https://github.com/tevren/biffbot

ruby api for diffbot's APIs
https://github.com/tevren/biffbot

Last synced: 3 months ago
JSON representation

ruby api for diffbot's APIs

• Host: GitHub
• URL: https://github.com/tevren/biffbot
• Owner: tevren
• License: mit
• Created: 2012-10-12T15:31:44.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2022-03-11T17:56:58.000Z (over 2 years ago)
• Last Synced: 2024-05-12T02:03:19.188Z (6 months ago)
• Language: Ruby
• Homepage: https://github.com/tevren/biffbot
• Size: 40 KB
• Stars: 11
• Watchers: 1
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Biffbot 

[![Build Status](https://travis-ci.org/tevren/biffbot.svg?branch=master)](https://travis-ci.org/tevren/biffbot) [![Gem Version](https://badge.fury.io/rb/biffbot.svg)](http://badge.fury.io/rb/biffbot) [![Code Climate](https://codeclimate.com/github/tevren/biffbot/badges/gpa.svg)](https://codeclimate.com/github/tevren/biffbot) [![Test Coverage](https://codeclimate.com/github/tevren/biffbot/badges/coverage.svg)](https://codeclimate.com/github/tevren/biffbot) [![Inline docs](http://inch-ci.org/github/tevren/biffbot.svg?branch=master&style=flat)](http://inch-ci.org/github/tevren/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