googlebooks 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 399d18813263d0a61d626bed082934a9b2c0fcc6
-  data.tar.gz: 98fc2773a396e7495ecffab860baf58ecc4bde18
-SHA512: 
-  metadata.gz: 38f8d0ab7a550c64603f6aaec7a76d21653985816e77afd986104aedb02faa3589f70c8e81d6d8f601e364e48f9fedb27588997f049572b9bcdb7897775ff0ec
-  data.tar.gz: db8009bdfc1236dc3ddffa3ba8b3f6c49ba6c196d77bade56bec59b39154114aff7733128ba2edbe71f90f43616cf283fb09224bfb5d77dbf7eba0242d6c3268
+---
+SHA1:
+  metadata.gz: e23c0a340abeb5925dbb2942f00c3972aa767e96
+  data.tar.gz: 0efc45830013af8c69e04a537567657bbddb4e63
+SHA512:
+  metadata.gz: 5d5609f90e3eb3983b117878eff07081768835eafb0ce3c0dfca4ef372906b9ac60b6fd29c01d5719b9c15c1032dca7cca6f2bd6fda7f92f958b82575d97f9af
+  data.tar.gz: 992b09c5c91e07162a1f48e189799c4437278b0808109ca8089644968bc100e55c0951d99267671fd2de09f7e4850c8d45f645206cd5d00618638aacb22d6b1d

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.travis.yml

data/README.md

@@ -15,7 +15,7 @@ Using GoogleBooks is simple. There's just one class, `GoogleBooks`, and one meth
     books = GoogleBooks.search('The Great Gatsby')
     first_book = books.first
     
-    first_book.author #=> 'F. Scott Fitzgerald'
+    first_book.authors #=> 'F. Scott Fitzgerald'
     first_book.isbn #=> '9781443411080'
     first_book.image_link(:zoom => 6) #=> 'http://bks2.books.google.com/books?id=...'
     
@@ -45,6 +45,21 @@ 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
 
+Filtering
+-----------
+
+You can use the filter parameter to restrict the returned results further by setting it the to one of the following values:
+
+* `partial` *Returns results where at least parts of the text are previewable.*
+* `full` *Only returns results where all of the text is viewable.*
+* `free-ebooks` *Only returns results that are free Google eBooks.*
+* `paid-ebooks` *Only returns results that are Google eBooks with a price.*
+* `ebooks` *Only returns results that are Google eBooks, paid or free. Examples of non-eBooks would be publisher content that is available in limited preview and not for sale, or magazines.*
+
+Examples:
+
+    GoogleBooks.search('ruby', :filter => 'free-ebooks')
+
 Geolocation
 -----------
 

data/googlebooks.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |s|
   s.add_dependency('httparty')
   s.add_development_dependency('rspec')
   s.add_development_dependency('webmock')
-  
+  s.add_development_dependency('rspec-its')
+  s.add_development_dependency('rake')
+
   s.files         = `git ls-files`.split("\n")
   #s.files         = Dir["{lib}/**/*", "googlebooks.gemspec", "Gemfile", "Rakefile"]
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/googlebooks.rb

@@ -32,6 +32,7 @@ module GoogleBooks
       self.parameters = { 'q' => query }
       options[:page] ||= 1
       options[:count] ||= 5
+      parameters['filter'] = options[:filter] if options[:filter]
       parameters['startIndex'] = options[:count] * (options[:page] - 1)
       parameters['maxResults'] = options[:count]
       parameters['key'] = options[:api_key] if options[:api_key]

data/lib/version.rb

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

data/spec/googlebooks/book/item_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'rspec/its'
 
 module GoogleBooks
   class Item
@@ -7,50 +8,50 @@ module GoogleBooks
       example = GoogleBooks.search('isbn:9780062132345').first
 
       it "should append a subtitle to the title if it exists" do
-        example.title.should eq "Freakonomics: A Rogue Economist Explores the Hidden Side of Everything"
+        expect(example.title).to 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"])
+        expect(example.titles_array).to 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"
+        expect(example.authors).to 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"])
+        expect(example.authors_array).to 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'
-        example.isbn.to_s.length.should eq 13
+        expect(example.isbn).not_to eq nil
+        expect(example.isbn).to eq '9780062132345'
+        expect(example.isbn.to_s.length).to eq 13
       end
 
       it "should convert to a 10 digit isbn" do
-        example.isbn_10.should eq '0062132342'
+        expect(example.isbn_10).to eq '0062132342'
       end
 
       it "should make a 13 digit isbn duplicated from the default isbn" do
-        example.isbn_13.should eq '9780062132345'
-        example.isbn_13.should eq example.isbn
+        expect(example.isbn_13).to eq '9780062132345'
+        expect(example.isbn_13).to eq example.isbn
       end
 
       describe "image_link" do
         it "should have all zoom varieties and show 1 as a default" do
-          example.image_link.should include "zoom=1"
-          example.image_link(:zoom => 2).should include "zoom=2"
-          example.image_link(:zoom => 3).should include "zoom=3"
-          example.image_link(:zoom => 4).should include "zoom=4"
-          example.image_link(:zoom => 5).should include "zoom=5"
-          example.image_link(:zoom => 6).should include "zoom=6"
-          example.image_link(:zoom => 7).should include "zoom=7"
+          expect(example.image_link).to include "zoom=1"
+          expect(example.image_link(:zoom => 2)).to include "zoom=2"
+          expect(example.image_link(:zoom => 3)).to include "zoom=3"
+          expect(example.image_link(:zoom => 4)).to include "zoom=4"
+          expect(example.image_link(:zoom => 5)).to include "zoom=5"
+          expect(example.image_link(:zoom => 6)).to include "zoom=6"
+          expect(example.image_link(:zoom => 7)).to include "zoom=7"
         end
 
         it "should default to 'edge=none' and curl when dictated" do
