From 31baf7b70e2f7c63476685afe18fc7c4697274d4 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:35:13 +0200 Subject: meta class with role --- lib/MooseX/Net/API/Meta/Class.pm | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Class.pm b/lib/MooseX/Net/API/Meta/Class.pm index e4bed0c..376578d 100644 --- a/lib/MooseX/Net/API/Meta/Class.pm +++ b/lib/MooseX/Net/API/Meta/Class.pm @@ -1,25 +1,10 @@ package MooseX::Net::API::Meta::Class; use Moose::Role; -use Moose::Meta::Class; -use MooseX::Types::Moose qw(Str ArrayRef ClassName Object); -has local_api_methods => ( - traits => ['Array'], - is => 'ro', - isa => ArrayRef [Str], - required => 1, - default => sub { [] }, - auto_deref => 1, - handles => { '_add_api_method' => 'push' }, -); - -sub _build_meta_class { - my $self = shift; - return Moose::Meta::Class->create_anon_class( - superclasses => [ $self->method_metaclass ], - cache => 1, - ); -} +with qw/ + MooseX::Net::API::Meta::Method::APIMethod + MooseX::Net::API::Meta::Method::APIDeclare + /; 1; -- cgit 1.4.1 From 59536291a0e5687532a4b42a3302c4040db2bb5d Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:35:37 +0200 Subject: mx::net::api::method : attributes, wrapper, validates, ... --- lib/MooseX/Net/API/Meta/Method.pm | 209 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 201 insertions(+), 8 deletions(-) (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm index e9ceca7..12001c4 100644 --- a/lib/MooseX/Net/API/Meta/Method.pm +++ b/lib/MooseX/Net/API/Meta/Method.pm @@ -1,19 +1,212 @@ package MooseX::Net::API::Meta::Method; use Moose; +use MooseX::Net::API::Error; +use MooseX::Types::Moose qw/Str Int ArrayRef/; + extends 'Moose::Meta::Method'; -has description => ( is => 'ro', isa => 'Str' ); -has path => ( is => 'ro', isa => 'Str', required => 1 ); -has method => ( is => 'ro', isa => 'Str', required => 1 ); -has params => ( is => 'ro', isa => 'ArrayRef', required => 0 ); -has required => ( is => 'ro', isa => 'ArrayRef', required => 0 ); -has expected => ( is => 'ro', isa => 'ArrayRef', required => 0 ); +use Moose::Util::TypeConstraints; + +subtype UriPath => as 'Str' => where { $_ =~ m!^/! } => + message {"path must start with /"}; + +enum 'Method' => qw(GET POST PUT DELETE); + +has description => (is => 'ro', isa => 'Str'); +has method => (is => 'ro', isa => 'Method', required => 1); +has path => (is => 'ro', isa => 'UriPath', required => 1, coerce => 1); +has params_in_url => (is => 'ro', isa => 'Bool', default => 0); +has authentication => (is => 'ro', isa => 'Bool', required => 0, default => 0); +has expected => ( + traits => ['Array'], + is => 'ro', + isa => ArrayRef [Int], + auto_deref => 1, + required => 0, + predicate => 'has_expected', + handles => {find_expected_code => 'grep',}, +); +has params => ( + traits => ['Array'], + is => 'ro', + isa => ArrayRef [Str], + required => 0, + default => sub { [] }, + auto_deref => 1, + handles => {find_param => 'first',} +); +has required => ( + traits => ['Array'], + is => 'ro', + isa => ArrayRef [Str], + default => sub { [] }, + auto_deref => 1, + required => 0, +); + +before wrap => sub { + my $class = shift; + my %args = @_; + + $class->_validate_params_before_install(\%args); + $class->_validate_required_before_install(\%args); +}; -sub new { +sub wrap { my $class = shift; my %args = @_; - $class->SUPER::wrap(@_); + + if (!defined $args{body}) { + my $code = sub { + my ($self, %method_args) = @_; + + my $method = + $self->meta->find_method_by_name($args{name}) + ->get_original_method; + + $method->_validate_before_execute(\%method_args); + + my $path = $method->build_path(\%method_args); + my $local_url = $method->build_uri($self, $path); + + my $result = $self->http_request( + $method->method => $local_url, + $method->params_in_url, \%method_args + ); + + my $code = $result->code; + + if ($method->has_expected + && !$method->find_expected_code(sub {/$code/})) + { + die MooseX::Net::API::Error->new( + reason => "unexpected code", + http_error => $result + ); + } + + my $content_type = $self->api_format + // $result->header('Content-Type'); + $content_type =~ s/(;.+)$//; + + my $content; + if ($result->is_success && $code != 204) { + my @deserialize_order = ($content_type, $self->api_format); + $content = + $self->deserialize($result->content, \@deserialize_order); + + if (!$content) { + die MooseX::Net::API::Error->new( + reason => "can't deserialize content", + http_error => $result, + ); + } + } + + if ($result->is_success) { + if (wantarray) { + return ($content, $result); + } + else { + return $content; + } + } + + die MooseX::Net::API::Error->new( + http_error => $result, + reason => $result->reason, + ); + }; + $args{body} = $code; + } + $class->SUPER::wrap(%args); +} + +sub _validate_params_before_install { + my ( $class, $args ) = @_; + if ( !$args->{params} && $args->{required} ) { + die MooseX::Net::API::Error->new( reason => + "You can't require a param that have not been declared" ); + } +} + +sub _validate_required_before_install { + my ( $class, $args ) = @_; + if ( $args->{required} ) { + foreach my $required ( @{ $args->{required} } ) { + die MooseX::Net::API::Error->new( reason => + "$required is required but is not declared in params" ) + if ( !grep { $_ eq $required } @{ $args->{params} } ); + } + } +} + +sub _validate_before_execute { + my ($self, $args) = @_; + for my $method (qw/check_params_before_run check_required_before_run/) { + $self->$method($args); + } +} + +sub check_params_before_run { + my ($self, $args) = @_; + + # check if there is no undeclared param + foreach my $arg (keys %$args) { + if (!$self->find_param(sub {/$arg/})) { + die MooseX::Net::API::Error->new( + reason => "'$arg' is not declared as a param"); + } + } +} + +sub check_required_before_run { + my ($self, $args) = @_; + + # check if all our params declared as required are present + foreach my $required ($self->required) { + if (!grep { $required eq $_ } keys %$args) { + die MooseX::Net::API::Error->new(reason => + "'$required' is declared as required, but is not present"); + } + } +} + +sub build_path { + my ($self, $args) = @_; + my $path = $self->path; + + my $max_iter = keys %$args; + my $i = 0; + while ($path =~ /(?:\$|:)(\w+)/g) { + my $match = $1; + $i++; + if (my $value = delete $args->{$match}) { + $path =~ s/(?:\$|:)$match/$value/; + } + if ($max_iter > $i) { + $path =~ s/(?:\$|:)(\w+)//; + } + } + return $path; +} + +sub build_uri { + my ($method, $self, $path) = @_; + + my $local_url = $self->api_base_url->clone; + my $path_url_base = $local_url->path; + $path_url_base =~ s/\/$// if $path_url_base =~ m!/$!; + $path_url_base .= $path; + + if ($self->api_format && $self->api_format_mode eq 'append') { + my $format = $self->api_format; + $path_url_base .= "." . $format; + } + + $local_url->path($path_url_base); + return $local_url; } 1; -- cgit 1.4.1 From 044f1054e38474d687df9a1e98c94f24582a663c Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:35:59 +0200 Subject: move code to roles --- lib/MooseX/Net/API/Meta/Method/APIDeclare.pm | 49 ++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 lib/MooseX/Net/API/Meta/Method/APIDeclare.pm (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm new file mode 100644 index 0000000..4ad5150 --- /dev/null +++ b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm @@ -0,0 +1,49 @@ +package MooseX::Net::API::Meta::Method::APIDeclare; + +use Moose::Role; +use MooseX::Net::API::Error; + +has options => ( + is => 'ro', + traits => ['Hash'], + isa => 'HashRef[Str|CodeRef]', + default => sub { {} }, + lazy => 1, + handles => { + set_option => 'set', + get_option => 'get', + }, +); + +sub add_net_api_declare { + my ($meta, $name, %options) = @_; + + if ($options{useragent}) { + die MooseX::Net::API::Error->new( + reason => "'useragent' must be a CODE ref") + unless ref $options{useragent} eq 'CODE'; + $meta->set_option(useragent => delete $options{useragent}); + } + + # XXX custom authentication_method (replace with before request !) + + # XXX for backward compatibility + for my $attr (qw/base_url format username password/) { + my $attr_name = "api_" . $attr; + if (exists $options{$attr} && !exists $options{$attr_name}) { + $options{$attr_name} = delete $options{$attr}; + } + } + + for my $attr (qw/api_base_url api_format api_username api_password authentication/) { + $meta->set_option($attr => $options{$attr}) if defined $options{$attr}; + } + + # XXX before_request after_request + + if (keys %options) { + # XXX croak + } +} + +1; -- cgit 1.4.1 From 54b15b8276e20b2ce6863ed65f6abf4963ccc363 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:36:25 +0200 Subject: remove code, let the wrapper do the work --- lib/MooseX/Net/API/Meta/Method/APIMethod.pm | 59 +++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 lib/MooseX/Net/API/Meta/Method/APIMethod.pm (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method/APIMethod.pm b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm new file mode 100644 index 0000000..b1d0777 --- /dev/null +++ b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm @@ -0,0 +1,59 @@ +package MooseX::Net::API::Meta::Method::APIMethod; + +use Moose::Role; +use MooseX::Net::API::Error; +use MooseX::Net::API::Meta::Method; +use MooseX::Types::Moose qw/Str ArrayRef/; + +has local_api_methods => ( + traits => ['Array'], + is => 'ro', + isa => ArrayRef [Str], + required => 1, + default => sub { [] }, + auto_deref => 1, + handles => { + _get_api_method => 'grep', + _add_api_method => 'push', + _all_api_methods => 'elements', + }, +); + +before add_net_api_method => sub { + my ($meta, $name) = @_; + if (my @method = $meta->_get_api_method(sub {/^$name$/})) { + die MooseX::Net::API::Error->new( + reason => "method '$name' is already declared in " . $meta->name); + } +}; + +sub add_net_api_method { + my ($meta, $name, %options) = @_; + + my $code = delete $options{code}; + $meta->add_method( + $name, + MooseX::Net::API::Meta::Method->wrap( + name => $name, + package_name => $meta->name, + body => $code, + %options + ), + ); + $meta->_add_api_method($name); +} + +after add_net_api_method => sub { + my ($meta, $name, %options) = @_; + $meta->add_before_method_modifier( + $name, + sub { + my $self = shift; + die MooseX::Net::API::Error->new( + reason => "'api_base_url' have not been defined") + unless $self->api_base_url; + } + ); +}; + +1; -- cgit 1.4.1 From b9d5222b73faf3577833008e32d55d16d5e4818b Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:52:22 +0200 Subject: move content deserialization to role --- lib/MooseX/Net/API/Meta/Method.pm | 34 +++++++++----------------------- lib/MooseX/Net/API/Role/Serialization.pm | 24 ++++++++++++++++++++++ 2 files changed, 33 insertions(+), 25 deletions(-) (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm index 12001c4..03e0612 100644 --- a/lib/MooseX/Net/API/Meta/Method.pm +++ b/lib/MooseX/Net/API/Meta/Method.pm @@ -67,8 +67,8 @@ sub wrap { $method->_validate_before_execute(\%method_args); - my $path = $method->build_path(\%method_args); - my $local_url = $method->build_uri($self, $path); + my $path = $method->_build_path(\%method_args); + my $local_url = $method->_build_uri($self, $path); my $result = $self->http_request( $method->method => $local_url, @@ -76,7 +76,7 @@ sub wrap { ); my $code = $result->code; - + if ($method->has_expected && !$method->find_expected_code(sub {/$code/})) { @@ -86,23 +86,7 @@ sub wrap { ); } - my $content_type = $self->api_format - // $result->header('Content-Type'); - $content_type =~ s/(;.+)$//; - - my $content; - if ($result->is_success && $code != 204) { - my @deserialize_order = ($content_type, $self->api_format); - $content = - $self->deserialize($result->content, \@deserialize_order); - - if (!$content) { - die MooseX::Net::API::Error->new( - reason => "can't deserialize content", - http_error => $result, - ); - } - } + my $content = $self->get_content($result);; if ($result->is_success) { if (wantarray) { @@ -144,12 +128,12 @@ sub _validate_required_before_install { sub _validate_before_execute { my ($self, $args) = @_; - for my $method (qw/check_params_before_run check_required_before_run/) { + for my $method (qw/_check_params_before_run _check_required_before_run/) { $self->$method($args); } } -sub check_params_before_run { +sub _check_params_before_run { my ($self, $args) = @_; # check if there is no undeclared param @@ -161,7 +145,7 @@ sub check_params_before_run { } } -sub check_required_before_run { +sub _check_required_before_run { my ($self, $args) = @_; # check if all our params declared as required are present @@ -173,7 +157,7 @@ sub check_required_before_run { } } -sub build_path { +sub _build_path { my ($self, $args) = @_; my $path = $self->path; @@ -192,7 +176,7 @@ sub build_path { return $path; } -sub build_uri { +sub _build_uri { my ($method, $self, $path) = @_; my $local_url = $self->api_base_url->clone; diff --git a/lib/MooseX/Net/API/Role/Serialization.pm b/lib/MooseX/Net/API/Role/Serialization.pm index b36955c..b813b03 100644 --- a/lib/MooseX/Net/API/Role/Serialization.pm +++ b/lib/MooseX/Net/API/Role/Serialization.pm @@ -1,7 +1,10 @@ package MooseX::Net::API::Role::Serialization; +use 5.010; + use Try::Tiny; use Moose::Role; +use MooseX::Net::API::Error; has serializers => ( traits => ['Hash'], @@ -15,6 +18,27 @@ has serializers => ( }, ); +sub get_content { + my ($self, $result) = @_; + + my $content_type = $self->api_format // $result->header('Content-Type'); + $content_type =~ s/(;.+)$//; + + my $content; + if ($result->is_success && $result->code != 204) { + my @deserialize_order = ($content_type, $self->api_format); + $content = $self->deserialize($result->content, \@deserialize_order); + + if (!$content) { + die MooseX::Net::API::Error->new( + reason => "can't deserialize content", + http_error => $result, + ); + } + } + $content; +} + sub deserialize { my ($self, $content, $list_of_formats) = @_; -- cgit 1.4.1 From 3f3ff5052101e26eb4c35c61637951f97b284c49 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 13:24:52 +0200 Subject: clean --- lib/MooseX/Net/API/Meta/Method.pm | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm index 03e0612..3f77d08 100644 --- a/lib/MooseX/Net/API/Meta/Method.pm +++ b/lib/MooseX/Net/API/Meta/Method.pm @@ -2,12 +2,12 @@ package MooseX::Net::API::Meta::Method; use Moose; use MooseX::Net::API::Error; +use Moose::Util::TypeConstraints; + use MooseX::Types::Moose qw/Str Int ArrayRef/; extends 'Moose::Meta::Method'; -use Moose::Util::TypeConstraints; - subtype UriPath => as 'Str' => where { $_ =~ m!^/! } => message {"path must start with /"}; @@ -104,6 +104,7 @@ sub wrap { }; $args{body} = $code; } + $class->SUPER::wrap(%args); } -- cgit 1.4.1 From 6b5a00cab381d5ed55d662be44b67112e13fbb1c Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 18:56:01 +0200 Subject: clean code --- lib/MooseX/Net/API/Meta/Method/APIDeclare.pm | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm index 4ad5150..b65ef41 100644 --- a/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm +++ b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm @@ -14,6 +14,22 @@ has options => ( get_option => 'get', }, ); +has accepted_options => ( + is => 'ro', + traits => ['Array'], + isa => 'ArrayRef[Str]', + default => sub { + [ qw/api_base_url + api_format + api_useranem + api_password + authentication + authentication_method/ + ]; + }, + lazy => 1, + auto_deref => 1, +); sub add_net_api_declare { my ($meta, $name, %options) = @_; @@ -25,8 +41,6 @@ sub add_net_api_declare { $meta->set_option(useragent => delete $options{useragent}); } - # XXX custom authentication_method (replace with before request !) - # XXX for backward compatibility for my $attr (qw/base_url format username password/) { my $attr_name = "api_" . $attr; @@ -35,15 +49,11 @@ sub add_net_api_declare { } } - for my $attr (qw/api_base_url api_format api_username api_password authentication/) { + for my $attr ($meta->accepted_options) { $meta->set_option($attr => $options{$attr}) if defined $options{$attr}; } # XXX before_request after_request - - if (keys %options) { - # XXX croak - } } 1; -- cgit 1.4.1 From fdb180a73f97d5a1456d5ac3d0a5a844e22d0ea9 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Thu, 3 Jun 2010 08:34:13 +0200 Subject: http-console: a simple http console to do REST query (like http://github.com/cloudhead/http-console) --- bin/http-console | 46 +++++++++++++++++++++++++++++ lib/MooseX/Net/API/Meta/Method.pm | 2 +- lib/MooseX/Net/API/Meta/Method/APIMethod.pm | 1 + 3 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 bin/http-console (limited to 'lib/MooseX/Net/API/Meta') diff --git a/bin/http-console b/bin/http-console new file mode 100644 index 0000000..6f0e1f8 --- /dev/null +++ b/bin/http-console @@ -0,0 +1,46 @@ +use strict; +use warnings; +use 5.010; +use Term::ReadLine; + +use Getopt::Long; +use YAML::Syck; + +my $url = shift; +my $format_mode = 'append'; +my $format = 'json'; + +GetOptions( + 'm=s' => \$format_mode, + 'f=s' => \$format, +); + +package http::net::console; +use MooseX::Net::API; + +package main; + +my ($content, $result); + +my $term = Term::ReadLine->new("http::net::console"); +my $prompt = $url . '> '; +while (defined(my $in = $term->readline($prompt))) { + if ($in =~ /^(GET|PUT|POST|DELETE)\s(.*)$/) { + my $http_console = + http::net::console->new(api_base_url => $url, api_format => $format, api_format_mode => $format_mode); + $http_console->meta->add_net_api_method( + 'anonymous', + method => $1, + path => $2 + ); + ($content, $result) = $http_console->anonymous; + say $result->content; + } + if ($in eq 'show headers') { + if (defined $result) { + say Dump $result->headers; + }else{ + say "no headers to show"; + } + } +} diff --git a/lib/MooseX/Net/API/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm index 3f77d08..bb29a97 100644 --- a/lib/MooseX/Net/API/Meta/Method.pm +++ b/lib/MooseX/Net/API/Meta/Method.pm @@ -99,7 +99,7 @@ sub wrap { die MooseX::Net::API::Error->new( http_error => $result, - reason => $result->reason, + reason => $result->message, ); }; $args{body} = $code; diff --git a/lib/MooseX/Net/API/Meta/Method/APIMethod.pm b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm index b1d0777..8185522 100644 --- a/lib/MooseX/Net/API/Meta/Method/APIMethod.pm +++ b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm @@ -30,6 +30,7 @@ before add_net_api_method => sub { sub add_net_api_method { my ($meta, $name, %options) = @_; + # accept blessed method my $code = delete $options{code}; $meta->add_method( $name, -- cgit 1.4.1 From b62c50ed3c9b48d7d964134de5f4ef0fd36a6112 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Thu, 3 Jun 2010 09:50:39 +0200 Subject: update POD --- lib/MooseX/Net/API.pm | 12 +++++-- lib/MooseX/Net/API/Error.pm | 1 - lib/MooseX/Net/API/Meta/Class.pm | 26 +++++++++++++++ lib/MooseX/Net/API/Meta/Method.pm | 32 ++++++++++++++++-- lib/MooseX/Net/API/Meta/Method/APIDeclare.pm | 28 +++++++++++++++- lib/MooseX/Net/API/Meta/Method/APIMethod.pm | 26 +++++++++++++++ lib/MooseX/Net/API/Parser.pm | 27 +++++++++++++++ lib/MooseX/Net/API/Parser/JSON.pm | 26 +++++++++++++++ lib/MooseX/Net/API/Parser/XML.pm | 26 +++++++++++++++ lib/MooseX/Net/API/Parser/YAML.pm | 26 +++++++++++++++ lib/MooseX/Net/API/Role/Authentication.pm | 36 ++++++++++++++++++++ lib/MooseX/Net/API/Role/Deserialize.pm | 49 ---------------------------- lib/MooseX/Net/API/Role/Format.pm | 44 +++++++++++++++++++++++++ lib/MooseX/Net/API/Role/Request.pm | 42 ++++++++++++++++++++++++ lib/MooseX/Net/API/Role/Serialization.pm | 46 ++++++++++++++++++++++++++ lib/MooseX/Net/API/Role/UserAgent.pm | 34 ++++++++++++++++++- 16 files changed, 424 insertions(+), 57 deletions(-) delete mode 100644 lib/MooseX/Net/API/Role/Deserialize.pm (limited to 'lib/MooseX/Net/API/Meta') diff --git a/lib/MooseX/Net/API.pm b/lib/MooseX/Net/API.pm index b6f0f28..2dcfc13 100644 --- a/lib/MooseX/Net/API.pm +++ b/lib/MooseX/Net/API.pm @@ -72,11 +72,11 @@ MooseX::Net::API - Easily create client for net API ); # declaring a users method - # calling $obj->users will call http://exemple.com/api/users?country=france + # calling $obj->users will call http://exemple.com/api/users/france net_api_method users => ( description => 'this get a list of users', method => 'GET', - path => '/users/', + path => '/users/:country', params => [qw/country/], ); @@ -155,6 +155,14 @@ The following methods are added to your class: =item B +=item B + +=item B + +=item B + +=item B + =back =head2 METHODS diff --git a/lib/MooseX/Net/API/Error.pm b/lib/MooseX/Net/API/Error.pm index a710205..8825877 100644 --- a/lib/MooseX/Net/API/Error.pm +++ b/lib/MooseX/Net/API/Error.pm @@ -29,7 +29,6 @@ sub error { } 1; - __END__ =head1 NAME diff --git a/lib/MooseX/Net/API/Meta/Class.pm b/lib/MooseX/Net/API/Meta/Class.pm index 376578d..9fdd793 100644 --- a/lib/MooseX/Net/API/Meta/Class.pm +++ b/lib/MooseX/Net/API/Meta/Class.pm @@ -8,3 +8,29 @@ with qw/ /; 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Meta::Class + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm index bb29a97..7c388b9 100644 --- a/lib/MooseX/Net/API/Meta/Method.pm +++ b/lib/MooseX/Net/API/Meta/Method.pm @@ -11,13 +11,13 @@ extends 'Moose::Meta::Method'; subtype UriPath => as 'Str' => where { $_ =~ m!^/! } => message {"path must start with /"}; -enum 'Method' => qw(GET POST PUT DELETE); +enum Method => qw(GET POST PUT DELETE); has description => (is => 'ro', isa => 'Str'); has method => (is => 'ro', isa => 'Method', required => 1); has path => (is => 'ro', isa => 'UriPath', required => 1, coerce => 1); -has params_in_url => (is => 'ro', isa => 'Bool', default => 0); -has authentication => (is => 'ro', isa => 'Bool', required => 0, default => 0); +has params_in_url => (is => 'ro', isa => 'Bool', default => 0); +has authentication => (is => 'ro', isa => 'Bool', default => 0); has expected => ( traits => ['Array'], is => 'ro', @@ -195,3 +195,29 @@ sub _build_uri { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Meta::Class::Method + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm index b65ef41..14fb83d 100644 --- a/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm +++ b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm @@ -21,7 +21,7 @@ has accepted_options => ( default => sub { [ qw/api_base_url api_format - api_useranem + api_username api_password authentication authentication_method/ @@ -57,3 +57,29 @@ sub add_net_api_declare { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Meta::Class::Method::APIDeclare + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Meta/Method/APIMethod.pm b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm index 8185522..d55fe82 100644 --- a/lib/MooseX/Net/API/Meta/Method/APIMethod.pm +++ b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm @@ -58,3 +58,29 @@ after add_net_api_method => sub { }; 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Meta::Class::Method::APIMethod + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Parser.pm b/lib/MooseX/Net/API/Parser.pm index d33d857..8bf74b0 100644 --- a/lib/MooseX/Net/API/Parser.pm +++ b/lib/MooseX/Net/API/Parser.pm @@ -6,3 +6,30 @@ sub encode {die "must be implemented"} sub decode {die "must be implemented"} 1; + +__END__ + +=head1 NAME + +MooseX::Net::API::Parser + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Parser/JSON.pm b/lib/MooseX/Net/API/Parser/JSON.pm index 4711a8a..bf4c08b 100644 --- a/lib/MooseX/Net/API/Parser/JSON.pm +++ b/lib/MooseX/Net/API/Parser/JSON.pm @@ -15,3 +15,29 @@ sub decode { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Parser::JSON + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Parser/XML.pm b/lib/MooseX/Net/API/Parser/XML.pm index f831cf1..8aee74f 100644 --- a/lib/MooseX/Net/API/Parser/XML.pm +++ b/lib/MooseX/Net/API/Parser/XML.pm @@ -22,3 +22,29 @@ sub decode { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Parser::XML + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Parser/YAML.pm b/lib/MooseX/Net/API/Parser/YAML.pm index f359831..5258796 100644 --- a/lib/MooseX/Net/API/Parser/YAML.pm +++ b/lib/MooseX/Net/API/Parser/YAML.pm @@ -15,3 +15,29 @@ sub decode { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Parser::YAML + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Role/Authentication.pm b/lib/MooseX/Net/API/Role/Authentication.pm index 6c38641..0b6de69 100644 --- a/lib/MooseX/Net/API/Role/Authentication.pm +++ b/lib/MooseX/Net/API/Role/Authentication.pm @@ -45,3 +45,39 @@ after BUILDALL => sub { }; 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Role::Authentication + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head2 ATTRIBUTES + +=over 4 + +=item B + +=item B + +=back + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Role/Deserialize.pm b/lib/MooseX/Net/API/Role/Deserialize.pm deleted file mode 100644 index cf69087..0000000 --- a/lib/MooseX/Net/API/Role/Deserialize.pm +++ /dev/null @@ -1,49 +0,0 @@ -package MooseX::Net::API::Role::Deserialize; - -use Moose::Role; -use JSON::XS; -use YAML::Syck; -use XML::Simple; -use Try::Tiny; - -my $reverse_content_type = { - 'application/json' => 'json', - 'application/x-yaml' => 'yaml', - 'text/xml' => 'xml', - 'application/xml' => 'xml', -}; - -sub _from_json { - return decode_json( $_[1] ); -} - -sub _from_yaml { - return Load $_[1]; -} - -sub _from_xml { - my $xml = XML::Simple->new( ForceArray => 0 ); - $xml->XMLin( $_[1] ); -} - -sub _do_deserialization { - my ( $caller, $raw_content, @content_types ) = @_; - - my $content; - foreach my $deserializer (@content_types) { - my $method; - if ( $reverse_content_type->{$deserializer} ) { - $method = '_from_' . $reverse_content_type->{$deserializer}; - } - else { - $method = '_from_' . $deserializer; - } - next if ( !$caller->meta->find_method_by_name($method) ); - try { - $content = $caller->$method($raw_content); - }; - return $content if $content; - } -} - -1; diff --git a/lib/MooseX/Net/API/Role/Format.pm b/lib/MooseX/Net/API/Role/Format.pm index 32dbc98..e766161 100644 --- a/lib/MooseX/Net/API/Role/Format.pm +++ b/lib/MooseX/Net/API/Role/Format.pm @@ -39,3 +39,47 @@ has api_format_mode => ( ); 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Role::Format + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head2 METHODS + +=over 4 + +=item B + +=back + +=head2 ATTRIBUTES + +=over 4 + +=item B + +=item B + +=back + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Role/Request.pm b/lib/MooseX/Net/API/Role/Request.pm index eabb32d..214411c 100644 --- a/lib/MooseX/Net/API/Role/Request.pm +++ b/lib/MooseX/Net/API/Role/Request.pm @@ -50,3 +50,45 @@ sub http_request { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Role::Request + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head2 METHODS + +=over 4 + +=item B + +=back + +=head2 ATTRIBUTES + +=over 4 + +=item B + +=back + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Role/Serialization.pm b/lib/MooseX/Net/API/Role/Serialization.pm index b813b03..d4feb56 100644 --- a/lib/MooseX/Net/API/Role/Serialization.pm +++ b/lib/MooseX/Net/API/Role/Serialization.pm @@ -70,3 +70,49 @@ sub _load_serializer { } 1; +__END__ + +=head1 NAME + +MooseX::Net::API::Role::Serialization + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head2 ATTRIBUTES + +=over 4 + +=item B + +=back + +=head2 METHODS + +=over 4 + +=item B + +=item B + +=item B + +=back + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/Net/API/Role/UserAgent.pm b/lib/MooseX/Net/API/Role/UserAgent.pm index 0c11732..c3a1d5b 100644 --- a/lib/MooseX/Net/API/Role/UserAgent.pm +++ b/lib/MooseX/Net/API/Role/UserAgent.pm @@ -20,5 +20,37 @@ has api_useragent => ( ); 1; - __END__ + +=head1 NAME + +MooseX::Net::API::Role::UseAgent + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +=head2 ATTRIBUTES + +=over 4 + +=item B + +=back + +=head1 AUTHOR + +franck cuny Efranck@lumberjaph.netE + +=head1 SEE ALSO + +=head1 LICENSE + +Copyright 2009, 2010 by Linkfluence + +http://linkfluence.net + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut -- cgit 1.4.1