isbndb 1.5.5 → 2.0.0

data/lib/isbndb/result.rb

@@ -1,5 +1,5 @@
 module ISBNdb
-  
+
   private
   # The Result object is a true testament of metaprogramming. Almost every method of the Result
   # is dynamically generated through the build_result() method. All attribtues of the XML are
@@ -9,52 +9,51 @@ module ISBNdb
   class Result
     # Initialize simply calls build_result. Because the method definition is recusive, it must
     # be moved into a separate helper.
-    def initialize(top_node)
-      build_result(top_node)
+    def initialize(json = {})
+      @store = build_result(json)
     end
-    
-    # Because a result may or may not contain a specified key, we always return nil for 
+
+    # Because a result may or may not contain a specified key, we always return nil for
     # consistency. This allows developers to easily check for .nil? instead of checking for
-    # a miriad of exceptions throughout their code.
+    # a myriad of exceptions throughout their code.
     def method_missing(m, *args, &block)
-      nil
+      @store[m.to_s.underscore]
     end
-    
-    # Pretty preint the Result including the number of singleton methods that exist. If
+
+    # Return a list of all "methods" this class responds to
+    def instance_methods
+      @store.collect{ |key,value| key.to_s }
+    end
+
+    # Pretty print the Result including the number of singleton methods that exist. If
     # you want the ACTUAL singleton methods, call @result.singleton_methods.
     def to_s
-      @singleton_methods ||= []
-      "#<Result @num_singleton_methods=#{@singleton_methods.size}>"
+      "#<Result @num_singleton_methods=#{@store.size}>"
     end
-    
-    private
-    # This is the `magical` method. It essentially parses each attribute of the XML as well as
-    # the content of each XML node, dynamically sends a method to the instance with that attribute's
-    # or content's value. Not to be outdone, it recursively iterates over all children too!
-    def build_result(top_node)
-      top_node.attributes.each do |attribute|
-        singleton.send(:define_method, method_name(attribute.name)) { attribute.value } unless attribute.value.strip.empty?
-      end
-      
-      if top_node.children?
-        top_node.children.each { |child| build_result(child) }
-      else
-        singleton.send(:define_method, method_name(top_node.parent.name)) { top_node.content.strip.chomp(',') } unless top_node.content.strip.empty?
-      end
+
+    def inspect
+      "#<Result #{@store.collect{ |key,value| ':' + key.to_s + ' => ' + value.inspect }.join(', ')}>"
     end
-    
-    # This helper function reduces code redundancy and maintains consistency by formatting
-    # all method names the same. All method names are stripped of any trailing whitespaces,
-    # converted from CamelCase to under_score, and converted to a symbol 
-    def method_name(name)
-      name.strip.underscore.to_sym
+
+    def ==(result)
+      self.inspect == result.inspect
     end
-    
-    # We need a singleton reference to the current _instance_ so that we can dynamically define
-    # methods. This is just a simple helper that returns the singleton class of the current
-    # object instance.
-    def singleton
-      class << self; self end
+
+    private
+    def build_result(json)
+      result = {}
+
+      json.each do |key,value|
+        result[key.to_s.underscore] = if value.is_a?(Hash)
+          build_result(value)
+        elsif value.blank?
+          nil
+        else
+          value
+        end
+      end
+
+      result
     end
   end
-end
+end

data/lib/isbndb/result_set.rb

@@ -1,12 +1,16 @@
 module ISBNdb
-  
+
   private
   # The ResultSet is a collection of Result objects with helper methods for pagination. It
   # allows for easy paginating through multiple pages of results as well as jumping to a
   # specific results page.
   class ResultSet
     include Enumerable
-    
+    include HTTParty
+
+    base_uri 'http://isbndb.com/api'
+    headers 'Content-Type' => 'text/xml'
+
     # This method creates instance variables for @uri, @collection, and @current_page. It then
     # attempts to parse the XML at the gieven URI. If it cannot parse the URI for any reason,
     # it will raise an ISBNdb::InvalidURIError. Next, the results are checked for an any error
@@ -14,76 +18,71 @@ module ISBNdb
     # Finally, this method then actually builds the ResultSet.
     def initialize(uri, collection, current_page = 1)
       @uri = uri
