tencentcloud-sdk-common 1.0.199

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 860333f84b5b6c07088a6348b3e9998f5ca736cf
+  data.tar.gz: d954ff249bf9164d8fd2d5938966f44377019f30
+SHA512:
+  metadata.gz: 6d96a82ccd871524957bc4db9fa26c5471641a7e4c8690d0e29a06d1b959e8be00fc5f17e913b6fe910f458c7ed225aaac7b3a38ef5c9e1923ef61d9554905c8
+  data.tar.gz: 6a9917086e1bc39178c0a117c7bad59e248e172f3cd5a46b98d174891a8db535b848279a9cfbcb3cee74a429f9a682936a367b215a6f6c3c89dd54fc62d887ef

data/lib/VERSION

@@ -0,0 +1 @@
+1.0.199

data/lib/tencentcloud-sdk-common/client.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'uri'
+require 'json'
+require 'securerandom'
+require 'digest'
+
+module TencentCloud
+  module Common
+    # common client
+    class AbstractClient
+      include Log
+
+      def initialize(credential, region, api_version, api_endpoint, sdk_version, profile = nil)
+        raise TencentCloudSDKException.new('InvalidCredential', 'Credential is None or invalid') unless credential
+
+        @credential = credential
+        @region = region
+        @api_version = api_version
+        @endpoint = api_endpoint
+        @sdk_version = sdk_version
+        @profile = profile || ClientProfile.new
+        @request = ApiRequset.new(@profile.http_profile.scheme, endpoint, nil, @profile.http_profile.req_timeout, @profile.http_profile.proxy)
+      end
+
+      def send_request(action, params, options = {})
+        request_data = BaseRequest.new(@profile.http_profile.scheme, endpoint, @profile.http_profile.req_method, REQUEST_PATH)
+        build_req(action, params, request_data, options)
+        logger.debug("Request: [\n#{request_data.to_s}]") if @profile.debug
+        resp = @request.send_request(request_data)
+        logger.debug("Response: [\n#{resp.to_s}]") if @profile.debug
+        raise TencentCloudSDKException.new('ServerNetworkError', resp.data) if resp.code != '200'
+
+        resp.data
+      end
+
+      private
+
+      REQUEST_PATH = '/'
+      JSON_CONTENT = 'application/json'
+      MULTIPART_CONTENT = 'multipart/form-data'
+      FORM_URLENCODED_CONTENT = 'application/x-www-form-urlencoded'
+
+      def endpoint
+        @profile.http_profile.endpoint || @endpoint
+      end
+
+      def build_req(action, params, req, options = {})
+        if %w[HmacSHA1 HmacSHA256].include? @profile.sign_method
+          build_req_with_v1_signature(action, params, req)
+        elsif @profile.sign_method == 'TC3-HMAC-SHA256' || options['IsMultipart']
+          build_req_with_v3_signature(action, params, req, options)
+        else
+          raise TencentCloudSDKException.new('ClientError', 'Invalid signature method')
+        end
+      end
+
+      def build_req_with_v1_signature(action, params, req)
+        params = AbstractModel.format_params(nil, params)
+        params['Action'] = action
+        params['RequestClient'] = "SDK_RUBY_#{@sdk_version}"
+        params['Nonce'] = Random.rand(1..1 << 32)
+        params['Timestamp'] = Time.now.to_i
+        params['Version'] = @api_version
+        params['Region'] = @region
+        params['Token'] = @credential.token if @credential.token
+        params['SecretId'] = @credential.secret_id
+        params['SignatureMethod'] = @profile.sign_method
+        params['Language'] = @profile.language
+        params['Signature'] = Sign.sign_v1(@profile.http_profile.req_method, endpoint, req.uri,
+                                           params, @credential.secret_key, @profile.sign_method)
+        req.data = URI.encode_www_form(params)
+        req.header['Content-Type'] = FORM_URLENCODED_CONTENT
+      end
+
+      def build_req_with_v3_signature(action, params, req, options = {})
+        content_type = req.method == 'GET' ? FORM_URLENCODED_CONTENT : JSON_CONTENT
+        content_type = MULTIPART_CONTENT if options['IsMultipart']
+        timestamp = Time.now.to_i
+        req.header['Content-Type'] = content_type
+        req.header['Host'] = endpoint
+        req.header['X-TC-Action'] = action
+        req.header['X-TC-Timestamp'] = timestamp
+        req.header['X-TC-Version'] = @api_version
+        req.header['X-TC-Region'] = @region
+        req.header['X-TC-Language'] = @profile.language
+        req.header['X-TC-Token'] = @credential.token if @credential.token
+        req.header['X-TC-Content-SHA256'] = 'UNSIGNED-PAYLOAD' if @profile.unsigned_payload
+        if req.method == 'GET'
+          params = AbstractModel.format_params(nil, params)
+          req.data = URI.encode_www_form(params)
+          canonical_querystring = req.data
+          payload = ''
+        else
+          case content_type
+          when JSON_CONTENT
+            req.data = JSON.generate(params, { 'ascii_only' => true, 'space' => ' ' })
+          when MULTIPART_CONTENT
+            binparas = options['binparas'] || []
+            boundary = SecureRandom.hex
+            req.header['Content-Type'] += '; boundary=' + boundary
+            body = ''
+            params.each do |k, v|
+              body += "--#{boundary}\r\n"
+              body += "Content-Disposition: form-data; name=\"#{k}\""
+              if binparas.include? k
+                body += "; filename=\"File\"\r\n"
+              else
+                body += "\r\n"
+                if v.is_a?(Array) || v.is_a?(Hash)
+                  v = JSON.generate(v, { 'ascii_only' => true, 'space' => ' ' })
+                  body += "Content-Type: application/json\r\n"
+                end
+              end
+              body += "\r\n#{v}\r\n"
+            end
+            body += "--#{boundary}--\r\n" unless body.empty?
+            req.data = body
+            # req.is_multipart = options['IsMultipart']
+          else
+            raise TencentCloudSDKException.new('ContentTypeError', "Unsupported content type: #{content_type}")
+          end
+          payload = req.data
+          canonical_querystring = ''
+        end
+        payload = 'UNSIGNED-PAYLOAD' if @profile.unsigned_payload
+        hashed_payload = Digest::SHA256.hexdigest(payload)
+
+        authorization = Sign.sign_v3(content_type, endpoint, @profile.http_profile.req_method, req.uri,
+                                     canonical_querystring, hashed_payload, req.header['X-TC-Timestamp'],
+                                     @credential.secret_id, @credential.secret_key)
+        req.header['Authorization'] = authorization
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/credential.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TencentCloud
+  module Common
+    # common credential
+    class Credential
+      attr_accessor :secret_id, :secret_key, :token
+
+      def initialize(secret_id, secret_key, token = nil)
+        if secret_id.nil? || secret_id.strip.empty?
+          raise TencentCloudSDKException.new('InvalidCredential', 'secret id should not be none or empty')
+        elsif secret_id.strip != secret_id
+          raise TencentCloudSDKException.new('InvalidCredential', 'secret id should not contain spaces')
+        end
+
+        @secret_id = secret_id
+
+        if secret_key.nil? || secret_key.strip.empty?
+          raise TencentCloudSDKException.new('InvalidCredential', 'secret id should not be none or empty')
+        elsif secret_key.strip != secret_key
+          raise TencentCloudSDKException.new('InvalidCredential', 'secret id should not contain spaces')
+        end
+
+        @secret_key = secret_key
+        @token = token
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/exception.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TencentCloud
+  module Common
+    # TencentCloud exception
+    class TencentCloudSDKException < StandardError
+      attr_accessor :code, :message, :request_id
+
+      def initialize(code = nil, message = nil, request_id = nil)
+        @code = code
+        @message = message
+        @request_id = request_id
+      end
+
+      def to_s
+        "[TencentCloudSDKError] Code=#{@code}, Message=#{@message}, RequestId=#{@request_id}"
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/http/request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+
+module TencentCloud
+  module Common
+    # common http request class
+    class ApiRequset
+      def initialize(scheme, host, port = nil, timeout = 60, proxy = nil)
+        port = 443 if scheme == 'https'
+        if proxy.nil?
+          @conn = Net::HTTP.new(host, port)
+        else
+          p = URI(proxy)
+          @conn = Net::HTTP.new(host, port, p.host, p.port, p.user, p.pass)
+        end
+        @conn.use_ssl = scheme == 'https'
+        @conn.read_timeout = timeout
+      end
+
+      def send_request(request, keep_alive = false)
+        uri = URI("#{request.scheme}://#{request.host}#{request.uri}")
+        @conn.keep_alive_timeout = 20 if keep_alive
+        @conn.start do |http|
+          case request.method
+          when 'GET'
+            uri.query = request.data
+            req = Net::HTTP::Get.new uri
+          when 'POST'
+            req = Net::HTTP::Post.new uri
+            req.body = request.data
+          else
+            raise TencentCloudSDKException.new('ClientParamsError', 'Method only support (GET, POST)')
+          end
+          request.header.each do |k, v|
+            req[k] = v
+          end
+          resp = http.request req
+          BaseResponse.new(resp.code, resp.each_header.to_h, resp.read_body)
+        end
+      end
+    end
+
+    # base class of http request data
+    class BaseRequest
+      attr_accessor :scheme, :host, :method, :uri, :header, :data, :is_multipart
+
+      def initialize(scheme = '', host = '', method = '', uri = '', header = {}, data = nil)
+        @scheme = scheme
+        @host = host
+        @method = method
+        @uri = uri
+        @header = header
+        @data = data
+        @is_multipart = false
+      end
+
+      def to_s
+        s = "Host: #{@host}\nMethod: #{method}\nUri: #{@uri}\nHeader: \n"
+        @header ||= {}
+        @header.each do |k, v|
+          s += "#{k}: #{v}\n"
+        end
+        s += "Data: #{@data}\n"
+      end
+    end
+
+    # base class of http response data
+    class BaseResponse
+      attr_accessor :code, :header, :data
+
+      def initialize(code = 200, header = nil, data = "")
+        @code = code
+        @header = header
+        @data = data
+      end
+
+      def to_s
+        s = "Status: #{@code}\nHeader: \n"
+        @header ||= {}
+        @header.each do |k, v|
+          s += "#{k}: #{v}\n"
+        end
+        s += "Data: #{@data}\n"
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/log.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module TencentCloud
+  module Common
+    # common logger
+    module Log
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/models.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module TencentCloud
+  module Common
+    # common model
+    class AbstractModel
+      def serialize
+        flat(self)
+      end
+
+      def self.format_params(prefix = nil, params)
+        d = {}
+        case params
+        when Hash
+          params.each do |k, v|
+            key = prefix ? "#{prefix}.#{k}" : k.to_s
+            d.update(format_params(key, v))
+          end
+        when Array
+          params.each_with_index do |v, i|
+            key = prefix ? "#{prefix}.#{i}" : i.to_s
+            d.update(format_params(key, v))
+          end
+        else
+          d[prefix] = params
+        end
+        d
+      end
+
+      private
+
+      def flat(obj)
+        case obj
+        when AbstractModel
+          params = nil
+          keys = obj.instance_variables
+          keys.each do |k|
+            value = obj.instance_variable_get k
+            key = k.to_s.split('@').at 1
+            next unless value
+
+            r = flat(value)
+            unless r.nil?
+              params ||= {}
+              params[key] = r
+            end
+          end
+          params
+        when Array
+          arr = nil
+          obj.each do |v|
+            r = flat(v)
+            unless r.nil?
+              arr ||= []
+              arr << r
+            end
+          end
+          arr
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/profile/client_profile.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TencentCloud
+  module Common
+    # basic httpprofile
+    class ClientProfile
+      attr_accessor :http_profile, :sign_method, :language, :unsigned_payload, :debug
+
+      def initialize(sign_method = 'TC3-HMAC-SHA256', http_profile = nil,
+                     language = 'zh-CN', debug = false)
+        @sign_method = sign_method
+        @http_profile = http_profile || HttpProfile.new
+        valid_language = %w[zh-CN en-US]
+        unless valid_language.include? language
+          raise TencentCloudSDKException.new('ClientError', "Language invalid, choices: #{valid_language}")
+        end
+
+        @language = language
+        @debug = debug
+        @unsigned_payload = false
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/profile/http_profile.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TencentCloud
+  module Common
+    # basic httpprofile
+    class HttpProfile
+      attr_accessor :scheme, :endpoint, :req_method, :req_timeout, :keep_alive, :proxy
+
+      def initialize(scheme = 'https', endpoint = nil, req_method = 'POST',
+                     req_timeout = 60, keep_alive = false, proxy = nil)
+        @scheme = scheme
+        @endpoint = endpoint
+        @req_method = req_method
+        @req_timeout = req_timeout
+        @keep_alive = keep_alive
+        @proxy = proxy
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common/sign.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+
+module TencentCloud
+  module Common
+    # sign class
+    class Sign
+      class << self
+        def sign_v1(method, endpoint, path, data, secret_key, sign_method)
+          sign = method + endpoint + path + '?'
+          params = []
+          data.sort.each do |item|
+            params << "#{item[0]}=#{item[1]}"
+          end
+          sign += params.join('&')
+          case sign_method
+          when 'HmacSHA256'
+            digest = OpenSSL::Digest.new('sha256')
+          when 'HmacSHA1'
+            digest = OpenSSL::Digest.new('sha1')
+          else
+            raise TencentCloudSDKException.new('signMethod invalid', 'signMethod only support (HmacSHA1, HmacSHA256)')
+          end
+          Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, sign))
+        end
+
+        def sign_v3(content_type, endpoint, method, uri, query, payload, timestamp, secret_id, secret_key)
+          canonical_headers = "content-type:#{content_type}\nhost:#{endpoint}\n"
+          signed_headers = 'content-type;host'
+          canonical_request = [
+            method,
+            uri,
+            query,
+            canonical_headers,
+            signed_headers,
+            payload,
+          ].join("\n")
+          service = endpoint.split('.')[0]
+
+          date = Time.at(timestamp).utc.strftime('%Y-%m-%d')
+          credential_scope = date + '/' + service + '/' + 'tc3_request'
+          algorithm = 'TC3-HMAC-SHA256'
+          hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
+          string_to_sign = [
+            algorithm,
+            timestamp,
+            credential_scope,
+            hashed_request_payload,
+          ].join("\n")
+
+          digest = OpenSSL::Digest.new('sha256')
+          secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + secret_key, date)
+          secret_service = OpenSSL::HMAC.digest(digest, secret_date, service)
+          secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
+          signature = OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
+          "#{algorithm} Credential=#{secret_id}/#{credential_scope}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+        end
+      end
+    end
+  end
+end

data/lib/tencentcloud-sdk-common.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'tencentcloud-sdk-common/exception'
+require_relative 'tencentcloud-sdk-common/log'
+require_relative 'tencentcloud-sdk-common/profile/client_profile'
+require_relative 'tencentcloud-sdk-common/profile/http_profile'
+require_relative 'tencentcloud-sdk-common/credential'
+require_relative 'tencentcloud-sdk-common/models'
+require_relative 'tencentcloud-sdk-common/sign'
+require_relative 'tencentcloud-sdk-common/http/request'
+require_relative 'tencentcloud-sdk-common/client'
+
+module TencentCloud
+  # sdk common module
+  module Common
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: tencentcloud-sdk-common
+version: !ruby/object:Gem::Version
+  version: 1.0.199
+platform: ruby
+authors:
+- Tencent Cloud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies: []
+description: Tencent Cloud Ruby SDK is the official software development kit, which
+  allows Ruby developers to write software that makes use of Tencent Cloud service.
+email:
+- tencentcloudapi@tencent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/VERSION
+- lib/tencentcloud-sdk-common.rb
+- lib/tencentcloud-sdk-common/client.rb
+- lib/tencentcloud-sdk-common/credential.rb
+- lib/tencentcloud-sdk-common/exception.rb
+- lib/tencentcloud-sdk-common/http/request.rb
+- lib/tencentcloud-sdk-common/log.rb
+- lib/tencentcloud-sdk-common/models.rb
+- lib/tencentcloud-sdk-common/profile/client_profile.rb
+- lib/tencentcloud-sdk-common/profile/http_profile.rb
+- lib/tencentcloud-sdk-common/sign.rb
+homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/TencentCloud/tencentcloud-sdk-ruby/tencentcloud-sdk-common
+  changelog_uri: https://github.com/TencentCloud/tencentcloud-sdk-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Tencent Cloud SDK for Ruby - Common
+test_files: []