google-book 0.2.2 → 0.3.0

data/Gemfile

@@ -1,2 +1,8 @@
 source 'http://rubygems.org'
 gemspec
+
+gem 'rspec', '~> 2.5.0'
+gem 'ruby-debug', :platform => :mri_18, :require => 'ruby-debug'
+gem 'ruby-debug19', :platform => :mri_19, :require => 'ruby-debug'
+gem 'vcr', '~> 1.7.0'
+gem 'webmock', '~> 1.6.2'

data/README.md

@@ -2,3 +2,16 @@ Google Book
 ===========
 
 Google Book is a Ruby wrapper to the [Google Book Search Data API](http://code.google.com/apis/books/docs/gdata/developers_guide_protocol.html).
+
+Usage
+-----
+
+    entries = Google::Book.search('deleuze')
+    entry = entries.first
+
+    puts entry.title
+    => "Difference and repetition"
+    puts entry.isbn
+    => "9780826477156"
+    puts entry.cover.thumbnail
+    => "http://bks0.books.google.com/books?id=..."

data/google.gemspec

@@ -16,10 +16,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency('bookland', '~> 1.0.0')
   s.add_dependency('httparty', '~> 0.7.4')
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('ruby-debug19', '~> 0.11.6')
-  s.add_development_dependency('vcr', '~> 1.7.0')
-  s.add_development_dependency('webmock', '~> 1.6.2')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/google/book.rb

@@ -0,0 +1,48 @@
+require 'cgi'
+require 'httparty'
+require 'google/book/response'
+
+module Google
+
+  # A simple wrapper around the Google Book Search API.
+  module Book
+    include HTTParty
+    format :xml
+
+    class << self
+
+      # The search parameters.
+      attr_accessor :parameters
+
+      # Queries the Google Book Search Data API. Takes a query string and an
+      # optional options hash.
+      #
+      # The options hash respects the following members:
+      #
+      # * `:page`, which specifies the page.
+      #
+      # * `:count`, which specifies the number of results per page.
+      def search(query, opts = {})
+        self.parameters = { 'q' => query }
+        parameters['start-index'] = opts[:page]  if opts[:page]
+        parameters['max-results'] = opts[:count] if opts[:count]
+
+        Response.new(get(url.to_s))
+      end
+
+      private
+
+      def query
+        parameters.
+          map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.
+          join('&')
+      end
+
+      def url
+        URI::HTTP.build(:host  => 'books.google.com',
+                        :path  => '/books/feeds/volumes',
+                        :query => query)
+      end
+    end
+  end
+end

data/lib/google/book/cover.rb

@@ -6,28 +6,28 @@ module Google
       end
 
       def thumbnail
-        cover_url(5)
+        urlify(5)
       end
 
       def small
-        cover_url(1)
+        urlify(1)
       end
 
       def medium
-        cover_url(2)
+        urlify(2)
       end
 
       def large
-        cover_url(3)
+        urlify(3)
       end
 
       def extra_large
-        cover_url(6)
+        urlify(6)
       end
 
       private
 
-      def cover_url(zoom)
+      def urlify(zoom)
         @url.
           gsub('zoom=5', "zoom=#{zoom}").
           gsub('&edge=curl', '')

data/lib/google/book/entry.rb

@@ -0,0 +1,71 @@
+require 'bookland'
+require 'google/book/cover'
+
+module Google
+  module Book
+    class Entry
+      def initialize(hash)
+        @hash = hash
+      end
+
+      def cover
+        Cover.new(@hash['link'][0]['href'])
+      end
+
+      def creators
+        [@hash['dc:creator']].flatten.join(', ')
+      end
+
+      def date
+        @hash['dc:date']
+      end
+
+      def description
+        @hash['dc:description']
+      end
+
+      def format
+        [@hash['dc:format']].flatten.reject do |format|
+          format == 'book'
+        end.join(', ')
+      end
+
+      def info_url
+        @hash['link'][1]['href']
+      end
+
+      def preview_url
+        @hash['link'][2]['href']
+      end
+
+      def publisher
+        @hash['dc:publisher'].
+          gsub(/[ ,]+Inc.?$/, '').
+          gsub(/[ ,]+Llc.?$/i, '').
+          gsub(/[ ,]+Ltd.?$/, '').
+          gsub(/Intl( |$)/) { "International#{$1}" }.
+          gsub(/Pr( |$)/) { "Press#{$1}" }.
+          gsub(/ Pub$/, ' Publishers').
+          gsub(/ Pubns$/, ' Publications').
+          gsub('Pub Group', 'Publishing Group').
+          gsub(/Univ( |$)/) { "University#{$1}" }
+      end
+
+      def subjects
+        @hash['dc:subject']
+      end
+
+      def title
+        [@hash['dc:title']].flatten.join(': ')
+      end
+
+      def isbn
+        @hash['dc:identifier'].detect do |identifier|
+          identifier.match(/ISBN:([0-9X]{10,13})/)
+        end
+
+        ISBN.to_13($1) rescue nil
+      end
+    end
+  end
+end

data/lib/google/book/response.rb

@@ -1,26 +1,24 @@
+require 'google/book/entry'
+
 module Google
   module Book
     class Response
+      include Enumerable
+
       def initialize(hash)
         @feed = hash['feed']
       end
 
-      def to_books
-        return [] if total_results == 0
+      def each(&block)
+        members =
+          if total_results == 0
+            []
+          else
+            [@feed['entry']].flatten
+          end
 
-        [@feed['entry']].flatten.map do |hash|
-          book = Struct.new(
-            Cover.new(hash['link'][0]['href']),
-            hash['link'][1]['href'],
-            hash['link'][2]['href'],
-            [hash['dc:creator']].flatten,
-            hash['dc:date'],
-            hash['dc:description'],
-            [hash['dc:format']].flatten,
-            hash['dc:identifier'],
-            hash['dc:publisher'],
-            hash['dc:subject'],
-            [hash['dc:title']].flatten)
+        members.each do |member|
+          block.call(Entry.new(member))
         end
       end
 

data/lib/google/book/version.rb

@@ -1,5 +1,5 @@
 module Google
   module Book
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/spec/google/book/cover_spec.rb

@@ -5,7 +5,7 @@ module Google
     describe Cover do
       use_vcr_cassette 'google'
 
-      subject { Request.find('deleuze').to_books.first.cover }
+      subject { Book.search('deleuze').first.cover }
 
       %w{thumbnail small medium large extra_large}.each do |attribute|
         its(attribute) { should_not be_nil }

data/spec/google/book/entry_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+module Google
+  module Book
+    describe Entry do
+      use_vcr_cassette 'google'
+
+      let(:entry) do
+        Entry.new({})
+      end
+
+      subject { Book.search('deleuze').first }
+
+      %w{cover creators date description format info_url preview_url publisher
+        subjects title isbn}.each do |attribute|
+        it { should respond_to attribute }
+      end
+
+      describe "#creators" do
+        it "should concatenate creators" do
+          entry.instance_variable_set(:@hash, {
+            'dc:creator' => ['Deleuze', 'Guattari']
+          })
+
+          entry.creators.should eql 'Deleuze, Guattari'
+        end
+      end
+
+      describe "#format" do
+        it "should concatenate formats" do
+          entry.instance_variable_set(:@hash, {
+            'dc:format' => ['foo', 'bar']
+          })
+
+          entry.format.should eql 'foo, bar'
+        end
+
+        it "should drop the word book" do
+          entry.instance_variable_set(:@hash, {
+            'dc:format' => ['foo', 'book']
+          })
+
+          entry.format.should eql 'foo'
+        end
+      end
+
+      describe "#publisher" do
+        it "should drop Inc at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Inc'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should drop Inc. at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Inc.'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should drop Llc at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Llc'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should drop Llc. at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Llc.'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should drop LLC at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher LLC'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should drop Ltd at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Ltd'
+          })
+
+          entry.publisher.should eql 'Publisher'
+        end
+
+        it "should format Intl" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Intl'
+          })
+
+          entry.publisher.should eql 'Publisher International'
+        end
+
+        it "should format Pr" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Pr'
+          })
+
+          entry.publisher.should eql 'Publisher Press'
+        end
+
+        it "should format Pub at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Pub'
+          })
+
+          entry.publisher.should eql 'Publisher Publishers'
+        end
+
+        it "should format Pubns at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Pubns'
+          })
+
+          entry.publisher.should eql 'Publisher Publications'
+        end
+
+        it "should format Pub Group" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Pub Group'
+          })
+
+          entry.publisher.should eql 'Publisher Publishing Group'
+        end
+
+        it "should format Univ in the middle of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Univ Press'
+          })
+
+          entry.publisher.should eql 'Publisher University Press'
+        end
+
+        it "should format Univ at the end of the name" do
+          entry.instance_variable_set(:@hash, {
+            'dc:publisher' => 'Publisher Univ'
+          })
+
+          entry.publisher.should eql 'Publisher University'
+        end
+      end
+
+      describe "#title" do
+        it "should concatenate titles" do
+          entry.instance_variable_set(:@hash, {
+            'dc:title' => ['Thousand Plateaus', 'Capitalism and Schizophrenia']
+          })
+
+          entry.title.should eql 'Thousand Plateaus: Capitalism and Schizophrenia'
+        end
+      end
+
+      describe "#isbn" do
+        it "should return the ISBN" do
+          entry.instance_variable_set(:@hash, {
+            'dc:identifier' => ['8cp-Z_G42g4C','ISBN:0192802380']
+          })
+
+          entry.isbn.should eql '9780192802385'
+        end
+
+        it "should return nil if no ISBN is available" do
+          entry.instance_variable_set(:@hash, {
+            'dc:identifier' => []
+          })
+
+          entry.isbn.should eql nil
+        end
+      end
+    end
+  end
+end

