oss 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18056995a42219f8ec4e6d5b89276451d71db85
-  data.tar.gz: bd2c2b1fd51045d94b340a8e4438b27bc5777f47
+  metadata.gz: 4b6ac21fd62a512f849f4479d6ee4e00fc905cac
+  data.tar.gz: 86d458df9b9f4fdb76ddf236e397a4dce01546b7
 SHA512:
-  metadata.gz: 31d22959e6651e173e1afa5451ab4541b0e1d45645b7d0932bda415098be873afbfe4a6b225d48b480b62096d601658133b909e4d1400eafaf74f2918e330903
-  data.tar.gz: f7c0cd2589281c402fa6785725db956fce4ffc3e3c42b59b11e08814188bfded253e6d7a1de3ab3660847fff351db38ed16d5f7806ebc0f293d7a573af84dea8
+  metadata.gz: 8eb1642cba5e9abbe9db0b344d596764a926803e7fdf3bcf16d27b34dec8530940f8c219d020730d1eef80b5552641b7fcd68410032f38a7085d7d9e6a88f7ba
+  data.tar.gz: 2dbb6f7ca282587052d6f3c28f031e704c0e101ddd87c31c9f19c65a17546fe016b18021ac5868539d602df7649249efdf8f025aabf5c662ac0e6bb7cfee218d

data/README.md

@@ -28,19 +28,9 @@ Go to OSS website, create a new account for new user.
 
 After account created, you can create the OSS instance and get the `accessKeyId` and `accessKeySecret`.
 
-### Quick Start
-
-#### 1. Initialize OSS API
-
-```ruby
-# require the gem if you not set in Gemfile
-require 'oss'
+### Rails Application
 
-endpoint = 'oss-cn-hangzhou.aliyuncs.com'
-@api = Oss::Api.new(endpoint, access_key_id, access_key_secret)
-```
-
-Rails Application Config:
+Config:
 
 create `oss.yml` file in your rails application `config` path:
 
@@ -64,6 +54,22 @@ test:
   <<: *default
 ```
 
+Rails Application Usage Demo:
+
+[http://git.oschina.net/raymond/oss-rails-demo](http://git.oschina.net/raymond/oss-rails-demo)
+
+### Quick Start
+
+#### 1. Initialize OSS API
+
+```ruby
+# require the gem if you not set in Gemfile
+require 'oss'
+
+endpoint = 'oss-cn-hangzhou.aliyuncs.com'
+@api = Oss::Api.new(endpoint, access_key_id, access_key_secret)
+```
+
 #### 2. Create New Bucket
 
 ```ruby
@@ -355,6 +361,10 @@ Success will return Hash:
 - `allow_empty_referer` {Bool} allow empty request referer or not
 - `referers` {Array} Referer white list
 
+```ruby
+puts @api.get_bucket_referer('bucket_name')
+```
+
 #### .get_bucket_website(bucket_name)
 
 Get the bucket website config.
@@ -367,6 +377,10 @@ Success will return Hash:
 - `index_doc` {String} index page
 - `error_doc` {String} error page, maybe nil
 
+```ruby
+puts @api.get_bucket_website('bucket_name')
+```
+
 #### .get_bucket_lifecycle(bucket_name)
 
 Get the bucket object lifecycle.
@@ -381,6 +395,10 @@ Success will return lifecycle rules Array:
 - `[days]` {Number} expire after the days
 - `[date]` {String} expire date, e.g.: `2022-10-11T00:00:00.000Z` date and days only has one.
 
+```ruby
+puts @api.get_bucket_lifecycle('bucket_name')
+```
+
 #### .delete_bucket_logging(bucket_name)
 
 Delete the bucket logging settings.
@@ -390,6 +408,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.delete_bucket_logging('bucket_name')
+```
+
 #### .delete_bucket_website(bucket_name)
 
 Delete the bucket website config.
@@ -399,6 +421,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.delete_bucket_website('bucket_name')
+```
+
 #### .delete_bucket_lifecycle(bucket_name)
 
 Delete the bucket object lifecycle.
