README.md
# Diffbot.rb [![Build Status](https://travis-ci.org/orendon/diffbot.rb.png?branch=master)](https://travis-ci.org/orendon/diffbot.rb) [![Code Climate](https://codeclimate.com/github/orendon/diffbot.rb.png)](https://codeclimate.com/github/orendon/diffbot.rb)
Ruby wraper for the [diffbot.com](http://diffbot.com/) API, follows Ruby conventions and idioms.
Check out the code documentation [here](http://rubydoc.info/github/orendon/diffbot.rb/frames).
## Installation
Add this line to your application's Gemfile:
gem 'diffbot_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install diffbot_api
## Usage
You can provide your authentication token globally
```ruby
Diffbot.configure do |c|
c.token = ENV['DIFFBOT_TOKEN']
end
```
The API is modular, you can access access all resources through the client instance
```ruby
client = Diffbot::Client.new
client.article "www.somedomain.com/example-url"
```
or just the module-level resources that you actually need
```ruby
article = Diffbot::Article.new("www.mrt.com/the-a-team")
article.title # => "The A-Team"
article.author # => "Mr. T"
```
## Status
This is very early stage, here are the endpoints implemented so far:
* Article (in progress)
* FrontPage (pending)
* Product (pending)
* Image (pending)
* Classifier (pending)
## Contributing
1. Fork it ( http://github.com/orendon/diffbot.rb/fork )
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
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/orendon/diffbot.rb/trend.png)](https://bitdeli.com/free "Bitdeli Badge")