diff --git a/README.pod b/README.pod new file mode 100644 index 0000000..d271ca8 --- /dev/null +++ b/README.pod @@ -0,0 +1,141 @@ +=head1 NAME + +Google::Plus - simple interface to Google+ + +=head1 SYNOPSIS + + use Google::Plus; + use v5.10.1; + + my $plus = Google::Plus->new(key => $your_gplus_api_key); + + # get a person's profile + my $user_id = '112708775709583792684'; + my $person = $plus->person($user_id); + say "Name: ", $person->{displayName}; + + # get this person's activities + my $activities = $plus->activities($user_id); + while ($activities->{nextPageToken}) { + my $next = $activities->{nextPageToken}; + for my $item (@{$activities->{items}}) { + ...; + } + $activities = $plus->activities($user_id, $next); + } + + # get a specific activity + my $post = 'z13uxtsawqqwwbcjt04cdhsxcnfyir44xeg'; + my $act = $plus->activity($post); + say "Activity: ", $act->{title}; + +=head1 DESCRIPTION + +This module lets you access Google+ people profiles and activities from +Perl. Currently, only access to public data is supported; authenticated +requests for C and other private data will follow in a future +release. + +This module is B software, use at your own risk. + +=head1 ATTRIBUTES + +=head2 C + + my $key = $plus->key; + my $key = $plus->key('xxxxNEWKEYxxxx'); + +Google+ API key, used for retrieving content. Usually set using L. + +=head2 C + + my $ua = $plus->ua; + my $ua = $plus->ua(Mojo::UserAgent->new); + +User agent object that retrieves JSON from the Google+ API endpoint. +Defaults to a L object. This object will use +HTTP/HTTPS proxies when available (via C and C +environment variables.) + +=head1 METHODS + +L implements the following methods: + +=head2 C + + my $plus = Google::Plus->new(key => $google_plus_api_key); + +Construct a new L object. Needs a valid Google+ API key, +which you can get at L. + +=head2 C + + my $person = $plus->person('userId'); + my $person = $plus->person('userId', 'fields'); + +Get a Google+ person's public profile. Returns a L decoded +hashref describing the person's profile in L format. If +C is given, limit response to the specified fields; see the +Partial Responses section of L. + +=head2 C + + my $acts = $plus->activities('userId'); + my $acts = $plus->activities('userId', 'collection'); + my $acts = $plus->activities('userId', 'collection', nextPage'); + my $acts = $plus->activities('userId', 'collection', nextPage', 'fields'); + +Get person's list of public activities, returning a L +decoded hashref describing the person's activities in L format; this method also +accepts requesting partial responses if C is given. If +C is given, use that as the collection of activities to +list; the default is to list C activities instead. If a +C token is given, this method retrieves the next page of +activities this person has. + +=head2 C + + my $post = $plus->activity('activityId') + my $post = $plus->activity('activityId', fields'); + +Get a specific activity/post. Returns a L decoded hashref +describing the activity in L format. If C is +given, limit response to specified fields. + +=head1 SEE ALSO + +=over + +=item * L + +=item * L + +=item * L + +=item * L + +=back + +=cut + +=head1 DEVELOPMENT + +Send pull requests to +L. You can also post issues there or at L. + +=head1 AUTHOR + +Zak B. Elep, C + +=head1 COPYRIGHT AND LICENSE + +This software is Copyright (c) 2011, Zak B. Elep. + +This is free software, you can redistribute it and/or modify it under +the same terms as Perl language system itself. + +=cut