Ruby wrapper for the Berg Cloud API v2
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.ruby-gemset
.ruby-version
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
bergcloud.gemspec

README.md

alt text BERGCloud Gem Version Build Status Code Climate

A gem for interacting with BERG's Cloud API v2

Installation

Add this line to your application's Gemfile:

gem 'bergcloud'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bergcloud

Usage

Get started:

BERGCloud.api_token = 'your_api_token'

Project methods:

project = BERGCloud::Project.new('your_project_id')

# Check if a project is valid
project.valid? #=> true or false

# Claim a device
project.claim('your-claim-code')

# Check a claim status
project.claim_status('your-claim-code')

# Send a command
project.send_command(:device_id => 'your_device_id', :name => 'my-command', :payload => [1, 2, 3])

# List devices
project.devices

# List events
project.events

Event methods:

event = BERGCloud::Event.new('my-event-id')

# Get event information
event.info

Command methods:

command = BERGCloud::Command.new('my-command-id')

# Get command info
command.info

# Remove a command from the queue
command.delete

Changelog

1.0.3

  • Turns out I didn't fix the 422 error last time

1.0.2

  • Requests returning 422 shouldn't be classed as errors because they are not failures
  • Add a nicer error message for 401, telling you that you forgot to set BERGCloud.api_token

1.0.1

  • Fixes inability to send commands (changes POST encoding to JSON)

1.0.0

  • First Release

Contributing

  1. Fork it
  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