summaryrefslogtreecommitdiff
path: root/lib/MooseX/Net/API/Role
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-06-03 10:01:01 +0200
committerfranck cuny <franck@lumberjaph.net>2010-06-03 10:01:01 +0200
commit3da11a8153d3b42af2f2a250008be6cc52e57b09 (patch)
tree4da02b541e9f8d35e5f20d63908cd33fe64dc7f8 /lib/MooseX/Net/API/Role
parentreplace remainging with nothing (diff)
parentfix attribute declaration (diff)
downloadnet-http-api-3da11a8153d3b42af2f2a250008be6cc52e57b09.tar.gz
merge
Diffstat (limited to '')
-rw-r--r--lib/MooseX/Net/API/Role/Authentication.pm83
-rw-r--r--lib/MooseX/Net/API/Role/Deserialize.pm49
-rw-r--r--lib/MooseX/Net/API/Role/Format.pm85
-rw-r--r--lib/MooseX/Net/API/Role/Request.pm94
-rw-r--r--lib/MooseX/Net/API/Role/Serialization.pm118
-rw-r--r--lib/MooseX/Net/API/Role/Serialize.pm34
-rw-r--r--lib/MooseX/Net/API/Role/UserAgent.pm56
7 files changed, 436 insertions, 83 deletions
diff --git a/lib/MooseX/Net/API/Role/Authentication.pm b/lib/MooseX/Net/API/Role/Authentication.pm
new file mode 100644
index 0000000..0b6de69
--- /dev/null
+++ b/lib/MooseX/Net/API/Role/Authentication.pm
@@ -0,0 +1,83 @@
+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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Role::Authentication
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head2 ATTRIBUTES
+
+=over 4
+
+=item B<api_password>
+
+=item B<api_username>
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=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
new file mode 100644
index 0000000..e766161
--- /dev/null
+++ b/lib/MooseX/Net/API/Role/Format.pm
@@ -0,0 +1,85 @@
+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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Role::Format
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head2 METHODS
+
+=over 4
+
+=item B<content_type>
+
+=back
+
+=head2 ATTRIBUTES
+
+=over 4
+
+=item B<api_format>
+
+=item B<api_format_mode>
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=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
new file mode 100644
index 0000000..214411c
--- /dev/null
+++ b/lib/MooseX/Net/API/Role/Request.pm
@@ -0,0 +1,94 @@
+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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Role::Request
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head2 METHODS
+
+=over 4
+
+=item B<http_request>
+
+=back
+
+=head2 ATTRIBUTES
+
+=over 4
+
+=item B<api_base_url>
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=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
new file mode 100644
index 0000000..d4feb56
--- /dev/null
+++ b/lib/MooseX/Net/API/Role/Serialization.pm
@@ -0,0 +1,118 @@
+package MooseX::Net::API::Role::Serialization;
+
+use 5.010;
+
+use Try::Tiny;
+use Moose::Role;
+use MooseX::Net::API::Error;
+
+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 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) = @_;
+
+ 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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Role::Serialization
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head2 ATTRIBUTES
+
+=over 4
+
+=item B<serializers>
+
+=back
+
+=head2 METHODS
+
+=over 4
+
+=item B<get_content>
+
+=item B<serialize>
+
+=item B<deserialize>
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=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/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;
diff --git a/lib/MooseX/Net/API/Role/UserAgent.pm b/lib/MooseX/Net/API/Role/UserAgent.pm
new file mode 100644
index 0000000..c3a1d5b
--- /dev/null
+++ b/lib/MooseX/Net/API/Role/UserAgent.pm
@@ -0,0 +1,56 @@
+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__
+
+=head1 NAME
+
+MooseX::Net::API::Role::UseAgent
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head2 ATTRIBUTES
+
+=over 4
+
+=item B<api_useragent>
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=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