scalarium-api-wrapper 0.2.9

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scalarium-api-wrapper.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,135 @@
+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](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 
+ <pre><code>$ git clone http://github.com/luki3k5/scalarium-api-wrapper</code></pre>
+  or install the gem
+ <pre><code>$ gem install scalarium-api-wrapper</code></pre>
+
+
+
+
+Setup
+--
+  You need to pass your api token to the Scalarium.configuration: 
+   <pre>
+<code>Scalarium.configuration.api_token = "YOUR TOKEN"</code></pre>
+
+You can obtain your token at ([https://manage.scalarium.com/users](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: 
+
+
+<pre>
+<code>api = Scalarium::API.new</code>
+</pre>
+
+and then for example execute a deploy for one of your applications: 
+
+<pre>
+<code>api.deploy_application('application_id')</code>
+</pre>
+
+to obtain list of all possible applications execute:
+<pre>
+<code>api.get_applications</code>
+</pre> 
+
+notice that this will return array of all applications currently available for this user account.
+To get ID one could execute: 
+
+<pre>
+<code>api.get_applications.each do |app|
+  puts "app name: #{app['name']}  -- app id: #{app['id']} "
+end</code>
+</pre> 
+
+Here are the fields returned in each hash:
+<pre>
+<code>
+ "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"</code>
+</pre>
+
+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) 
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/scalarium-api-wrapper.rb

@@ -0,0 +1,24 @@
+module Scalarium
+  
+  def self.clouds_url
+    Scalarium.configuration.clouds_url
+  end
+
+  def self.applications_url
+    Scalarium.configuration.applications_url
+  end
+  
+  def self.headers
+    return {'X-Scalarium-Token' => "#{Scalarium.configuration.api_token}", 'Accept' => 'application/vnd.scalarium-v1+json' }
+  end
+  
+  # @return [Configuration] The configuration singleton.
+  def self.configuration
+    @configuration ||= Scalarium::Configuration.new
+  end
+end
+
+
+require "scalarium-api-wrapper/version"
+require "scalarium-api-wrapper/configuration"
+require "scalarium-api-wrapper/api"

data/lib/scalarium-api-wrapper/api.rb

@@ -0,0 +1,65 @@
+require 'rest-client'
+require 'json'
+
+module Scalarium
+  
+  class API
+    
+    # Method fetches all clouds on the server    
+    #
+    # @option headers [Hash]       -    hash for of headers details for authentication
+    # @returns array [Array]       -    array containing all the clouds 
+    #
+    def get_clouds
+      http_get_request(Scalarium.clouds_url)      
+    end
+    
+    # Method fetches all applications on the server
+    # 
+    # @option headers [Hash]      -     hash for of headers details for authentication
+    # @returns array  [Array]     -     array containing all the applications 
+    #
+    def get_applications
+      http_get_request(Scalarium.applications_url)
+    end
+    
+    # Method allows to deploy application in scalarium
+    #
+    # @option app_id    [String]  -     The ID of application we want to deploy.
+    #
+    # @option options   [Hash]    -     Hash with options:
+    #   :comment                  -     comment to be displayed on the deployment
+    #   :migrate                  -     boolean indicating if we should run the migrations too (false by default)
+    #
+    # @returns [Hash] response of the progress and details
+    # 
+    def deploy_application(app_id, options = {:comment => nil, :migrate => false})
+      json_command = JSON.dump(:command => 'deploy', 
+                               :comment => options[:comment], 
+                               :migrate => options[:migrate])
+      http_post_request(Scalarium.applications_url+"/#{app_id}/deploy", json_command)                         
+    end
+    
+    
+    private
+    def get_headers
+      # quick validation if the header is set
+      if Scalarium.headers['X-Scalarium-Token'].nil? || Scalarium.headers['X-Scalarium-Token'] == "" 
+        raise AttributeException "X-Scalarium-Token is not set"
+      end
+      Scalarium.headers     
+    end
+    
+    # Method uses RestClient to make a HTTP POST request to Scalarium API    
+    def http_post_request(url, json_command)
+      JSON.parse(RestClient.post(url, json_command, get_headers))
+    end
+
+    # Method uses RestClient to make a HTTP GET request to Scalarium API    
+    def http_get_request(url)
+      JSON.parse(RestClient.get(url, get_headers))
+    end
+    
+    
+  end
+end

data/lib/scalarium-api-wrapper/configuration.rb

@@ -0,0 +1,8 @@
+class Scalarium::Configuration
+  attr_accessor :api_token, :clouds_url, :applications_url
+
+  def initialize
+    @clouds_url = "https://manage.scalarium.com/api/clouds"
+    @applications_url = "https://manage.scalarium.com/api/applications"
+  end
+end

data/lib/scalarium-api-wrapper/version.rb

@@ -0,0 +1,7 @@
+module Scalarium
+  module Api
+    module Wrapper
+      VERSION = "0.2.9"
+    end
+  end
+end

data/scalarium-api-wrapper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scalarium-api-wrapper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scalarium-api-wrapper"
+  s.version     = Scalarium::Api::Wrapper::VERSION
+  s.authors     = ["luki3k5"]
+  s.email       = ["luki3k5@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{This is scalarium API wrapper}
+  s.description = %q{This is scalarium API wrapper, allowing to execute API calls to scalarium backend}
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 2.0')
+
+  s.rubyforge_project = "scalarium-api-wrapper"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/api_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe "Scalarium::API", "when first created" do
+
+  before(:all) do
+    Scalarium.configuration.api_token = "FAKE_TOKEN"
+    @api = Scalarium::API.new
+    @clouds_url = "https://manage.scalarium.com/api/clouds"
+    @applications_url = "https://manage.scalarium.com/api/applications"
+  end
+  
+  # notice that get_headers is private method so we test it thru send
+  it "should have api token in headers set" do
+    @api.send(:get_headers)['X-Scalarium-Token'].should == "FAKE_TOKEN"
+  end
+
+  # notice that get_headers is private method so we test it thru send  
+  it "should have Accept piece of header set automatically " do 
+    @api.send(:get_headers)['Accept'].should == "application/vnd.scalarium-v1+json"    
+  end
+  
+  it "Scalarium Module should return correct applications url" do
+    Scalarium.applications_url.should == @applications_url
+  end
+
+  it "Scalarium Module should return correct clouds url" do
+    Scalarium.clouds_url.should == @clouds_url
+  end
+  
+  it "should be able to deploy application" do
+    @api.should respond_to(:deploy_application)
+  end
+
+  it "should be able to get all the clouds" do
+    @api.should respond_to(:get_clouds)
+  end
+
+  it "should be able to get all the applications" do
+    @api.should respond_to(:get_applications)
+  end
+  
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "Scalarium.configuration", "when first created" do
+
+  it "should has no api token set yet" do
+    Scalarium.configuration.api_token.should == nil
+  end
+
+  it "we should be able to set api token and check it's presence" do
+    Scalarium.configuration.api_token = "FAKE_TOKEN"
+    Scalarium.configuration.api_token.should == "FAKE_TOKEN"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'rspec'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+
+require 'scalarium-api-wrapper'
+
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: scalarium-api-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.2.9
+  prerelease: 
+platform: ruby
+authors:
+- luki3k5
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-20 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164547980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164547980
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164547360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164547360
+description: This is scalarium API wrapper, allowing to execute API calls to scalarium
+  backend
+email:
+- luki3k5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/scalarium-api-wrapper.rb
+- lib/scalarium-api-wrapper/api.rb
+- lib/scalarium-api-wrapper/configuration.rb
+- lib/scalarium-api-wrapper/version.rb
+- scalarium-api-wrapper.gemspec
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: scalarium-api-wrapper
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: This is scalarium API wrapper
+test_files:
+- spec/api_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb