bookle 0.0.1 → 0.0.5

data/lib/bookle.rb

@@ -1,8 +1,13 @@
 require 'bookle/google_books_api'
 
+# Enables Ruby code interact with the Google Books API.
 class Bookle
-	# def self.api(google_books_api_key=nil)
-	def self.api(google_books_api_key='AIzaSyAUJ0psGl0udam2kFzT29L2YWAhCF748ik')
+
+	# Returns an instance of the class that interacts with the Google Books API.
+	#
+  # @return [Google::Books::API] -- An instance of the class that interacts with the Google Books API.
+	def self.api(google_books_api_key)
 		Google::Books::API.new(google_books_api_key)
 	end
+
 end

data/lib/bookle/google_books_access_info.rb

@@ -8,19 +8,17 @@ module Google
 				:access_view_status
 
 			def initialize(access_info)
-				if access_info
-					@access_country 						= access_info["country"]
-					@viewability 								= access_info["viewability"]
-					@embeddable 								= access_info["embeddable"]
-					@public_domain 							= access_info["publicDomain"]
-					@text_to_speech_permission 	= access_info["textToSpeechPermission"]
-					@epub 											= Google::Books::Epub.new(access_info["epub"])
-					@pdf 												= Google::Books::Pdf.new(access_info["pdf"])
-					@web_reader_link 						= access_info["webReaderLink"]
-					@access_view_status 				= access_info["accessViewStatus"]
-				end
+				access_info									= {} unless access_info
+				@access_country 						= access_info["country"]
+				@viewability 								= access_info["viewability"]
+				@embeddable 								= access_info["embeddable"]
+				@public_domain 							= access_info["publicDomain"]
+				@text_to_speech_permission 	= access_info["textToSpeechPermission"]
+				@epub 											= Google::Books::Epub.new(access_info["epub"])
+				@pdf 												= Google::Books::Pdf.new(access_info["pdf"])
+				@web_reader_link 						= access_info["webReaderLink"]
+				@access_view_status 				= access_info["accessViewStatus"]
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_api.rb

@@ -31,16 +31,24 @@ module Google
 
 			attr_accessor *(GOOGLE_QUERY_KEYWORDS.keys + GOOGLE_OPTIONAL_PARAMETERS.keys).map{|method_name| method_name.to_sym} << :google_books_api_key
 
+		  # Instantiates the API for a given Google key.
+		  # 
+		  # @param [String, #read] -- Google API key.
+		  # @return [Google::Books::API] -- An API to interact with the Google Books API.
 			def initialize(google_books_api_key)
 				@google_books_api_key = google_books_api_key
 				@total_volumes				= 0
 				@volumes 							= []
 			end
 
+		  # Returns a list of accessors that can be used to set the search criteria.
+		  # 
+		  # @return [Array] -- A list of accessors that can be used to set the search criteria.
 			def search_accessors
 				GOOGLE_QUERY_KEYWORDS.keys + GOOGLE_OPTIONAL_PARAMETERS.keys
 			end
 
+		  # Clears the search criteria.
 			def clear_search_options
 				search_accessors.each do |method_name|
 					__send__ "#{method_name}=".to_sym, nil
@@ -49,21 +57,14 @@ module Google
 				nil
 			end
 
-			# Build and also let the user query the string.
-			# schema 						= https
-			# host							= www.googleapis.com`
-			# path 							= books/v1/volumes
-			# key marker 				= key
-			# query marker 			= q
-			# keyword separator	= + (used in build_query_options())
+			# Builds and also lets users query the URI string used to interact with the Google API.
 			def uri_string
 				"https://www.googleapis.com/books/v1/volumes?key=#{@google_books_api_key}#{build_optional_parameters}&q=#{build_query_options}"
 			end
 
-			# The Google Books API builds its query using 'OR', not 'AND'. That means that the more keywords used during the search
-			# the wider the range of results.
-			# When search options are passed to this method prior search options set with the set_search_option method will be disregarded.
-			# def search(isbn='9780140196092')
+			# Runs the search against the Google API.
+			#
+		  # @return [Array] -- An array of volumes (or what the Google API calls "items").
 			def search
 				google_response	= nil
 				uri 						= URI(uri_string)
@@ -83,8 +84,11 @@ module Google
 			end
 
 
-			# cacert = certification authority certificates
+			# Updates the SSL certificates file.
+			#
+		  # @return [String] -- Either a successful message or an error explanation.
 			def update_cacert_file
+				# cacert = certification authority certificates
 				file_path = cacert_path
 
 				Net::HTTP.start("curl.haxx.se") do |http|
@@ -119,6 +123,9 @@ module Google
 
 			private
 
+				# Returns a string with optional parameters that the URI string uses to query the Google API.
+				#
+			  # @return [String] -- A string with optional parameters that the URI string uses to query the Google API.
 				def build_optional_parameters
 					string = ''
 
@@ -132,6 +139,9 @@ module Google
 					string
 				end
 
+				# Returns a string with the query string that the URI string uses to query the Google API.
+				#
+			  # @return [String] -- A string with the query string that the URI string uses to query the Google API.
 				def build_query_options
 					string = ''
 
@@ -146,6 +156,9 @@ module Google
 					string.chop
 				end
 
+				# Returns the full path of where the cacert file lives.
+				#
+			  # @return [String] -- The full path of where the cacert file lives.
 				def cacert_path
 					File.dirname(`gem which bookle`.chomp) + '/cacert/cacert.pem'
 				end

data/lib/bookle/google_books_epub.rb

@@ -4,15 +4,13 @@ module Google
 			attr_reader :is_available
 
 			def initialize(epub)
-				if epub
-					@is_available = epub["isAvailable"]
-				end
+				epub 					= {} unless epub
+				@is_available = epub["isAvailable"]
 			end
 
 			def to_hash
 				{"is_epub_available" => self.is_available}
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_image_links.rb

@@ -4,12 +4,10 @@ module Google
 			attr_reader :small_thumbnail, :thumbnail
 
 			def initialize(image_links)
-				if image_links
-					@small_thumbnail 	= image_links["smallThumbnail"]
-					@thumbnail 				= image_links["thumbnail"]
-				end
+        image_links = {} unless image_links
+				@small_thumbnail 	= image_links["smallThumbnail"]
+				@thumbnail 				= image_links["thumbnail"]
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_industry_identifier.rb

@@ -4,6 +4,7 @@ module Google
 			attr_reader :type, :identifier
 
 			def initialize(identifier)
+				identifier 	= {} unless identifier
 				@type 			= identifier["type"]
 				@identifier = identifier["identifier"]
 			end
@@ -11,7 +12,6 @@ module Google
 			def to_hash
 				{self.type.downcase => self.identifier}
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_item.rb

@@ -10,6 +10,7 @@ module Google
 			attr_reader :kind, :id, :etag, :self_link, :volume_info, :sale_info, :access_info, :search_info
 
 			def initialize(item)
+				item 					= {} unless item
 				@kind 				= item["kind"]
 				@id 					= item["id"]
 				@etag					= item["etag"]
@@ -23,7 +24,6 @@ module Google
 			def hash
 				Hasherizer.to_hash(self)
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_list_price.rb

@@ -7,7 +7,6 @@ module Google
 			def to_hash
 				{"list_price_amount" => self.amount, "list_price_currency_code" => self.currency_code}
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_pdf.rb

@@ -4,15 +4,13 @@ module Google
 			attr_reader :is_available
 
 			def initialize(pdf)
-				if pdf
-					@is_available = pdf["isAvailable"]
-				end
+				pdf 					= {} unless pdf
+				@is_available = pdf["isAvailable"]
 			end
 
 			def to_hash
 				{"is_pdf_available" => self.is_available}
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_price.rb

@@ -4,12 +4,10 @@ module Google
 			attr_reader :amount, :currency_code
 
 			def initialize(price)
-				if price
-					@amount					= price["amount"]
-					@currency_code	= price["currencyCode"]
-				end
+        price           = {} unless price
+				@amount					= price["amount"]
+				@currency_code	= price["currencyCode"]
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_retail_price.rb

@@ -7,7 +7,6 @@ module Google
 			def to_hash
 				{"retail_price_amount" => self.amount, "retail_price_currency_code" => self.currency_code}
 			end
-
 		end
 	end
 end

data/lib/bookle/google_books_sale_info.rb

@@ -7,16 +7,14 @@ module Google
 		  attr_reader :sale_country, :saleability, :is_ebook, :list_price, :retail_price, :buy_link
 
 		  def initialize(sale_info)
-		  	if sale_info
-			    @sale_country = sale_info["country"]
-			    @saleability  = sale_info["saleability"]
-			    @is_ebook 		= sale_info["isEbook"]
-			    @list_price		= Google::Books::ListPrice.new(sale_info["listPrice"])
-			    @retail_price = Google::Books::RetailPrice.new(sale_info["retailPrice"])
-			    @buy_link			= sale_info["buyLink"]
-			  end
+		  	sale_info 		= {} unless sale_info
+		    @sale_country = sale_info["country"]
+		    @saleability  = sale_info["saleability"]
+		    @is_ebook 		= sale_info["isEbook"]
+		    @list_price		= Google::Books::ListPrice.new(sale_info["listPrice"])
+		    @retail_price = Google::Books::RetailPrice.new(sale_info["retailPrice"])
+		    @buy_link			= sale_info["buyLink"]
 		  end
-
 		end
 	end
 end

data/lib/bookle/google_books_search_info.rb

@@ -4,9 +4,8 @@ module Google
 			attr_reader :text_snippet
 
 			def initialize(search_info)
-				if search_info
-					@text_snippet = search_info["textSnippet"]
-				end
+        search_info   = {} unless search_info
+				@text_snippet = search_info["textSnippet"]
 			end
 		end
 	end

data/lib/bookle/google_books_volume_info.rb

@@ -9,30 +9,28 @@ module Google
 				:info_link, :canonical_volume_link
 
 			def initialize(volume_info)
-				if volume_info
-					@title 									= volume_info["title"]
-					@subtitle 							= volume_info["subtitle"]
-					@authors  							= volume_info["authors"]
-					@publisher 							= volume_info["publisher"]
-					@published_date 				= volume_info["published_date"]
-					@description 						= volume_info["description"]
-					@industry_identifiers 	= volume_info["industryIdentifiers"].collect do
-																			|i| Google::Books::IndustryIdentifier.new(i)
-																		end if volume_info["industryIdentifiers"]
-					@page_count 						= volume_info["pageCount"]
-					@print_type 						= volume_info["printType"]
-					@categories 						= volume_info["categories"]
-					@average_rating 				= volume_info["averageRating"]
-					@ratings_count 					= volume_info["ratingsCount"]
-					@content_version 				= volume_info["contentVersion"]
-					@image_links 						= Google::Books::ImageLinks.new(volume_info["imageLinks"])
-					@language 							= volume_info["language"]
-					@preview_link 					= volume_info["previewLink"]
-					@info_link 							= volume_info["infoLink"]
-					@canonical_volume_link 	= volume_info["canonicalVolumeLink"]
-				end
+				volume_info 						= {} unless volume_info
+				@title 									= volume_info["title"]
+				@subtitle 							= volume_info["subtitle"]
+				@authors  							= volume_info["authors"]
+				@publisher 							= volume_info["publisher"]
+				@published_date 				= volume_info["published_date"]
+				@description 						= volume_info["description"]
+				@industry_identifiers 	= volume_info["industryIdentifiers"].collect do
+																		|i| Google::Books::IndustryIdentifier.new(i)
+																	end if volume_info["industryIdentifiers"]
+				@page_count 						= volume_info["pageCount"]
+				@print_type 						= volume_info["printType"]
+				@categories 						= volume_info["categories"]
+				@average_rating 				= volume_info["averageRating"]
+				@ratings_count 					= volume_info["ratingsCount"]
+				@content_version 				= volume_info["contentVersion"]
+				@image_links 						= Google::Books::ImageLinks.new(volume_info["imageLinks"])
+				@language 							= volume_info["language"]
+				@preview_link 					= volume_info["previewLink"]
+				@info_link 							= volume_info["infoLink"]
+				@canonical_volume_link 	= volume_info["canonicalVolumeLink"]
 			end
-
 		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000 Z
+date: 2012-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &19283832 !ruby/object:Gem::Requirement
+  requirement: &76971900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *19283832
+  version_requirements: *76971900
 - !ruby/object:Gem::Dependency
   name: hasherizer
-  requirement: &19282476 !ruby/object:Gem::Requirement
+  requirement: &76970760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '0.0'
   type: :runtime
   prerelease: false
-  version_requirements: *19282476
+  version_requirements: *76970760
 description: Allows to search for books within Google Books. This is basically an
   adapter for the Google Books API for volume searches.
 email: pepe.hipolito@gmail.com
@@ -40,23 +40,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/bookle/google_books_access_info.rb
+- lib/bookle/google_books_retail_price.rb
+- lib/bookle/google_books_list_price.rb
+- lib/bookle/google_books_item.rb
+- lib/bookle/google_books_price.rb
+- lib/bookle/google_books_items.rb
 - lib/bookle/google_books_api.rb
 - lib/bookle/google_books_epub.rb
+- lib/bookle/google_books_access_info.rb
+- lib/bookle/google_books_search_info.rb
+- lib/bookle/google_books_sale_info.rb
 - lib/bookle/google_books_image_links.rb
-- lib/bookle/google_books_industry_identifier.rb
-- lib/bookle/google_books_item.rb
-- lib/bookle/google_books_items.rb
-- lib/bookle/google_books_list_price.rb
 - lib/bookle/google_books_pdf.rb
-- lib/bookle/google_books_price.rb
-- lib/bookle/google_books_retail_price.rb
-- lib/bookle/google_books_sale_info.rb
-- lib/bookle/google_books_search_info.rb
+- lib/bookle/google_books_industry_identifier.rb
 - lib/bookle/google_books_volume_info.rb
 - lib/bookle.rb
 - lib/cacert/cacert.pem
-homepage: http://rubygems.org/gems/bookle
+homepage: https://github.com/pepehipolito/bookle
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Google Books API volume search.