tencent-cloud 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 592a86b70523e7839dd5f9b7ae296f7878410f5d45cf7ee69bbb4c695d4dade6
+  data.tar.gz: 9758fc685b5851df00344fff725e2ff3f41dd199e27d409ab201f3b47c3cbb67
+SHA512:
+  metadata.gz: 6b8861cbedbc17b1bf2bc4c0370529b46401571c1b9727b11101dc310623f9cb4c694de13c90243dec722029bf02bc377b983d5736b8af5aec2e92fc0c4798dd
+  data.tar.gz: 1848d712eac278f0f9670ef30ee930add8751348cd2d2c7a8af6329e4a8c059b68a14d4da496068cf44c93b63b9a531ec7e58d648127359c2771707ad0f45534

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    tencent-cloud (0.0.1)
+      faraday (~> 1.0)
+      multi_json (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    listen (3.3.2)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
+    shellany (0.0.1)
+    thor (1.0.1)
+    webmock (3.10.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  guard (~> 2.0)
+  guard-rspec (~> 4.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.0)
+  tencent-cloud!
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2020 Ryan Wong <lazing@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Tencent::Cloud
+
+腾讯云 QCloud API 3.0 Ruby SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tencent-cloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tencent-cloud
+
+## Usage
+
+```ruby
+client = Tencent::Cloud::Client.new 'apguanzhou', 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******', 'Gu5t9xGARNpq86cd98joQYCN3*******', SmsSdkAppid: 1234567890
+client.switch_to 'cvm', 'cvm.tencentcloudapi.com' # 切换接口，设定服务和地址
+response_body = client.post(a: 1, b: 2) # 响应报文体解析为Hash
+client.post({a: 1, b: 2}, h1: 1, h2: 2) # 请求参数可以有两个：第一组Hash为报文体，第二组为头部
+
+client.send_sms ['+8613912312345'], 1, ['code'], 'sign' # 实现常用方法包装
+
+```
+
+### 常用方法
+
+#### SMS短信服务
+详细内容参考`Tencent::Cloud::Sms` 或 `sms_spec.rb`
+1. send_sms(numbers, template_id, params, sign = nil, **args)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dianping-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/tencent/cloud.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module Tencent
+  module Cloud
+
+    def self.logger
+      @@logger ||= defined?(Rails) ? Rails.logger : ::Logger.new(STDOUT)
+    end
+
+    def self.logger=(logger)
+      @@logger = logger
+    end
+  end
+end
+
+require 'tencent/cloud/client'
+require 'tencent/cloud/sms_api'

data/lib/tencent/cloud/client.rb

@@ -0,0 +1,174 @@
+require 'faraday'
+require 'digest'
+require 'openssl'
+
+module Tencent
+  module Cloud
+    #
+    # create tencent cloud api client. request need different instance
+    #
+    # > client = Tencent::Cloud.client.new 'region', 'secret_id', 'secret_key'
+    # > client.swith_to 'cvm', 'cvm.tencentcloudapi.com' # optional. for quick api call will use defualt
+    # > client.post json_text # text or hash, hash will use MultiJson.dump to convert
+    # 
+    class Client
+      attr_reader :host, :service, :secret_id, :secret_key, :region, :options
+
+      def initialize(region, secret_id, secret_key, **options)
+        @secret_id = secret_id
+        @region = region
+        @secret_key = secret_key
+        @options = options
+      end
+
+      def switch_to(service, host)
+        Cloud.logger.debug { {service: service, host: host} }
+        @service = service
+        @host = host
+      end
+
+      def connection
+        Faraday.new(url: "https://#{host}") do |conn|
+          conn.request :retry
+          # conn.request :url_encoded
+          conn.response :logger
+          conn.response :raise_error
+          conn.adapter :net_http
+        end
+      end
+
+      def post(body = nil, headers = nil)
+        yield(self) if block_given?
+        params = body.is_a?(Hash) ? MultiJson.dump(body) : body
+        Cloud.logger.debug { { body: body, headers: headers } }
+        res = connection.post('/', params, public_headers(body, headers))
+        json(res.body)
+      end
+
+      def method_missing(symbol, *args)
+        key = camel_case(symbol.to_s)
+        # pp key, ::Tencent::Cloud.constants, ::Tencent::Cloud.const_defined?(key)
+        super(symbol, *args) unless ::Tencent::Cloud.const_defined?(key)
+
+        Tencent::Cloud.const_get(key).new region, secret_id, secret_key, options
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.to_s.end_with?('_api') || super
+      end
+
+      def camel_case(key)
+        key.split('_').map(&:capitalize).join
+      end
+
+      def json(data)
+        return {} unless data && !data.empty?
+
+        MultiJson.load data, symbolize_keys: true
+      end
+
+      def public_headers(body, headers)
+        datus = (headers || {}).dup
+        datus.merge!(body) if body.is_a?(Hash)
+        {
+          'Authorization' => authorization(signature('POST', body)),
+          'Content-Type' => 'application/json; charset=utf-8', 'Host' => host,
+          'X-TC-Action' => datus[:Action], 'X-TC-Timestamp' => sign_timestamp,
+          'X-TC-Version' => datus[:Version], 'X-TC-Region' => region
+        }.merge!(headers || {})
+      end
+
+      def authorization(signature)
+        [
+          algorithm, ' ',
+          'Credential=', secret_id, '/', credential_scope, ', ',
+          'SignedHeaders=', signed_headers, ', ',
+          'Signature=', signature
+        ].join
+      end
+
+      def algorithm
+        'TC3-HMAC-SHA256'
+      end
+
+      def sign_version
+        'tc3_request'
+      end
+
+      def credential_scope
+        [sign_date, service, sign_version].join('/')
+      end
+
+      def canonical_headers
+        {
+          'content-type' => 'application/json; charset=utf-8',
+          'host' => host
+        }.map { |p| p.join(':') }.join("\n") + "\n"
+      end
+
+      def signed_headers
+        %w[content-type host].join(';')
+      end
+
+      def hashed_request_payload(request_payload)
+        request_payload = MultiJson.dump(request_payload) if request_payload.is_a?(Hash)
+        hash_sha256(request_payload)
+      end
+
+      def hashed_canonical_request(request_method, hashed_request_payload)
+        res = [
+          request_method, '/', '',
+          canonical_headers, signed_headers,
+          hashed_request_payload
+        ].join("\n")
+        hash_sha256(res)
+      end
+
+      def signature(request_method, request_payload)
+        hashed = hashed_request_payload(request_payload)
+        data = hashed_canonical_request(request_method, hashed)
+        content =
+          hmac_sha256(
+            secret_signing,
+            string_to_sign(data)
+          )
+        hex_encode(content)
+      end
+
+      def sign_date
+        sign_time.strftime '%F'
+      end
+
+      def sign_time
+        @sign_time ||= Time.now.getutc
+      end
+
+      def sign_timestamp
+        sign_time.to_i.to_s
+      end
+
+      def secret_signing
+        secret_date = hmac_sha256('TC3' + secret_key, sign_date) 
+        secret_service = hmac_sha256(secret_date, service)
+        hmac_sha256(secret_service, sign_version)
+      end
+
+      def string_to_sign(hashed_canonical_request)
+        timestamp = sign_timestamp
+        [algorithm, timestamp, credential_scope, hashed_canonical_request].join("\n")
+      end
+
+      def hex_encode(content)
+        Digest.hexencode content
+      end
+
+      def hash_sha256(data)
+        Digest::SHA256.hexdigest(data).downcase
+      end
+
+      def hmac_sha256(key, data)
+        OpenSSL::HMAC.digest('SHA256', key, data)
+      end
+    end
+  end
+end

data/lib/tencent/cloud/sms_api.rb

@@ -0,0 +1,39 @@
+module Tencent
+  module Cloud
+    class SmsApi < Client
+
+      def initialize(*args)
+        super(*args)
+        switch_to('sms', 'sms.tencentcloudapi.com')
+      end
+
+      ##
+      # Send SMS to client
+      #
+      # @param numbers [Array] client numbers in format +[country_code][number]
+      # @param template_id [String] sms template id
+      # @param params [Array] sms template params
+      # @param sign [String] optional for china local message
+      # @param args [Hash] other api parameters
+      def send_sms(numbers, template_id, params, sign = nil, **args)
+        headers = { Action: 'SendSms' }.merge(share_headers)
+        datus = {
+          PhoneNumberSet: numbers, TemplateID: template_id,
+          Sign: sign, TemplateParamSet: params
+        }
+        datus.merge!(args) if args
+        post(datus, headers)
+      end
+
+      def describe_sms_sign_list(list, international)
+        headers = { Action: 'DescribeSmsSignList' }.merge(share_headers)
+        datus = { SignIdSet: list, International: international }
+        post(datus, headers)
+      end
+
+      def share_headers
+        { Version: '2019-07-11', SmsSdkAppid: options[:SmsSdkAppid].to_s }
+      end
+    end
+  end
+end

data/lib/tencent/cloud/version.rb

@@ -0,0 +1,5 @@
+module Tencent
+  module Cloud
+    VERSION = '0.0.1'
+  end
+end

data/tencent-cloud.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'tencent/cloud/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'tencent-cloud'
+  s.version       = Tencent::Cloud::VERSION
+  s.authors       = ['Ryan Wong']
+  s.email         = ['lazing@gmail.com']
+  s.homepage      = 'https://github.com/lazing/tencent-cloud'
+  s.licenses      = ['MIT']
+  s.summary       = '[summary]'
+  s.description   = '[description]'
+
+  s.files         = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+
+  s.add_dependency 'faraday', '~> 1.0'
+  s.add_dependency 'multi_json', '~> 1.0'
+
+  s.add_development_dependency "bundler", "~> 1.17"
+  s.add_development_dependency "guard", "~> 2.0"
+  s.add_development_dependency "guard-rspec", "~> 4.0"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-its", "~> 1.0"
+  s.add_development_dependency 'webmock', "~> 3.0"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: tencent-cloud
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Wong
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "[description]"
+email:
+- lazing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
+- README.md
+- lib/tencent/cloud.rb
+- lib/tencent/cloud/client.rb
+- lib/tencent/cloud/sms_api.rb
+- lib/tencent/cloud/version.rb
+- tencent-cloud.gemspec
+homepage: https://github.com/lazing/tencent-cloud
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: "[summary]"
+test_files: []