goodreads 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree

data/README.md

@@ -0,0 +1,125 @@
+# Goodreads API wrapper
+
+Ruby library to connect with Goodreads API.
+
+[![Build Status](https://secure.travis-ci.org/sosedoff/goodreads.png)](http://travis-ci.org/sosedoff/goodreads)
+
+## Installation
+
+You can install this library via rubygems:
+
+```
+gem install goodreads
+```
+
+Or using rake:
+
+```
+rake install
+```
+
+## Getting Started
+
+In order to use Goodreads API you must obtain an API key for your account.
+
+Setup client:
+
+```ruby
+client = Goodreads::Client.new(:api_key => 'YOUR_KEY')
+
+# or using a shortcut
+client = Goodreads.new(:api_key => 'YOUR_KEY')
+```
+
+### Global configuration
+
+Library allows you to define a global configuration options.
+
+```ruby
+Goodreads.configure(:api_key => 'YOUR_KEY')
+```
+
+Get current options:
+
+```ruby
+Goodreads.configuration # => {:api_key => 'YOUR_KEY'}
+```
+
+In case you need to reset options:
+
+```ruby
+Goodreads.reset_configuration
+```
+
+## Usage
+
+### Lookup books
+
+Find a book by ISBN:
+
+```ruby
+book = client.book_by_isbn('ISBN')
+```
+  
+Find a book by Goodreads ID:
+
+```ruby
+book = client.book('id')
+```
+  
+Find a book by title:
+
+```ruby
+book = client.book_by_title('Book title')
+```
+  
+Search for books (by title, isbn, genre):
+
+```ruby
+search = client.search_books('Your search query')
+search.results.work.each do |book|
+  book.id        # => book ID
+  book.title     # => book title
+end
+```
+
+### Reviews
+
+Pull recent reviews:
+
+```ruby
+client.recent_reviews.each do |r|
+  r.id            # => review id
+  r.book.title    # => review book title
+  r.body          # => review message
+  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
+```
+
+## Contributions
+
+Feel free to contribute any patches or new features.
+
+Make sure to add a test coverage so it does not break any existing code.
+
+For documentation please visit [API Reference](http://www.goodreads.com/api)
+
+## License
+
+Copyright © 2011-2012 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.

data/Rakefile

@@ -1,9 +1,10 @@
 require 'bundler'
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:test) do |t|
   t.pattern = 'spec/*_spec.rb'
   t.verbose = false
 end
 
-task :default => :test
+task :default => :test

data/goodreads.gemspec

@@ -9,23 +9,19 @@ 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 'ZenTest', '~> 4.5'
+  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 'yard', '~> 0.6'
+  s.add_development_dependency 'yard',      '~> 0.6'
   
-  s.add_runtime_dependency 'rest-client', '~> 1.6.1'
-  s.add_runtime_dependency 'hashie', '~> 1.0.0'
-  s.add_runtime_dependency 'activesupport', '~> 3.0.0'
-  s.add_runtime_dependency 'i18n', '~> 0.5'
-  
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.add_runtime_dependency 'rest-client',   '~> 1.6'
+  s.add_runtime_dependency 'hashie',        '~> 1.0'
+  s.add_runtime_dependency 'activesupport', '~> 3'
+  s.add_runtime_dependency 'i18n',          '~> 0.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   s.require_paths = ["lib"]
-  
-  s.platform = Gem::Platform::RUBY
-  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
 end

data/lib/goodreads.rb

@@ -1,6 +1,41 @@
-require 'rest-client'
-require 'active_support/core_ext'
-require 'hashie'
+require 'goodreads/version'
+require 'goodreads/errors'
+require 'goodreads/request'
+require 'goodreads/client'
 
-require 'goodreads/goodreads'
-require 'goodreads/client'
+module Goodreads
+  @@options = {}
+  
+  # Create a new Goodreads::Client instance
+  #
+  def self.new(options={})
+    Goodreads::Client.new(options)
+  end
+  
+  # Define a global configuration
+  #
+  # options[:api_key]    - Account API key
+  # options[:api_secret] - Account API secret
+  #
+  def self.configure(options={})
+    unless options.kind_of?(Hash)
+      raise ArgumentError, "Options hash required."
+    end
+    
+    @@options[:api_key]    = options[:api_key]
+    @@options[:api_secret] = options[:api_secret]
+    @@options
+  end
+  
+  # Returns global configuration hash
+  #
+  def self.configuration
+    @@options
+  end
+  
+  # Resets the global configuration
+  #
+  def self.reset_configuration
+    @@options = {}
+  end
+end

data/lib/goodreads/client.rb

@@ -1,94 +1,31 @@
+require 'goodreads/client'
+require 'goodreads/client/books'
+require 'goodreads/client/reviews'
+require 'goodreads/client/authors'
+require 'goodreads/client/users'
+
 module Goodreads
   class Client
-    @@config = {}
-    
-    # Initialize the API client
-    # You must specify the API key given by goodreads in order to make requests
-    #   :api_key - Your api key
-    def self.configure(opts={})
-      key = opts[:api_key].to_s
-      raise ArgumentError, 'API key required!' if key.empty?
-      @@config[:api_key] = opts[:api_key]
-    end
-    
-    # Search for books
-    # q => The query text to match against book title, author, and ISBN fields.
-    # params => Optional search parameters
-    #   :page => Which page to return (default 1, optional)
-    #   :field => Field to search, one of title, author, or genre (default is all)
-    def search_books(q, params={})
-      params[:q] = q.to_s.strip
-      data = request('/search/index', params)
-      Hashie::Mash.new(data['search'])
-    end
-    
-    # Get book details by Goodreads book ID
-    def book(id)
-      Hashie::Mash.new(request('/book/show', :id => id)['book'])
-    end
-    
-    # Get book details by book ISBN
-    def book_by_isbn(isbn)
-      Hashie::Mash.new(request('/book/isbn', :isbn => isbn)['book'])
-    end
-    
-    # Get book details by book title
-    def book_by_title(title)
-      Hashie::Mash.new(request('/book/title', :title => title)['book'])
-    end
-    
-    # Recent reviews from all members.
-    #   :skip_cropped - Select only non-cropped reviews
-    def recent_reviews(params={})
-      skip_cropped = params.delete(:skip_cropped) || false
-      data = request('/review/recent_reviews', params)
-      if data['reviews'] && data['reviews'].key?('review')
-        reviews = data['reviews']['review'].map { |r| Hashie::Mash.new(r) }
-        reviews = reviews.select { |r| !r.body.include?(r.url) } if skip_cropped
-        reviews
+    include Goodreads::Request
+    include Goodreads::Books
+    include Goodreads::Reviews
+    include Goodreads::Authors
+    include Goodreads::Users
+    
+    attr_reader :api_key, :api_secret
+    
+    # Initialize a Goodreads::Client instance
+    #
+    # options[:api_key]    - Account API key
+    # options[:api_secret] - Account API secret
+    #
+    def initialize(options={})
+      unless options.kind_of?(Hash)
+        raise ArgumentError, "Options hash required."
       end
-    end
-    
-    # Get review details
-    def review(id)
-      data = request('/review/show', :id => id)
-      Hashie::Mash.new(data['review'])
-    end
-    
-    # Get author details
-    def author(id, params={})
-      params[:id] = id
-      data = request('/author/show', params)
-      Hashie::Mash.new(data['author'])
-    end
-    
-    # Get user details
-    def user(id)
-      data = request('/user/show', :id => id)
-      Hashie::Mash.new(data['user'])
-    end
-    
-    private
-    
-    # Perform an API request
-    def request(path, params={})
-      raise 'API key required!' unless @@config.key?(:api_key)
-      params.merge!(:format => 'xml', :key => @@config[:api_key])
-      
-      resp = RestClient.get("#{API_URL}#{path}", :params => params) { |response, request, result, &block|
-        case response.code
-          when 200
-            response.return!(request, result, &block)
-          when 401
-            raise Goodreads::Unauthorized
-          when 404
-            raise Goodreads::NotFound
-        end
-      }
       
-      hash = Hash.from_xml(resp)['GoodreadsResponse']
-      hash.delete('Request')
-      hash
+      @api_key    = options[:api_key]
+      @api_secret = options[:api_secret]
     end
   end
 end

data/lib/goodreads/client/authors.rb

@@ -0,0 +1,11 @@
+module Goodreads
+  module Authors
+    # Get author details
+    #
+    def author(id, params={})
+      params[:id] = id
+      data = request('/author/show', params)
+      Hashie::Mash.new(data['author'])
+    end
+  end
+end

data/lib/goodreads/client/books.rb

@@ -0,0 +1,35 @@
+module Goodreads
+  module Books
+    # Search for books
+    #
+    # query   - Text to match against book title, author, and ISBN fields.
+    # options - Optional search parameters
+    #
+    # options[:page] - Which page to returns (default: 1)
+    # options[:field] - Search field. One of: title, author, or genre (default is all)
+    #
+    def search_books(query, params={})
+      params[:q] = query.to_s.strip
+      data = request('/search/index', params)
+      Hashie::Mash.new(data['search'])
+    end
+    
+    # Get book details by Goodreads book ID
+    #
+    def book(id)
+      Hashie::Mash.new(request('/book/show', :id => id)['book'])
+    end
+    
+    # Get book details by book ISBN
+    #
+    def book_by_isbn(isbn)
+      Hashie::Mash.new(request('/book/isbn', :isbn => isbn)['book'])
+    end
+    
+    # Get book details by book title
+    #
+    def book_by_title(title)
+      Hashie::Mash.new(request('/book/title', :title => title)['book'])
+    end
+  end
+end

data/lib/goodreads/client/reviews.rb

@@ -0,0 +1,24 @@
+module Goodreads
+  module Reviews
+    # Recent reviews from all members.
+    #
+    # params[:skip_cropped] - Select only non-cropped reviews
+    #
+    def recent_reviews(params={})
+      skip_cropped = params.delete(:skip_cropped) || false
+      data = request('/review/recent_reviews', params)
+      if data['reviews'] && data['reviews'].key?('review')
+        reviews = data['reviews']['review'].map { |r| Hashie::Mash.new(r) }
+        reviews = reviews.select { |r| !r.body.include?(r.url) } if skip_cropped
+        reviews
+      end
+    end
+    
+    # Get review details
+    #
+    def review(id)
+      data = request('/review/show', :id => id)
+      Hashie::Mash.new(data['review'])
+    end
+  end
+end

data/lib/goodreads/client/users.rb

@@ -0,0 +1,10 @@
+module Goodreads
+  module Users
+    # Get user details
+    #
+    def user(id)
+      data = request('/user/show', :id => id)
+      Hashie::Mash.new(data['user'])
+    end
+  end
+end

data/lib/goodreads/errors.rb

@@ -0,0 +1,6 @@
+module Goodreads
+  class Error              < StandardError; end
+  class ConfigurationError < Error ; end
+  class Unauthorized       < Error ; end
+  class NotFound           < Error ; end
+end

data/lib/goodreads/request.rb

@@ -0,0 +1,43 @@
+require 'rest-client'
+require 'active_support/core_ext'
+require 'hashie'
+
+module Goodreads
+  module Request
+    API_URL    = 'http://www.goodreads.com'
+    API_FORMAT = 'xml'
+    
+    protected
+    
+    # Perform an API request
+    #
+    # path   - Request path
+    # params - Parameters hash
+    #
+    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
+            response.return!(request, result, &block)
+          when 401
+            raise Goodreads::Unauthorized
+          when 404
+            raise Goodreads::NotFound
+        end
+      end
+      
+      hash = Hash.from_xml(resp)['GoodreadsResponse']
+      hash.delete('Request')
+      hash
+    end
+  end
+end

data/lib/goodreads/version.rb

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

data/spec/authentication_spec.rb

@@ -2,19 +2,23 @@ require 'spec_helper'
 
 describe 'Client' do
   before :each do
-    @client = Goodreads::Client.new
+    Goodreads.reset_configuration
   end
   
-  it 'should raise exception if API key was not provided' do
-    proc { @client.book_by_isbn('0307463745') }.should raise_error Exception, 'API key required!'
+  it 'raises Goodreads::ConfigurationError if API key was not provided' do
+    client = Goodreads::Client.new
+    
+    proc { client.book_by_isbn('0307463745') }.
+      should raise_error Goodreads::ConfigurationError, 'API key required.'
   end
     
-  it 'should raise Goodreads::Unauthorized if API key is not valid' do
-    Goodreads.configure('INVALID_KEY')
+  it 'raises Goodreads::Unauthorized if API key is not valid' do
+    client = Goodreads::Client.new(:api_key => 'INVALID_KEY')
+    
     stub_request(:get, "http://www.goodreads.com/book/isbn?format=xml&isbn=054748250711&key=INVALID_KEY").
       to_return(:status => 401)
       
-    proc { @client.book_by_isbn('054748250711') }.should raise_error Goodreads::Unauthorized
+    proc { client.book_by_isbn('054748250711') }.
+      should raise_error Goodreads::Unauthorized
   end
 end
-

data/spec/client_spec.rb

@@ -2,11 +2,19 @@ require 'spec_helper'
 
 describe 'Client' do
   before :each do
-    Goodreads.configure('SECRET_KEY')
-    @client = Goodreads::Client.new
+    Goodreads.reset_configuration
+    @client = Goodreads::Client.new(:api_key => 'SECRET_KEY')
   end
   
-  it 'should return a book found by isbn' do
+  it 'raises error on invalid config parameter' do
+    proc { Goodreads::Client.new(nil) }.
+      should raise_error ArgumentError, "Options hash required."
+      
+    proc { Goodreads::Client.new('foo') }.
+      should raise_error ArgumentError, "Options hash required."
+  end
+
+  it 'returns a book by isbn' do
     stub_with_key_get('/book/isbn', {:isbn => '0307463745'}, 'book.xml')
     
     proc { @book = @client.book_by_isbn('0307463745') }.should_not raise_error
@@ -14,24 +22,24 @@ describe 'Client' do
     @book.respond_to?(:title).should == true
   end
   
-  it 'should return a book found by goodreads id' do
+  it 'returns a book by goodreads id' do
     stub_with_key_get('/book/show', {:id => '6732019'}, 'book.xml')
     proc { @client.book('6732019') }.should_not raise_error
   end
   
-  it 'should return a book found by title' do
+  it 'returns a book by title' do
     stub_with_key_get('/book/title', {:title => 'Rework'}, 'book.xml')
     proc { @client.book_by_title('Rework') }.should_not raise_error
   end
   
-  it 'should raise Goodreads::NotFound if book was not found' do
+  it 'raises Goodreads::NotFound if book was not found' do
     stub_request(:get, "http://www.goodreads.com/book/isbn?format=xml&isbn=123456789&key=SECRET_KEY").
       to_return(:status => 404, :body => "", :headers => {})
          
     proc { @client.book_by_isbn('123456789') }.should raise_error Goodreads::NotFound
   end
   
-  it 'should return recent reviews' do
+  it 'returns recent reviews' do
     stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml')
     
     proc { @reviews = @client.recent_reviews }.should_not raise_error
@@ -42,7 +50,7 @@ describe 'Client' do
     end
   end
   
-  it 'should return recent reviews with clean reviews' do
+  it 'returns only full reviewes' do
     stub_with_key_get('/review/recent_reviews', {}, 'recent_reviews.xml')
     
     proc { @reviews = @client.recent_reviews(:skip_cropped => true) }.should_not raise_error
@@ -53,7 +61,7 @@ describe 'Client' do
     end
   end
   
-  it 'should return single review details' do
+  it 'returns review details' do
     stub_with_key_get('/review/show', {:id => '166204831'}, 'review.xml')
     
     proc { @review = @client.review('166204831') }.should_not raise_error
@@ -62,14 +70,14 @@ describe 'Client' do
     @review.id.should == '166204831'
   end
   
-  it 'should raise Goodreads::NotFound if review was not found' do
+  it 'raises Goodreads::NotFound if review was not found' do
     stub_request(:get, "http://www.goodreads.com/review/show?format=xml&id=12345&key=SECRET_KEY").
       to_return(:status => 404, :body => "", :headers => {})
 
     proc { @client.review('12345') }.should raise_error Goodreads::NotFound
   end
   
-  it 'should return author details' do
+  it 'returns author details' do
     stub_with_key_get('/author/show', {:id => '18541'}, 'author.xml')
     
     proc { @author = @client.author('18541') }.should_not raise_error
@@ -79,14 +87,14 @@ describe 'Client' do
     @author.name.should == "Tim O'Reilly"
   end
   
-  it 'should raise Goodreads::NotFound if author was not found' do
+  it 'raises Goodreads::NotFound if author was not found' do
     stub_request(:get, "http://www.goodreads.com/author/show?format=xml&id=12345&key=SECRET_KEY").
       to_return(:status => 404, :body => "", :headers => {})
     
     proc { @client.author('12345') }.should raise_error Goodreads::NotFound
   end
   
-  it 'should return user details' do
+  it 'returns user details' do
     stub_with_key_get('/user/show', {:id => '878044'}, 'user.xml')
     
     proc { @user = @client.user('878044') }.should_not raise_error
@@ -97,14 +105,14 @@ describe 'Client' do
     @user.user_name.should == 'janmt'
   end
   
-  it 'should raise Goodreads::NotFound if user was not found' do
+  it 'raiser Goodreads::NotFound if user was not found' do
     stub_request(:get, "http://www.goodreads.com/user/show?format=xml&id=12345&key=SECRET_KEY").
       to_return(:status => 404, :body => "", :headers => {})
     
     proc { @client.user('12345') }.should raise_error Goodreads::NotFound
   end
   
-  it 'should return book search results' do
+  it 'returns book search results' do
     stub_with_key_get('/search/index', {:q => 'Rework'}, 'search_books_by_name.xml')
     
     proc { @search = @client.search_books('Rework') }.should_not raise_error

data/spec/goodreads_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe 'Goodreads' do
+  context '.new' do
+    it 'returns a new client instance' do
+      Goodreads.new.should be_a Goodreads::Client
+    end
+  end
+  
+  context '.configure' do
+    it 'sets a global configuration options' do
+      r = Goodreads.configure(:api_key => 'FOO', :api_secret => 'BAR')
+      r.should be_a Hash
+      r.should have_key(:api_key)
+      r.should have_key(:api_secret)
+      r[:api_key].should eql('FOO')
+      r[:api_secret].should eql('BAR')
+    end
+    
+    it 'raises ConfigurationError on invalid config parameter' do
+      proc { Goodreads.new(nil) }.
+        should raise_error ArgumentError, "Options hash required."
+      
+      proc { Goodreads.new('foo') }.
+        should raise_error ArgumentError, "Options hash required."
+    end
+  end
+  
+  context '.configuration' do
+    before do
+      Goodreads.configure(:api_key => 'FOO', :api_secret => 'BAR')
+    end
+    
+    it 'returns global configuration options' do
+      r = Goodreads.configuration
+      r.should be_a Hash
+      r.should have_key(:api_key)
+      r.should have_key(:api_secret)
+      r[:api_key].should eql('FOO')
+      r[:api_secret].should eql('BAR')
+    end
+  end
+  
+  context '.reset_configuration' do
+    before do
+      Goodreads.configure(:api_key => 'FOO', :api_secret => 'BAR')
+    end
+    
+    it 'resets global configuration options' do
+      Goodreads.reset_configuration
+      Goodreads.configuration.should eql({})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -24,14 +24,15 @@ def stub_with_key_get(path, params, fixture_name)
   stub_get(path, params, fixture_name)
 end
 
-def fixture_path
-  File.expand_path("../fixtures", __FILE__)
+def fixture_path(file=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  file.nil? ? path : File.join(path, file)
 end
 
 def fixture(file)
-  File.new(fixture_path + '/' + file)
+  File.read(fixture_path(file))
 end
 
 def api_url(path)
-  "#{Goodreads::API_URL}#{path}"
+  "#{Goodreads::Request::API_URL}#{path}"
 end

metadata

@@ -1,195 +1,137 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: goodreads
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-08 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: webmock
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157623060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157623060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157622560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157622560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157622100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 5
-        version: "2.5"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 4
-        - 5
-        version: "4.5"
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157622100
+- !ruby/object:Gem::Dependency
   name: simplecov
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2157621640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2157621640
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157621180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        version: "0.6"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2157621180
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2157620720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 6
-        - 1
-        version: 1.6.1
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2157620720
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2157620260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2157620260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2157619800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *2157619800
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2157619340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 5
-        version: "0.5"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id010
+  prerelease: false
+  version_requirements: *2157619340
 description: Simple wrapper for the Goodreads API
-email: 
+email:
 - dan.sosedoff@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - goodreads.gemspec
 - lib/goodreads.rb
 - lib/goodreads/client.rb
-- lib/goodreads/goodreads.rb
+- lib/goodreads/client/authors.rb
+- lib/goodreads/client/books.rb
+- lib/goodreads/client/reviews.rb
+- lib/goodreads/client/users.rb
+- lib/goodreads/errors.rb
+- lib/goodreads/request.rb
 - lib/goodreads/version.rb
 - spec/authentication_spec.rb
 - spec/client_spec.rb
@@ -199,44 +141,33 @@ files:
 - spec/fixtures/review.xml
 - spec/fixtures/search_books_by_name.xml
 - spec/fixtures/user.xml
+- spec/goodreads_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/sosedoff/goodreads
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Goodreads API wrapper
-test_files: 
+test_files:
 - spec/authentication_spec.rb
 - spec/client_spec.rb
 - spec/fixtures/author.xml
@@ -245,4 +176,5 @@ test_files:
 - spec/fixtures/review.xml
 - spec/fixtures/search_books_by_name.xml
 - spec/fixtures/user.xml
+- spec/goodreads_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,66 +0,0 @@
-= Goodreads -- simple client for Goodreads.com API
-
-A simple API client to pull book information and reviews from Goodreads.com.
-Wrapper uses XML feed and transforms it into the object model.
-
-* Main page: http://github.com/sosedoff/goodreads
-* Goodreads API: http://goodreads.com/api
-
-== Getting Started
-
-First, you need to provide your API token
-
-  Goodreads.configure('API_TOKEN')
-  
-  client = Goodreads::Client.new
-  
-== Usage
-  
-=== Lookup books
-
-Find a book by ISBN:
-
-  book = client.book_by_isbn('ISBN')
-  
-Find a book by Goodreads ID:
-
-  book = client.book('id')
-  
-Find a book by title:
-
-  book = client.book_by_title('Book title')
-  
-Search for books (by title, isbn, genre)
-
-  search = client.search_books('Your search query')
-  search.results.work.each do |book|
-    book.id        # => book ID
-    book.title     # => book title
-  end
-
-=== Pull recent reviews
-
-  client.recent_reviews.each do |r|
-    r.id            # => review id
-    r.book.title    # => review book title
-    r.body          # => review message
-    r.user.name     # => review user name
-  end
-  
-=== Get review Details
-
-  review = client.review('id')
-  review.id         # => review ID
-  review.user       # => review user information
-  review.book       # => review book information
-  review.reting     # => review rating
-
-== Limitation
-  
-* According to Goodreads API there is a limit of 60 RPM (requests per minute)
-* Provided data cannot be stored for any usage
-* Please check original documentation for additional object fields and properties
-
-== Authors
-
-* Dan Sosedoff [http://github.com/sosedoff]

data/lib/goodreads/goodreads.rb

@@ -1,12 +0,0 @@
-module Goodreads
-  API_URL = 'http://www.goodreads.com'
-  API_FORMAT = 'xml'
-  
-  class Error < StandardError; end
-  class Unauthorized < Error ; end
-  class NotFound < Error ; end
-  
-  def self.configure(api_key)
-    Goodreads::Client.configure({:api_key => api_key})  
-  end
-end