rscalr 0.0.1 → 0.0.4

data/.gitignore

@@ -1,3 +1,6 @@
+# Global
+**/.DS_Store
+
 *.gem
 *.rbc
 .bundle
@@ -16,3 +19,5 @@ tmp
 .yardoc
 _yardoc
 doc/
+
+

data/README.md

@@ -1,4 +1,51 @@
-rscalr
+Rscalr
 ======
 
-Ruby Scalr API implementation
+Ruby Scalr API implementation. 
+
+Desciption
+----------
+
+Rscalr allows your Ops team to build on top of the Scalr API using Ruby. This is particularly beneficial due to the popularity of Chef, a cloud management software suite also written in Ruby.
+
+Rscalr provides both a low-level client implementation, as well as a more user-friendly domain object layer. Here are some brief examples of how to interact with each API mode.
+
+Installation
+------------
+
+Rscalr is available on RubyGems so installing it is simply: 
+
+```bash
+gem install rscalr
+```
+
+Client Usage
+------------
+
+```ruby
+require 'rscalr'
+scalr = Scalr.new { :key_id => 'your-key-id', :key_secret => 'your-key-secret' }
+# list all farms
+api_response = scalr.farms_list
+# Response objects exted REXML::Document, so you can work with them easily
+api_repsonse.write($stdout, 1)
+```
+
+Domain Model Usage
+------------------
+
+```ruby
+require 'rscalr'
+scalr = Scalr.new { :key_id => 'your-key-id', :key_secret => 'your-key-secret' }
+dashboard = Dashboard.new scalr
+farm = dashboard.get_farm 'my-farm-name'
+script = dashboard.get_script 'my-script-name'
+# execute the script on all instances in the farm (see Script.rb for all options)
+script.execute farm.id
+```
+
+
+Caveats
+-------
+
+This client library is a work in progress and is not yet complete. Feel free to submit pull requests and/or suggestions. I am not an experienced Rubyist, so if you see anything in the source that makes you cringe, by all means let me know!

data/lib/rscalr/api/scalr.rb

@@ -22,10 +22,14 @@ class Scalr
     [[hexdigest].pack("H*")].pack("m0")
   end
   
+  def generate_timestamp(time)
+    time.strftime("%Y-%m-%dT%H:%M:%SZ")
+  end
+  
   def execute_api_call(action, action_params=nil)
   
     begin
-  	  params = { :Action => action, :TimeStamp => Time.now.strftime("%Y-%m-%dT%H:%M:%SZ") }
+  	  params = { :Action => action, :TimeStamp => generate_timestamp(Time.now) }
 	    params.merge!(action_params) unless action_params.nil?
 		
   	  params[:Signature] = generate_sig(action, params[:TimeStamp])
@@ -58,7 +62,7 @@ class Scalr
     result = ScalrResponse.new "<?xml version='1.0?>"
     result.add_element("Error")
     ele = REXML::Element.new "TransactionID"
-    ele.text = generate_sig(message, Time.now.strftime("%Y-%m-%dT%H:%M:%SZ"))
+    ele.text = generate_sig(message, generate_timestamp(Time.now))
     result.root.elements << ele
     ele = REXML::Element.new "Message"
     ele.text = message
@@ -74,10 +78,149 @@ class Scalr
   
   #=================== API Section ===================================
   
