ar_book_finder 1.0.0 → 1.1.0

data/README.md

@@ -2,7 +2,7 @@
 
 Retrieve book data from [arbookfind.com](http://www.arbookfind.com)
 
-[![Build Status](https://travis-ci.org/anthonator/ar-book-finder.png?branch=master)](https://travis-ci.org/anthonator/ar-book-finder) [![Dependency Status](https://gemnasium.com/anthonator/ar-book-finder.png)](https://gemnasium.com/anthonator/ar-book-finder) [![Coverage Status](https://coveralls.io/repos/anthonator/ar-book-finder/badge.png)](https://coveralls.io/r/anthonator/ar-book-finder) [![Code Climate](https://codeclimate.com/github/anthonator/ar-book-finder.png)](https://codeclimate.com/github/anthonator/ar-book-finder)
+[![Gem Version](https://badge.fury.io/rb/ar_book_finder.png)](http://badge.fury.io/rb/ar_book_finder) [![Build Status](https://travis-ci.org/anthonator/ar-book-finder.png?branch=master)](https://travis-ci.org/anthonator/ar-book-finder) [![Dependency Status](https://gemnasium.com/anthonator/ar-book-finder.png)](https://gemnasium.com/anthonator/ar-book-finder) [![Coverage Status](https://coveralls.io/repos/anthonator/ar-book-finder/badge.png)](https://coveralls.io/r/anthonator/ar-book-finder) [![Code Climate](https://codeclimate.com/github/anthonator/ar-book-finder.png)](https://codeclimate.com/github/anthonator/ar-book-finder)
 
 ## Installation
 
@@ -68,7 +68,7 @@ And publisher details:
 ## Usage
 
 ### Quick Search
-Quick search allows you to perform searches based on title, topics, author or ISBN.
+Quick search will allow you to perform searches based on title, topics, author or ISBN.
 
 Perform a quick search...
 ```ruby
@@ -79,7 +79,7 @@ results.books # Retrieve the books returned on this page
 Load book data on demand using ```#fetch```...
 ``` ruby
 ...
-book = results[0]
+book = results.book[0]
 book.fetch # Retrieve book data
 book.title
 book.author
@@ -94,11 +94,24 @@ publisher.isbn
 ...
 ```
 
-### Pagination and Sorting
-It's also possible to paginate and sort search results.
+### Collections
+Collections will retrieve books lists. Examples include awards, state lists, etc.
+
+Retrieve a collection...
+```ruby
+results = ARBookFinder.collection({ 'Awards' => 'ALA Notable/Best Books' })
+```
+
+Retrieve a collection with a multi-level hash...
+```ruby
+results = ARBookFinder.collection({ 'State Lists' => { 'Indiana' => 'IN Young Hoosier Middle Grades Book Award Nominees 2013-2014' } })
+```
+
+### Pagination
+It's also possible to paginate search results.
 ```ruby
 # Retrieve results for page 2 and sort on title
-results = ARBookFinder.Search('harry potter', 2, :title)
+results = ARBookFinder.search('harry potter', 2)
 ```
 
 ## Contributing

data/lib/ar_book_finder.rb

@@ -2,9 +2,11 @@ require 'capybara'
 require 'capybara/poltergeist'
 require 'nokogiri'
 
+require 'ar_book_finder/constants'
 require 'ar_book_finder/user_type_processor'
 require 'ar_book_finder/pagination_processor'
 require 'ar_book_finder/quick_search_processor'
+require 'ar_book_finder/collection_processor'
 require 'ar_book_finder/book_detail_processor'
 require 'ar_book_finder/search_results_parser'
 require 'ar_book_finder/book_detail_parser'
@@ -24,15 +26,15 @@ module ARBookFinder
     Scraper.new(user_type)
   end
 
-  def self.search(query, page = 1, sort_by = 'Relevance')
-    scraper(options[:user_type]).search(query, page, sort_by)
+  def self.search(query, page = 1)
+    scraper(options[:user_type]).search(query, page)
   end
 
   def self.advanced_search(user_type, search_type, params)
     raise 'Not yet implemented'
   end
 
-  def self.collection(topic, sub_topic)
-    raise 'Not yet implemented'
+  def self.collection(collection, page = 1)
+    scraper(options[:user_type]).collection(collection, page)
   end
 end

data/lib/ar_book_finder/book.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module ARBookFinder
   class Book
     attr_reader :cover, :title, :author, :summary,
@@ -29,12 +31,11 @@ module ARBookFinder
       load_ar_quiz_availability(parsed_data[:ar_quiz_availability])
       load_topics(parsed_data[:topics])
       load_series(parsed_data[:series])
-
-      parsed_data[:publishers].each { |p| @publishers << Publisher.new(p) }
+      load_publishers(parsed_data[:publishers])
     end
 
     def load_ar_quiz_availability(ar_quiz_availability)
-      @ar_quiz_availability = ar_quiz_availability.split(',').collect { |v| v.strip }
+      @ar_quiz_availability = ar_quiz_availability.split(',').collect { |v| v.strip.gsub('  ', '') }
     end
 
     def load_topics(topics)
@@ -46,5 +47,9 @@ module ARBookFinder
     def load_series(series)
       @series = series.split(';').collect { |v| v.strip }
     end
+    
+    def load_publishers(publishers)
+      publishers.each { |p| @publishers << Publisher.new(p) }
+    end
   end
 end

data/lib/ar_book_finder/collection_processor.rb

@@ -0,0 +1,30 @@
+module ARBookFinder
+  class CollectionProcessor
+    include Capybara::DSL
+    
+    COLLECTIONS_URL = "#{ARBookFinder::BASE_URL}/collections.aspx"
+    
+    def initialize(collections)
+      @collections = collections
+    end
+    
+    def process
+      unless current_url.downcase == COLLECTIONS_URL
+        visit(COLLECTIONS_URL)
+      end
+      navigate_collection(@collections)
+    end
+    
+    private
+    def navigate_collection(collection)
+      collection.each do |key, value|
+        click_on(key)
+        if value.kind_of?(Hash)
+          navigate_collection(value)
+        else
+          click_on(value)
+        end  
+      end
+    end
+  end
+end

data/lib/ar_book_finder/constants.rb

@@ -0,0 +1,3 @@
+module ARBookFinder
+  BASE_URL = 'http://www.arbookfind.com'
+end

data/lib/ar_book_finder/pagination_processor.rb

@@ -1,27 +1,21 @@
 module ARBookFinder
   class PaginationProcessor
     include Capybara::DSL
+    
+    SEARCH_GOTO_FIELD = 'ctl00_ContentPlaceHolder1_ucSeachResults_txtPageToGoToTop'
+    SEARCH_SUBMIT_BUTTON = 'ctl00_ContentPlaceHolder1_ucSeachResults_btnGoToPageTop'
+    
+    COLLECTION_GOTO_FIELD = 'ctl00_ContentPlaceHolder1_ucCollection_ucSeachResults_txtPageToGoToTop'
+    COLLECTION_SUBMIT_BUTTON = 'ctl00_ContentPlaceHolder1_ucCollection_ucSeachResults_btnGoToPageTop'
 
-    DEFAULT_SORT_BY = 'Relevance'
-
-    SORT_BY_TYPES = {
-      title: 'Title',
-      author: 'Author',
-      interest_level: 'Interest Level',
-      book_level: 'Book Level',
-      relevance: 'Relevance',
-      rating: 'Rating'
-    }
-
-    def initialize(page, sort_by)
+    def initialize(page, collection = false)
       @page = page
-      @sort_by = SORT_BY_TYPES[sort_by]
+      @field_const = collection ? :COLLECTION : :SEARCH
     end
 
     def process
-      fill_in('ctl00_ContentPlaceHolder1_ucSeachResults_txtPageToGoToTop', with: @page)
-      select(@sort_by, from: 'ctl00_ContentPlaceHolder1_ucSeachResults_lstSortOptionListTop')
-      click_button('ctl00_ContentPlaceHolder1_ucSeachResults_btnGoToPageTop')
+      fill_in(self.class.const_get(:"#{@field_const}_GOTO_FIELD"), with: @page)
+      click_button(self.class.const_get(:"#{@field_const}_SUBMIT_BUTTON"))
     end
   end
 end

data/lib/ar_book_finder/quick_search_processor.rb

@@ -1,19 +1,19 @@
 module ARBookFinder
   class QuickSearchProcessor
     include Capybara::DSL
+    
+    QUICK_SEARCH_URL = "#{ARBookFinder::BASE_URL}/default.aspx"
 
-    def initialize(query, page, sort_by)
+    def initialize(query)
       @query = query
-      @page = page
-      @sort_by = sort_by
     end
 
     def process
+      unless current_url.downcase == QUICK_SEARCH_URL
+        visit(QUICK_SEARCH_URL)
+      end
       fill_in('ctl00_ContentPlaceHolder1_txtKeyWords', with: @query)
       click_button('ctl00_ContentPlaceHolder1_btnDoIt')
-      if @page > 1 || @sort_by != PaginationProcessor::DEFAULT_SORT_BY
-        PaginationProcessor.new(@page, @sort_by).process
-      end
     end
   end
 end

data/lib/ar_book_finder/scraper.rb

@@ -1,13 +1,31 @@
 module ARBookFinder
   class Scraper
     def initialize(user_type)
-      @user_type = user_type
+      UserTypeProcessor.new(user_type).process
     end
 
-    def search(query, page = 1, sort_by = 'Relevance')
-      UserTypeProcessor.new(@user_type).process
-      QuickSearchProcessor.new(query, page, sort_by).process
-      SearchResultsParser.new(Capybara.page.html).parse
+    def search(query, page = 1)
+      QuickSearchProcessor.new(query).process
+      results = SearchResultsParser.new(Capybara.page.html).parse
+      if page > 1
+        results = paginate(page, false)
+      end
+      results
+    end
+    
+    def collection(collection, page = 1)
+      CollectionProcessor.new(collection).process
+      results = SearchResultsParser.new(Capybara.page.html, true).parse
+      if page > 1
+        results = paginate(page, true)
+      end
+      results
+    end
+    
+    private
+    def paginate(page, collection) 
+      PaginationProcessor.new(page, collection).process
+      SearchResultsParser.new(Capybara.page.html, collection).parse
     end
   end
 end

data/lib/ar_book_finder/search_results_parser.rb

@@ -1,36 +1,46 @@
 module ARBookFinder
   class SearchResultsParser
-    PAGE_COUNT_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucSeachResults_lblResultsSummaryTop"]'
-    RESULTS_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucSeachResults_lblQuizzes"]/table'
+    SEARCH_PAGE_COUNT_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucSeachResults_lblResultsSummaryTop"]'
+    SEARCH_RESULTS_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucSeachResults_lblQuizzes"]/table'
+    
+    COLLECTION_PAGE_COUNT_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucCollection_ucSeachResults_lblResultsSummaryTop"]'
+    COLLECTION_RESULTS_XPATH = '//*[@id="ctl00_ContentPlaceHolder1_ucCollection_ucSeachResults_lblQuizzes"]/table'
+    
     BOOK_XPATH = 'tbody/tr/td[2]'
     BOOK_DETAIL_XPATH = 'table/tbody/tr/td[2]'
     BOOK_URL_XPATH = 'a'
 
-    attr_reader :page_count, :books
+    attr_reader :current_page, :page_count, :total_books, :books
 
-    def initialize(html)
+    def initialize(html, collection = false)
       @doc = Nokogiri::HTML.parse(html)
+      @xpath_const = collection ? :COLLECTION : :SEARCH
       @books = []
     end
 
     def parse
-      @page_count = parse_page_count
+      @current_page = parse_current_page.to_i
+      @page_count = parse_page_count.to_i
       @books = parse_results
       self
     end
 
     private
+    def parse_current_page
+      @doc.xpath(self.class.const_get(:"#{@xpath_const}_PAGE_COUNT_XPATH")).text.gsub(/Page /, '').gsub(/ of \d+/, '')
+    end
+    
     def parse_page_count
-      @doc.xpath(PAGE_COUNT_XPATH).text.gsub(/Page \d+ of /, '')
+      @doc.xpath(self.class.const_get(:"#{@xpath_const}_PAGE_COUNT_XPATH")).text.gsub(/Page \d+ of /, '')
     end
 
     def parse_results
       books = []
-      @doc.xpath(RESULTS_XPATH).each_with_index do |result, i|
+      @doc.xpath(self.class.const_get(:"#{@xpath_const}_RESULTS_XPATH")).each_with_index do |result, i|
         next if i.odd?
         book = result.xpath(BOOK_XPATH)
         book_detail = book.xpath(BOOK_DETAIL_XPATH)
-        books << Book.new('http://www.arbookfind.com/' + book_detail.xpath(BOOK_URL_XPATH).attribute('href').content)
+        books << Book.new("#{ARBookFinder::BASE_URL}/#{book_detail.xpath(BOOK_URL_XPATH).attribute('href').content}")
       end
       books
     end

data/lib/ar_book_finder/user_type_processor.rb

@@ -1,6 +1,8 @@
 module ARBookFinder
   class UserTypeProcessor
     include Capybara::DSL
+    
+    USER_TYPE_URL = "#{ARBookFinder::BASE_URL}/usertype.aspx"
 
     USER_TYPES = {
       student: 'Student',
@@ -14,7 +16,7 @@ module ARBookFinder
     end
 
     def process
-      visit('http://www.arbookfind.com/usertype.aspx')
+      visit(USER_TYPE_URL)
       choose(@user_type)
       click_button('Submit')
     end

data/lib/ar_book_finder/version.rb

@@ -1,3 +1,3 @@
 module ARBookFinder
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/ar_book_finder/collection_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Collection' do
+  it 'should return results for a single child hash' do
+    results = ARBookFinder.collection('Awards' => 'ALA Notable/Best Books')
+    results.books.size.should > 0
+  end
+  
+  it 'should return results for a multi child hash' do
+    results = ARBookFinder.collection('State Lists' => { 'Indiana' => 'IN Young Hoosier Middle Grades Book Award Nominees 2013-2014' })
+    results.books.size.should > 0
+  end
+  
+  it 'should return results for page 2' do
+    results = ARBookFinder.collection({ 'Awards' => 'ALA Notable/Best Books' }, 2)
+    results.current_page.should == 2
+  end
+  
+  it 'should fetch book data' do
+    results = ARBookFinder.collection('Awards' => 'ALA Notable/Best Books')
+    book = results.books[0]
+    book.fetch
+    book.title.should_not be ''
+  end
+end

data/spec/ar_book_finder/search_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Search' do
+  it 'should return results for a title search' do
+    results = ARBookFinder.search('harry potter')
+    results.books.size.should > 0
+  end
+  
+  it 'should return results for page 2' do
+    results = ARBookFinder.search('harry potter', 2)
+    results.current_page.should == 2
+  end
+  
+  it 'should fetch book data' do
+    results = ARBookFinder.search('harry potter')
+    book = results.books[0]
+    book.fetch
+    book.title.should_not be ''
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: ar_book_finder
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony Smith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -109,7 +109,9 @@ files:
 - lib/ar_book_finder/book.rb
 - lib/ar_book_finder/book_detail_parser.rb
 - lib/ar_book_finder/book_detail_processor.rb
+- lib/ar_book_finder/collection_processor.rb
 - lib/ar_book_finder/configuration.rb
+- lib/ar_book_finder/constants.rb
 - lib/ar_book_finder/pagination_processor.rb
 - lib/ar_book_finder/publisher.rb
 - lib/ar_book_finder/quick_search_processor.rb
@@ -118,8 +120,8 @@ files:
 - lib/ar_book_finder/user_type_processor.rb
 - lib/ar_book_finder/version.rb
 - spec/.keep
-- spec/ar_book_finder/book_spec.rb
-- spec/ar_book_finder_spec.rb
+- spec/ar_book_finder/collection_spec.rb
+- spec/ar_book_finder/search_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/anthonator/ar-book-finder
 licenses:
@@ -148,6 +150,6 @@ specification_version: 3
 summary: Crawls and parses data on arbookfind.com and returns book data in an easy to use format
 test_files:
 - spec/.keep
-- spec/ar_book_finder/book_spec.rb
-- spec/ar_book_finder_spec.rb
+- spec/ar_book_finder/collection_spec.rb
+- spec/ar_book_finder/search_spec.rb
 - spec/spec_helper.rb

data/spec/ar_book_finder/book_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe ARBookFinder::Book do
-  describe 'fetch' do
-    it 'should return book details' do
-      book = ARBookFinder.search('978-0590353403').books[0]
-      book.fetch.title.should == "Harry Potter and the Sorcerer's Stone"
-    end
-  end
-end

data/spec/ar_book_finder_spec.rb

@@ -1,15 +0,0 @@
-require 'spec_helper'
-
-describe ARBookFinder do
-  describe 'search' do
-    it 'should return results' do
-      results = ARBookFinder.search('978-0590353403').books
-      results.size.should > 0
-    end
-
-    it 'should paginate and sort results' do
-      results = ARBookFinder.search('harry potter', 2, :title).books
-      results.size.should > 0
-    end
-  end
-end