aliyun-oss-sdk 0.1.1 → 0.1.2

data/wiki/object_based/error.md

@@ -0,0 +1,70 @@
+## Error
+
+### Handle Error
+
+If a error occurs when visit the OSS, the OSS will be return a error code and error message, making it easy for users to locate problems, and make the appropriate treatment. For code not 2XX, you can get information:
+
+    require 'aliyun/oss'
+    
+    client = Aliyun::OSS::Client.new('ACCESS_KEY', 'SECRET_KEY', host: 'oss-cn-hangzhou.aliyuncs.com', bucket: 'oss-sdk-dev-hangzhou')
+    
+    begin
+      client.buckets.create("invalid_bucket_name")
+    rescue Aliyun::Oss::RequestError => e
+      puts "Code: #{e.code}"
+      puts "Message: #{e.message}"
+      puts "Request id: #{e.request_id}"
+    end
+    
+Here, 
+
++ Code: the error code
++ Message: the error message
++ requestId: It's the UUID to uniquely identifies this request; When you can't solve the problem, can the RequestId to request help from the OSS development engineer.   
+    
+
+# Error Code
+
+| code  |  summary |  HTTP Status|
+|---|---|
+|AccessDenied	|Access denied | 403|
+|BucketAlreadyExists	| Bucket Already Exist|	409|
+|BucketNotEmpty	|Bucket Not Empty|	409|
+|EntityTooLarge	| Entry Too Large|	400|
+|EntityTooSmall	| Entry Too Small|	400|
+|FileGroupTooLarge	|File Group Too Large|	400|
+|InvalidLinkName	| Object Link Same With Object| 400|
+|LinkPartNotExist	| Object Not Exist| 400|
+|ObjectLinkTooLarge	| Object Too Much | 400|
+|FieldItemTooLong	| Field Too Large| 400|
+|FilePartInterity	| File Part Already Changed| 400|
+|FilePartNotExist	|File Part Not Exist|	400|
+|FilePartStale	| File Part Expired|	400|
+|IncorrectNumberOfFilesInPOSTRequest|	File Count Invalid| 400|
+|InvalidArgument	|Invalid Argument|	400|
+|InvalidAccessKeyId | Access Key ID Not Exist| 403|
+|InvalidBucketName	| The specified bucket is not valid.| 400|
+|InvalidDigest	| Invalid Digest | 400|
+|InvalidEncryptionAlgorithmError	| Specified Encoding-Type Error | 400|
+|InvalidObjectName	|Invalid Object Name| 400
+|InvalidPart	| Invalid Part| 400|
+|InvalidPartOrder	|Invalid Part Order| 400|
+|InvalidPolicyDocument	| Invalid Policy| 400|
+|InvalidTargetBucketForLogging	|Invalid Target Bucket For Logging| 400|
+|InternalError	|Internal Error| 500|
+|MalformedXML	|	XML Invalid| 400|
+|MalformedPOSTRequest | Requested XML Invalid | 400|
+|MaxPOSTPreDataLengthExceededError	| Body except file Too Large | 400|
+|MethodNotAllowed	|Method Not Allowed| 405|
+|MissingArgument	|Missing Argument| 411|
+|MissingContentLength	|Missing Content Length| 411|
+|NoSuchBucket	|No Such Bucket| 404|
+|NoSuchKey	|No Such Key| 404|
+|NoSuchUpload	|Multipart Upload ID Not Exist| 404|
+|NotImplemented	|Not Implemented| 501|
+|PreconditionFailed	|Precondition Failed| 412|
+|RequestTimeTooSkewed	|Request Time Large Than 15 minutes| 403|
+|RequestTimeout	|Request Timeout| 400|
+|RequestIsNotMultiPartContent | Content-Type Invalid| 400|
+|SignatureDoesNotMatch	|Signature Does Not Match|403|
+|TooManyBuckets	|Too Many Buckets| 400|

data/wiki/object_based/get_start.md

