aliyun-oss-sdk 0.1.1 → 0.1.2

data/lib/aliyun/oss/client/bucket_objects.rb

@@ -5,7 +5,6 @@ module Aliyun
         # List objects of bucket
         #
         # @param (see #bucket_list_objects)
-        #
         # @option (see #bucket_list_objects)
         #
         # @raise [RequestError]
@@ -17,9 +16,9 @@ module Aliyun
           result = client.bucket_list_objects(*args).parsed_response
 
           object_keys = %w(ListBucketResult Contents)
-          Utils.wrap(Utils.dig_value(result, *object_keys)).map do |object|
-            Struct::Object.new(object.merge(client: client))
-          end
+          directory_keys = %w(ListBucketResult CommonPrefixes)
+          Struct::Object.init_from_response(result, object_keys, client) + \
+            Struct::Object.init_from_response(result, directory_keys, client)
         end
 
         # create object of bucket
@@ -99,11 +98,11 @@ module Aliyun
         #
         # @raise (see #bucket_append_object)
         #
-        # @return [true]
+        # @return [HTTParty::Response::Headers]
         #
         # @see Client#bucket_append_object
         def append(*args)
-          !!client.bucket_append_object(*args)
+          client.bucket_append_object(*args).headers
         end
       end
     end

data/lib/aliyun/oss/client/buckets.rb

@@ -15,11 +15,7 @@ module Aliyun
 
           bucket_keys = %w(ListAllMyBucketsResult Buckets Bucket)
           Utils.wrap(Utils.dig_value(result, *bucket_keys)).map do |bucket_hash|
-            Struct::Bucket.new(bucket_hash).tap do |bucket|
-              dup_client = client.clone
-              dup_client.bucket = bucket.name
-              bucket.client = dup_client
-            end
+            build_bucket(bucket_hash, client)
           end
         end
 
@@ -44,6 +40,16 @@ module Aliyun
         def delete(*args)
           !!client.bucket_delete(*args)
         end
+
+        private
+
+        def build_bucket(bucket_hash, client)
+          Struct::Bucket.new(bucket_hash).tap do |bucket|
+            bucket.client = Client.new(
+              client.access_key, client.secret_key, host: bucket.host, bucket: bucket.name
+            )
+          end
+        end
       end
     end
   end

data/lib/aliyun/oss/http.rb

@@ -119,7 +119,7 @@ module Aliyun
 
       def default_content_type
         {
-          'Content-Type' => 'application/x-www-form-urlencoded'
+          'Content-Type' => 'application/xml'
         }
       end
 

data/lib/aliyun/oss/struct/bucket.rb

@@ -14,6 +14,10 @@ module Aliyun
         # reference to client
         attr_accessor :client
 
+        def host
+          "#{location}.aliyuncs.com"
+        end
+
         # Get the location
         #
         # @return [String]

data/lib/aliyun/oss/struct/directory.rb

@@ -0,0 +1,25 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Directory < Object
+        # prefix in CommonPrefixes is key of Directory object
+        alias_method :prefix=, :key=
+
+        # List objects under directory
+        #
+        # @see #bucket_list_objects
+        #
+        # @param (see #bucket_list_objects)
+        # @option (see #bucket_list_objects)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Array<Aliyun::Oss::Struct::Object>]
+        def list(options = {})
+          Utils.stringify_keys!(options)
+          client.bucket_objects.list(options.merge('prefix' => key))
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/oss/struct/file.rb

@@ -0,0 +1,8 @@
+module Aliyun
+  module Oss
+    module Struct
+      class File < Object
+      end
+    end
+  end
+end

data/lib/aliyun/oss/struct/multipart.rb

@@ -28,9 +28,9 @@ module Aliyun
         #
         # @raise (see #bucket_multipart_upload)
         #
-        # @return [true]
+        # @return [HTTParty::Response::Headers]
         def upload(*args)
-          !!client.bucket_multipart_upload(*args.unshift(upload_id, key))
+          client.bucket_multipart_upload(*args.unshift(upload_id, key)).headers
         end
 
         # Copy exsting object to Multipart Upload Event

data/lib/aliyun/oss/struct/object.rb

@@ -61,11 +61,32 @@ module Aliyun
         #
         # @raise [RequestError]
         #
-        # @return [Hash]
+        # @return [HTTParty::Response::Headers]
         def meta!(*args)
           client.bucket_get_meta_object(*args.unshift(key)).headers
         end
+
+        class << self
+          def init_from_response(result, keys, client)
+            Utils.wrap(Utils.dig_value(result, *keys)).map do |object|
+              init_from_object(object, client)
+            end
+          end
+
+          def init_from_object(object, client)
+            if object.key?('Key') && object['Key'].end_with?('/')
+              Struct::Directory.new(object.merge(client: client))
+            elsif object.key?('Prefix') && object['Prefix'].end_with?('/')
+              Struct::Directory.new(object.merge(client: client))
+            else
+              Struct::File.new(object.merge(client: client))
+            end
+          end
+        end
       end
     end
   end
 end
+
+require 'aliyun/oss/struct/file'
+require 'aliyun/oss/struct/directory'

data/lib/aliyun/oss/struct/part.rb

@@ -4,9 +4,11 @@ module Aliyun
       class Part < Base
         # [Integer] :number the part number
         attr_accessor :number
+        alias_method :part_number=, :number=
 
         # [String] :etag the etag for the part
         attr_accessor :etag
+        alias_method :e_tag=, :etag=
 
         # Last Modified time
         attr_accessor :last_modified
@@ -18,14 +20,6 @@ module Aliyun
           @last_modified = Time.parse(last_modified)
         end
 
-        def part_number=(part_number)
-          @number = part_number
-        end
-
-        def e_tag=(e_tag)
-          @etag = e_tag
-        end
-
         def to_hash
           if valid?
             {

data/lib/aliyun/oss/utils.rb

@@ -85,6 +85,12 @@ module Aliyun
           [object]
         end
       end
+
+      def self.stringify_keys!(hash)
+        hash.keys.each do |key|
+          hash[key.to_s] = hash.delete(key)
+        end
+      end
     end
   end
 end

data/lib/aliyun/oss/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module Oss
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/todo.md

@@ -3,3 +3,4 @@
 + Command Line Tool
 + Custom Domain Support
 + Get Download URL
++ Multipart#upload return headers

data/wiki/multipart.md

@@ -42,7 +42,7 @@ Upload ID is the UUID for the Multipart Upload Event, store it for use later.
     bucket = "bucket-name"
     client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
     
-    res = client.bucket_multipart_upload("Exciting-Ruby.mp4", 1, "Upload ID", file_or_bin)
+    res = client.bucket_multipart_upload("Upload ID", "Exciting-Ruby.mp4", 1, file_or_bin)
     
     if res.success?
       puts "etag: #{res.headers['etag']}"
@@ -71,7 +71,7 @@ It can used to upload part to a object. Please note:
     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' })
-	res = client.bucket_complete_multipart("Exciting-Ruby.mp4", "Upload ID", [part1, part2, part3])
+	res = client.bucket_complete_multipart("Upload ID", "Exciting-Ruby.mp4", [part1, part2, part3])
 	
 
 Here, we create Aliyun::Oss::Struct::Part to build your part, use Part#valid? to valid the object.
@@ -87,7 +87,7 @@ If some Problem occurs, you may want to abort a Multipart Upload:
     bucket = "bucket-name"
     client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
     
-    res = client.bucket_abort_multipart("Exciting-Ruby.mp4", "Upload ID")
+    res = client.bucket_abort_multipart("Upload ID", "Exciting-Ruby.mp4")
     
 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.
 

data/wiki/object_based/bucket.md

@@ -0,0 +1,125 @@
+## Bucket
+
+Bucket is a 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
+    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
+    
+You can specify bucket name, location(default 'oss-cn-hangzhou') and acl(default: 'private') when create new bucket.
+
+
+### 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)
+    
+    begin
+      buckets = client.buckets.list
+    rescue Aliyun::Oss::RequestError => e
+      puts "List Buckets fail", e.code, e.message, e.request_id
+    end    
+
+### Set ACL
+
+With Client#bucket_set_acl you can modify the ACL:
+
+    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)
+    
+    bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+    # supported value: public-read-write | public-read | private
+    begin
+      bucket.set_acl('public-read')
+    rescue Aliyun::Oss::RequestError => e
+      puts "Set ACL fail", e.code, e.message, e.request_id
+    end  
+
+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
+
+To get current ACL of Bucket, use Client#bucket_get_acl:
+       
+    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)
+    
+    bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+    begin
+      acl = bucket.acl!
+    rescue Aliyun::Oss::RequestError => e
+      puts "Get ACL fail", e.code, e.message, e.request_id
+    end    
+    
+### 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, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
+    client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
+    
+    bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+    begin
+      location = bucket.location!
+    rescue Aliyun::Oss::RequestError => e
+      puts "Get Location fail", e.code, e.message, e.request_id
+    end 
+
+To get more bucket information, visit Bucket#xxx! methods [here](http://www.rubydoc.info/gems/aliyun-oss-sdk/0.1.1/Aliyun/Oss/Struct/Bucket).
+
+
+### Delete Bucket
+
+If you do need one 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)    
+    
+    begin
+      client.buckets.delete("deleted-bucket-name")
+    rescue Aliyun::Oss::RequestError => e
+      puts "Delete Bucket fail", e.code, e.message, e.request_id
+    end
+    
+Note: when the bucket is not empty(existing object or [Multipart Uploaded](./multipart.md) parts), the delete will fail.
+
+
+OK, Let's visit [Objects](./object.md)    
+    

data/wiki/object_based/cors.md

@@ -0,0 +1,71 @@
+## CORS
+
+CORS allow web application visit resources not belongs it's domain. OSS provide interface to help developer control the premissions.
+
+
+### Set CORS
+
+
+With Bucket#enable_cors, you can set cors easily:
+
+    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)
+      rule = Aliyun::Oss::Struct::Cors.new(allowed_methods: ['get'], allowed_origins: ['*'])
+	  bucket.enable_cors([rule])
+	rescue Aliyun::Oss::RequestError => e
+      puts "Set CORS fail", e.code, e.message, e.request_id
+    end
+
+More about the rules, visit [OSS API](https://docs.aliyun.com/#/pub/oss/api-reference/cors&PutBucketcors) and [Struct::Cors](http://www.rubydoc.info/gems/aliyun-oss-sdk/0.1.1/Aliyun/Oss/Struct/Cors)
+
+
+### Get CORS Rules
+
+To get current cors rules, you can use Client#bucket_get_cors:
+
+    
+    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)
+	  cors = bucket.cors!
+	rescue Aliyun::Oss::RequestError => e
+      puts "Get CORS fail", e.code, e.message, e.request_id
+    end
+
+    
+### Disable CORS
+
+If you want to diable CORS, just like below:
+
+    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)
+    
+    # create a private bucket on oss-cn-beijing
+    begin
+      bucket = Aliyun::Oss::Struct::Bucket.new(client: client)
+	  bucket.disable_cors
+	rescue Aliyun::Oss::RequestError => e
+      puts "Disable CORS fail", e.code, e.message, e.request_id
+    end
+    
+Note: disable CORS will remove all existing CORS Rules.
+
+
+Now, Let's go to next section: [LifeCycle](./lifecycle.md)