clx_api

ClxApi

A wrapper for easier use of CLX networks API.

Installation

Add this line to your application's Gemfile:

gem 'clx_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install clx_api

Usage

See examples folder

For Developers

Set up environment

Clone or download and unzip to local folder Navigate to folder in console/terminal

$ cd [your_development_folder]/ruby_api

Install development dependencies

$ bundle install

Runing tests

Minitest is used for unit testing.

$ bundle exec rake test

Generate documentation

Yard generates documentation from comments in the code

$ bundle exec yard doc

Code coverage

SimpleCov checks test coverage automatically when tests are run

Contributing

1. Fork it ( https://github.com/CLXNetworks/ruby-api/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 a new Pull Request