aliyun-sdk 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0eb63cbc2eaef6904f149227af4fe4aadaf492b3
-  data.tar.gz: c77132cb5b467b459f84641ede4ae9335d626ff1
+SHA256:
+  metadata.gz: aea256f156d30bf7e84ed0f6a2cd0670b63c02fe1fc6a6f9641e479dc2dfcbf5
+  data.tar.gz: 1344db0e4aa351fc9065779ef80297857a57e48fdf5d41527dd5ce3cb62c17cb
 SHA512:
-  metadata.gz: befbf2ca1b3b80e69d58fcea1c4c6d2dcab38499cfecd2aa4f8c8827b098b5ab912a7efe388b8d24e6ace7a065f0eb2a4464b0be713190c5d7120020fab57bc5
-  data.tar.gz: 9c1384ed6d63ba3a71634276b48dbe04e757fc865152f9fcd9bb52e3cb7a750e30afd8d519aebaafc60157be35845d6e315e6087e795125398b2e62ea6727356
+  metadata.gz: 53387168b68b6b209f8a2c83e7704c0b0fa5bc02cb7dcd384c19bfe357eece672a5e9b2e566e2da261d1133d5a99280455e74eb71ef3aa09158659948b3fb2bf
+  data.tar.gz: 93615f26a714a0daf08cfe18addd2fc25bc5e1d028ec53ab8302f6aeabd4e4b05dc59f254cc823faeba2d846f0b0b8e5a74736fc9348ee1ee6d88366b100cc84

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change Log
 
+### v0.7.1 / 2019-11-16
+
+- add the validity check of bucket name
+- add parameters argument for buclet.object_url api
+- fix http.get_request_url function bug
+- fix warning constant ::Fixnum is deprecated
+- support rest-client 2.1.0
+
 ### v0.7.0 / 2018-06-05
 
 - deps: upgrade nokogiri to > 1.6 and ruby version >= 2.0

data/lib/aliyun/oss/bucket.rb

@@ -588,42 +588,38 @@ module Aliyun
       # 获取Object的URL
       # @param [String] key Object的key
       # @param [Boolean] sign 是否对URL进行签名，默认为是
-      # @param [Fixnum] expiry URL的有效时间，单位为秒，默认为60s
+      # @param [Integer] expiry URL的有效时间，单位为秒，默认为60s
+      # @param [Hash] parameters 附加的query参数，默认为空
       # @return [String] 用于直接访问Object的URL
-      def object_url(key, sign = true, expiry = 60)
-        url = @protocol.get_request_url(name, key)
-        return url unless sign
-
-        expires = Time.now.to_i + expiry
-        query = {
-          'Expires' => expires.to_s,
-          'OSSAccessKeyId' => CGI.escape(access_key_id)
-        }
-
-        sub_res = []
-        if @protocol.get_sts_token
-          sub_res << "security-token=#{@protocol.get_sts_token}"
-          query['security-token'] = CGI.escape(@protocol.get_sts_token)
-        end
-
-        resource = "/#{name}/#{key}"
-        unless sub_res.empty?
-          resource << (resource.include?('?') ? "&#{sub_res.join('&')}" : "?#{sub_res.join('&')}")
-        end
+      def object_url(key, sign = true, expiry = 60, parameters = {})
+        url = @protocol.get_request_url(name, key).gsub('%2F', '/')
+        query = parameters.dup
+
+        if sign
+          #header
+          expires = Time.now.to_i + expiry
+          headers = {
+            'date' => expires.to_s,
+          }
+
+          #query 
+          if @protocol.get_sts_token
+            query['security-token'] = @protocol.get_sts_token
+          end
 
-        string_to_sign = "" <<
-                         "GET\n" << # method
-                         "\n" <<    # Content-MD5
-                         "\n" <<    # Content-Type
-                         "#{expires}\n" <<
-                         "#{resource}"
+          res = {
+            :path => @protocol.get_resource_path(name, key),
+            :sub_res => query,
+          }
+          signature = Util.get_signature(@protocol.get_access_key_secret, 'GET', headers, res)
 
-        signature = sign(string_to_sign)
-        query_string =
-          query.merge('Signature' => CGI.escape(signature))
-          .map { |k, v| "#{k}=#{v}" }.join('&')
+          query['Expires'] = expires.to_s
+          query['OSSAccessKeyId'] = @protocol.get_access_key_id
+          query['Signature'] = signature
+        end  
 
-        link_char = url.include?('?') ? '&' : '?'
+        query_string = query.map { |k, v| v ? [k, CGI.escape(v)].join("=") : k }.join("&")
+        link_char = query_string.empty? ? '' : '?'
         [url, query_string].join(link_char)
       end
 

