aliyun-oss-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f9ea0e6c34c0a6d15ff9c7f1c5b7063eab4c74
+  data.tar.gz: 3ff1e1a73d6b74bbaec4ff7e23179197197978ae
+SHA512:
+  metadata.gz: 12ca936fc5538dac82a12a6dd1ec3057f12d31bf0bd163931e6bc98b0215070abbd76c6191d8de1ae4e8d346249217c7a7ebad8948aed0a871bb5471117e3568
+  data.tar.gz: 5917b901eed5f2b8182719474418b212382bfdd678c93a95a29ef3ea33e3aa4d169715f153648281837edd02cb84a5a83f36cfb81b01b6f518f7c890adf6c6f1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://ruby.taobao.org'
+
+# Specify your gem's dependencies in ruby-oss-sdk.gemspec
+gemspec

data/README.md

@@ -0,0 +1,195 @@
+# Aliyun OSS SDK
+
+[![Coverage Status](https://coveralls.io/repos/zlx/ruby-oss-sdk/badge.svg?branch=master&service=bitbucket)](https://coveralls.io/bitbucket/zlx/ruby-oss-sdk?branch=master)
+
+-----
+
+
+It provide One-to-one Ruby interface for Aliyun OSS Restful API. I try to keep things natural and reasonable, but there are always some places are leaky, welcome to give me advice and modification. Thank you!
+
+
+## Document
+
++ [ALiyun OSS API](https://docs.aliyun.com/#/pub/oss/api-reference/overview)
++ [Ruby Document]()
+
+
+## Usage    
+
+### Quick Start
+
+    require 'aliyun/oss'
+    
+    # ACCESS_KEY/SECRET_KEY is your access credentials, Aliyun provide three ways, read detail at https://docs.aliyun.com/#/pub/oss/product-documentation/acl&RESTAuthentication
+    # host: your bucket's data center host, eg: oss-cn-hangzhou.aliyuncs.com, visit https://docs.aliyun.com/#/pub/oss/product-documentation/domain-region#menu2 get full list
+    # bucket: your bucket name
+	
+	client = Aliyun::OSS::Client.new('ACCESS_KEY', 'SECRET_KEY', host: 'oss-cn-hangzhou.aliyuncs.com', bucket: 'oss-sdk-dev-hangzhou')
+	
+	# Get all objects in this bucket
+	# use prefix，marker，delimiter, max-keys to filter results
+	client.bucket_list_objects()
+	
+	# Upload objects
+	client.bucket_create_object('image.png', File.new('path/to/image.png'), { 'Content-Type' => 'image/png' })
+	
+	# Get Object
+	client.bucket_get_object('image.png')
+    
+
+### Share your files
+
+Sometimes, you want to share some file in your private bucket with your friends , but you donot want to share your AccessKey, thus, Aliyun provide alternative way: [Put signature in URL](https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-url)
+
+We provide a method to calculate signature for you:
+
+    # Return Singature string
+    Aliyun::Oss::Authorization.get_temporary_signature('SECRET_KEY', Time.now.to_i + 60*60, verb: 'GET', bucket: 'bucket-name', key: 'object-name')
+
+
+### Directly POST file to Aliyun OSS
+
+Sometime we may allow user directly upload image or file to Aliyun to improve the upload speed. thus you may need POST form: [Post Object](https://docs.aliyun.com/#/pub/oss/api-reference/object&PostObject)
+
+With Post Form, we need Post Policy to restrict permissions, here we provide two methods that you may interesting:
+
+     # policy your policy in hash
+     # Return base64 string which can used to fill your form field: policy
+     client.get_base64_policy(policy)
+     
+     # Get Signature for policy
+     # Return Signature with policy, can used to fill your form field: Signature
+     client.get_policy_signature(SECRET_KEY, policy)
+
+
+### Full API
+
+
+    ###### Bucket #####
+    
+    # Get all buckets information
+	client.list_buckets
+	
+	# Create new buckets
+	client.bucket_create('oss-sdk-dev-beijing-no1', 'oss-cn-beijing', 'public-read')
+	
+	# Delete bucket
+	client.bucket_delete(name)
+	
+	# Get all objects in this bucket
+	# use prefix，marker，delimiter, max-keys to filter results
+	client.bucket_list_objects()
+	
+		
+	#### Get information of this bucket  ####
+	
+	client.bucket_get_acl
+	client.bucket_get_cors
+	client.bucket_get_lifecycle
+	client.bucket_get_location
+	client.bucket_get_logging
+	client.bucket_get_referer
+	client.bucket_get_website
+	
+	
+	##### Set the bucket properties  ####
+	
+	# set cors for bucket
+	rule = Aliyun::Oss::Rule::Cors.new({ allowed_methods: ['get'], allowed_origins: ['*'] })
+	client.bucket_enable_cors([rule])
+	client.bucket_disable_cors	# Disable and remove existing cors
+	
+	# Set lifecycle for bucket
+	rule1 = Aliyun::Oss::Rule::LifeCycle.new({ prefix: 'logs-prod-', days: 7, enable: true })
+	rule2 = Aliyun::Oss::Rule::LifeCycle.new({ prefix: 'logs-dev', date: Time.now + 24*60*60, enable: true })
+	client.bucket_enable_lifecycle([rule1, rule2])
+	client.bucket_disable_lifecycle  # Disable and remove existing lifecycle
+	
+	# Enable  access logging for bucket
+	client.bucket_enable_logging('logs-oss-sdk', 'logs-')
+	client.bucket_disable_logging  # Disable logging
+	
+	# Set bucket to static web sites hosted mode.
+	client.bucket_enable_website('index.html', 'error.html')
+	client.bucket_disable_website  # Disable static web sites hosted mode
+	
+	# Set Referer for this bucket
+	client.bucket_set_referer(['http://www.aliyun.com'], false)
+	
+	# Set ACL for bucket
+	# supported value: public-read-write | public-read | private
+	client.bucket_set_acl('public-read')
+	
+	
+	#### Object ####
+	
+	# Upload object to bucket
+	client.bucket_create_object("image.png", File.new("path/to/image.png"), { 'Content-Type' => 'image/png' })
+	
+	# Copy object from other bucket
+	client.bucket_copy_object('new_image.png', 'origin-bucket-name', 'origin.png', { 'x-oss-metadata-directive' => 'REPLACE' })
+	
+	# Get a Object
+	client.bucket_get_object("image.png")
+	
+	# Get meta information of object
+	client.bucket_get_meta_object("image.png")
+	
+	# Get object ACL
+	client.bucket_get_object_acl("image.png")
+	
+	# Set object ACL
+	client.bucket_set_object_acl("image.png", 'public-read-write')
+	
+	# upload object with append
+	# it will create a Appendable object
+	# https://docs.aliyun.com/#/pub/oss/api-reference/object&AppendObject
+	client.bucket_append_object("secret.zip", Bin Data, 0)  # return the last position, 100203
+	client.bucket_append_object("secret.zip", Bin Data, 100203)
+	
+	# Delete Object
+	client.bucket_delete_object('secret.zip)
+	
+	# Delete Multiple objects
+	client.bucket_delete_objects(['secret.zip', 'image.png'], true)
+	
+	
+	
+	#### Multipart Upload  ####  
+	
+	# Init a Multipart Upload event
+	client.bucket_init_multipart("Exciting-Ruby.mp4", { 'Content-Type' => 'video/mp4' })  # return upload ID "98A6524428734723BE8F81D72B5295EE"
+	
+	# Upload files
+	client.bucket_multipart_upload("Exciting-Ruby.mp4", 1, "98A6524428734723BE8F81D72B5295EE", file1)  # return etag for use later
+	client.bucket_multipart_upload("Exciting-Ruby.mp4", 2, "98A6524428734723BE8F81D72B5295EE", file2)
+	client.bucket_multipart_upload("Exciting-Ruby.mp4", 3, "98A6524428734723BE8F81D72B5295EE", file3)
+	
+	# Copy from existing object
+	client.bucket_multipart_copy_upload("Exciting-Ruby.mp4", 4, "98A6524428734723BE8F81D72B5295EE", source_bucket: 'original-bucket-name', source_key: 'original-file', range: 'bytes=0-10000')
+	
+	# List uploaded parts for a Multipart Upload event
+	client.bucket_list_parts("sample_multipart.data", "98A6524428734723BE8F81D72B5295EE")  
+	
+	# Complete a Multipart Upload event
+	part1 = Aliyun::Oss::Multipart::Part.new({ number: 1, etag: 'etag1' })
+	part2 = Aliyun::Oss::Multipart::Part.new({ number: 2, etag: 'etag2' })
+	part3 = Aliyun::Oss::Multipart::Part.new({ number: 3, etag: 'etag3' })
+	client.bucket_complete_multipart("Exciting-Ruby.mp4", "98A6524428734723BE8F81D72B5295EE", [part1, part2, part3])
+	
+	# Abort a Multipart Upload event
+	# abort will remove all uploaded parts
+	# invoke a few time to confirm all parts are deleted for concurrency access
+	client.bucket_abort_multipart("Exciting-Ruby.mp4", "9FB6F32C2DC24E04B813963B58E29E68")
+
+
+
+
+## Authors && Contributors
+
+- [Newell Zhu](https://github.com/zlx_star)
+
+
+## License
+
+licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/aliyun-oss.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun/oss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aliyun-oss-sdk'
+  spec.version       = Aliyun::Oss::VERSION
+  spec.authors       = ['Newell Zhu']
+  spec.email         = ['zlx.star@gmail.com']
+
+  spec.summary       = 'Aliyun OSS Ruby SDK'
+  spec.description   = 'Aliyun OSS Ruby SDK'
+  spec.homepage      = 'http://github.com/aliyun/ruby-oss-sdk'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'gyoku'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'simplecov'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'aliyun/oss'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aliyun/oss.rb

@@ -0,0 +1,21 @@
+require 'aliyun/oss/version'
+
+module Aliyun
+  module Oss
+    autoload :Utils,            'aliyun/oss/utils'
+    autoload :Client,           'aliyun/oss/client'
+    autoload :Http,             'aliyun/oss/http'
+    autoload :XmlBuilder,       'aliyun/oss/xml_builder'
+    autoload :Authorization,    'aliyun/oss/authorization'
+
+    module Rule
+      autoload :LifeCycle,      'aliyun/oss/rule/lifecycle'
+      autoload :Cors,           'aliyun/oss/rule/cors'
+    end
+
+    module Multipart
+      autoload :Part,           'aliyun/oss/multipart/part'
+    end
+
+  end
+end

data/lib/aliyun/oss/authorization.rb

@@ -0,0 +1,117 @@
+require 'base64'
+require 'openssl'
+require 'digest'
+require 'json'
+
+module Aliyun
+  module Oss
+    class Authorization
+      PROVIDER = 'OSS'
+
+      # Get temporary Signature
+      #
+      # @see {https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-url Tempoorary Signature}
+      #
+      # @param secret_key [String] Secret Key
+      # @param expires [Integer] the number of seconds since January 1, 1970 UTC. used to specified expired time
+      # @param [Hash] options other options
+      # @option options [String] :key the object name
+      # @option options [String] :bucket bucket name
+      # @option options [String] :verb, Request Method
+      # @option options [Hash] :query Query Params
+      # @option options [Hash] :headers Headers Params
+      #
+      # @return [String]
+      def self.get_temporary_signature(secret_key, expire_time, options = {})
+        content_string = concat_content_string(options[:verb], expire_time, options)
+        URI.escape(signature(secret_key, content_string).strip)
+      end
+
+      # Get base64 encoded string, used to fill policy field
+      #
+      # @see {https://docs.aliyun.com/#/pub/oss/api-reference/object&PostObject Post Object}
+      #
+      # @param secret_key [String] Secret Key
+      # @param policy [Hash] Policy {https://docs.aliyun.com/#/pub/oss/api-reference/object&PostObject#menu7 Detail}
+      #
+      # @return [String]
+      def self.get_base64_policy(policy)
+        Base64.encode64(JSON.generate(policy).force_encoding('utf-8')).delete("\n")
+      end
+
+      # Get Signature for policy
+      #
+      # @see {https://docs.aliyun.com/#/pub/oss/api-reference/object&PostObject}
+      #
+      # @param secret_key [String] Secret Key
+      # @param policy [Hash] Policy {https://docs.aliyun.com/#/pub/oss/api-reference/object&PostObject#menu7 Detail}
+      #
+      # @return [String]
+      def self.get_policy_signature(secret_key, policy)
+        signature(secret_key, get_base64_policy(policy)).strip
+      end
+
+      # @private
+      #
+      # Get authorization key
+      #
+      # @see {https://docs.aliyun.com/#/pub/oss/api-reference/access-control&signature-header Authorization}
+      #
+      # @return [String] the authorization string
+      def self.get_authorization(access_key, secret_key, options = {})
+        content_string = concat_content_string(options[:verb], options[:date], options)
+        signature_string = signature(secret_key, content_string)
+        "#{PROVIDER} #{access_key}:#{signature_string.strip}"
+      end
+
+      private
+
+      def self.concat_content_string(verb, time, options = {})
+        headers = options.fetch(:headers, {})
+
+        cononicalized_oss_headers = get_cononicalized_oss_headers(headers)
+        cononicalized_resource = get_cononicalized_resource(*options.values_at(:bucket, :key, :query))
+
+        if cononicalized_oss_headers
+          [
+            verb.upcase,
+            headers['Content-MD5'],
+            headers['Content-Type'],
+            time,
+            cononicalized_oss_headers,
+            cononicalized_resource
+          ].join("\n")
+        else
+          [
+            verb.upcase,
+            headers['Content-MD5'],
+            headers['Content-Type'],
+            time,
+            cononicalized_resource
+          ].join("\n")
+        end
+      end
+
+      def self.signature(secret_key, content_string)
+        utf8_string = content_string.force_encoding('utf-8')
+        Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, secret_key, utf8_string))
+      end
+
+      def self.get_cononicalized_oss_headers(headers)
+        oss_headers = (headers || {}).select { |key, _| key.to_s.downcase.start_with?('x-oss-') }
+        return if oss_headers.empty?
+
+        oss_headers.keys.sort.map { |key| "#{key.downcase}:#{oss_headers[key]}" }.join("\n")
+      end
+
+      def self.get_cononicalized_resource(bucket, key, query)
+        cononicalized_resource = '/'
+        cononicalized_resource += "#{bucket}/" if bucket
+        cononicalized_resource += key if key
+        return cononicalized_resource if query.nil? || query.empty?
+
+        cononicalized_resource + '?' + query.keys.sort.map { |key| "#{key}=#{query[key]}" }.join('&')
+      end
+    end
+  end
+end

data/lib/aliyun/oss/client.rb

@@ -0,0 +1,635 @@
+require 'base64'
+require 'openssl'
+require 'digest'
+require 'httparty'
+
+module Aliyun
+  module Oss
+    class Client
+      attr_reader :access_key, :secret_key, :bucket
+
+      # Initialize a object
+      #
+      # @example
+      #   Aliyun::Oss::Client.new("ACCESS_KEY", "SECRET_KEY", host: "oss-cn-beijing.aliyuncs.com", bucket: 'oss-sdk-beijing')
+      #
+      # @param access_key [String] access_key obtained from aliyun
+      # @param secret_key [String] secret_key obtained from aliyun
+      # @option options [String] :host host for bucket's data center
+      # @option options [String] :bucket Bucket name
+      #
+      # @return [Client] the object
+      def initialize(access_key, secret_key, options = {})
+        @access_key = access_key
+        @secret_key = secret_key
+        @options = options
+        @bucket = options[:bucket]
+      end
+
+      # List buckets
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/service&GetService GetService (ListBucket
+      #
+      # @param options [Hash] options
+      # @option options [String] :prefix Filter buckets with prefix
+      # @option options [String] :marker Bucket name should after marker in alphabetical order
+      # @option options [Integer] :max-keys (100) Limit number of buckets, the maxinum should <= 1000
+      #
+      # @return [Object{buckets}]
+      def list_buckets(options = {})
+        query = Utils.hash_slice(options, 'prefix', 'marker', 'max-keys')
+        http.get('/', query: query)
+      end
+
+      # List objects in the bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucket Get Bucket (List Object)
+      #
+      # @param options [Hash] options
+      # @option options [String] :prefix Filter objects with prefix
+      # @option options [String] :marker Result should after marker in alphabetical order
+      # @option options [Integer] :max-keys (100) Limit number of objects, the maxinum should <= 1000
+      # @option options [String] :delimiter Used to group objects with delimiter
+      # @option options [String] :encoding-type Encoding type used for unsupported character
+      #
+      # @return [Object{objects}]
+      def bucket_list_objects(options = {})
+        accepted_keys = ['prefix', 'marker', 'max-keys', 'delimiter', 'encoding-type']
+        query = Utils.hash_slice(options, *accepted_keys)
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Create bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucket Put Bucket
+      #
+      # @example
+      #  oss.client.bucket_create('oss-sdk-dev-hangzhou-xxx')
+      #
+      # @param name [String] Specify bucket name
+      # @param location [String] Specify the bucket's data center location, can be one of below:
+      #   oss-cn-hangzhou,oss-cn-qingdao,oss-cn-beijing,oss-cn-hongkong,
+      #   oss-cn-shenzhen,oss-cn-shanghai,oss-us-west-1 ,oss-ap-southeast-1
+      # @param acl [String] Specify the bucket's access. (see #bucket_set_acl)
+      #
+      # @return [Response]
+      def bucket_create(name, location = 'oss-cn-hangzhou', acl = 'private')
+        query = { 'acl' => true }
+        headers = { 'x-oss-acl' => acl }
+
+        configuration = { 'CreateBucketConfiguration' => { 'LocationConstraint' => location } }
+        body = Utils.to_xml(configuration)
+
+        http.put('/', query: query, headers: headers, body: body, bucket: name, location: location)
+      end
+
+      # Delete bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucket Delete Bucket
+      #
+      # @param name [String] bucket name want to delete
+      #
+      # @return [Response]
+      def bucket_delete(name)
+        http.delete('/', bucket: name)
+      end
+
+      # Used to modify the bucket access.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketACL Put Bucket Acl
+      #
+      # @param acl [String] supported value: public-read-write | public-read | private
+      def bucket_set_acl(acl)
+        query = { 'acl' => true }
+        headers = { 'x-oss-acl' => acl }
+        http.put('/', query: query, headers: headers, bucket: bucket)
+      end
+
+      # Used to enable access logging.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketLogging Put Bucket Logging
+      #
+      # @param target_bucket [String] specifies the bucket where you want Aliyun OSS to store server access logs.
+      # @param target_prefix [String] this element lets you specify a prefix for the objects that the log files will be stored.
+      def bucket_enable_logging(target_bucket, target_prefix = nil)
+        query = { 'logging' => true }
+
+        logging = { 'TargetBucket' => target_bucket }
+        logging.merge!('TargetPrefix' => target_prefix) if target_prefix
+        body = Utils.to_xml('BucketLoggingStatus' => { 'LoggingEnabled' => logging })
+
+        http.put('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Used to disable access logging.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketLogging Delete Bucket Logging
+      def bucket_disable_logging
+        query = { 'logging' => false }
+        http.delete('/', query: query, bucket: bucket)
+      end
+
+      # Used to enable static website hosted mode.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketWebsite Put Bucket Website
+      #
+      # @param suffix [String] A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
+      # @param key [String] The object key name to use when a 4XX class error occurs
+      def bucket_enable_website(suffix, key = nil)
+        query = { 'website' => true }
+
+        website_configuration = { 'IndexDocument' => { 'Suffix' => suffix } }
+        website_configuration.merge!('ErrorDocument' => { 'Key' => key }) if key
+        body = Utils.to_xml('WebsiteConfiguration' => website_configuration)
+
+        http.put('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Used to disable website hostted mode.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketWebsite Delete Bucket Website
+      def bucket_disable_website
+        query = { 'website' => false }
+        http.delete('/', query: query, bucket: bucket)
+      end
+
+      # Used to set referer for bucket.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketReferer Put Bucket Referer
+      #
+      # @param referers [Array<String>] white list for allowed referer.
+      # @param allowed_empty [Boolean] whether allow empty refer.
+      #
+      # @return [Response]
+      def bucket_set_referer(referers = [], allowed_empty = false)
+        query = { 'referer' => true }
+
+        referer_configuration = { 'RefererConfiguration' => { 'AllowEmptyReferer' => allowed_empty, 'RefererList' => { 'Referer' => referers } } }
+        body = Utils.to_xml(referer_configuration)
+
+        http.put('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Used to enable and set lifecycle for bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketLifecycle Put Bucket Lifecycle
+      #
+      # @param rules [Array<Rule::LifeCycle>] rules for lifecycle
+      #
+      # @return [Response]
+      def bucket_enable_lifecycle(rules = [])
+        query = { 'lifecycle' => true }
+
+        body = Utils.to_xml('LifecycleConfiguration' => {
+                              'Rule' => rules.map(&:to_hash)
+                            })
+
+        http.put('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Used to disable lifecycle for bucket.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketLifecycle Delete Bucket Lifecycle
+      def bucket_disable_lifecycle
+        query = { 'lifecycle' => false }
+        http.delete('/', query: query, bucket: bucket)
+      end
+
+      # Used to enable CORS and set rules for bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&PutBucketcors Put Bucket cors
+      #
+      # @param rules [Array<Rule::Cors>] array of rule
+      #
+      # @return [Response]
+      def bucket_enable_cors(rules = [])
+        query = { 'cors' => true }
+
+        body = Utils.to_xml('CORSConfiguration' => {
+                              'CORSRule' => rules.map(&:to_hash)
+                            })
+
+        http.put('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Used to disable cors and clear rules for bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&DeleteBucketcors Delete Bucket cors
+      #
+      # @return [Response]
+      def bucket_disable_cors
+        query = { 'cors' => false }
+        http.delete('/', query: query, bucket: bucket)
+      end
+
+      # OPTIONS Object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&OptionObject OPTIONS Object
+      #
+      # @param origin [String] the requested source domain, denoting cross-domain request.
+      # @param request_method [String] the actual request method will be used.
+      # @param request_headers [Array<String>] the actual used headers except simple headers will be used.
+      # @param object_name [String] the object name will be visit.
+      #
+      # @return [Response]
+      def bucket_preflight(origin, request_method, request_headers = [], object_name = nil)
+        uri = object_name ? "/#{object_name}" : '/'
+
+        headers = { 'Origin' => origin, 'Access-Control-Request-Method' => request_method }
+        unless request_headers.empty?
+          headers.merge!('Access-Control-Request-Headers' => request_headers.join(','))
+        end
+
+        http.options(uri, headers: headers, bucket: bucket, key: object_name)
+      end
+
+      # Get ACL for bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketAcl Get Bucket ACL
+      #
+      # @return [Response]
+      def bucket_get_acl
+        query = { 'acl' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the location information of the Bucket's data center
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLocation Get Bucket Location
+      #
+      # @return [Response]
+      def bucket_get_location
+        query = { 'location' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the log configuration of Bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLogging Get Bucket Logging
+      #
+      # @return [Response]
+      def bucket_get_logging
+        query = { 'logging' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the bucket state of static website hosting.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketWebsite Get Bucket Website
+      #
+      # @return [Response]
+      def bucket_get_website
+        query = { 'website' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the referer configuration of bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketReferer Get Bucket Referer
+      #
+      # @return [Response]
+      def bucket_get_referer
+        query = { 'referer' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the lifecycle configuration of bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLifecycle Get Bucket Lifecycle
+      #
+      # @return [Response]
+      def bucket_get_lifecycle
+        query = { 'lifecycle' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Get the CORS rules of bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&GetBucketcors Get Bucket cors
+      #
+      # @return [Response]
+      def bucket_get_cors
+        query = { 'cors' => true }
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # Upload file to bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&PutObject Put Object
+      #
+      # @param key [String] Specify object name
+      # @param file [File, Bin data] Specify need upload resource
+      # @param [Hash] headers Specify other options
+      # @option headers [String] :Content-Type ('application/x-www-form-urlencoded') Specify Content-Type for the object
+      # @option headers [String] :Cache-Control Specify the caching behavior when download from browser, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [String] :Content-Disposition Specify the name when download, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [String] :Content-Encoding Specify the content encoding when download, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [String] :Content-MD5 RFC 1864 according to the agreement of the message Content (not including head) are calculated MD5 value 128 bits number, the number is base64 encoding for the Content of a message - MD5 value.The legality of the examination of the request headers can be used for information (a message content is consistent with send).Although the request header is optional, OSS recommend that users use the end-to-end check request header.
+      # @option headers [Integer] :Expires Specify the expiration time (milliseconds)
+      # @option headers [String] :x-oss-server-side-encryption Specify the oss server-side encryption algorithm when the object was created. supported value: 'AES256'
+      # @option headers [String] :x-oss-object-acl Specify the oss access when the object was created. supported value: public-read-write | public-read | private
+      # @option headers [Hash] other options will insert into headers when upload, such as user meta headers, eg: headers with prefix: x-oss-meta-
+      #
+      # @return [Response]
+      def bucket_create_object(key, file, headers = {})
+        http.put("/#{key}", headers: headers, body: Utils.to_data(file), bucket: bucket, key: key)
+      end
+
+      # Copy an existing object in OSS into another object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&CopyObject Copy Object
+      #
+      # @param key [String] the object name
+      # @param source_bucket [String] the source bucket name
+      # @param source_key [String] the source object name
+      # @param [Hash] headers
+      # @option options [String] :source_bucket the source bucket name
+      # @option options [String] :source_key the source object name
+      # @option options [String] :x-oss-copy-source-if-match If the specified ETag match the source object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+      # @option options [String] :x-oss-copy-source-if-none-match If the specified ETag not match the source object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+      # @option options [String] :x-oss-copy-source-if-unmodified-since If the specified time is equal to or later than the source object last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+      # @option options [String] :x-oss-copy-source-if-modified-since If the specified time is earlier than the source object last modification time, normal transfer ans return 200; Otherwise returns 304(not modified)
+      # @option options [String] :x-oss-metadata-directive ('COPY') supported value: COPY, REPLACE;
+      # @option options [String] :x-oss-server-side-encryption supported value: AES256
+      # @option options [String] :x-oss-object-acl supported value: public-read，private，public-read-write
+      #
+      # @return [Response]
+      def bucket_copy_object(key, source_bucket, source_key, headers = {})
+        fail('source_bucket must be not empty!') if source_bucket.nil? || source_bucket.empty?
+        fail('source_key must be not empty!') if source_key.nil? || source_key.empty?
+
+        headers.merge!('x-oss-copy-source' => "/#{source_bucket}/#{source_key}")
+
+        http.put("/#{key}", headers: headers, bucket: bucket, key: key)
+      end
+
+      # Append data to a object, will create Appendable object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&AppendObject Append Object
+      #
+      # @param key [String] object name
+      # @param file [file, bin data] the data to append
+      # @param position [Integer] append to position of object
+      # @option headers (see #bucket_create_object)
+      #
+      def bucket_append_object(key, file, position = 0, headers = {})
+        query = { 'append' => true, 'position' => position }
+
+        body = Utils.to_data(file)
+
+        http.post("/#{key}", query: query, headers: headers, body: body, bucket: bucket, key: key)
+      end
+
+      # Get the object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&GetObject Get Object
+      #
+      # @param key [String] the object name
+      # @param query [Hash] query params
+      # @option query [String] :response-content-type Specify the header Content-Type in response
+      # @option query [String] :response-content-language Specify the header Content-Language in response
+      # @option query [String] :response-expires Specify the header Expires in response
+      # @option query [String] :response-cache-control Specify the header Cache-Control in response
+      # @option query [String] :response-content-disposition Specify the header Content-Disposition in response
+      # @option query [String] :response-content-encoding Specify the header Content-encoding in response
+      # @param headers [Hash] headers
+      # @option headers [String] :Range Specify the range of the file. Such as "bytes=0-9" means the 10 characters from 0 to 9.
+      # @option headers [String] :If-Modified-Since If the specified time is earlier than the file last modification time, return 200 OK; Otherwise returns 304(not modified)
+      # @option headers [String] :If-Unmodified-Since If the specified time is equal to or later than the file last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+      # @option headers [String] :If-Match If the specified ETag match the object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+      # @option headers [String] :If-None-Match If the specified ETag not match the object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+      #
+      # @return [Response]
+      def bucket_get_object(key, query = {}, headers = {})
+        http.get("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+      end
+
+      # Delete object from bucket
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&DeleteObject Delete Object
+      #
+      # @param key [String] the object name
+      #
+      # @return [Response]
+      def bucket_delete_object(key)
+        http.delete("/#{key}", bucket: bucket, key: key)
+      end
+
+      # Delete multiple objects, at max 1000 at once
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&DeleteMultipleObjects Delete Multiple Objects
+      #
+      # @param keys [Array<String>] the object names
+      # @param quiet [Boolean] Specify response mode: false(Quiet) return results for error objects, true(Verbose) return results of every objects
+      #
+      # @return [Response]
+      def bucket_delete_objects(keys, quiet = false)
+        query = { 'delete' => true }
+
+        key_objects = keys.map { |key| { 'Key' => key } }
+        body = Utils.to_xml('Delete' => { 'Object' => key_objects, 'Quiet' => quiet })
+
+        http.post('/', query: query, body: body, bucket: bucket)
+      end
+
+      # Get meta information of object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&HeadObject Head Object
+      #
+      # @param key [String] object name
+      # @param headers [Hash] headers
+      # @option headers [String] :If-Modified-Since If the specified time is earlier than the file last modification time, return 200 OK; Otherwise returns 304(not modified)
+      # @option headers [String] :If-Unmodified-Since If the specified time is equal to or later than the file last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+      # @option headers [String] :If-Match If the specified ETag match the object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+      # @option headers [String] :If-None-Match If the specified ETag not match the object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+      #
+      # @return [Response]
+      def bucket_get_meta_object(key, headers = {})
+        http.head("/#{key}", headers: headers, bucket: bucket, key: key)
+      end
+
+      # Get access of object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&GetObjectACL Get Object ACL
+      #
+      # @param key [String] object name
+      #
+      # @return [Response]
+      def bucket_get_object_acl(key)
+        query = { 'acl' => true }
+        http.get("/#{key}", query: query, bucket: bucket, key: key)
+      end
+
+      # Set access of object
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&PutObjectACL Put Object ACL
+      #
+      # @param key [String] object name
+      # @param acl [String] access value, supported value: private, public-read, public-read-write
+      #
+      # @return [Response]
+      def bucket_set_object_acl(key, acl)
+        query = { 'acl' => true }
+        headers = { 'x-oss-object-acl' => acl }
+        http.put("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+      end
+
+      # Initialize a Multipart Upload event, before using Multipart Upload mode to transmit data, we has to call the interface to notify the OSS initialize a Multipart Upload events.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&InitiateMultipartUpload Initiate Multipart Upload
+      #
+      # @param key [String] object name
+      # @param headers [Hash] headers
+      # @option headers [String] :Content-Type ('application/x-www-form-urlencoded') Specify Content-Type for the object
+      # @option headers [String] :Cache-Control Specify the caching behavior when download from browser, ref https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [String] :Content-Disposition Specify the name when download, ref https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [String] :Content-Encoding Specify the content encoding when download, ref https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+      # @option headers [Integer] :Expires Specify the expiration time (milliseconds)
+      # @option headers [String] :x-oss-server-side-encryption Specify the oss server-side encryption algorithm when the object was created. supported value: 'AES256'#
+      #
+      # @return [Response]
+      def bucket_init_multipart(key, headers = {})
+        query = { 'uploads' => true }
+        http.post("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+      end
+
+      # Upload object in part.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&UploadPart Upload Part
+      #
+      # @param key [String] object name
+      # @param number [Integer] the part number, Range in 1~10000.
+      # @param upload_id [String] the upload ID return by #bucket_init_multipart
+      # @param file [File, bin data] the upload data
+      #
+      # @return [Response]
+      def bucket_multipart_upload(key, number, upload_id, file)
+        fail('number must present!') if number.nil?
+        fail('upload_id must present!') if upload_id.nil? || upload_id.empty?
+
+        query = { 'partNumber' => number.to_s, 'uploadId' => upload_id }
+
+        http.put("/#{key}", query: query, body: Utils.to_data(file), bucket: bucket, key: key)
+      end
+
+      # Upload a Part from an existing Object Copy data.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&UploadPartCopy Upload Part Copy
+      #
+      # @param key [String] object name
+      # @param number [Integer] the part number, Range in 1~10000.
+      # @param upload_id [String] the upload ID return by #bucket_init_multipart
+      # @param options [Hash] options
+      # @option options [String] :source_bucket the source bucket name
+      # @option options [String] :source_key the source object name
+      # @option options [String] :range the Range bytes, not set means the whole object
+      # @option options [String] :x-oss-copy-source-if-match If the specified ETag match the source object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+      # @option options [String] :x-oss-copy-source-if-none-match If the specified ETag not match the source object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+      # @option options [String] :x-oss-copy-source-if-unmodified-since If the specified time is equal to or later than the source object last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+      # @option options [String] :x-oss-copy-source-if-modified-since If the specified time is earlier than the source object last modification time, normal transfer ans return 200; Otherwise returns 304(not modified)
+      #
+      # @return [Response]
+      def bucket_multipart_copy_upload(key, number, upload_id, options = {})
+        fail('source_bucket must present!') if options[:source_bucket].to_s.empty?
+        fail('source_key must present!') if options[:source_key].to_s.empty?
+
+        query = { 'partNumber' => number, 'uploadId' => upload_id }
+
+        source_bucket = options.delete(:source_bucket)
+        source_key = options.delete(:source_key)
+
+        headers = {}
+        headers.merge!('x-oss-copy-source' => "/#{source_bucket}/#{source_key}")
+        headers.merge!('x-oss-copy-source-range' => options.delete(:range)) if options.key?(:range)
+        headers.merge!(options)
+
+        http.put("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+      end
+
+      # Complete a Multipart Upload event.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&CompleteMultipartUpload Complete Multipart Upload
+      #
+      # @param key [String] object name
+      # @param upload_id [String] the upload ID return by #bucket_init_multipart
+      # @param parts [Array<Multipart:Part>] parts
+      #
+      # @return [Response]
+      def bucket_complete_multipart(key, upload_id, parts = [])
+        fail('parts must present!') if parts.nil? || parts.empty?
+        fail('upload_id must present!') if upload_id.nil?
+
+        query = { 'uploadId' => upload_id }
+
+        body = Utils.to_xml('CompleteMultipartUpload' => {
+                              'Part' => parts.map(&:to_hash)
+                            })
+
+        http.post("/#{key}", query: query, body: body, bucket: bucket, key: key)
+      end
+
+      # Abort a Multipart Upload event
+      #
+      # @note After abort the Multipart Upload, the Uploaded data will be deleted
+      # @note When abort a Multipart Upload event, if there are still part upload belonging to this event, then theree parts will not be removed. So if there is a concurrent access, in order to release the space on the OSS completely, you need to call #bucket_abort_multipart a few times.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&AbortMultipartUpload Abort Multipart Upload
+      #
+      # @param key [String] the object name
+      # @param upload_id [String] the upload ID return by #bucket_init_multipart
+      #
+      # @return [Response]
+      def bucket_abort_multipart(key, upload_id)
+        query = { 'uploadId' => upload_id }
+        http.delete("/#{key}", query: query, bucket: bucket, key: key)
+      end
+
+      # List existing opened Multipart Upload event.
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&ListMultipartUploads List Multipart Uploads
+      #
+      # @param options [Hash] options
+      # @option options [String] :prefix Filter objects with prefix
+      # @option options [String] :delimiter Used to group objects with delimiter
+      # @option options [Integer] :max-uploads (1000) Limit number of Multipart Upload events, the maxinum should <= 1000
+      # @option options [String] :encoding-type Encoding type used for unsupported character
+      # @option options [String] :key-marker with upload-id-marker used to specify the result range.
+      # @option options [String] :upload-id-marker with key-marker used to specify the result range.
+      #
+      # @return [Response]
+      def bucket_list_multiparts(options = {})
+        accepted_keys = ['prefix', 'key-marker', 'upload-id-marker', 'max-uploads', 'delimiter', 'encoding-type']
+
+        query = Utils.hash_slice(options, *accepted_keys).merge('uploads' => true)
+
+        http.get('/', query: query, bucket: bucket)
+      end
+
+      # List uploaded parts for Multipart Upload event
+      #
+      # @see https://docs.aliyun.com/#/pub/oss/api-reference/multipart-upload&ListParts List Parts
+      #
+      # @param key [String] the object name
+      # @param upload_id [String] the upload ID return by #bucket_init_multipart
+      # @param options [Hash] options
+      # @option options [Integer] :max-parts (1000) Limit number of parts, the maxinum should <= 1000
+      # @option options [Integer] :part-number-marker Specify the start part, return parts which number large than the specified value
+      # @option options [String] :encoding-type Encoding type used for unsupported character in xml 1.0
+      #
+      # @return [Response]
+      def bucket_list_parts(key, upload_id, options = {})
+        accepted_keys = ['max-parts', 'part-number-marker', 'encoding-type']
+
+        query = Utils.hash_slice(options, *accepted_keys).merge('uploadId' => upload_id)
+
+        http.get("/#{key}", query: query, bucket: bucket, key: key)
+      end
+
+      private
+
+      def http
+        @http = Http.new(access_key, secret_key, @options[:host])
+      end
+    end
+  end
+end