gplus 0.3.0 → 0.3.1

data/README.md

@@ -8,11 +8,14 @@ I'm aiming to produce something light-weight, well documented, and thoroughly te
 
 It currently has full support for the People and Activities APIs, using either OAuth requests for private data or API key requests for public data.
 
+* [Documentation](http://rubydoc.info/gems/gplus/frames)
+* [Issues](https://github.com/nfm/gplus/issues)
+
 ## Installation
 
 Add GPlus to your Gemfile, then run `bundle install`.
 
-    gem "gplus", "~> 0.2.0"
+    gem "gplus", "~> 0.3.1"
 
 ## Creating and configuring your application
 
@@ -22,6 +25,8 @@ Next, [create an OAuth 2.0 client ID](http://code.google.com/apis/console#access
 
 You can then specify additional redirect URIs and allowed javascript origins.
 
+Currently, the Google+ API limits applications to 1,000 API requests per day. You can request an increase to this limit by visiting the [developer console](https://code.google.com/apis/console/) under the 'Quotas' section for your application.
+
 ## Unauthorized requests (for public data)
 
 Create an API client using your API key:

data/lib/gplus/activity.rb

@@ -1,9 +1,21 @@
 module Gplus
   class Client
+    # Get an Activity by its unique ID.
+    # See http://developers.google.com/+/api/latest/activities/get for more details.
+    #
+    # @param [String] id The unique ID of the activity you want to retrieve.
+    # @return [Hash] A nested hash representation of an {http://developers.google.com/+/api/latest/activities Activity resource}.
     def get_activity(id)
       get("activities/#{id}")
     end
 
+    # List a Person's Google+ activities.
+    # See http://developers.google.com/+/api/latest/activities/list for more details.
+    #
+    # @param [String] person_id The unique ID of the person whose activities you want to list. Pass the string 'me' to list the activities for the person that the API client is authorized as.
+    # @param [Integer] results The number of activities, between 1 and 100, to return.
+    # @param [String] page The page of activities to fetch. Pass the value of :nextPageToken from the previous result set to get the next page of results.
+    # @return [Hash] A nested hash representation of {http://developers.google.com/+/api/latest/activities/list list of activities}.
     def list_activities(person_id, results = 20, page = nil)
       get("people/#{person_id}/activities/public", { :maxResults => results, :pageToken => page })
     end

data/lib/gplus/client.rb

@@ -3,6 +3,15 @@ require 'gplus/person'
 
 module Gplus
   class Client
+    # Create a Google+ API client. Read the {file:README.md README} to find learn about the different ways of initializing a client.
+    #
+    # @param [Hash] options
+    # @option options [String] :api_key Your application's API key, used for non-authenticated requests (for public data).
+    # @option options [String] :token The OAuth token to authorize the API client for authenticated requests (for non-public data). This can be supplied after initialization by calling {#authorize}.
+    # @option options [String] :client_id Your application's Client ID. Required to generate an authorization URL with {#authorize_url}.
+    # @option options [String] :client_secret Your application's Client Secret. Required to generate an authorization URL with {#authorize_url}.
+    # @option options [String] :redirect_uri The default URI to redirect to after authorization. You can override this in many other methods. It must be specified as an authorized URI in your application's console. Required to generate an authorization URL with #authorize_url.
+    # @return [Gplus::Client] A Google+ API client.
     def initialize(options = {})
       @api_key = options[:api_key]
       @client_id = options[:client_id]
@@ -19,10 +28,18 @@ module Gplus
       )
     end
 
+    # Generate an authorization URL where a user can authorize your application to access their Google+ data.
+    #
+    # @param [String] redirect_uri An optional over-ride for the redirect_uri you initialized the API client with.
+    # @return [String] A Google account authorization URL for your application.
     def authorize_url(redirect_uri = @redirect_uri)
       @oauth_client.auth_code.authorize_url(:redirect_uri => redirect_uri, :scope => 'https://www.googleapis.com/auth/plus.me')
     end
 
+    # Authorize an API client instance to access the user's private data.
+    # @param [String] auth_code The code returned to your redirect_uri after the user authorized your application to access their Google+ data.
+    # @param [String] redirect_uri An optional over-ride for the redirect_uri you initialized the API client with.
+    # @return [OAuth2::AccessToken] An OAuth access token. Store access_token[:token] and access_token[:refresh_token] to get persistent access to the user's data until access_token[:expires_at].
     def authorize(auth_code, redirect_uri = @redirect_uri)
       @access_token = @oauth_client.auth_code.get_token(auth_code, :redirect_uri => redirect_uri)
     end

data/lib/gplus/person.rb

@@ -1,5 +1,10 @@
 module Gplus
   class Client
+    # Get a person's Google+ profile.
+    # See http://developers.google.com/+/api/latest/people/get for more details.
+    #
+    # @param [String] id The unique ID of the person whose profile you want to retrieve. Pass the string 'me' to fetch the profile for the person that the API client is authorized as.
+    # @return [Hash] A nested hash representation of a {http://developers.google.com/+/api/latest/people/get Person resource}
     def get_person(id)
       get("people/#{id}")
     end

data/lib/gplus/version.rb

@@ -1,3 +1,3 @@
 module Gplus
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gplus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &17792180 !ruby/object:Gem::Requirement
+  requirement: &11450460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *17792180
+  version_requirements: *11450460
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &17784300 !ruby/object:Gem::Requirement
+  requirement: &11449420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *17784300
+  version_requirements: *11449420
 description: A complete implementation of the Google plus API for Ruby
 email:
 - nicholas@2suggestions.com.au