data/lib/aliyun/oss/client.rb

@@ -34,9 +34,9 @@ module Aliyun
       #  是否开启CRC校验，默认为不开启(false)
       # @option opts [String] :sts_token [可选] 指定STS的
       #  SecurityToken，如果指定，则使用STS授权访问
-      # @option opts [Fixnum] :open_timeout [可选] 指定建立连接的超时
+      # @option opts [Integer] :open_timeout [可选] 指定建立连接的超时
       #  时间，默认为10秒
-      # @option opts [Fixnum] :read_timeout [可选] 指定等待响应的超时
+      # @option opts [Integer] :read_timeout [可选] 指定等待响应的超时
       #  时间，默认为120秒
       # @example 标准endpoint
       #   oss-cn-hangzhou.aliyuncs.com
@@ -70,6 +70,7 @@ module Aliyun
       # @param opts [Hash] 创建Bucket的属性（可选）
       # @option opts [:location] [String] 指定bucket所在的区域，默认为oss-cn-hangzhou
       def create_bucket(name, opts = {})
+        Util.ensure_bucket_name_valid(name)
         @protocol.create_bucket(name, opts)
       end
 
@@ -77,6 +78,7 @@ module Aliyun
       # @param name [String] Bucket名字
       # @note 如果要删除的Bucket不为空（包含有object），则删除会失败
       def delete_bucket(name)
+        Util.ensure_bucket_name_valid(name)
         @protocol.delete_bucket(name)
       end
 
@@ -84,6 +86,7 @@ module Aliyun
       # @param name [String] Bucket名字
       # @return [Boolean] 如果Bucket存在则返回true，否则返回false
       def bucket_exists?(name)
+        Util.ensure_bucket_name_valid(name)
         exist = false
 
         begin
@@ -102,6 +105,7 @@ module Aliyun
       # @param name [String] Bucket名字
       # @return [Bucket] Bucket对象
       def get_bucket(name)
+        Util.ensure_bucket_name_valid(name)
         Bucket.new({:name => name}, @protocol)
       end
 

data/lib/aliyun/oss/http.rb

@@ -121,17 +121,13 @@ module Aliyun
 
       def get_request_url(bucket, object)
         url = @config.endpoint.dup
+        url.query = nil
+        url.fragment = nil 
         isIP = !!(url.host =~ Resolv::IPv4::Regex)
         url.host = "#{bucket}." + url.host if bucket && !@config.cname && !isIP
         url.path = '/'
         url.path << "#{bucket}/" if bucket && isIP
-
-        if object
-          path, query = object.split('?')
-          url.path << path.split('/').map { |seg| CGI.escape(seg) }.join('/')
-          url.query = query.split('&').map { |kv| k, v = kv.split('='); "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&') if query
-        end
-
+        url.path << CGI.escape(object) if object
         url.to_s
       end
 
@@ -285,9 +281,11 @@ module Aliyun
         # RestClient::Response ourselves
         unless response.is_a?(RestClient::Response)
           if response.code.to_i >= 300
-            response = RestClient::Response.create(
-              RestClient::Request.decode(response['content-encoding'], response.body),
-              response, request)
+            body = response.body
+            if RestClient::version < '2.1.0'
+              body = RestClient::Request.decode(response['content-encoding'], response.body)
+            end
+            response = RestClient::Response.create(body, response, request)
             e = ServerError.new(response)
             logger.error(e.to_s)
             raise e

data/lib/aliyun/oss/protocol.rb

@@ -346,10 +346,10 @@ module Aliyun
                     xml.Date Time.utc(
                                r.expiry.year, r.expiry.month, r.expiry.day)
                               .iso8601.sub('Z', '.000Z')
-                  elsif r.expiry.is_a?(Fixnum)
+                  elsif r.expiry.is_a?(Integer)
                     xml.Days r.expiry
                   else
-                    fail ClientError, "Expiry must be a Date or Fixnum."
+                    fail ClientError, "Expiry must be a Date or Integer."
                   end
                 }
               }
@@ -1394,12 +1394,26 @@ module Aliyun
         @http.get_request_url(bucket, object)
       end
 
+      # Get bucket/object resource path
+      # @param [String] bucket the bucket name
+      # @param [String] object the bucket name
+      # @return [String] resource path for the bucket/object
+      def get_resource_path(bucket, object = nil)
+        @http.get_resource_path(bucket, object)
+      end
+
       # Get user's access key id
       # @return [String] the access key id
       def get_access_key_id
         @config.access_key_id
       end
 
