google_plus 0.1.3 → 0.1.4

data/README.md

@@ -1,4 +1,4 @@
-# GooglePlus
+# [GooglePlus](http://rubygems.org/gems/google_plus)
 
 [![Build Status](https://secure.travis-ci.org/seejohnrun/google_plus.png)](http://travis-ci.org/seejohnrun/google_plus)
 
@@ -8,6 +8,8 @@ This is a Ruby client library for the [Google+ API](http://developers.google.com
 
     gem install google_plus
 
+## [Documentation](http://rdoc.info/gems/google_plus/file/README.md)
+
 ## Authentication
 
 To make calls to the Google+ API, you have to either authenticate via [OAuth](http://oauth.net/) or provide an API key (which you can get from the Google [APIs Console](https://code.google.com/apis/console#access).  To set your API key and get started, use:
@@ -20,6 +22,14 @@ If you want to change it for an individual request, you can use a param, like:
 
     person = GooglePlus::Person.get(123, :key => 'other_key')
 
+If you want to use [OAuth](http://oauth.net/) for authorization, you can use a method such as [OmniAuth](https://github.com/intridea/omniauth)'s [GoogleOAuth2 Strategy](http://rubydoc.info/gems/oa-oauth/0.3.0/OmniAuth/Strategies/GoogleOAuth2) to get an `access_token`, and then set it using:
+
+    GooglePlus.access_token = 'token'
+
+If you want to set it for an individual request (or series of requests), you can use a param like above:
+
+    person = GooglePlus::Person.get(123, :access_token => 'token')
+
 ## People
 
 Getting information about a person is easy, given that you have their Google+ ID:

data/lib/google_plus.rb

@@ -2,7 +2,7 @@ require 'bundler/setup'
 require File.dirname(__FILE__) + '/google_plus/resource'
 require File.dirname(__FILE__) + '/google_plus/cursor'
 
-# GooglePlus is a ruby library for accessing the 
+# GooglePlus is a ruby library for accessing the Google Plus API
 module GooglePlus
 
   autoload :Activity, File.dirname(__FILE__) + '/google_plus/activity'

data/lib/google_plus/activity.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/entity'
 
 module GooglePlus
 
+  # An Acitity in Google Plus
   class Activity
 
     extend GooglePlus::Resource

data/lib/google_plus/comment.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/entity'
 
 module GooglePlus
 
+  # A Comment in Google Plus
   class Comment
 
     extend GooglePlus::Resource

data/lib/google_plus/cursor.rb

@@ -2,10 +2,14 @@ require 'json'
 
 module GooglePlus
 
+  # A class for easily paginating through lists of Google Plus
+  # results.  Automatically handles details like nextPageToken
   class Cursor
 
     extend GooglePlus::Resource
 
+    # Get the current page of results
+    # @return [Array] the current page of results, or nil if the page is blank
     def items(params = {})
       if instance_variable_defined?(:@items)
         # TODO raise error if params are passed here, since they're meaningless
@@ -15,10 +19,17 @@ module GooglePlus
       end
     end
 
+    # Load the next page of results and load it as the current page
+    # @return [Array] the next page of results, or nil if the page is blank
     def next_page(params = {})
       @items = load_page(params)
     end
 
+    # Create a new cursor
+    # @param [Class] klass - The class type to instantiate members of this cursor as
+    # @param [Symbol] method - The HTTP method if this request
+    # @param [String] resource - The path of this request relative to the API
+    # @param [Hash] params - a set of parameters to be merged into the request
     def initialize(klass, method, resource, params = {})
       @first_page_loaded = false
       @resource_klass = klass

data/lib/google_plus/entity.rb

@@ -1,7 +1,15 @@
 module GooglePlus
 
+  # A mixin that allows retrieval of nested attributes
   module Entity
 
+    def self.included(base)
+      base.instance_eval do
+        undef_method :id if method_defined? :id
+      end
+    end
+
+    # Access an attribute of the Entity
     def method_missing(method, *arguments, &block)
       method_s = method.to_s
       if @attributes.has_key?(method_s)
@@ -16,6 +24,7 @@ module GooglePlus
       end
     end
 
+    # Determine if an attribute is set on the Entity
     def respond_to?(method, include_private = false)
       method_s = method.to_s
       if @attributes.has_key?(method_s)
@@ -25,10 +34,12 @@ module GooglePlus
       end
     end
 
+    # The raw accessible attributes
     attr_reader :attributes
 
     private
 
+    # Load the data from the hash into the Entity
     def load_hash(hash)
       # underscore all of the attributes
       @attributes = hash
@@ -40,10 +51,13 @@ module GooglePlus
 
   end
 
+  # A convenience class for wrapping nestings of Entity objects so that
+  # they can be traversed as deeply as desired
   class EntityHash
 
     include Entity
 
+    # Initialize a new EntityHash with the given data
     def initialize(hash = {})
       load_hash(hash)
     end

data/lib/google_plus/errors/connection_error.rb

@@ -1,5 +1,6 @@
 module GooglePlus
 
+  # A wrapper for errors encountered during connection, ie: SocketError
   class ConnectionError < Exception
 
     # Initialize a new ConnectionError

data/lib/google_plus/errors/request_error.rb

@@ -3,10 +3,15 @@ require File.dirname(__FILE__) + '/../entity'
 
 module GooglePlus
 
+  # An error class for wrapping errors made during requests, and making its attributes
+  # available similar to any [GooglePlus::Entity]
   class RequestError < Exception
 
     include GooglePlus::Entity
 
+    # Instantiate a new GooglePlus::RequestError and allow it to be accessed
+    # as an entity
+    # @param [Exception] e The original exception
     def initialize(e)
       load_hash JSON.parse(e.response.body)
     end

data/lib/google_plus/person.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/entity'
 
 module GooglePlus
 
+  # A Person in Google Plus
   class Person
 
     extend GooglePlus::Resource

data/lib/google_plus/resource.rb

@@ -4,6 +4,8 @@ require File.dirname(__FILE__) + '/errors/connection_error'
 
 module GooglePlus
 
+  # A modular extension for classes that make requests to the
+  # Google Plus API
   module Resource
 
     # Base resource URI - includes trailing slash

data/lib/google_plus/version.rb

@@ -1,5 +1,6 @@
 module GooglePlus
 
-  VERSION = '0.1.3'
+  # The current version of the library
+  VERSION = '0.1.4'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_plus
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-06 00:00:00.000000000Z
+date: 2011-10-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70229192765580 !ruby/object:Gem::Requirement
+  requirement: &70353324637400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70229192765580
+  version_requirements: *70353324637400
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70229192765020 !ruby/object:Gem::Requirement
+  requirement: &70353324636220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,18 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70229192765020
+  version_requirements: *70353324636220
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70353324635840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70353324635840
 description: Google+ Ruby Gem
 email: john.crepezzi@gmail.com
 executables: []