geckoboard-ruby

Ruby client library for Geckoboard (https://developer.geckoboard.com/api-reference/ruby).

Installation

Add this line to your application's Gemfile:

gem 'geckoboard-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install geckoboard-ruby

Usage

Ping to authenticate

Verify that your API key is valid and that you can reach the Geckoboard API.

client = Geckoboard.client('222efc82e7933138077b1c2554439e15')
client.ping # => true

Find or create

Verify an existing dataset or create a new one.

dataset = client.datasets.find_or_create('sales.gross', fields: [
  Geckoboard::MoneyField.new(:amount, name: 'Amount', currency: 'USD'),
  Geckoboard::DateTimeField.new(:timestamp, name: 'Time'),
])

Available field types:

DateField
DateTimeField
NumberField
PercentageField
StringField
MoneyField

Delete

Delete a dataset and all data therein.

dataset.delete # => true

Delete a dataset with a given id.

client.datasets.delete('sales.gross') # => true

Put

Replace all data in the dataset.

dataset.put([
  {
    timestamp: DateTime.new(2016, 1, 2, 12, 0, 0),
    amount: 40900
  },
  {
    timestamp: DateTime.new(2016, 1, 3, 12, 0, 0),
    amount: 16400
  },
])

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Fork it ( https://github.com/geckoboard/geckoboard-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