Clever::Ruby

Ruby bindings to the Clever API. Documentation

Installation

Add this line to your application's Gemfile:

gem 'clever-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install clever-ruby

Usage

Configure clever-ruby to use your Clever token:

Clever.configure do |config|
  config.token = 'YOUR-API-TOKEN'
end

See the documentation for further details.

Run tests

To run all tests:

$ rake test

To run all tests and the linter (rubocop):

$ rake

The linter follows the Ruby Style Guide with a few exceptions. To just run the linter:

$ rake lint

Running specific tests is not currently supported.

Documentation

To generate it to ./doc:

$ rake doc

To see documentation coverage:

$ rake doc-coverage

and then view doc_coverage.txt.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git add -p ./path/to/files; git commit -m 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request