Net::Gnip - interact with Gnip


Net-Gnip documentation Contained in the Net-Gnip distribution.

Index


Code Index:

NAME

Top

Net::Gnip - interact with Gnip

SYNOPSIS

Top

    use Net::Gnip;
    my $gnip       = Net::Gnip->new($user, $pass, $publisher_name);

    # Get a list of publisher
    my @publisher = $gnip->publishers();
    $gnip->create_publisher($name);




    # Create an activity and publish it
    my $activity   = Net::Gnip::Activity->new('added_friend', 'me');
    $gnip->publish($publisher_name, $activity);
    # or
    $gnip->publish($publisher_name, @activities);
    # or
    $gnip->publish($activity_stream);

    # Retrieve activities for a given publisher
    my $stream     = $gnip->fetch(notification => $publisher_name);
    foreach my $activity ($stream->activities) {
        print "Type=".$activity->type."\n";
    }

    # Retrieve activities for a given publisher 10 minutes ago
    my $stream     = $gnip->fetch(notification => $publisher_name, time => 10*60);

    # Retrieve activities for a given publisher from a specific time
    my $stream     = $gnip->fetch(notification => $publisher_name, time => $dt);

    # The same but get the full date
    my $stream     = $gnip->fetch(activity => $publisher_name, time => $dt);




    # Create a filter and 
    my @rules  = ( { type => 'actor', value => 'joe' } );
    my $filter     = Net::Gnip::Filter->new('my_filter', 'true', [@rules]);
    my $result     = $gnip->create_filter($publisher_name, $filter); 

    # Get a list of filters
    foreach my $filters ($gnip->filters($publisher_name)) {
        print $filter->name."\n";
    }

    


    # Get the activities from it
    my $stream     = $gnip->fetch(activity => $publisher_name, filter => $filter_name);
    foreach my $activity ($stream->activities) {
        print "Type=".$activity->type."\n";
    }

    # Update it
    $filter->full('false');
    $gnip->update_filter($publisher_name, $filter);

    $gnip->add_filter_rule($filter,    'actor', 'simon');
    $gnip->delete_filter_rule($filter, 'actor', 'simon')

    


    # Delete it
    $gnip->delete_filter($publisher_name, $filter);







METHODS

new <username> <password>

Create a new Gnip object

fetch <publisher> [datetime])

Gets all of the data for a specific publisher, based on the datetime parameter.

If datetime is not passed in, the current time will be used.

Note that all times need to be as UTC DateTime objects.

Returns a Net::Gnip::ActivityStream object.

publish <activity stream>

Publish an activity stream.

publish <publisher name> <activity[s]>

filters <publisher name>

Get a list of filters for this publisher.

Returns a list of Net::Gnip::Filter objects.

create_filter <publisher name> <filter>

Creates a new filter.

get_filter <publisher name> <filter>

Fetches an existing filter.

filter can either be a filter object or a name.

Returns a Net::Gnip::Filter object.

update_filter <publisher name> <filter>

Updates an existing filter.

filter can either be a filter object or a name.

Returns 1 on success and 0 on failure.

delete_filter <publisher name> <filter>

Deletes an existing filter.

filter can either be a filter object or a name.

add_filter_rule <publisher> <filter> <type> <value>

Incrementally add a filter rule.

delete_filter_rule <publisher> <filter> <type> <value>

Incrementally delete a filter rule.

publishers

Gets a list of publishers on the system

create_publisher <publisher[s]>

Takes one or more Net::Gnip::Publisher objects and creates them.

Returns 1 on success and undef on failure (and sets $@)

get <url>

Does an HTTP GET request of the passed in url, and returns the result from the server.

Returns undef on failure (and sets $@)

post <url> <data object>

Does a HTTP POST request of the passed in url and data object, and returns the result from the server.

Returns undef on failure (and sets $@)

put <url> <data>

Does an HTTP PUT request of the passed in url and data object, and returns the result from the server.

Returns undef on failure (and sets $@)

delete <url>

Does a HTTP Delete request of the passed in url and returns the result from the server.

Returns undef on failure (and sets $@)

round_time_to_nearest_bucket <datetime>

Rounds the time passed in down to the previous 1 minute mark.

Returns a new DateTime object.

sync_with_gnip_clock <datetime>

This method gets the current time from the Gnip server.

Returns a new DateTime object.

time_to_string <datetime>

Converts the time passed in to a string of the form YYYYMMDDHHMM.

AUTHOR

Top

Simon Wistow <simon@thegestalt.org>

Based on code by ajackson from http://github.com/gnip/gnip-perl/tree/master

COPYRIGHT

Top


Net-Gnip documentation Contained in the Net-Gnip distribution.
package Net::Gnip;

use strict;

use DateTime;
use DateTime::Format::Strptime;
use LWP::UserAgent;

use Net::Gnip::ActivityStream;
use Net::Gnip::FilterStream;
use Net::Gnip::PublisherStream;

our $VERSION = "0.3";

use constant GNIP_BASE_ADDRESS => 'prod.gnipcentral.com';
use constant GNIP_BASE_URL     => 'https://'.GNIP_BASE_ADDRESS;

sub new {
    my ($class, $username, $password, %self) = @_;
    $self{'_username'} = $username;
    $self{'_password'} = $password;
    return bless {%self}, $class;
}



