gplus 0.1.0 → 0.2.0

data/README.md

@@ -12,7 +12,7 @@ Lets work together to get Ruby on Google+ ASAP!
 
 gem install gplus
 
-## Using the gem
+## Creating and configuring your application
 
 To make requests, you need to [create an application](https://code.google.com/apis/console) with access to the Google+ API.
 
@@ -22,6 +22,91 @@ You can then specify additional redirect URIs and allowed javascript origins.
 
 You'll need the Client ID and Client secret that are generated. Keep them secure!
 
-Create a Google+ client:
+## Authorized requests
 
-    client = Gplus::Client.new(:client_id => 'YOUR_CLIENT_ID', :client_secret => 'YOUR_CLIENT_SECRET')
+Create an instance of the client using the credentials from when you set up your application:
+
+    @client = Gplus::Client.new(
+      :client_id => 'YOUR_CLIENT_ID',
+      :client_secret => 'YOUR_CLIENT_SECRET',
+      :redirect_uri => 'http://example.com/oauth2callback'
+    )
+
+Generate an authorization URL, and use it in a view:
+
+    @auth_url = @client.authorization_url
+    => https://accounts.google.com/o/oauth2/auth?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri= ...
+
+    = link_to 'Authorize This App', @auth_url
+
+After the user authorizes your app, they will be redirected to your `redirect_uri`. Store `params[:code]`:
+
+    def oauth_callback_handler
+      current_user.update_attributes(:oauth_code => params[:code])
+    end
+
+Finally, create an authorized client instance:
+
+    client.authorize(current_user.oauth_code)
+
+## [People](http://developers.google.com/+/api/latest/people)
+
+Get a person's profile with `client.get_person`:
+
+    person = client.get_person(id)
+
+You can use the id 'me' in place of a Person ID to fetch information about the user the client is authorized as.
+
+The person's profile will be returned as a nested hash:
+
+    person[:displayName]
+    person[:urls].count
+    person[:name][:middleName]
+
+See the API documentation for [People](http://developers.google.com/+/api/latest/people) and [People: get](http://developers.google.com/+/api/latest/people/get) for more info.
+
+## [Activities](http://developers.google.com/+/api/latest/activities)
+
+Get an activity with `client.get_activity`:
+
+    activity = client.get_activity(id)
+
+The activity will be returned as a nested hash:
+
+    activity[:actor][:displayName]
+    activity[:object][:replies][:totalItems]
+    activity[:attachments].each do { |a| a[:url] }
+
+List a person's activities with `client.list_activities`:
+
+    activities = client.list_activities(id)
+
+The list will be returned as a nested hash. The actual activities are in the `:items` array:
+
+    activities[:title]
+    activities[:updated]
+    activities[:items].each { |a| a.title }
+
+By default, this will fetch 20 activities. You can fetch between 1 and 100 by passing a `:results` argument:
+
+    # Get 80 results
+    client.list_activities(id, :results => 80)
+
+If you want more than 100 results, take the `:nextPageToken` returned from your first request, and pass it as a `:page` argument:
+
+    activities = client.list_activities(id, :results => 100)
+    more_activities = client.list_activities(id, :results => 100, :page => activities[:nextPageToken])
+
+See the API documentation for [Activities](http://developers.google.com/+/api/latest/activities), [Activities: get](http://developers.google.com/+/api/latest/activities/get) and [Activities: list](http://developers.google.com/+/api/latest/activities/list).
+
+## Contributing to Gplus
+
+Please submit bug reports as [Github Issues](https://github.com/nfm/Gplus/issues).
+
+For bonus points, submit a pull request:
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Commit and push your changes.
+5. Submit a pull request. Please do not include changes to the gemspec or version.

data/gplus.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/gplus/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Nicholas Firth-McCoy"]
   gem.email         = ["nicholas@2suggestions.com.au"]
-  gem.description   = %q{An *actual* Google+ gem!}
-  gem.summary       = %q{}
+  gem.description   = %q{A complete implementation of the Google plus API for Ruby}
+  gem.summary       = %q{Google+ API implementation with support for authorized requests, People, and Activities}
   gem.homepage      = "https://github.com/nfm/gplus"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/gplus/activity.rb

@@ -0,0 +1,11 @@
+module Gplus
+  module Activity
+    def get_activity(id)
+      get("activities/#{id}")
+    end
+
+    def list_activities(person_id, results = 20, page = nil)
+      get("people/#{person_id}/activities/public?maxResults=#{results}&pageToken=#{page}")
+    end
+  end
+end

data/lib/gplus/client.rb

@@ -1,3 +1,4 @@
+require 'gplus/activity'
 require 'gplus/person'
 
 module Gplus

data/lib/gplus/version.rb

@@ -1,3 +1,3 @@
 module Gplus
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gplus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &22201720 !ruby/object:Gem::Requirement
+  requirement: &17028120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *22201720
+  version_requirements: *17028120
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &22197600 !ruby/object:Gem::Requirement
+  requirement: &17027640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,8 +32,8 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *22197600
-description: An *actual* Google+ gem!
+  version_requirements: *17027640
+description: A complete implementation of the Google plus API for Ruby
 email:
 - nicholas@2suggestions.com.au
 executables: []
@@ -46,6 +46,7 @@ files:
 - Rakefile
 - gplus.gemspec
 - lib/gplus.rb
+- lib/gplus/activity.rb
 - lib/gplus/client.rb
 - lib/gplus/person.rb
 - lib/gplus/version.rb
@@ -72,5 +73,6 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Google+ API implementation with support for authorized requests, People,
+  and Activities
 test_files: []