No description, website, or topics provided.
Ruby
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
ar_book_finder.gemspec

README.md

ARBookFinder

Retrieve book data from arbookfind.com

Gem Version Build Status Dependency Status Coverage Status Code Climate

Installation

Add this line to your application's Gemfile:

gem 'ar_book_finder'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ar_book_finder

PhantomJS

This gem utilizes PhantomJS for interacting with arbookfind.com. Make sure to install PhantomJS in order to use this gem.

Configuration

Choose what type of user to peform searches as.

Available types include:

  • :student
  • :parent
  • :teacher
  • :librarian

These types match up to the available user types here.

ARBookFinder.configure do |config|
  config.user_type = :teacher
end

What data is returned?

The ARBookFinder gem is capable or returning any data located on a book's detail page.

This includes:

  • cover
  • title
  • author
  • summary
  • ar_quiz_number
  • language
  • ar_quiz_availability
  • atos_book_level
  • interest_level
  • ar_points
  • rating
  • word_count
  • type
  • topics
  • series
  • url

And publisher details:

  • name
  • lccn
  • isbn
  • year_published
  • page_count

Usage

Quick Search

Quick search will allow you to perform searches based on title, topics, author or ISBN.

Perform a quick search...

results = ARBookFinder.search('harry potter')
results.page_count # Retrieve the number of pages this search returns
results.books # Retrieve the books returned on this page

Load book data on demand using #fetch...

...
book = results.book[0]
book.fetch # Retrieve book data
book.title
book.author
...

Return publisher data...

...
publisher = book.publishers[0]
publisher.name
publisher.isbn
...

Collections

Collections will retrieve books lists. Examples include awards, state lists, etc.

Retrieve a collection...

results = ARBookFinder.collection({ 'Awards' => 'ALA Notable/Best Books' })

Retrieve a collection with a multi-level hash...

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.

# Retrieve results for page 2
results = ARBookFinder.search('harry potter', 2)
results.current_page # should == 2

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Credits

Sticksnleaves

ARBookFinder is maintained and funded by Sticksnleaves

Thanks to all of our contributors