aliyun-rails 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e27be7e1a623946c583fc2d8dfd8144c76352b1370f37954f07d1a92379903d
-  data.tar.gz: 73ce2236eacb879c9a4648a1b03701a2f33dfd5ab3060a854fbbb51c54fb50ad
+  metadata.gz: cb272181c60129e57686d1086eb34e5b4cb20776926c600ca9865e8a8e7537d3
+  data.tar.gz: 345f2c7bfc4135d42c4f8d9a0c4caab0218a5c419bde70fb4e13ae5f44414ac0
 SHA512:
-  metadata.gz: 6db85298bf709c4688a92b7c45c34376c043156ae00443882030e1382b6ae36a5eef5456b1c3f317074799440d7edce17751afb1b560a98ad7cef09425014bfb
-  data.tar.gz: 5041a64210b45a9cf036e4573bb33a9cbc8a652c2f9fcf167f634477cf816a5daf4709e9e3836718a7bc306e2f424edc9b99f21d686e53579c929e03ddf8b49f
+  metadata.gz: 62c17e6d850d702b250aefab7c0934990271a244ff97cfcc1e2f27870117f5ccbee62445e95fb0e3cec7207fedbc226986bd7e40ffd50da951e9bbdbad36ee46
+  data.tar.gz: 234b8e75fb51905c926ac4204c6ee5259a9f854ad0f8efb6b2b482a0870abc51fae36ce5203d131c970175474ccc06e4e3dddb0480f03d27d2b0a5471c8e1ba2

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.1.14] - 2022-04-01
+
+- 优化 rpc_client 代码
+- 优化 roa_client 代码
+- 完善代码范例
+
+## [0.1.0] - 2022-03-31
+
+- 首次发布代码

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at careline@foxmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+## 待添加

data/lib/aliyun/connector/rpc_client.rb

@@ -1,116 +1,147 @@
-# 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
+  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
 
-        # 解析接口响应
-        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}"
+    # 通用请求接口
+    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
+      normalized     = normalize(params)
+      canonicalized  = canonicalize(normalized)
+      string_to_sign = "#{method}&#{encode('/')}&#{encode(canonicalized)}"
+      secret         = "#{self.access_key_secret}&"
+      signature      = Base64.encode64(OpenSSL::HMAC.digest("sha1", secret, string_to_sign)).strip
+      normalized.push(["Signature", encode(signature)])
+
+      # 转换为 query 样式
+      querystring = canonicalize(normalized)
+
+      # 特殊处理 POST
+      uri = opts[:method] == "POST" ? "/" : "/?#{querystring}"
+
+      # 初始化会话
+      response = connection.send(method.downcase, uri) do |request|
+        if opts[:method] == "POST"
+          request.headers["Content-Type"] = "application/x-www-form-urlencoded"
+          request.body                    = querystring
         end
+        request.headers["User-Agent"] = DEFAULT_UA
+      end
 
-        response_body
+      # 解析接口响应
+      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
 
-      private
-        def connection(adapter = Faraday.default_adapter)
-          Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
-        end
+      response_body
+    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
+    private
+      def connection(adapter = Faraday.default_adapter)
+        Faraday.new(url: self.endpoint) { |f| f.adapter adapter }
+      end
 
-        # 消息签名需要
-        def encode(input)
-          ERB::Util.url_encode input
-        end
+      # 设置缺省参数
+      def default_params
+        default_params                  = {
+          "Format"           => "JSON",
+          "SignatureMethod"  => "HMAC-SHA1",
+          "SignatureNonce"   => SecureRandom.hex(16),
+          "SignatureVersion" => "1.0",
+          "Timestamp"        => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+          "AccessKeyId"      => self.access_key_id,
+          "Version"          => self.api_version,
+        }
+        default_params["SecurityToken"] = self.security_token if self.security_token
+        default_params
+      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 encode(string)
+        ERB::Util.url_encode(string)
+      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"'
+      # 转换 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 replace_repeat_list(target, key, repeat)
+        repeat.each_with_index do |item, index|
+          if item && item.instance_of?(Hash)
+            item.each_key { |k| target["#{key}.#{index.next}.#{k}"] = item[k] }
+          else
+            target["#{key}.#{index.next}"] = item
           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
+        target
+      end
+
+      def flat_params(params)
+        target = {}
+        params.each do |key, value|
+          if value.instance_of?(Array)
+            replace_repeat_list(target, key, value)
+          else
+            target[key.to_s] = value
           end
         end
-    end
+        target
+      end
+
+      def normalize(params)
+        flat_params(params).sort.to_h.map { |key, value| [encode(key), encode(value)] }
+      end
+
+      def canonicalize(normalized)
+        normalized.map { |element| "#{element.first}=#{element.last}" }.join("&")
+      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

data/lib/aliyun/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - WENWU.YAN
@@ -45,6 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile