Scalarium API wrapper

About

Since Scalarium is currently (June 2011) not supporting roles and therefore it is troublesome/risky to give all the development team members full access to the clouds/applications this library will allow easy setup of local environments for anyone minimizing the risk of 'stoping' the production environment. For example limiting only to one cloud or application (development environment).

All the documentation for Scalarium API - (http://support.scalarium.com/kb/api)

It can:

  • Obtain a list of all clouds
  • Obtain a list of all applications
  • Perform deploy of specified application, stop/start/restart clouds

Install

Clone this repository 

$ git clone <a href="http://github.com/luki3k5/scalarium-api-wrapper">http://github.com/luki3k5/scalarium-api-wrapper</a>
or install the gem 
$ gem install scalarium-api-wrapper

Setup

You need to pass your api token to the Scalarium.configuration: 

Scalarium.configuration.api_token = "YOUR TOKEN"

You can obtain your token at (https://manage.scalarium.com/users) - I highly encourage to setup new user with (i.e. devdeploy) and then render him new API_TOKEN.

Usage

After the api token is set you can create API class instance: 

api = Scalarium::API.new

and then for example execute a deploy for one of your applications: 

api.deploy_application('application_id')

to obtain list of all possible applications execute:

api.get_applications

notice that this will return array of all applications currently available for this user account. To get ID one could execute: 

api.get_applications.each do |app|
  puts "app name: #{app['name']}  -- app id: #{app['id']} "
end

Here are the fields returned in each hash:


 "id", 
 "name", 
 "ssl_certificate", 
 "scm_url", 
 "application_type", 
 "rails_env", 
 "deleted_at", 
 "ssl_certificate_key", 
 "scm_revision", 
 "ssl_support", 
 "scm_ssh_key", 
 "scm_user", 
 "domain_names", 
 "document_root", 
 "created_at", 
 "scm_password", 
 "auto_bundle_on_deploy", 
 "updated_at", 
 "mounted_at", 
 "description", 
 "domain_name", 
 "ssl_certificate_ca", 
 "cluster_id", 
 "scm_type", 
 "slug_name"

for their meaning check Scalarium's documentation and examples

License

Copyright (c) 2010 Lukasz Lazewski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Credits

luki3k5 (Lukasz Lazewski)