aliyun-rails 0.1.13 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54b953cc3442bb86cdfccfb2fe1cd80f7237280f67384588d27effb11cadb580
-  data.tar.gz: 17e808edae1fac737e133b2fecf62a6b4923cc21490a5c4bf83547b261dd0be9
+  metadata.gz: 3240b73e02b5bf35dfa310205d8dae87e0850fdd55a89f61ffd3ede196b4dd2f
+  data.tar.gz: 1b547158d62ab63a243c32e4e4b53b7aa793f29373857585a7e24f1b989e688a
 SHA512:
-  metadata.gz: c6642a259e9b175b99a97b7acf03c2931a3ff02a01b03e01118a20cec4f51ac20b5bd250ab1c821fa41103ea78f379d476416b32438dd5fc7c28c2b1a1c9b598
-  data.tar.gz: 3aa40ca9000cdc6b2ca7618f25d9e2742c99048d8d496f41fd3715ed678f3fb47de60168518facb66d18ebbb90749cd13dc316e1f8deb21188a94265491f60cc
+  metadata.gz: 17a9fe79cb951e258a942b1e429ae99d28ca94a8d5b36b7e6df3e3f0a179f1d565c9fa7d5c0f7f88e9323e44810fdf1fe3ec9cca42a26528e9d7116d0a6978f4
+  data.tar.gz: ae4449f0facadcecb91d5f752b9129eb3c3f0ac527c1d04d601e0008d39041b718dd58c062560ebc342ebba2c069e550229717e707526cc52a986628d7b386d5

data/README.md

@@ -5,23 +5,25 @@
 <a href=" https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/Aliyun.svg"></a>
 </p>
 
-<h1 align="center">非官方SDK套件-用于RAILS项目管理阿里云资源</h1>
+<h1 align="center">非官方SDK套件-用于RAILS项目管理阿里云相关资源，已集成接口鉴权、短信服务、和语音服务功能</h1>
 
 <p align="center">
-<a href="https://badge.fury.io/rb/aliyunsdkcore"><img src="https://badge.fury.io/rb/aliyunsdkcore.svg" alt="Gem Version"></a>
-<a href="https://travis-ci.org/aliyun/openapi-core-ruby-sdk"><img src="https://travis-ci.org/aliyun/openapi-core-ruby-sdk.svg?branch=master" alt="Build Status"></a>
-<a href="https://ci.appveyor.com/project/aliyun/openapi-core-ruby-sdk/branch/master"><img src="https://ci.appveyor.com/api/projects/status/uyepkk5bjbynofvu/branch/master?svg=true" alt="Build status"></a>
-<a href="https://codecov.io/gh/aliyun/openapi-core-ruby-sdk"><img src="https://codecov.io/gh/aliyun/openapi-core-ruby-sdk/branch/master/graph/badge.svg" alt="codecov"></a>
+<a href="https://badge.fury.io/rb/aliyun-rails"><img src="https://badge.fury.io/rb/aliyun-rails.svg" alt="Gem Version"></a>
+<a href="https://travis-ci.org/ciscolive/aliyun-rails"><img src="https://travis-ci.org/ciscolive/aliyun-rails.svg?branch=master" alt="Build Status"></a>
+<a href="https://ci.appveyor.com/project/ciscolive/aliyun-rails/branch/master"><img src="https://ci.appveyor.com/api/projects/status/uyepkk5bjbynofvu/branch/master?svg=true" alt="Build status"></a>
+<a href="https://codecov.io/gh/ciscolive/aliyun-rails"><img src="https://codecov.io/gh/ciscolive/aliyun-rails/branch/master/graph/badge.svg" alt="codecov"></a>
 </p>
 
 
-支持 Rails 轻松访问阿里云服务，例如：弹性云主机（ECS）、负载均衡（SLB）、云监控（CloudMonitor）等。当前已集成短信服务、语音服务功能，后续可以根据业务需要拓展。
+- 支持 Rails 轻松访问阿里云服务，例如：弹性云主机（ECS）、负载均衡（SLB）、云监控（CloudMonitor）等。
+- 已集成阿里云短信服务和语音服务，满足日常短信和电话告警需求。
 
 本文档介绍如何安装和使用 aliyun-rails
-本项目是个人用于集成阿里云短信推送、电话告警功能编排，部分代码借鉴自官方 openapi-core-ruby-sdk
 
 ## 使用诊断
-[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) 提供 OpenAPI 使用诊断服务，通过 `RequestID` 或 `报错信息` ，帮助开发者快速定位，为开发者提供解决方案。
+
+[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) 提供 OpenAPI 使用诊断服务，通过 `RequestID` 或 `报错信息`
+，帮助开发者快速定位，为开发者提供解决方案。
 
 ## 安装
 
