qingcloud-sdk 0.4.1 → 2.0.0.pre.alpha.1

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "qingcloud/sdk"
+require 'bundler/setup'
+require 'qingcloud/sdk'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "qingcloud/sdk"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/qingcloud/sdk.rb

@@ -1,15 +1,17 @@
-require 'qingcloud/sdk/version'
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
 
-# General
-require 'qingcloud/sdk/general/contract'
-require 'qingcloud/sdk/general/error'
-
-# Utility
-require 'qingcloud/sdk/utility/logger'
-require 'qingcloud/sdk/utility/file_manager'
-require 'qingcloud/sdk/utility/json_parser'
-
-# Client
-require 'qingcloud/sdk/iaas/connector'
-require 'qingcloud/sdk/iaas/foundation'
-require 'qingcloud/sdk/iaas/service'
+Dir[File.dirname(__FILE__) + '/sdk/**/*.rb'].each { |file| require file }

data/lib/qingcloud/sdk/general/config.rb

@@ -0,0 +1,70 @@
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
+
+require 'fileutils'
+require 'yaml'
+
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/deep_merge'
+require 'net/http/persistent'
+
+module QingCloud
+  module SDK
+    class Config < Hash
+      attr_accessor :connection
+
+      def self.init(access_key_id, secret_access_key)
+        initial_config = {
+          qy_access_key_id:     access_key_id,
+          qy_secret_access_key: secret_access_key,
+        }
+        Config.new(initial_config)
+      end
+
+      def initialize(initial_config = {})
+        self.connection = Net::HTTP::Persistent.new
+        load_default_config
+        update initial_config
+      end
+
+      def update(another_config = {})
+        deep_merge! another_config.deep_symbolize_keys!
+        Logger.set_level self[:log_level]
+        self
+      end
+
+      def load_default_config
+        load_config_from_file Contract::DEFAULT_CONFIG_FILEPATH
+      end
+
+      def load_user_config
+        install_default_user_config unless File.exist? Contract::USER_CONFIG_FILEPATH
+        load_config_from_file Contract::USER_CONFIG_FILEPATH
+      end
+
+      def load_config_from_file(path)
+        path = path.sub '~', Dir.home if path.start_with? '~/'
+        update YAML.load_file File.absolute_path path
+      end
+
+      def install_default_user_config
+        Logger.warn "Installing default config file to #{Contract::USER_CONFIG_FILEPATH}"
+        FileUtils.mkdir_p Contract::USER_SUPPORT_DIRECTORY
+        FileUtils.copy Contract::DEFAULT_CONFIG_FILEPATH, Contract::USER_CONFIG_FILEPATH
+      end
+    end
+  end
+end

data/lib/qingcloud/sdk/general/contract.rb

@@ -1,20 +1,31 @@
-module QingCloud
-    module SDK
-        module Contract
-
-            SUPPORT_DIRECTORY = "#{Dir.home}/.qingcloud"
-            CONFIG_FILE_NAME = 'config.json'
-            CONFIG_FILE_PATH = "#{SUPPORT_DIRECTORY}/#{CONFIG_FILE_NAME}"
-            LOG_FILE_NAME = 'access.log'
-            LOG_FILE_PATH = "#{SUPPORT_DIRECTORY}/#{LOG_FILE_NAME}"
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
 
-            TEMPLATE_DIRECTORY = Gem::Specification.find_by_name('qingcloud-sdk').gem_dir + '/lib/qingcloud/sdk/template'
-            TEMPLATE_CONFIG_FILE_NAME = 'config.json'
-            TEMPLATE_CONFIG_FILE_PATH = "#{TEMPLATE_DIRECTORY}/#{TEMPLATE_CONFIG_FILE_NAME}"
-
-            API_URL = 'https://api.qingcloud.com'
-            IaaS_API_URL = "#{API_URL}/iaas/?"
+module QingCloud
+  module SDK
+    module Contract
+      USER_SUPPORT_DIRECTORY    = "#{Dir.home}/.qingcloud".freeze
+      USER_CONFIG_FILENAME      = 'config.yaml'.freeze
+      USER_CONFIG_FILEPATH      = "#{USER_SUPPORT_DIRECTORY}/#{USER_CONFIG_FILENAME}".freeze
 
