aliyun-oss-sdk 0.0.3 → 0.1.0

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

@@ -0,0 +1,71 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Object < Base
+        # Key of object
+        attr_accessor :key
+
+        # last modified time of object
+        attr_accessor :last_modified
+
+        # etag of object
+        attr_accessor :etag
+
+        # type of object
+        attr_accessor :type
+
+        # size of object
+        attr_accessor :size
+
+        # storage class of object
+        attr_accessor :storage_class
+
+        # owner of object
+        attr_accessor :owner
+
+        # location of object
+        attr_accessor :location
+
+        # bucket of object placed
+        attr_accessor :bucket
+
+        # reference to client
+        attr_accessor :client
+
+        # Get ACL for object
+        #
+        # @raise [RequestError]
+        #
+        # @return [String]
+        def acl!
+          result = client.bucket_get_object_acl(key).parsed_response
+          acl_keys = %w(AccessControlPolicy AccessControlList Grant)
+          Utils.dig_value(result, *acl_keys).strip
+        end
+
+        # Set ACL for object
+        #
+        # @param acl [String] access value, supported value: private, public-read, public-read-write
+        #
+        # @raise [RequestError]
+        #
+        # @return [true]
+        def set_acl(acl)
+          !!client.bucket_set_object_acl(key, acl)
+        end
+
+        # Get meta information of object
+        #
+        # @param headers [Hash] headers
+        # @option (see #bucket_get_meta_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Hash]
+        def meta!(*args)
+          client.bucket_get_meta_object(*args.unshift(key)).headers
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Part < Base
+        # [Integer] :number the part number
+        attr_accessor :number
+
+        # [String] :etag the etag for the part
+        attr_accessor :etag
+
+        # Last Modified time
+        attr_accessor :last_modified
+
+        # Part size
+        attr_accessor :size
+
+        def last_modified=(last_modified)
+          @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?
+            {
+              'PartNumber' => number,
+              'ETag' => etag
+            }
+          else
+            {}
+          end
+        end
+
+        private
+
+        def valid?
+          number && etag
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Referer < Base
+        # specify allow empty referer access
+        attr_accessor :allow_empty
+
+        # specify white list for allows referers
+        attr_accessor :referers
+
+        def allow_empty=(allow_empty)
+          @allow_empty = allow_empty == 'true'
+        end
+
+        def referers=(referers)
+          @referers = Utils.wrap(referers).map(&:strip)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Website < Base
+        # A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
+        attr_accessor :suffix
+
+        # The object key name to use when a 4XX class error occurs
+        attr_accessor :error_key
+      end
+    end
+  end
+end

data/lib/aliyun/oss/utils.rb

@@ -43,7 +43,47 @@ module Aliyun
       end
 
       def self.to_xml(hash) # nodoc