@@ -408,6 +434,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.delete_bucket_lifecycle('bucket_name')
+```
+
 #### .delete_bucket(bucket_name)
 
 Delete an empty bucket.
@@ -416,6 +446,10 @@ Delete an empty bucket.
 
 Success will return true
 
+```ruby
+puts @api.delete_bucket('bucket_name')
+```
+
 ### Object Operations
 Class `Oss::Object`
 
@@ -438,6 +472,11 @@ parameters:
 
 Success will return true
 
+```ruby
+file = File.read('/path/to/your/file')
+puts  @api.put_object('bucket_name', 'object_name', file)
+```
+
 #### .copy_object(bucket_name, object, old_bucket, old_object, options)
 
 To copy an existing object on OSS to form another object.
@@ -461,6 +500,12 @@ Success will return Hash:
 - `last_modify` the object last modify time
 - `etag` the object etag
 
+```ruby
+result = @api.copy_object('bucket_name', 'object_name', 'old_bucket', 'old_object')
+puts result[:last_modify]
+puts result[:etag]
+```
+
 #### .get_object(bucket_name, object, options)
 
 Get an object from the bucket.
@@ -504,6 +549,13 @@ Success will return Hash:
 - `hash_crc64ecma` {String} append object hash crc64
 - `next_append_position` {String} next append position
 
+```ruby
+file = File.read('/path/to/your/file')
+result = @api.append_object('bucket_name', 'object_name', file, 'old_object', 0)
+puts result[:hash_crc64ecma]
+puts result[:next_append_position]
+```
+
 #### .delete_object(bucket_name, object_name)
 
 Delete the object.
@@ -514,6 +566,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.delete_object('bucket_name', 'object_name')
+```
+
 #### .delete_multiple_objects(bucket_name, objects)
 
 Delete multiple objects.
@@ -524,6 +580,10 @@ parameters:
 
 Success will return success deleted object names
 
+```ruby
+puts @api.delete_multiple_objects('bucket_name', ['object_name1', 'object_name2'])
+```
+
 #### .head_object(bucket_name, object_name, options)
 
 Head an object and get the meta info.
@@ -539,6 +599,10 @@ parameters:
 
 Success will return response headers
 
+```ruby
+puts @api.head_object('bucket_name', 'object_name')
+```
+
 #### .put_object_acl(bucket_name, object_name, acl)
 
 Set the object ACL.
@@ -550,6 +614,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.put_object_acl('bucket_name', 'object_name', 'public-read')
+```
+
 #### .get_object_acl(bucket_name, object_name)
 
 Get the object ACL.
@@ -563,6 +631,10 @@ Success will return Hash:
 - `grant` {String} acl settings string
 - `owner` {Hash} object owner, including `id` and `display_name`
 
+```ruby
+puts @api.get_object_acl('bucket_name', 'object_name')
+```
+
 #### .post_object(bucket_name, key, options)
 
 Create form post upload parameters.
@@ -574,6 +646,11 @@ parameters:
 
 return form post need parameters including `OSSAccessKeyId` `Signature`
 
+```ruby
+@form_info = @api.post_object('bucket_name', 'object_name', options)
+# render @form_info in views
+```
+
 ### Multipart Upload Operations
 Class `Oss::Multipart`
 
@@ -596,6 +673,13 @@ Success will return Hash:
 - `key` {String} key
 - `upload_id` {String} upload_id
 
+```ruby
+result = @api.initiate_multipart_upload('bucket_name', 'object_name')
+put result[:bucket]
+put result[:key]
+put result[:upload_id]
+```
+
 #### .upload_part(bucket_name, object_name, upload_id, file, part_number, options)
 
 After a Multipart Upload is initialized, data can be uploaded by part according to the specified Object name and Upload ID. Each part uploaded has an identification number (Part number, range: 1-10,000).
@@ -612,6 +696,13 @@ Success will return Hash:
 - `etag` {String} part etag
 - `part_number` {String} part_number
 
+```ruby
+file = File.read('/file/to/path')
+result = @api.upload_part('bucket_name', 'object_name', upload_id, 1, file)
+put result[:etag]
+put result[:part_number]
+```
+
 #### .upload_part_copy(bucket_name, object_name, upload_id, old_bucket, old_object, part_number, options)
 
 The interface Upload Part Copy is used to upload a Part data by copying the data from an existing Object.
@@ -634,6 +725,13 @@ Success will return Hash:
 - `etag` {String} part etag
 - `last_modify` {String} object last modify time
 
+```ruby
+options = {copy_source_begin: 0, copy_source_end: 1024}
+result = @api.upload_part_copy('bucket_name', 'object_name', upload_id, 'old_bucket', 'old_object', 1, options)
+put result[:etag]
+put result[:last_modify]
+```
+
 #### .complete_multipart_upload(bucket_name, object_name, upload_id, parts)
 
 After all the Part data are uploaded, the API of Complete Multipart Upload must be called to complete the Multipart Upload of the entire file.
@@ -650,6 +748,15 @@ Success will return Hash:
 - `key` {String} object key
 - `etag` {String} object etag
 
+```ruby
+parts = [{etag: 'etag1', part_number: 1}, {etag: 'etag2', part_number: 2}]
+result = @api.complete_multipart_upload('bucket_name', 'object_name', upload_id, parts)
+put result[:location]
+put result[:bucket]
+put result[:key]
+put result[:etag]
+```
+
 #### .abort_multipart_upload(bucket_name, object_name, upload_id)
 
 This interface can be used to abort a Multipart Upload event according to the corresponding Upload ID offered by the user. 
@@ -661,6 +768,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.abort_multipart_upload('bucket_name', 'object_name', upload_id)
+```
+
 #### .list_multipart_upload(bucket_name, options)
 
 This interface can list all Multipart Upload events under execution, which means all the events initialized but neither completed nor aborted. 