data/spec/google/book/response_spec.rb

@@ -6,23 +6,23 @@ module Google
       use_vcr_cassette 'google'
 
       it "should set total results" do
-        response = Request.find('deleuze')
+        response = Book.search('deleuze')
         response.total_results.should > 0
       end
 
-      it "should return books" do
-        response = Request.find('deleuze')
-        books = response.to_books
-
-        books.first.should be_a Struct
+      it "should return entries" do
+        response = Book.search('deleuze')
+        response.first.should be_an Entry
       end
 
-      it "should handle single matches" do
-        Request.find('9780826490780').to_books.first.should be_a Struct
+      context "when there is a single match" do
+        it "should return entries" do
+          Book.search('9780826490780').first.should be_an Entry
+        end
       end
 
       it "should handle an empty query" do
-        Request.find('').to_books.should be_empty
+        Book.search('').to_a.should be_empty
       end
     end
   end

data/spec/google/book_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Google
+  describe Book do
+    use_vcr_cassette 'google'
+
+    describe "#search" do
+      it "should escape parameters" do
+        Book.search('foo bar')
+        Book.send(:query).should include 'q=foo+bar'
+      end
+
+      it "should set the page" do
+        Book.search('foo bar', :page => 2)
+        Book.send(:query).should include 'start-index=2'
+      end
+
+      it "should set the number of results per page" do
+        Book.search('foo bar', :count => 20)
+        Book.send(:query).should include 'max-results=20'
+      end
+
+      it "should return a response" do
+        Book.search('foo bar').should be_a Book::Response
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,6 @@ require 'rubygems'
 require 'bundler/setup'
 require 'rspec'
 