+      # Get user's access key secret
+      # @return [String] the access key secret
+      def get_access_key_secret
+        @config.access_key_secret
+      end  
+
       # Get user's STS token
       # @return [String] the STS token
       def get_sts_token
@@ -1517,7 +1531,7 @@ module Aliyun
       def get_bytes_range(range)
         if range &&
            (!range.is_a?(Array) || range.size != 2 ||
-            !range.at(0).is_a?(Fixnum) || !range.at(1).is_a?(Fixnum))
+            !range.at(0).is_a?(Integer) || !range.at(1).is_a?(Integer))
           fail ClientError, "Range must be an array containing 2 Integers."
         end
 

data/lib/aliyun/oss/struct.rb

@@ -107,10 +107,10 @@ module Aliyun
     # * id [String] the unique id of a rule
     # * enabled [Boolean] whether to enable this rule
     # * prefix [String] the prefix objects to apply this rule
-    # * expiry [Date] or [Fixnum] the expire time of objects
+    # * expiry [Date] or [Integer] the expire time of objects
     #   * if expiry is a Date, it specifies the absolute date to
     #     expire objects
-    #   * if expiry is a Fixnum, it specifies the relative date to
+    #   * if expiry is a Integer, it specifies the relative date to
     #     expire objects: how many days after the object's last
     #     modification time to expire the object
     # @example Specify expiry as Date

data/lib/aliyun/oss/util.rb

@@ -93,6 +93,12 @@ module Aliyun
           end
         end
 
+        def ensure_bucket_name_valid(name)
+          unless (name =~ %r|^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$|)
+            fail ClientError, "The bucket name is invalid."
+          end
+        end  
+
       end # self
     end # Util
   end # OSS

data/lib/aliyun/sts/client.rb

@@ -25,7 +25,7 @@ module Aliyun
       # @param role [String] the role arn
       # @param session [String] the session name
       # @param policy [STS::Policy] the policy
-      # @param duration [Fixnum] the duration seconds for the
+      # @param duration [Integer] the duration seconds for the
       #  requested token
       # @return [STS::Token] the sts token
       def assume_role(role, session, policy = nil, duration = 3600)

data/lib/aliyun/sts/protocol.rb

@@ -27,7 +27,7 @@ module Aliyun
       # @param role [String] the role arn
       # @param session [String] the session name
       # @param policy [STS::Policy] the policy
-      # @param duration [Fixnum] the duration seconds for the
+      # @param duration [Integer] the duration seconds for the
       #  requested token
       # @return [STS::Token] the sts token
       def assume_role(role, session, policy = nil, duration = 3600)

data/lib/aliyun/version.rb

@@ -2,6 +2,6 @@
 
 module Aliyun
 
-    VERSION = "0.7.0"
+    VERSION = "0.7.1"
 
 end # Aliyun

data/spec/aliyun/oss/client/bucket_spec.rb

@@ -498,7 +498,10 @@ module Aliyun
               :access_key_secret => 'yyy',
               :sts_token => 'zzz').get_bucket(@bucket_name)
 
-            url = sts_bucket.object_url('ico.png?x-oss-process=image/resize,m_fill,h_100,w_100')
+            param = {
+              'x-oss-process' => 'image/resize,m_fill,h_100,w_100',
+            }  
+            url = sts_bucket.object_url('ico.png', true, 60, param)
             path = url[0, url.index('?')]
             expect(path).to eq('http://rubysdk-bucket.oss-cn-hangzhou.aliyuncs.com/ico.png')
 

data/spec/aliyun/oss/client/client_spec.rb

@@ -127,6 +127,31 @@ module Aliyun
           expect(WebMock).to have_requested(:get, "#{bucket}.#{ep1}/#{object}")
           expect(WebMock).to have_requested(:put, "#{bucket}.#{ep2}/#{object}")
         end
+
+        it "should fail with invalid bucket name" do
+          bucket = 'INVALID'
+          ep1 = 'oss-cn-hangzhou.aliyuncs.com'
+          client = Client.new(
+            :endpoint => ep1,
+            :access_key_id => 'xxx', :access_key_secret => 'yyy')
+
+          expect {
+            client.create_bucket(bucket)
+          }.to raise_error(ClientError, "The bucket name is invalid.")
+
+          expect {
+            client.delete_bucket(bucket)
+          }.to raise_error(ClientError, "The bucket name is invalid.")
+
+          expect {
+            client.bucket_exists?(bucket)
+          }.to raise_error(ClientError, "The bucket name is invalid.")
+
+          expect {
+            client.get_bucket(bucket)
+          }.to raise_error(ClientError, "The bucket name is invalid.")
+        end
+
       end # construct
 
       def mock_buckets(buckets, more = {})