-      @collection = collection
+      @collection = collection.to_s.titleize.singularize
       @current_page = current_page
-      @xml = parse_xml
-      
+      @parsed_response = self.class.get(@uri).parsed_response['ISBNdb']
+
       check_results
       build_results
     end
-    
+
+    def size
+      @results.size
+    end
+
     # Because ResultSet extends Enumerable, we need to define the each method. This allows users
     # to call methods like .first, .last, [5], and .each on the ResultSet, making it behave like
     # a primitive array.
     def each(&block)
       @results.each &block
     end
-    
+
     # Jump to a specific page. This method will return nil if the specified page does not exist.
     def go_to_page(page)
       get_total_pages unless @total_pages
-      return nil if page < 1 || page > @total_pages
+      return nil if page.to_i < 1 || page.to_i > @total_pages
       ISBNdb::ResultSet.new("#{@uri}&page_number=#{page}", @collection, page)
     end
-    
+
     # Go to the next page. This method will return nil if a next page does not exist.
     def next_page
       go_to_page(@current_page+1)
     end
-    
+
     # Go to the previous page. This method will return nil if a previous page does not exist.
     def prev_page
      go_to_page(@current_page-1)
     end
-    
+
     # Pretty prints the Result set information.
     def to_s
-      "#<ResultSet @collection=#{@collection}, total_results=#{@results.size}>"
+      "#<ResultSet::#{@collection} :total_results => #{@results.size}>"
     end
-    
-    private
-    # Try and parses and returns the XML from the given URI. If the parsing fails for any reason, this method
-    # raises ISBNdb::InvalidURIError. 
-    def parse_xml
-      begin
-        LibXML::XML::Parser.file(@uri).parse
-      rescue
-        raise ISBNdb::InvalidURIError
-      end
+
+    def ==(result_set)
+      self.size == result_set.size && self.instance_variable_get('@results') == result_set.instance_variable_get('@results')
     end
-    
-    # Check the results for an error message. If one exists, raise an ISBNdb::AccessKeyError for now. 
+
+    private
+    # Check the results for an error message. If one exists, raise an ISBNdb::AccessKeyError for now.
     # Currently the API does not differentiate between an overloaded API key and an invalid one
     # (it returns the same exact response), so there only exists one exception for now...
     def check_results
-      raise ISBNdb::AccessKeyError unless @xml.find("ErrorMessage").first.nil?
+      raise ISBNdb::AccessKeyError if @parsed_response['ErrorMessage']
     end
-    
+
     # Iterate over #{@collection}List/#{@collection}Data (ex. BookList/BookData) and build a result with
     # each child. This method works because the API always returns #{@collection}List followed by a subset
     # of #{@collection}Data. These results are all pushed into the @results array for accessing.
     def build_results
-      @results = []
-      list =  @xml.find("#{@collection}List/#{@collection}Data")
-      return [nil] if list.empty?
-      list.collect { |node| @results << Result.new(node) }
+      @results = @parsed_response["#{@collection}List"]["#{@collection}Data"].collect{ |json| Result.new(json) }
     end
-    
+
     # This helper method is mainly designed for use with the go_to_page(page) method. It parses the XML
     # and returns the total number of pages that exist for this result set.
     def get_total_pages
-      list = @xml.find("#{@collection}List").first.attributes
+      list = @parsed_response["#{@collection}List"]
       @total_pages = (list['total_results'].to_f/list['page_size'].to_f).ceil
     end
   end
-end
+end

data/spec/responses/access_key_error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T19:19:05Z">
+<ErrorMessage>Access key error</ErrorMessage>
+</ISBNdb>

data/spec/responses/authors_seth.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T20:26:27Z">
+<AuthorList total_results="401" page_size="10" page_number="1" shown_results="10">
+<AuthorData person_id="abraham_seth">
+<Name>Abraham, Seth</Name>
+<Details first_name="Seth" last_name="Abraham" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="abramson_seth_f">
+<Name>Abramson, Seth F.</Name>
+<Details first_name="Seth" last_name="Abramson" dates="1926-" has_books="1" />
+</AuthorData>
+<AuthorData person_id="adams_seth">
+<Name>Adams, Seth</Name>
+<Details first_name="Seth" last_name="Adams" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="seth_afikorah_danquah">
+<Name>Seth Afikorah-Danquah</Name>
+<Details first_name="Seth" last_name="Afikorah-Danquah" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="agata_seth_h">
+<Name>Agata, Seth H</Name>
+<Details first_name="Seth" last_name="Agata" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="agbo_seth_a">
+<Name>Agbo, Seth A.</Name>
+<Details first_name="Seth" last_name="Agbo" dates="1951-" has_books="1" />
+</AuthorData>
+<AuthorData person_id="allcorn_seth">
+<Name>Allcorn, Seth</Name>
+<Details first_name="Seth" last_name="Allcorn" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="ames_seth">
+<Name>Ames, Seth</Name>
+<Details first_name="Seth" last_name="Ames" dates="1805-1881." has_books="1" />
+</AuthorData>
+<AuthorData person_id="anderson_seth_b">
+<Name>Anderson, Seth B.</Name>
+<Details first_name="Seth" last_name="Anderson" dates="" has_books="1" />
+</AuthorData>
+<AuthorData person_id="seth_andrew_a01">
+<Name>Seth Andrew</Name>
+<Details first_name="Seth" last_name="Andrew" dates="" has_books="1" />
+</AuthorData>
+</AuthorList>
+</ISBNdb>

data/spec/responses/books_hello.xml