@@ -0,0 +1,93 @@
+## Getting started
+
+Here, you can know how to do some basic operation with Aliyun OSS SDK.
+
+
+### Step-1. Init a client
+
+Mostly OSS API are handled by [Aliyun::Oss::Client](http://www.rubydoc.info/gems/aliyun-oss-sdk/Aliyun/Oss/Client) class, Let's create a instance first:
+
+    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)
+
+Here, access_key/secret_key is is your access credentials, Aliyun provide three ways to get access credentials, get more information [here](https://docs.aliyun.com/#/pub/oss/product-documentation/acl&RESTAuthentication).
+
+
+### Step-2. Create Bucket
+
+Buckets are global object in OSS, so find a uniqueness name for your bucket, Or it fail when create. It can used to store 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
+    begin
+      client.buckets.create('new-bucket', 'oss-cn-beijing', 'private')
+    rescue Aliyun::Oss::RequestError => e
+      puts "Bucket create fail", e.code, e.message, e.request_id
+    end
+
+
+### Step-3 Upload Object
+
+Object is the most basic unit of data in OSS, you can simple imagine it's just a file. here, we upload a object to OSS:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    file = File.new("path/to/test.txt")
+    begin
+      client.bucket_objects.create("test.txt", file)
+    rescue Aliyun::Oss::RequestError => e
+      puts "Upload Object fail", e.code, e.message, e.request_id
+    end
+
+### Step-4 list all object
+
+After you complete some upload, maybe you want to list the objects in the bucket:
+
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    begin
+      objects = client.bucket_objects.list
+    rescue Aliyun::Oss::RequestError => e
+      puts "Cannot list objects", e.code, e.message, e.request_id
+    end
+
+With correct parameters, you can get more flexible result. you can get detailed Paramters [here](http://www.rubydoc.info/gems/aliyun-oss-sdk/Aliyun%2FOss%2FClient%3Abucket_list_objects).
+
+
+### Step-5. Get special object
+
+Now, you want to get a special object:
+
+    require 'aliyun/oss'
+    
+    access_key, secret_key = "your id", "your secret"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    begin
+      body = client.bucket_objects.get("test.txt")
+      # save the response to your local file system
+      File.open("test.txt", "wb") { |f| f << body.read }
+    rescue Aliyun::Oss::RequestError => e
+      puts "Get object fail", e.code, e.message, e.request_id
+    end
+
+Next, Visit more about [Bucket](./bucket.md)

data/wiki/object_based/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/object_based/lifecycle.md

@@ -0,0 +1,88 @@
+## LifeCycle
+
+OSS provide LifeCycle to help user manage lifecycle of object. User can create LifeCycle rules to manage objects. At present, user can create rule to auto delete Objects. Each rule is composed by following several parts:
+
++ Prefix of Object name, only match the prefix will apply this rule.
++ Operation, user want to take for the matched objects.
++ Date or Days, which user can specify expired date or days to expire.
+
+
+### Set LifeCycle
+
+
+In the LifeCycle, you can contains 1000 rules at max.
+
+Each rule contains:
+
++ ID: each rule ID must keep uniqueness and cannot contain others(eg: abc and abcd).
++ Prefix: it can used to apply rule for object with the prefix
++ Status: defined the status for the rule, Only support Enabled and Disabled.
++ Expiration: Date or Days, used to specify expired date or specify expired after x days from last modified date.
+
+In our Library, to use Struct::LifeCycle to define a rule:
+
+     # Define a rule to auto delete objects with prefix: logs-prod- after 7 days since last modified date
+    rule1 = Aliyun::Oss::Struct::LifeCycle.new({ prefix: 'logs-prod-', days: 7, enable: true })
+	
+	# Define a rule to auto delete objects with prefix: logs-dev- at Time.now + 24*60*60
+	rule2 = Aliyun::Oss::Struct::LifeCycle.new({ prefix: 'logs-dev', date: Time.now + 24*60*60, enable: true })
+	
+
+To set your LifeCycle with this rules:
+
+    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)
+    
+    begin
+      bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+      bucket.enable_lifecycle([rule1, rule2])
+    rescue Aliyun::Oss::RequestError => e
+      puts "Enable Lifecycle fail", e.code, e.message, e.request_id    
+    end
+
+### Get LifeCycle
+
+To get LifeCycle for bucket, use Client#bucket_get_lifecycle:
+
+    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)
+    
+    begin
+      bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+      bucket.lifecycle!
+    rescue Aliyun::Oss::RequestError => e
+      puts "Enable Lifecycle fail", e.code, e.message, e.request_id
+    end
+    
+
+### Disable LifeCycle
+
+
+With Client#bucket_disable_lifecycle, you can disable LifeCycle:
+
+
+    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)
+    
+    begin
+      bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+      bucket.disable_lifecycle
+    rescue Aliyun::Oss::RequestError => e
+      puts "Disable Lifecycle fail", e.code, e.message, e.request_id
+    end
+    
+
+Next, Let's discuss about [Error](./error.md)        
+       

