aliyun-oss-sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25f9ea0e6c34c0a6d15ff9c7f1c5b7063eab4c74
-  data.tar.gz: 3ff1e1a73d6b74bbaec4ff7e23179197197978ae
+  metadata.gz: bbccd13ad8cbf7ce3e840808e7065fad629020d9
+  data.tar.gz: b375cc54baf8f421deedadf54ba3fa0bac695172
 SHA512:
-  metadata.gz: 12ca936fc5538dac82a12a6dd1ec3057f12d31bf0bd163931e6bc98b0215070abbd76c6191d8de1ae4e8d346249217c7a7ebad8948aed0a871bb5471117e3568
-  data.tar.gz: 5917b901eed5f2b8182719474418b212382bfdd678c93a95a29ef3ea33e3aa4d169715f153648281837edd02cb84a5a83f36cfb81b01b6f518f7c890adf6c6f1
+  metadata.gz: 624ca57c96e66016198632a1bf199c2884c103a0f6d7ee9ba6352fbb3839152ef40ac3c12d0626c12ba33464a7ed839ba55dfb449e2af0f815cdbd5e0d040202
+  data.tar.gz: a89b46e78d75d569748c50e812b2e0d2c55e3071a19c7a7c1827d07cfe81565839c856ddada590a546ce3e878e747694970cbe3c89c2c6c90a05f30eb4c2afa8

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "{}" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright 2015 newell_zlx
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -11,8 +11,20 @@ It provide One-to-one Ruby interface for Aliyun OSS Restful API. I try to keep t
 ## Document
 
 + [ALiyun OSS API](https://docs.aliyun.com/#/pub/oss/api-reference/overview)
-+ [Ruby Document]()
++ [Ruby API Document](http://www.rubydoc.info/gems/aliyun-oss-sdk/0.0.1)
 
+## Wiki
+
+There are some more document here, Hope can help you!
+
++ [Installation](./wiki/installation.md)
++ [Get started](./wiki/get_start.md)
++ [Bucket](./wiki/bucket.md)
++ [Objects](./wiki/object.md)
++ [Multipart Upload](./wiki/multipart_upload.md)
++ [CORS](./wiki/cors.md)
++ [Lifecycle](./wiki/lifecycle.md)
++ [Error](./wiki/error.md)
 
 ## Usage    
 

data/lib/aliyun/oss.rb

@@ -16,6 +16,5 @@ module Aliyun
     module Multipart
       autoload :Part,           'aliyun/oss/multipart/part'
     end
-
   end
 end

data/lib/aliyun/oss/client.rb

@@ -164,8 +164,13 @@ module Aliyun
       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)
+        body = Utils.to_xml('RefererConfiguration' => {
+                              'AllowEmptyReferer' => allowed_empty,
+                              'RefererList' => {
+                                'Referer' => referers
+                              }
+                            }
+                           )
 
         http.put('/', query: query, body: body, bucket: bucket)
       end
@@ -600,7 +605,8 @@ module Aliyun
       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)
+        query = Utils.hash_slice(options, *accepted_keys)
+                .merge('uploads' => true)
 
         http.get('/', query: query, bucket: bucket)
       end

data/lib/aliyun/oss/http.rb

@@ -14,17 +14,17 @@ module Aliyun
       end
 
       def put(uri, options = {})
-        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }.merge(options[:headers] || {})
+        headers = default_content_type.merge(options[:headers] || {})
         request('PUT', uri, options.merge(headers: headers))
       end
 
       def post(uri, options = {})
-        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }.merge(options[:headers] || {})
+        headers = default_content_type.merge(options[:headers] || {})
         request('POST', uri, options.merge(headers: headers))
       end
 
       def delete(uri, options = {})
-        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }.merge(options[:headers] || {})
+        headers = default_content_type.merge(options[:headers] || {})
         request('DELETE', uri, options.merge(headers: headers))
       end
 
@@ -49,11 +49,13 @@ module Aliyun
 
         headers.merge!('Host' => get_host(options))
 