@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T20:10:13Z">
+<BookList total_results="1664" page_size="10" page_number="1" shown_results="10">
+<BookData book_id="100th_day_of_school_a04" isbn="1590543947" isbn13="9781590543948">
+<Title>100th Day of School</Title>
+<TitleLong>100th Day of School (Hello Reader Level 2)</TitleLong>
+<AuthorsText>Angela Shelf Medearis, </AuthorsText>
+<PublisherText publisher_id="fitzgerald_books">Fitzgerald Books</PublisherText>
+<Details change_time="2011-03-08T18:28:45Z" price_time="2012-05-29T16:45:46Z" edition_info="Unknown Binding; 2007-01" language="" physical_description_text="6.0&quot;x9.0&quot;x0.5&quot;; 0.4 lb; 32 pages" lcc_number="" dewey_decimal_normalized="" dewey_decimal="" />
+</BookData>
+<BookData book_id="100th_day_the" isbn="0439330173" isbn13="9780439330176">
+<Title>100th Day, The</Title>
+<TitleLong>100th Day, The (level 1) (Hello Reader Level 1)</TitleLong>
+<AuthorsText>Alayne Pick, Grace Maccarone, Laura Freeman (Illustrator)</AuthorsText>
+<PublisherText publisher_id="cartwheel">Cartwheel</PublisherText>
+<Details change_time="2006-02-27T21:34:15Z" price_time="2012-05-29T16:46:08Z" edition_info="Paperback; 2002-12-01" language="" physical_description_text="32 pages" lcc_number="" dewey_decimal_normalized="" dewey_decimal="" />
+</BookData>
+<BookData book_id="2011_hello_kitty_engagement_calendar" isbn="1423803558" isbn13="9781423803553">
+<Title>2011 Hello Kitty Engagement Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream (Contributor)</AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2010-09-21T21:20:39Z" price_time="2012-03-24T04:44:44Z" edition_info="Calendar; 2010-08-01" language="" physical_description_text="7.0&quot;x8.5&quot;x0.9&quot;; 1.1 lb" lcc_number="" dewey_decimal_normalized="741" dewey_decimal="741" />
+</BookData>
+<BookData book_id="2011_hello_kitty_wall_calendar" isbn="1423803981" isbn13="9781423803980">
+<Title>2011 Hello Kitty Wall Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream (Contributor)</AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2010-09-21T18:46:02Z" price_time="2012-04-25T20:26:40Z" edition_info="Calendar; 2010-08-01" language="" physical_description_text="10.8&quot;x11.8&quot;x0.2&quot;; 0.3 lb" lcc_number="" dewey_decimal_normalized="" dewey_decimal="" />
+</BookData>
+<BookData book_id="2012_hello_kitty_2_year_pocket_planner_calendar" isbn="1423809424" isbn13="9781423809425">
+<Title>2012 Hello Kitty 2 Year Pocket Planner Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream, </AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2012-01-17T22:23:43Z" price_time="2012-03-04T05:32:03Z" edition_info="Calendar; 2011-07-01" language="" physical_description_text="3.5&quot;x6.2&quot;x0.0&quot;; 0.1 lb" lcc_number="" dewey_decimal_normalized="636" dewey_decimal="636" />
+</BookData>
+<BookData book_id="2012_hello_kitty_juvenile_activity_calendar" isbn="1423811194" isbn13="9781423811190">
+<Title>2012 Hello Kitty Juvenile Activity Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream, </AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2012-05-15T00:52:54Z" price_time="2012-06-16T20:10:13Z" edition_info="Calendar; 2011-07-01" language="" physical_description_text="11.0&quot;x12.0&quot;x0.3&quot;; 0.8 lb" lcc_number="" dewey_decimal_normalized="741" dewey_decimal="741" />
+</BookData>
+<BookData book_id="2012_hello_kitty_mini_calendar" isbn="1423809165" isbn13="9781423809166">
+<Title>2012 Hello Kitty Mini Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream, </AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2012-01-17T22:24:12Z" price_time="2012-02-09T06:11:01Z" edition_info="Calendar; 2011-07-01" language="" physical_description_text="6.2&quot;x6.9&quot;x0.2&quot;; 0.1 lb" lcc_number="" dewey_decimal_normalized="741" dewey_decimal="741" />
+</BookData>
+<BookData book_id="2012_hello_kitty_wall_calendar" isbn="1423809696" isbn13="9781423809692">
+<Title>2012 Hello Kitty Wall Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream, </AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2012-01-17T22:14:27Z" price_time="2012-02-09T06:02:14Z" edition_info="Calendar; 2011-07-01" language="" physical_description_text="10.6&quot;x11.8&quot;x0.2&quot;; 0.5 lb" lcc_number="" dewey_decimal_normalized="741" dewey_decimal="741" />
+</BookData>
+<BookData book_id="2012_hello_kitty_weekly_engagement_calendar" isbn="1423809092" isbn13="9781423809098">
+<Title>2012 Hello Kitty Weekly Engagement Calendar</Title>
+<TitleLong></TitleLong>
+<AuthorsText>Day Dream, </AuthorsText>
+<PublisherText publisher_id="day_dream">Day Dream</PublisherText>
+<Details change_time="2012-01-17T22:14:34Z" price_time="2012-02-08T12:37:05Z" edition_info="Calendar; 2011-07-01" language="" physical_description_text="7.2&quot;x8.5&quot;x0.9&quot;; 1.0 lb" lcc_number="" dewey_decimal_normalized="741" dewey_decimal="741" />
+</BookData>
+<BookData book_id="2_grrrls_hello_gorgeous" isbn="0439187370" isbn13="9780439187374">
+<Title>Hello gorgeous</Title>
+<TitleLong>Hello gorgeous: a guide to style</TitleLong>
+<AuthorsText>by Kristen Kemp</AuthorsText>
+<PublisherText publisher_id="scholastic">New York : Scholastic, c2000.</PublisherText>
+<Details change_time="2009-09-29T18:09:13Z" price_time="2011-03-25T22:20:05Z" edition_info="(pbk.) :$3.99" language="eng" physical_description_text="64 p. : ill. (some col.) ; 20 cm." lcc_number="" dewey_decimal_normalized="" dewey_decimal="" />
+</BookData>
+</BookList>
+</ISBNdb>