-require File.expand_path('../../lib/google', __FILE__)
+require File.expand_path('../../lib/google/book', __FILE__)
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -2,7 +2,7 @@
 name: google-book
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-06 00:00:00 +00:00
+date: 2011-03-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,50 +35,6 @@ dependencies:
         version: 0.7.4
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.5.0
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug19
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.11.6
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: vcr
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.7.0
-  type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.6.2
-  type: :development
-  version_requirements: *id006
 description: Google Book is a Ruby wrapper to the Google Book Search Data API.
 email: 
 - code@papercavalier.com
@@ -96,16 +52,15 @@ files:
 - README.md
 - Rakefile
 - google.gemspec
-- lib/google.rb
+- lib/google/book.rb
 - lib/google/book/cover.rb
-- lib/google/book/request.rb
+- lib/google/book/entry.rb
 - lib/google/book/response.rb
-- lib/google/book/struct.rb
 - lib/google/book/version.rb
 - spec/google/book/cover_spec.rb
-- spec/google/book/request_spec.rb
+- spec/google/book/entry_spec.rb
 - spec/google/book/response_spec.rb
-- spec/google/book/struct_spec.rb
+- spec/google/book_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr.rb
 has_rdoc: true
@@ -138,8 +93,8 @@ specification_version: 3
 summary: A Ruby wrapper to the Google Book Search Data API
 test_files: 
 - spec/google/book/cover_spec.rb
