/usr/share/perl5/Role/REST/Client.pm is in librole-rest-client-perl 0.22-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | package Role::REST::Client;
$Role::REST::Client::VERSION = '0.22';
use Moo::Role;
use MooX::HandlesVia;
use Types::Standard qw(HashRef Str Int Enum HasMethods);
use HTTP::Tiny;
use URI::Escape::XS 'uri_escape';
use Try::Tiny;
use Carp qw(confess);
use HTTP::Response;
use HTTP::Status 'status_message';
use HTTP::Headers;
use Role::REST::Client::Serializer;
use Role::REST::Client::Response;
has 'server' => (
isa => Str,
is => 'rw',
default => '',
);
has 'type' => (
isa => Enum[qw{application/json application/xml application/yaml application/x-www-form-urlencoded}],
is => 'rw',
default => sub { 'application/json' },
);
has clientattrs => (
isa => HashRef,
is => 'ro',
default => sub {return {} }
);
has user_agent => (
isa => HasMethods['request'],
is => 'ro',
lazy => 1,
builder => '_build_user_agent',
);
sub _build_user_agent {
my $self = shift;
require HTTP::Thin;
return HTTP::Thin->new(%{$self->clientattrs});
}
has persistent_headers => (
is => 'rw',
# isa => HashRef[Str],
default => sub { {} },
handles_via => 'Hash',
handles => {
set_persistent_header => 'set',
get_persistent_header => 'get',
has_no_persistent_headers => 'is_empty',
clear_persistent_headers => 'clear',
},
);
has _httpheaders => (
is => 'rw',
isa => HashRef[Str],
init_arg => 'httpheaders',
default => sub { {} },
handles_via => 'Hash',
handles => {
set_header => 'set',
get_header => 'get',
exist_header => 'exists',
has_no_headers => 'is_empty',
clear_headers => 'clear',
reset_headers => 'clear',
},
);
sub httpheaders {
my $self = shift;
return { %{$self->persistent_headers}, %{$self->_httpheaders} };
}
sub clear_all_headers {
my $self = shift;
$self->clear_headers;
$self->clear_persistent_headers;
return {};
}
has serializer_class => (
isa => Str,
is => 'ro',
default => sub { 'Role::REST::Client::Serializer' },
);
has serializer_options => (
isa => HashRef,
is => 'ro',
default => sub { return {} },
);
sub _rest_response_class { 'Role::REST::Client::Response' }
# If the response is a hashref, we expect it to be in the format returned by
# HTTP::Tiny->request() and convert it to an HTTP::Response object. Otherwise,
# pass the response through unmodified.
sub _handle_response {
my ( $self, $res ) = @_;
if ( ref $res eq 'HASH' ) {
my $code = $res->{'status'};
return HTTP::Response->new(
$code,
$res->{'reason'} || status_message($code),
HTTP::Headers->new(%{$res->{'headers'}}),
$res->{'content'},
);
} else {
return $res;
}
}
sub _new_rest_response {
my ($self, @args) = @_;
return $self->_rest_response_class->new(@args);
}
sub new_serializer {
my ($self, @args) = @_;
my %args = (%{ $self->serializer_options }, @args);
$self->serializer_class->new(%args);
}
sub _serializer {
my ($self, $type) = @_;
$type ||= $self->type;
$type =~ s/;\s*?charset=.+$//i; #remove stuff like ;charset=utf8
try {
$self->{serializer}{$type} ||= $self->new_serializer(type => $type);
}
catch {
# Deal with real life content types like "text/xml;charset=ISO-8859-1"
warn "No serializer available for " . $type . " content. Trying default " . $self->type;
$self->{serializer}{$type} = $self->new_serializer(type => $self->type);
};
return $self->{serializer}{$type};
}
sub do_request {
my ($self, $method, $uri, $opts) = @_;
return $self->user_agent->request($method, $uri, $opts);
}
sub _call {
my ($self, $method, $endpoint, $data, $args) = @_;
my $uri = $self->server . $endpoint;
# If no data, just call endpoint (or uri if GET w/parameters)
# If data is a scalar, call endpoint with data as content (POST w/parameters)
# Otherwise, encode data
$self->set_header('content-type', $self->type);
my %options = (headers => $self->httpheaders);
if ( defined $data ) {
$options{content} = ref $data ? $self->_serializer->serialize($data) : $data;
$options{'headers'}{'content-length'} = length($options{'content'});
}
my $res = $self->_handle_response( $self->do_request($method, $uri, \%options) );
$self->reset_headers unless $args->{preserve_headers};
my $use_serializer = exists $args->{deserializer}
? defined $args->{deserializer} ? 1 : 0
: ($res->header('Content-Type')
and $res->header('Content-Type') !~ m{(?:text/(?:plain|html)|application/octet-stream)});
my $deserializer_cb = sub {
# Try to find a serializer for the result content
my $content_type = $args->{deserializer} || $res->header('Content-Type');
my $deserializer = $self->_serializer($content_type);
# Try to deserialize
my $content = $res->decoded_content;
$content = $deserializer->deserialize($content) if $deserializer && $content;
$content ||= {};
};
return $self->_new_rest_response(
code => $res->code,
response => $res,
data => $use_serializer
? $deserializer_cb : sub { $res->decoded_content },
$res->is_error ? ( error => $res->message) : (),
);
}
sub _urlencode_data {
my ($self, $data) = @_;
return join '&', map { uri_escape($_) . '=' . uri_escape($data->{$_})} keys %$data;
}
sub _request_with_query {
my ($self, $method, $endpoint, $data, $args) = @_;
my $uri = $endpoint;
if ($data && scalar keys %$data) {
$uri .= '?' . $self->_urlencode_data($data);
}
return $self->_call($method, $uri, undef, $args);
}
sub get { return shift->_request_with_query('GET', @_) }
sub head { return shift->_request_with_query('HEAD', @_) }
sub _request_with_body {
my ($self, $method, $endpoint, $data, $args) = @_;
my $content = $data;
if ( $self->type =~ /urlencoded/ ) {
$content = ( $data && scalar keys %$data ) ? $self->_urlencode_data($data) : q{};
}
return $self->_call($method, $endpoint, $content, $args);
}
sub post { return shift->_request_with_body('POST', @_) }
sub put { return shift->_request_with_body('PUT', @_) }
sub options { return shift->_request_with_body('OPTIONS', @_) }
sub delete { return shift->_request_with_query('DELETE', @_) }
1;
=pod
=encoding UTF-8
=head1 NAME
Role::REST::Client - REST Client Role
=head1 VERSION
version 0.22
=head1 SYNOPSIS
{
package RESTExample;
use Moose;
with 'Role::REST::Client';
sub bar {
my ($self) = @_;
my $res = $self->post('/foo/bar/baz', {foo => 'bar'});
my $code = $res->code;
my $data = $res->data;
return $data if $code == 200;
}
}
my $foo = RESTExample->new(
server => 'http://localhost:3000',
type => 'application/json',
clientattrs => {timeout => 5},
);
$foo->bar;
# controller
sub foo : Local {
my ($self, $c) = @_;
my $res = $c->model('MyData')->post('/foo/bar/baz', {foo => 'bar'});
my $code = $res->code;
my $data = $res->data;
...
}
=head1 DESCRIPTION
This REST Client role makes REST connectivity easy.
Role::REST::Client will handle encoding and decoding when using the HTTP verbs.
GET
HEAD
PUT
POST
DELETE
OPTIONS
Currently Role::REST::Client supports these encodings
application/json
application/x-www-form-urlencoded
application/xml
application/yaml
x-www-form-urlencoded only works for GET and POST, and only for encoding, not decoding.
Responses which claim to not be serialised data (eg C<text/plain>,
C<application/octet-stream>) will by default not be serialised. When the
response is none of these, and it is impossible to determine what encoding is
used, the content will be treated as JSON by default.
=head1 NAME
Role::REST::Client - REST Client Role
=head1 METHODS
=head2 methods
Role::REST::Client implements the standard HTTP 1.1 verbs as methods
These methods can NOT have a request body
get
head
These methods can take a request body.
post
put
delete
options
All methods take these parameters
url - The REST service
data - The data structure (hashref, arrayref) to send. The data will be encoded
according to the value of the I<type> attribute.
args - hashref with arguments to augment the way the call is handled.
args - the optional argument parameter can have these entries
deserializer - if you KNOW that the content-type of the response is incorrect,
you can supply the correct content type, like
my $res = $self->post('/foo/bar/baz', {foo => 'bar'}, {deserializer => 'application/yaml'});
Alternatively, if you KNOW that the response is not serial data, you can
disable deserialization by setting this to undef.
preserve_headers - set this to true if you want to keep the headers between calls
All methods return a response object dictated by _rest_response_class. Set to L<Role::REST::Client::Response> by default.
=head1 ATTRIBUTES
=head2 user_agent
sub _build_user_agent { HTTP::Thin->new }
A User Agent object which has a C<< ->request >> method suitably compatible with L<HTTP::Tiny>. It should accept arguments like this: C<< $ua->request($method, $uri, $opts) >>, and needs to return a hashref as HTTP::Tiny does, or an L<HTTP::Response> object. To set your own default, use a C<_build_user_agent> method.
=head2 server
URL of the REST server.
e.g. 'http://localhost:3000'
=head2 type
MIME Content-Type header,
e.g. application/json
=head2 persistent_headers
$self->set_persistent_header('Header' => 'foo', ... );
$self->get_persistent_header('Header-Name');
$self->has_no_persistent_headers;
$self->clear_persistent_headers;
A hashref containing headers you want to use for all requests. Use the methods
described above to manipulate it.
To set your own defaults, override the default or call C<set_persistent_header()> in your
C<BUILD> method.
has '+persistent_headers' => (
default => sub { ... },
);
=head2 httpheaders
$self->set_header('Header' => 'foo', ... );
$self->get_header('Header-Name');
$self->has_no_headers;
$self->clear_headers;
You can set any http header you like with set_header, e.g.
$self->set_header($key, $value) but the content-type header will be overridden.
http_headers will be reset after each request, unless there's a reserve_headers
argument, but it's a hack. The recommended way to keep headers across requests
is to store them in the persistent_headers.
$self->httpheaders will return the combined hashref of persistent_headers and
what's been added with set_header.
For historical reasons, the two methods clear_headers and reset_headers are
equal. Both will clear the headers for the current request, but NOT the
persistent headers.
To clear ALL headers, use
$self->clear_all_headers;
=head2 clientattrs
Attributes to feed the user agent object (which defaults to L<HTTP::Thin>)
e.g. {timeout => 10}
=head2 serializer_class
You can override the serializer class and use your own. Default is 'Role::REST::Client::Serializer'
=head2 serializer_options
Options for the serializer instantiation.
=head1 CONTRIBUTORS
Breno G. de Oliveira, <garu@cpan.org>
Mark Stosberg, <mark@stosberg.com>
Matt Phillips, (cpan:MATTP) <mattp@cpan.org>
Wallace Reis, <wallace@reis.me>
=head1 BUGS
Please report any bugs or feature requests to bug-role-rest-client at rt.cpan.org, or through the
web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Role-REST-Client.
=head1 AUTHOR
Kaare Rasmussen <kaare at cpan dot org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Kaare Rasmussen.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
# ABSTRACT: REST Client Role
|