-        end
+      # GEM_DIRECTORY             = Gem::Specification.find_by_name('qingcloud-sdk').gem_dir
+      # DEFAULT_SUPPORT_DIRECTORY = GEM_DIRECTORY + '/lib/qingcloud/sdk/commons/default'
+      DEFAULT_SUPPORT_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/./default')
+      DEFAULT_CONFIG_FILENAME   = 'config.yaml'.freeze
+      DEFAULT_CONFIG_FILEPATH   = "#{DEFAULT_SUPPORT_DIRECTORY}/#{DEFAULT_CONFIG_FILENAME}".freeze
     end
-end
+  end
+end

data/lib/qingcloud/sdk/general/default/config.yaml

@@ -0,0 +1,13 @@
+# QingCloud services configuration
+
+#qy_access_key_id: 'ACCESS_KEY_ID'
+#qy_secret_access_key: 'SECRET_ACCESS_KEY'
+
+host: 'api.qingcloud.com'
+port: 443
+protocol: 'https'
+uri: '/iaas'
+connection_retries: 3
+
+# Valid log levels are "debug", "info", "warn", "error", and "fatal".
+log_level: 'warn'

data/lib/qingcloud/sdk/general/error.rb

@@ -1,39 +1,48 @@
-module QingCloud
-    module SDK
-        module Error
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
 
-            class SDKError < StandardError
-            end
+module QingCloud
+  module SDK
+    class SDKError < StandardError
+    end
 
-            class NetworkError < SDKError
-                def message
-                    'Network Error, please check your internet connection.'
-                end
-            end
+    class NetworkError < SDKError
+    end
 
-            class ServerError < SDKError
-                def initialize(code)
-                    super "Server Response with Error Code \"#{code}\"."
-                end
-            end
+    class ParameterRequiredError < SDKError
+      def initialize(parameter_name, parent_name)
+        @parameter_name = parameter_name
+        @parent_name = parent_name
+      end
 
-            class ParameterError < SDKError
-                def initialize(something)
-                    super "Parameter Error when \"#{something}\"."
-                end
-            end
+      def message
+        "\"#{@parameter_name}\" is required in \"#{@parent_name}\"."
+      end
+    end
 
-            class APIError < SDKError
-                def initialize(something)
-                    super "API Error: \"#{something}\"."
-                end
-            end
+    class ParameterValueNotAllowedError < SDKError
+      def initialize(parameter_name, parameter_value, allowed_values)
+        @parameter_name = parameter_name
+        @parameter_value = parameter_value
+        @allowed_values = allowed_values
+      end
 
-            class AnalyseError < SDKError
-                def initialize(something)
-                    super "Analyse Error when \"#{something}\"."
-                end
-            end
-        end
+      def message
+        "\"#{@parameter_name}\" value \"#{@parameter_value}\" is not allowed, should be one of #{@allowed_values.join ', '}."
+      end
     end
-end
+  end
+end

data/lib/qingcloud/sdk/general/logger.rb

@@ -0,0 +1,54 @@
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
+
+require 'active_support/logger'
+
+module QingCloud
+  module SDK
+    class Logger
+      @@logger = ActiveSupport::Logger.new STDOUT
+      @@level = :warn
+
+      def self.set_level(level)
+        index = %w(debug info warn error fatal).find_index level.to_s
+        @@logger.level = index.nil? ? 0 : index
+        @@level = level.to_sym
+      end
+
+      set_level :warn
+
+      def self.debug(text)
+        @@logger.debug text
+      end
+
+      def self.info(text)
+        @@logger.info text
+      end
+
+      def self.warn(text)
+        @@logger.warn text
+      end
+
+      def self.error(text)
+        @@logger.error text
+      end
+
+      def self.fatal(text)
+        @@logger.fatal text
+      end
+    end
+  end
+end

data/lib/qingcloud/sdk/request/preprocessor.rb

@@ -0,0 +1,81 @@
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
+
+require 'active_support/core_ext/hash/keys'
+
+module QingCloud
+  module SDK
+    class Preprocessor
+      def self.do(input)
+        input = decorate_input input
+
+        config                   = input[:config]
+        input[:request_endpoint] = "#{config[:protocol]}://#{config[:host]}:#{config[:port]}"
+
+        parsed_params = {}
+        input[:request_params].each do |param_k, param_v|
+          if param_v.is_a? Array
+            param_v.each_with_index do |value, index|
+              if value.is_a? Hash
+                value.each do |value_k, value_v|
+                  parsed_params["#{param_k}.#{index}.#{value_k}"] = value_v
+                end
+              else
+                parsed_params["#{param_k}.#{index}"] = value
+              end
+            end
+          elsif param_v.is_a? Hash
+            param_v.each do |key, value|
+              parsed_params["#{param_k}.#{key}"] = value
+            end
+          else
+            parsed_params[param_k] = param_v
+          end
+        end
+        input[:request_params] = parsed_params.deep_symbolize_keys!
+        input[:request_params].update(
+          action:            input[:api_name],
+          time_stamp:        Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ'),
+          version:           1,
+          signature_method:  'HmacSHA256',
+          signature_version: 1,
+          access_key_id:     input[:config][:qy_access_key_id],
+        )
+
+        if input[:properties][:zone] && !input[:properties][:zone].empty?
+          input[:request_params][:zone] = input[:properties][:zone]
+        end
+
+        Logger.info "Preprocess QingCloud request: [#{input[:id]}] #{input}"
+        input
+      end
+
+      def self.decorate_input(input)
+        input.deep_symbolize_keys!
+        input[:id] = (Random.new.rand * 1_000_000).to_int
+        compact input
+      end
+
+      def self.compact(object)
+        object.each do |k, v|
+          object[k] = compact v if v.is_a? Hash
+          object.delete k if v.nil? || v == ''
+        end
+        object
+      end
+    end
+  end
+end

data/lib/qingcloud/sdk/request/request.rb

@@ -0,0 +1,80 @@
+#  +-------------------------------------------------------------------------
+#  | Copyright (C) 2016 Yunify, Inc.
+#  +-------------------------------------------------------------------------
+#  | Licensed under the Apache License, Version 2.0 (the "License");
+#  | you may not use this work except in compliance with the License.
+#  | You may obtain a copy of the License in the LICENSE file, or at:
+#  |
+#  | http://www.apache.org/licenses/LICENSE-2.0
+#  |
+#  | Unless required by applicable law or agreed to in writing, software
+#  | distributed under the License is distributed on an "AS IS" BASIS,
+#  | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  | See the License for the specific language governing permissions and
+#  | limitations under the License.
+#  +-------------------------------------------------------------------------
+
+require 'json'
+require 'net/http'
+require 'ostruct'
+
+module QingCloud
+  module SDK
+    class Request
+      attr_accessor :input, :request_url, :http_request, :http_response
+
+      def initialize(input)
+        self.input = Preprocessor.do input
+      end
+
+      def send
+        check
+        build
+        perform
+        unpack
+      end
+
+      private
+
+      def check
+        unless !input[:config][:qy_access_key_id].nil? && !input[:config][:qy_access_key_id].empty?
+          raise SDKError, 'access key not provided'
+        end
+        unless !input[:config][:qy_secret_access_key].nil? && !input[:config][:qy_secret_access_key].empty?
+          raise SDKError, 'secret access key not provided'
+        end
+      end
+
+      def build
+        self.input = Signer.do input
+
+        params           = input[:request_params].map { |k, v| "#{k}=#{v}" }
+        query_string     = !params.empty? ? "?#{params.join '&'}" : ''
+        self.request_url = "#{input[:request_endpoint]}#{input[:config][:uri]}#{query_string}"
+
+        self.http_request = Net::HTTP::Get.new request_url
+      end
+
+      def perform
+        retries = input[:config][:connection_retries]
+        while
+          begin
+            Logger.info "Sending request: [#{input[:id]}] #{request_url}"
+            self.http_response = input[:config].connection.request request_url, http_request
+          rescue SocketError
+            retries > 0 ? retries -= 1 : (raise NetworkError)
+            sleep 1
+            next
+          end
+          break
+        end
+      end
+
+      def unpack
+        output = JSON.parse(http_response.body)
+        Logger.info "Parse response: [#{input[:id]}] #{output}"
+        output.deep_symbolize_keys!
+      end
+    end
+  end
+end