goodreads-wrapper 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+goodreads
+=========
+
+home :: http://github.com/tiagoluchini/goodreads
+bugs :: http://github.com/tiagoluchini/goodreads/issues
+
+## Description
+
+This gem allows you to easily access publicly available data from Goodreads.
+
+## Features
+
+`goodreads` currently features the following:
+
+* Querying details of a specified book
+
+## In a nutshell
+
+    b = Goodreads::Book.new('9780375403170')
+    
+    b.title
+    #=> "Les Misérables"
+    b.characters
+    #=> ["Jean Valjean", "Javert", "Cosette", "Fantine", "Bishop Myriel"]
+    b.cover
+    #=> "http://d.gr-assets.com/books/1320406739l/24284.jpg" 
+
+## Installation
+
+    $ gem install goodreads-wrapper
+
+## Future features
+
+The following features are considered next steps:
+
+* Search by title or author
+* Expose more details about genres, characters, authors
+* Expose editions
+* Expose 'similar items'
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Tiago Luchini
+
+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/goodreads.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "goodreads/version"
+
+Gem::Specification.new do |s|
+  s.name        = "goodreads-wrapper"
+  s.version     = Goodreads::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tiago Luchini"]
+  s.email       = ["info@tiagoluchini.eu"]
+  s.homepage    = "http://github.com/tiagoluchini/goodreads"
+  s.summary     = %q{Easily access the publicly available information on Goodreads.}
+  s.description = %q{Easily use Ruby to find information on Goodreads.com.}
+
+  s.rubyforge_project = "goodreads-wrapper"
+
+  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.add_dependency 'hpricot', '~> 0.8.4'
+
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rspec', '~> 1.3.2'
+  s.add_development_dependency 'gokdok'
+  s.add_development_dependency 'rdoc', '~> 3.11'
+  s.add_development_dependency 'fakeweb'
+end

data/lib/goodreads.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'open-uri'
+require 'rubygems'
+require 'hpricot'
+
+require 'goodreads/book'
+require 'goodreads/string_extensions'
+require 'goodreads/version'

data/lib/goodreads/book.rb

@@ -0,0 +1,85 @@
+module Goodreads
+
+  # Represents a Book on goodreads.com
+  class Book
+    attr_accessor :isbn, :url, :query_url
+
+    # Initialize a new Goodreads book object with its ISBN (as a String)
+    #
+    #   book = Goodreads::Book.new("9780375403170")
+    #
+    # Goodreads::Book objects are lazy loading, meaning that no HTTP request
+    # will be performed when a new object is created. Only when you use an
+    # accessor that needs the remote data, a HTTP request is made (once).
+    #
+    def initialize(isbn)
+      @isbn = isbn
+      @query_url = Goodreads::Book.make_query_url(isbn)
+    end
+
+    # Returns the id used by Goodreads (does not trigger lazy loading)
+    def goodreads_id
+      @url.match(/\/(\d+)\./)[1] rescue nil
+    end
+    
+    # Returns a string containing the title
+    def title
+      document.search(".bookTitle").innerHTML.strip rescue nil
+    end
+    
+    # Returns a string containing the URL for the cover file
+    def cover
+      document.at("img[@id='coverImage']")['src'] rescue nil
+    end
+    
+    # Returns an array with the authors of the book
+    def authors
+      document.search("[@id='bookAuthors']/[@itemprop='author']/a/span").map { |elem| elem.innerHTML.strip } rescue []
+    end
+    
+    # Returns a string with the current Goodreads rating
+    def rating
+      document.at("[@id='bookMeta']/*/[@itemprop='ratingValue']").innerHTML.strip rescue nil
+    end
+    
+    # Retursn a string with the book's description
+    def description
+      document.at("[@id='description']/span[1]").innerHTML.goodreads_strip_tags.goodreads_strip_bad_description_content rescue nil
+    end
+
+    # Returns an array with the main characters of the book
+    def characters
+      document.search("[@id='bookDataBox']/*/[@class='infoBoxRowItem']/a").select {|elem| elem['href'] =~ /character/}.map {|elem| elem.innerHTML.strip} rescue []
+    end
+    
+    # Returns an integer with the number of pages
+    def number_of_pages
+      document.at("[@itemprop='numberOfPages']").innerHTML.scan(/\d+/).first.to_i rescue nil
+    end
+    
+    # Returns an array with the genres of the book
+    def genres
+      document.search("[@class='actionLinkLite']").select { |elem| elem['href'] =~ /genres/ }.map { |elem| elem.innerHTML.strip } rescue []
+    end
+
+
+    private
+
+    # Returns a new Hpricot document for parsing.
+    def document
+      @document ||= Hpricot(open_goodreads)
+    end
+    
+    def open_goodreads
+      f = open(@query_url)
+      @url = f.base_uri.to_s
+      f.read
+    end
+
+    def self.make_query_url(isbn)
+      "http://www.goodreads.com/search?utf8=%E2%9C%93&query=#{isbn}"
+    end
+
+  end # Book
+
+end # Goodreads

data/lib/goodreads/string_extensions.rb

@@ -0,0 +1,32 @@
+require 'cgi'
+ 
+module Goodreads #:nordoc:
+  module StringExtensions
+  
+    # Unescape HTML
+    def goodreads_unescape_html
+      if String.method_defined?(:encode)
+        CGI::unescapeHTML(self.encode("UTF-8", 'ISO-8859-1'))
+      else
+        require 'iconv'
+        Iconv.conv("UTF-8", 'ISO-8859-1', CGI::unescapeHTML(self)) 
+      end
+    end
+  
+    # Strip tags
+    def goodreads_strip_tags
+      gsub(/<\/?[^>]*>/, "")
+    end
+    
+    def goodreads_strip_bad_description_content
+      gsub(/^\([^\)]+\)/, '').gsub(/more$/, '')
+    end
+    
+    # Strips out whitespace then tests if the string is empty.
+    def blank?
+      strip.empty?
+    end unless method_defined?(:blank?)
+  end
+end
+
+String.send :include, Goodreads::StringExtensions

data/lib/goodreads/version.rb

@@ -0,0 +1,3 @@
+module Goodreads
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: goodreads-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tiago Luchini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: gokdok
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily use Ruby to find information on Goodreads.com.
+email:
+- info@tiagoluchini.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- goodreads.gemspec
+- lib/goodreads.rb
+- lib/goodreads/book.rb
+- lib/goodreads/string_extensions.rb
+- lib/goodreads/version.rb
+homepage: http://github.com/tiagoluchini/goodreads
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: goodreads-wrapper
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easily access the publicly available information on Goodreads.
+test_files: []