data/spec/responses/categories_fiction.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T20:36:49Z">
+<CategoryList total_results="99" page_size="10" page_number="1" shown_results="10">
+<CategoryData category_id="society.religion.christianity.denominations.catholicism.literature.fiction" parent_id="society.religion.christianity.denominations.catholicism.literature">
+<Name>Fiction</Name>
+<Details summary="" depth="6" element_count="30" />
+</CategoryData>
+<CategoryData category_id="society.religion.christianity.denominations.catholicism.clergy.fiction" parent_id="society.religion.christianity.denominations.catholicism.clergy">
+<Name>Fiction</Name>
+<Details summary="" depth="6" element_count="16" />
+</CategoryData>
+<CategoryData category_id="society.family.family_members.fathers.single_and_divorced.fiction" parent_id="society.family.family_members.fathers.single_and_divorced">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="7" />
+</CategoryData>
+<CategoryData category_id="society.family.family_members.mothers.single_and_divorced.fiction" parent_id="society.family.family_members.mothers.single_and_divorced">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="25" />
+</CategoryData>
+<CategoryData category_id="society.family.family_members.mothers.working_mothers.fiction" parent_id="society.family.family_members.mothers.working_mothers">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="6" />
+</CategoryData>
+<CategoryData category_id="society.family.family_members.mothers.teenage_mothers.fiction" parent_id="society.family.family_members.mothers.teenage_mothers">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="4" />
+</CategoryData>
+<CategoryData category_id="society.sexuality.homosexuality.lesbians.literature.fiction" parent_id="society.sexuality.homosexuality.lesbians.literature">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="24" />
+</CategoryData>
+<CategoryData category_id="arts.music.styles.jazz.musicians.fiction" parent_id="arts.music.styles.jazz.musicians">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="6" />
+</CategoryData>
+<CategoryData category_id="regions.france.history.famous_people.napoleon_i.fiction" parent_id="regions.france.history.famous_people.napoleon_i">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="4" />
+</CategoryData>
+<CategoryData category_id="science.biology.fields.genetics.literature.fiction" parent_id="science.biology.fields.genetics.literature">
+<Name>Fiction</Name>
+<Details summary="" depth="5" element_count="3" />
+</CategoryData>
+</CategoryList>
+</ISBNdb>

data/spec/responses/keystats.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T18:32:28Z">
+<KeyStats granted="2" access_key="ABC123" requests="5" limit="0" />
+<BookList total_results="0" page_size="10" page_number="1" shown_results="0"></BookList>
+</ISBNdb>

data/spec/responses/publishers_francis.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ISBNdb server_time="2012-06-16T20:42:39Z">
+<PublisherList total_results="276" page_size="10" page_number="1" shown_results="10">
+<PublisherData publisher_id="taylor_francis_a01">
+<Name>: Taylor &amp; Francis</Name>
+<Details location="London [etc.]" />
+</PublisherData>
+<PublisherData publisher_id="a_a_balkema_taylor_francis">
+<Name>A.A. Balkema/Taylor &amp; Francis</Name>
+<Details location="Leiden, The Netherlands" />
+</PublisherData>
+<PublisherData publisher_id="albert_francis_perrin">
+<Name>Albert Francis Perrin</Name>
+<Details location="Ottawa" />
+</PublisherData>
+<PublisherData publisher_id="auerbach_publications_tayl_a02">
+<Name>Auerbach Publications, Taylor &amp; Francis Group</Name>
+<Details location="Boca Raton, FL" />
+</PublisherData>
+<PublisherData publisher_id="auerbach_publications_tayl_a01">
+<Name>Auerbach Publications/Taylor &amp; Francis</Name>
+<Details location="Boca Raton, FL" />
+</PublisherData>
+<PublisherData publisher_id="auerbach_publications_taylor_f">
+<Name>Auerbach Publications/Taylor &amp; Francis Group</Name>
+<Details location="Boca Raton, FL" />
+</PublisherData>
+<PublisherData publisher_id="auerbach_taylor_francis">
+<Name>Auerbach/Taylor&amp;Francis</Name>
+<Details location="Boca Raton" />
+</PublisherData>
+<PublisherData publisher_id="b_francis">
+<Name>B. Francis</Name>
+<Details location="[Coolangatta, Qld.]" />
+</PublisherData>
+<PublisherData publisher_id="balkema_taylor_francis">
+<Name>Balkema/Taylor &amp; Francis</Name>
+<Details location="[London]" />
+</PublisherData>
+<PublisherData publisher_id="beau_francis_press">
+<Name>Beau Francis Press</Name>
+<Details location="" />
+</PublisherData>
+</PublisherList>
+</ISBNdb>