GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::HTTP::SPORE (3)

.ds Aq ’

NAME

Net::HTTP::Spore - SPORE client

CONTENTS

VERSION

version 0.06

SYNOPSIS



    my $client = Net::HTTP::Spore->new_from_spec(twitter.json);

    # from JSON specification string
    my $client = Net::HTTP::Spore->new_from_string($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);



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. A description of the SPORE specification format is available at <http://github.com/SPORE/specifications/blob/master/spore_description.pod>

Some specifications for well-known services are available <http://github.com/SPORE/api-description>.

    CLIENT CREATION

First you need to create a client. This can be done using two methods, <B>new_from_specB> and <B>new_from_stringB>. The client will read the specification file to create a appropriate methods to interact with the API.

    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 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);



For very simple middlewares, you can simple pass in an anonymous function



    $client->enable( sub { my $request = shift; ... } );



    METHODS

new_from_spec($specification_file, %args) Create and return a 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.
new_from_string($specification_string, %args) Create and return a Net::HTTP::Spore::Core object, with methods generated from a JSON specification string.

    TRACING

Net::HTTP::Spore provides a way to trace what’s going on when doing a request.

Enabling Trace

You can enable tracing using the environment variable <B>SPORE_TRACEB>. You can also enable tracing at construct time by adding <B>trace => 1B> when calling <B>new_from_specB>.

Trace Output

By default output will be directed to <B>STDERRB>. You can specify another default output:



    SPORE_TRACE=1=log.txt



or



    ->new_from_spec(spec.json, trace => 1=log.txt);



AUTHORS

o franck cuny <franck@lumberjaph.net>
o Ash Berlin <ash@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by linkfluence.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 NET::HTTP::SPORE (3) 2013-04-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.