qingstor-sdk 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c017ab0377c9dbe06078e86770f14657f3a3c119
-  data.tar.gz: a94c9695d19a24647392a92ee09ea5cd0da7e831
+  metadata.gz: c85e73c270e2630d4e2499bd7ef31f1b6e246d2d
+  data.tar.gz: 1b3a584bbee63df761921a43d4f8270ae42beab0
 SHA512:
-  metadata.gz: beb1bf011b11f37dc244d3840ff7fba7ea0130ae3177d167da5e45368c8d5636e68d27a5da4fd1b653a5cf0e25b45ecfd99186135f0d2967f4da4d97544487ce
-  data.tar.gz: 8a4627ef7a91cd0fee08aee91d9769e9fa87ccd34ef4fe0b23161137168f79b8cdfce92e3b2222060fbdda2d7ccb28ca1af4e433fde488fec029d4052c125bce
+  metadata.gz: 8246701fa0c00c9959dce2e967984fdb9427c0378272eb510766fab145b3a276e4b79d0e275190e297275f96939f82cdce8016e1f3f34a6280e917fc36461c64
+  data.tar.gz: ac8bc039c6f9be943efae10848bfdc03b225e2d5a7264510f900de43b940998ae7734fcb7d36676d1c65b8b932b4eb53aaf58fb59741197133e538756a0e2c9d

data/README.md

@@ -31,7 +31,7 @@ Specify `qingstor-sdk` as dependency in your application's Gemfile:
 gem 'qingstor-sdk'
 ```
 
-Ensure `qingstor-sdk` is installed as dependency with `bundle-install`:
+Ensure `qingstor-sdk` is installed as dependency with `bundle install`:
 
 ``` bash
 $ bundle install
@@ -169,13 +169,19 @@ log_level: 'warn'
 ## Change Log
 All notable changes to QingStor SDK for Ruby will be documented here.
 
-## [v2.2.0] - 2017-02-28
+### [v2.2.1] - 2017-03-10
 
-### Added
+#### Added
+
+- Allow user to append additional info to User-Agent
+
+### [v2.2.0] - 2017-02-28
+
+#### Added
 
 - Add ListMultipartUploads API.
 
-### Fixed
+#### Fixed
 
 - Fix request builder & signer.
 
@@ -228,7 +234,8 @@ All notable changes to QingStor SDK for Ruby will be documented here.
 The Apache License (Version 2.0, January 2004).
 
 [compatible]: https://github.com/yunify/qingstor-sdk-ruby/tree/compatible
-[v2.2.0]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.1.2...v2.2.0
+[v2.2.1]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.2.0...v2.2.1
+[v2.2.0]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.1.1...v2.2.0
 [v2.1.1]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.1.0...v2.1.1
 [v2.1.0]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.0.1...v2.1.0
 [v2.0.1]: https://github.com/yunify/qingstor-sdk-ruby/compare/v2.0.0...v2.0.1

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

@@ -46,6 +46,23 @@ module QingStor
         self
       end
 
+      def check
+        [:access_key_id, :secret_access_key, :host, :port, :protocol].each do |x|
+          if !self[x] || self[x].to_s.empty?
+            raise ConfigurationError, "#{x.to_sym} not specified"
+          end
+        end
+        if self[:additional_user_agent] && !self[:additional_user_agent].empty?
+          self[:additional_user_agent].each_byte do |x|
+            # Allow space(32) to ~(126) in ASCII Table, exclude "(34).
+            if x < 32 || x > 126 || x == 32 || x == 34
+              raise ConfigurationError, 'additional User-Agent contains characters that not allowed'
+            end
+          end
+        end
+        self
+      end
+
       def load_default_config
         load_config_from_file Contract::DEFAULT_CONFIG_FILEPATH
       end

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

@@ -1,12 +1,15 @@
 # QingStor services configuration
 
-#access_key_id: 'ACCESS_KEY_ID'
-#secret_access_key: 'SECRET_ACCESS_KEY'
+#access_key_id: ACCESS_KEY_ID
+#secret_access_key: SECRET_ACCESS_KEY
 
-host: 'qingstor.com'
+host: qingstor.com
 port: 443
-protocol: 'https'
+protocol: https
 connection_retries: 3
 
+# Additional User-Agent
+additional_user_agent: ""
+
 # Valid log levels are "debug", "info", "warn", "error", and "fatal".
-log_level: 'warn'
+log_level: warn

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

@@ -14,11 +14,21 @@
 #  | limitations under the License.
 #  +-------------------------------------------------------------------------
 
-module QingCloud
+module QingStor
   module SDK
     class SDKError < StandardError
     end
 
+    class ConfigurationError < SDKError
+      def initialize(error_message)
+        @error_message = error_message
+      end
+
+      def message
+        "configuration is not valid, #{@error_message}"
+      end
+    end
+
     class NetworkError < SDKError
     end
 

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

@@ -92,6 +92,9 @@ module QingStor
         end
         unless input[:request_headers][:'User-Agent']
           ua = "qingstor-sdk-ruby/#{QingStor::SDK::VERSION} (Ruby v#{RUBY_VERSION}; #{RUBY_PLATFORM})"
+          if input[:config][:additional_user_agent] && !input[:config][:additional_user_agent].empty?
+            ua = "#{ua} #{input[:config][:additional_user_agent]}"
+          end
           input[:request_headers][:'User-Agent'] = ua
         end
 
@@ -99,11 +102,9 @@ module QingStor
           input[:request_headers][:'Content-MD5'] = Base64.encode64(Digest::MD5.digest(input[:request_body])).strip
         end
 
-        input[:request_headers].map { |k, v|
-          unless v.to_s.ascii_only?
-            input[:request_headers][k] = escape v.to_s
-          end
-        }
+        input[:request_headers].map do |k, v|
+          input[:request_headers][k] = escape v.to_s unless v.to_s.ascii_only?
+        end
 
         input[:request_headers]
       end

data/lib/qingstor/sdk/version.rb

@@ -16,6 +16,6 @@
 
 module QingStor
   module SDK
-    VERSION = '2.2.0'.freeze
+    VERSION = '2.2.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qingstor-sdk
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Yunify SDK Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport