abebooks4r 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hasham Malik
+
+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/README.rdoc

@@ -0,0 +1,49 @@
+= abebooks4r
+
+abebooks4r provides high level ruby interface for AbeBooks REST service API.
+
+== Installation
+	
+  $ gem sources -a http://gemcutter.org
+  $ sudo gem install abebooks4r
+
+Abebooks4r requires hpricot gem
+  
+  $ sudo gem install hpricot
+  
+== Usage  
+
+  require 'abebooks4r'
+  
+  Abebooks4r::Abe.configure do |options|    
+	options[:clientkey] = ABE_ACCESS_KEY  	  
+  end
+  
+  res = Abebooks4r::Abe.search(:author => 'Brad Ediger', :title => 'Advanced Rails')
+  
+  unless res.has_error?
+    res.books.each do |book|
+      puts book.get('title')
+      puts book.get('author')
+    end
+  end
+
+== Links  
+
+  http://www.abebooks.de/docs/AffiliateProgram/WebServices/
+  http://hasham2.blogspot.com/
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Hasham Malik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "abebooks4r"
+    gem.summary = %Q{abebooks4r provides high level ruby interface for AbeBooks REST service API}
+    gem.description = %Q{Abebooks is a service to  buy and sell new and used books online. abebooks4r provides high level ruby interface for AbeBooks REST service API}
+    gem.email = "hasham2@gmail.com"
+    gem.homepage = "http://github.com/hasham2/abebooks4r"
+    gem.authors = ["Hasham Malik"]
+    gem.add_dependency('hpricot', '>= 0.4')    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "abebooks4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/abebooks4r.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{abebooks4r}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hasham Malik"]
+  s.date = %q{2009-10-26}
+  s.description = %q{Abebooks is a service to  buy and sell new and used books online. abebooks4r provides high level ruby interface for AbeBooks REST service API}
+  s.email = %q{hasham2@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "abebooks4r.gemspec",
+     "lib/abebooks4r.rb",
+     "test/helper.rb",
+     "test/test_abebooks4r.rb"
+  ]
+  s.homepage = %q{http://github.com/hasham2/abebooks4r}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{abebooks4r provides high level ruby interface for AbeBooks REST service API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_abebooks4r.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0.4"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0.4"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0.4"])
+  end
+end
+

data/lib/abebooks4r.rb

@@ -0,0 +1,244 @@
+#--
+# Copyright (c) 2009 Hasham Malik
+#
+# 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.
+#++
+
+require "cgi"
+require "base64"
+require "uri"
+require "net/https"
+require "hpricot"
+
+module Abebooks4r
+	
+	class RequestError < StandardError; end
+	
+	class Abe
+		
+		@@options = {:clientkey => ''}	
+		@@debug = false
+		
+		# Default service options
+		def self.options
+			@@options
+		end
+    
+		# Set default service options
+		def self.options=(opts)
+			@@options = opts
+		end
+    
+		# Get debug flag.
+		def self.debug
+			@@debug
+		end
+    
+		# Set debug flag to true or false.
+		def self.debug=(dbg)
+			@@debug = dbg
+		end
+    
+		def self.configure(&proc)
+			raise ArgumentError, "Block is required." unless block_given?
+			yield @@options
+		end
+		
+		#search abe books web service for the book
+		def self.search(params = {})
+			url = self.prepare_url(params)
+			log "Request URL: #{url}"
+			res = Net::HTTP.get_response(url)
+			unless res.kind_of? Net::HTTPSuccess
+				raise Abebooks4r::RequestError, "HTTP Response: #{res.code} #{res.message}"
+			end
+			log "Response text: #{res.body}"
+			Response.new(res.body)
+		end
+		
+		
+		# Response object returned after a REST call to Amazon service.
+		class Response
+			# XML input is in string format
+			def initialize(xml)
+				@doc = Hpricot(xml)
+			end
+
+			# Return Hpricot object.
+			def doc
+				@doc
+			end      
+      
+			# Return true if response has an error.
+			def has_error?
+				!(error.nil? || error.empty?)
+			end
+
+			# Return error message.
+			def error
+				Element.get(@doc, "searchresults/messages")
+			end
+      
+			# Return error code
+			def error_message
+				Element.get(@doc, "searchresults/messages")
+			end
+			
+			# Return an array of Abebooks4r::Element item objects.
+			def books
+				unless @books
+					@books = (@doc/"book").collect {|item| Element.new(item)}
+				end
+				@books
+			end
+			
+			# Return total results.
+			def total_results
+				unless @total_results
+					@total_results = (@doc/"resultcount").inner_html.to_i
+				end
+				@total_results		     	      	      
+			end     				                          
+		end
+		
+		protected
+		
+		def self.log(s)
+			return unless self.debug
+			if defined? RAILS_DEFAULT_LOGGER
+				RAILS_DEFAULT_LOGGER.error(s)
+			elsif defined? LOGGER
+				LOGGER.error(s)
+			else
+				puts s
+			end
+		end
+		
+		private
+		
+		def self.prepare_url(params)
+			params = params.merge(self.options)
+			url = URI.parse("http://search2.abebooks.com/search?" +
+				params.to_a.collect{|item| item.first.id2name + "=" + CGI::escape(item.last) }.join("&")
+          		)
+          		return url
+		end	
+	end
+	
+	# Internal wrapper class to provide convenient method to access Hpricot element value.
+	class Element
+	
+		# Pass Hpricot::Elements object
+		def initialize(element)
+			@element = element
+		end
+
+		# Returns Hpricot::Elments object    
+		def elem
+			@element
+		end
+    
+		# Find Hpricot::Elements matching the given path. Example: element/"author".
+		def /(path)
+			elements = @element/path
+			return nil if elements.size == 0
+			elements
+		end
+    
+		# Find Hpricot::Elements matching the given path, and convert to Abebooks4r::Element.
+		# Returns an array Abebooks4r::Elements if more than Hpricot::Elements size is greater than 1.
+		def search_and_convert(path)
+			elements = self./(path)
+			return unless elements
+			elements = elements.map{|element| Element.new(element)}
+			return elements.first if elements.size == 1
+			elements
+		end
+
+		# Get the text value of the given path, leave empty to retrieve current element value.
+		def get(path='')
+			Element.get(@element, path)
+		end
+    
+		# Get the unescaped HTML text of the given path.
+		def get_unescaped(path='')
+			Element.get_unescaped(@element, path)
+		end
+    
+		# Get the array values of the given path.
+		def get_array(path='')
+			Element.get_array(@element, path)
+		end
+
+		# Get the children element text values in hash format with the element names as the hash keys.
+		def get_hash(path='')
+			Element.get_hash(@element, path)
+		end
+
+		# Similar to #get, except an element object must be passed-in.
+		def self.get(element, path='')
+			return unless element
+			result = element.at(path)
+			result = result.inner_html if result
+			result
+		end
+    
+		# Similar to #get_unescaped, except an element object must be passed-in.    
+		def self.get_unescaped(element, path='')
+			result = get(element, path)
+			CGI::unescapeHTML(result) if result
+		end
+
+		# Similar to #get_array, except an element object must be passed-in.
+		def self.get_array(element, path='')
+			return unless element
+      
+			result = element/path
+			if (result.is_a? Hpricot::Elements) || (result.is_a? Array)
+				parsed_result = []
+				result.each {|item|
+					parsed_result << Element.get(item)
+				}
+				parsed_result
+			else
+				[Element.get(result)]
+			end
+        	end
+
+        	# Similar to #get_hash, except an element object must be passed-in.
+        	def self.get_hash(element, path='')
+        		return unless element
+    
+        		result = element.at(path)
+        		if result
+        			hash = {}
+        			result = result.children
+        			result.each do |item|
+        				hash[item.name.to_sym] = item.inner_html
+        			end 
+        			hash
+        		end
+        	end
+    
+        	def to_s
+        		elem.to_s if elem
+        	end
+        end	
+end	

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'abebooks4r'
+
+class Test::Unit::TestCase
+end

data/test/test_abebooks4r.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class TestAbebooks4r < Test::Unit::TestCase
+	
+	ABE_ACCESS_KEY = ''  
+  
+	raise "Please specify set your ABE_ACCESS_KEY" if ABE_ACCESS_KEY.empty?
+  
+  
+	Abebooks4r::Abe.configure do |options|    
+		options[:clientkey] = ABE_ACCESS_KEY  	  
+  	end
+	
+  	#set a switch for debugging
+  	Abebooks4r::Abe.debug = true
+	
+  	#test the result count from service
+	def test_abebooks_total_result_count
+		resp = Abebooks4r::Abe.search(:author => 'Brad Ediger', :title => 'Advanced Rails')
+		assert(resp.total_results == 41) #this varies time to time
+	end
+	
+	#test the composition of book obect returned
+	def test_abebooks_book_object
+		resp = Abebooks4r::Abe.search(:author => 'Brad Ediger', :title => 'Advanced Rails')		
+		assert(resp.books.first.get('title') == 'Advanced Rails')
+		assert(resp.books.first.get('author') == 'Ediger, Brad')
+	end
+	
+	#test error detection on service response
+	def test_abebooks_error
+		resp = Abebooks4r::Abe.search(:authr => 'Brad Ediger', :title => 'Advanced Rails')
+		assert(resp.has_error? == true)
+	end	
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: abebooks4r
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hasham Malik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 +05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
+description: Abebooks is a service to  buy and sell new and used books online. abebooks4r provides high level ruby interface for AbeBooks REST service API
+email: hasham2@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- abebooks4r.gemspec
+- lib/abebooks4r.rb
+- test/helper.rb
+- test/test_abebooks4r.rb
+has_rdoc: true
+homepage: http://github.com/hasham2/abebooks4r
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: abebooks4r provides high level ruby interface for AbeBooks REST service API
+test_files: 
+- test/helper.rb
+- test/test_abebooks4r.rb