From 0ce9554937e19d7c0045a68bc0c4184c84c236c4 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:37:02 +0200 Subject: role to handle useragent --- lib/MooseX/Net/API/Role/UserAgent.pm | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 lib/MooseX/Net/API/Role/UserAgent.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/UserAgent.pm b/lib/MooseX/Net/API/Role/UserAgent.pm new file mode 100644 index 0000000..0c11732 --- /dev/null +++ b/lib/MooseX/Net/API/Role/UserAgent.pm @@ -0,0 +1,24 @@ +package MooseX::Net::API::Role::UserAgent; + +use Moose::Role; +use LWP::UserAgent; + +has api_useragent => ( + is => 'rw', + isa => 'LWP::UserAgent', + lazy => 1, + default => sub { + my $self = shift; + my $ua = $self->meta->get_option('useragent'); + return $ua->() if $ua; + $ua = LWP::UserAgent->new(); + $ua->agent( + "MooseX::Net::API " . $MooseX::Net::API::VERSION . " (Perl)"); + $ua->env_proxy; + return $ua; + } +); + +1; + +__END__ -- cgit v1.2.3 From a2634d1eb978366d85a9b55153a90bd001950933 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:37:31 +0200 Subject: role to handle format informations --- lib/MooseX/Net/API/Role/Format.pm | 41 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 lib/MooseX/Net/API/Role/Format.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/Format.pm b/lib/MooseX/Net/API/Role/Format.pm new file mode 100644 index 0000000..32dbc98 --- /dev/null +++ b/lib/MooseX/Net/API/Role/Format.pm @@ -0,0 +1,41 @@ +package MooseX::Net::API::Role::Format; + +use Moose::Role; +use Moose::Util::TypeConstraints; + +sub content_type { + { json => {value => 'application/json', module => 'JSON',}, + yaml => {value => 'text/x-yaml', module => 'YAML'}, + xml => {value => 'text/xml', module => 'XML::Simple'}, + }; +} + +subtype Format => as 'Str' => where { + my $format = shift; + grep {/^$format$/} keys %{content_type()}; +}; + +enum 'FormatMode' => qw(content-type append); + +has api_format => ( + is => 'rw', + isa => 'Format', + lazy => 1, + default => sub { + my $self = shift; + $self->meta->get_option('api_format'); + } +); + +has api_format_mode => ( + is => 'rw', + isa => 'FormatMode', + lazy => 1, + default => sub { + my $self = shift; + my $mode = $self->meta->get_option('api_format_mode'); + $mode || 'append'; + } +); + +1; -- cgit v1.2.3 From 44e876662f72e88e5bd40c433a14e749d3ad5fdc Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:37:49 +0200 Subject: http_request and api_base_url are defined in this role --- lib/MooseX/Net/API/Role/Request.pm | 52 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 lib/MooseX/Net/API/Role/Request.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/Request.pm b/lib/MooseX/Net/API/Role/Request.pm new file mode 100644 index 0000000..eabb32d --- /dev/null +++ b/lib/MooseX/Net/API/Role/Request.pm @@ -0,0 +1,52 @@ +package MooseX::Net::API::Role::Request; + +use Moose::Role; +use HTTP::Request; +use MooseX::Net::API::Error; +use MooseX::Types::URI qw(Uri); + +has api_base_url => ( + is => 'rw', + isa => Uri, + coerce => 1, + lazy => 1, + default => sub { + my $self = shift; + my $api_base_url = $self->meta->get_option('api_base_url'); + if (!$api_base_url) { + die MooseX::Net::API::Error->new( + reason => "'api_base_url' have not been defined"); + } + $api_base_url; + } +); + +sub http_request { + my ($self, $method, $uri, $params_in_url, $args) = @_; + + my $request; + + if ( $method =~ /^(?:GET|DELETE)$/ || $params_in_url ) { + $uri->query_form(%$args); + $request = HTTP::Request->new( $method => $uri ); + } + elsif ( $method =~ /^(?:POST|PUT)$/ ) { + $request = HTTP::Request->new( $method => $uri ); + my $content = $self->serialize($args); + $request->content($content); + } + else { + die MooseX::Net::API::Error->new( + reason => "$method is not defined" ); + } + + $request->header( + 'Content-Type' => $self->content_type->{$self->api_format}->{value}) + if $self->api_format_mode eq 'content-type'; + + # XXX lwp hook! + my $result = $self->api_useragent->request($request); + return $result; +} + +1; -- cgit v1.2.3 From 1c4c26d1a82b81df4571568b21d919418f3355fa Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 11:38:07 +0200 Subject: use MX::Net::API::Parser to handle serialization --- lib/MooseX/Net/API/Role/Serialization.pm | 48 ++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 lib/MooseX/Net/API/Role/Serialization.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/Serialization.pm b/lib/MooseX/Net/API/Role/Serialization.pm new file mode 100644 index 0000000..b36955c --- /dev/null +++ b/lib/MooseX/Net/API/Role/Serialization.pm @@ -0,0 +1,48 @@ +package MooseX::Net::API::Role::Serialization; + +use Try::Tiny; +use Moose::Role; + +has serializers => ( + traits => ['Hash'], + is => 'rw', + isa => 'HashRef[MooseX::Net::API::Parser]', + default => sub { {} }, + auto_deref => 1, + handles => { + _add_serializer => 'set', + _get_serializer => 'get', + }, +); + +sub deserialize { + my ($self, $content, $list_of_formats) = @_; + + foreach my $format (@$list_of_formats) { + my $s = $self->_get_serializer($format) + || $self->_load_serializer($format); + next unless $s; + my $result = try { $s->decode($content) }; + return $result if $result; + } +} + +sub serialize { + my ($self, $content) = @_; + my $s = $self->_get_serializer($self->api_format); + my $result = try { $s->encode($content) }; + return $result if $result; +} + +sub _load_serializer { + my $self = shift; + my $format = shift || $self->api_format; + my $parser = "MooseX::Net::API::Parser::" . uc($format); + if (Class::MOP::load_class($parser)) { + my $o = $parser->new; + $self->_add_serializer($format => $o); + return $o; + } +} + +1; -- cgit v1.2.3 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/Role/Serialization.pm | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'lib/MooseX/Net/API/Role') 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 v1.2.3 From a86d71f615e207fe82cd5866d7d8f2d3abc842f1 Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 13:23:37 +0200 Subject: remove old serilizer --- lib/MooseX/Net/API/Role/Serialize.pm | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 lib/MooseX/Net/API/Role/Serialize.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/Serialize.pm b/lib/MooseX/Net/API/Role/Serialize.pm deleted file mode 100644 index f527928..0000000 --- a/lib/MooseX/Net/API/Role/Serialize.pm +++ /dev/null @@ -1,34 +0,0 @@ -package MooseX::Net::API::Role::Serialize; - -use Moose::Role; -use JSON::XS; -use YAML::Syck; -use XML::Simple; -use Try::Tiny; - -sub _to_json { - return encode_json( $_[1] ); -} - -sub _to_yaml { - return Dump $_[1]; -} - -sub _to_xml { - my $xml = XML::Simple->new( ForceArray => 0 ); - $xml->XMLin("$_[0]"); -} - -sub _do_serialization { - my ( $caller, $content, $format ) = @_; - - my $format_content; - my $method = '_to_' . $format; - return if ( !$caller->meta->find_method_by_name($method) ); - try { - $format_content = $caller->$method($content); - }; - return $format_content if $format_content; -} - -1; -- cgit v1.2.3 From 223e96504478e507e4d8e1627cb748fd4ec1c14b Mon Sep 17 00:00:00 2001 From: franck cuny Date: Wed, 2 Jun 2010 18:56:12 +0200 Subject: handle authentication --- lib/MooseX/Net/API/Role/Authentication.pm | 47 +++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 lib/MooseX/Net/API/Role/Authentication.pm (limited to 'lib/MooseX/Net/API/Role') diff --git a/lib/MooseX/Net/API/Role/Authentication.pm b/lib/MooseX/Net/API/Role/Authentication.pm new file mode 100644 index 0000000..6c38641 --- /dev/null +++ b/lib/MooseX/Net/API/Role/Authentication.pm @@ -0,0 +1,47 @@ +package MooseX::Net::API::Role::Authentication; + +use Moose::Role; + +has api_username => ( + is => 'rw', + isa => 'Str', + predicate => 'has_api_username', +); + +has api_password => ( + is => 'rw', + isa => 'Str', + predicate => 'has_api_password', +); + +# ugly :( +after BUILDALL => sub { + my $self = shift; + + for (qw/api_username api_password/) { + my $predicate = 'has_' . $_; + my $value = $self->meta->get_option($_); + $self->$_($value) if $value && !$self->$predicate; + } + + if (my $has_auth = $self->meta->get_option('authentication')) { + my $auth_method = $self->meta->get_option('authentication_method'); + if ($auth_method) { + $self->api_useragent->add_handler( + request_prepare => sub { $self->$auth_method(@_) }); + } + else { + if ($self->has_api_username && $self->has_api_password) { + $self->api_useragent->add_handler( + request_prepare => sub { + my $req = shift; + $req->headers->authorization_basic($self->api_username, + $self->api_password); + } + ); + } + } + } +}; + +1; -- cgit v1.2.3 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/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 ++++++++++++++++++++- 6 files changed, 201 insertions(+), 50 deletions(-) delete mode 100644 lib/MooseX/Net/API/Role/Deserialize.pm (limited to 'lib/MooseX/Net/API/Role') 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 v1.2.3