-        auth_key = get_auth_key(options.merge(verb: verb, headers: headers, date: headers['Date']))
+        auth_key = get_auth_key(options
+          .merge(verb: verb, headers: headers, date: headers['Date']))
         headers.merge!('Authorization' => auth_key)
 
         uri = get_uri(headers['Host'], resource)
-        options = Utils.hash_slice(options.merge(headers: headers), :query, :headers, :body)
+        options = Utils
+        .hash_slice(options.merge(headers: headers), :query, :headers, :body)
 
         HTTParty.__send__(verb.downcase, uri, options)
       end
@@ -64,7 +66,8 @@ module Aliyun
 
       def default_headers
         {
-          'User-Agent' => "aliyun-oss-sdk-ruby/#{Aliyun::Oss::VERSION} (#{RbConfig::CONFIG['host_os']} ruby-#{RbConfig::CONFIG['ruby_version']})",
+          'User-Agent' => "aliyun-oss-sdk-ruby/#{Aliyun::Oss::VERSION} " \
+          "(#{RbConfig::CONFIG['host_os']} ruby-#{RbConfig::CONFIG['ruby_version']})",
           'Date' => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
         }
       end
@@ -79,6 +82,10 @@ module Aliyun
         end
       end
 
+      def default_content_type
+        { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      end
+
       def get_uri(host, resource)
         "http://#{host}#{resource}"
       end

data/lib/aliyun/oss/rule/cors.rb

@@ -49,7 +49,9 @@ module Aliyun
         end
 
         def allowed_methods
-          @allowed_methods.map(&:upcase).select { |method| ACCESSPTED_METHODS.include?(method.to_s) }
+          @allowed_methods
+            .map(&:upcase)
+            .select { |method| ACCESSPTED_METHODS.include?(method.to_s) }
         end
 
         def value_present?(value)

data/lib/aliyun/oss/rule/lifecycle.rb

@@ -27,7 +27,12 @@ module Aliyun
 
         def to_hash
           if valid?
-            { 'ID' => id || '', 'Prefix' => prefix, 'Status' => status, 'Expiration' => expiration }
+            {
+              'ID' => id || '',
+              'Prefix' => prefix,
+              'Status' => status,
+              'Expiration' => expiration
+            }
           else
             {}
           end

data/lib/aliyun/oss/utils.rb

@@ -25,7 +25,8 @@ module Aliyun
       end
 
       # @example
-      #   Utils.hash_slice({ 'a' => 1, 'b' => 2, 'c' => 3 }, 'a', 'c')  # { 'a' => 1, 'c' => 3 }
+      #   # { 'a' => 1, 'c' => 3 }
+      #   Utils.hash_slice({ 'a' => 1, 'b' => 2, 'c' => 3 }, 'a', 'c')
       #
       # @return [Hash]
       def self.hash_slice(hash, *selected_keys)
@@ -38,7 +39,7 @@ module Aliyun
       #
       # @return [Bin data]
       def self.to_data(file_or_bin)
-        file_or_bin.respond_to?(:read) ? IO.binread(file_or_bin) : file
+        file_or_bin.respond_to?(:read) ? IO.binread(file_or_bin) : file_or_bin
       end
 
       def self.to_xml(hash) # nodoc

data/lib/aliyun/oss/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module Oss
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/wiki/bucket.md

@@ -0,0 +1,106 @@
+## Bucket
+
+Bucket is namespace in OSS, as well as management entity for high functions such as pricing, access control, logging; Bucket names are global uniqueness throughout the OSS services, and cannot be modified. Each Object stored in the OSS must contained in a Bucket. An application, such as the picture sharing website, can correspond to one or more Bucket. A user can create up to 10 Bucket, but each bucket can store unlimit objects, there is no limit to the number of storage capacity each buckte highest support 2 PB.
+
+### Name Spec
+
++ only contains lowercase letters, Numbers, dash (-)
++ Must begin with lowercase letters or Numbers
++ Length must be between 3-63 bytes
+
+
+### Create Bucket
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host)
+    
+    # create a private bucket on oss-cn-beijing
+    res = client.bucket_create('new-bucket', 'oss-cn-beijing', 'private')
+    puts res.success?, res.headers
+    
+You can specify bucket name, location and acl when create new bucket. More about this method, visit [Client#bucket_create]()
+
+### List all buckets
+
+To get all buckets use Client#list_buckets:
+
+ 
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host)
+    
+    res = client.list_buckets
+    puts res.parsed_response
+    
+
+### Set ACL for Bucket
+
+With Client#bucket_set_acl you can modify the ACL for bucket:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    # supported value: public-read-write | public-read | private
+    res = client.bucket_set_acl("public-read")
+    puts res.parsed_response
+
+Now, it support public-read-write | public-read | private, more detail visit: [Bucket ACL](https://docs.aliyun.com/#/pub/oss/product-documentation/acl&bucket-acl)
+
+### Get ACL of Bucket
+
+To get current ACL of Bucket, use Client#bucket_get_acl
+
+       
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_get_acl
+    puts res.parsed_response
+    
+    
+### Get Bucket Location
+
+Get bucket's data center location, use Client#bucket_get_location:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_get_location
+    puts res.parsed_response
+
+More bucket information can fetch via Client#bucket_get_xxx methods. View the [Ruby Document]()
+
+### Delete Bucket
+
+If you donot need the bucket, delete it with Client#bucket_delete
+    
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host)    
+    
+    res = client.bucket_delete("deleted-bucket-name")
+    puts res.success?, res.headers
+    
+Note: when the bucket is not empty(existing object or parts upload via Multipart), the delete may be fail.
+
+OK, Let's visit [Objects](./object.md)    
+    

