aliyun-oss-sdk 0.1.1 → 0.1.2

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

@@ -0,0 +1,204 @@
+module Aliyun
+  module Oss
+    module Api
+      module BucketObjects
+        # List objects in the bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucket Get Bucket (List Object)
+        #
+        # @param options [Hash] options
+        # @option options [String] :prefix Filter objects with prefix
+        # @option options [String] :marker Result should after marker in alphabetical order
+        # @option options [Integer] :max-keys (100) Limit number of objects, the maxinum should <= 1000
+        # @option options [String] :delimiter Used to group objects with delimiter
+        # @option options [String] :encoding-type Encoding type used for unsupported character
+        #
+        # @return [Response]
+        def bucket_list_objects(options = {})
+          Utils.stringify_keys!(options)
+          accepted_keys = ['prefix', 'marker', 'max-keys', 'delimiter', 'encoding-type']
+          query = Utils.hash_slice(options, *accepted_keys)
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Upload file to bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&PutObject Put Object
+        #
+        # @param key [String] Specify object name
+        # @param file [File, Bin data] Specify need upload resource
+        # @param [Hash] headers Specify other options
+        # @option headers [String] :Content-Type ('application/x-www-form-urlencoded') Specify Content-Type for the object
+        # @option headers [String] :Cache-Control Specify the caching behavior when download from browser, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+        # @option headers [String] :Content-Disposition Specify the name when download, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+        # @option headers [String] :Content-Encoding Specify the content encoding when download, ref {https://www.ietf.org/rfc/rfc2616.txt?spm=5176.730001.3.128.Y5W4bu&file=rfc2616.txt RFC2616}
+        # @option headers [String] :Content-MD5 RFC 1864 according to the agreement of the message Content (not including head) are calculated MD5 value 128 bits number, the number is base64 encoding for the Content of a message - MD5 value.The legality of the examination of the request headers can be used for information (a message content is consistent with send).Although the request header is optional, OSS recommend that users use the end-to-end check request header.
+        # @option headers [Integer] :Expires Specify the expiration time (milliseconds)
+        # @option headers [String] :x-oss-server-side-encryption Specify the oss server-side encryption algorithm when the object was created. supported value: 'AES256'
+        # @option headers [String] :x-oss-object-acl Specify the oss access when the object was created. supported value: public-read-write | public-read | private
+        # @option headers [Hash] other options will insert into headers when upload, such as user meta headers, eg: headers with prefix: x-oss-meta-
+        #
+        # @return [Response]
+        def bucket_create_object(key, file, headers = {})
+          Utils.stringify_keys!(headers)
+          http.put("/#{key}", headers: headers, body: Utils.to_data(file), bucket: bucket, key: key)
+        end
+
+        # Copy an existing object in OSS into another object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&CopyObject Copy Object
+        #
+        # @param key [String] the object name
+        # @param source_bucket [String] the source bucket name
+        # @param source_key [String] the source object name
+        # @param [Hash] headers
+        # @option options [String] :source_bucket the source bucket name
+        # @option options [String] :source_key the source object name
+        # @option options [String] :x-oss-copy-source-if-match If the specified ETag match the source object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+        # @option options [String] :x-oss-copy-source-if-none-match If the specified ETag not match the source object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+        # @option options [String] :x-oss-copy-source-if-unmodified-since If the specified time is equal to or later than the source object last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+        # @option options [String] :x-oss-copy-source-if-modified-since If the specified time is earlier than the source object last modification time, normal transfer ans return 200; Otherwise returns 304(not modified)
+        # @option options [String] :x-oss-metadata-directive ('COPY') supported value: COPY, REPLACE;
+        # @option options [String] :x-oss-server-side-encryption supported value: AES256
+        # @option options [String] :x-oss-object-acl supported value: public-read, private, public-read-write
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_copy_object(key, source_bucket, source_key, headers = {})
+          fail('source_bucket must be not empty!') if source_bucket.nil? || source_bucket.empty?
+          fail('source_key must be not empty!') if source_key.nil? || source_key.empty?
+
+          Utils.stringify_keys!(headers)
+          headers.merge!('x-oss-copy-source' => "/#{source_bucket}/#{source_key}")
+
+          http.put("/#{key}", headers: headers, bucket: bucket, key: key)
+        end
+
+        # Append data to a object, will create Appendable object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&AppendObject Append Object
+        #
+        # @param key [String] object name
+        # @param file [file, bin data] the data to append
+        # @param position [Integer] append to position of object
+        # @option headers (see #bucket_create_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_append_object(key, file, position = 0, headers = {})
+          Utils.stringify_keys!(headers)
+
+          query = { 'append' => true, 'position' => position }
+          body = Utils.to_data(file)
+
+          http.post("/#{key}", query: query, headers: headers, body: body, bucket: bucket, key: key)
+        end
+
+        # Get the object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&GetObject Get Object
+        #
+        # @param key [String] the object name
+        # @param query [Hash] query params
+        # @option query [String] :response-content-type Specify the header Content-Type in response
+        # @option query [String] :response-content-language Specify the header Content-Language in response
+        # @option query [String] :response-expires Specify the header Expires in response
+        # @option query [String] :response-cache-control Specify the header Cache-Control in response
+        # @option query [String] :response-content-disposition Specify the header Content-Disposition in response
+        # @option query [String] :response-content-encoding Specify the header Content-encoding in response
+        # @param headers [Hash] headers
+        # @option headers [String] :Range Specify the range of the file. Such as "bytes=0-9" means the 10 characters from 0 to 9.
+        # @option headers [String] :If-Modified-Since If the specified time is earlier than the file last modification time, return 200 OK; Otherwise returns 304(not modified)
+        # @option headers [String] :If-Unmodified-Since If the specified time is equal to or later than the file last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+        # @option headers [String] :If-Match If the specified ETag match the object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+        # @option headers [String] :If-None-Match If the specified ETag not match the object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+        #
+        # @return [Response]
+        def bucket_get_object(key, query = {}, headers = {})
+          Utils.stringify_keys!(query)
+          Utils.stringify_keys!(headers)
+
+          http.get("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+        end
+
+        # Delete object from bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&DeleteObject Delete Object
+        #
+        # @param key [String] the object name
+        #
+        # @return [Response]
+        def bucket_delete_object(key)
+          http.delete("/#{key}", bucket: bucket, key: key)
+        end
+
+        # Delete multiple objects, at max 1000 at once
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&DeleteMultipleObjects Delete Multiple Objects
+        #
+        # @param keys [Array<String>] the object names
+        # @param quiet [Boolean] Specify response mode: false(Quiet) return results for error objects, true(Verbose) return results of every objects
+        #
+        # @return [Response]
+        def bucket_delete_objects(keys, quiet = false)
+          query = { 'delete' => true }
+
+          body = XmlGenerator.generate_delete_objects_xml(keys, quiet)
+
+          http.post('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Get meta information of object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&HeadObject Head Object
+        #
+        # @param key [String] object name
+        # @param headers [Hash] headers
+        # @option headers [String] :If-Modified-Since If the specified time is earlier than the file last modification time, return 200 OK; Otherwise returns 304(not modified)
+        # @option headers [String] :If-Unmodified-Since If the specified time is equal to or later than the file last modification time, normal transfer ans return 200; Otherwise returns 412(precondition)
+        # @option headers [String] :If-Match If the specified ETag match the object ETag, normal transfer and return 200; Otherwise return 412(precondition)
+        # @option headers [String] :If-None-Match If the specified ETag not match the object ETag, normal transfer and return 200; Otherwise return 304(Not Modified)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_get_meta_object(key, headers = {})
+          Utils.stringify_keys!(headers)
+          http.head("/#{key}", headers: headers, bucket: bucket, key: key)
+        end
+
+        # Get access of object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&GetObjectACL Get Object ACL
+        #
+        # @param key [String] object name
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_get_object_acl(key)
+          query = { 'acl' => true }
+          http.get("/#{key}", query: query, bucket: bucket, key: key)
+        end
+
+        # Set access of object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&PutObjectACL Put Object ACL
+        #
+        # @param key [String] object name
+        # @param acl [String] access value, supported value: private, public-read, public-read-write
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_set_object_acl(key, acl)
+          query = { 'acl' => true }
+          headers = { 'x-oss-object-acl' => acl }
+          http.put("/#{key}", query: query, headers: headers, bucket: bucket, key: key)
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/oss/api/bucket_property.rb

@@ -0,0 +1,246 @@
+module Aliyun
+  module Oss
+    module Api
+      module BucketProperty
+        # Used to modify the bucket access.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketACL Put Bucket Acl
+        #
+        # @param acl [String] supported value: public-read-write | public-read | private
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_set_acl(acl)
+          query = { 'acl' => true }
+          headers = { 'x-oss-acl' => acl }
+          http.put('/', query: query, headers: headers, bucket: bucket)
+        end
+
+        # Used to enable access logging.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketLogging Put Bucket Logging
+        #
+        # @param target_bucket [String] specifies the bucket where you want Aliyun OSS to store server access logs.
+        # @param target_prefix [String] this element lets you specify a prefix for the objects that the log files will be stored.
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_enable_logging(target_bucket, target_prefix = nil)
+          query = { 'logging' => true }
+
+          body = XmlGenerator.generate_enable_logging_xml(target_bucket,
+                                                          target_prefix)
+
+          http.put('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Used to disable access logging.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketLogging Delete Bucket Logging
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_disable_logging
+          query = { 'logging' => false }
+          http.delete('/', query: query, bucket: bucket)
+        end
+
+        # Used to enable static website hosted mode.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketWebsite Put Bucket Website
+        #
+        # @param suffix [String] 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.
+        # @param key [String] The object key name to use when a 4XX class error occurs
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_enable_website(suffix, key = nil)
+          query = { 'website' => true }
+
+          body = XmlGenerator.generate_enable_website_xml(suffix, key)
+
+          http.put('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Used to disable website hostted mode.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketWebsite Delete Bucket Website
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_disable_website
+          query = { 'website' => false }
+          http.delete('/', query: query, bucket: bucket)
+        end
+
+        # Used to set referer for bucket.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketReferer Put Bucket Referer
+        #
+        # @param referers [Array<String>] white list for allowed referer.
+        # @param allowed_empty [Boolean] whether allow empty refer.
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_set_referer(referers = [], allowed_empty = false)
+          query = { 'referer' => true }
+
+          body = XmlGenerator.generate_set_referer_xml(referers, allowed_empty)
+
+          http.put('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Used to enable and set lifecycle for bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucketLifecycle Put Bucket Lifecycle
+        #
+        # @param rules [Array<Aliyun::Oss::Struct::LifeCycle>] rules for lifecycle
+        #
+        # @raise [RequestError]
+        # @raise [Aliyun::Oss::InvalidLifeCycleRuleError]
+        #   if rule invalid
+        #
+        # @return [Response]
+        def bucket_enable_lifecycle(rules = [])
+          query = { 'lifecycle' => true }
+
+          rules = Utils.wrap(rules)
+
+          rules.each do |rule|
+            unless rule.valid?
+              fail Aliyun::Oss::InvalidLifeCycleRuleError, rule.inspect
+            end
+          end
+
+          body = XmlGenerator.generate_lifecycle_rules(rules)
+
+          http.put('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Used to disable lifecycle for bucket.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucketLifecycle Delete Bucket Lifecycle
+        def bucket_disable_lifecycle
+          query = { 'lifecycle' => false }
+          http.delete('/', query: query, bucket: bucket)
+        end
+
+        # Used to enable CORS and set rules for bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&PutBucketcors Put Bucket cors
+        #
+        # @param rules [Array<Aliyun::Oss::Struct::Cors>] array of rule
+        #
+        # @raise [RequestError]
+        # @raise [InvalidCorsRule]
+        #   if rule invalid
+        #
+        # @return [Response]
+        def bucket_enable_cors(rules = [])
+          query = { 'cors' => true }
+
+          rules = Utils.wrap(rules)
+
+          rules.each do |rule|
+            unless rule.valid?
+              fail Aliyun::Oss::InvalidCorsRuleError, rule.inspect
+            end
+          end
+
+          body = XmlGenerator.generate_cors_rules(rules)
+
+          http.put('/', query: query, body: body, bucket: bucket)
+        end
+
+        # Used to disable cors and clear rules for bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&DeleteBucketcors Delete Bucket cors
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_disable_cors
+          query = { 'cors' => false }
+          http.delete('/', query: query, bucket: bucket)
+        end
+
+        # Get ACL for bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketAcl Get Bucket ACL
+        #
+        # @return [Response]
+        def bucket_get_acl
+          query = { 'acl' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the location information of the Bucket's data center
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLocation Get Bucket Location
+        #
+        # @return [Response]
+        def bucket_get_location
+          query = { 'location' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the log configuration of Bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLogging Get Bucket Logging
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_get_logging
+          query = { 'logging' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the bucket state of static website hosting.
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketWebsite Get Bucket Website
+        #
+        # @return [Response]
+        def bucket_get_website
+          query = { 'website' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the referer configuration of bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketReferer Get Bucket Referer
+        #
+        # @return [Response]
+        def bucket_get_referer
+          query = { 'referer' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the lifecycle configuration of bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&GetBucketLifecycle Get Bucket Lifecycle
+        #
+        # @return [Response]
+        def bucket_get_lifecycle
+          query = { 'lifecycle' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+
+        # Get the CORS rules of bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&GetBucketcors Get Bucket cors
+        #
+        # @return [Response]
+        def bucket_get_cors
+          query = { 'cors' => true }
+          http.get('/', query: query, bucket: bucket)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module Aliyun
+  module Oss
+    module Api
+      module Buckets
+        # List buckets
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/service&GetService GetService (ListBucket
+        #
+        # @param options [Hash] options
+        # @option options [String] :prefix Filter buckets with prefix
+        # @option options [String] :marker Bucket name should after marker in alphabetical order
+        # @option options [Integer] :max-keys (100) Limit number of buckets, the maxinum should <= 1000
+        #
+        # @return [Response]
+        def list_buckets(options = {})
+          Utils.stringify_keys!(options)
+          query = Utils.hash_slice(options, 'prefix', 'marker', 'max-keys')
+          http.get('/', query: query)
+        end
+
+        # Create bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&PutBucket Put Bucket
+        #
+        # @example
+        #  oss.client.bucket_create('oss-sdk-dev-hangzhou-xxx')
+        #
+        # @param name [String] Specify bucket name
+        # @param location [String] Specify the bucket's data center location, can be one of below:
+        #   oss-cn-hangzhou,oss-cn-qingdao,oss-cn-beijing,oss-cn-hongkong,
+        #   oss-cn-shenzhen,oss-cn-shanghai,oss-us-west-1 ,oss-ap-southeast-1
+        # @param acl [String] Specify the bucket's access. (see #bucket_set_acl)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_create(name, location = 'oss-cn-hangzhou', acl = 'private')
+          query = { 'acl' => true }
+          headers = { 'x-oss-acl' => acl }
+
+          body = XmlGenerator.generate_create_bucket_xml(location)
+
+          http.put('/', query: query, headers: headers, body: body, bucket: name, location: location)
+        end
+
+        # Delete bucket
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/bucket&DeleteBucket Delete Bucket
+        #
+        # @param name [String] bucket name want to delete
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_delete(name)
+          http.delete('/', bucket: name)
+        end
+
+        # OPTIONS Object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/cors&OptionObject OPTIONS Object
+        #
+        # @param object_key [String] the object name want to visit.
+        # @param origin [String] the requested source domain, denoting cross-domain request.
+        # @param request_method [String] the actual request method will be used.
+        # @param request_headers [Array<String>] the actual used headers except simple headers will be used.
+        #
+        # @raise [RequestError]
+        #
+        # @return [Response]
+        def bucket_preflight(object_key, origin, request_method, request_headers = [])
+          path = object_key ? "/#{object_key}" : '/'
+
+          headers = {
+            'Origin' => origin,
+            'Access-Control-Request-Method' => request_method
+          }
+
+          unless request_headers.empty?
+            value = request_headers.join(',')
+            headers.merge!('Access-Control-Request-Headers' => value)
+          end
+
+          http.options(path, headers: headers, bucket: bucket, key: object_key)
+        end
+      end
+    end
+  end
+end