summaryrefslogtreecommitdiff
path: root/lib/MooseX/Net/API/Meta
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/Meta
parentreplace remainging with nothing (diff)
parentfix attribute declaration (diff)
downloadnet-http-api-3da11a8153d3b42af2f2a250008be6cc52e57b09.tar.gz
merge
Diffstat (limited to 'lib/MooseX/Net/API/Meta')
-rw-r--r--lib/MooseX/Net/API/Meta/Class.pm51
-rw-r--r--lib/MooseX/Net/API/Meta/Method.pm220
-rw-r--r--lib/MooseX/Net/API/Meta/Method/APIDeclare.pm85
-rw-r--r--lib/MooseX/Net/API/Meta/Method/APIMethod.pm86
4 files changed, 414 insertions, 28 deletions
diff --git a/lib/MooseX/Net/API/Meta/Class.pm b/lib/MooseX/Net/API/Meta/Class.pm
index e4bed0c..9fdd793 100644
--- a/lib/MooseX/Net/API/Meta/Class.pm
+++ b/lib/MooseX/Net/API/Meta/Class.pm
@@ -1,25 +1,36 @@
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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Meta::Class
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=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/Meta/Method.pm b/lib/MooseX/Net/API/Meta/Method.pm
index e9ceca7..7c388b9 100644
--- a/lib/MooseX/Net/API/Meta/Method.pm
+++ b/lib/MooseX/Net/API/Meta/Method.pm
@@ -1,19 +1,223 @@
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';
-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 );
+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', 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,
+);
-sub new {
+before wrap => sub {
my $class = shift;
my %args = @_;
- $class->SUPER::wrap(@_);
+
+ $class->_validate_params_before_install(\%args);
+ $class->_validate_required_before_install(\%args);
+};
+
+sub wrap {
+ my $class = shift;
+ my %args = @_;
+
+ 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 = $self->get_content($result);;
+
+ if ($result->is_success) {
+ if (wantarray) {
+ return ($content, $result);
+ }
+ else {
+ return $content;
+ }
+ }
+
+ die MooseX::Net::API::Error->new(
+ http_error => $result,
+ reason => $result->message,
+ );
+ };
+ $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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Meta::Class::Method
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=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/Meta/Method/APIDeclare.pm b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm
new file mode 100644
index 0000000..14fb83d
--- /dev/null
+++ b/lib/MooseX/Net/API/Meta/Method/APIDeclare.pm
@@ -0,0 +1,85 @@
+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',
+ },
+);
+has accepted_options => (
+ is => 'ro',
+ traits => ['Array'],
+ isa => 'ArrayRef[Str]',
+ default => sub {
+ [ qw/api_base_url
+ api_format
+ api_username
+ api_password
+ authentication
+ authentication_method/
+ ];
+ },
+ lazy => 1,
+ auto_deref => 1,
+);
+
+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 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 ($meta->accepted_options) {
+ $meta->set_option($attr => $options{$attr}) if defined $options{$attr};
+ }
+
+ # XXX before_request after_request
+}
+
+1;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Meta::Class::Method::APIDeclare
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=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/Meta/Method/APIMethod.pm b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm
new file mode 100644
index 0000000..d55fe82
--- /dev/null
+++ b/lib/MooseX/Net/API/Meta/Method/APIMethod.pm
@@ -0,0 +1,86 @@
+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) = @_;
+
+ # accept blessed method
+ 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;
+__END__
+
+=head1 NAME
+
+MooseX::Net::API::Meta::Class::Method::APIMethod
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=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