data/wiki/get_start.md

@@ -0,0 +1,67 @@
+## Getting started
+
+Here, you can know how to do some basic operation with Aliyun OSS SDK.
+
+### Step-1. Init a client
+
+Mostly API are handled by Aliyun::Oss::Client class, now Let's create a instance:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "oss-sdk-dev-test"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+
+Here, access_key/secret_key is is your access credentials, Aliyun provide three ways to fetch them, read detail at https://docs.aliyun.com/#/pub/oss/product-documentation/acl&RESTAuthentication, more about the [Aliyun::Oss::Client]()
+
+
+### Step-2. Create Bucket
+
+Buckets are global in OSS, so keep your bucket name unique with others. It can used to store many objects. Now, we create a bucket:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host)
+    
+    # create a private bucket on oss-cn-beijing
+    res = client.bucket_create('new-bucket', 'oss-cn-beijing', 'private')
+    puts res.success?, res.headers
+    
+Default, most api return a [HttpartyResponse](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response), you can use much methods to fetch your interesting message.
+
+### Step-3 Upload Object
+
+Object is the most basic unit of data in OSS, mostly it's a file. you can upload a object:
+
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    file = File.new("path/to/test.txt")
+    res = client.bucket_create_object("test.txt", file)
+    puts res.success?, res.headers
+
+### Step-4 list all object
+
+After you complete some upload, maybe you want to list the objects in the bucket:
+
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_list_objects()
+    puts res.success?, res.parsed_response
+
+With correct parameters, you can get more flexible result.
+
+### Step-5. Get special object
+
+Now, you want to get a special object:
+
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_get_object("test.txt")
+    puts res.success?, res.headers
+    # save the response to your local file system
+    File.open("file.png", "wb") { |f| f << res.parsed_response }
+
+Next, Visit more about [Bucket](./bucket.md)

data/wiki/installation.md

@@ -0,0 +1,15 @@
+## Installation
+
+It's a Ruby Gem, so you can install it like any Gem:
+
+    gem install aliyun-oss-sdk
+
+If you use Gemfile manage your Gems, Add below to your Gemfile.
+
+    gem "aliyun-oss-sdk"
+
+And run:
+
+    bundle install
+    
+Now, [Getting started](./get_start.md)    

data/wiki/multipart.md