-          example.image_link.should include "edge=none"
-          example.image_link(:curl => true).should include "edge=curl"
+          expect(example.image_link).to include "edge=none"
+          expect(example.image_link(:curl => true)).to include "edge=curl"
         end
 
         context "when google_book_item has no isbn_10 but one OTHER industry identifiers" do

data/spec/googlebooks/book/response_spec.rb

@@ -6,15 +6,15 @@ module GoogleBooks
     response = GoogleBooks.search('the great gatsby')
 
     it "should set total results" do
-      response.total_items.should > 0
+      expect(response.total_items).to be > 0
     end
 
     it "should return entries" do
-      response.first.should be_an Item
+      expect(response.first).to be_an Item
     end
 
     it "should handle an empty query" do
-      GoogleBooks.search('').to_a.should be_empty
+      expect(GoogleBooks.search('').to_a).to be_empty
     end
   end
 end

data/spec/googlebooks/googlebooks_spec.rb

@@ -4,53 +4,54 @@ describe GoogleBooks do
   describe "#search" do
     it "should escape spaces" do
       GoogleBooks.search('the great gatsby')
-      GoogleBooks.send(:query).should include 'q=the+great+gatsby'
+      expect(GoogleBooks.send(:query)).to include 'q=the+great+gatsby'
     end
 
 		describe 'startIndex' do
 		  it "should default to 0 if no page is specified" do
 		  	GoogleBooks.search('the great gatsby')
-		  	GoogleBooks.send(:query).should include 'startIndex=0'
+		  	expect(GoogleBooks.send(:query)).to include 'startIndex=0'
 		  end
 		  
 		  it "should calculate based on default count of 5 if no count is given" do
 		  	GoogleBooks.search("the great gatsby", :page => 4)
-		  	GoogleBooks.send(:query).should include 'startIndex=15'
+		  	expect(GoogleBooks.send(:query)).to include 'startIndex=15'
 		  end
 		  
 		  it "should set based on page number and count" do
 		    GoogleBooks.search('the great gatsby', {:page => 3, :count => 12})
-		    GoogleBooks.send(:query).should include 'startIndex=24'
+		    expect(GoogleBooks.send(:query)).to include 'startIndex=24'
 		  end
 		  
 		end
 
     it "should set the number of results per page" do
       GoogleBooks.search('the great gatsby', :count => 20)
-      GoogleBooks.send(:query).should include 'maxResults=20'
+      expect(GoogleBooks.send(:query)).to include 'maxResults=20'
     end
     
     it "should set the country" do
       GoogleBooks.search('the great gatsby', :country => "ca")
-      GoogleBooks.send(:query).should include 'country=ca'
+      expect(GoogleBooks.send(:query)).to include 'country=ca'
     end
     
     it "should join parameters" do
-      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).should include 'country=ca'
-      GoogleBooks.send(:query).count('&').should eq 3 
+      GoogleBooks.search('the great gatsby', :filter => "free-ebooks", :count => 20, :page => 2, :country => "ca")
+      expect(GoogleBooks.send(:query)).to include 'startIndex=2'
+      expect(GoogleBooks.send(:query)).to include 'maxResults=20'
+      expect(GoogleBooks.send(:query)).to include 'q=the+great+gatsby'
+      expect(GoogleBooks.send(:query)).to include 'country=ca'
+      expect(GoogleBooks.send(:query)).to include 'filter=free-ebooks'
+      expect(GoogleBooks.send(:query).count('&')).to eq 4
     end
     
     it "should return the proper number results based on the count passed in" do
       results = GoogleBooks.search('F. Scott Fitzgerald', :count => 20)
-      results.count.should eq 20
+      expect(results.count).to eq 20
     end
 
     it "should return a response" do
-      GoogleBooks.search('the great gatsby').should be_a GoogleBooks::Response
+      expect(GoogleBooks.search('the great gatsby')).to be_a GoogleBooks::Response
     end
   end
 end

metadata

@@ -1,91 +1,140 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: googlebooks
-version: !ruby/object:Gem::Version 
-  version: 0.0.8
+version: !ruby/object:Gem::Version
+  version: 0.0.9
 platform: ruby
-authors: 
+authors:
 - Zean Tsoi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-10-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - googlebooks.gemspec
+- lib/.DS_Store
 - lib/book/item.rb
 - lib/book/response.rb
 - lib/googlebooks.rb
 - lib/version.rb
+- spec/.DS_Store
+- spec/googlebooks/.DS_Store
 - spec/googlebooks/book/item_spec.rb
 - spec/googlebooks/book/response_spec.rb
 - spec/googlebooks/googlebooks_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/zeantsoi/googlebooks
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: googlebooks
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 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: 
+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/.DS_Store
 - spec/googlebooks/book/item_spec.rb
 - spec/googlebooks/book/response_spec.rb
 - spec/googlebooks/googlebooks_spec.rb