data/wiki/object_based/multipart.md

@@ -0,0 +1,133 @@
+## Multipart Upload
+
+Besides simple upload via put, OSS provide another way to upload large file -- Multipart Upload, Here we list some normal application scenarios:
+
++ To support breakpoint upload
++ Upload file large than 100 MB
++ Network is bad, and the connection between the OSS server often disconnected
++ Upload a file before, unable to determine the size of the uploaded files
+
+
+Now, Let's start party!
+
+
+### Initialize
+
+Before start a Multipart Upload, we need first initialize a event:
+
+    
+    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)
+    
+    begin
+    # Step-1 Init a Multipart Upload
+      multipart = client.bucket_multiparts.init("Exciting-Ruby.mp4", { 'Content-Type' => 'video/mp4' })
+      puts "Upload ID: #{multipart.upload_id}"
+    rescue Aliyun::Oss::RequestError => e
+      puts "Init Multipart fail", e.code, e.message, e.request_id
+    end
+    
+Upload ID is the UUID for the Multipart Upload Event, store it for use later.
+
+### Upload Part from local 
+
+    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)
+    
+    begin
+      multipart = client.bucket_multiparts.init("Exciting-Ruby.mp4", { 'Content-Type' => 'video/mp4' })
+      headers = multipart.upload("Exciting-Ruby.mp4", 1, file_or_bin)
+      puts "etag: #{headers['etag']}"
+    rescue Aliyun::Oss::RequestError => e
+      puts "Upload to Multipart fail", e.code, e.message, e.request_id
+    end
+
+Store the etag, it will used for complete a Multipart Upload.
+
+It can used to upload part to a object. Please note:
+
++ Multipart Upload requirements every parts greater than 100 KB except last
++ In order to ensure that data safe when network transmission, strongly recommend to include meta: content-md5, after receiving the data, OSS using the md5 value to prove the validity of the upload data, if they are inconsistent returns InvalidDigest.
++ The Part number range is 1~10000. If beyond this range, the OSS will return InvalidArgument.
++ If you upload from the same file, be careful for the upload position
+
+### Complete 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)
+    
+    part1 = Aliyun::Oss::Struct::Part.new({ number: 1, etag: 'etag1' })
+	part2 = Aliyun::Oss::Struct::Part.new({ number: 2, etag: 'etag2' })
+	part3 = Aliyun::Oss::Struct::Part.new({ number: 3, etag: 'etag3' })
+	begin
+	  multipart.complete([part1, part2, part3])
+	rescue Aliyun::Oss::RequestError => e
+      puts "Complete Multipart fail", e.code, e.message, e.request_id
+    end
+	
+
+Here, we create Aliyun::Oss::Struct::Part to build your part, use Part#valid? to valid the object.
+
+### Abort Multipart Upload
+
+If some Problem occurs, you may want to abort a 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)
+    
+    begin
+      multipart.abort
+    rescue Aliyun::Oss::RequestError => e
+      puts "Upload to Multipart fail", e.code, e.message, e.request_id
+    end
+    
+After abort a multipart, all uploaded parts will be destroyed, But Note: If some others are upload parts to this object when your abort, they may be missing, so invoke a few times if you have access in concurrent.
+
+### List Multipart Upload
+
+To get all Multipart Upload in this 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)
+    
+    multiparts = client.bucket_multiparts.list
+
+Same with all other list method, it support prefix, delimiter, marker to get flexible results.
+
+
+### List Uploaded Parts
+
+Sometimes, you want to know which parts are uploaded.
+
+    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)
+    
+    parts = multipart.list_parts
+
+
+OK, It's time to visit [CORS](./cors.md)    
+    

