Invisible Collector API Ruby client
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install invisible_collector
If necessary include it in you ruby code:
You'll need to retrieve an access token from Invisible Collector's dashboard.
With your access token you can instantiate a new client with it:
client = InvisibleCollector::API.new(api_token: 'YOUR_TOKEN')
client = InvisibleCollector::API.new(api_token: 'YOUR_TOKEN') client.company #=> InvisibleCollector::CompanyResource
client = InvisibleCollector::API.new(api_token: 'YOUR_TOKEN') client.customer #=> InvisibleCollector::CustomerResource
client = InvisibleCollector::API.new(api_token: 'YOUR_TOKEN') client.debt #=> InvisibleCollector::DebtResource
client = InvisibleCollector::API.new(api_token: 'YOUR_TOKEN') client.alarm #=> InvisibleCollector::AlarmResource
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/invisiblecloud/invisible-collector-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
- Fork it ( https://github.com/invisiblecloud/invisible-collector-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
The gem is available as open source under the terms of the MIT License.