@@ -0,0 +1,24 @@
+### Multipart Upload
+
+     require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    # Step-1 Init a Multipart Upload
+    client.bucket_init_multipart("Exciting-Ruby.mp4", { 'Content-Type' => 'video/mp4' })  
+    
+    # Step-2 Upload parts
+    client.bucket_multipart_upload("Exciting-Ruby.mp4", 1, "98A6524428734723BE8F81D72B5295EE", file1)
+    client.bucket_multipart_upload("Exciting-Ruby.mp4", 2, "98A6524428734723BE8F81D72B5295EE", file2)
+    
+    # Step-3 Complete Multipart Upload
+    
+    file = File.new("path/to/image.png")
+    res = client.bucket_create_object("image.png", file, { 'Content-Type' => 'image/png' })
+    puts res.success?, res.headers
+    
+    res = client.bucket_create_object("hello.txt", "Hello World", { 'Content-Type' => 'text/plain' })
+    puts res.success?, res.headers  

data/wiki/object.md

@@ -0,0 +1,74 @@
+## Object
+
+In Aliyun OSS, the basic data unit that user operation is the Object. A single Object maximum size varies according to the way of uploading data, Put the Object way most can't more than 5 GB, using multipart Object way to upload size must not exceed 48.8 TB. Object contains the key, meta, and data. Among them, the key is the name of the Object. Meta is user's description of the object consists of a series of name-value pairs; The data is the object data.
+
+
+## Name Spec
+
++ Use utf-8 encoding
++ Length must be between 1 to 1023 bytes
++ Don't begin with "/" or "\" character
++ Can not contain "\r" or "\n"
+
+
+## Upload Object
+
+### Simple upload
+
+Client#bucket_create_object support file or bin data to upload.
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    file = File.new("path/to/image.png")
+    res = client.bucket_create_object("image.png", file, { 'Content-Type' => 'image/png' })
+    puts res.success?, res.headers
+    
+    res = client.bucket_create_object("hello.txt", "Hello World", { 'Content-Type' => 'text/plain' })
+    puts res.success?, res.headers
+    
+
+The Upload limit Data to 5 GB, if large than it, use [Multipart Upload](./multipart.md).
+
+
+### Create a folder
+
+To Create a folder, it's easy, just pass key with "/" at last:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_create_object("images/", "")
+    puts res.success?, res.headers
+
+Create simulations folder nature created a size of 0 object.Uploads and downloads, for this object can only console to end with "/" object to display the folder. So the user can use this way to implement to create simulation folder. And access to the folder can see files below the folder.
+
+    
+### Customize Http Header for object
+
+OSS service allow users to customize the http headers of object. The following code set the expiration time for the Object:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host = "oss-cn-hangzhou.aliyuncs.com"
+    bucket = "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    res = client.bucket_create_object("image.png", file, { 'Content-Type' => 'image/png', "Expires" => "Fri, 28 Feb 2012 05:38:42 GMT" })
+    puts res.success?, res.headers
+ 
+Except Expires, also support Cache-Control, Content-Disposition, Content-Encoding, Content-MD5, more details visit: [Client#bucket_create_object]()
+
+
+
+    
+ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-oss-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Newell Zhu
@@ -160,6 +160,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - aliyun-oss.gemspec
@@ -174,7 +175,14 @@ files:
 - lib/aliyun/oss/rule/lifecycle.rb
 - lib/aliyun/oss/utils.rb
 - lib/aliyun/oss/version.rb
-- lib/aliyun/oss/xml_builder.rb
+- wiki/bucket.md
+- wiki/cors.md
+- wiki/error.md
+- wiki/get_start.md
+- wiki/installation.md
+- wiki/lifecycle.md
+- wiki/multipart.md
+- wiki/object.md
 homepage: http://github.com/aliyun/ruby-oss-sdk
 licenses: []
 metadata: {}

data/lib/aliyun/oss/xml_builder.rb

@@ -1,11 +0,0 @@
-require 'gyoku'
-
-module Aliyun
-  module Oss
-    class XmlBuilder
-      def self.to_xml(hash)
-        %(<?xml version="1.0" encoding="UTF-8"?>#{Gyoku.xml(hash)})
-      end
-    end
-  end
-end