Skip to content
This repository

A cross-website product information fetcher for ruby.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 config
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 test
Octocat-spinner-32 .document
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 VERSION
Octocat-spinner-32 fletcher.gemspec
README.md

Fletcher

Build Status

Fletcher is a cross-website product information fetcher. Just give fletcher a product's url and you'll get back a nice, uniform object that's easy to work with.

Features

  • No third-party API access required (good for websites that don't even have API access)
  • Uses nokogiri for data parsing

Supported Websites

Installation

gem install fletcher

Usage

API

require "fletcher"

product  = Fletcher.fetch "http://www.amazon.com/Avenir-Deluxe-Unicycle-20-Inch-Wheel/dp/B00165Q9F8"

product.name # => "Avenir Deluxe Unicycle (20-Inch Wheel)"

product.description # => "A wonderful unicycle"

product.images.count # => 1
product.image # => {:src => "http://ecx.images-amazon.com/images/I/41b3TNb3uCL._SL500_AA300_.jpg", :alt => "Picture of Unicycle"}
product.image.src # => "http://ecx.images-amazon.com/images/I/41b3TNb3uCL._SL500_AA300_.jpg"

product.price # => #<Money cents:500 currency:USD>
product.price.to_f # => 5.0
product.price.format # => "$5.00"  
product.price.currency.symbol # => "$"

# Get Raw Nokogiri Document
product.doc.class.name # => Nokogiri::HTML::Document

# Get list of supported websites/services
Fletcher.models # => [:amazon, :ebay, :etsy, :thinkgeek, ...]

CLI

Get Product Details (defaults to yaml output):

$ fletcher fetch "http://www.amazon.com/Avenir-Deluxe-Unicycle-20-Inch-Wheel/dp/B00165Q9F8"

---
name: Avenir Deluxe Unicycle (20-Inch Wheel)
description: 'Amazon.com: Avenir Deluxe Unicycle (20-Inch Wheel): Sports & Outdoors'
price: $99.99
image:
  src: http://ecx.images-amazon.com/images/I/41b3TNb3uCL._SL500_AA280_.jpg
url: http://www.amazon.com/Avenir-Deluxe-Unicycle-20-Inch-Wheel/dp/B00165Q9F8

Get a single attribute of a product:

$ fletcher fetch --only name "http://www.amazon.com/Avenir-Deluxe-Unicycle-20-Inch-Wheel/dp/B00165Q9F8"
Avenir Deluxe Unicycle (20-Inch Wheel)

Get list of supported websites:

$ fletcher websites
Amazon
ThinkGeek
...

Run in debug mode:

fletcher fetch --debug "http://www.amazon.com/gp/product/B004HZYA6E/"

Attributes

The following attributes/method are available for a product:

  • name - (String) The name of the product
  • description - (String) The product's description
  • price - (Money) A Money object representing the product's price. This makes converting exchange rates and math functionality easy to use.
  • image - (Hash) The main image of the product, if available. This is a hash containing standard HTML attributes: src, alt, width, height, etc.
  • images - (Array) An array of product images.
  • doc - The raw Nokogiri::HTML::Document object for the product. You can use this to pull other stuff from the product's page.

Contributing

If you make any changes to fletcher, be sure to run the test suite before creating any pull requests.

bundle install
bundle exec rspec spec/
  • Troubleshooting

    • fletcher uses vcr to save http requests for faster testing. To pull real-time http data, clear the vcr cache with rm -rf spec/vcr. Please clear this cache before making a pull request.
Something went wrong with that request. Please try again.