goodreads 0.1.0

data/lib/goodreads.rb

@@ -0,0 +1,7 @@
+require 'rest-client'
+require 'xmlsimple'
+require 'active_support/all'
+
+require 'goodreads/goodreads'
+require 'goodreads/client'
+require 'goodreads/record'

data/lib/goodreads/client.rb

@@ -0,0 +1,52 @@
+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 initialize(opts={})
+      raise ArgumentError, 'API key required!' unless opts.key?(:api_key)
+      @@config[:api_key] = opts[:api_key]
+    end
+    
+    # Get most recent reviews
+    # :skip_cropped - Select only non-cropped reviews
+    def recent_reviews(params={})
+      data = request('/review/recent_reviews', params)
+      reviews = data['reviews']['review'].collect { |r| Goodreads::Record.new(r) }
+      reviews = reviews.select { |r| !r.body.include?(r.url) } if params.key?(:skip_cropped)
+      return reviews
+    end
+    
+    # Get book (including reviews) by ISBN.
+    # :skip_cropped_reviews - Select only non-cropped book reviews
+    # :page - Reviews page
+    # :per_page - Reviews per page (default to 30)
+    def book_by_isbn(isbn, params={})
+      params.merge!(:isbn => isbn)
+      data = request('/book/isbn', params)
+      record = Goodreads::Record.new(data['book'])
+      if params.key?(:skip_cropped_reviews)
+        record.reviews['review'] = record.reviews.review.select { |r| !r.body.include?(r.url) }
+      end
+      return record
+    end
+    
+    private
+    
+    # Perform an API request
+    def request(path, params={})
+      params.merge!(:format => 'xml', :key => @@config[:api_key])
+      begin
+        resp = RestClient.get("#{API_URL}#{path}", :params => params)
+        Hash.from_xml(resp)['GoodreadsResponse']
+      rescue RestClient::Unauthorized
+        raise AuthError, 'Invalid API token!'
+      rescue Exception => ex
+        raise NotFound, 'Resource was not found!' if ex.http_code == 404
+        raise GeneralError, ex.message
+      end
+    end
+  end
+end

data/lib/goodreads/goodreads.rb

@@ -0,0 +1,8 @@
+module Goodreads
+  API_URL = 'http://www.goodreads.com'
+  API_FORMAT = 'xml'
+  
+  class AuthError < Exception ; end
+  class NotFound < Exception ; end
+  class GeneralError < Exception ; end
+end

data/lib/goodreads/record.rb

@@ -0,0 +1,38 @@
+module Goodreads
+  class Record
+    # Initialize the record and set its data if present
+    def initialize(data=nil)
+      @fields = {}
+      setup(data) unless data.nil?
+    end
+    
+    # Set or override the existing field value
+    def []=(key, value)
+      @fields[key] = value
+    end
+    
+    # Get the field value by hash key
+    def [](key)
+      @fields[key]
+    end
+    
+    # Load data into the record
+    def setup(data)
+      data.each_pair do |key, value|
+        case value
+          when Hash
+            @fields[key] = Record.new(value)
+          when Array
+            @fields[key] = value.collect { |v| Record.new(v) }
+          when NilClass
+            @fields[key] = nil
+          else
+            @fields[key] = value
+        end
+        (class << self; self; end).class_eval do
+          define_method(key.to_sym) { return @fields[key] }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: goodreads
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Simplified client to the Goodreads.com API
+email: dan.sosedoff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/goodreads.rb
+- lib/goodreads/goodreads.rb
+- lib/goodreads/client.rb
+- lib/goodreads/record.rb
+has_rdoc: true
+homepage: http://github.com/sosedoff/goodreads
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simplified client to the Goodreads.com API
+test_files: []
+