data/spec/aliyun/oss/object_spec.rb

@@ -710,6 +710,23 @@ module Aliyun
                     'Range' => 'bytes=0-9'
                   })
         end
+
+        it "should get to get object with special chars" do
+          object_name = 'ruby///adfadfa//!@#%^*//?key=value&aabc#abc=ad'
+          url = get_request_path(object_name)
+
+          return_content = "hello world"
+          stub_request(:get, url).to_return(:body => return_content)
+
+          content = ""
+          @protocol.get_object(@bucket, object_name) {|c| content << c}
+
+          expect(WebMock).to have_requested(:get, url)
+            .with(:body => nil, :query => {})
+
+          expect(content).to eq(return_content)
+        end
+
       end # Get object
 
       context "Get object meta" do

data/spec/aliyun/oss/util_spec.rb

@@ -94,6 +94,57 @@ module Aliyun
         }.to raise_error(CrcInconsistentError, "The crc of post between client and oss is not inconsistent.")
       end
 
+      it "should check bucket name valid" do
+        expect {
+          Util.ensure_bucket_name_valid('abc')
+        }.not_to raise_error
+
+        expect {
+          Util.ensure_bucket_name_valid('abc123-321cba')
+        }.not_to raise_error
+
+        expect {
+          Util.ensure_bucket_name_valid('abcdefghijklmnopqrstuvwxyz1234567890-0987654321zyxwuvtsrqponmlk')
+        }.not_to raise_error
+
+        #>63
+        expect {
+          Util.ensure_bucket_name_valid('abcdefghijklmnopqrstuvwxyz1234567890-0987654321zyxwuvtsrqponmlkj')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        #<3
+        expect {
+          Util.ensure_bucket_name_valid('12')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+        
+        #not [a-z0-9-]
+        expect {
+          Util.ensure_bucket_name_valid('Aabc')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        expect {
+          Util.ensure_bucket_name_valid('abc/')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        expect {
+          Util.ensure_bucket_name_valid('abc#')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        expect {
+          Util.ensure_bucket_name_valid('abc?')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        #start & end not -
+        expect {
+          Util.ensure_bucket_name_valid('-abc')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+
+        expect {
+          Util.ensure_bucket_name_valid('abc-')
+        }.to raise_error(ClientError, "The bucket name is invalid.")
+        
+      end  
+
     end # Util
 
   end # OSS

data/tests/test_object_key.rb

@@ -17,6 +17,8 @@ class TestObjectKey < Minitest::Test
       chinese: '杭州・中国',
       space: '是 空格 yeah +-/\\&*#',
       invisible: '' << 1 << 10 << 12 << 7 << 80 << 99,
+      specail1: 'testkey/',
+      specail2: 'testkey/?key=value#abc=def',
       xml: 'a<b&c>d +'
     }
   end
@@ -57,6 +59,22 @@ class TestObjectKey < Minitest::Test
     assert_equal key, @bucket.get_object(key).key
   end
 
+  def test_specail1
+    key = get_key(:specail1)
+    @bucket.put_object(key)
+    all = @bucket.list_objects(prefix: @prefix).map(&:key)
+    assert_includes all, key
+    assert_equal key, @bucket.get_object(key).key
+  end
+
+  def test_specail2
+    key = get_key(:specail2)
+    @bucket.put_object(key)
+    all = @bucket.list_objects(prefix: @prefix).map(&:key)
+    assert_includes all, key
+    assert_equal key, @bucket.get_object(key).key
+  end
+
   def test_batch_delete
     keys = @keys.map { |k, _| get_key(k) }
     keys.each { |k| @bucket.put_object(k) }

data/tests/test_object_url.rb

@@ -66,4 +66,24 @@ class TestObjectUrl < Minitest::Test
 
     assert_equal 200, r.code
   end
+
+  def test_signed_url_with_parameters
+    key = get_key('example.jpg')
+
+    @bucket.put_object(key, :file => 'tests/example.jpg', acl: Aliyun::OSS::ACL::PRIVATE)
+
+    meta = @bucket.get_object(key)
+    assert_equal 21839, meta.size 
+
+    parameters = {
+      'x-oss-process' => 'image/resize,m_fill,h_100,w_100',
+    }
+    signed_url = @bucket.object_url(key, true, 60, parameters)
+    r = RestClient.get(signed_url)
+    lenth = r.headers[:content_length].to_i
+    assert_equal 200, r.code
+    assert_equal true, lenth < meta.size
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Tianlong Wu
 autorequire: 
 bindir: lib/aliyun
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -230,8 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Aliyun OSS SDK for Ruby