Role::REST::Client - REST Client Role
version 0.18
{ 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; ... }
This REST Client role makes REST connectivety easy.
Role::REST::Client will handle encoding and decoding when using the HTTP verbs.
GET PUT POST DELETE OPTIONS HEAD
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.
Role::REST::Client implements the standard HTTP 1.1 verbs as methods
post get head 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'}); 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 Role::REST::Client::Response by default.
sub _build_user_agent { HTTP::Thin->new }
A User Agent object which has a ->request method suitably compatible with HTTP::Tiny. It should accept arguments like this: $ua->request($method, $uri, $opts), and needs to return a hashref as HTTP::Tiny does, or an HTTP::Response object. To set your own default, use a _build_user_agent method.
->request
$ua->request($method, $uri, $opts)
_build_user_agent
URL of the REST server.
e.g. 'http://localhost:3000'
MIME Content-Type header,
e.g. application/json
$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.
$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 set_persistent_header() in your BUILD method.
set_persistent_header()
BUILD
has '+persistent_headers' => ( default => sub { ... }, );
Attributes to feed the user agent object (which defaults to HTTP::Thin)
e.g. {timeout => 10}
Breno G. de Oliveira, <garu@cpan.org>
Mark Stosberg, <mark@stosberg.com>
Matt Phillips, (cpan:MATTP) <mattp@cpan.org>
Wallace Reis, <wallace@reis.me>
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.
Kaare Rasmussen <kaare at cpan dot net>
This software is copyright (c) 2014 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.
To install Role::REST::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Role::REST::Client
CPAN shell
perl -MCPAN -e shell install Role::REST::Client
For more information on module installation, please visit the detailed CPAN module installation guide.