isbndb 1.5.5 → 2.0.0

data/Rakefile

@@ -1,49 +1,9 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "isbndb"
-  gem.homepage = "https://github.com/sethvargo/isbndb"
-  gem.license = "MIT"
-  gem.summary = "This gem provides an easy solution for connecting to ISBNdb.com's API"
-  gem.description = "Ruby ISBNdb is a amazingly fast and accurate gem that reads ISBNdb.com's XML API and gives you incredible flexibilty with the results! The gem uses libxml-ruby, the fastest XML parser for Ruby, so you get blazing fast results every time. Additionally, the newest version of the gem also features caching, so developers minimize API-key usage."
-  gem.email = "seth.vargo@gmail.com"
-  gem.authors = ["Seth Vargo"]
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RSpec::Core::RakeTask.new(:spec)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "ruby_isbndb #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+namespace :test do
+  desc 'Run tests against the CI'
+  task :ci => [:spec]
 end

data/config/isbndb.example.yml

@@ -0,0 +1,3 @@
+access_keys:
+  - ABC123
+  - DEF456

data/isbndb.gemspec

@@ -1,79 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{isbndb}
-  s.version = "1.5.5"
+  s.name        = 'isbndb'
+  s.version     = '2.0.0'
+  s.author      = 'Seth Vargo'
+  s.email       = 'sethvargo@gmail.com'
+  s.homepage    = 'https://github.com/sethvargo/isbndb'
+  s.summary     = 'Connect with ISBNdb.com\'s API'
+  s.description = 'Ruby ISBNdb is a amazingly fast and accurate gem that reads ISBNdb.com\'s XML API and gives you incredible flexibilty with the results! The newest version of the gem also features caching, so developers minimize API-key usage.'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Seth Vargo}]
-  s.date = %q{2011-06-23}
-  s.description = %q{Ruby ISBNdb is a amazingly fast and accurate gem that reads ISBNdb.com's XML API and gives you incredible flexibilty with the results! The gem uses libxml-ruby, the fastest XML parser for Ruby, so you get blazing fast results every time. Additionally, the newest version of the gem also features caching, so developers minimize API-key usage.}
-  s.email = %q{seth.vargo@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.markdown"
-  ]
-  s.files = [
-    ".document",
-    "ACKNOWLEDGEMENTS",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "isbndb.gemspec",
-    "lib/isbndb.rb",
-    "lib/isbndb/access_key_set.rb",
-    "lib/isbndb/exceptions.rb",
-    "lib/isbndb/result.rb",
-    "lib/isbndb/result_set.rb",
-    "test/helper.rb",
-    "test/test_isbndb.rb"
-  ]
-  s.homepage = %q{https://github.com/sethvargo/isbndb}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{This gem provides an easy solution for connecting to ISBNdb.com's API}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_development_dependency 'rspec', '~> 2.10.0'
+  s.add_development_dependency 'shoulda', '~> 3.0.1'
+  s.add_development_dependency 'simplecov', '~> 0.6.4'
+  s.add_development_dependency 'webmock', '~> 1.8.7'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<rake>, [">= 0"])
-      s.add_runtime_dependency(%q<rdoc>, [">= 0"])
-      s.add_runtime_dependency(%q<libxml-ruby>, [">= 1.1.4"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<i18n>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
-      s.add_dependency(%q<libxml-ruby>, [">= 1.1.4"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<i18n>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
-    s.add_dependency(%q<libxml-ruby>, [">= 1.1.4"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
+  s.add_runtime_dependency 'httparty', '~> 0.8.3'
+  s.add_runtime_dependency 'rake', '~> 0.9.2.2'
 end
-

data/lib/core_extensions/nil.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def blank?
+    true
+  end
+end

data/lib/core_extensions/string.rb

@@ -0,0 +1,49 @@
+class String
+  require 'date'
+
+  def is_plural?
+    self.downcase.pluralize == self.downcase
+  end
+
+  def is_singular?
+    !self.is_plural?
+  end
+
+  def titleize
+    str = self[0].upcase + self[1..-1].downcase
+  end
+
+  def singularize
+    str = self.dup
+    if str[-3..-1] == 'ies'
+      str[0..-4] + 'y'
+    elsif str[-1] == 's'
+      str[0..-2]
+    else
+      str
+    end
+  end
+
+  def pluralize
+    str = self.dup
+    if str[-1] == 'y'
+      str[0..-2] + 'ies'
+    elsif str[-1] == 's'
+      str
+    else
+      str + 's'
+    end
+  end
+
+  def blank?
+    dup.strip.length == 0 ? true : false
+  end
+
+  def underscore
+    self.dup.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/isbndb.rb

@@ -1,116 +1,12 @@
-# require dependencies
-require 'libxml'
-require 'active_support/inflector'
-
-# private sub-classes
-require 'isbndb/access_key_set'
-require 'isbndb/exceptions'
-require 'isbndb/result_set'
-require 'isbndb/result'
-
 module ISBNdb
-  # The Query object is the most important class of the ISBNdb Module. It is the only public
-  # class, and handles the processing power.
-  class Query
-    DEFAULT_COLLECTION = :books
-    DEFAULT_RESULTS = :details
-    BASE_URL = "http://isbndb.com/api"
-  
-    # Access methods of the access_key_set instance variable. This allows developers to manually
-    # advance, add, remove, and manage keys. See the AccessKeySet class for more information.
-    attr_reader :access_key_set
-  
-    # This method sets an array of access_keys to use for making requests to the ISBNdb API.
-    def initialize(access_keys)
-      @access_key_set = ISBNdb::AccessKeySet.new(access_keys)
-    end
-  
-    # This is the generic find method. It accepts a hash of parameters including :collection,
-    # :where clauses, and :results to show. It builds the corresponding URI and sends that URI
-    # off to the ResultSet for processing.
-    def find(params = {})
-      raise "No parameters specified! You must specify at least one parameter!" unless params[:where]
-      
-      collection = params[:collection] ||= DEFAULT_COLLECTION
-      results = params[:results] ||= DEFAULT_RESULTS
-      results = [results].flatten
-      
-      # build the search clause
-      searches = []
-      params[:where].each_with_index do |(key,val), i|
-        searches << "index#{i+1}=#{key.to_s.strip}"
-        searches << "value#{i+1}=#{val.to_s.strip}"
-      end
-    
-      # make the request
-      make_request(collection, results, searches)
-    end
-    
-    # This method returns keystats about your API key, including the number of requests
-    # and the number of granted requets. Be advised that this request actually counts 
-    # as a request to the server, so use with caution.
-    def keystats
-      uri = "#{BASE_URL}/books.xml?access_key=#{@access_key_set.current_key}&results=keystats"
-      keystats = {}
-      LibXML::XML::Parser.file(uri).parse.find('KeyStats').first.attributes.each { |attribute| keystats[attribute.name.to_sym] = attribute.value.to_i unless attribute.name == 'access_key' }
-      return keystats
-    end
-    
-    # Method missing allows for dynamic finders, similar to that of ActiveRecord. See
-    # the README for more information on using magic finders.
-    def method_missing(m, *args, &block)
-      m = m.to_s.downcase
-      
-      if m.match(/find_(.+)_by_(.+)/)
-        split = m.split('_', 4)
-        collection, search_strs = split[1].downcase.pluralize, [split.last]
-        
-        # check and see if we are searching multiple fields
-        search_strs = search_strs.first.split('_and_') if(search_strs.first.match(/_and_/))
-        raise "Wrong Number of Arguments (#{args.size} for #{search_strs.size})" if args.size != search_strs.size
-      
-        # create the searches hash
-        searches = {}
-        search_strs.each_with_index { |str, i| searches[str.strip.to_sym] = args[i].strip }
-      
-        return find(:collection => collection, :where => searches)
-      end
-      
-      super
-    end
-    
-    # Pretty print the Query object with the access key.
-    def to_s
-      "#<ISBNdb::Query, @access_key=#{@access_key_set.current_key}>"
-    end
-    
-    private
-    # Make the request to the ResultSet. If the request fails because of an ISBNdb::AccessKeyError
-    # the system will automatically rollover to the next AccessKey in the AccessKeySet. If one exists,
-    # a new request is attempted. If not, the ISBNdb::AccessKeyError persists and can be caught by your
-    # application logic.
-    def make_request(collection, results, searches)
-      begin
-        uri = "#{BASE_URL}/#{collection}.xml?access_key=#{@access_key_set.current_key}&results=#{results.join(',')}&#{searches.join('&')}"
-        ISBNdb::ResultSet.new(uri, collection.singularize.capitalize)
-      rescue ISBNdb::AccessKeyError
-        puts "Access Key Error (#{@access_key_set.current_key}) - You probably reached your limit! Trying the next key."
-        @access_key_set.next_key!
-        retry unless @access_key_set.current_key.nil?
-        raise ISBNdb::AccessKeyError
-      end
-    end
-  end
-end
+  require 'httparty'
 
+  require 'isbndb/access_key_set'
+  require 'isbndb/exceptions'
+  require 'isbndb/query'
+  require 'isbndb/result_set'
+  require 'isbndb/result'
 
-# Add a few methods to the String class
-class String
-  def is_plural?
-    self.downcase.pluralize == self.downcase 
-  end
-  
-  def is_singular?
-    !self.is_plural?
-  end
-end
+  require 'core_extensions/string'
+  require 'core_extensions/nil'
+end

data/lib/isbndb/access_key_set.rb

@@ -1,53 +1,64 @@
 module ISBNdb
-  
-  private
+  protected
   # The AccessKeySet is a simple class used to manage access keys. It is used primarily
   # by the ruby_isbndb class to automatically advance access keys when necessary.
   class AccessKeySet
     # Create the @access_keys array and then verify that the keys are valid keys.
-    def initialize(access_keys)
-      @access_keys = [access_keys].flatten
+    def initialize
+      @access_keys ||= YAML::load(File.open('config/isbndb.yml'))['access_keys']
     end
-    
+
+    # Returns the total number of access keys in this set.
+    def size
+      @access_keys.size
+    end
+
+    def current_index
+      @current_index ||= 0
+    end
+
     # Get the current key. It returns a string of the access key.
     def current_key
-      @access_keys[@current_index ||= 0]
+      @access_keys[current_index]
     end
-    
+
     # Move the key pointer forward.
     def next_key!
-      @current_index += 1
+      @current_index = current_index + 1
+      current_key
     end
-    
+
     # Get the next key.
     def next_key
-      @access_keys[@current_index+1]
+      @access_keys[current_index+1]
     end
-    
+
     # Move the key pointer back.
     def prev_key!
-      @current_index -= 1
+      @current_index = current_index - 1
+      current_key
     end
-    
+
     # Get the previous key.
     def prev_key
-      @access_keys[@current_index-1]
+      @access_keys[current_index-1]
     end
-    
-    # Tell Ruby ISBNdb to use a specified key. If the key does not exist, it is 
+
+    # Tell Ruby ISBNdb to use a specified key. If the key does not exist, it is
     # added to the set and set as the current key.
     def use_key(key)
       @current_index = @access_keys.index(key) || @access_keys.push(key).index(key)
+      current_key
     end
-    
+
     # Remove the given access key from the AccessKeySet.
     def remove_key(key)
       @access_keys.delete(key)
     end
-    
+
     # Pretty print the AccessKeySet
     def to_s
-      "#<AccessKeySet @keys=<#{@access_keys.collect{ |key| key }.join(',')}>>"
+      "#<AccessKeySet @keys=#{@access_keys.inspect}>"
     end
   end
-end
+end

data/lib/isbndb/exceptions.rb

@@ -1,4 +1,3 @@
 module ISBNdb
   class AccessKeyError < StandardError; end
-  class InvalidURIError < StandardError; end
-end
+end

data/lib/isbndb/query.rb

@@ -0,0 +1,78 @@
+module ISBNdb
+  # The Query object is the most important class of the ISBNdb Module. It is the only public
+  # class, and handles the processing power.
+  class Query
+    include HTTParty
+    base_uri 'http://isbndb.com/api'
+    headers 'Content-Type' => 'text/xml'
+
+    # This is the generic find method. It accepts a hash of parameters including :collection,
+    # :where clauses, and :results to show. It builds the corresponding URI and sends that URI
+    # off to the ResultSet for processing.
+    def self.find(params = {})
+      raise 'No parameters specified! You must specify at least one parameter!' unless params[:where]
+      raise 'params[:where] cannot be a String! It must be a Hash!' if params[:where].is_a?(String)
+      raise 'params[:where] cannot be an Array! It must be a Hash!' if params[:where].is_a?(Array)
+
+      collection = params[:collection] ||= :books
+      results = params[:results] ||= :details
+      results = [results].flatten
+
+      # build the search clause
+      searches = []
+      params[:where].each_with_index do |(key,val), i|
+        searches << "index#{i+1}=#{key.to_s.strip}"
+        searches << "value#{i+1}=#{val.to_s.strip}"
+      end
+
+      # make the request
+      uri = "/#{collection}.xml?access_key=#{access_key_set.current_key}&results=#{results.join(',')}&#{searches.join('&')}"
+      ISBNdb::ResultSet.new(uri, collection)
+    rescue ISBNdb::AccessKeyError
+      access_key_set.next_key!
+      retry unless access_key_set.current_key.nil?
+      raise
+    end
+
+    # This method returns keystats about your API key, including the number of requests
+    # and the number of granted requets. Be advised that this request actually counts
+    # as a request to the server, so use with caution.
+    def self.keystats
+      result = self.get("/books.xml?access_key=#{access_key_set.current_key}&results=keystats")
+      result.parsed_response['ISBNdb']['KeyStats'] || {}
+    end
+
+    # Method missing allows for dynamic finders, similar to that of ActiveRecord. See
+    # the README for more information on using magic finders.
+    def self.method_missing(m, *args, &block)
+      method = m.to_s.downcase
+
+      if method.match(/find_(.+)_by_(.+)/)
+        split = method.split('_', 4)
+        collection, search_strs = split[1].downcase.pluralize, [split.last]
+
+        # check and see if we are searching multiple fields
+        search_strs = search_strs.first.split('_and_') if(search_strs.first.match(/_and_/))
+        raise "Wrong Number of Arguments (#{args.size} for #{search_strs.size})" if args.size != search_strs.size
+
+        # create the searches hash
+        searches = {}
+        search_strs.each_with_index { |str, i| searches[str.strip.to_sym] = args[i].strip }
+
+        return find(:collection => collection, :where => searches)
+      end
+
+      super
+    end
+
+    # Pretty print the Query object with the access key.
+    def self.to_s
+      "#<ISBNdb::Query, @access_key=#{access_key_set.current_key}>"
+    end
+
+    private
+    def self.access_key_set
+      @@access_key_set ||= ISBNdb::AccessKeySet.new
+    end
+  end
+end