hilarity-api

Hilarity Ruby Client

The Hilarity Ruby Client is used to interact with the Hilarity API from Ruby.

Usage

Start by creating a connection to Hilarity with your credentials:

require 'hilarity-api'

hilarity = Hilarity::API.new(:api_key => API_KEY)                           # use API Key
hilarity = Hilarity::API.new(:username => USERNAME, :password => PASSWORD)  # use username and password
hilarity = Hilarity::API.new(:headers => {'User-Agent' => 'custom'})        # use custom header

NOTE: You can leave out the :api_key if ENV['HILARITY_API_KEY'] is set instead.

Now you can make requests to the api.

Requests

What follows is an overview of commands you can run for the client.

For additional details about any of the commands, see the API docs.

Add-ons

hilarity.delete_addon(APP, ADD_ON)    # remove the ADD_ON add-on from the app named APP
hilarity.post_addon(APP, ADD_ON)      # add ADD_ON add-on to an the app named APP
hilarity.put_addon(APP, ADD_ON)       # update the ADD_ON add-on on the app named APP
hilarity.get_addons                   # see a listing of all available add-ons
hilarity.get_addons(APP)              # see listing of installed add-ons for the app named APP

Apps

hilarity.delete_app(APP)                  # delete the app named APP
hilarity.get_apps                         # get a list of your apps
hilarity.get_app(APP)                     # get info about the app named APP
hilarity.get_dyno_types(APP)              # get dyno types for the app named APP    
hilarity.post_app                         # create an app with a generated name and the default stack
hilarity.post_app_maintenance(APP, '1')   # toggle maintenance mode for the app named APP
hilarity.post_app('name' => 'app')        # create an app with a specified name, APP
hilarity.put_app('name' => 'myapp')       # update an app to have a different name

Collaborators

hilarity.delete_collaborator(APP, '[e-mail]')   # remove '[e-mail]' collaborator from APP app
hilarity.get_collaborators(APP)                          # list collaborators for APP app
hilarity.post_collaborator(APP, '[e-mail]')     # add '[e-mail]' collaborator to APP app

Config Variables

hilarity.delete_config_var(APP, KEY)               # remove KEY key from APP app
hilarity.get_config_vars(APP)                      # get list of config vars for APP app
hilarity.put_config_vars(APP, KEY => 'value')      # set KEY key to 'value' for APP app

Domains

hilarity.delete_domain(APP, 'example.com')   # remove the 'example.com' domain from the APP app
hilarity.get_domains(APP)                    # list configured domains for the APP app
hilarity.post_domain(APP, 'example.com')     # add 'example.com' domain to the APP app

Keys

hilarity.delete_key('[e-mail]') # remove the '[e-mail]' key
hilarity.delete_keys                       # remove all keys
hilarity.get_keys                          # list configured keys
hilarity.post_key('key data')              # add key defined by 'key data'

Logs

hilarity.get_logs(APP) # return logs information for APP app

Processes

hilarity.get_ps(APP)                               # list current dynos for APP app
hilarity.post_ps(APP, 'command')                   # run 'command' command in context of APP app
hilarity.post_ps_restart(APP)                      # restart all dynos for APP app
hilarity.post_ps_scale(APP, TYPE, QTY)             # scale TYPE type dynos to QTY for APP app
hilarity.post_ps_stop(APP, 'ps' => 'web.1')        # stop 'web.1' dyno for APP app
hilarity.post_ps_stop(APP, 'type' => 'web')        # stop all 'web' dynos for APP app
hilarity.post_ps_restart(APP, 'ps' => 'web.1')     # restart 'web.1' dyno for APP app
hilarity.put_dynos(APP, DYNOS)                     # set number of dynos for bamboo app APP to DYNOS
hilarity.put_workers(APP, WORKERS)                 # set number of workers for bamboo app APP to WORKERS
hilarity.post_ps_scale(APP, 'worker', WORKERS)     # set number of workers for cedar app APP to WORKERS
hilarity.put_formation(APP, 'web' => '2X')         # set dyno size to '2X' for all 'web' dynos for APP app

Releases

hilarity.get_releases(APP)       # list of releases for the APP app
hilarity.get_release(APP, 'v#')  # get details of 'v#' release for APP app
hilarity.post_release(APP, 'v#') # rollback APP app to 'v#' release

Stacks

hilarity.get_stack(APP)          # list available stacks
hilarity.put_stack(APP, STACK) # migrate APP app to STACK stack

User

hilarity.get_user                  # list user info

Mock

For testing (or practice) you can also use a simulated Hilarity account:

require 'hilarity-api'

hilarity = Hilarity::API.new(:api_key => API_KEY, :mock => true)

Commands will now behave as normal, however, instead of interacting with your actual Hilarity account you'll be interacting with a blank test account. Note: test accounts will have NO apps to begin with. You'll need to create one:

hilarity.post_app(:name => 'my-test-app')

Tests

To run tests, first set ENV['HEROKU_API_KEY'] to your api key. Then use bundle exec rake to run mock tests or MOCK=false bundle exec rake to run integration tests.

Meta

Released under the MIT license.