rscalr 0.0.5 → 0.0.7

data/lib/rscalr/api/scalr.rb

@@ -252,16 +252,19 @@ class Scalr
   
   #=============== Helper methods ==================================
   
+  # Generates request signature based on config, action, timestamp
   def generate_sig(action, timestamp)
     message = action + ':' + @config[:key_id] + ':' + timestamp
     hexdigest = OpenSSL::HMAC.hexdigest('sha256', @config[:key_secret], message)
     [[hexdigest].pack("H*")].pack("m0")
   end
   
+  # Generates a timestamp string based on a Time object
   def generate_timestamp(time)
     time.strftime("%Y-%m-%dT%H:%M:%SZ")
   end
   
+  # Executes the specified API call, passing in the specified params
   def execute_api_call(action, action_params=nil)
   
     begin
@@ -272,6 +275,7 @@ class Scalr
   	  params[:Version] = @config[:version]
   	  params[:AuthVersion] = @config[:auth_version]
   	  params[:KeyID] = @config[:key_id]
+  	  params[:EnvID] = @config[:env_id] unless @config[:env_id].nil?
 			
   	  uri = URI("https://api.scalr.net/?" + hash_to_querystring(params))
 	
@@ -294,11 +298,12 @@ class Scalr
     result
   end
   
+  # Builds an ad hoc ScalrResponse to represent an unexpected error
   def build_error_response(message, transaction_id)
     result = ScalrResponse.new "<?xml version='1.0?>"
     result.add_element("Error")
     ele = REXML::Element.new "TransactionID"
-    ele.text = transaction_id
+    ele.text = "sig:#{transaction_id}"
     result.root.elements << ele
     ele = REXML::Element.new "Message"
     ele.text = message
@@ -307,11 +312,18 @@ class Scalr
 	  result
   end
   
+  # Turns a hash of request parameter key/value pairs into an escaped request query string.
+  # Keys are expected to not require escaping.
   def hash_to_querystring(h)
     h.map{|k,v| "#{k.to_s}=#{CGI::escape(v.to_s)}"}.join('&')
   end
+  
+  def env_id= env_id
+    @config[:env_id] = env_id
+  end
 end
 
+# Represents a response from an API call. Thin wrapper around an REXML::Document of the parsed repsonse.
 class ScalrResponse < REXML::Document
   
   def initialize http_response_body=nil
@@ -322,10 +334,14 @@ class ScalrResponse < REXML::Document
     end
   end
     
+  # True iff the response indicates that the API call succeeded. This does not guarantee that
+  # the intent of the call succeeded of course (e.g. that a script executed successfully on the Scalr side), 
+  # only that Scalr reported success for the call.
   def success?
     root.name != 'Error'
   end
   
+  # If the API call was not successful, this returns the inner error message.
   def error_message
     if success?
       nil

data/lib/rscalr/version.rb

@@ -1,3 +1,3 @@
 module Rscalr
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/test_integration/test_client_farms.rb

@@ -4,7 +4,12 @@ require 'test/unit'
 class TestClientFarms < Test::Unit::TestCase
   
   def setup
-    @scalr = Scalr.new({ :key_id => ENV['SCALR_TEST_API_KEY'], :key_secret => ENV['SCALR_TEST_API_SECRET'] })
+    @scalr = Scalr.new({
+      :key_id => ENV['SCALR_TEST_API_KEY'], 
+      :key_secret => ENV['SCALR_TEST_API_SECRET'], 
+      :env_id => ENV['SCALR_TEST_ENV_ID'] 
+    })
+      
     @farm_test1_name = 'test1'
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rscalr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies: []
 description: Rscalr is a Ruby implementation of the Scalr API, written to interface
   cleanly with Chef and other internal release management tasks.