googlebooks 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 399d18813263d0a61d626bed082934a9b2c0fcc6
+  data.tar.gz: 98fc2773a396e7495ecffab860baf58ecc4bde18
+SHA512: 
+  metadata.gz: 38f8d0ab7a550c64603f6aaec7a76d21653985816e77afd986104aedb02faa3589f70c8e81d6d8f601e364e48f9fedb27588997f049572b9bcdb7897775ff0ec
+  data.tar.gz: db8009bdfc1236dc3ddffa3ba8b3f6c49ba6c196d77bade56bec59b39154114aff7733128ba2edbe71f90f43616cf283fb09224bfb5d77dbf7eba0242d6c3268

data/README.md

@@ -45,6 +45,22 @@ By default, results are returned in order of relevance. However, results also be
     GoogleBooks.search('The Great Gatsby', {:order_by => `ANYTHING ELSE`})
     #=> both return results in order of relevance
 
+Geolocation
+-----------
+
+Some users may experience issues when querying the Google API from IP addresses that cannot be geolocated by Google. From [this Google forum](http://productforums.google.com/d/msg/books-api/7FQ-622q-jI/XYaWyh-Tzl4J):
+
+> Unfortunately the Books API cannot return any results for IPs that we cannot geo-locate.  This is due to both legal and contractual reasons.  Google does not have the rights to display all the books in all countries.  Even public domain laws vary by country.
+
+Users experiencing issues can typically resolve this limitation by passing a valid country code to the `country` parameter in the URL query.
+
+    GoogleBooks.search('The Great Gatsby')
+    #=> "Cannot determine user location for geographically restricted operation."
+    
+    GoogleBooks.search('The Great Gatsby', {:country => "ca"}) 
+    #=> returns the first five results
+
+
 Special Keywords
 ----------------
 
@@ -71,7 +87,9 @@ Attributes
 By default, GoogleBooks can query the following attributes (note that not all attributes are available to all books):
 
 * `title`
+* `titles_array` *Returns an array of all titles, both main and alternative
 * `authors` *Returns all authors as a comma delimited string*
+* `authors_array` *Returns an array of all author names
 * `publisher`
 * `published_date`
 * `description`

data/lib/book/item.rb

@@ -1,7 +1,7 @@
 module GoogleBooks
 
   class Item
-    attr_reader :kind, :id, :title, :authors, :publisher, :published_date, :description, :isbn, :isbn_10, :isbn_13, :other_identifier, :page_count, :print_type, :categories, :average_rating, :ratings_count, :language, :preview_link, :info_link, :sale_info
+    attr_reader :kind, :id, :title, :titles_array, :authors, :authors_array, :publisher, :published_date, :description, :isbn, :isbn_10, :isbn_13, :other_identifier, :page_count, :print_type, :categories, :average_rating, :ratings_count, :language, :preview_link, :info_link, :sale_info
 
     def initialize(item)
       @item = item
@@ -12,39 +12,41 @@ module GoogleBooks
     # Enables image_link attribute to be customized via passing
     # optional zoom and edge arguments as a hash
     def image_link(opts = {})
-    	opts[:zoom] ||= 1
-    	opts[:curl] ||= false
-     	@volume_info['imageLinks']['thumbnail'].gsub('zoom=1', "zoom=#{opts[:zoom]}").gsub('&edge=curl', "&edge=#{opts[:curl] ? 'curl' : 'none'}") rescue nil
+      opts[:zoom] ||= 1
+      opts[:curl] ||= false
+      @volume_info['imageLinks']['thumbnail'].gsub('zoom=1', "zoom=#{opts[:zoom]}").gsub('&edge=curl', "&edge=#{opts[:curl] ? 'curl' : 'none'}") rescue nil
     end
 
   private
 
-  	def retrieve_attribute
-    	@kind = @item['kind']
-    	@id = @item['id']
-    	@title = build_title
-    	@authors = [@volume_info['authors']].flatten.join(', ')
-    	@publisher = @volume_info['publisher']
-    	@published_date = @volume_info['publishedDate']
-    	@description = @volume_info['description']
+    def retrieve_attribute
+      @kind = @item['kind']
+      @id = @item['id']
+      @title = build_title
+      @titles_array = [@volume_info['title'], @volume_info['subtitle']].compact
+      @authors = [@volume_info['authors']].flatten.join(', ')
+      @authors_array = [@volume_info['authors']].flatten
+      @publisher = @volume_info['publisher']
+      @published_date = @volume_info['publishedDate']
+      @description = @volume_info['description']
 
       retrieve_industry_identifiers
 
-    	@page_count = @volume_info['pageCount']
-    	@print_type = @volume_info['printType']
-    	@categories = [@volume_info['categories']].flatten.join(', ')
-			@average_rating = @volume_info['averageRating']
-			@ratings_count = @volume_info['ratingsCount']
-			@language = @volume_info['language']
-			@preview_link = @volume_info['previewLink']
-			@info_link = @volume_info['infoLink']
+      @page_count = @volume_info['pageCount']
+      @print_type = @volume_info['printType']
+      @categories = [@volume_info['categories']].flatten.join(', ')
+      @average_rating = @volume_info['averageRating']
+      @ratings_count = @volume_info['ratingsCount']
+      @language = @volume_info['language']
+      @preview_link = @volume_info['previewLink']
+      @info_link = @volume_info['infoLink']
       @sale_info = @item['saleInfo']
-   	end
+    end
 
-   	def build_title
-   		title = [@volume_info['title']].flatten.join(': ')
-			@volume_info['subtitle'].nil? ? title : title + ": " + @volume_info['subtitle']
-		end
+    def build_title
+      title = [@volume_info['title']].flatten.join(': ')
+      @volume_info['subtitle'].nil? ? title : title + ": " + @volume_info['subtitle']
+    end
 
     def retrieve_industry_identifiers
 

data/lib/googlebooks.rb

@@ -36,6 +36,7 @@ module GoogleBooks
       parameters['maxResults'] = options[:count]
       parameters['key'] = options[:api_key] if options[:api_key]
       parameters['orderBy'] = 'newest' if options[:order_by].eql?('newest')
+      parameters['country'] = options[:country]
 
       Response.new(get(url.to_s))
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GoogleBooks
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/googlebooks/book/item_spec.rb

@@ -10,10 +10,18 @@ module GoogleBooks
         example.title.should eq "Freakonomics: A Rogue Economist Explores the Hidden Side of Everything"
       end
 
+      it "should return an array of all titles" do
+        example.titles_array.should include(*["Freakonomics", "A Rogue Economist Explores the Hidden Side of Everything"])
+      end
+
       it "should return a string authors delineated by a comma" do
         example.authors.should eq "Steven D. Levitt, Stephen J. Dubner"
       end
 
+      it "should return an array of author names" do
+        example.authors_array.should include(*["Steven D. Levitt", "Stephen J. Dubner"])
+      end
+
       it "should have an isbn that is 13 digits" do
         example.isbn.should_not eq nil
         example.isbn.should eq '9780062132345'

data/spec/googlebooks/googlebooks_spec.rb

@@ -30,12 +30,18 @@ describe GoogleBooks do
       GoogleBooks.send(:query).should include 'maxResults=20'
     end
     
+    it "should set the country" do
+      GoogleBooks.search('the great gatsby', :country => "ca")
+      GoogleBooks.send(:query).should include 'country=ca'
+    end
+    
     it "should join parameters" do
-      GoogleBooks.search('the great gatsby', :count => 20, :page => 2)
+      GoogleBooks.search('the great gatsby', :count => 20, :page => 2, :country => "ca")
       GoogleBooks.send(:query).should include 'startIndex=2'
       GoogleBooks.send(:query).should include 'maxResults=20'
       GoogleBooks.send(:query).should include 'q=the+great+gatsby'
-      GoogleBooks.send(:query).count('&').should eq 2 
+      GoogleBooks.send(:query).should include 'country=ca'
+      GoogleBooks.send(:query).count('&').should eq 3 
     end
     
     it "should return the proper number results based on the count passed in" do

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: googlebooks
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Zean Tsoi
@@ -10,15 +9,15 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-19 00:00:00 Z
+date: 2013-10-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - &id002 
+      - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :runtime
@@ -26,25 +25,19 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    - *id002
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    - *id002
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: GoogleBooks is a lightweight Ruby wrapper that queries the Google API to search for publications in the Google Books repository. It is inspired by the google-book gem which relies on the deprecated Google GData Books API, but is updated to hook into the current Google API.
 email: 
 - zean.tsoi@gmail.com
@@ -72,29 +65,25 @@ files:
 homepage: https://github.com/zeantsoi/googlebooks
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  - *id002
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  - *id002
 requirements: []
 
 rubyforge_project: googlebooks
-rubygems_version: 1.8.25
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: GoogleBooks is a lightweight Ruby wrapper that queries the Google API to search for publications in the Google Books repository.
 test_files: 
 - spec/googlebooks/book/item_spec.rb