Role-REST-Client-0.22000755001750000144 013117155434 13734 5ustar00kaareusers000000000000README100644001750000144 54713117155434 14663 0ustar00kaareusers000000000000Role-REST-Client-0.22 This archive contains the distribution Role-REST-Client, version 0.22: REST Client Role 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. This README file was generated by Dist::Zilla::Plugin::Readme v6.005. Changes100644001750000144 741013117155434 15312 0ustar00kaareusers000000000000Role-REST-Client-0.22Revision history for Role-REST-Client 0.22 2017-06-11 07:54:35 Europe/Copenhagen 0.21 2017-06-07 09:12:43 Europe/Copenhagen - Add a little info when dying 0.20 2017-06-02 10:29:15 Europe/Copenhagen - Allow for conditional serializers (José Joaquín Atria) 0.19 2016-11-08 08:08:16 Europe/Copenhagen - The standard is not clear on this, and some servers don't allow them, but it seems that DELETE can take a request body. - Added serializer_options so it's possible to instantiate the serializer w/ parameters - Fixed "Use of uninitialized value in concatenation (.) or string" warning when $self->server is not initialized - Changes for rt #118413. Thanks to abraxxa http_headers return a combined hashref of http_headers and persistent_headers new method, clear_all_headers 0.18 2014-06-26 22:28:12 Europe/Copenhagen - Decode the content even for http codes >= 400. There might be some information there (idea: moltar) 0.17 2014-04-22 19:58:08 Europe/Copenhagen - Prevent 'redefined' warnings and updated dependency list (Breno G. de Oliveira) 0.16 2013-09-26 07:51:17 Europe/Copenhagen - Mooify Role::REST::Client (Matt Phillips) - Start deserializing text/javascript without a warning (Mark Stosberg) - Replace HTTP::Tiny with HTTP::Thin - Use HTTP::Response to determine if a request failed 0.15 2013-03-28 22:38:29 Europe/Copenhagen - Only update httpheaders from persistent_headers if they are not already set. 0.14 2013-03-28 21:17:06 Europe/Copenhagen - Fix URI encode process (Wallace Reis) - self->_persistent_headers was sometimes undef and there was no lazy bit. - dist.ini corrections - Improved Docs (Mark Stosberg) 0.13 2012-11-11 12:45:40 Europe/Copenhagen - Change json/yaml/xml serializers to recommends instead of requires (Matt Phillips) - Fix httpheaders attr - must be lazy since builder depends on persistent_headers (Wallace Reis). - Remove MooseX::Declare from the dependency chain (Mark Stosberg) - Don't require HTTP::Tiny to be loaded if it is never used (Mark Stosberg) 0.12 2012-06-26 19:08:09 Europe/Copenhagen - Fix httpheaders attr - must be lazy since builder depends on persistent_headers (Wallace Reis). 0.11 2012-06-14 20:47:25 Europe/Copenhagen - Init methods remember the persistent headers (Thanks to Wallace Reis for the tests). 0.10 2012-06-01 14:07:37 Europe/Copenhagen - Add HTTP HEAD method (Wallace Reis). 0.09 2012-05-29 14:59:38 Europe/Copenhagen - Use Data::Serializer::Raw instead of Data::Serializer - Fix content-length missmatch issue (Wallace Reis). - Factor out request step (Wallace Reis). 0.08 2012-05-29 07:24:24 Europe/Copenhagen - Lazily deserialize the response (Wallace Reis). - Allow use of a custom UA object (Wallace Reis). - Defer the building of serializer obj until really necessary (Wallace Reis). 0.07 2012-05-24 07:22:16 Europe/Copenhagen - Make new_serializer and serializer_class public method and attr, respectively (Wallace Reis). 0.06 2012-05-19 18:32:07 Europe/Copenhagen - Add preserve_headers option and persistent_headers to allow sticky headers. 0.05 2012-04-02 22:57:55 Europe/Copenhagen - Response and serializer are now easy overridable [Matt Phillips]. 0.04 2012-03-30 11:02:47 Europe/Copenhagen - Don't use 5.010; we don't have particular needs for that 0.03 2012-03-19 19:50:25 Europe/Copenhagen - Clear headers AFTER the request, Makes it possible to set any http header except content-type and any header set by authentication roles. 0.02 2012-03-01 20:58:30 Europe/Copenhagen - Turn _ua into an attribute - Add support for Auth modules (See http://search.cpan.org/dist/Role-REST-Client-Auth-Basic/) 0.01 2012-02-20 17:28:59 Europe/Copenhagen - First version, with functionality taken from Catalyst::Model::REST t000755001750000144 013117155434 14120 5ustar00kaareusers000000000000Role-REST-Client-0.22pod.t100644001750000144 20113117155434 15200 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse Test::More; eval "use Test::Pod 1.14"; plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; all_pod_files_ok(); LICENSE100644001750000144 4366613117155434 15061 0ustar00kaareusers000000000000Role-REST-Client-0.22This 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. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2017 by Kaare Rasmussen. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2017 by Kaare Rasmussen. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End INSTALL100644001750000144 224113117155434 15045 0ustar00kaareusers000000000000Role-REST-Client-0.22This is the Perl distribution Role-REST-Client. Installing Role-REST-Client is straightforward. ## Installation with cpanm If you have cpanm, you only need one line: % cpanm Role::REST::Client If it does not have permission to install modules to the current perl, cpanm will automatically set up and install to a local::lib in your home directory. See the local::lib documentation (https://metacpan.org/pod/local::lib) for details on enabling it in your environment. ## Installing with the CPAN shell Alternatively, if your CPAN shell is set up, you should just be able to do: % cpan Role::REST::Client ## Manual installation As a last resort, you can manually install it. Download the tarball, untar it, then build it: % perl Build.PL % ./Build && ./Build test Then install it: % ./Build install If your perl is system-managed, you can create a local::lib in your home directory to install modules to. For details, see the local::lib documentation: https://metacpan.org/pod/local::lib ## Documentation Role-REST-Client documentation is available as POD. You can run perldoc from a shell to read the documentation: % perldoc Role::REST::Client dist.ini100644001750000144 212213117155434 15456 0ustar00kaareusers000000000000Role-REST-Client-0.22name = Role-REST-Client author = Kaare Rasmussen license = Perl_5 copyright_holder = Kaare Rasmussen [Git::NextVersion] version_regexp = ^release-(.+)$ [@Basic] [ModuleBuild] [NextRelease] format = %-7v %{yyyy-MM-dd HH:mm:ss VVVV}d [InstallGuide] [MetaJSON] [MetaResources] repository.url = git://github.com/kaare/Role-REST-Client.git repository.web = http://github.com/kaare/Role-REST-Client repository.type = git [PodWeaver] ;[NoTabsTests] ;[EOLTests] ;[Signature] [CheckChangeLog] [AutoPrereqs] [Prereqs / RuntimeRequires] HTTP::Message = 0 Data::Serializer::Raw = 0 Moo = 1.003000 MooX::HandlesVia = 0.001004 Type::Tiny = 0.024 URI::Escape::XS = 0.11 [Prereqs / TestRequires] Data::Serializer::JSON = 0 Data::Serializer::YAML = 0 Data::Serializer::XML::Simple = 0 HTTP::Thin = 0 JSON = 2.00 YAML = 0 XML::Simple = 0 Test::More = 0.88 [Prereqs] -relationship = recommends Data::Serializer::JSON = 0 Data::Serializer::YAML = 0 Data::Serializer::XML::Simple = 0 HTTP::Thin = 0 JSON = 2.00 YAML = 0 XML::Simple = 0 [PkgVersion] [Git::Tag] tag_format = release-%v [@Git] rest.t100644001750000144 667713117155434 15442 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse Test::More; use Test::Deep; use HTTP::Response; use HTTP::Headers; use HTTP::Request; use utf8; { package RESTExample; use Moo; with 'Role::REST::Client'; sub bar { my ($self) = @_; return $self->post('/foo/bar/baz', {foo => 'bar'}); } sub baz { my ($self) = @_; return $self->post('/foo/bar/baz', {foo => 'bar', bar => 'baz' }); } } { package UAClass; use Moo; use JSON; use Test::More; has 'timeout' => ( is => 'ro'); sub request { my ( $self, $method, $uri, $opts ) = @_; ok(!ref($opts->{'content'}), 'content key must be a scalar value due content-type'); if ( lc $method eq 'post' ) { like($opts->{'content'}, qr{foo\=bar}, 'no serialization should happen'); } my $req = HTTP::Request->new($method => $uri); my $json = encode_json({ error => 'Resource not found' }); my $headers = HTTP::Headers->new('Content-Type' => 'application/json'); my $res = HTTP::Response->new(404, 'Not Found', $headers, $json); $res->request($req); return $res; } } my $ua = UAClass->new(timeout => 5); my $persistent_headers = { 'Accept' => 'application/json' }; my %testdata = ( server => 'http://localhost:3000', type => 'application/x-www-form-urlencoded', user_agent => $ua, persistent_headers => $persistent_headers, ); { ok(my $client = RESTExample->new({ server => 'http://localhost:3000', type => 'application/json', }), 'New object'); is($client->has_no_headers, 1, 'client has no headers'); #is_deeply($client->httpheaders, {}, 'client has no headers'); $client->set_persistent_header('X-Test' => 'foo' ); is_deeply($client->httpheaders, { 'X-Test' => 'foo' }, 'should have at least persistent_headers'); } ok(my $obj = RESTExample->new(%testdata), 'New object'); isa_ok($obj, 'RESTExample'); for my $item (qw/post get put delete _call httpheaders/) { ok($obj->can($item), "Role method $item exists"); } is_deeply($obj->httpheaders, $persistent_headers, 'headers should include persistent ones since first request'); ok(my $res = $obj->bar, 'got a response object'); is_deeply($obj->httpheaders, $persistent_headers, 'after first request, it contains persistent ones'); isa_ok($res, 'Role::REST::Client::Response'); isa_ok($res->response, 'HTTP::Response'); is($res->code, 404, 'Resource not found'); $obj->set_header('X-Foo', 'foo'); is_deeply($obj->httpheaders, { %$persistent_headers, 'X-Foo', 'foo', }); $obj->reset_headers; is_deeply($obj->httpheaders, $persistent_headers, 'should have at least persistent_headers'); ok(!exists($obj->persistent_headers->{'X-Foo'})); ok($res = $obj->bar, 'got a response obj'); ok(!exists($obj->persistent_headers->{'content-length'})); ok($res = $obj->baz, 'got a response obj'); ok(!exists($obj->persistent_headers->{'content-length'})); $obj->clear_all_headers; is_deeply($obj->httpheaders, {}, 'All headers are cleared, even the persistent ones'); my $newheaders = { 'X-Foo' => 'foo', 'Accept' => 'application/yaml' }; ok($obj = RESTExample->new({ %testdata, httpheaders => $newheaders })); is_deeply($obj->httpheaders, { %$persistent_headers, %$newheaders, }, 'merge httpheaders with persistent_headers'); ok($res = $obj->bar, 'got a response object'); is_deeply($obj->httpheaders, $persistent_headers, 'after first request, it contains persistent ones'); ok($res = $obj->get('/getendpoint', { param => 'büz' })); like($res->response->request->uri, qr{param=b%C3%BCz}); done_testing; META.yml100644001750000144 271413117155434 15272 0ustar00kaareusers000000000000Role-REST-Client-0.22--- abstract: 'REST Client Role' author: - 'Kaare Rasmussen ' build_requires: Data::Serializer::JSON: '0' Data::Serializer::XML::Simple: '0' Data::Serializer::YAML: '0' File::Find: '0' File::Temp: '0' HTTP::Request: '0' HTTP::Thin: '0' JSON: '2.00' Module::Build: '0.28' Moose: '0' Plack::Component: '0' Plack::Request: '0' Plack::Runner: '0' Test::Deep: '0' Test::Exception: '0' Test::More: '0.88' Test::TCP: '0' Test::Warnings: '0' XML::Simple: '0' YAML: '0' parent: '0' strict: '0' utf8: '0' warnings: '0' configure_requires: ExtUtils::MakeMaker: '0' Module::Build: '0.28' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.005, CPAN::Meta::Converter version 2.150005' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Role-REST-Client recommends: Data::Serializer::JSON: '0' Data::Serializer::XML::Simple: '0' Data::Serializer::YAML: '0' HTTP::Thin: '0' JSON: '2.00' XML::Simple: '0' YAML: '0' requires: Carp: '0' Data::Dumper: '0' Data::Serializer::Raw: '0' HTTP::Headers: '0' HTTP::Message: '0' HTTP::Response: '0' HTTP::Status: '0' HTTP::Thin: '0' HTTP::Tiny: '0' Moo: '1.003000' Moo::Role: '0' MooX::HandlesVia: '0.001004' Try::Tiny: '0' Type::Tiny: '0.024' Types::Standard: '0' URI::Escape::XS: '0.11' resources: repository: git://github.com/kaare/Role-REST-Client.git version: '0.22' MANIFEST100644001750000144 55713117155434 15135 0ustar00kaareusers000000000000Role-REST-Client-0.22# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.005. Build.PL Changes INSTALL LICENSE MANIFEST META.json META.yml Makefile.PL README dist.ini lib/Role/REST/Client.pm lib/Role/REST/Client/Response.pm lib/Role/REST/Client/Serializer.pm t/boilerplate.t t/compile.t t/conditional_deserialization.t t/pod.t t/response.t t/rest.t t/serializer.t Build.PL100644001750000144 522113117155434 15311 0ustar00kaareusers000000000000Role-REST-Client-0.22 # This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v6.005. use strict; use warnings; use Module::Build 0.28; my %module_build_args = ( "build_requires" => { "Module::Build" => "0.28" }, "configure_requires" => { "ExtUtils::MakeMaker" => 0, "Module::Build" => "0.28" }, "dist_abstract" => "REST Client Role", "dist_author" => [ "Kaare Rasmussen " ], "dist_name" => "Role-REST-Client", "dist_version" => "0.22", "license" => "perl", "module_name" => "Role::REST::Client", "recommends" => { "Data::Serializer::JSON" => 0, "Data::Serializer::XML::Simple" => 0, "Data::Serializer::YAML" => 0, "HTTP::Thin" => 0, "JSON" => "2.00", "XML::Simple" => 0, "YAML" => 0 }, "recursive_test_files" => 1, "requires" => { "Carp" => 0, "Data::Dumper" => 0, "Data::Serializer::Raw" => 0, "HTTP::Headers" => 0, "HTTP::Message" => 0, "HTTP::Response" => 0, "HTTP::Status" => 0, "HTTP::Thin" => 0, "HTTP::Tiny" => 0, "Moo" => "1.003000", "Moo::Role" => 0, "MooX::HandlesVia" => "0.001004", "Try::Tiny" => 0, "Type::Tiny" => "0.024", "Types::Standard" => 0, "URI::Escape::XS" => "0.11" }, "test_requires" => { "Data::Serializer::JSON" => 0, "Data::Serializer::XML::Simple" => 0, "Data::Serializer::YAML" => 0, "File::Find" => 0, "File::Temp" => 0, "HTTP::Request" => 0, "HTTP::Thin" => 0, "JSON" => "2.00", "Moose" => 0, "Plack::Component" => 0, "Plack::Request" => 0, "Plack::Runner" => 0, "Test::Deep" => 0, "Test::Exception" => 0, "Test::More" => "0.88", "Test::TCP" => 0, "Test::Warnings" => 0, "XML::Simple" => 0, "YAML" => 0, "parent" => 0, "strict" => 0, "utf8" => 0, "warnings" => 0 } ); my %fallback_build_requires = ( "Data::Serializer::JSON" => 0, "Data::Serializer::XML::Simple" => 0, "Data::Serializer::YAML" => 0, "File::Find" => 0, "File::Temp" => 0, "HTTP::Request" => 0, "HTTP::Thin" => 0, "JSON" => "2.00", "Module::Build" => "0.28", "Moose" => 0, "Plack::Component" => 0, "Plack::Request" => 0, "Plack::Runner" => 0, "Test::Deep" => 0, "Test::Exception" => 0, "Test::More" => "0.88", "Test::TCP" => 0, "Test::Warnings" => 0, "XML::Simple" => 0, "YAML" => 0, "parent" => 0, "strict" => 0, "utf8" => 0, "warnings" => 0 ); unless ( eval { Module::Build->VERSION(0.4004) } ) { delete $module_build_args{test_requires}; $module_build_args{build_requires} = \%fallback_build_requires; } my $build = Module::Build->new(%module_build_args); $build->create_build_script; META.json100644001750000144 517413117155434 15445 0ustar00kaareusers000000000000Role-REST-Client-0.22{ "abstract" : "REST Client Role", "author" : [ "Kaare Rasmussen " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.005, CPAN::Meta::Converter version 2.150005", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Role-REST-Client", "prereqs" : { "build" : { "requires" : { "Module::Build" : "0.28" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0", "Module::Build" : "0.28" } }, "runtime" : { "recommends" : { "Data::Serializer::JSON" : "0", "Data::Serializer::XML::Simple" : "0", "Data::Serializer::YAML" : "0", "HTTP::Thin" : "0", "JSON" : "2.00", "XML::Simple" : "0", "YAML" : "0" }, "requires" : { "Carp" : "0", "Data::Dumper" : "0", "Data::Serializer::Raw" : "0", "HTTP::Headers" : "0", "HTTP::Message" : "0", "HTTP::Response" : "0", "HTTP::Status" : "0", "HTTP::Thin" : "0", "HTTP::Tiny" : "0", "Moo" : "1.003000", "Moo::Role" : "0", "MooX::HandlesVia" : "0.001004", "Try::Tiny" : "0", "Type::Tiny" : "0.024", "Types::Standard" : "0", "URI::Escape::XS" : "0.11" } }, "test" : { "requires" : { "Data::Serializer::JSON" : "0", "Data::Serializer::XML::Simple" : "0", "Data::Serializer::YAML" : "0", "File::Find" : "0", "File::Temp" : "0", "HTTP::Request" : "0", "HTTP::Thin" : "0", "JSON" : "2.00", "Moose" : "0", "Plack::Component" : "0", "Plack::Request" : "0", "Plack::Runner" : "0", "Test::Deep" : "0", "Test::Exception" : "0", "Test::More" : "0.88", "Test::TCP" : "0", "Test::Warnings" : "0", "XML::Simple" : "0", "YAML" : "0", "parent" : "0", "strict" : "0", "utf8" : "0", "warnings" : "0" } } }, "release_status" : "stable", "resources" : { "repository" : { "type" : "git", "url" : "git://github.com/kaare/Role-REST-Client.git", "web" : "http://github.com/kaare/Role-REST-Client" } }, "version" : "0.22" } compile.t100644001750000144 232313117155434 16075 0ustar00kaareusers000000000000Role-REST-Client-0.22/t#!perl use strict; use warnings; use Test::More; use File::Find; use File::Temp qw{ tempdir }; my @modules; find( sub { return if $File::Find::name !~ /\.pm\z/; my $found = $File::Find::name; $found =~ s{^lib/}{}; $found =~ s{[/\\]}{::}g; $found =~ s/\.pm$//; # nothing to skip push @modules, $found; }, 'lib', ); my @scripts; if ( -d 'bin' ) { find( sub { return unless -f; my $found = $File::Find::name; # nothing to skip push @scripts, $found; }, 'bin', ); } my $plan = scalar(@modules) + scalar(@scripts); $plan ? (plan tests => $plan) : (plan skip_all => "no tests to run"); { # fake home for cpan-testers # no fake requested ## local $ENV{HOME} = tempdir( CLEANUP => 1 ); like( qx{ $^X -Ilib -e "require $_; print '$_ ok'" }, qr/^\s*$_ ok/s, "$_ loaded ok" ) for sort @modules; SKIP: { eval "use Test::Script 1.05; 1;"; skip "Test::Script needed to test script compilation", scalar(@scripts) if $@; foreach my $file ( @scripts ) { my $script = $file; $script =~ s!.*/!!; script_compiles( $file, "$script script compiles" ); } } } Makefile.PL100644001750000144 554313117155434 15776 0ustar00kaareusers000000000000Role-REST-Client-0.22# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.005. use strict; use warnings; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "REST Client Role", "AUTHOR" => "Kaare Rasmussen ", "BUILD_REQUIRES" => { "Module::Build" => "0.28" }, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "Module::Build" => "0.28" }, "DISTNAME" => "Role-REST-Client", "LICENSE" => "perl", "NAME" => "Role::REST::Client", "PREREQ_PM" => { "Carp" => 0, "Data::Dumper" => 0, "Data::Serializer::Raw" => 0, "HTTP::Headers" => 0, "HTTP::Message" => 0, "HTTP::Response" => 0, "HTTP::Status" => 0, "HTTP::Thin" => 0, "HTTP::Tiny" => 0, "Moo" => "1.003000", "Moo::Role" => 0, "MooX::HandlesVia" => "0.001004", "Try::Tiny" => 0, "Type::Tiny" => "0.024", "Types::Standard" => 0, "URI::Escape::XS" => "0.11" }, "TEST_REQUIRES" => { "Data::Serializer::JSON" => 0, "Data::Serializer::XML::Simple" => 0, "Data::Serializer::YAML" => 0, "File::Find" => 0, "File::Temp" => 0, "HTTP::Request" => 0, "HTTP::Thin" => 0, "JSON" => "2.00", "Moose" => 0, "Plack::Component" => 0, "Plack::Request" => 0, "Plack::Runner" => 0, "Test::Deep" => 0, "Test::Exception" => 0, "Test::More" => "0.88", "Test::TCP" => 0, "Test::Warnings" => 0, "XML::Simple" => 0, "YAML" => 0, "parent" => 0, "strict" => 0, "utf8" => 0, "warnings" => 0 }, "VERSION" => "0.22", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "Data::Dumper" => 0, "Data::Serializer::JSON" => 0, "Data::Serializer::Raw" => 0, "Data::Serializer::XML::Simple" => 0, "Data::Serializer::YAML" => 0, "File::Find" => 0, "File::Temp" => 0, "HTTP::Headers" => 0, "HTTP::Message" => 0, "HTTP::Request" => 0, "HTTP::Response" => 0, "HTTP::Status" => 0, "HTTP::Thin" => 0, "HTTP::Tiny" => 0, "JSON" => "2.00", "Module::Build" => "0.28", "Moo" => "1.003000", "Moo::Role" => 0, "MooX::HandlesVia" => "0.001004", "Moose" => 0, "Plack::Component" => 0, "Plack::Request" => 0, "Plack::Runner" => 0, "Test::Deep" => 0, "Test::Exception" => 0, "Test::More" => "0.88", "Test::TCP" => 0, "Test::Warnings" => 0, "Try::Tiny" => 0, "Type::Tiny" => "0.024", "Types::Standard" => 0, "URI::Escape::XS" => "0.11", "XML::Simple" => 0, "YAML" => 0, "parent" => 0, "strict" => 0, "utf8" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); response.t100644001750000144 317513117155434 16311 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse strict; use warnings; use Test::More; use HTTP::Response; eval 'use JSON'; if ($@) { plan skip_all => 'Install JSON to run this test'; } else { plan tests => 12 }; use_ok( 'Role::REST::Client::Serializer' ); use_ok( 'Role::REST::Client::Response' ); { package MyResponse; use Moose; extends 'Role::REST::Client::Response'; sub foo { 1 } } { package MyClient; use Moose; use Role::REST::Client; with 'Role::REST::Client'; sub _rest_response_class { 'MyResponse' } } # test JSON hashes / arrays my $jtype = 'application/json'; my $json_array = '["foo","bar"]'; my $array_data = [qw/foo bar/]; ok (my $serializer = Role::REST::Client::Serializer->new(type => $jtype), "New $jtype type serializer"); is($serializer->content_type, $jtype, 'Content Type'); ok(my $sdata = $serializer->serialize($array_data), 'Serialize'); is($sdata, $json_array, 'Serialize data'); ok(my $res = Role::REST::Client::Response->new( code => 200, response => HTTP::Response->new, data => sub { $serializer->deserialize($sdata) }, ), 'response accepted'); is_deeply($res->data, $array_data, 'Deserialize'); ok($res = Role::REST::Client::Response->new( code => 500, response => HTTP::Response->new, error => 'Internal Server Error', ), 'error response accepted'); is_deeply($res->data, {}, 'empty hashref if the response was unsuccessful'); sub Mock::UA::request { shift(@{$_[0]->{responses}}) } my $client = MyClient->new('server' => 'bar'); my $response = $client->get('/foo'); isa_ok($response, 'MyResponse', 'proper response class returned'); ok($response->can('foo'), 'custom response method included'); serializer.t100644001750000144 237113117155434 16621 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse strict; use warnings; use Test::More; eval 'use JSON'; if ($@) { plan skip_all => 'Install JSON to run this test'; } else { plan tests => 25 }; use_ok( 'Role::REST::Client::Serializer' ); my %resultdata = ( hash => { 'application/json' => '{"foo":"bar"}', 'application/xml' => ''."\n", 'application/yaml' => "---\nfoo: bar\n", }, array => { 'application/json' => '["foo","bar"]', 'application/xml' => "\n foo\n bar\n\n", 'application/yaml' => "---\n- foo\n- bar\n", }, ); for my $type (qw{application/json application/xml application/yaml}) { ok (my $serializer = Role::REST::Client::Serializer->new(type => $type), "New $type serializer"); is($serializer->content_type, $type, 'Content Type'); my $hashdata = {foo => 'bar'}; ok(my $sdata = $serializer->serialize($hashdata), "Serialize hash $type"); is($sdata, $resultdata{hash}{$type}, 'Correct type'); is_deeply($serializer->deserialize($sdata), $hashdata, "Deserialize hash $type"); my $arraydata = [qw/foo bar/]; ok($sdata = $serializer->serialize($arraydata), "Serialize array $type"); is($sdata, $resultdata{array}{$type}, 'Correct type'); is_deeply($serializer->deserialize($sdata), $arraydata, "Deserialize array $type"); }boilerplate.t100644001750000144 231413117155434 16747 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse strict; use warnings; use Test::More tests => 3; sub not_in_file_ok { my ($filename, %regex) = @_; open my $fh, "<", $filename or die "couldn't open $filename for reading: $!"; my %violated; while (my $line = <$fh>) { while (my ($desc, $regex) = each %regex) { if ($line =~ $regex) { push @{$violated{$desc}||=[]}, $.; } } } if (%violated) { fail("$filename contains boilerplate text"); diag "$_ appears on lines @{$violated{$_}}" for keys %violated; } else { pass("$filename contains no boilerplate text"); } } not_in_file_ok(README => "The README is used..." => qr/The README is used/, "'version information here'" => qr/to provide version information/, ); not_in_file_ok(Changes => "placeholder date/time" => qr(Date/time) ); sub module_boilerplate_ok { my ($module) = @_; not_in_file_ok($module => 'the great new $MODULENAME' => qr/ - The great new /, 'boilerplate description' => qr/Quick summary of what the module/, 'stub function definition' => qr/function[12]/, ); } module_boilerplate_ok('lib/Role/REST/Client.pm'); REST000755001750000144 013117155434 16101 5ustar00kaareusers000000000000Role-REST-Client-0.22/lib/RoleClient.pm100644001750000144 2622613117155434 20045 0ustar00kaareusers000000000000Role-REST-Client-0.22/lib/Role/RESTpackage 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') !~ 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, C) 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 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 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. 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 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 in your C 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) 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, Mark Stosberg, Matt Phillips, (cpan:MATTP) Wallace Reis, =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 =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 conditional_deserialization.t100644001750000144 403713117155434 22222 0ustar00kaareusers000000000000Role-REST-Client-0.22/tuse strict; use warnings; use Test::Exception; use Test::More; use Test::TCP; use Test::Warnings 'warning'; use Try::Tiny; { package My::REST::Client; use Moo; with 'Role::REST::Client'; 1; } { package My::TCP::Server; use parent qw( Plack::Component ); use Plack::Request; sub call { my ($self, $env) = @_; my $req = Plack::Request->new($env); my $content_type = $env->{REQUEST_URI} =~ /json/i ? 'application/json' : $env->{REQUEST_URI} =~ /html/i ? 'text/html' : 'text/plain'; return [ 200, [ 'Content-Type' => $content_type ], [ '{"foo":"bar"}' ], ]; } 1; } use Plack::Runner; my $host = '127.0.0.1'; my $server = try { Test::TCP->new( host => $host, max_wait => 3, # seconds code => sub { my $port = shift; my $runner = Plack::Runner->new; $runner->parse_options( '--host' => $host, '--port' => $port, '--env' => 'test', '--server' => 'HTTP::Server::PSGI' ); $runner->run(My::TCP::Server->new->to_app); } ); } catch { plan skip_all => $_; }; my $url = "http://$host:" . $server->port; my $client = My::REST::Client->new; # text/plain with specific undef: no deserialization ok !ref($client->get("$url/plain", undef, {deserializer => undef })->data), 'plain with undef'; # text/plain with default: no deserialization ok !ref($client->get("$url/plain")->data), 'plain with default'; # text/plain with specific deserializer: deserialize is ref($client->get( "$url/plain", undef, { deserializer => 'application/json'})->data), 'HASH', "plain with specific deserializer"; # application/json with undef deserializer: no deserialization ok !ref($client->get("$url/json", undef, { deserializer => undef})->data), "json with undef"; # application/json with specific deserializer: deserialize is ref($client->get( "$url/json", undef, { deserializer => 'application/json'})->data), 'HASH', "json with specific deserializer"; # application/json with default: deserialize is ref($client->get("$url/json")->data), 'HASH', "json with default"; undef $server; done_testing(); Client000755001750000144 013117155434 17317 5ustar00kaareusers000000000000Role-REST-Client-0.22/lib/Role/RESTResponse.pm100644001750000144 360113117155434 21613 0ustar00kaareusers000000000000Role-REST-Client-0.22/lib/Role/REST/Clientpackage Role::REST::Client::Response; $Role::REST::Client::Response::VERSION = '0.22'; use Moo; use MooX::HandlesVia; use Types::Standard qw(Str Int CodeRef InstanceOf); has 'code' => ( isa => Int, is => 'ro', ); has 'response' => ( isa => InstanceOf['HTTP::Response'], is => 'ro', ); has 'error' => ( isa => Str, is => 'ro', predicate => 'failed', ); has 'data_callback' => ( init_arg => 'data', isa => CodeRef, is => 'ro', default => sub { sub { {} } }, handles_via => 'Code', handles => { data => 'execute' }, ); 1; __END__ =pod =encoding UTF-8 =head1 NAME Role::REST::Client::Response =head1 VERSION version 0.22 =head1 SYNOPSIS my $res = Role::REST::Client::Response->new( code => '200', response => HTTP::Response->new(...), error => 0, data_callback => sub { sub { ... } }, ); =head1 NAME Role::REST::Client::Response - Response class for REST =head1 ATTRIBUTES =head2 code HTTP status code of the request =head2 response L object. Use this if you need more information than status and content. =head2 error The error description returned from the user agent when the HTTP status code is 500 or higher. More detail may be found by calling C<< $res->response->content >>. =head2 failed True if the request didn't succeed. =head2 data The deserialized data. Returns an empty hashref if the response was unsuccessful. =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 =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 Serializer.pm100644001750000144 407013117155434 22127 0ustar00kaareusers000000000000Role-REST-Client-0.22/lib/Role/REST/Clientpackage Role::REST::Client::Serializer; $Role::REST::Client::Serializer::VERSION = '0.22'; use Try::Tiny; use Moo; use Types::Standard qw(Enum InstanceOf); use Data::Serializer::Raw; has 'type' => ( isa => Enum[qw{application/json application/xml application/yaml application/x-www-form-urlencoded text/javascript}], is => 'rw', default => sub { 'application/json' }, ); has 'serializer' => ( isa => InstanceOf['Data::Serializer::Raw'], is => 'ro', default => \&_set_serializer, lazy => 1, ); our %modules = ( 'application/json' => { module => 'JSON', }, 'application/xml' => { module => 'XML::Simple', }, 'application/yaml' => { module => 'YAML', }, 'application/x-www-form-urlencoded' => { module => 'FORM', }, 'text/javascript' => { module => 'JSON', }, ); sub _set_serializer { my $self = shift; return unless $modules{$self->type}; my $module = $modules{$self->type}{module}; return $module if $module eq 'FORM'; return Data::Serializer::Raw->new( serializer => $module, ); } sub content_type { my ($self) = @_; return $self->type; } sub serialize { my ($self, $data) = @_; return unless $self->serializer; my $result; try { $result = $self->serializer->serialize($data) } catch { warn "Couldn't serialize data with " . $self->type . ": $_"; }; return $result; } sub deserialize { my ($self, $data) = @_; return unless $self->serializer; my $result; try { $result = $self->serializer->deserialize($data); } catch { use Data::Dumper 'Dumper'; $Data::Dumper::Maxdepth = 4; warn 'Data was ' . Dumper([ $data ]), ' '; warn "Couldn't deserialize data with " . $self->type . ": $_"; }; return $result; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Role::REST::Client::Serializer =head1 VERSION version 0.22 =head1 AUTHOR Kaare Rasmussen =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