scalarium-api-wrapper 0.2.10 → 0.3.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/functional/scalarium.yml

data/README.markdown

@@ -33,7 +33,7 @@ Setup
    <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. 
+You can obtain your token at ([https://manage.scalarium.com/users](https://manage.scalarium.com/users)) - I highly encourage to setup a new user in scalarium (i.e. devdeploy) and then render him new API_TOKEN. 
 
 
 
@@ -54,7 +54,19 @@ and then for example execute a deploy for one of your applications:
 <code>api.deploy_application('application_id')</code>
 </pre>
 
-to obtain list of all possible applications execute:
+This will return hash containing information about current deploy:
+[Scalarium Documentation details](http://support.scalarium.com/kb/api/fetching-deployment-details)
+
+We can then use the 'id' from the above hash and current application id to call for information about the progress:
+
+<pre>
+<code>api.fetch_deployment_details('application_id','deployment_id')</code>
+</pre>
+
+NOTE: We can always see the deploy status if we know proper deployment_id (even from the deploys that have been already finished)
+
+
+to obtain list of all available applications execute:
 <pre>
 <code>api.get_applications</code>
 </pre> 
@@ -100,13 +112,18 @@ Here are the fields returned in each hash:
 
 for their meaning check Scalarium's documentation and examples
 
+Ruby on Rails integration
+--
+
+Here is a simple [RAKE task](https://gist.github.com/1037410) that illustrates how this library could be used with Rails application.
+
 
 
 
 License
 --
 
-Copyright (c) 2010 Lukasz Lazewski
+Copyright (c) 2011 Lukasz Lazewski
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/scalarium-api-wrapper.rb

@@ -1,9 +1,11 @@
 module Scalarium
   
+  # @return [String] url for the clouds
   def self.clouds_url
     Scalarium.configuration.clouds_url
   end
 
+  # @return [String] url for the applications
   def self.applications_url
     Scalarium.configuration.applications_url
   end
@@ -16,6 +18,11 @@ module Scalarium
   def self.configuration
     @configuration ||= Scalarium::Configuration.new
   end
+  
+  # setting an alias for :configuration 
+  class << self
+    alias configure configuration
+  end
 end
 
 

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

@@ -7,7 +7,6 @@ module Scalarium
     
     # 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
@@ -16,13 +15,21 @@ module Scalarium
     
     # 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 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 
+    # 
+    def fetch_deployment_details(app_id, deployment_id)
+      http_get_request(Scalarium.applications_url+"/#{app_id}/deployments/#{deployment_id}")
+    end
+    
     # Method allows to deploy application in scalarium
     #
     # @option app_id    [String]  -     The ID of application we want to deploy.

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

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

data/scalarium-api-wrapper.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   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_dependency('json')
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec', '~> 2.0')
 

data/spec/api_spec.rb

@@ -38,5 +38,10 @@ describe "Scalarium::API", "when first created" do
   it "should be able to get all the applications" do
     @api.should respond_to(:get_applications)
   end
+
+  it "should be able to get deployment status aka deployment details" do
+    @api.should respond_to(:fetch_deployment_details)
+  end
+
   
 end

data/spec/configuration_spec.rb

@@ -6,9 +6,19 @@ describe "Scalarium.configuration", "when first created" do
     Scalarium.configuration.api_token.should == nil
   end
 
+  it "should has no api token set yet - testing thru alias" do
+    Scalarium.configure.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
   
+  it "by using alias we should be able to obtain details set thru 'configuration' check it's presence change it and check again" do
+    Scalarium.configure.api_token.should == "FAKE_TOKEN"
+    Scalarium.configure.api_token = "FAKE_TOKEN_NEW"    
+    Scalarium.configure.api_token.should == "FAKE_TOKEN_NEW"    
+  end
+  
 end

data/spec/functional/api_functional_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'yaml'
+
+
+describe "Scalarium functional tests", "when first created" do
+
+  before(:all) do
+    # we load configuration 
+    config = YAML::load(File.open("./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"]
+    @application_id = config["app_id"]
+    @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)
+    @response_status.class.should == Hash
+    @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)
+    @status_check_response.class.should == Hash
+    @status_check_response["status"].should == "running"
+  end
+  
+end

data/spec/functional/scalarium.yml.sample

@@ -0,0 +1,5 @@
+# IMPORTANT NOTE: functional test will deploy this application during testing 
+# so please make sure you are okay with that! 
+
+api_token: SET_YOUR_TOKEN_HERE
+app_id: SET_YOUR_APPLICATION_ID

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalarium-api-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-20 00:00:00.000000000 +02:00
+date: 2011-06-24 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2153054260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153054260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156892240 !ruby/object:Gem::Requirement
+  requirement: &2153053800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156892240
+  version_requirements: *2153053800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156891520 !ruby/object:Gem::Requirement
+  requirement: &2153053200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +44,7 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2156891520
+  version_requirements: *2153053200
 description: This is scalarium API wrapper, allowing to execute API calls to scalarium
   backend
 email:
@@ -53,6 +64,8 @@ files:
 - scalarium-api-wrapper.gemspec
 - spec/api_spec.rb
 - spec/configuration_spec.rb
+- spec/functional/api_functional_spec.rb
+- spec/functional/scalarium.yml.sample
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: ''
@@ -82,4 +95,6 @@ summary: This is scalarium API wrapper
 test_files:
 - spec/api_spec.rb
 - spec/configuration_spec.rb
+- spec/functional/api_functional_spec.rb
+- spec/functional/scalarium.yml.sample
 - spec/spec_helper.rb