cloudshare-sdk 0.1.0.dev

data/lib/cloudshare-sdk/cs_high_api.rb

@@ -0,0 +1,220 @@
+require 'cloudshare-sdk/cs_low_api'
+
+module CloudshareSDK
+  class CSHighApi
+    def initialize(id, key, version=CSLowApi::DEFAULT_VERSION, host=CSLowApi::DEFAULT_HOST)
+      @lowapi = CSLowApi.new(id, key, version, host)
+    end
+
+    def call(category, command, params={})
+      @lowapi.call(category, command, params).json['data']
+    end
+
+    # Env info
+
+    def list_environments
+      call('env', 'ListEnvironments')
+    end
+
+    def list_environments_with_state
+      call('env', 'ListEnvironmentsWithStateExt')
+    end
+
+    def get_environment_status(envId)
+      call('env', 'GetEnvironmentStateExt', {'EnvId' => envId})
+    end
+
+    def get_environment_status_list
+      envs = list_environments
+      envs.map{|env| get_environment_status(env['envId'])}
+    end
+
+    # General env actions
+
+    def resume_environment(envId)
+      call('env', 'ResumeEnvironment', {'EnvId' => envId})
+    end
+
+    def revert_environment(envId)
+      call('env', 'RevertEnvironment', {'EnvId' => envId})
+    end
+
+    def delete_environment(envId)
+      call('env', 'DeleteEnvironment', {'EnvId' => envId})
+    end
+
+    def extend_environment(envId)
+      call('env', 'ExtendEnvironment', {'EnvId' => envId})
+    end
+
+    def postpone_inactivity(envId)
+      call('env', 'PostponeInactivityAction', {'EnvId' => envId})
+    end
+
+    def suspend_environment(envId)
+      call('env', 'SuspendEnvironment', {'EnvId' => envId})
+    end
+
+    def revert_environment_to_snapshot(envId, snapshotId)
+      call('env', 'RevertEnvironmentToSnapshot', {'EnvId' => envId, 'SnapshotId' => snapshotId})
+    end
+
+    # Create env actions
+
+    def list_templates
+      call('env', 'ListTemplates')
+    end
+
+    def add_vm_from_template(envId, templateId, vm_name, vm_description)
+      call('env', 'AddVmFromTemplate',
+           {'EnvId' => envId, 'TemplateVmId' => templateId, 'VmName' => vm_name, 'VmDescription' => vm_description})
+    end
+
+    def create_ent_app_env_options(project_filter='', blueprint_filter='', env_policy_duration_filter='')
+      call('env', 'CreateEntAppEnvOptions',
+           {'ProjectFilter' => project_filter, 'BlueprintFilter' => blueprint_filter,
+            'EnvironmentPolicyDurationFilter' => env_policy_duration_filter})
+    end
+
+    def create_ent_app_env(envPolicyId, snapshotId, env_new_name=nil, project_filter='',
+        blueprint_filter='', env_policy_duration_filter='')
+      call('env', 'CreateEntAppEnv', {'EnvironmentPolicyId' => envPolicyId,
+                                      'SnapshotId' => snapshotId,
+                                      'ProjectFilter' => project_filter,
+                                      'BlueprintFilter' => blueprint_filter,
+                                      'EnvironmentPolicyDurationFilter' => env_policy_duration_filter,
+                                      'EnvironmentNewName' => env_new_name})
+    end
+
+    def create_empty_ent_app_env(env_name, project_name, description='none')
+      call('env', 'CreateEmptyEntAppEnv',
+           {'EnvName' => env_name, 'ProjectName' => project_name, 'Description' => description})
+    end
+
+
+    # Snapshots
+
+    def get_snapshots(envId)
+      call('env', 'GetSnapshots', {'EnvId' => envId})
+    end
+
+    def get_snapshot_info(snapshotId)
+      call('env', 'GetSnapshotDetails', {'SnapshotId' => snapshotId})
+    end
+
+    def get_blueprints_for_publish(envId)
+      call('env', 'GetBlueprintsForPublish', {'EnvId' => envId})
+    end
+
+    def mark_snapshot_default(envId, snapshotId)
+      call('env', 'MarkSnapshotDefault', {'EnvId' => envId, 'SnapshotId' => snapshotId})
+    end
+
+    def ent_app_take_snapshot(envId, snapshot_name, description='', set_as_default=true)
+      call('env', 'EntAppTakeSnapshot',
+           {'EnvId' => envId, 'SnapshotName' => snapshot_name, 'Description' => description,
+            'SetAsDefault' => (set_as_default ? 'true' : 'false')})
+    end
+
+    def ent_app_take_snapshot_to_new_blueprint(envId, snapshot_name, new_blueprint_name, description='')
+      call('env', 'EntAppTakeSnapshotToNewBlueprint',
+           {'EnvId' => envId,
+            'SnapshotName' => snapshot_name,
+            'NewBlueprintName' => new_blueprint_name,
+            'Description' => description})
+    end
+
+    def ent_app_take_snapshot_to_existing_blueprint(envId, snapshot_name, otherBlueprintId, description='', set_as_default=true)
+      call('env', 'EntAppTakeSnapshotToExistingBlueprint',
+           {'EnvId' => envId,
+            'SnapshotName' => snapshot_name,
+            'OtherBlueprintId' => otherBlueprintId,
+            'Desctiption' => description,
+            'SetAsDefault' => (set_as_default ? 'true' : 'false')})
+    end
+
+    # VM actions
+
+    def delete_vm(envId, vmId)
+      call('env', 'DeleteVm', {'EnvId' => envId, 'VmId' => vmId})
+    end
+
+    def revert_vm(envId, vmId)
+      call('env', 'RevertVm', {'EnvId' => envId, 'VmId' => vmId})
+    end
+
+    def reboot_vm(envId, vmId)
+      call('env', 'RebootVm', {'EnvId' => envId, 'VmId' => vmId})
+    end
+
+    def execute_path(envId, vmId, path)
+      call('env', 'ExecutePathExt', {'EnvId' => envId, 'VmId' => vmId, 'Path' => path})
+    end
+
+    def edit_machine_hardware(envId, vmId, numCpus=nil,mbRAM=nil, gbDisk=nil)
+      call('env', 'EditMachineHardware',
+           {'EnvId' => envId,
+            'VmId' => vmId,
+            'NumCpus' => numCpus,
+            'MemorySizeMBs' => mbRAM,
+            'DiskSizeGBs' => gbDisk})
+    end
+
+    def check_execution_id(envId, vmId, exec_id)
+      call('env', 'CheckExecutionStatus', {'EnvId' => envId, 'VmId' => vmId, 'ExecutionId' => exec_id})
+    end
+
+    # CloudFolders
+
+    def get_cloudfolders_info
+      call('env', 'GetCloudFoldersInfo')
+    end
+
+    def mount(envId)
+      call('env', 'Mount', {'EnvId' => envId})
+    end
+
+    def unmount(envId)
+      call('env', 'Unmount', {'EnvId' => envId})
+    end
+
+    def mount_and_fetch_info(envId)
+      call('env', 'MountAndFetchInfo', {'EnvId' => envId})
+    end
+
+    def mount_and_fetch_info_ext(envId)
+      call('env', 'MountAndFetchInfoExt', {'EnvId' => envId})
+    end
+
+    def regenerate_cloudfolders_password
+      call('env', 'RegenerateCloudfoldersPassword')
+    end
+
+    # Login
+
+    def get_login_url(url)
+      call('env', 'GetLoginUrl', {'Url' => url})
+    end
+
+    def who_am_i(userId)
+      call('env', 'WhoAmI', {'UserId' => userId})
+    end
+
+    # RDP
+
+    def get_remote_access(envId, vmId, isConsole='', desktopWidth='', desktopHeight='')
+      call('env', 'GetRemoteAccessFile',
+           {'EnvId' => envId,
+            'VmId' => vmId,
+            'IsConsole' => isConsole,
+            'DesktopWidth' => desktopWidth,
+            'DesktopHeight' => desktopHeight})
+    end
+
+    # Admin
+
+    def list_allowed_commands
+      call('admin', 'ListAllowedCommands')
+    end
+  end
+end

