gplus 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+## v0.5.0: 2011/09/18
+
+* Add support for the Comments API
+
+## v0.4.0: 2011/09/18
+
+* Handle refreshing of OAuth tokens
+
+## v0.3.1: 2011/09/17
+
+* Add YARD documentation for all public methods
+
+## v0.3.0: 2011/09/17
+
+* API key based requests for public data
+
+## v0.2.2: 2011/09/16
+
+* Bug fixes
+
+## v0.2.1: 2011/09/16
+
+* Bug fixes
+
+## v0.2.0: 2011/09/16
+
+* Add support for the Activities API
+
+## v0.1.0: 2011/09/16
+
+* Add support for OAuth authorization for non-public data
+* Add support for the People API

data/README.md

@@ -10,12 +10,13 @@ It currently has full support for the People and Activities APIs, using either O
 
 * [Documentation](http://rubydoc.info/github/nfm/gplus/master/frames)
 * [Issues](https://github.com/nfm/gplus/issues)
+* [Changelog](https://github.com/nfm/gplus/blob/master/CHANGELOG.md)
 
 ## Installation
 
-Add gplus to your Gemfile, then run `bundle install`.
+Add the current version of gplus to your Gemfile, then run `bundle install`.
 
-    gem "gplus", "~> 0.3.1"
+    gem "gplus"
 
 ## Creating and configuring your application
 
@@ -122,7 +123,7 @@ The activity will be returned as a nested hash:
 
     activity[:actor][:displayName]
     activity[:object][:replies][:totalItems]
-    activity[:attachments].each do { |a| a[:url] }
+    activity[:attachments].each do { |attachment| attachment[:url] }
 
 List a person's activities with `client.list_activities`:
 
@@ -132,20 +133,54 @@ The list will be returned as a nested hash. The actual activities are in the `:i
 
     activities[:title]
     activities[:updated]
-    activities[:items].each { |a| a.title }
+    activities[:items].each { |activity| activity[: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)
+    client.list_activities(person_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])
+    activities = client.list_activities(person_id, :results => 100)
+    more_activities = client.list_activities(person_id, :results => 100, :page => activities[:nextPageToken])
 
 See the Google+ 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).
 
+## [Comments](http://developers.google.com/+/api/latest/comments)
+
+Get an activity with `client.get_comment`:
+
+    comment = client.get_comment(id)
+
+The activity will be returned as a nested hash:
+
+    comment[:actor][:displayName]
+    comment[:object][:content][:totalItems]
+    comment[:inReplyTo][:id]
+
+List an activity's comments with `client.list_comments`:
+
+    comments = client.list_comments(activity_id)
+
+The list will be returned as a nested hash. The actual comments are in the `:items` array:
+
+    comments[:title]
+    comments[:updated]
+    comments[:items].each { |comment| comment[:object][:content] }
+
+By default, this will fetch 20 comments. You can fetch between 1 and 100 by passing a `:results` argument:
+
+    # Get 80 results
+    client.list_comments(activity_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:
+
+    comments = client.list_comments(activity_id, :results => 100)
+    more_comments = client.list_comments(activity_id, :results => 100, :page => comments[:nextPageToken])
+
+See the Google+ API documentation for [Comments](http://developers.google.com/+/api/latest/comments), [Comments: get](http://developers.google.com/+/api/latest/comments/get) and [Comments: list](http://developers.google.com/+/api/latest/comments/list).
+
 ## Contributing to gplus
 
 Please submit bug reports as [Github Issues](https://github.com/nfm/Gplus/issues).

data/Rakefile

@@ -1,2 +1,6 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/gplus.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
   gem.add_runtime_dependency 'multi_json', '~> 1.0'
   gem.add_runtime_dependency 'oauth2', '~> 0.5'
+  gem.add_development_dependency 'rspec'
 end

data/lib/gplus/comment.rb

@@ -0,0 +1,23 @@
+module Gplus
+  class Client
+    # Get a Comment by its unique ID.
+    # See https://developers.google.com/+/api/latest/comments/get for more details.
+    #
+    # @param [String] id The unique ID of the comment you want to retrieve.
+    # @returb [Hash] A nested hash representation of a {https://developers.google.com/+/api/latest/comments Comment resource}.
+    def get_comment(id)
+      get("comments/#{id}")
+    end
+
+    # List an activity's comments.
+    # See http://developers.google.com/+/api/latest/comments/list for more details.
+    #
+    # @param [String] activity_id The unique ID of the activity whose comments you want to list.
+    # @param [Integer] results The number of comments, between 1 and 100, to return.
+    # @param [String] page The page of comments 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 a {http://developers.google.com/+/api/latest/comments/list list of comments}.
+    def list_comments(activity_id, results = 20, page = nil)
+      get("activities/#{activity_id}/comments", { :maxResults => results, :pageToken => page })
+    end
+  end
+end

data/lib/gplus/version.rb

@@ -1,3 +1,3 @@
 module Gplus
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/gplus/activity_spec.rb

@@ -0,0 +1,9 @@
+describe Gplus::Client do
+  describe '.get_activity' do
+    pending
+  end
+
+  describe '.list_activities' do
+    pending
+  end
+end

data/spec/gplus/client_spec.rb

@@ -0,0 +1,25 @@
+describe Gplus::Client do
+  describe '.initialize' do
+    pending
+  end
+
+  describe '.authorize_url' do
+    pending
+  end
+
+  describe '.authorize' do
+    pending
+  end
+
+  describe '.access_token' do
+    pending
+  end
+
+  describe '.access_token_refreshed?' do
+    pending
+  end
+
+  describe '.get' do
+    pending
+  end
+end

data/spec/gplus/comment_spec.rb

@@ -0,0 +1,9 @@
+describe Gplus::Client do
+  describe '.get_comment' do
+    pending
+  end
+
+  describe '.list_comments' do
+    pending
+  end
+end

data/spec/gplus/person_spec.rb

@@ -0,0 +1,5 @@
+describe Gplus::Client do
+  describe '.get_person' do
+    pending
+  end
+end

data/spec/gplus_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'gplus'
+require 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gplus
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-18 00:00:00.000000000Z
+date: 2011-10-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &18783920 !ruby/object:Gem::Requirement
+  requirement: &23027300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *18783920
+  version_requirements: *23027300
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &18783100 !ruby/object:Gem::Requirement
+  requirement: &23026460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,18 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *18783100
+  version_requirements: *23026460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &23025000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23025000
 description: A complete implementation of the Google plus API for Ruby
 email:
 - nicholas@2suggestions.com.au
@@ -41,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -48,8 +60,15 @@ files:
 - lib/gplus.rb
 - lib/gplus/activity.rb
 - lib/gplus/client.rb
+- lib/gplus/comment.rb
 - lib/gplus/person.rb
 - lib/gplus/version.rb
+- spec/gplus/activity_spec.rb
+- spec/gplus/client_spec.rb
+- spec/gplus/comment_spec.rb
+- spec/gplus/person_spec.rb
+- spec/gplus_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/nfm/gplus
 licenses: []
 post_install_message: