scalarium-api-wrapper 0.3.0 → 0.4.2

data/README.markdown

@@ -3,16 +3,24 @@ 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). 
- 
+This library simplifies and automates the interaction with Scalarium's API. It makes all the common operations for obtaining 
+Clouds with their instances and roles a breeze. <br />
+It is very easy to integrate this library with 
+your application to control your instances (restart, stop, start) and applications (deploy/redeploy) from the command line 
+
+<!--
+Since Scalarium is currently (June 2011) not supporting members' 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 
+* Obtain a list of all clouds with their instances & roles 
+* Obtain a list of all applications plus their deployements
+* Perform deploy of specified application, with custom comment and enabled migrations command
+* Interact with the clouds stop/start/restart clouds (Still under development)
 
 
 
@@ -119,6 +127,22 @@ Here is a simple [RAKE task](https://gist.github.com/1037410) that illustrates h
 
 
 
+Contributing
+--
+
+* Fork this project
+
+* Check with TODO.txt what could be worked on 
+
+* Push your contribution to a branch named after your change
+  ie: git push origin master:added-feature-name
+
+* Try to write tests first, so we know it works beforehand  
+
+* Send me a pull request through GitHub with a description of
+  what you are contributing.
+
+
 
 License
 --

data/Rakefile

@@ -1 +1,20 @@
+namespace :test do
+
+  desc "run spec/unit tests"
+  task :spec do
+    print %x[rspec -c -f s spec/*_spec.rb]
+  end
+  
+  desc "run functional tests"
+  task :functional do
+    print %x[rspec -c -f s spec/functional/*_spec.rb]
+  end
+  
+  desc "run all the tests"
+  task :all => [:spec, :functional] do
+  end
+  
+end
+
 require 'bundler/gem_tasks'
+

data/TODO.txt

@@ -0,0 +1,7 @@
+1 - Call to obtain all the deployments for application [currently talking to Scalarium's support about this - 28th of June]
+2 - Getting Clouds' roles, instances of particular cloud and instance of role [DONE] (http://support.scalarium.com/kb/api/listing-clouds-roles-and-instances)
+3 - Creating, starting, stopping and rebooting instances
+4 - Listing and deploying applications [DONE]
+5a - abstract HTTP REST Client calls into separate class [DONE]
+5b - Move cloud specific stuff to API::Clouds and applications to API::Applications
+6  - add the rake task to run the tests from the APP_ROOT

data/lib/scalarium-api-wrapper.rb

@@ -28,4 +28,5 @@ end
 
 require "scalarium-api-wrapper/version"
 require "scalarium-api-wrapper/configuration"
+require "scalarium-api-wrapper/abstract_api"
 require "scalarium-api-wrapper/api"

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

@@ -0,0 +1,28 @@
+require 'rest-client'
+require 'json'
+
+module Scalarium
+  
+  class AbstractAPI
+    
+    private
+    def get_headers
+      # quick validation if the header is set
+      if Scalarium.headers['X-Scalarium-Token'].nil? || Scalarium.headers['X-Scalarium-Token'] == "" 
+        raise ArgumentError "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/api.rb

@@ -1,21 +1,72 @@
-require 'rest-client'
-require 'json'
-
 module Scalarium
   
-  class API
-    
+  class API < AbstractAPI
     # Method fetches all clouds on the server    
     #
-    # @returns array [Array]       -    array containing all the clouds 
+    # @option [String]       - cloud id of the cloud we want to see or nothing then we get the list of all clouds
+    #
+    # @return [Array]        - array containing all the clouds 
+    # or when param is passed it gets the particular cloud and 
+    # @return [Hash]         - @see API#get_cloud
     #
-    def get_clouds
+    def get_clouds(cloud_id=nil)
+      return get_cloud(cloud_id) unless cloud_id.nil?
       http_get_request(Scalarium.clouds_url)      
     end
     
+    # Method gets single could details 
+    #
+    # @param   [String]   cloud_id  - id of the cloud we want to see 
+    # @return  [Hash]               - hash containing details for particular cloud
+    # 
+    def get_cloud(cloud_id)
+      http_get_request(Scalarium.clouds_url+"/#{cloud_id}")      
+    end
+    
+    # Method obtains roles per cloud
+    #
+    # @param  [String]   cloud_id  - id of the cloud of which roles we want to see 
+    # @return [Array]              - list of the roles 
+    #
+    def get_cloud_roles(cloud_id)
+      http_get_request(Scalarium.clouds_url+"/#{cloud_id}/roles")      
+    end
+    
+    # Method obtains instances of the cloud
+    #
+    # @param  [String]   cloud_id  - id of the cloud of which instances we want to see 
+    # @return [Array]              - list of the instances
+    #
+    def get_cloud_instances(cloud_id)
+      http_get_request(Scalarium.clouds_url+"/#{cloud_id}/instances")      
+    end
+    
+    # Method obtains details of specified instance for a given cloud
+    #
+    # @param [String] cloud_id     - id of the cloud instance detail we want to obtain
+    # @param [String] instance_id  - id of the instance for specified cloud we want to see
+    # @return [Hash]               - hash with details about the passed instance of the cloud
+    #
+    def get_instance_of_cloud(cloud_id, instance_of_cloud_id)
+      http_get_request(Scalarium.clouds_url+"/#{cloud_id}/instances/#{instance_of_cloud_id}")      
+    end
+    
+    # Method allows to send command to the instance of specified cloud
+    #
+    # @param [String] cloud_id
+    # @param [String] instance_id
+    # @param [Symbol] command - it can be one of :start, :stop, :reboot
+    #
+    def send_instance_command(cloud_id, instance_id, command)
+      commands = [:start, :reboot, :stop]
+      raise ArgumentError, "You have passed wrong command allowed ones are: #{commands}" if !commands.include?(command) 
+
+      http_post_request(Scalarium.clouds_url+"/#{cloud_id}/instances/#{instance_id}/#{command.to_s}")  
+    end
+        
     # Method fetches all applications on the server
     # 
-    # @returns array  [Array]     -     array containing all the applications 
+    # @return  [Array]              -     array containing all the applications 
     #
     def get_applications
       http_get_request(Scalarium.applications_url)
@@ -24,21 +75,32 @@ module Scalarium
     # Method pings scalarium to check the details of the deploy (i.e. progress)
     # @see http://support.scalarium.com/kb/api/fetching-deployment-details
     # 
-    # @returns hash [Hash]      -       Hash contains all the deployment details 
+    # @param  [String] app_id        -       String app_id of application we want to see
+    # @param  [String] deployment_id -       String id of the deployment we want to see
+    # @return [Hash]                 -       Hash contains all the deployment details 
     # 
     def fetch_deployment_details(app_id, deployment_id)
       http_get_request(Scalarium.applications_url+"/#{app_id}/deployments/#{deployment_id}")
     end
     
+    # @see http://support.scalarium.com/discussions/questions/83-is-it-possible-to-obtain-all-the-deployments-for-the-specified-application
+    # Method allows to fetch all the deployments for the specified application
+    # 
+    # @param  [String] app_id         -       String app_id of application that deployments we want to see  
+    # @return [Array]                 -       Delivers array of all the deployments for the application
+    def fetch_all_deployments(app_id)
+      warn "[WARRNING!] This functionality might not be yet supported by Scalarium!"
+      http_get_request(Scalarium.applications_url+"/#{app_id}/deployments/#{deployment_id}")
+    end
+    
     # Method allows to deploy application in scalarium
+    #                                            
+    # @param  [String]  app_id               -   The ID of application we want to deploy.
+    #                                            
+    # @option options [String]   :comment    -   comment to be displayed on the deployment
+    # @option options [Boolean]  :migrate    -   boolean indicating if we should run the migrations too (false by default)
     #
-    # @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
+    # @return [Hash] response of the progress and details
     # 
     def deploy_application(app_id, options = {:comment => nil, :migrate => false})
       json_command = JSON.dump(:command => 'deploy', 
@@ -46,27 +108,14 @@ module Scalarium
                                :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 ArgumentError "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
+
+# ALIASES:
+#
+# adding some better naming for the fetch_deployment_details -> get_deployment_details 
+# it is just an alias for existing method (so it stays backward compatible)
+Scalarium::API.class_eval do
+  alias :get_deployment_details :fetch_deployment_details   
+  alias :get_all_deployments :fetch_all_deployments
 end

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

@@ -1,7 +1,7 @@
 module Scalarium
   module Api
     module Wrapper
-      VERSION = "0.3.0"
+      VERSION = "0.4.2"
     end
   end
 end

data/spec/api_spec.rb

@@ -27,13 +27,33 @@ describe "Scalarium::API", "when first created" 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 single cloud" do
+    @api.should respond_to(:get_cloud)
+  end
+  
+  it "should be able to get list cloud's roles" do
+    @api.should respond_to(:get_cloud_roles)
+  end
+
+  it "should be able to get list cloud's instances" do
+    @api.should respond_to(:get_cloud_instances)
+  end
+
+  it "should be able to get cloud's instances of a specific role" do
+    
+  end
+
+  it "should be able to get cloud's single instance" do
+    @api.should respond_to(:get_instance_of_cloud)
+  end
+
+  it "should be able to deploy application" do
+    @api.should respond_to(:deploy_application)
+  end
 
   it "should be able to get all the applications" do
     @api.should respond_to(:get_applications)
@@ -42,6 +62,19 @@ describe "Scalarium::API", "when first created" do
   it "should be able to get deployment status aka deployment details" do
     @api.should respond_to(:fetch_deployment_details)
   end
+  
+  it "should be able to get deployment status aka deployment details with alias :get_deployment_details" do
+    @api.should respond_to(:get_deployment_details)
+  end
+
+  it "should be able to get all deployments details" do
+    @api.should respond_to(:fetch_all_deployments)
+  end
+  
+  it "should be able to get all deployments details with alias :get_all_deployments" do
+    @api.should respond_to(:get_all_deployments)
+  end
+
 
   
 end

data/spec/configuration_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 describe "Scalarium.configuration", "when first created" do
 
+  before(:all) do
+    Scalarium.configuration.api_token = nil
+  end
+
   it "should has no api token set yet" do
     Scalarium.configuration.api_token.should == nil
   end

data/spec/functional/{api_functional_spec.rb → api_application_functional_spec.rb}

@@ -6,7 +6,7 @@ describe "Scalarium functional tests", "when first created" do
 
   before(:all) do
     # we load configuration 
-    config = YAML::load(File.open("./scalarium.yml"))
+    config = YAML::load(File.open(File.dirname(__FILE__)+"/scalarium.yml"))
     raise "!!! scalarium.yml file is missing - have your renamed scalarium.yml.sample into scalarium.yml? !!!" if config.nil?
     
     Scalarium.configuration.api_token = config["api_token"]
@@ -14,22 +14,11 @@ describe "Scalarium functional tests", "when first created" do
     @comment = "This is test deploy by functional testing from scalarium-api-wrapper gem"
     
     @api = Scalarium::API.new
-    
-    # @response_status - this is initial response status 
-    # returned after we make initial call to deploy application
-    @response_status = nil
-    # @status_check_response - this is status response for when we check 
-    # progress of our deployment 
-    @status_check_response = nil
   end
   
   it "should obtain list of applications and present an array" do
     @api.get_applications.class.should == Array
   end
-
-  it "should obtain list of clouds and present an array" do
-    @api.get_clouds.class.should == Array
-  end
   
   it "should redeploy application with specified ID and comment: #{@comment} returning status should be in proper state" do
     @response_status = @api.deploy_application(@application_id, :comment => @comment)
@@ -37,7 +26,7 @@ describe "Scalarium functional tests", "when first created" do
     @response_status["status"].should == "running"
     @response_status["command"].should == "deploy" 
     @response_status["application_id"].should == @application_id
-
+  
     sleep 2
     id_of_deployment = @response_status["id"]
     @status_check_response = @api.fetch_deployment_details(@application_id, id_of_deployment)

data/spec/functional/api_cloud_functional_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'yaml'
+
+
+describe "Scalarium api", "obtaining clouds and then single cloud details" do
+  
+  before(:all) do
+    # we load configuration 
+    config = YAML::load(File.open(File.dirname(__FILE__)+"/scalarium.yml"))
+    raise "!!! scalarium.yml file is missing - have your renamed scalarium.yml.sample into scalarium.yml? !!!" if config.nil?
+
+    @cloud_keys = %w( id name region nickname_theme custom_agent_version default_os deleted_at created_at updated_at custom_json use_custom_cookbooks scm_user scm_password scm_type scm_url scm_ssh_key scm_revision account_id user_id ssh_key_id credential_id )    
+    
+    Scalarium.configuration.api_token = config["api_token"]    
+    @api = Scalarium::API.new
+  end
+  
+  it "should obtain list of clouds and present an array" do
+    @api.get_clouds.class.should == Array
+  end
+  
+  it "be able to obtain list of clouds and then get the details of first cloud from the list" do
+    # we should get at least one cloud 
+    @api.get_clouds.first['id'].nil?.should == false 
+    single_cloud = @api.get_cloud(@api.get_clouds.first['id'])
+
+    # checking if we received planed Hash structure
+    single_cloud.keys.each do |key|  
+      @cloud_keys.include?(key).should == true
+    end
+  end
+  
+  it "should get cloud's instances" do
+    @api.get_clouds.first['id'].nil?.should == false 
+    single_cloud = @api.get_cloud(@api.get_clouds.first['id'])
+    
+    # we should get array of instances back
+    @api.get_cloud_instances(single_cloud["id"]).class.should == Array
+  end
+
+  it "should get cloud's roles" do
+    @api.get_clouds.first['id'].nil?.should == false 
+    single_cloud = @api.get_cloud(@api.get_clouds.first['id'])
+    
+    # we should get array of roles back
+    @api.get_cloud_roles(single_cloud["id"]).class.should == Array
+  end
+  
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalarium-api-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-24 00:00:00.000000000 +02:00
+date: 2011-07-06 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2153054260 !ruby/object:Gem::Requirement
+  requirement: &2153560380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153054260
+  version_requirements: *2153560380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153053800 !ruby/object:Gem::Requirement
+  requirement: &2153559960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153053800
+  version_requirements: *2153559960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153053200 !ruby/object:Gem::Requirement
+  requirement: &2153559460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,7 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2153053200
+  version_requirements: *2153559460
 description: This is scalarium API wrapper, allowing to execute API calls to scalarium
   backend
 email:
@@ -57,14 +57,17 @@ files:
 - Gemfile
 - README.markdown
 - Rakefile
+- TODO.txt
 - lib/scalarium-api-wrapper.rb
+- lib/scalarium-api-wrapper/abstract_api.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/functional/api_functional_spec.rb
+- spec/functional/api_application_functional_spec.rb
+- spec/functional/api_cloud_functional_spec.rb
 - spec/functional/scalarium.yml.sample
 - spec/spec_helper.rb
 has_rdoc: true
@@ -95,6 +98,7 @@ summary: This is scalarium API wrapper
 test_files:
 - spec/api_spec.rb
 - spec/configuration_spec.rb
-- spec/functional/api_functional_spec.rb
+- spec/functional/api_application_functional_spec.rb
+- spec/functional/api_cloud_functional_spec.rb
 - spec/functional/scalarium.yml.sample
 - spec/spec_helper.rb