-        %|<?xml version="1.0" encoding="UTF-8"?>#{Gyoku.xml(hash)}|
+        %(<?xml version="1.0" encoding="UTF-8"?>#{Gyoku.xml(hash)})
+      end
+
+      # Dig values in deep hash
+      #
+      # @example
+      #   dig_value({ 'a' => { 'b' => { 'c' => 3 } } }, 'a', 'b', 'c')  # => 3
+      #
+      def self.dig_value(hash, *keys)
+        new_hash = hash.dup
+
+        keys.each do |key|
+          if new_hash.is_a?(Hash) && new_hash.key?(key)
+            new_hash = new_hash[key]
+          else
+            return nil
+          end
+        end
+        new_hash
+      end
+
+      # @see {http://apidock.com/rails/String/underscore String#underscore}
+      def self.underscore(str)
+        word = str.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!('-', '_')
+        word.downcase!
+        word
+      end
+
+      # Copy from {https://github.com/rails/rails/blob/14254d82a90b8aa4bd81f7eeebe33885bf83c378/activesupport/lib/active_support/core_ext/array/wrap.rb#L36 ActiveSupport::Array#wrap}
+      def self.wrap(object)
+        if object.nil?
+          []
+        elsif object.respond_to?(:to_ary)
+          object.to_ary || [object]
+        else
+          [object]
+        end
       end
     end
   end

data/lib/aliyun/oss/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module Oss
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/lib/aliyun/oss/xml_generator.rb

@@ -0,0 +1,174 @@
+module Aliyun
+  module Oss
+    class XmlGenerator
+      # Generate xml from rules
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <LifecycleConfiguration>
+      #    <Rule>
+      #      <ID>RuleID</ID>
+      #      <Prefix>Prefix</Prefix>
+      #      <Status>Status</Status>
+      #      <Expiration>
+      #        <Days>Days</Days>
+      #      </Expiration>
+      #    </Rule>
+      #  </LifecycleConfiguration>
+      def self.generate_lifecycle_rules(rules)
+        Utils.to_xml(
+          'LifecycleConfiguration' => {
+            'Rule' => rules.map(&:to_hash)
+          })
+      end
+
+      # Generate xml for cors from rules
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <CORSConfiguration>
+      #      <CORSRule>
+      #        <AllowedOrigin>the origin you want allow CORS request from</AllowedOrigin>
+      #        <AllowedOrigin>...AllowedOrigin>
+      #        <AllowedMethod>HTTP method</AllowedMethod>
+      #        <AllowedMethod>...AllowedMethod>
+      #          <AllowedHeader> headers that allowed browser to send</AllowedHeader>
+      #            <AllowedHeader>...AllowedHeader>
+      #            <ExposeHeader> headers in response that can access from client app</ExposeHeader>
+      #            <ExposeHeader>...ExposeHeader>
+      #            <MaxAgeSeconds>time to cache pre-fight response</MaxAgeSeconds>
+      #      </CORSRule>
+      #      <CORSRule>
+      #      ...
+      #      </CORSRule>
+      #  ...
+      #  </CORSConfiguration >
+      #
+      def self.generate_cors_rules(rules)
+        Utils.to_xml(
+          'CORSConfiguration' => {
+            'CORSRule' => rules.map(&:to_hash)
+          })
+      end
+
+      # Generate xml for delete objects
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <Delete>
+      #    <Quiet>true</Quiet>
+      #    <Object>
+      #      <Key>key</Key>
+      #    </Object>
+      #  ...
+      #  </Delete>
+      #
+      def self.generate_delete_objects_xml(keys, quiet)
+        key_objects = keys.map { |key| { 'Key' => key } }
+        Utils.to_xml(
+          'Delete' => {
+            'Object' => key_objects,
+            'Quiet' => quiet
+          })
+      end
+
+      # Generate xml for complete multipart from parts
+      #
+      # @example
+      #  <CompleteMultipartUpload>
+      #   <Part>
+      #     <PartNumber>PartNumber</PartNumber>
+      #     <ETag>ETag</ETag>
+      #   </Part>
+      #   ...
+      #  </CompleteMultipartUpload>
+      #
+      def self.generate_complete_multipart_xml(parts)
+        Utils.to_xml(
+          'CompleteMultipartUpload' => {
+            'Part' => parts.map(&:to_hash)
+          })
+      end
+
+      # Generate xml for #bucket_create with location
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <CreateBucketConfiguration>
+      #   <LocationConstraint>BucketRegion</LocationConstraint>
+      #  </CreateBucketConfiguration>
+      #
+      def self.generate_create_bucket_xml(location)
+        configuration = {
+          'CreateBucketConfiguration' => {
+            'LocationConstraint' => location
+          }
+        }
+        Utils.to_xml(configuration)
+      end
+
+      # Generate xml for enable logging
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <BucketLoggingStatus>
+      #    <LoggingEnabled>
+      #     <TargetBucket>TargetBucket</TargetBucket>
+      #     <TargetPrefix>TargetPrefix</TargetPrefix>
+      #    </LoggingEnabled>
+      #  </BucketLoggingStatus>
+      #
+      def self.generate_enable_logging_xml(target_bucket, target_prefix)
+        logging = { 'TargetBucket' => target_bucket }
+        logging.merge!('TargetPrefix' => target_prefix) if target_prefix
+        Utils.to_xml(
+          'BucketLoggingStatus' => {
+            'LoggingEnabled' => logging
+          })
+      end
+
+      # Generate xml for enable website
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <WebsiteConfiguration>
+      #    <IndexDocument>
+      #     <Suffix>index.html</Suffix>
+      #    </IndexDocument>
+      #    <ErrorDocument>
+      #     <Key>errorDocument.html</Key>
+      #    </ErrorDocument>
+      #  </WebsiteConfiguration>
+      #
+      def self.generate_enable_website_xml(suffix, key)
+        website_configuration = { 'IndexDocument' => { 'Suffix' => suffix } }
+        website_configuration.merge!('ErrorDocument' => { 'Key' => key }) if key
+        Utils.to_xml('WebsiteConfiguration' => website_configuration)
+      end
+
+      # Generate xml for set referer
+      #
+      # @example
+      #  <?xml version="1.0" encoding="UTF-8"?>
+      #  <RefererConfiguration>
+      #    <AllowEmptyReferer>true</AllowEmptyReferer >
+      #    <RefererList>
+      #     <Referer> http://www.aliyun.com</Referer>
+      #     <Referer> https://www.aliyun.com</Referer>
+      #     <Referer> http://www.*.com</Referer>
+      #     <Referer> https://www.?.aliyuncs.com</Referer>
+      #    </ RefererList>
+      #  </RefererConfiguration>
+      #
+      def self.generate_set_referer_xml(referers, allowed_empty)
+        Utils.to_xml(
+          'RefererConfiguration' => {
+            'AllowEmptyReferer' => allowed_empty,
+            'RefererList' => {
+              'Referer' => referers
+            }
+          })
+      end
+    end
+  end
+end

data/todo.md

@@ -0,0 +1,5 @@
+## TODO
+
++ Command Line Tool
++ Custom Domain Support
++ Get Download URL

data/wiki/bucket.md

@@ -1,10 +1,10 @@
 ## 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.
+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 (-)
++ Only contains lowercase letters, Numbers, dash (-)
 + Must begin with lowercase letters or Numbers
 + Length must be between 3-63 bytes
 
@@ -21,7 +21,8 @@ Bucket is namespace in OSS, as well as management entity for high functions such
     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]()
+You can specify bucket name, location(default 'oss-cn-hangzhou') and acl(default: 'private') when create new bucket.
+
 
 ### List all buckets
 
@@ -35,40 +36,38 @@ To get all buckets use Client#list_buckets:
     client = Aliyun::Oss::Client.new(access_key, secret_key, host: host)
     
     res = client.list_buckets
-    puts res.parsed_response
+    puts res.success?, res.parsed_response
     
 
-### Set ACL for Bucket
+### Set ACL
 
-With Client#bucket_set_acl you can modify the ACL for bucket:
+With Client#bucket_set_acl you can modify the ACL:
 
     require 'aliyun/oss'
     
     access_key, secret_key = "your id", "your secret"
-    host = "oss-cn-hangzhou.aliyuncs.com"
-    bucket = "bucket-name"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "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
+    puts res.success?, 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
+### 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 = "oss-cn-hangzhou.aliyuncs.com"
-    bucket = "bucket-name"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
     client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
     
     res = client.bucket_get_acl
-    puts res.parsed_response
+    puts res.success?, res.parsed_response
     
     
 ### Get Bucket Location
@@ -78,18 +77,18 @@ 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"
+    host, bucket = "oss-cn-hangzhou.aliyuncs.com", "bucket-name"
     client = Aliyun::Oss::Client.new(access_key, secret_key, host: host, bucket: bucket)
     
     res = client.bucket_get_location
-    puts res.parsed_response
+    puts res.success?, res.parsed_response
+
+To get more bucket information, visit Client#bucket_get_xxx methods [here](http://www.rubydoc.info/gems/aliyun-oss-sdk/Aliyun/Oss/Client).
 
-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
+If you do need one bucket, delete it with Client#bucket_delete:
     
     require 'aliyun/oss'
     
@@ -100,7 +99,8 @@ If you donot need the bucket, delete it with Client#bucket_delete
     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.
+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)