data/lib/cloudshare-sdk/cs_low_api.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+require 'json'
+require 'securerandom'
+require 'digest'
+
+module CloudshareSDK
+  def self.token_generator
+    if RUBY_VERSION >= "1.9"
+      SecureRandom.hex(10/2) # generated result string from #hex is double the size of given n...
+    else
+      o = [('a'..'z'), ('A'..'Z'), ('0'..'9')].map { |i| i.to_a }.flatten
+      (0...10).map { o[rand(o.length)] }.join
+    end
+  end
+
+  def self.prettify_json(s)
+    begin
+      JSON.pretty_generate(Hash[JSON.parse(s).sort])
+    rescue
+      s
+    end
+  end
+
+  class ApiException < StandardError
+    attr_reader :content, :code
+    def initialize(content, code)
+      @content = content
+      @code = code
+    end
+
+    def to_s
+      "\ncontent:\n\n#@content\n\nhttp status code: #@code\n\n"
+    end
+  end
+
+
+  class ApiResponse
+    def initialize(content, code)
+      @content = content
+      @code = code
+    end
+
+    def pretty_content
+      CloudshareSDK::prettify_json(@content)
+    end
+
+    def json
+      JSON.parse(@content)
+    end
+  end
+
+
+  class CSLowApi
+    DEFAULT_HOST = "use.cloudshare.com"
+    DEFAULT_VERSION = "v2"
+
+    def initialize(id, key, version=DEFAULT_VERSION, host=DEFAULT_HOST)
+      @id = id
+      @key = key
+      @version = version
+      @host = host
+    end
+
+    def call(category, command, params={})
+      uri = gen_uri(category, command, params)
+      begin
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        request = Net::HTTP::Get.new(uri.request_uri)
+        f = http.request(request)
+        raise ApiException.new(f.body , f.code) if f.code != '200'
+        raise ApiException.new('Empty Response' , f.code) if f.body.length == 0
+      rescue StandardError => ex
+        raise ApiException.new((ex.respond_to?(:content) ? ex.content : ex.message),
+                               (ex.respond_to?(:code) ? ex.code : -1))
+      end
+
+      ApiResponse.new(f.body, f.code)
+    end
+
+    def gen_uri(category, command, params)
+      hmac = Digest::SHA1.new
+      hmac.update(@key.encode('utf-8'))
+      hmac.update(command.downcase.encode('utf-8')) if @version != 'v1'
+
+      params['timestamp'] = Time.now.to_i.to_s
+      params['UserApiId'] = @id
+      params['token'] = CloudshareSDK::token_generator if @version != 'v1'
+
+      query = {}
+      params.keys.sort_by {|k| [k.downcase]}.each do |pkey|
+        pkey_lower = pkey.downcase
+        continue if pkey_lower == "hmac"
+
+        hmac.update(pkey_lower.encode('utf-8'))
+        pvalue = params[pkey]
+        if !pvalue.nil? and pvalue.length > 0
+          hmac.update(pvalue.encode('utf-8'))
+          query[pkey] = pvalue.encode('utf-8')
+        end
+      end
+
+      query['HMAC'] = hmac.hexdigest
+      uri = URI("https://#{@host.encode('utf-8')}/Api/#{@version.encode('utf-8')}" +
+                    "/#{category.encode('utf-8')}/#{command.encode('utf-8')}")
+      uri.tap do |u|
+        u.query = URI.encode_www_form(query)
+      end
+    end
+
+    def check_keys
+      call('ApiTest', 'Ping').json['data']
+    end
+  end
+end

data/lib/cloudshare-sdk.rb

@@ -0,0 +1,6 @@
+module CloudshareSDK
+  require 'cloudshare-sdk/cs_low_api'
+  require 'cloudshare-sdk/cs_high_api'
+end
+
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: cloudshare-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0.dev
+  prerelease: 6
+platform: ruby
+authors:
+- Muly Gottlieb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies: []
+description: ! 'An SDK for developing applications in Ruby to connect to the CloudShare
+  service using the CloudShare API. '
+email: muly@cloudshare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cloudshare-sdk.rb
+- lib/cloudshare-sdk/cs_high_api.rb
+- lib/cloudshare-sdk/cs_low_api.rb
+homepage: http://www.cloudshare.com
+licenses:
+- Apache 2.0
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: An SDK for developing applications in Ruby to connect to the CloudShare service
+  using the CloudShare API.
+test_files: []