-- spec/google/book/request_spec.rb
+- spec/google/book/entry_spec.rb
 - spec/google/book/response_spec.rb
-- spec/google/book/struct_spec.rb
+- spec/google/book_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr.rb

data/lib/google.rb

@@ -1,7 +0,0 @@
-require 'bookland'
-require 'httparty'
-
-require 'google/book/cover'
-require 'google/book/request'
-require 'google/book/response'
-require 'google/book/struct'

data/lib/google/book/request.rb

@@ -1,42 +0,0 @@
-require 'cgi'
-require 'httparty'
-
-module Google
-  module Book
-    module Request
-      include HTTParty
-      format :xml
-
-      class << self
-        attr_accessor :parameters
-
-        # Queries the Google Book Search Data API.
-        #
-        # Optionally, specify a page and count to paginate through the
-        # result set.
-        #
-        #   GoogleBook.find('deleuze', :page => 2, :count => 20)
-        #
-        def find(query, opts = {})
-          self.parameters = { 'q' => query }
-          parameters['start-index'] = opts[:page] if opts[:page]
-          parameters['max-results'] = opts[:count] if opts[:count]
-
-          Response.new(get(url.to_s))
-        end
-
-        private
-
-        def query
-          parameters.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
-        end
-
-        def url
-          URI::HTTP.build(:host  => 'books.google.com',
-                          :path  => '/books/feeds/volumes',
-                          :query => query)
-        end
-      end
-    end
-  end
-end

data/lib/google/book/struct.rb

@@ -1,53 +0,0 @@
-module Google
-  module Book
-    class Struct< Struct.new :cover,
-                             :info,
-                             :preview,
-                             :creators,
-                             :date,
-                             :description,
-                             :formats,
-                             :identifiers,
-                             :publisher,
-                             :subjects,
-                             :titles
-
-      include Bookland
-
-      def formatted_creators
-        creators.join(', ')
-      end
-
-      def formatted_formats
-        formats.reject do |format|
-          format == 'book'
-        end.join(', ')
-      end
-
-      def formatted_publisher
-        publisher.
-          gsub(/[ ,]+Inc.?$/, '').
-          gsub(/[ ,]+Llc.?$/i, '').
-          gsub(/[ ,]+Ltd.?$/, '').
-          gsub(/Intl( |$)/) { "International#{$1}" }.
-          gsub(/Pr( |$)/) { "Press#{$1}" }.
-          gsub(/ Pub$/, ' Publishers').
-          gsub(/ Pubns$/, ' Publications').
-          gsub('Pub Group', 'Publishing Group').
-          gsub(/Univ( |$)/) { "University#{$1}" }
-      end
-
-      def formatted_title
-        titles.join(': ')
-      end
-
-      def isbn
-        identifiers.detect do |identifier|
-          identifier.match(/ISBN:([0-9X]{10,13})/)
-        end
-
-        ISBN.to_13($1) rescue nil
-      end
-    end
-  end
-end

data/spec/google/book/request_spec.rb