sub fetch {
    my $self          = shift;
    my %opts          = @_;

    my $what;
    my $name;

    for my $key (qw(notification activity)) {
        next unless defined $opts{$key};
        $what = $key;
        $name = $opts{$key};
    }
    die "You must must pass in either a 'notification' or 'activity' key with a publisher name"
        unless defined $what;

    
    my $path = "publishers/${name}";
    if (defined $opts{filter}) {
        $path .= "/filters/".$opts{filter};
    }
    $path .= "/${what}";

    my $datetime      = $opts{time};
    my $file          = "current.xml";

    if (defined $datetime) {
        $datetime = DateTime->now->subtract( seconds => $datetime) unless ref($datetime);
        unless ($self->{no_time_sync}) {
            my $gnip_time     = $self->sync_with_gnip_clock;
            my $local_time    = DateTime->now;
            $datetime         = $datetime + ($gnip_time - $local_time);
        }
        my $rounded       = $self->round_time_to_nearest_bucket($datetime);
        my $time_string   = $self->time_to_string($rounded);
        $file             = "${time_string}.xml";
    }
    my $url = $self->GNIP_BASE_URL."/".$path."/".$file;
    my $xml = $self->get($url) || return;
    return Net::Gnip::ActivityStream->parse($xml, _no_dt => $self->{_no_dt});
}

sub publish {
    my $self       = shift;
    my $publisher  = shift;
    my $stream;
    if (ref $publisher) {
        $stream    = $publisher;
        $publisher = $stream->publisher;
        die "An activity stream must have a publisher set if it's the only argument to publish()" 
            unless defined $publisher; 
    }
    die "You need to pass in some activities" unless @_;
    $stream        = Net::Gnip::ActivityStream->new( publisher => $publisher);
    $stream->activities(@_);
    my $url        = $self->GNIP_BASE_URL."/publishers/" . $publisher . "/activity";
    $self->post($url, $stream);
}



sub filters {
    my $self      = shift;
    my $publisher = shift;
    my $url       = $self->GNIP_BASE_URL."/publishers/$publisher/filters.xml";
    my $xml       = $self->get($url) || return;
    return Net::Gnip::FilterStream->parse($xml)->filters;
}


sub create_filter {
   my ($self, $publisher, $filter) = @_;
   my $url = $self->GNIP_BASE_URL."/publishers/$publisher/filters.xml";
   return $self->post($url, $filter);
}

sub get_filter {
    my $self = shift;
    my $xml  = $self->_filter_method('get', @_) || return;
    return Net::Gnip::Filter->parse($xml);
}

sub update_filter {
    my $self = shift;
    return $self->_filter_method('put', @_);
}

sub delete_filter {
    my $self = shift;
    return $self->_filter_method('delete', @_);
}

sub add_filter_rule {
    my $self      = shift;
    $self->_filter_method('post', @_);
}

sub delete_filter_rule {
    my $self = shift;
    $self->_filter_method('delete', @_);
}

sub _filter_method {
    my $self      = shift;
    my $method    = shift;
    my $publisher = shift;
    my $filter    = shift;
    my $type      = shift; 
    my $value     = shift;
    my $name = (ref($filter))? $filter->name : $filter;
    my $url = $self->GNIP_BASE_URL."/publishers/$publisher/filters/$name";
    if (defined $type && defined $value) {
        $url .= "/rules.xml?type=${type}&value=${value}";
        if ($method eq 'post') {
            $filter = Net::Gnip::Filter->_create_rule({ type => $type, value => $value })->toString(1);
        }
    } else {
        $url .= ".xml";
    }
    return $self->$method($url, $filter);
}


sub publishers {
   my ($self) = @_;

   my $url = $self->GNIP_BASE_URL."/publishers.xml";

   my $xml = $self->get($url) || return;
   return map { $_->name } Net::Gnip::PublisherStream->parse($xml)->publishers;
}



sub create_publisher {
   my $self   = shift;
   my $name   = shift;
   my $stream = Net::Gnip::PublisherStream->new(children => [ @_ ] );
   my $url = $self->GNIP_BASE_URL."/publishers.xml";
   return $self->post($url, $stream);

}

sub get {
   my $self = shift;
   return $self->_do_http('GET', @_);
}

sub post {
    my $self = shift;
    return $self->_do_http('POST', @_);
}

sub _do_http {
    my $self = shift;
    my $type = shift;
    my $url  = shift;
    my $response = $self->_do_request(1, $type, $url, @_);
    # Check the outcome of the response
    if ($response->is_success) {
        return $response->content;
    } else {
        $@ = "Failed to $type $url ".$response->status_line."\n\n".$response->as_string;
        return;
    }
}

sub _do_request {
    my $self = shift;
    my ($auth, $type, $url, $data) = @_;
    my $agent = $self->{_agent} ||= LWP::UserAgent->new;
    # Load proxy settings from *_proxy environment variables
    $agent->env_proxy;
    $agent->agent(__PACKAGE__."-".$VERSION);
    my $request = HTTP::Request->new($type => $url);
    $request->authorization_basic($self->{_username}, $self->{_password}) if $auth;
    if (defined $data) {
        $request->content_type('application/xml');
        $request->content((ref $data)?$data->as_xml:$data);
    }
    return $agent->request($request);
}


sub put {
   my $self = shift;
   return $self->_do_http('PUT', @_)
}

sub delete {
   my $self = shift;
   return $self->_do_http('DELETE', @_)
}

sub round_time_to_nearest_bucket {
   my $self     = shift;
   my $datetime = shift->clone;

   my $min = $datetime->minute();
   my $new = $min - ($min % 1);

   $datetime->set(minute => $new);
   $datetime->set(second => 0);

   return $datetime;
}

sub sync_with_gnip_clock {
    my $self = shift;

    my $response   = $self->_do_request(0, 'HEAD', GNIP_BASE_URL);
    my $formatter  = DateTime::Format::Strptime->new( pattern => '%a, %d %b %Y %H:%M:%S %Z' );
    my $gnip_time  = $formatter->parse_datetime($response->header('Date'));
    return $gnip_time;
}

sub time_to_string {
   my ($self, $datetime) = @_;
   return $datetime->strftime("%Y%m%d%H%M");
}

1;