aliyun-sdk 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b400456da8877a797a2caecc64fd696f54f129f3
-  data.tar.gz: 0bc030c00b7bc81a234bfa7ac52db10a1cbc7f71
+SHA256:
+  metadata.gz: 9ed62a6f5a59df2499c7fd4028b4aecfad8506018ef7a3425b1c7627e0f8ddc8
+  data.tar.gz: eb47336dccf3d526466e6cbf5fbf3a845c4f9b8be5d34a5b7f7a55cd6b87f693
 SHA512:
-  metadata.gz: 71786966777a2ebcbbdf370bf436c8d5d983e710f0fca4f2f2c7e63ea8dab9fc51982b457a4cdfeeb3085cb4509260cd8646b15de374bd41b0ca114ae647d121
-  data.tar.gz: b03108695f1e78fae5c0ab4dc2da904b9af2409e93d4bb0529da78a1fa10f28e1f2548165890dc7710f35b364765559ecdcc60d2e5444f9035489fb5a737e831
+  metadata.gz: 4ee2ee99edbc2d8adbaa2d5dcf1cc2b661ee5430af90b8f5f95f6e4c7508fc878b4d83bc93c03d52efa8ea90796448e04992475ec8decc1756b886139d72c01a
+  data.tar.gz: 20d032b6e0c0537d2b6fbcc8d94aaba85e666c643a495bf2093418d731c5655c665a46523b17d11c9361edf683db418a9000e435e98afdaf53f4588a8c7bc794

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 ## Change Log
 
+### v0.8.0 / 2020-08-17
+
+- add bucket encryption
+- add bucket versioning
+- add env parameter to set default log level
+
+### v0.7.3 / 2020-06-28
+
+- add variable control log output path
+
+
+### v0.7.2 / 2020-06-05
+
+- add env parameter to descide whether output log file
+
+### 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
+
 ### v0.6.0 / 2017-07-23
 
 - deps: upgrade rest-client to 2.x

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,13 +33,31 @@ 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)
-          @logger.level = Logger::INFO
+              @log_file, MAX_NUM_LOG, ROTATE_SIZE)
+          @logger.level = get_env_log_level || Logger::INFO
         end
         @logger
       end
 
+      def self.get_env_log_level
+        return unless ENV["ALIYUN_OSS_SDK_LOG_LEVEL"]
+        case ENV["ALIYUN_OSS_SDK_LOG_LEVEL"].upcase
+        when "DEBUG"
+          Logger::DEBUG
+        when "WARN"
+          Logger::WARN
+        when "ERROR"
+          Logger::ERROR
+        when "FATAL"
+          Logger::FATAL
+        when "UNKNOWN"
+          Logger::UNKNOWN
+        end
+      end
+
     end # logging
   end # Common
 end # Aliyun

data/lib/aliyun/oss/bucket.rb

@@ -47,6 +47,34 @@ module Aliyun
         end
       end
 
+      # 获取Bucket的versioning配置
+      # @return [BucketVersioning] Bucket的versioning配置
+      def versioning
+        @protocol.get_bucket_versioning(name)
+      end
+
+      # 设置Bucket的versioning配置
+      # @param versioning [BucketVersioning] versioning配置
+      def versioning=(versioning)
+          @protocol.put_bucket_versioning(name, versioning)
+      end
+
+      # 获取Bucket的encryption配置
+      # @return [BucketEncryption] Bucket的encryption配置
+      def encryption
+        @protocol.get_bucket_encryption(name)
+      end
+
+      # 设置Bucket的encryption配置
+      # @param encryption [BucketEncryption] encryption配置
+      def encryption=(encryption)
+        if encryption.enabled?
+          @protocol.put_bucket_encryption(name, encryption)
+        else
+          @protocol.delete_bucket_encryption(name)
+        end
+      end
+
       # 获取Bucket的website配置
       # @return [BucketWebsite] Bucket的website配置
       def website