@@ -683,6 +794,15 @@ return uploads Array including Hash:
 - `upload_id` {String} upload id
 - `initiated` {String} initiated time
 
+```ruby
+list = @api.list_multipart_upload('bucket_name', upload_id)
+list.uploads.each do |object|
+  puts object[:key]
+  puts object[:upload_id]
+  puts object[:initiated]
+end
+```
+
 #### .list_parts(bucket_name, object_name, options)
 
 The interface List Parts can be used to list all Parts corresponding to a specified Upload ID which have been successfully uploaded.
@@ -704,6 +824,16 @@ return parts Array including Hash:
 - `etag` {String} part etag
 - `size` {String} part size
 
+```ruby
+list = @api.list_parts('bucket_name', 'object_name')
+list.parts.each do |part|
+  puts part[:part_number]
+  puts part[:last_modified]
+  puts part[:etag]
+  puts part[:size]
+end
+```
+
 ### CORS (Cross-Origin Resource Sharing) Operations
 Class `Oss::Cors`
 
@@ -717,6 +847,11 @@ parameters:
 
 Success will return true
 
+```ruby
+rules = [[{key: 'AllowedOrigin', value: '*'}, {key: 'AllowedMethod', value: 'GET'}], [{key: 'AllowedOrigin', value: 'http://www.a.com'}, {key: 'AllowedMethod', value: 'PUT'}]]
+puts @api.put_bucket_cors('bucket_name', rules)
+```
+
 #### .get_bucket_cors(bucket_name)
 
 The operation of Get Bucket cors operation is used to get the current CORS rules in the specified Bucket.
@@ -726,6 +861,10 @@ parameters:
 
 Success will return rules Array
 
+```ruby
+puts @api.get_bucket_cors('bucket_name')
+```
+
 #### .delete_bucket_cors(bucket_name)
 
 The Delete Bucket cors operation is used to disable the CORS function corresponding to the specified Bucket and remove all the rules.
@@ -735,6 +874,10 @@ parameters:
 
 Success will return true
 
+```ruby
+puts @api.delete_bucket_cors('bucket_name')
+```
+
 #### .option_object(bucket_name, object_name, origin, request_method, request_headers)
 
 Before sending the cross-origin request, the browser will first send a preflight request (OPTIONS) with specific source origin, HTTP method, and header information to OSS so that it can decide whether to send the real request.
@@ -748,6 +891,11 @@ parameters:
 
 Success will return response headers
 
+```ruby
+result = @api.option_object('bucket_name', 'object_name', 'Origin', 'GET', request_headers)
+puts result.headers
+```
+
 ## Run Rake Unit Test
 
 `id=accessKeyId secret=accessKeyIdSecret rake test -I --order=a`

data/lib/oss/service.rb

@@ -41,7 +41,7 @@ module Oss
             :location      => bucket.xpath('Bucket/Location').text,
             :name          => bucket.xpath('Bucket/Name').text,
             :creation_date => bucket.xpath('Bucket/CreationDate').text
-        }
+        } if bucket.xpath('Bucket/Name').text != ''
       end
       results
     end

data/lib/oss/version.rb

@@ -1,3 +1,3 @@
 module Oss
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oss
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - RaymondChou
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler