aliyunoss 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0859a2ea3ada1c1b72d5aa4bf7c19b475f2eee2
-  data.tar.gz: 3097869be179d2db30cf5c62cbac7f30994bc0bc
+  metadata.gz: 5cc87c05e0eb083f64578345b86b05f6734f6bca
+  data.tar.gz: 2f38f52a10c1c692d9d91c5466eb2690f75167f1
 SHA512:
-  metadata.gz: dedf4b7a770d1cf47d24433121c873906be73773d80910a018f445f7e61a50eb9dba647d824d36747275113cb3ef9e6467d4bd6bb90657aff484ab8ee678f062
-  data.tar.gz: cf277b1cb70111c855c9a997e523940d5198f60290196db1b67c8bd6b4d3ae755e96dd5a9768bde540490c035f386b7668c5c31f08429a1f65ee5f24b600781c
+  metadata.gz: 6bf9a1f3732ab56243a38a98d74f03d6eabad29b81aa928440c764613cb4a4e76da598a6a11859567b944c6310ab22387e40fb5d31b1c2c39ac7b325dbd918a7
+  data.tar.gz: 5a0b80b464be4ce629fbe9eccfa543c41b916c68cfddaffa7d34c05026e9701e70cc9f828cee93a60e50ed198756b19506ce365c5fc1adc197884931df476ba1

data/.byebug_history

@@ -0,0 +1,15 @@
+q
+Aliyun::Oss.config[:logger].info 'xxxx'
+Aliyun::Oss.config[:logger]
+Aliyun::Oss.config
+Aliyun::Oss.logger
+    Aliyun::Oss.configure(logger: Logger.new(STDOUT))
+Aliyun::Oss.logger
+Aliyun::Oss.configure.logger
+Aliyun::Oss.configure.log
+q
+@config[:logger]
+c
+@config[:logger]
+c
+@config[:logger]

data/.gitignore

@@ -13,4 +13,5 @@
 *.a
 mkmf.log
 *~
-aliyun-config.yml
+aliyun-config.yml
+*.gem

data/Gemfile

@@ -3,4 +3,6 @@ source 'https://ruby.taobao.org/'
 # Specify your gem's dependencies in aliyun-oss.gemspec
 gemspec
 
+gem 'nokogiri'
+
 gem 'byebug', :group => ['development', 'test']

data/README.md

@@ -2,7 +2,29 @@
 
 Ruby gem for [Aliyun Open Storage Service (OSS)][1]. This gem implemented API from [references of Aliyun OSS-API][2].
 