@@ -588,42 +616,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

@@ -121,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
 
@@ -280,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

@@ -212,6 +212,105 @@ module Aliyun
         logger.info("Done delete bucket logging")
       end
 
+      # Put bucket versioning settings
+      # @param name [String] the bucket name
+      # @param versioning [BucketVersioning] versioning options
+      def put_bucket_versioning(name, versioning)
+        logger.info("Begin put bucket versioning, "\
+                    "name: #{name}, versioning: #{versioning}")
+
+        sub_res = {'versioning' => nil}
+        body = Nokogiri::XML::Builder.new do |xml|
+          xml.VersioningConfiguration {
+            xml.Status versioning.status
+          }
+        end.to_xml
+
+        @http.put(
+          {:bucket => name, :sub_res => sub_res},
+          {:body => body})
+
+        logger.info("Done put bucket versioning")
+      end
+
+      # Get bucket versioning settings
+      # @param name [String] the bucket name
+      # @return [BucketVersioning] versioning options of this bucket
+      def get_bucket_versioning(name)
+        logger.info("Begin get bucket versioning, name: #{name}")
+
+        sub_res = {'versioning' => nil}
+        r = @http.get({:bucket => name, :sub_res => sub_res})
+
+        doc = parse_xml(r.body)
+
+        versioning_node = doc.at_css("VersioningConfiguration")
+        opts = {
+          :status => get_node_text(versioning_node, 'Status')
+        }
+
+        logger.info("Done get bucket versioning")
+
+        BucketVersioning.new(opts)
+      end
+
+      # Put bucket encryption settings
+      # @param name [String] the bucket name
+      # @param encryption [BucketEncryption] encryption options
+      def put_bucket_encryption(name, encryption)
+        logger.info("Begin put bucket encryption, "\
+                    "name: #{name}, encryption: #{encryption}")
+
+        sub_res = {'encryption' => nil}
+        body = Nokogiri::XML::Builder.new do |xml|
+          xml.ServerSideEncryptionRule {
+            xml.ApplyServerSideEncryptionByDefault {
+              xml.SSEAlgorithm encryption.sse_algorithm
+              xml.KMSMasterKeyID encryption.kms_master_key_id if encryption.kms_master_key_id
+            }
+          }
+        end.to_xml
+
+        @http.put(
+          {:bucket => name, :sub_res => sub_res},
+          {:body => body})
+
+        logger.info("Done put bucket encryption")
+      end
+
+      # Get bucket encryption settings
+      # @param name [String] the bucket name
+      # @return [BucketEncryption] encryption options of this bucket
+      def get_bucket_encryption(name)
+        logger.info("Begin get bucket encryption, name: #{name}")
+
+        sub_res = {'encryption' => nil}
+        r = @http.get({:bucket => name, :sub_res => sub_res})
+
+        doc = parse_xml(r.body)
+
+        encryption_node = doc.at_css("ApplyServerSideEncryptionByDefault")
+        opts = {
+          :sse_algorithm => get_node_text(encryption_node, 'SSEAlgorithm'),
+          :kms_master_key_id => get_node_text(encryption_node, 'KMSMasterKeyID')
+        }
+
+        logger.info("Done get bucket encryption")
+
+        BucketEncryption.new(opts)
+      end
+
+      # Delete bucket encryption settings, a.k.a. disable bucket encryption
+      # @param name [String] the bucket name
+      def delete_bucket_encryption(name)
+        logger.info("Begin delete bucket encryption, name: #{name}")
+
+        sub_res = {'encryption' => nil}
+        @http.delete({:bucket => name, :sub_res => sub_res})
+
+        logger.info("Done delete bucket encryption")
+      end
+
       # Put bucket website settings
       # @param name [String] the bucket name
       # @param website [BucketWebsite] the bucket website options
@@ -346,10 +445,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 +1493,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 +1630,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