1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
package Net::HTTP::Spore;
# ABSTRACT: SPORE client
use Moose;
use IO::All;
use JSON;
use Carp;
use Try::Tiny;
use Net::HTTP::Spore::Core;
our $VERSION = 0.01;
sub new_from_string {
my ($class, $string, %args) = @_;
my $spec;
try {
$spec = JSON::decode_json($string);
}catch{
Carp::confess("unable to parse JSON spec: ".$_);
};
my ( $spore_class, $spore_object );
# XXX should we let the possibility to override this super class, or add
# another superclasses?
$spore_class =
Class::MOP::Class->create_anon_class(
superclasses => ['Net::HTTP::Spore::Core'] );
try {
my $base_url;
if ( $spec->{base_url} && !$args{base_url} ) {
$args{base_url} = $spec->{base_url};
}
elsif ( !$args{base_url} ) {
die "base_url is missing!";
}
if ( $spec->{formats} ) {
$args{formats} = $spec->{formats};
}
if ( $spec->{authentication} ) {
$args{authentication} = $spec->{authentication};
}
$spore_object = $spore_class->new_object(%args);
$spore_object = _add_methods( $spore_object, $spec->{methods} );
}
catch {
Carp::confess( "unable to create new Net::HTTP::Spore object: " . $_ );
};
return $spore_object;
}
sub new_from_spec {
my ( $class, $spec_file, %args ) = @_;
Carp::confess("specification file is missing") unless $spec_file;
my ( $content, $spec );
if ( $spec_file =~ m!^http(s)?://! ) {
my $uri = URI->new($spec_file);
my $req = HTTP::Request->new(GET => $spec_file);
my $ua = LWP::UserAgent->new();
my $res = $ua->request( $req );
$content = $res->content;
}
else {
unless ( -f $spec_file ) {
Carp::confess("$spec_file does not exists");
}
$content < io($spec_file);
}
$class->new_from_string( $content, %args );
}
sub _add_methods {
my ($class, $methods_spec) = @_;
foreach my $method_name (keys %$methods_spec) {
$class->meta->add_spore_method($method_name,
%{$methods_spec->{$method_name}});
}
$class;
}
1;
=head1 SYNOPSIS
my $client = Net::HTTP::Spore->new_from_spec('twitter.json');
# for identica
my $client = Net::HTTP::Spore->new_from_spec('twitter.json', base_url => 'http://identi.ca/com/api');
$client->enable('Format::JSON');
my $timeline = $client->public_timeline(format => 'json');
my $tweets = $timeline->body;
foreach my $tweet (@$tweets) {
print $tweet->{user}->{screen_name}. " says ".$tweet->{text}."\n";
}
my $friends_timeline = $client->friends_timeline(format => 'json');
=head1 DESCRIPTION
This module is an implementation of the SPORE specification. To use this client, you need to use or to write a SPORE specification of an API. Some specifications are available L<http://github.com/SPORE/api-description>.
=head2 CLIENT CREATION
First you need to create a client. This can be done using two methods, B<new_from_spec> and B<new_from_string>. The client will read the specification file to create a appropriate methods to interact with the API.
=head2 MIDDLEWARES
It's possible to activate some middlewares to extend the usage of the client. If you're using an API that discuss in JSON, you can enable the middleware L<Net::HTTP::Spore::Middleware::JSON>.
$client->enable('Format::JSON');
or only on some path
$client->enable_if(sub{$_->[0]->path =~ m!/path/to/json/stuff!}, 'Format::JSON');
=head2 METHODS
=over 4
=item new_from_spec($specification_file, %args)
Create and return a L<Net::HTTP::Spore::Core> object, with methods
generated from the specification file. The specification file can
either be a file on disk or a remote URL.
=item new_from_string($specification_string, %args)
Create and return a L<Net::HTTP::Spore::Core> object, with methods
generated from the specification string.
=back
|
