DiffbotSimple

A simple, nothing-fancy, helper for the Diffbot API.

Will not objectify any responses, just pass on the json data as hash with symbolized keys. One exception to that rule, when using CrawlBot and requesting a single_crawl, it will return the single item in the :jobs-array, and when requesting all, it will return the array in :jobs. Send options to the api as named args, se usage below with article and fields-argument.

Installation

gem 'diffbot-simple'

Dependencies

• Ruby 2.0 or 2.1
• rest-core
• multi_json

Usage

require 'diffbot_simple'

token = "my_diffbot_assigned_token"
client = DiffbotSimple::V2::Client.new token: token

article = client.article
url = "http://www.xconomy.com/san-francisco/2012/07/25/diffbot-is-using-computer-vision-to-reinvent-the-semantic-web/"
# Pass on diffbot parameters as options to the call
diffbot_response_as_symbolized_hash = article.single_article url: url, fields: "icon,title"
# =>
{
  icon: "http://www.xconomy.com/wordpress/wp-content/themes/xconomy/images/favicon.ico",
  author: "Wade Roush",
  date: "7/25/12",
  text: "...",
# and more, see http://www.diffbot.com/products/automatic/article/
}

Supports these Diffbot apis

Please see Diffbot Help and Documentation for details and arguments. Check the spec-directory too.

require 'diffbot_simple'

token = "my_diffbot_assigned_token"
client = DiffbotSimple::V2::Client.new token: token
url = "http://some_url_to_check"

# Custom API
custom = client.custom name: "my_custom_api_name" 
response = custom.single_custom url: url 

# Analyze API (beta)
analysis = client.analyze 
response = analyze.single_analysis url: url

# Article API
article = client.article
response = article.single_article url: url

# Image API
image = client.image
response = image.single_image url: url

# Product API
product = client.product
response = product.single_product url: url

# Crawlbot API
crawlbot = client.crawlbot
all_my_crawls = crawlbot.all
current_settings = crawlbot.single_crawl name: "my_crawl"
# shorthand for using apiUrl, use the api object from client, 
# it will create a correct value for you 
# (custom, image, article, product or analyze for automatic)
# A call to single_crawl will create if not exists or update settings
settings = crawlbot.single_crawl name: "my_new_crawl", onlyProcessIfNew: 0, seeds: "http://www.upptec.se", apiUrl: custom
crawlbot.pause name: "my_new_crawl"
crawlbot.unpause name: "my_new_crawl"
crawlbot.restart name: "my_new_crawl"
result = crawlbot.result "my_new_crawl" # shorthand for downloading the json that are specifed in :downloadJson
crawlbot.delete name: "my_new_crawl" 

On error

If Diffbot returns an error, it will raise and fill DiffbotSimple::V2::DiffbotError with passed on info, as stated in http://www.diffbot.com/dev/docs/error/ and put errorCode in :error_code and error in :message .

TODO

• Frontpage API
• Bulk API
• Async http fetching
• Batch API

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