README.md

Biffbot

Ruby gem to connect to diffbot's APIs

Installation

Add this line to your application's Gemfile:

gem 'biffbot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install biffbot

Usage

Usage example:

require 'biffbot'
Biffbot.token = YOUR_DEVELOPER_TOKEN
analyze = Biffbot::Analyze.new(url, {:type => 'article'})
article = Biffbot::Article.new(url,some_hash_of_options)

Available classes:

• Biffbot::Analyze

• Biffbot::Article

• Biffbot::Image

• Biffbot::Product

• Untested Classes (I don't have a paid account)

  • Biffbot::Bulk
  • Biffbot::Custom

To do

• Add support for Diffbot Crawlbot API
• Add support for Diffbot Search API
• Add support for Diffbot beta APIs (video/discussion)

Testing

1. Create a .env file in the following format:

    DIFFBOT_DEV_TOKEN=YOUR_DIFFBOT_TOKEN
   

2. Run the tests via rake

    rake test
   

3. Style matters, check your rubocop output.

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