@@ -31,36 +33,90 @@ $ gem install aliyun-rails
 
 ## 使用
 
-RPC 示例；
+- 加载模块自动挂载几个常量：Dysms、Dyvms、RPCClient和ROAClient
+
+CALL_TTS 实例：
+
+```ruby
+require "aliyun-rails"
+
+client = Aliyun::Dyvms.new(
+  access_key_id:     ENV['ACCESS_KEY_ID'],
+  access_key_secret: ENV['ACCESS_KEY_SECRET'],
+)
+
+# 可以直接将API参数放到RAILS项目 * config/initializers *下
+# Aliyun.config do |aliyun|
+#   aliyun.access_key_id = "XXX"
+#   aliyun.access_key_secret = "YYY"
+# end
+# 随后直接初始化
+# client = Aliyun::Dyvms.new
+
+# 调用语音方法 single_call_by_tts method
+response = client.single_call_by_tts("075566668888", "13900001234", "TTS_CODE", { TTS_PARAM: 2022 })
+
+puts response
+
+```
+
+SEND_SMS 示例：
 
 ```ruby
 require "aliyun-rails"
 
-client = Dysms.new(
+client = Aliyun::Dysms.new(
   access_key_id:     ENV['ACCESS_KEY_ID'],
   access_key_secret: ENV['ACCESS_KEY_SECRET'],
 )
 
-# 可以直接将API参数放到 initializers下
-# Aliyun::Rails.config do |i|
-# i.access_key_id = "XXX"
-# i.access_key_secret = "YYYY"
+# 可以直接将API参数放到RAILS项目 * config/initializers *下
+# Aliyun.config do |aliyun|
+#   aliyun.access_key_id = "XXX"
+#   aliyun.access_key_secret = "YYY"
 # end
 # 随后直接初始化
 # client = Dysms.new
 
-# then use the send_sms method
-response = client.send_sms("1380000000", "SMS_10010", {param1: "11"}, "SIGN_NAME")
+# 调用短信方法 send_sms method
+response = client.send_sms("1380000000", "SMS_10010", { param1: "11" }, "SIGN_NAME")
 
 puts response
 ```
 
+RPC 示例：
+
+```ruby
+require 'aliyun-rails'
+
+# 实例化对象
+client = RPCClient.new(
+  endpoint:          'http://ros.aliyuncs.com',
+  api_version:       '2015-09-01',
+  access_key_id:     ENV['ACCESS_KEY_ID'],
+  access_key_secret: ENV['ACCESS_KEY_SECRET'],
+  security_token:    'TOKEN_KEY'
+)
+
+# 请求接口查询
+params         = { key: (1..11).to_a.map(&:to_s) }
+request_option = { method: 'POST', timeout: 15000 }
+response       = client.request(
+  action: 'DescribeRegions',
+  params: params,
+  opts:   request_option
+)
+
+puts response
+
+```
 
 ROA 示例：
 
 ```ruby
 require 'aliyun-rails'
 
+# 初始化对象
 client = ROAClient.new(
   endpoint:          'http://ros.aliyuncs.com',
   api_version:       '2015-09-01',
@@ -68,28 +124,30 @@ client = ROAClient.new(
   access_key_secret: ENV['ACCESS_KEY_SECRET'],
 )
 
+# 请求接口查询
 response = client.request(
-  method: 'GET',
-  uri: '/regions',
+  method:  'GET',
+  uri:     '/regions',
   options: {
     timeout: 15000
   }
 )
 
-print response.body
+puts response.body
 ```
 
 ## 问题
