The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

DAGOLDEN / HTTP-Tiny-UA-0.006 / lib / HTTP / Tiny / UA / Response.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
—
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

              
use strict;
use warnings;
package HTTP::Tiny::UA::Response;
# ABSTRACT: Wrap HTTP::Tiny response as objects with accessors
our $VERSION = '0.006';
# Declare custom accessor before Class::Tiny loads
use subs 'headers';
use Class::Tiny 1.000 qw( success url status reason content protocol headers );
#pod =attr success
#pod
#pod =attr url
#pod
#pod =attr protocol
#pod
#pod =attr status
#pod
#pod =attr reason
#pod
#pod =attr content
#pod
#pod =attr headers
#pod
#pod =method header
#pod
#pod     $response->header( "Content-Length" );
#pod
#pod Return a header out of the headers hash.  The field is case-insensitive.  If
#pod the header was repeated, the value returned will be an array reference.
#pod Otherwise it will be a scalar value.
#pod
#pod =cut
# Don't return the original hash reference because the caller could
# alter that referred-to hash, which in turn would alter this object's
# internals, which we almost certainly do not want!
sub headers {
    my ($self) = @_;
    my $headers = $self->{headers};
    my %copy;
    while ( my ( $k, $v ) = each %$headers ) {
        $copy{$k} = ref($v) eq 'ARRAY' ? [@$v] : $v;
    }
    return \%copy;
}
sub header {
    my ( $self, $field ) = @_;
    # NB: lc() can potentially use non-English (e.g., Turkish)
    # lowercasing logic, which we very likely do not want here.
    $field =~ tr/A-Z/a-z/;
    # We don't return the original array reference for the same reason
    # why headers() doesn't return the original hash reference.
    my $hdr = $self->{headers}{$field};
    return ref($hdr) eq 'ARRAY' ? [@$hdr] : $hdr;
}
1;
# vim: ts=4 sts=4 sw=4 et:
__END__
=pod
=encoding UTF-8
=head1 NAME
HTTP::Tiny::UA::Response - Wrap HTTP::Tiny response as objects with accessors
=head1 VERSION
version 0.006
=head1 SYNOPSIS
    my $res = HTTP::Tiny::UA->new->get( $url );
    if ( $res->success ) {
        say "Got " . $res->header("Content-Length") . " bytes";
    }
=head1 DESCRIPTION
This module wraps an L<HTTP::Tiny> response as an object to provide some
accessors and convenience methods.
=head1 ATTRIBUTES
=head2 success
=head2 url
=head2 protocol
=head2 status
=head2 reason
=head2 content
=head2 headers
=head1 METHODS
=head2 header
    $response->header( "Content-Length" );
Return a header out of the headers hash.  The field is case-insensitive.  If
the header was repeated, the value returned will be an array reference.
Otherwise it will be a scalar value.
=for Pod::Coverage BUILD
=head1 AUTHOR
David Golden <dagolden@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by David Golden.
This is free software, licensed under:
  The Apache License, Version 2.0, January 2004
=cut