@@ -1,24 +0,0 @@
-require 'spec_helper'
-
-module Google
-  module Book
-    describe Request do
-      use_vcr_cassette 'google'
-
-      it "should escape parameters" do
-        Request.find('foo bar')
-        Request.send(:query).should include 'foo+bar'
-      end
-
-      it "should set page" do
-        Request.find('foo bar', :page => 2)
-        Request.send(:query).should include 'start-index=2'
-      end
-
-      it "should set number of results per page" do
-        Request.find('foo bar', :count => 20)
-        Request.send(:query).should include 'max-results=20'
-      end
-    end
-  end
-end

data/spec/google/book/struct_spec.rb

@@ -1,116 +0,0 @@
-require 'spec_helper'
-
-module Google
-  module Book
-    describe Struct do
-      use_vcr_cassette 'google'
-
-      let(:book) do
-        Struct.new
-      end
-
-      subject { Request.find('deleuze').to_books.first }
-
-      %w{cover info preview creators date description formats
-        identifiers isbn publisher subjects titles}.each do |attribute|
-        its(attribute) { should_not be_nil }
-      end
-
-      describe "#formatted_creators" do
-        it "should concatenate creators" do
-          book.creators = ['Deleuze', 'Guattari']
-          book.formatted_creators.should eql 'Deleuze, Guattari'
-        end
-      end
-
-      describe "#formatted_formats" do
-        it "should concatenate formats" do
-          book.formats = ['foo', 'bar']
-          book.formatted_formats.should eql 'foo, bar'
-        end
-
-        it "should drop the word book" do
-          book.formats = ['foo', 'book']
-          book.formatted_formats.should eql 'foo'
-        end
-      end
-
-      describe "#formatted_publisher" do
-        it "should drop Inc at the end of the name" do
-          book.publisher = 'Publisher Inc'
-          book.formatted_publisher.should eql 'Publisher'
-
-          book.publisher = 'Random House, Inc.'
-          book.formatted_publisher.should eql 'Random House'
-        end
-
-        it "should drop Llc at the end of the name" do
-          book.publisher = 'Publisher Llc'
-          book.formatted_publisher.should eql 'Publisher'
-
-          book.publisher = 'Publisher LLC'
-          book.formatted_publisher.should eql 'Publisher'
-        end
-
-        it "should drop Ltd at the end of the name" do
-          book.publisher = 'Publisher Ltd'
-          book.formatted_publisher.should eql 'Publisher'
-        end
-
-        it "should format Intl" do
-          book.publisher = 'Continuum Intl'
-          book.formatted_publisher.should eql 'Continuum International'
-        end
-
-        it "should format Pr" do
-          book.publisher = 'Polity Pr'
-          book.formatted_publisher.should eql 'Polity Press'
-        end
-
-        it "should format Pub at the end of the name" do
-          book.publisher = 'Rowman & Littlefield Pub'
-          book.formatted_publisher.should eql 'Rowman & Littlefield Publishers'
-        end
-
-        it "should format Pubns at the end of the name" do
-          book.publisher = 'Publisher Pubns'
-          book.formatted_publisher.should eql 'Publisher Publications'
-        end
-
-        it "should format Pub Group" do
-          book.publisher = 'Continuum International Pub Group'
-          book.formatted_publisher.should eql 'Continuum International Publishing Group'
-        end
-
-        it "should format Univ in the middle of the name" do
-          book.publisher = 'Columbia Univ Press'
-          book.formatted_publisher.should eql 'Columbia University Press'
-        end
-
-        it "should format Univ at the end of the name" do
-          book.publisher = 'Columbia Univ'
-          book.formatted_publisher.should eql 'Columbia University'
-        end
-      end
-
-      describe "#formatted_title" do
-        it "should concatenate titles" do
-          book.titles = ['Thousand Plateaus', 'Capitalism and Schizophrenia']
-          book.formatted_title.should eql 'Thousand Plateaus: Capitalism and Schizophrenia'
-        end
-      end
-
-      describe "#isbn" do
-        it "should return the ISBN" do
-          book.identifiers = ['8cp-Z_G42g4C','ISBN:0192802380']
-          book.isbn.should eql '9780192802385'
-        end
-
-        it "should return nil if no ISBN is available" do
-          book.identifiers = []
-          book.isbn.should eql nil
-        end
-      end
-    end
-  end
-end