aliyun-sdk 0.5.0 → 0.7.3

data/lib/aliyun/common/logging.rb

@@ -11,7 +11,6 @@ module Aliyun
     #   logger.info(xxx)
     module Logging
 
-      DEFAULT_LOG_FILE = "./aliyun_sdk.log"
       MAX_NUM_LOG = 100
       ROTATE_SIZE = 10 * 1024 * 1024
 
@@ -34,8 +33,10 @@ module Aliyun
 
       def self.logger
         unless @logger
+          # Environment parameter ALIYUN_OSS_SDK_LOG_PATH used to set output log to a file,do not output log if not set
+          @log_file ||= ENV["ALIYUN_OSS_SDK_LOG_PATH"]
           @logger = Logger.new(
-            @log_file ||= DEFAULT_LOG_FILE, MAX_NUM_LOG, ROTATE_SIZE)
+              @log_file, MAX_NUM_LOG, ROTATE_SIZE)
           @logger.level = Logger::INFO
         end
         @logger

data/lib/aliyun/oss/bucket.rb

@@ -588,42 +588,39 @@ 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 << "?#{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  
 
-        [url, query_string].join('?')
+        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
 
       # 获取用户所设置的ACCESS_KEY_ID

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

@@ -105,35 +105,11 @@ module Aliyun
           false
         end
 
-        def inspect
-          "@buffer: " + @buffer[0, 32].inspect + "...#{@buffer.size} bytes"
-        end
-      end
-
-      # RestClient requires the payload to respones to :read(bytes)
-      # and return a stream.
-      # We are not doing the real read here, just return a
-      # readable stream for RestClient playload.rb treats it as:
-      #     def read(bytes=nil)
-      #       @stream.read(bytes)
-      #     end
-      #     alias :to_s :read
-      #     net_http_do_request(http, req, payload ? payload.to_s : nil,
-      #                     &@block_response)
-      class StreamPayload
-        def initialize(crc_enable = false, init_crc = 0, &block)
-          @stream = StreamWriter.new(crc_enable, init_crc, &block)
-        end
-
-        def read(bytes = nil)
-          @stream
-        end
-
         def close
         end
 
-        def closed?
-          false
+        def inspect
+          "@buffer: " + @buffer[0, 32].inspect + "...#{@buffer.size} bytes"
         end
       end
 
@@ -145,12 +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
-        url.path << "#{CGI.escape(object)}" if object
-
+        url.path << CGI.escape(object) if object
         url.to_s
       end
 
@@ -281,44 +258,46 @@ module Aliyun
         headers[:params] = (sub_res || {}).merge(http_options[:query] || {})
 
         block_response = ->(r) { handle_response(r, &block) } if block
-        r = RestClient::Request.execute(
+        request = RestClient::Request.new(
           :method => verb,
           :url => get_request_url(bucket, object),
           :headers => headers,
           :payload => http_options[:body],
           :block_response => block_response,
           :open_timeout => @config.open_timeout || OPEN_TIMEOUT,
-          :timeout => @config.read_timeout || READ_TIMEOUT
-        ) do |response, request, result, &blk|
-
-          if response.code >= 300
-            e = ServerError.new(response)
+          :read_timeout => @config.read_timeout || READ_TIMEOUT
+        )
+        response = request.execute do |resp, &blk|
+          if resp.code >= 300
+            e = ServerError.new(resp)
             logger.error(e.to_s)
             raise e
           else
-            response.return!(request, result, &blk)
+            resp.return!(&blk)
           end
         end
 
         # If streaming read_body is used, we need to create the
         # RestClient::Response ourselves
-        unless r.is_a?(RestClient::Response)
-          if r.code.to_i >= 300
-            r = RestClient::Response.create(
-              RestClient::Request.decode(r['content-encoding'], r.body),
-              r, nil, nil)
-            e = ServerError.new(r)
+        unless response.is_a?(RestClient::Response)
+          if response.code.to_i >= 300
+            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
           end
-          r = RestClient::Response.create(nil, r, nil, nil)
-          r.return!
+          response = RestClient::Response.create(nil, response, request)
+          response.return!
         end
 
-        logger.debug("Received HTTP response, code: #{r.code}, headers: " \
-                      "#{r.headers}, body: #{r.body}")
+        logger.debug("Received HTTP response, code: #{response.code}, headers: " \
+                      "#{response.headers}, body: #{response.body}")
 
-        r
+        response
       end
 
       def get_user_agent

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
                 }
               }
@@ -535,7 +535,7 @@ module Aliyun
           headers[CALLBACK_HEADER] = opts[:callback].serialize
         end
 
-        payload = HTTP::StreamPayload.new(@config.upload_crc_enable, opts[:init_crc], &block)
+        payload = HTTP::StreamWriter.new(@config.upload_crc_enable, opts[:init_crc], &block)
         r = @http.put(
           {:bucket => bucket_name, :object => object_name},
           {:headers => headers, :body => payload})
@@ -547,7 +547,7 @@ module Aliyun
         end
 
         if @config.upload_crc_enable && !r.headers[:x_oss_hash_crc64ecma].nil?
-          data_crc = payload.read.data_crc
+          data_crc = payload.data_crc
           Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'put')
         end
 
@@ -593,16 +593,17 @@ module Aliyun
 
         headers.merge!(to_lower_case(opts[:headers])) if opts.key?(:headers)
 
-        payload = HTTP::StreamPayload.new(@config.upload_crc_enable && !opts[:init_crc].nil?, opts[:init_crc], &block)
+        payload = HTTP::StreamWriter.new(
+          @config.upload_crc_enable && !opts[:init_crc].nil?, opts[:init_crc], &block)
 
         r = @http.post(
           {:bucket => bucket_name, :object => object_name, :sub_res => sub_res},
           {:headers => headers, :body => payload})
 
-        if @config.upload_crc_enable && 
-          !r.headers[:x_oss_hash_crc64ecma].nil? && 
+        if @config.upload_crc_enable &&
+          !r.headers[:x_oss_hash_crc64ecma].nil? &&
           !opts[:init_crc].nil?
-          data_crc = payload.read.data_crc
+          data_crc = payload.data_crc
           Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'append')
         end
 
@@ -780,7 +781,7 @@ module Aliyun
           {:bucket => bucket_name, :object => object_name,
            :sub_res => sub_res},
           {:headers => headers}
-        ) do |chunk| 
+        ) do |chunk|
           if block_given?
             # crc enable and no range and oss server support crc
             data_crc = Aliyun::OSS::Util.crc(chunk, data_crc) if @config.download_crc_enable && range.nil?
@@ -1110,13 +1111,13 @@ module Aliyun
 
         sub_res = {'partNumber' => part_no, 'uploadId' => txn_id}
 
-        payload = HTTP::StreamPayload.new(@config.upload_crc_enable, &block)
+        payload = HTTP::StreamWriter.new(@config.upload_crc_enable, &block)
         r = @http.put(
           {:bucket => bucket_name, :object => object_name, :sub_res => sub_res},
           {:body => payload})
 
         if @config.upload_crc_enable && !r.headers[:x_oss_hash_crc64ecma].nil?
-          data_crc = payload.read.data_crc
+          data_crc = payload.data_crc
           Aliyun::OSS::Util.crc_check(data_crc, r.headers[:x_oss_hash_crc64ecma], 'put')
         end
 
@@ -1393,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
@@ -1516,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)