-[提交 Issue](https://github.com/ciscolive/aliyun-rails/issues/new/choose)，不符合指南的问题可能会立即关闭。
 
+[提交 Issue](https://github.com/ciscolive/aliyun-rails/issues/new/choose)，不符合指南的问题可能会立即关闭。
 
 ## 发行说明
-每个版本的详细更改记录在[发行说明](CHANGELOG.md)中。
 
+每个版本的详细更改记录在[发行说明](CHANGELOG.md)中。
 
 ## 贡献
-提交 Pull Request 之前请阅读[贡献指南](CONTRIBUTING.md)。
 
+提交 Pull Request 之前请阅读[贡献指南](CONTRIBUTING.md)。
 
 ## 许可证
-[MIT](LICENSE.md)
+
+[MIT](LICENSE.txt)

data/lib/aliyun/connector/roa_client.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "securerandom"
+require "active_support/all"
+require "net/http"
+
+module Net::HTTPHeader
+  def capitalize(name)
+    name
+  end
+  private :capitalize
+end
+
+module Aliyun
+  module Connector
+    class ROAClient
+      attr_accessor :endpoint, :api_version, :access_key_id,
+                    :access_key_secret, :security_token, :hostname, :opts
+
+      def initialize(config)
+        validate config
+
+        self.endpoint          = config[:endpoint]
+        self.api_version       = config[:api_version]
+        self.access_key_id     = config[:access_key_id] || Aliyun.access_key_id
+        self.access_key_secret = config[:access_key_secret] || Aliyun.access_key_secret
+        self.security_token    = config[:security_token]
+      end
+
+      def request(method:, uri:, params: {}, body: {}, headers: {}, options: {})
+        # :"Content-Type" => "application/json" to "content-type" => "application/json"
+        headers.deep_transform_keys! { |key| key.to_s.downcase }
+        mix_headers = default_headers.merge(headers)
+
+        response = connection.send(method.downcase) do |request|
+          request.url uri, params
+          if body
+            if mix_headers["content-type"].start_with? "application/json"
+              request_body = body.to_json
+            elsif mix_headers["content-type"].start_with? "application/x-www-form-urlencoded"
+              request_body = URI.encode_www_form(body)
+            else
+              request_body = body
+            end
+            mix_headers["content-md5"]    = Digest::MD5.base64digest request_body
+            mix_headers["content-length"] = request_body.length.to_s
+            request.body                  = request_body
+          end
+          string2sign                 = string_to_sign(method, uri, mix_headers, params)
+          mix_headers[:authorization] = authorization(string2sign)
+          mix_headers.each { |key, value| request.headers[key] = value }
+        end
+
+        return response if options.has_key? :raw_body
+
+        response_content_type = response.headers["Content-Type"] || ""
+        if response_content_type.start_with?("application/json")
+          if response.status >= 400
+            result = JSON.parse(response.body)
+            raise StandardError, "code: #{response.status}, #{result['Message']} requestid: #{result['RequestId']}"
+          end
+        end
+
+        if response_content_type.start_with?("text/xml")
+          result = Hash.from_xml(response.body)
+          raise ACSError, result["Error"] if result["Error"]
+        end
+
+        response
+      end
+
+      def connection(adapter = Faraday.default_adapter)
+        Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
+      end
+
+      def get(uri: "", headers: {}, params: {}, options: {})
+        request(method: :get, uri: uri, params: params, body: {}, headers: headers, options: options)
+      end
+
+      def post(uri: "", headers: {}, params: {}, body: {}, options: {})
+        request(method: :post, uri: uri, params: params, body: body, headers: headers, options: options)
+      end
+
+      def put(uri: "", headers: {}, params: {}, body: {}, options: {})
+        request(method: :put, uri: uri, params: params, body: body, headers: headers, options: options)
+      end
+
+      def delete(uri: "", headers: {}, params: {}, options: {})
+        request(method: :delete, uri: uri, params: params, body: {}, headers: headers, options: options)
+      end
+
+      def default_headers
+        default_headers = {
+          "accept"                  => "application/json",
+          "date"                    => Time.now.httpdate,
+          "host"                    => URI(self.endpoint).host,
+          "x-acs-signature-nonce"   => SecureRandom.hex(16),
+          "x-acs-signature-method"  => "HMAC-SHA1",
+          "x-acs-signature-version" => "1.0",
+          "x-acs-version"           => self.api_version,
+          "x-sdk-client"            => "RUBY(#{RUBY_VERSION})", # FIXME: 如何获取Gem的名称和版本号
+          "user-agent" => DEFAULT_UA
+        }
+        if self.security_token
+          default_headers["x-acs-accesskey-id"]   = self.access_key_id
+          default_headers["x-acs-security-token"] = self.security_token
+        end
+        default_headers
+      end
+
+      private
+        def string_to_sign(method, uri, headers, query = {})
+          header_string = [
+            method,
+            headers["accept"],
+            headers["content-md5"] || "",
+            headers["content-type"] || "",
+            headers["date"],
+          ].join("\n")
+          "#{header_string}\n#{canonicalized_headers(headers)}#{canonicalized_resource(uri, query)}"
+        end
+
+        def canonicalized_headers(headers)
+          headers.keys.select { |key| key.to_s.start_with? "x-acs-" }
+                 .sort.map { |key| "#{key}:#{headers[key].strip}\n" }.join
+        end
+
+        def canonicalized_resource(uri, query_hash = {})
+          query_string = query_hash.sort.map { |key, value| "#{key}=#{value}" }.join("&")
+          query_string.empty? ? uri : "#{uri}?#{query_string}"
+        end
+
+        def authorization(string_to_sign)
+          "acs #{self.access_key_id}:#{signature(string_to_sign)}"
+        end
+
+        def signature(string_to_sign)
+          Base64.encode64(OpenSSL::HMAC.digest("sha1", self.access_key_secret, string_to_sign)).strip
+        end
+
+        def validate(config)
+          raise ArgumentError, 'must pass "config"' unless config
+          raise ArgumentError, 'must pass "config[:endpoint]"' unless config[:endpoint]
+          unless config[:endpoint].start_with?("http://") || config[:endpoint].start_with?("https://")
+            raise ArgumentError, '"config.endpoint" must starts with \'https://\' or \'http://\'.'
+          end
+          raise ArgumentError, 'must pass "config[:api_version]"' unless config[:api_version]
+          raise ArgumentError, 'must pass "config[:access_key_id]"' unless config[:access_key_id]
+          raise ArgumentError, 'must pass "config[:access_key_secret]"' unless config[:access_key_secret]
+        end
+
+        class ACSError < StandardError
+          attr_accessor :code
+
+          def initialize(error)
+            self.code  = error["Code"]
+            message    = error["Message"]
+            host_id    = error["HostId"]
+            request_id = error["RequestId"]
+            super("#{message} host_id: #{host_id}, request_id: #{request_id}")
+          end
+        end
+    end
+  end
+end

data/lib/aliyun/connector/rpc_client.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "set"
+require "openssl"
+require "faraday"
+require "erb"
+require "active_support/all"
+
+module Aliyun
+  module Connector
+    class RPCClient
+      attr_accessor :endpoint, :api_version, :access_key_id, :access_key_secret,
+                    :security_token, :codes, :opts, :verbose
+
+      # 对象初始化属性
+      def initialize(config = {}, verbose = false)
+        validate config
+
+        self.endpoint          = config[:endpoint]
+        self.api_version       = config[:api_version]
+        self.access_key_id     = config[:access_key_id] || Aliyun.access_key_id
+        self.access_key_secret = config[:access_key_secret] || Aliyun.access_key_secret
+        self.security_token    = config[:security_token]
+        self.opts              = config[:opts] || {}
+        self.verbose           = verbose.instance_of?(TrueClass) && verbose
+
+        self.codes = Set.new [200, "200", "OK", "Success"]
+        self.codes.merge config[:codes] if config[:codes]
+      end
+
+      # 通用请求接口
+      def request(action:, params: {}, opts: {})
+        opts                = self.opts.merge(opts)
+        action              = action.upcase_first if opts[:format_action]
+        params              = format_params(params) unless opts[:format_params]
+        defaults            = default_params
+        params              = { Action: action }.merge(defaults).merge(params)
+        method              = (opts[:method] || "GET").upcase
+        sign                = "#{method}&#{encode('/')}&#{encode(params.to_query)}"
+        secret              = "#{self.access_key_secret}&"
+        signature           = Base64.encode64(OpenSSL::HMAC.digest("sha1", secret, sign)).strip
+        params["Signature"] = signature
+
+        # 转换为 query 样式
+        query_string = params.to_query
+
+        # 特殊处理 POST
+        uri = opts[:method] == "POST" ? "/" : "/?#{query_string}"
+
+        # 初始化会话
+        response = connection.send(method.downcase, uri) do |r|
+          if opts[:method] == "POST"
+            r.headers["Content-Type"] = "application/x-www-form-urlencoded"
+            r.body                    = query_string
+          end
+          r.headers["User-Agent"] = DEFAULT_UA
+        end
+
+        # 解析接口响应
+        response_body = JSON.parse(response.body)
+        if response_body["Code"] && !response_body["Code"].to_s.empty? && !self.codes.include?(response_body["Code"])
+          raise StandardError, "Code: #{response_body['Code']}, Message: #{response_body['Message']}, URL: #{uri}"
+        end
+
+        response_body
+      end
+
+      private
+        def connection(adapter = Faraday.default_adapter)
+          Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
+        end
+
+        # 设置缺省参数
+        def default_params
+          params                 = {
+            Format:           "JSON",
+            SignatureMethod:  "HMAC-SHA1",
+            SignatureNonce:   SecureRandom.hex(8),
+            SignatureVersion: "1.0",
+            Timestamp:        Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+            AccessKeyId:      self.access_key_id,
+            Version:          self.api_version,
+          }
+          params[:SecurityToken] = self.security_token if self.security_token.present?
+          params
+        end
+
+        # 消息签名需要
+        def encode(input)
+          ERB::Util.url_encode input
+        end
+
+        # 转换 HASH key 样式
+        def format_params(param_hash)
+          param_hash.keys.each { |key| param_hash[(key.to_s.upcase_first).to_sym] = param_hash.delete key }
+          param_hash
+        end
+
+        def validate(config = {})
+          config.with_indifferent_access
+          raise ArgumentError, 'must pass "config"' unless config
+          raise ArgumentError, 'must pass "config[:endpoint]"' unless config[:endpoint]
+          unless config[:endpoint].match?(/^http[s]?:/i)
+            raise ArgumentError, '"config.endpoint" must starts with \'https://\' or \'http://\'.'
+          end
+          raise ArgumentError, 'must pass "config[:api_version]"' unless config[:api_version]
+          unless config[:access_key_id] || Aliyun.access_key_id
+            raise ArgumentError, 'must pass "config[:access_key_id]" or define "Aliyun.access_key_id"'
+          end
+          unless config[:access_key_secret] || Aliyun.access_key_secret
+            raise ArgumentError, 'must pass "config[:access_key_secret]" or define "Aliyun.access_key_secret"'
+          end
+        end
+    end
+  end
+end

data/lib/aliyun/dysms.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aliyun
+  class Dysms < Aliyun::Connector::RPCClient
+    # 本产品（Dysmsapi/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。
+    # 我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。
+    def initialize(config = {}, verbose = nil)
+      config[:endpoint]    ||= "http://dysmsapi.aliyuncs.com"
+      config[:api_version] ||= "2017-05-25"
+      super(config, verbose)
+    end
+
+    # 发送短信，发送前要申请短信签名和短信模板，并确保签名和模板已审核通过。
+    def send_sms(phone_numbers, template_code, template_param, sign_name = "")
+      params = {
+        PhoneNumbers:  phone_numbers,
+        SignName:      sign_name,
+        TemplateCode:  template_code,
+        TemplateParam: template_param.to_json
+      }
+      opts   = { method: "POST", timeout: 15000 }
+      request(action: "SendSms", params: params, opts: opts)
+    end
+  end
+end

data/lib/aliyun/dyvms.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Aliyun
+  class Dyvms < Aliyun::Connector::RPCClient
+    # 本产品（Dyvmsapi/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。
+    # 我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。
+    def initialize(config = {}, verbose = nil)
+      config[:endpoint]    ||= "http://dyvmsapi.aliyuncs.com"
+      config[:api_version] ||= "2017-05-25"
+      super(config, verbose)
+    end
+
+    # 调用SingleCallByTts接口向指定号码发送语音验证码和带参数变量的语音通知
+    def single_call_by_tts(called_show_number, called_number, tts_code, tts_param)
+      params = {
+        CalledShowNumber: called_show_number,
+        CalledNumber:     called_number,
+        TtsCode:          tts_code,
+        TtsParam:         tts_param.to_json
+      }
+      opts   = { method: "POST", timeout: 15000 }
+      request(action: "SendSms", params: params, opts: opts)
+    end
+  end
+end

data/lib/aliyun/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Aliyun
+  VERSION    = "0.1.16"
+  DEFAULT_UA = "AlibabaCloud (#{Gem::Platform.local.os}; " +
+    "#{Gem::Platform.local.cpu}) Ruby/#{RUBY_VERSION} Core/#{VERSION}"
+end

data/lib/aliyun-rails.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "aliyun/version"
+require_relative "aliyun/connector/roa_client"
+require_relative "aliyun/connector/rpc_client"
+require_relative "aliyun/dysms"
+require_relative "aliyun/dyvms"
+
+module Aliyun
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :access_key_id, :access_key_secret
+    def config
+      yield self
+    end
+  end
+
+  # Your code goes here...
+end
+
+# 加载模块，自动初始化的常量
+RPCClient = Aliyun::Connector::RPCClient
+ROAClient = Aliyun::Connector::ROAClient
+Dysms     = Aliyun::Dysms
+Dyvms     = Aliyun::Dyvms

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.16
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.4
-description: 支持 Rails 轻松访问阿里云服务，例如：弹性云主机（ECS）、负载均衡（SLB）、云监控（CloudMonitor）等
+description: 支持 Rails 轻松访问阿里云服务，例如：弹性云主机（ECS）、负载均衡（SLB）、云监控（CloudMonitor）等。当前已支持短信服务、语音服务，可以直接调用！
 email:
 - careline@foxmail.com
 executables: []
@@ -47,19 +47,19 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- lib/aliyun/rails.rb
-- lib/aliyun/rails/connector/roa_client.rb
-- lib/aliyun/rails/connector/rpc_client.rb
-- lib/aliyun/rails/dysms.rb
-- lib/aliyun/rails/dyvms.rb
-- lib/aliyun/rails/version.rb
+- lib/aliyun-rails.rb
+- lib/aliyun/connector/roa_client.rb
+- lib/aliyun/connector/rpc_client.rb
+- lib/aliyun/dysms.rb
+- lib/aliyun/dyvms.rb
+- lib/aliyun/version.rb
 homepage: https://github.com/ciscolive/aliyun-rails
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ciscolive/aliyun-rails
   source_code_uri: https://github.com/ciscolive/aliyun-rails
-  changelog_uri: https://github.com/ciscolive/aliyun-rails/blob/main/README.md
+  changelog_uri: https://github.com/ciscolive/aliyun-rails/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/aliyun/rails/connector/roa_client.rb

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-require "faraday"
-require "securerandom"
-require "active_support/all"
-require "net/http"
-
-module Net::HTTPHeader
-  def capitalize(name)
-    name
-  end
-  private :capitalize
-end
-
-module Aliyun
-  module Rails
-    module Connector
-      class ROAClient
-        attr_accessor :endpoint, :api_version, :access_key_id,
-                      :access_key_secret, :security_token, :hostname, :opts
-
-        def initialize(config)
-          validate config
-
-          self.endpoint          = config[:endpoint]
-          self.api_version       = config[:api_version]
-          self.access_key_id     = config[:access_key_id]
-          self.access_key_secret = config[:access_key_secret]
-          self.security_token    = config[:security_token]
-        end
-
-        def request(method:, uri:, params: {}, body: {}, headers: {}, options: {})
-          # :"Content-Type" => "application/json" to "content-type" => "application/json"
-          headers.deep_transform_keys! { |key| key.to_s.downcase }
-          mix_headers = default_headers.merge(headers)
-
-          response = connection.send(method.downcase) do |request|
-            request.url uri, params
-            if body
-              if mix_headers["content-type"].start_with? "application/json"
-                request_body = body.to_json
-              elsif mix_headers["content-type"].start_with? "application/x-www-form-urlencoded"
-                request_body = URI.encode_www_form(body)
-              else
-                request_body = body
-              end
-              mix_headers["content-md5"]    = Digest::MD5.base64digest request_body
-              mix_headers["content-length"] = request_body.length.to_s
-              request.body                  = request_body
-            end
-            string2sign                 = string_to_sign(method, uri, mix_headers, params)
-            mix_headers[:authorization] = authorization(string2sign)
-            mix_headers.each { |key, value| request.headers[key] = value }
-          end
-
-          return response if options.has_key? :raw_body
-
-          response_content_type = response.headers["Content-Type"] || ""
-          if response_content_type.start_with?("application/json")
-            if response.status >= 400
-              result = JSON.parse(response.body)
-              raise StandardError, "code: #{response.status}, #{result['Message']} requestid: #{result['RequestId']}"
-            end
-          end
-
-          if response_content_type.start_with?("text/xml")
-            result = Hash.from_xml(response.body)
-            raise ACSError, result["Error"] if result["Error"]
-          end
-
-          response
-        end
-
-        def connection(adapter = Faraday.default_adapter)
-          Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
-        end
-
-        def get(uri: "", headers: {}, params: {}, options: {})
-          request(method: :get, uri: uri, params: params, body: {}, headers: headers, options: options)
-        end
-
-        def post(uri: "", headers: {}, params: {}, body: {}, options: {})
-          request(method: :post, uri: uri, params: params, body: body, headers: headers, options: options)
-        end
-
-        def put(uri: "", headers: {}, params: {}, body: {}, options: {})
-          request(method: :put, uri: uri, params: params, body: body, headers: headers, options: options)
-        end
-
-        def delete(uri: "", headers: {}, params: {}, options: {})
-          request(method: :delete, uri: uri, params: params, body: {}, headers: headers, options: options)
-        end
-
-        def default_headers
-          default_headers = {
-            "accept"                  => "application/json",
-            "date"                    => Time.now.httpdate,
-            "host"                    => URI(self.endpoint).host,
-            "x-acs-signature-nonce"   => SecureRandom.hex(16),
-            "x-acs-signature-method"  => "HMAC-SHA1",
-            "x-acs-signature-version" => "1.0",
-            "x-acs-version"           => self.api_version,
-            "x-sdk-client"            => "RUBY(#{RUBY_VERSION})", # FIXME: 如何获取Gem的名称和版本号
-            "user-agent" => DEFAULT_UA
-          }
-          if self.security_token
-            default_headers["x-acs-accesskey-id"]   = self.access_key_id
-            default_headers["x-acs-security-token"] = self.security_token
-          end
-          default_headers
-        end
-
-        private
-          def string_to_sign(method, uri, headers, query = {})
-            header_string = [
-              method,
-              headers["accept"],
-              headers["content-md5"] || "",
-              headers["content-type"] || "",
-              headers["date"],
-            ].join("\n")
-            "#{header_string}\n#{canonicalized_headers(headers)}#{canonicalized_resource(uri, query)}"
-          end
-
-          def canonicalized_headers(headers)
-            headers.keys.select { |key| key.to_s.start_with? "x-acs-" }
-                   .sort.map { |key| "#{key}:#{headers[key].strip}\n" }.join
-          end
-
-          def canonicalized_resource(uri, query_hash = {})
-            query_string = query_hash.sort.map { |key, value| "#{key}=#{value}" }.join("&")
-            query_string.empty? ? uri : "#{uri}?#{query_string}"
-          end
-
-          def authorization(string_to_sign)
-            "acs #{self.access_key_id}:#{signature(string_to_sign)}"
-          end
-
-          def signature(string_to_sign)
-            Base64.encode64(OpenSSL::HMAC.digest("sha1", self.access_key_secret, string_to_sign)).strip
-          end
-
-          def validate(config)
-            raise ArgumentError, 'must pass "config"' unless config
-            raise ArgumentError, 'must pass "config[:endpoint]"' unless config[:endpoint]
-            unless config[:endpoint].start_with?("http://") || config[:endpoint].start_with?("https://")
-              raise ArgumentError, '"config.endpoint" must starts with \'https://\' or \'http://\'.'
-            end
-            raise ArgumentError, 'must pass "config[:api_version]"' unless config[:api_version]
-            raise ArgumentError, 'must pass "config[:access_key_id]"' unless config[:access_key_id]
-            raise ArgumentError, 'must pass "config[:access_key_secret]"' unless config[:access_key_secret]
-          end
-
-          class ACSError < StandardError
-            attr_accessor :code
-
-            def initialize(error)
-              self.code  = error["Code"]
-              message    = error["Message"]
-              host_id    = error["HostId"]
-              request_id = error["RequestId"]
-              super("#{message} host_id: #{host_id}, request_id: #{request_id}")
-            end
-          end
-      end
-    end
-  end
-end

data/lib/aliyun/rails/connector/rpc_client.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require "set"
-require "openssl"
-require "faraday"
-require "erb"
-require "active_support/all"
-
-module Aliyun
-  module Rails
-    module Connector
-      class RPCClient
-        attr_accessor :endpoint, :api_version, :access_key_id, :access_key_secret,
-                      :security_token, :codes, :opts, :verbose
-
-        # 对象初始化属性
-        def initialize(config = {}, verbose = false)
-          validate config
-
-          self.endpoint          = config[:endpoint]
-          self.api_version       = config[:api_version]
-          self.access_key_id     = config[:access_key_id] || Aliyun::Rails.access_key_id
-          self.access_key_secret = config[:access_key_secret] || Aliyun::Rails.access_key_secret
-          self.security_token    = config[:security_token]
-          self.opts              = config[:opts] || {}
-          self.verbose           = verbose.instance_of?(TrueClass) && verbose
-          self.codes             = Set.new [200, "200", "OK", "Success"]
-          self.codes.merge config[:codes] if config[:codes]
-        end
-
-        # 通用请求接口
-        def request(action:, params: {}, opts: {})
-          opts                = self.opts.merge(opts)
-          action              = action.upcase_first if opts[:format_action]
-          params              = format_params(params) unless opts[:format_params]
-          defaults            = default_params
-          params              = { Action: action }.merge(defaults).merge(params)
-          method              = (opts[:method] || "GET").upcase
-          sign                = "#{method}&#{encode('/')}&#{encode(params.to_query)}"
-          secret              = "#{self.access_key_secret}&"
-          signature           = Base64.encode64(OpenSSL::HMAC.digest("sha1", secret, sign)).strip
-          params["Signature"] = signature
-
-          # 转换为 query 样式
-          query_string = params.to_query
-
-          # 特殊处理 POST
-          uri = opts[:method] == "POST" ? "/" : "/?#{query_string}"
-
-          # 初始化会话
-          response = connection.send(method.downcase, uri) do |r|
-            if opts[:method] == "POST"
-              r.headers["Content-Type"] = "application/x-www-form-urlencoded"
-              r.body                    = query_string
-            end
-            r.headers["User-Agent"] = DEFAULT_UA
-          end
-
-          # 解析接口响应
-          response_body = JSON.parse(response.body)
-          if response_body["Code"] && !response_body["Code"].to_s.empty? && !self.codes.include?(response_body["Code"])
-            raise StandardError, "Code: #{response_body['Code']}, Message: #{response_body['Message']}, URL: #{uri}"
-          end
-
-          response_body
-        end
-
-        private
-          def connection(adapter = Faraday.default_adapter)
-            Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
-          end
-
-          # 设置缺省参数
-          def default_params
-            params                 = {
-              Format:           "JSON",
-              SignatureMethod:  "HMAC-SHA1",
-              SignatureNonce:   SecureRandom.hex(8),
-              SignatureVersion: "1.0",
-              Timestamp:        Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
-              AccessKeyId:      self.access_key_id,
-              Version:          self.api_version,
-            }
-            params[:SecurityToken] = self.security_token if self.security_token.present?
-            params
-          end
-
-          # 消息签名需要
-          def encode(input)
-            ERB::Util.url_encode input
-          end
-
-          # 转换 HASH key 样式
-          def format_params(param_hash)
-            param_hash.keys.each { |key| param_hash[(key.to_s.upcase_first).to_sym] = param_hash.delete key }
-            param_hash
-          end
-
-          def validate(config)
-            config.with_indifferent_access
-            raise ArgumentError, 'must pass "config"' unless config
-            raise ArgumentError, 'must pass "config[:endpoint]"' unless config[:endpoint]
-            unless config[:endpoint].match?(/^http[s]?:/i)
-              raise ArgumentError, '"config.endpoint" must starts with \'https://\' or \'http://\'.'
-            end
-            raise ArgumentError, 'must pass "config[:api_version]"' unless config[:api_version]
-            unless config[:access_key_id] || Aliyun::Rails.access_key_id
-              raise ArgumentError, 'must pass "config[:access_key_id]" or define "Aliyun::Rails.access_key_id"'
-            end
-            unless config[:access_key_secret] || Aliyun::Rails.access_key_secret
-              raise ArgumentError, 'must pass "config[:access_key_secret]" or define "Aliyun::Rails.access_key_secret"'
-            end
-          end
-      end
-    end
-  end
-end

data/lib/aliyun/rails/dysms.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Aliyun
-  module Rails
-    class Dysms < Aliyun::Rails::Connector::RPCClient
-      # 本产品（Dysmsapi/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。
-      # 我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。
-      def initialize(config = {}, verbose = nil)
-        config[:endpoint]    ||= "http://dysmsapi.aliyuncs.com"
-        config[:api_version] ||= "2017-05-25"
-        super(config, verbose)
-      end
-
-      # 发送短信，发送前要申请短信签名和短信模板，并确保签名和模板已审核通过。
-      def send_sms(phone_numbers, template_code, template_param, sign_name = "")
-        params = {
-          PhoneNumbers:  phone_numbers,
-          SignName:      sign_name,
-          TemplateCode:  template_code,
-          TemplateParam: template_param.to_json
-        }
-        opts   = { method: "POST", timeout: 15000 }
-        request(action: "SendSms", params: params, opts: opts)
-      end
-    end
-  end
-end

data/lib/aliyun/rails/dyvms.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Aliyun
-  module Rails
-    class Dyvms < Aliyun::Rails::Connector::RPCClient
-      # 本产品（Dyvmsapi/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。
-      # 我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。
-      def initialize(config = {}, verbose = nil)
-        config[:endpoint]    ||= "http://dyvmsapi.aliyuncs.com"
-        config[:api_version] ||= "2017-05-25"
-        super(config, verbose)
-      end
-
-      # 调用SingleCallByTts接口向指定号码发送语音验证码和带参数变量的语音通知
-      def single_call_by_tts(called_show_number, called_number, tts_code, tts_param)
-        params = {
-          CalledShowNumber: called_show_number,
-          CalledNumber:     called_number,
-          TtsCode:          tts_code,
-          TtsParam:         tts_param.to_json
-        }
-        opts   = { method: "POST", timeout: 15000 }
-        request(action: "SendSms", params: params, opts: opts)
-      end
-    end
-  end
-end

data/lib/aliyun/rails/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Aliyun
-  module Rails
-    VERSION = "0.1.13"
-    DEFAULT_UA = "AlibabaCloud (#{Gem::Platform.local.os}; " +
-      "#{Gem::Platform.local.cpu}) Ruby/#{RUBY_VERSION} Core/#{VERSION}"
-  end
-end

data/lib/aliyun/rails.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rails/version"
-require_relative "rails/connector/roa_client"
-require_relative "rails/connector/rpc_client"
-require_relative "rails/dyvms"
-require_relative "rails/dysms"
-
-module Aliyun
-  module Rails
-    class Error < StandardError; end
-
-    class << self
-      attr_accessor :access_key_id, :access_key_secret
-      def config
-        yield self
-      end
-    end
-
-    # Your code goes here...
-  end
-end