+  def apache_vhost_create(domain_name, farm_id, farm_role_id, document_root_dir, enable_ssl, ssl_private_key=nil, ssl_certificate=nil)
+    params = { 
+      :DomainName => domain_name,
+      :FarmID => farm_id, 
+      :FarmRoleID => farm_role_id,
+      :DocumentRootDir => document_root_dir, 
+      :EnableSSL => enable_ssl 
+    }
+    params[:SSLPrivateKey] = ssl_private_key unless ssl_private_key.nil?
+    params[:SSLCertificate] = ssl_certificate unless ssl_certificate.nil?
+    
+    execute_api_call('ApacheVhostCreate', params)
+  end
+  
+  def apache_vhosts_list
+    execute_api_call('ApacheVhostsList')
+  end
+  
+  def bundle_task_get_status(bundle_task_id)
+    params = { :BundleTaskID => bundle_task_id }
+    
+    execute_api_call('BundleTaskGetStatus', params)
+  end
+  
+  def dm_application_deploy(application_id, farm_role_id, remote_path)
+    params = { :ApplicationID => application_id, :FarmRoleID => farm_role_id, :RemotePath => remote_path }
+
+    execute_api_call('DmApplicationDeploy', params)
+  end
+  
+  def dm_applications_list
+    execute_api_call('DmApplicationsList')
+  end
+  
+  def dm_sources_list
+    execute_api_call('DmSourcesList')
+  end
+  
+  def dns_zone_create(domain_name, farm_id=nil, farm_role_id=nil)
+    params = { :DomainName => domain_name }
+    params[:FarmID] = farm_id unless farm_id.nil?
+    params[:FarmRoleID] = farm_role_id unless farm_role_id.nil?
+    
+    execute_api_call('DNSZoneCreate', params)
+  end
+  
+  def dns_zone_record_add(zone_name, type, ttl, name, value, priority=nil, weight=nil, port=nil)
+    params = { 
+      :ZoneName => zone_name,
+      :Type => type, 
+      :TTL => ttl,
+      :Name => name, 
+      :Value => value 
+    }
+    params[:Priority] = priority unless priority.nil?
+    params[:Weight] = weight unless weight.nil?
+    params[:Port] = port unless port.nil?
+    
+    execute_api_call('DNSZoneRecordAdd', params)
+  end
+  
+  def dns_zone_record_remove(zone_name, record_id)
+    params = { :ZoneName => zone_name, :RecordID => record_id }
+    
+    execute_api_call('DNSZoneRecordRemove', params)
+  end
+  
+  def dns_zone_records_list(zone_name)
+    params = { :ZoneName => zone_name }
+    
+    execute_api_call('DNSZoneRecordsList', params)
+  end
+  
+  def dns_zones_list    
+    execute_api_call('DNSZonesList')
+  end
+  
+  def environments_list    
+    execute_api_call('EnvironmentsList')
+  end
+  
+  def events_list(farm_id, start=nil, limit=nil)
+    params = { :FarmID => farm_id }
+    params[:StartFrom] = start unless start.nil?
+    params[:RecordsLimit] = limit unless limit.nil?
+    
+    execute_api_call('EventsList', params)
+  end
+  
+  def farm_clone(farm_id)
+    params = { :FarmID => farm_id }
+
+    execute_api_call('FarmClone', params)
+  end
+  
+  def farm_get_stats(farm_id, date)
+    params = { :FarmID => farm_id }
+    params[:Date] = date.strftime("%m-%Y") unless date.nil?
+
+    execute_api_call('FarmGetStats', params)
+  end
+  
+  def farm_launch(farm_id)
+    params = { :FarmID => farm_id }
+
+    execute_api_call('FarmLaunch', params)
+  end
+  
   def farms_list
+  
     execute_api_call('FarmsList')
   end
   
+  def farm_terminate(farm_id, keep_ebs, keep_eip, keep_dns_zone)
+    params = { 
+      :FarmID => farm_id,
+      :KeepEBS => (keep_ebs ? 1 : 0), 
+      :KeepEIP => (keep_eip ? 1 : 0), 
+      :KeepDNSZone => (keep_dns_zone ? 1 : 0)
+    }
+    
+    execute_api_call('FarmTerminate', params)
+  end
+  
+  def logs_list(farm_id, server_id=nil, start=nil, limit=nil)
+    params = { :FarmID => farm_id }
+    params[:ServerID] = server_id unless server_id.nil?
+    params[:StartFrom] = start unless start.nil?
+    params[:RecordsLimit] = limit unless limit.nil?
+    
+    execute_api_call('LogsList', params)
+  end
+  
+  def roles_list(platform=nil, name=nil, prefix=nil, image_id=nil)
+    params = {}
+    params[:Platform] = platform unless platform.nil?
+    params[:Name] = name unless name.nil?
+    params[:Prefix] = prefix unless prefix.nil?
+    params[:ImageID] = image_id unless image_id.nil?
+
+	execute_api_call('RolesList', params)
+  end
+  
   def scripts_list
     execute_api_call('ScriptsList')
   end
@@ -107,6 +250,32 @@ class Scalr
     execute_api_call('ScriptGetDetails', { :ScriptID => script_id })
   end
   
+  def server_image_create(server_id, role_name)
+    params = { :ServerID => server_id, :RoleName => role_name }
+    
+    execute_api_call('ServerImageCreate', params)
+  end
+  
+  def server_launch(farm_role_id, increase_max_instances=nil)
+    params = { :FarmRoleID => farm_role_id }
+    params[:IncreaseMaxInstances] = (increase_max_instances ? 1 : 0) unless increase_max_instances.nil?
+  
+  	execute_api_call('ServerLaunch', params)
+  end
+  
+  def server_reboot(server_id)
+  	params = { :ServerID => server_id }
+
+  	execute_api_call('ServerReboot', params)
+  end
+  
+  def server_terminate(server_id, decrease_min_instances=nil)
+    params = { :ServerID => server_id }
+    params[:DecreaseMinInstancesSetting] = (decrease_min_instances ? 1 : 0) unless decrease_min_instances.nil?
+  
+  	execute_api_call('ServerTerminate', params)
+  end
+  
   def farm_role_parameters_list(farm_role_id)
     execute_api_call('FarmRoleParametersList', { :FarmRoleID => farm_role_id })
   end
@@ -123,6 +292,17 @@ class Scalr
     
     execute_api_call('ScriptingLogsList', params)
   end
+  
+  def statistics_get_graph_url(object_type, object_id, watcher_name, graph_type)
+    params = { 
+      :ObjectType => object_type,
+      :ObjectID => object_id, 
+      :WatcherName => watcher_name,
+      :GraphType => graph_type
+    }
+    
+    execute_api_call('StatisticsGetGraphURL', params)
+  end
 end
 
 class ScalrResponse < REXML::Document

data/lib/rscalr/version.rb

@@ -1,3 +1,3 @@
 module Rscalr
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/rscalr.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{Ruby implementation of the Scalr API}
   s.description = %q{Rscalr is a Ruby implementation of the Scalr API, written to interface cleanly with Chef and other internal release management tasks.}
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {test,test_integration}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/test/test_sig.rb

@@ -0,0 +1,21 @@
+require 'rscalr'
+require 'test/unit'
+
+class TestSig < Test::Unit::TestCase
+
+  def test_generate_timestamp
+    scalr = Scalr.new({ :key_id => '123', :key_secret => '123abc' })
+    time = Time.new(2013, "feb", 3, 22, 36, 01)
+   	timestamp = scalr.generate_timestamp time
+   	assert_equal '2013-02-03T22:36:01Z', timestamp
+  end
+
+  def test_generate_sig
+    scalr = Scalr.new({ :key_id => '123', :key_secret => '123abc' })
+    time = Time.new(2013, "feb", 3, 22, 36, 01)
+   	timestamp = scalr.generate_timestamp time
+    action = 'FarmsList'
+   	assert_equal 'XBwijDqKLfCuatAG33SreuL1ftA10L5DZqdTf7mmuII=', scalr.generate_sig(action, timestamp)
+  end
+  
+end

data/test_integration/test_client_farms.rb

@@ -0,0 +1,41 @@
+require 'rscalr'
+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'] })
+    @farm_test1_name = 'test1'
+  end
+  
+  def test_list_launch_details_terminate
+    farm_test1_id = nil
+    
+    # List
+    api_result = @scalr.farms_list
+    assert(api_result.success?, "FarmsList failed with message #{api_result.error_message}")
+    api_result.root.each_element('FarmSet/Item') do |ele|
+      if ele.elements['Name'].text == @farm_test1_name
+        farm_test1_id = ele.elements['ID'].text.to_i
+        assert ele.elements['Status'].text == '0', "Test Farm 1 is not currently down! Please stop it manually and rerun tests." 
+      end
+    end
+    
+    assert_not_nil farm_test1_id, "Test Farm 1 not found!"
+    
+    # Launch
+    api_result = @scalr.farm_launch farm_test1_id
+    assert api_result.success?, "FarmLaunch failed with message #{api_result.error_message}"
+    
+    # GetDetails
+    api_result = @scalr.farm_get_details farm_test1_id
+    assert api_result.success?, "FarmGetDetails failed with message #{api_result.error_message}"
+    
+    sleep(5)
+    
+    # Terminate
+    api_result = @scalr.farm_terminate farm_test1_id, false, false, false
+    assert api_result.success?, "FarmTerminate failed with message #{api_result.error_message}"
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rscalr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -31,6 +31,8 @@ files:
 - lib/rscalr/model/server.rb
 - lib/rscalr/version.rb
 - rscalr.gemspec
+- test/test_sig.rb
+- test_integration/test_client_farms.rb
 homepage: 
 licenses: []
 post_install_message: 
@@ -51,8 +53,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of the Scalr API
-test_files: []
+test_files:
+- test/test_sig.rb
+- test_integration/test_client_farms.rb