aliyun-sdk 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a27f8d07de2e2948e0af93983d9deee1fe09afcdc78be58f4387406061e19bc1
-  data.tar.gz: 5f8ee19a0277de7a739221521621ef7be34f8a597f95b688819c737ec746dd1d
+  metadata.gz: 9ed62a6f5a59df2499c7fd4028b4aecfad8506018ef7a3425b1c7627e0f8ddc8
+  data.tar.gz: eb47336dccf3d526466e6cbf5fbf3a845c4f9b8be5d34a5b7f7a55cd6b87f693
 SHA512:
-  metadata.gz: 5d63ecabcb9835ef73d8e1cb0bf4cebe94e8bdb16c3ea4f890ffcfe7be93edd9874a4b6c0efc175e7f545715b616e6e995cb193b8a16b8215bbfb601ccf4e65f
-  data.tar.gz: 64a6931f66da611f9be61fa18ad172fe6c0ba69a4e8c0afd2f286fb2e9aa7b9d243da984cc1e1f98a8bfe035ddc198cf240114811b51a24c7b84c365def14753
+  metadata.gz: 4ee2ee99edbc2d8adbaa2d5dcf1cc2b661ee5430af90b8f5f95f6e4c7508fc878b4d83bc93c03d52efa8ea90796448e04992475ec8decc1756b886139d72c01a
+  data.tar.gz: 20d032b6e0c0537d2b6fbcc8d94aaba85e666c643a495bf2093418d731c5655c665a46523b17d11c9361edf683db418a9000e435e98afdaf53f4588a8c7bc794

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 ## 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
+- add variable control log output path
 
 
 ### v0.7.2 / 2020-06-05

data/lib/aliyun/common/logging.rb

@@ -37,11 +37,27 @@ module Aliyun
           @log_file ||= ENV["ALIYUN_OSS_SDK_LOG_PATH"]
           @logger = Logger.new(
               @log_file, MAX_NUM_LOG, ROTATE_SIZE)
-          @logger.level = Logger::INFO
+          @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

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

data/lib/aliyun/oss/struct.rb

@@ -74,6 +74,31 @@ module Aliyun
       end
     end
 
+    ##
+    # Bucket Versioning setting. See: {http://help.aliyun.com/document_detail/oss/product-documentation/function/versioning.html OSS Bucket versioning}
+    # Attributes:
+    # * status [String] the bucket versioning status, can be 'Enabled' and 'Suspended'
+    # @example Enable bucket versioning
+    #  bucket.versioning = BucketVersioning.new(:status => 'Enabled')
+    # @example Suspend bucket versioning
+    #  bucket.versioning = BucketVersioning.new(:status => 'Suspended')
+    class BucketVersioning < Common::Struct::Base
+      attrs :status
+    end
+    
+    ##
+    # Bucket Encryption setting. See: {http://help.aliyun.com/document_detail/oss/product-documentation/function/encryption.html OSS Bucket encryption}
+    # Attributes:
+    # * sse_algorithm [string] Indicates the default server-side encryption method
+    # * kms_master_key_id [string] Indicates the ID of CMK that is currently used.
+    class BucketEncryption < Common::Struct::Base
+      attrs :enable, :sse_algorithm, :kms_master_key_id
+
+      def enabled?
+        enable == true
+      end
+    end
+
     ##
     # Bucket website setting. See: {http://help.aliyun.com/document_detail/oss/product-documentation/function/host-static-website.html OSS Website hosting}
     # Attributes:

data/lib/aliyun/version.rb

@@ -2,6 +2,6 @@
 
 module Aliyun
 
-    VERSION = "0.7.3"
+    VERSION = "0.8.0"
 
 end # Aliyun

data/spec/aliyun/oss/bucket_spec.rb

@@ -96,6 +96,25 @@ module Aliyun
         end.to_xml
       end
 
+      def mock_versioning(opts)
+        Nokogiri::XML::Builder.new do |xml|
+          xml.VersioningConfiguration {
+            xml.Status opts.status
+          }
+        end.to_xml
+      end
+
+      def mock_encryption(opts)
+        Nokogiri::XML::Builder.new do |xml|
+          xml.ServerSideEncryptionRule {
+            xml.ApplyServerSideEncryptionByDefault {
+              xml.SSEAlgorithm opts.sse_algorithm
+              xml.KMSMasterKeyID opts.kms_master_key_id if opts.kms_master_key_id
+            }
+          }
+        end.to_xml
+      end
+
       def mock_website(opts)
         Nokogiri::XML::Builder.new do |xml|
           xml.WebsiteConfiguration {
@@ -354,7 +373,7 @@ module Aliyun
         end
       end # delete bucket
 
-      context "acl, logging, website, referer, lifecycle" do
+      context "acl, logging, versioning, encryption, website, referer, lifecycle" do
         it "should update acl" do
           query = {'acl' => nil}
           stub_request(:put, request_path).with(:query => query)

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

@@ -376,6 +376,130 @@ module Aliyun
             .with(:query => query, :body => nil)
         end
 
+		it "should set versioning" do
+          query = {'versioning' => nil}
+
+          body = Nokogiri::XML::Builder.new do |xml|
+            xml.VersioningConfiguration {
+              xml.Status 'Enabled'
+            }
+            end.to_xml
+
+          stub_request(:put, bucket_url)
+            .with(:query => query)
+            .to_return(status: 200, :body => nil)
+
+          @bucket.versioning = BucketVersioning.new(:status => 'Enabled')
+
+          expect(WebMock).to have_requested(:put, bucket_url)
+            .with(:query => query, :body => body)
+        end
+
+		it "should get versioning" do
+          query = {'versioning' => nil}
+
+          body = Nokogiri::XML::Builder.new do |xml|
+            xml.VersioningConfiguration {
+              xml.Status 'Enabled'
+            }
+            end.to_xml
+
+          stub_request(:get, bucket_url)
+            .with(:query => query)
+            .to_return(status: 200, :body => body)
+
+          ret = @bucket.versioning
+
+          expect(WebMock).to have_requested(:get, bucket_url)
+            .with(:query => query, :body => nil)
+
+          expect(ret.status).to eq('Enabled')
+        end
+
+		it "should set encryption with aes256" do
+          query = {'encryption' => nil}
+
+          body = Nokogiri::XML::Builder.new do |xml|
+            xml.ServerSideEncryptionRule {
+              xml.ApplyServerSideEncryptionByDefault {
+                xml.SSEAlgorithm 'AES256'
+              }
+            }
+            end.to_xml
+
+          stub_request(:put, bucket_url)
+            .with(:query => query)
+            .to_return(status: 200, :body => nil)
+
+          @bucket.encryption = BucketEncryption.new(:enable => true, :sse_algorithm => 'AES256')
+
+          expect(WebMock).to have_requested(:put, bucket_url)
+            .with(:query => query, :body => body)
+        end
+
+		it "should set encryption with KMS" do
+          query = {'encryption' => nil}
+
+          body = Nokogiri::XML::Builder.new do |xml|
+            xml.ServerSideEncryptionRule {
+              xml.ApplyServerSideEncryptionByDefault {
+                xml.SSEAlgorithm 'KMS'
+                xml.KMSMasterKeyID 'kms-id'
+              }
+            }
+            end.to_xml
+
+          stub_request(:put, bucket_url)
+            .with(:query => query)
+            .to_return(status: 200, :body => nil)
+
+          @bucket.encryption = BucketEncryption.new(
+			:enable => true, 
+			:sse_algorithm => 'KMS', 
+			:kms_master_key_id => 'kms-id')
+
+          expect(WebMock).to have_requested(:put, bucket_url)
+            .with(:query => query, :body => body)
+        end
+
+		it "should get encryption" do
+          query = {'encryption' => nil}
+
+          body = Nokogiri::XML::Builder.new do |xml|
+            xml.ServerSideEncryptionRule {
+              xml.ApplyServerSideEncryptionByDefault {
+                xml.SSEAlgorithm 'KMS'
+                xml.KMSMasterKeyID 'kms-id'
+              }
+            }
+            end.to_xml
+
+          stub_request(:get, bucket_url)
+            .with(:query => query)
+            .to_return(status: 200, :body => body)
+
+          ret = @bucket.encryption
+
+          expect(WebMock).to have_requested(:get, bucket_url)
+            .with(:query => query, :body => nil)
+
+          expect(ret.sse_algorithm).to eq('KMS')
+          expect(ret.kms_master_key_id).to eq('kms-id')
+        end
+
+		it "should delete encryption" do
+          query = {'encryption' => nil}
+
+          stub_request(:delete, bucket_url)
+            .with(:query => query)
+            .to_return(status: 204, :body => nil)
+
+          @bucket.encryption = BucketEncryption.new(:enable => false)
+
+          expect(WebMock).to have_requested(:delete, bucket_url)
+            .with(:query => query, :body => nil)
+        end
+
         it "should get bucket url" do
           expect(@bucket.bucket_url)
             .to eq('http://rubysdk-bucket.oss-cn-hangzhou.aliyuncs.com/')

data/tests/test_bucket.rb

@@ -0,0 +1,73 @@
+require 'minitest/autorun'
+require 'yaml'
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require 'aliyun/oss'
+require 'time'
+require_relative 'config'
+
+class TestBucket < Minitest::Test
+  def setup
+    Aliyun::Common::Logging.set_log_level(Logger::DEBUG)
+    @client = Aliyun::OSS::Client.new(TestConf.creds)
+    @bucket_name = TestConf.bucket + Time.now.to_i.to_s
+    @client.create_bucket(@bucket_name)
+    @bucket = @client.get_bucket(@bucket_name)
+  end
+
+  def teardown
+    @client.delete_bucket(@bucket_name)
+  end
+
+  def test_bucket_versioning
+    ret = @bucket.versioning
+    assert_nil ret.status
+
+    @bucket.versioning =  Aliyun::OSS::BucketVersioning.new(:status => 'Enabled')
+    ret = @bucket.versioning
+    assert_equal 'Enabled', ret.status
+
+    @bucket.versioning =  Aliyun::OSS::BucketVersioning.new(:status => 'Suspended')
+    ret = @bucket.versioning
+    assert_equal 'Suspended', ret.status
+
+  end
+
+  def test_bucket_encryption
+
+    begin
+      ret = @bucket.encryption
+      assert_raises "should not here"
+    rescue => exception
+    end  
+
+    @bucket.encryption =  Aliyun::OSS::BucketEncryption.new(
+      :enable => true,
+      :sse_algorithm => 'KMS')
+    ret = @bucket.encryption
+    assert_equal 'KMS', ret.sse_algorithm
+    assert_nil ret.kms_master_key_id
+
+    @bucket.encryption =  Aliyun::OSS::BucketEncryption.new(
+      :enable => true,
+      :sse_algorithm => 'KMS',
+      :kms_master_key_id => 'kms-id')
+    ret = @bucket.encryption
+    assert_equal 'KMS', ret.sse_algorithm
+    assert_equal 'kms-id', ret.kms_master_key_id
+
+    @bucket.encryption =  Aliyun::OSS::BucketEncryption.new(
+      :enable => true,
+      :sse_algorithm => 'AES256')
+    ret = @bucket.encryption
+    assert_equal 'AES256', ret.sse_algorithm
+    assert_nil ret.kms_master_key_id
+
+    @bucket.encryption =  Aliyun::OSS::BucketEncryption.new(
+      :enable => false)
+    begin
+      ret = @bucket.encryption
+      assert_raises "should not here"
+    rescue => exception
+    end  
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Tianlong Wu
 autorequire: 
 bindir: lib/aliyun
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -200,6 +200,7 @@ files:
 - spec/aliyun/sts/util_spec.rb
 - tests/config.rb
 - tests/helper.rb
+- tests/test_bucket.rb
 - tests/test_content_encoding.rb
 - tests/test_content_type.rb
 - tests/test_crc_check.rb
@@ -249,6 +250,7 @@ test_files:
 - spec/aliyun/sts/util_spec.rb
 - tests/config.rb
 - tests/helper.rb
+- tests/test_bucket.rb
 - tests/test_content_encoding.rb
 - tests/test_content_type.rb
 - tests/test_crc_check.rb