data/wiki/object_based/object.md

@@ -0,0 +1,324 @@
+## 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
+
+BucketObjects#create 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")
+    begin
+      client.bucket_objects.create("image.png", file, { 'Content-Type' => 'image/png' })
+    rescue Aliyun::Oss::RequestError => e
+      puts "Create Object fail", e.code, e.message, e.request_id
+    end
+    
+    begin
+      client.bucket_objects.create("hello.txt", "Hello World", { 'Content-Type' => 'text/plain' })
+    rescue Aliyun::Oss::RequestError => e
+      puts "Create Object fail", e.code, e.message, e.request_id
+    end
+    
+
+The Upload limit Data to 5 GB, if large than, visit [Multipart Upload](./multipart.md).
+
+
+### Create a folder
+
+To Create a folder, it's easy, just pass key end with "/":
+
+    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)
+    
+    begin
+      client.bucket_objects.create("images/", "")
+    rescue Aliyun::Oss::RequestError => e
+      puts "Create folder fail", e.code, e.message, e.request_id
+    end
+
+Create simulations folder nature created a object with size equals 0. 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 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)
+    
+    file = File.new("path/to/image.png")
+    begin
+      client.bucket_objects.create("image.png", file, { 'Content-Type' => 'image/png', "Expires" => "Sun, 25 Oct 2015 05:38:42 GMT" })
+    rescue Aliyun::Oss::RequestError => e
+      puts "Create Object fail", e.code, e.message, e.request_id
+    end
+     
+Except Expires, it also support Cache-Control, Content-Disposition, Content-Encoding, Content-MD5, more details visit: [BucketObjects#create](http://www.rubydoc.info/gems/aliyun-oss-sdk/0.1.1/Aliyun/Oss/Client/BucketObjects#create-instance_method).
+
+
+### Set User Meta
+
+OSS Support set some user meta information for object. Here we set x-oss-meta-user to username for 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)
+    
+    file = File.new("path/to/image.png")
+    begin
+      client.bucket_objects.create("image.png", file, { 'Content-Type' => 'image/png', 'x-oss-meta-user' => 'baymax' })
+    rescue Aliyun::Oss::RequestError => e
+      puts "Create Object fail", e.code, e.message, e.request_id
+    end
+
+
+user meta information stored as headers with prefix: "x-oss-meta", the maxinum limit is 2KB for all meta information.
+
+Note: the user meta key is case-insensitive, but value is case-sensitive.
+
+
+### Append Upload
+
+OSS Allow users to append data to a object, but only for appendable object, Objects created with Append Upload is Appendable object, Upload via Simple Upload is Normal 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)
+    
+    # Step-1 create a appendable object
+    begin
+    position = 0    
+      headers = client.bucket_objects.append("secret.zip", "init information", position)
+      # Step-2 get next append position
+      position = headers['x-oss-next-append-position']
+      # Step-3 append upload
+      client.bucket_objects.append("secret.zip", "append information", position)
+    rescue Aliyun::Oss::RequestError => e
+      puts "Append Object fail", e.code, e.message, e.request_id
+    end
+    
+Users upload with Append mode, the most important is to set position correctly: When a user creates an appendable object, should set position to 0; When append content for the object, the postion is the current size of the object. 
+
+There are two ways to get the object size: one is the return of BucketObject#append. Another is invoke Object#meta! with the object.
+
+Note: You can set meta information only when create appendable object(the first append). Later, if you want to change the meta, use BucketObject#copy(set source and destination to the same object).
+
+
+
+## List objects in Bucket
+
+
+### List Objects
+
+    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)
+    
+    objects = client.bucket_objects.list    
+    
+
+### More Parameters
+
+the method support many Parameters to get flexible results:
+
+    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)
+    
+    # list objects with prefix: pic and end with "/"
+    objects = client.bucket_objects.list(prefix: 'pic', delimiter: '/')
+    
+
+It list results with prefix: pic and end with "/", for example: "pic-people/". More about the Paramters, visit: [BucketObjects#list](http://www.rubydoc.info/gems/aliyun-oss-sdk/0.1.1/Aliyun/Oss/Client/BucketObjects#list-instance_method)
+
+
+### Simulate Directory
+
+In OSS, there is not real directory, the direcory we have seen actually is object with key end with /.
+
+So, we can list objects by directory with prefix and delimiter.
+
+For example, We have four objects:
+
++ fun/movie/001.avi
++ fun/movie/007.avi
++ fun/test.jpg
++ oss.jpg
+
+There are two directory object: fun/ and fun/movie/;
+
+Now, If we invoke:
+
+1. list() will return 4 objects + two directory object;
+2. list(prefix: 'fun/') will return first 3 objects and two directory object;
+3. list(prefix: 'fun/', delimiter='/') will only return fun/test.jpg, fun/ and fun/movie/.
+
+So we can use this two paramters to list objects by directory.
+
+    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)
+    
+    # list objects with prefix: fun/ and end with "/"
+    results = client.bucket_objects.list(prefix: 'fun/', delimiter: '/')
+    
+    results.each do |object|
+      if object.is_a?(Aliyun::Oss::Struct::Directory)
+        puts object.key
+        sub_objects = object.list(delimiter: '/')
+      else
+        puts object.key
+      end
+    end
+    
+Note: the results maybe instance of Aliyun::Oss::Struct::File or Aliyun::Oss::Struct::Directory, they are both subclass of Aliyun::Oss::Struct::Object, but Directory has method: #list to list objects under it.     
+    
+
+### Get 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)
+    
+    begin
+      body = client.bucket_objects.get('image.png')
+      File.open('image.png', 'wb') {|f| f.write body.read }
+    rescue Aliyun::Oss::RequestError => e
+      puts "Get Object fail", e.code, e.message, e.request_id
+    end
+        
+It Support Parameters, Range, If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match. With Range, we can get range data from a object, it's useful for download partly and so on.
+
+    
+### Get Meta Object
+
+To get meta information of a object, use Client#get_meta_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)
+    
+    begin
+      headers = client.bucket_objects.meta!('image.png')
+    rescue Aliyun::Oss::RequestError => e
+      puts "Get Object meta information fail", e.code, e.message, e.request_id
+    end
+
+### Delete 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)
+    
+    # Delete one object
+    begin
+      client.bucket_objects.delete('image.png')
+    rescue Aliyun::Oss::RequestError => e
+      puts "Delete Object fail", e.code, e.message, e.request_id
+    end
+    
+    
+    # Delete many objects at once
+    # the second Paramter used to control the response information. Quiet or Verbose
+    begin
+      client.bucket_objects.delete_multiple(['image1.png', 'image2.png'], true)
+    rescue Aliyun::Oss::RequestError => e
+      puts "Delete Objects fail", e.code, e.message, e.request_id
+    end
+    
+
+### Copy Object
+
+
+With BucketObjects#copy, we can copy objects from some bucket to others.
+
+    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)
+    
+    begin
+      client.bucket_objects.copy('new_image.png', 'origin-bucket-name', 'origin.png')
+    rescue Aliyun::Oss::RequestError => e
+      puts "Copy Objects fail", e.code, e.message, e.request_id
+    end
+    
+Note: the origin bucket and target bucket must locate at same region.
+
+Now, it allow to modify User meta information.
+
+
+### Modify Object Meta
+
+With Copy object, specify the source object and target object to the same one, we can implement modify user meta information.
+
+    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)
+    
+    begin
+      headers = { "Content-Type" => "image/japeg" }
+      client.bucket_objects.copy('image.png', 'bucket-name', 'image.png', headers)
+    rescue Aliyun::Oss::RequestError => e
+      puts "Copy Objects fail", e.code, e.message, e.request_id
+    end
+ 
+ 
+ 
+That's it, Here we visit [Multipart Upload](./multipart.md)