-## Installation
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Load Access Key ID and Access Key Secrete](#load)
+  * [Get Log Messages](#setlog)
+  * [Using Bucket API](#highlevel)
+    * [List Buckets](#listbuckets)
+	* [Create a Bucket](#newbucket)
+	* [Open a Bucket](#openbucket)
+	* [List Files In Bucket](#listfiles)
+	* [Upload a File to Bucket](#uploadfile)
+	* [Download a File from Bucket](#downloadfile)
+	* [Share a File in Bucket](#sharefile)
+	* [Delete a File in Bucket](#deletefile)
+	* [Upload a Large File in Multipart Way](#uploadlargefile)
+	* [Delete a bucket](#deletebucket)
+	* [Enable/Disable Logging for bucket](#logging)
+  * [Using Primitive API](#lowlevel)
+* [Test](#test)
+* [Contribute](#contribute)
+
+## <a name="installation"></a>Installation
 
 Add this line to your application's Gemfile:
 
@@ -12,73 +34,258 @@ gem 'aliyunoss'
 
 And then execute:
 
-    $ bundle
+```ruby
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install aliyunoss
+```ruby
+$ gem install aliyunoss
+```
 
-## Usage
+## <a name="usage"></a>Usage
 
-This gem provides high level interfaces which are built around class Bucket and low level interfaces which are wrappers for [OSS API][2].
+This gem provides Bucket API which are built around class Bucket and Primitive API which are wrappers for [OSS API][2]. Most of time using Bucket API is OK except you find OSS API that I didn't implement.
 
-### Load Access Key ID and Access Key Secret
+### <a name="load"></a>Load Access Key ID and Access Key Secret
 
 Specify you access key and access secret before calling methods provided in this gem:
 
-	Aliyun::Oss::configure(:access_key_id => 'access key id from aliyun', :access_key_secret => 'access secret from aliyun')
+```ruby
+Aliyun::Oss::configure(:access_key_id => 'access key id from aliyun', :access_key_secret => 'access secret from aliyun')
+```
+	
+When using this gem in a rails project, you can create a file named 'aliyunoss_key.rb' in RAILS\_ROOT/config/initializers, whose content is: 
 
-### Low Level Interfaces
+```ruby
+Aliyun::Oss::configure(:access_key_id => 'access key id from aliyun', :access_key_secret => 'access secret from aliyun')
+```
+	
+Then you can use the following APIs anywhere.
 
-Low level interfaces are simple wrappers for [OSS API][2], you send requests with specified parameters and receive responses with a Net::HTTPResponse object. All parameters listed in [OSS API][2] are needed for every request, and context info between requests is maintained by yourself. In order to tell whether a a request is success, check code and body of returned Net::HTTPResponse object.
+### <a name="setlog"></a>Get Log Messages
 
-All [OSS API][2] listed are implemented except [Post Object][3] and [CORS APIs][4].
+Log message is prohibited by default, you can pass a logger instace to enable it:
 
-List all the buckets:
+```ruby
+Aliyun::Oss::configure(:logger => Logger.new(STDOUT))
+```
 
-	Aliyun::Oss::API.list_bucket
+### <a name="highlevel"></a>Bucket API
 
-Upload data to specified bucket:
+Bucket API are built around class Bucket. You create a new bucket, and upload, download or delete files in it. When needed, responses are parsed to array, hash or object etc, thus more meaningful. Exceptions will be raised when request failed.
 
-	bucket = Aliyun::Oss::Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
-	path = '/test.dat'
-	data = Random.new.bytes(1024 * rand(100..300))
-	Aliyun::Oss::API.put_object(bucket, path, data)
+```ruby
+# Create a bucket in OSS server
+bucket = Aliyun::Oss::Bucket.create('aliyun-oss-gem-api-test','oss-cn-hangzhou')
+	
+# Upload a file
+filename = '/some/file'
+bucket.upload( IO.read(filename) )
+	
+# List all files in this bucket, returns a Hash array containing files info
+files = bucket.list_files
+	
+# Download a file, returns raw data
+data = bucket.download( '/some/path' )
+```
+	
+#### <a name="listbuckets"></a>List all buckets
 
-Download data from specified bucket:
+After correctly configuring your access key and secret, you can list all buckets:
 
-	bucket = Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
-	path = '/test.dat'
-	Aliyun::Oss::API.get_object(bucket, path)
+```ruby
+Aliyun::Oss::Bucket.all
+```
 
-For more usage, see API documentation generated by rdoc.
+The result is a Bucket array. Class Bucket has some simple attributes :
 
-### High Level Interfaces
+```ruby
+class Bucket
+  attr_accessor :location, :name, :creation_date, :domain, :extranet_endpoint, :intranet_endpoint
+  # ...
+end
+```
 
-High level interface are built around class Bucket. You create a new bucket, and upload, download or delete files in it. When needed, responses are parsed to array, hash or object etc, thus more meaningful. Exceptions will be raised when request failed.
+#### <a name="newbucket"></a>Create a new bucket
 
-	# Create a bucket in OSS server
-	bucket = Aliyun::Oss::Bucket.create('aliyun-oss-gem-api-test','oss-cn-hangzhou')
-	
-	# Upload a file
-	filename = '/some/file'
-	bucket.upload( IO.read(filename) )
-	
-	# List all files in this bucket, returns a Hash array containing files info
-	files = bucket.list_files
+You can create a new bucket using class method *create* of Bucket:
+
+```ruby
+bucket = Aliyun::Oss::Bucket.create(bucket_name, bucket_location)
+```
 	
-	# Download a file, returns raw data
-	data = bucket.download( '/some/path' )
+Where *bucket_name* is a string, and *bucket_location* is an optional string parameter which defaults to 'oss-cn-hangzhou'. Other available bucket locations can be referenced [here][5]. This method return a new Bucket instance if success.
+
+#### <a name="openbucket"></a>Open a bucket
+
+There is no such opeartion as opening a bucket, but you can create a Bucket instance by:
+
+```ruby
+Aliyun::Oss::Bucket.new(name: 'bucket-name', location: 'oss-cn-beijing')
+```
+
+So you can continue to download or upload files using this Bucket instance.
+
+#### <a name="listfiles"></a>List all files in an bucket
+
+You can list all files in an bucket using instance method *list\_files* of a bucket:
+
+```ruby
+files  = bucket.list_files
+```
+
+The result is a array consisted of file objects which are parsed from xml reponse, eg.
+
+```ruby
+[
+  { "key"=>"100f1a845046c189944dc8fd57bffbe390b90e3a.png",
+    "last_modified"=>"2015-12-14T03:04:37.000Z",
+    "e_tag"=>"\"B9072ECBBF4B06962517B3FD4090538E\"",
+    "type"=>"Normal",
+    "size"=>"49509",
+    "storage_class"=>"Standard" },
+
+{ "key"=>"11c5db2a88648d25da889a1d20687ec535a50905.jpg",
+    "last_modified"=>"2015-12-14T08:03:54.000Z",
+    "e_tag"=>"\"77618F54695C08E278ACBD7D9C63E521\"",
+	"type"=>"Normal",
+	"size"=>"491133",
+	"storage_class"=>"Standard" }
+]
+```
+
+#### <a name="uploadfile"></a>Upload a file to bucket
+
+You can upload a file using instance method *upload* of a bucket, eg.
+
+```ruby
+data = IO.read('/local/path/of/file')
+bucket.upload(data, '/remote/path/of/file') 
+```
+
+This will raise an exception unless success. A file in remote bucket can include some meta data, eg. when serving images, we often want Aliyun OSS server to return *Content-Type* header for http GET request. To acheive this effect, we have to add additional paramters when uploading file, eg.
+
+```ruby
+image = IO.read('/local/image')
+bucket.upload(image, '/remote/image', 'Content-Type'=>'image/png')
+```
+
+#### <a name="downloadfile"></a>Download file from bucket
+
+You can read content of a remote file using instance method *download* of a bucket, eg.
+
+```ruby
+raw_data = bucket.download('/remote/path/of/file')
+```
+
+where *raw_data* is body of a Net::HTTPResponse object.
+
+#### <a name="sharefile"></a>Generate a sharing url of a remote file
+
+If you set your bucket private for reading, others cannot access content of files in your bucket without valid access key and secret. But you won't give them access key or secret, instead you generate a sharing url for them to access your file:
+
+```ruby
+public_url = bucket.share('/remote/file')
+```
 	
-For more usage, see API documentation generated by rdoc.	
+This will generate a public url that can access some remote file. By default this url is only valid for 1 hour, you can change this behavior by adding the second paramter:
+
+```ruby
+public_url = bucket.share('/remote/file', 60 * 60 * 24)
+```
+
+where unit used is second, so that will be 1 day long.
+
+#### <a name="deletefile"></a>Delete a file in the bucket
+
+You can delete a remote file using instance method *delete* of a bucket, eg:
+
+```ruby
+bucket.delete('/remote/path/of/file')
+```
 	
-## Testing
+It will return an Net::HTTPNoContent if file is deleted successfully OR file not found.
+
+#### <a name="uploadlargefile"></a>Upload a large file in multipart way
+
+When uploading a large file, using multipart way is preffered due to unreliable network condition. An multipart task consist of a sequence operations: *multipart\_upload\_initiate*, *multipart\_upload* and *multipart_upload_compelete*:
+
+```ruby
+bucket.multipart_upload_initiate('/remote/path/of/a/large/file')
+    
+10.times do
+  bucket.multipart_upload( Random.new.bytes(1024 * rand(100..300)) )
+end
+
+bucket.multipart_upload_complete
+```
+
+#### <a name="deletebucket"></a>Delete a bucket
+
+You can delete a bucket using instance method *delete!* of a bucket, eg:
+
+```ruby
+bucket.delete!
+```
+
+Exception will be raised unless bucket is empty.
+
+#### <a name="logging"></a>Enable/Disable logging for a bucket
+
+OSS can record access log for a bucket, you can toggle this function by:
+
+```ruby
+bucket.enable_logging('/remote/file/of/log', 'log_prefix')
+```
+
+Then all access log is recorded with prefix you specified with the second paramter, and stored in the path you specified by the first parameter.
+
+Disable this function by:
+
+```ruby
+bucket.disable_logging
+```
+
+### <a name="lowlevel"></a>Primitive API
+
+Primitive API are simple http wrappers for [OSS API][2], you send requests with specified parameters and receive responses with a Net::HTTPResponse object. All parameters listed in [OSS API][2] are needed for every request, and context information between requests is maintained by yourself. In order to tell whether a a request is success, check code and body of returned Net::HTTPResponse object.
+
+All [OSS API][2] listed are implemented except [Post Object][3] and [CORS APIs][4].
+
+List all the buckets:
+
+```ruby
+Aliyun::Oss::API.list_bucket
+```
+
+Upload data to specified bucket:
+
+```ruby
+bucket = Aliyun::Oss::Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
+path = '/test.dat'
+data = Random.new.bytes(1024 * rand(100..300))
+Aliyun::Oss::API.put_object(bucket, path, data)
+```
+
+Download data from specified bucket:
+
+```ruby
+bucket = Bucket.new(:name => 'bucket-name', :location => 'oss-cn-beijing')
+path = '/test.dat'
+Aliyun::Oss::API.get_object(bucket, path)
+```
+
+For more usage, see API documentation generated by rdoc.
+
+## <a name="test"></a>Testing
 
 This gem use rspec for testing. Most of testing needs a valid access key id and access key secret, you should get these info from Aliyun.
 
 Create a file named aliyun-config.yml in path rspec/aliyunoss/config, fill in valid access key id and access key secret and cotinue to test.
 
-## Contributing
+## <a name="contribute"></a>Contributing
 
 1. Fork it ( https://github.com/yijiecc/aliyunoss/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -86,7 +293,8 @@ Create a file named aliyun-config.yml in path rspec/aliyunoss/config, fill in va
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-[1]: http://www.aliyun.com/product/oss
-[2]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/abstract
-[3]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/object&PostObject
-[4]: http://docs.aliyun.com/?spm=5176.383663.9.2.F8rxxr#/oss/api-reference/cors&abstract
+[1]: https://www.aliyun.com/product/oss?spm=5176.doc31870.416540.44.QdQVwH
+[2]: https://help.aliyun.com/document_detail/31827.html?spm=5176.doc31817.6.564.Px1zOr
+[3]: https://help.aliyun.com/document_detail/31849.html?spm=5176.doc31827.6.581.XDg3ZS
+[4]: https://help.aliyun.com/document_detail/31870.html?spm=5176.87240.400427.34.vFnPt8
+[5]: https://help.aliyun.com/document_detail/31837.html?spm=5176.doc31959.2.1.EpUpfD

data/lib/aliyunoss.rb

@@ -1,8 +1,13 @@
+#
 # dependency
+#
 require 'nokogiri'
 require 'net/http'
 require 'logger'
 
+#
+# aliyunoss files
+# 
 require 'aliyunoss/config'
 require 'aliyunoss/config_helper'
 require 'aliyunoss/extension'

data/lib/aliyunoss/api.rb

@@ -1,19 +1,23 @@
 module Aliyun
   module Oss
 
+      # Reference
+      # http://docs-aliyun-com-cn-b.oss-cn-hangzhou.aliyuncs.com/oss/pdf/oss_api-reference.pdf
     module API
       extend self
 
-      # Reference
-      # http://docs-aliyun-com-cn-b.oss-cn-hangzhou.aliyuncs.com/oss/pdf/oss_api-reference.pdf
 
+      #
       # List all buckets
+      # 
       def list_bucket(params = {})
         Aliyun::Oss::OssRequest.new(nil, '/', nil, {}, {}).get
       end
       alias :get_service :list_bucket
 
+      # 
       # Create a new bucket
+      # 
       def put_bucket(name, location = 'oss-cn-hangzhou')
         bucket = Bucket.new(name: name, location: location)
         request = Aliyun::Oss::OssRequest.new(bucket, '/')
@@ -27,54 +31,74 @@ HERE
       end
       alias :create_bucket :put_bucket
 
+      # 
       # Delete a bucket
+      # 
       def delete_bucket(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/').delete
       end
-        
+
+      # 
       # Delete bucket logging
+      # 
       def delete_logging(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'logging'=>nil).delete
       end
 
+      # 
       # Delete bucket website
+      # 
       def delete_website(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'website'=>nil).delete
       end
       alias :disable_website :delete_website
 
+      # 
       # List objects in bucket
+      # 
       def list_object(bucket, queries = {})
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, queries).get
       end
 
+      # 
       # Get bucket acl
+      # 
       def get_bucket_acl(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'acl'=>nil).get
       end
 
+      # 
       # Get bucket location
+      # 
       def get_bucket_location(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'location'=>nil).get
       end
 
+      # 
       # Query bucket logging status
+      # 
       def get_bucket_logging(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'logging'=>nil).get
       end
 
+      # 
       # Query bucket website status
+      # 
       def get_bucket_website(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'website'=>nil).get
       end
 
+      # 
       # Set bucket acl permission
+      # 
       def put_bucket_acl(bucket, permission)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, {}, 'x-oss-acl'=> permission).put
       end
       alias :set_bucket_acl :put_bucket_acl
 
-      # Enable or disable bucket logging
+      # 
+      # Enable bucket logging
+      # 
       def enable_bucket_logging(bucket, bucket_name_for_logging, log_prefix)
         request = Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'logging'=>nil)
         request.body = <<HERE
@@ -90,6 +114,9 @@ HERE
         request.put
       end
 
+      # 
+      # Disable bucket logging
+      #       
       def disable_bucket_logging(bucket)
         request = Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'logging'=>nil)
         request.body = <<HERE
@@ -101,7 +128,9 @@ HERE
         request.put        
       end
 
+      # 
       # Set bucket website access
+      # 
       def put_bucket_website(bucket, index_page, error_page)
         request = Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'website'=>nil)
         request.body = <<HERE
@@ -119,19 +148,25 @@ HERE
         request.put
       end
       alias :set_bucket_website :put_bucket_website
-      
+
+      # 
       # Copy Object
+      # 
       def copy_object(source_bucket, source_path, target_bucket, target_path, headers = {})
         headers = headers.merge({'x-oss-copy-source'=> "/" + source_bucket.name + source_path})
         Aliyun::Oss::OssRequest.new(target_bucket, target_path, nil, {}, headers).put
       end
 
+      # 
       # Delete Object
+      # 
       def delete_object(bucket, path)
         Aliyun::Oss::OssRequest.new(bucket, path).delete
       end
 
+      # 
       # Delete Multiple Object
+      # 
       def delete_multiple_objects(bucket, objects, quiet_mode = false)
         xml = '<?xml version="1.0" encoding="UTF-8"?>'
         xml << '<Delete>'
@@ -143,48 +178,70 @@ HERE
         request.post
       end
 
+      # 
       # Get Object
+      # 
       def get_object(bucket, path, headers = {})
         Aliyun::Oss::OssRequest.new(bucket, path, nil, {}, headers).get
       end
 
+      # 
       # Head Object
+      # 
       def head_object(bucket, path, headers = {})
         Aliyun::Oss::OssRequest.new(bucket, path, nil, {}, headers).head
       end
 
+      # 
       # Put Object
+      # 
       def put_object(bucket, path, data, headers = {})
         request = Aliyun::Oss::OssRequest.new(bucket, path, nil, {}, headers)
         request.body = data
         request.put
       end
 
+      # 
       # get share url for specified object
+      # 
       def generate_share_url(bucket, path, expires_in = 3600)
         Aliyun::Oss::OssRequest.new(bucket, path).url_for_sharing(expires_in)
       end
 
+      # 
       # Post Object
+      #
       # Not implemented
 
+      # 
       # Post Policy
+      # 
       # Not implemented
 
+      # 
       # Post signature
+      # 
       # Not implemented
 
+      # 
       # Multipart Initiate
+      # 
       def multipart_upload_initiate(bucket, path)
         Aliyun::Oss::OssRequest.new(bucket, path, nil, 'uploads'=>nil).post
       end
 
+      #
+      # Multipart upload part
+      # 
       def multipart_upload_part(bucket, path, upload_id, data, part_number)
         request = Aliyun::Oss::OssRequest.new(bucket, path, nil, 'partNumber'=> part_number.to_s, 'uploadId'=> upload_id)
         request.body = data
         request.put
       end
 
+      #
+      # Multipart upload from copy
+      # 
       def multipart_upload_from_copy(upload_id, source_bucket, source_path, target_bucket, target_path, part_number, part_size, range = nil)
         request = Aliyun::Oss::OssRequest.new(target_bucket, target_path, nil, 'partNumber'=> part_number.to_s, 'uploadId'=> upload_id)
         request['Content-Length'] = part_size
@@ -193,6 +250,9 @@ HERE
         request.put
       end
 
+      #
+      # Complete an multipart upload.
+      # 
       def multipart_upload_complete(bucket, path, upload_id, part_list)
         request = Aliyun::Oss::OssRequest.new(bucket, path, nil, 'uploadId'=> upload_id)
         xml = '<?xml version="1.0" encoding="UTF-8"?>'   
@@ -203,14 +263,23 @@ HERE
         request.post
       end
 
+      #
+      # Abort an upload task
+      # 
       def multipart_upload_abort(bucket, path, upload_id)
         Aliyun::Oss::OssRequest.new(bucket, path, nil, 'uploadId'=> upload_id).delete
       end
 
+      #
+      # List finished multipart parts
+      # 
       def multipart_upload_finished_parts(bucket, path, upload_id)
         Aliyun::Oss::OssRequest.new(bucket, path, nil, 'uploadId'=> upload_id).get
       end
 
+      #
+      # List all unfinished multipart task
+      # 
       def multipart_upload_unfinished_task(bucket)
         Aliyun::Oss::OssRequest.new(bucket, '/', nil, 'uploads'=>nil).get
       end

data/lib/aliyunoss/bucket.rb

@@ -12,40 +12,61 @@ module Aliyun
         end
       end
 
-      # Class methods
+      # 
+      # Class method - List all buckets in my account
+      # 
       def self.all
         Aliyun::Oss::API.list_bucket.raise_unless(Net::HTTPOK).to_buckets
       end
 
+      #
+      # Class method - Create a new bucket
+      # 
       def self.create(name, location = 'oss-cn-hangzhou')
         Aliyun::Oss::API.put_bucket(name, location).raise_unless(Net::HTTPOK)
         Bucket.new(:name => name,  :location=> location, :creation_date => Time.now)
       end
 
-      # Instance Methods -- object download and upload
+      # 
+      # List all files in an bucket
+      # 
       def list_files(options = {})
         Aliyun::Oss::API.list_object(self, options).raise_unless(Net::HTTPOK).to_objects
       end
 
+      #
+      # Upload data to bucket
+      # 
       def upload(data, path, options = {})
         Aliyun::Oss::API.put_object(self, path, data, options).raise_unless(Net::HTTPOK)
       end
 
+      #
+      # Download file from remote server
+      # 
       def download(path, options = {})
         Aliyun::Oss::API.get_object(self, path, options)
           .raise_unless(Net::HTTPOK)
           .body
       end
 
+      #
+      # Generate a url that can be shared to others
+      # 
       def share(path, expires_in = 3600)
         Aliyun::Oss::API.generate_share_url(self, path, expires_in)
       end
 
+      #
+      # Delete remote file
+      # 
       def delete(path)
         Aliyun::Oss::API.delete_object(self, path).raise_unless(Net::HTTPNoContent)
       end
 
+      # 
       # Multipart upload and copy
+      # 
       def multipart_pending
         Aliyun::Oss::API.multipart_upload_unfinished_task(self)
           .raise_unless(Net::HTTPOK)
@@ -95,7 +116,9 @@ module Aliyun
         @multipart_path = nil
       end
 
-      # Instance Methods -- miscellaneous
+      # 
+      # delete this bucket
+      # 
       def delete!
         Aliyun::Oss::API.delete_bucket(self).raise_unless(Net::HTTPNoContent)
       end

data/lib/aliyunoss/config.rb

@@ -1,22 +1,28 @@
 require 'yaml'
 require 'logger'
 
+class NullLogger < Logger
+  def initialize(*args)
+  end
+
+  def add(*args, &block)
+  end
+end
+
+
 module Aliyun
   module Oss
 
     @config = {
-      :log_level => 'info',
+      :logger => nil,
       :host => 'aliyuncs.com',
       :access_key_id => nil,
       :access_key_secret => nil
     }
 
-    @_logger = nil
-
     @valid_config_keys = @config.keys
 
     def self.configure(opts = {})
-      @_logger = nil
       opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include?(k.to_sym)}
     end
 
@@ -36,11 +42,7 @@ module Aliyun
     end
 
     def self.logger
-      unless @_logger
-        @_logger ||= Logger.new(STDOUT)
-        @_logger.level = Logger.const_get(@config[:log_level].upcase) rescue Logger::INFO        
-      end
-      @_logger
+      @config[:logger] or (@null_logger ||= NullLogger.new)
     end
     
   end

data/lib/aliyunoss/extension.rb

@@ -25,10 +25,10 @@ class String
   # Convert CamelCase to ruby_case
   def underscore
     self.gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
   end
 
 end

data/lib/aliyunoss/oss_request.rb

@@ -9,7 +9,10 @@ module Aliyun
       
       include ConfigHelper
       attr_accessor :bucket, :path, :body, :queris, :domain
-      
+
+      #
+      # Create a new oss request, parameters will be sent to methods of Net::HTTP later.
+      # 
       def initialize(bucket, path, domain = nil, queries = {}, headers = {})
         @bucket = bucket
         @path = path
@@ -18,6 +21,9 @@ module Aliyun
         @headers = {"Content-Type" => "", "Content-MD5" => "", "Date" => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')}.merge(headers)
       end
 
+      #
+      # Get complete url for this request
+      # 
       def get_uri
         if @domain
           uri = URI("http://#{domain}/")
@@ -68,6 +74,9 @@ module Aliyun
       add_operation :head
       add_operation :post
 
+      #
+      # Get sharing url for this request, pass _expires_in_ as parameter.
+      # 
       def url_for_sharing(expires_in)
         uri = get_uri
         request = Net::HTTP::Get.new(uri)
@@ -80,10 +89,16 @@ module Aliyun
         uri.to_s
       end
 
+      #
+      # Get http header value by attribute 
+      # 
       def [](key)
         @headers[key]
       end
 
+      #
+      # Set http header value by attribute
+      # 
       def []=(key, value)
         @headers[key] = value
       end

data/lib/aliyunoss/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module Oss
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/spec/aliyunoss/bucket_spec.rb

@@ -6,6 +6,7 @@ describe Aliyun::Oss::Bucket do
 
   before :all do
     Aliyun::Oss.configure_with('spec/aliyunoss/config/aliyun-config.yml')
+    Aliyun::Oss.configure(logger: Logger.new(STDOUT))
     @bucket_name = "aliyunoss-gem-test-#{rand.to_s.delete('0.')}"
     @location = 'oss-cn-beijing'
     @bucket = Aliyun::Oss::Bucket.new( location: @location, name: @bucket_name)
@@ -119,7 +120,7 @@ describe Aliyun::Oss::Bucket do
     end
     
     @bucket.delete!
-    expect {Bucket.new(:name=> 'bucket_not_exist').delete!}.to raise_error
+    expect {Aliyun::Oss::Bucket.new(:name=> 'bucket_not_exist').delete!}.to raise_error(SocketError)
   end
   
 end

data/spec/aliyunoss/config_spec.rb

@@ -6,25 +6,22 @@ describe 'Aliyun::Oss Configuration' do
 
   before :each do
     config = Aliyun::Oss.config
-    config[:log_level] = 'info'
     config[:access_key_id] = nil
     config[:access_key_secret] = nil
   end
   
   it 'should load default options' do
     default_config = Aliyun::Oss.config
-    expect(default_config).to include(:log_level)
     expect(default_config).to include(:access_key_id)
   end
 
   it 'should accept configuration from #configure' do
     url = "http://bucket_name.region.aliyuncs.com"
     access_key = "access_key_from_aliyun"
-    Aliyun::Oss.configure(:log_level => 'debug', :access_key_id => access_key, :not_used_para => "not used")
+    Aliyun::Oss.configure(:access_key_id => access_key, :not_used_para => "not used")
     config = Aliyun::Oss.config
     expect(config.keys).not_to include(:not_used_para)
     expect(config[:access_key_id]).to eq(access_key)
-    expect(config[:log_level]).to eq('debug')    
   end
 
   it 'should load yaml config file if specified' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyunoss
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - yijiecc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -80,7 +81,6 @@ files:
 - Rakefile
 - aliyunoss.gemspec
 - lib/aliyunoss.rb
-- lib/aliyunoss/#oss_request.rb#
 - lib/aliyunoss/api.rb
 - lib/aliyunoss/bucket.rb
 - lib/aliyunoss/config.rb
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A gem for accessing Aliyun Open Storage Service.

data/lib/aliyunoss/#oss_request.rb#

@@ -1,154 +0,0 @@
-# coding: utf-8
-require 'base64'
-require 'openssl'
-
-module Aliyun
-  module Oss
-
-    class OssRequest
-      
-      include ConfigHelper
-      attr_accessor :bucket, :path, :body, :queris, :domain
-      
-      def initialize(bucket, path, domain = nil, queries = {}, headers = {})
-        @bucket = bucket
-        @path = path
-        @queries = queries
-        @domain = domain
-        @headers = {"Content-Type" => "", "Content-MD5" => "", "Date" => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')}.merge(headers)
-      end
-
-      def get_uri
-        if @domain
-          uri = URI("http://#{domain}/")
-        else
-          if @bucket
-            uri = URI("http://#{bucket.name}.#{bucket.location}.#{host}")
-          else
-            uri = URI("http://oss.#{host}")
-          end
-        end
-        uri.path = @path
-        uri.query = @queries.to_query_string if @queries.count > 0
-        uri
-      end
-
-      def self.add_operation(verb)
-        define_method(verb) do
-          uri = get_uri
-
-          request = Net::HTTP.send(:const_get, verb.to_s.capitalize).new(uri)
-          
-          @headers.each_pair {|k,v| request[k] = v}
-          
-          if @body
-            request.body = @body
-            digest = OpenSSL::Digest::MD5.digest(@body)
-            request['Content-MD5'] = Base64.encode64(digest).strip
-            request['Content-Length'] = @body.bytesize
-          end
-
-          request['Authorization'] = 'OSS ' +  access_key_id + ':' +
-                                     signature(request)
-        
-          logger.info(verb.to_s.upcase + ' ' + uri.to_s + ' ' + request.to_hash.to_s)
-          
-          response = nil
-          Net::HTTP.start(uri.host, uri.port) do |http|
-            response = http.request(request)
-            logger.info(response.code.to_s + ' ' + response.message)
-          end
-          response          
-        end
-      end
-
-      add_operation :get
-      add_operation :put
-      add_operation :delete
-      add_operation :head
-      add_operation :post
-
-      def url_for_sharing(expires_in)
-        uri = get_uri
-        request = Net::HTTP::Get.new(uri)
-        @headers.each_pair {|k,v| request[k] = v}
-        expires_at = (Time.now + expires_in).utc.to_i
-        request["Date"] = expires_at
-        uri.query = URI.encode_www_form({"OSSAccessKeyId" => access_key_id,
-                                         "Expires" => expires_at,
-                                         "Signature" => signature(request)})
-        uri.to_s
-      end
-
-      def [](key)
-        @headers[key]
-      end
-
-      def []=(key, value)
-        @headers[key] = value
-      end
-
-      private
-      def signature(req)
-        verb = req.class.to_s.gsub(/Net::HTTP::/, '').upcase
-        data = verb + "\n" + req["Content-MD5"] + "\n" +
-               req["Content-Type"] + "\n" + req["Date"] + "\n" +
-               canonicalized_oss_headers(req) + 
-               canonicalized_resource()
-        
-        digest = OpenSSL::Digest.new('sha1')
-        hmac = OpenSSL::HMAC.digest(digest, access_key_secret, data)
-        Base64.encode64(hmac).strip
-      end
-
-      # oss api 20140828.pdf - 4.2
-      # 1) 将所有以“x-oss-”为前缀的 HTTP 请求头的名字转换成小写字母。如 ’X-OSS-Meta-Name: TaoBao’
-      #    转换成 ’x-oss-meta-name: TaoBao’ 。
-      # 2) 将上一步得到的所有 HTTP 请求头按照字典序进行升序排列。
-      # 3) 如果有相同名字的请求头,则根据标准 RFC 2616, 4.2 章进行合并(两个值之间只用逗号分隔)。
-      #    如有两个名为’x-oss-meta-name’的请求头,对应的值分别为’TaoBao’和’Alipay’,则合并后
-      #    为: ’x-oss-meta-name:TaoBao,Alipay’ 。
-      # 4) 删除请求头和内容之间分隔符两端出现的任何空格。
-      #    如 ’x-oss-meta-name: TaoBao,Alipay’ 转换成: ’x-oss-meta-name:TaoBao,Alipay’ 。
-      # 5) 将所有的头和内容用 ’\n’ 分隔符分隔拼成最后的 CanonicalizedOSSHeader 。
-      def canonicalized_oss_headers(req)
-        hash = Hash.new
-        req.each_header do |header|          
-          header = header.downcase
-          next unless header.start_with?('x-oss-')
-          if hash.has_key?(header)
-            hash[header] = hash[header] + "," + req[header].strip
-          else
-            hash[header] = req[header].strip
-          end
-        end
-
-        return "" if hash.count == 0
-        hash.keys.sort.map{|k| "#{k}:#{hash[k]}"}.join("\n") << "\n"
-      end
-
-      # oss api 20140828.pdf - 4.2
-      # 1) 将 CanonicalizedResource 置成空字符串( “” );
-      # 2) 放入要访问的 OSS 资源:“ /BucketName/ObjectName ”(无 ObjectName 则不填)
-      # 3) 如果请求的资源包括子资源 (sub-resource) ,那么将所有的子资源按照字典序,从小到大排列并
-      #    以 ’&’ 为分隔符生成子资源字符串。在 CanonicalizedResource 字符串尾添加“?”和子资源字
-      #    符串。此时的 CanonicalizedResource 例子如: /BucketName/ObjectName?acl &uploadId=UploadId
-      # 4) 如果用户请求在查询字符串 (query string) 中指定了要重写 (override) 返回请求的 header,那么将这
-      #    些查询字符串及其请求值按照字典序,从小到大排列,以 ’&’ 为分隔符,按参数的字典序添加到
-      #    CanonicalizedResource 中。此时的 CanonicalizedResource 例子:
-      #    /BucketName/ObjectName?acl&response-content-type=ContentType & uploadId =UploadId
-      def canonicalized_resource()
-        return @path unless @bucket
-        return "/#{@bucket.name}#{@path}" if @queries.count == 0
-
-        array =  @queries.keys.sort.map do |k|
-          if @queries[k] then "#{k}=#{@queries[k]}" else "#{k}" end
-        end
-          
-        "/#{@bucket.name}#{@path}?#{array.sort.join('&')}"
-      end
-
-    end
-    
-  end
-end