goodreads 0.2.1 → 0.2.2

data/.travis.yml

@@ -2,4 +2,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
+  - 2.0.0

data/Gemfile

@@ -1,4 +1,3 @@
-source 'http://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
 
+gemspec

data/README.md

@@ -1,18 +1,16 @@
-# Goodreads API wrapper
+# Goodreads [![Build Status](https://secure.travis-ci.org/sosedoff/goodreads.png)](http://travis-ci.org/sosedoff/goodreads)
 
-Ruby library to connect with Goodreads API.
-
-[![Build Status](https://secure.travis-ci.org/sosedoff/goodreads.png)](http://travis-ci.org/sosedoff/goodreads)
+Ruby wrapper to communicate with Goodreads API.
 
 ## Installation
 
-You can install this library via rubygems:
+Install gem with rubygems:
 
 ```
 gem install goodreads
 ```
 
-Or using rake:
+Or manually:
 
 ```
 rake install
@@ -20,28 +18,30 @@ rake install
 
 ## Getting Started
 
-In order to use Goodreads API you must obtain an API key for your account.
+Before using Goodreads API you must create a new application. Visit [signup form](http://www.goodreads.com/api/keys) for details.
 
 Setup client:
 
-```ruby
-client = Goodreads::Client.new(:api_key => 'YOUR_KEY')
-
-# or using a shortcut
-client = Goodreads.new(:api_key => 'YOUR_KEY')
+``` ruby
+client = Goodreads::Client.new(:api_key => 'KEY', :api_secret => 'SECRET')
+client = Goodreads.new(:api_key => 'KEY') # short version
 ```
 
 ### Global configuration
 
-Library allows you to define a global configuration options.
+You can define client credentials on global level. Just create an initializer file (if using rails) under
+`config/initializers`:
 
-```ruby
-Goodreads.configure(:api_key => 'YOUR_KEY')
+``` ruby
+Goodreads.configure(
+  :api_key => 'KEY',
+  :api_secret => 'SECRET'
+)
 ```
 
-Get current options:
+Get global configuration:
 
-```ruby
+``` ruby
 Goodreads.configuration # => {:api_key => 'YOUR_KEY'}
 ```
 
@@ -55,32 +55,55 @@ Goodreads.reset_configuration
 
 ### Lookup books
 
-Find a book by ISBN:
+You can lookup a book by ISBN, ID or Title:
 
 ```ruby
-book = client.book_by_isbn('ISBN')
+client.book('id')
+client.book_by_isbn('ISBN')
+client.book_by_title('Book title')
 ```
-  
-Find a book by Goodreads ID:
+
+Search for books (by title, isbn, genre):
 
 ```ruby
-book = client.book('id')
+search = client.search_books('The Lord Of The Rings')
+
+search.results.work.each do |book|
+  book.id        # => book id
+  book.title     # => book title
+end
 ```
-  
-Find a book by title:
+
+### Authors
+ 
+Look up an author by their Goodreads Author ID:
 
 ```ruby
-book = client.book_by_title('Book title')
+author = client.author('id')
+
+author.id              # => author id
+author.name            # => author's name
+author.link            # => link to author's Goodreads page
+author.fans_count      # => number of fans author has on Goodreads
+author.image_url       # => link to image of the author
+author.small_image_url # => link to smaller of the author
+author.about           # => description of the author
+author.influences      # => list of links to author's influences
+author.works_count     # => number of works by the author in Goodreads
+author.gender          # => author's gender
+author.hometown        # => author's hometown
+author.born_at         # => author's birthdate
+author.died_at         # => date of author's death
 ```
-  
-Search for books (by title, isbn, genre):
+
+Look up an author by name:
 
 ```ruby
-search = client.search_books('Your search query')
-search.results.work.each do |book|
-  book.id        # => book ID
-  book.title     # => book title
-end
+author = client.author_by_name('Author Name')
+
+author.id     # => author id
+author.name   # => author name
+author.link   # => link to author's Goodreads page
 ```
 
 ### Reviews
@@ -95,15 +118,16 @@ client.recent_reviews.each do |r|
   r.user.name     # => review user name
 end
 ```
-  
+
 Get review details:
 
 ```ruby
 review = client.review('id')
-review.id         # => ID
-review.user       # => User information
-review.book       # => Book information
-review.rating     # => User rating
+
+review.id         # => review id
+review.user       # => user information
+review.book       # => uook information
+review.rating     # => user rating
 ```
 
 ### Shelves
@@ -112,37 +136,76 @@ Get the books on a user's shelf:
 
 ```ruby
 shelf = client.shelf(user_id, shelf_name)
+
 shelf.books  # array of books on this shelf
 shelf.start  # start index of this page of paginated results
 shelf.end    # end index of this page of paginated results
 shelf.total  # total number of books on this shelf
 ```
 
-### User Id
+### Groups
 
-Get the user id of the user who authorized via OAuth:
+Get group details:
 
 ```ruby
-client = Goodreads::Client.new(:api_key => 'YOUR_KEY', :oauth_token => token)
-client.user_id  # id of user who authorized via OAuth
+group = client.group('id')
+
+group.id                 # => group id
+group.title              # => group title
+group.access             # => group's access settings
+                         # => (e.g., public or private)
+group.group_users_count  # => number of users in the group
 ```
 
-`token` is an instance of `OAuth::AccessToken`. See the [Goodreads documentation](http://www.goodreads.com/api/oauth_example) for examples of how to correct create one.
+List the groups a given user is a member of:
 
-## Contributions
+```ruby
+group_list = client.group_list('user_id', 'sort')
+
+group_list.total         # => total number of groups
+group_list.group.count  # => number of groups returned in the request
+
+# Loop through the list to get details for each of the groups.
+
+group_list.group.each do |g|
+  g.id                 # => group id
+  g.access             # => access settings (private, public)
+  g.users_count        # => number of members
+  g.title              # => title
+  g.image_url          # => url of the group's image
+  g.last_activity_at   # => date and time of the group's last activity
+end
+```
 
-Feel free to contribute any patches or new features.
+The `sort` parameter is optional, and defaults to `my_activity`. For other sorting options, [see here](http://www.goodreads.com/api#group.list).
+
+### OAuth
+
+For API calls requiring permission, such as write operations or browsing friends, see our [OAuth tutorial](examples/oauth.md).
+
+## Testing
+
+To run the test suite:
+
+```
+rake test
+```
+
+## Contributions
 
-Make sure to add a test coverage so it does not break any existing code.
+You're welcome to submit patches and new features.
 
-For documentation please visit [API Reference](http://www.goodreads.com/api)
+- Create a new branch for your feature of bugfix
+- Add tests so it does not break any existing code
+- Open a new pull request
+- Check official [API documentation](http://www.goodreads.com/api)
 
 ## License
 
-Copyright © 2011-2012 Dan Sosedoff.
+Copyright © 2011-2013 Dan Sosedoff.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/examples/oauth.md

@@ -0,0 +1,57 @@
+# Authorizing Goodreads via OAuth
+
+For services requiring permission, such as write operations or browsing friends, the client must be authorized through OAuth.
+
+## Request Tokens vs. Access Tokens
+
+First, get an OAuth *request* token:
+
+```ruby
+request_token = OAuth::Consumer.new(
+  Goodreads.configuration[:api_key],
+  Goodreads.configuration[:api_secret],
+  :site => 'http://www.goodreads.com'
+).get_request_token
+```
+
+Next, authorize by opening the authorization URL in a browser:
+
+```ruby
+request_token.authorize_url
+```
+
+Then request an OAuth *access* token:
+
+```ruby
+access_token = request_token.get_access_token
+```
+
+Finally, initialize a Goodreads client with it:
+
+```ruby
+goodreads_client = Goodreads.new :oauth_token => access_token
+```
+
+For more info, see the [Goodreads documentation](http://www.goodreads.com/api/oauth_example).
+
+## User ID
+
+Get the ID of the user who authorized via OAuth:
+
+```ruby
+goodreads_client.user_id
+```
+
+## Friends
+
+Get the friend details for a user:
+
+```ruby
+friends_hash = goodreads_client.friends [user_id]
+```
+
+Get a list of their names:
+
+```ruby
+friends_hash.user.map{ |u| u.name }
+```

data/goodreads.gemspec

@@ -9,17 +9,17 @@ Gem::Specification.new do |s|
   s.authors     = ["Dan Sosedoff"]
   s.email       = ["dan.sosedoff@gmail.com"]
   
-  s.add_development_dependency 'webmock',   '~> 1.6'
-  s.add_development_dependency 'rake',      '~> 0.8'
-  s.add_development_dependency 'rspec',     '~> 2.5'
-  s.add_development_dependency 'simplecov', '~> 0.4'
+  s.add_development_dependency 'webmock',   '~> 1.11'
+  s.add_development_dependency 'rake',      '~> 0.9'
+  s.add_development_dependency 'rspec',     '~> 2.12'
+  s.add_development_dependency 'simplecov', '~> 0.7'
   s.add_development_dependency 'yard',      '~> 0.6'
   
   s.add_runtime_dependency 'rest-client',   '~> 1.6'
-  s.add_runtime_dependency 'hashie',        '~> 1.0'
+  s.add_runtime_dependency 'hashie',        '~> 2.0'
   s.add_runtime_dependency 'activesupport', '~> 3'
   s.add_runtime_dependency 'i18n',          '~> 0.5'
-  s.add_runtime_dependency 'oauth',          '~> 0.4'
+  s.add_runtime_dependency 'oauth',         '~> 0.4'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/goodreads/client/authors.rb

@@ -7,5 +7,13 @@ module Goodreads
       data = request('/author/show', params)
       Hashie::Mash.new(data['author'])
     end
+
+    # Search for an author by name
+    #
+    def author_by_name(name, params={})
+      params[:id] = name
+      data = request('/api/author_url', params)
+      Hashie::Mash.new(data['author'])
+    end
   end
 end

data/lib/goodreads/client/friends.rb

@@ -0,0 +1,12 @@
+module Goodreads
+  module Friends
+    # Get the specified user's friends
+    #
+    # user_id - integer or string
+    #
+    def friends(user_id)
+      data = oauth_request("/friend/user/#{user_id}")
+      Hashie::Mash.new(data['friends'])
+    end
+  end
+end

data/lib/goodreads/client/groups.rb

@@ -0,0 +1,15 @@
+module Goodreads
+  module Groups
+    # Get group details
+    def group(group_id)
+      data = request('/group/show', :id => group_id)
+      Hashie::Mash.new(data['group'])
+    end
+
+    # Get list of groups a given user is a member of
+    def group_list(user_id, sort='my_activity')
+      data = request('/group/list', :id => user_id, :sort => sort)
+      Hashie::Mash.new(data['groups']['list'])
+    end
+  end
+end

data/lib/goodreads/client.rb

@@ -5,6 +5,8 @@ require 'goodreads/client/authors'
 require 'goodreads/client/users'
 require 'goodreads/client/shelves'
 require 'goodreads/client/authorized'
+require 'goodreads/client/groups'
+require 'goodreads/client/friends'
 
 module Goodreads
   class Client
@@ -15,22 +17,24 @@ module Goodreads
     include Goodreads::Users
     include Goodreads::Shelves
     include Goodreads::Authorized
-    
+    include Goodreads::Groups
+    include Goodreads::Friends
+
     attr_reader :api_key, :api_secret, :oauth_token
-    
+
     # Initialize a Goodreads::Client instance
     #
     # options[:api_key]     - Account API key
     # options[:api_secret]  - Account API secret
-    # options[:oauth_token] - OAuth token (optional, required for some calls)
+    # options[:oauth_token] - OAuth access token (optional, required for some calls)
     #
     def initialize(options={})
       unless options.kind_of?(Hash)
         raise ArgumentError, "Options hash required."
       end
-      
-      @api_key    = options[:api_key]
-      @api_secret = options[:api_secret]
+
+      @api_key    = options[:api_key] || Goodreads.configuration[:api_key]
+      @api_secret = options[:api_secret] || Goodreads.configuration[:api_secret]
       @oauth_token = options[:oauth_token]
     end
   end

data/lib/goodreads/request.rb

@@ -6,9 +6,9 @@ module Goodreads
   module Request
     API_URL    = 'http://www.goodreads.com'
     API_FORMAT = 'xml'
-    
+
     protected
-    
+
     # Perform an API request
     #
     # path   - Request path
@@ -16,14 +16,14 @@ module Goodreads
     #
     def request(path, params={})
       token = api_key || Goodreads.configuration[:api_key]
-      
+
       if token.nil?
         raise Goodreads::ConfigurationError, 'API key required.'
       end
-      
+
       params.merge!(:format => API_FORMAT, :key => token)
       url = "#{API_URL}#{path}"
-      
+
       resp = RestClient.get(url, :params => params) do |response, request, result, &block|
         case response.code
           when 200
@@ -38,15 +38,21 @@ module Goodreads
       parse(resp)
     end
 
+    # Perform an OAuth API request. Goodreads must have been initialized with a valid OAuth access token.
+    #
+    # path   - Request path
+    # params - Parameters hash
+    #
     def oauth_request(path, params=nil)
       raise 'OAuth access token required!' unless @oauth_token
       path = "#{path}?#{params.map{|k,v|"#{k}=#{v}"}.join('&')}" if params
-      resp = @oauth_token.get(path)
+      resp = @oauth_token.get(path, {'Accept'=>'application/xml'})
+
       case resp
-      when Net::HTTPUnauthorized
-        raise Goodreads::Unauthorized
-      when Net::HTTPNotFound
-        raise Goodreads::NotFound
+        when Net::HTTPUnauthorized
+          raise Goodreads::Unauthorized
+        when Net::HTTPNotFound
+          raise Goodreads::NotFound
       end
 
       parse(resp)
@@ -57,6 +63,5 @@ module Goodreads
       hash.delete('Request')
       hash
     end
-
   end
 end

data/lib/goodreads/version.rb

@@ -1,5 +1,5 @@
 module Goodreads
   unless defined?(Goodreads::VERSION)
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end