aliyun-oss-sdk 0.0.3 → 0.1.0

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

@@ -0,0 +1,43 @@
+module Aliyun
+  module Oss
+    class Client
+      module BucketMultiparts
+        # Init a Multipart Upload Event
+        #
+        # @param (see #bucket_init_multipart)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Aliyun::Oss::Struct::Multipart]
+        #
+        # @see Client#bucket_init_multipart
+        def init(*args)
+          result = client.bucket_init_multipart(*args).parsed_response
+
+          multipart = Utils.dig_value(result, 'InitiateMultipartUploadResult')
+          Struct::Multipart.new((multipart || {}).merge(client: client))
+        end
+
+        # List exist Multipart Upload Events of bucket
+        #
+        # @param (see #bucket_list_multiparts)
+        #
+        # @option (see #bucket_list_multiparts)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Array<Aliyun::Oss::Struct::Multipart>]
+        #
+        # @see Client#bucket_list_multiparts
+        def list(*args)
+          result = client.bucket_list_multiparts(*args).parsed_response
+
+          multipart_keys = %w(ListMultipartUploadsResult Upload)
+          Utils.wrap(Utils.dig_value(result, *multipart_keys)).map do |multipart|
+            Struct::Multipart.new(multipart.merge(client: client))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+module Aliyun
+  module Oss
+    class Client
+      module BucketObjects
+        # List objects of bucket
+        #
+        # @param (see #bucket_list_objects)
+        #
+        # @option (see #bucket_list_objects)
+        #
+        # @raise [RequestError]
+        #
+        # @return [Array<Aliyun::Oss::Struct::Object>]
+        #
+        # @see Client#bucket_list_objects
+        def list(*args)
+          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
+        end
+
+        # create object of bucket
+        #
+        # @param (see #bucket_create_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_create_object
+        def create(*args)
+          !!client.bucket_create_object(*args)
+        end
+
+        # Delete object for bucket
+        #
+        # @param (see #bucket_delete_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_delete_object
+        def delete(*args)
+          !!client.bucket_delete_object(*args)
+        end
+
+        # Delete objects for bucket
+        #
+        # @param (see #bucket_delete_objects)
+        #
+        # @raise [RequestError]
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_delete_objects
+        def delete_multiple(*args)
+          !!client.bucket_delete_objects(*args)
+        end
+
+        # Copy from existing object
+        #
+        # @param (see #bucket_copy_object)
+        #
+        # @option (see #bucket_copy_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_copy_object
+        def copy(*args)
+          !!client.bucket_copy_object(*args)
+        end
+
+        # Get Object
+        #
+        # @param (see #bucket_get_object)
+        #
+        # @option (see #bucket_get_object)
+        #
+        # @raise [RequestError]
+        #
+        # @return [String]
+        #
+        # @see Client#bucekt_get_object
+        def get(*args)
+          client.bucket_get_object(*args).body
+        end
+
+        # Append data to a object, will create Appendable object
+        #
+        # @see https://docs.aliyun.com/#/pub/oss/api-reference/object&AppendObject Append Object
+        #
+        # @param (see #bucket_append_object)
+        #
+        # @raise (see #bucket_append_object)
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_append_object
+        def append(*args)
+          !!client.bucket_append_object(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Aliyun
+  module Oss
+    class Client
+      module Buckets
+        # List buckets
+        #
+        # @param (see #list_buckets)
+        # @option (see #list_buckets)
+        #
+        # @return [Array<Aliyun::Oss::Struct::Bucket>]
+        #
+        # @see Client#list_buckets
+        def list(options = {})
+          result = client.list_buckets(options).parsed_response
+
+          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
+          end
+        end
+
+        # Create bucket
+        #
+        # @param (see #bucket_create)
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_create
+        def create(*args)
+          !!client.bucket_create(*args)
+        end
+
+        # Delete bucket
+        #
+        # @param (see #bucket_delete)
+        #
+        # @return [true]
+        #
+        # @see Client#bucket_delete
+        def delete(*args)
+          !!client.bucket_delete(*args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Aliyun
+  module Oss
+    #
+    # Here is some services used to make object based API possible, they are all contains a reference to instance of client, which used to do the real job.
+    #
+    # buckets: used to do many buckets operations eg: #list, #create, #delete
+    #
+    #   client.buckets
+    #
+    # bucket_objects: used to do some operation on objects eg: #list, #create, :delete, #copy
+    #
+    #   client.bucket_objects
+    #
+    # bucket_multiparts: used to do some operation for multiparts eg: #init, #list
+    #
+    #   client.bucket_multiparts
+    #
+    #
+    class Client
+      def buckets
+        @services[:buckets] ||= Client::BucketsService.new(self)
+      end
+
+      def bucket_objects
+        @services[:bucket_objects] ||= Client::BucketObjectsService.new(self)
+      end
+
+      def bucket_multiparts
+        @services[:bucket_multiparts] ||= \
+          Client::BucketMultipartsService.new(self)
+      end
+
+      ClientService = ::Struct.new(:client)
+
+      require 'aliyun/oss/client/buckets'
+
+      class BucketsService < ClientService
+        include Client::Buckets
+      end
+
+      require 'aliyun/oss/client/bucket_objects'
+
+      class BucketObjectsService < ClientService
+        include Client::BucketObjects
+      end
+
+      require 'aliyun/oss/client/bucket_multiparts'
+
+      class BucketMultipartsService < ClientService
+        include Client::BucketMultiparts
+      end
+    end
+  end
+end

data/lib/aliyun/oss/error.rb

@@ -0,0 +1,43 @@
+module Aliyun
+  module Oss
+    class Error < StandardError; end
+
+    # [Aliyun::Oss::RequestError] when OSS give a Non 2xx response
+    class RequestError < Error
+      # Error Code defined by OSS
+      attr_reader :code
+
+      # Error Message defined by OSS
+      attr_reader :message
+
+      # It's the UUID to uniquely identifies this request;
+      # When you can't solve the problem, you can request help from the OSS development engineer with the RequestId.
+      attr_reader :request_id
+
+      # The Origin Httparty Response
+      attr_reader :origin_response
+
+      def initialize(response)
+        if (error_values = response.parsed_response['Error']).empty?
+          @code = response.code
+          @message = response.message
+        else
+          @code = error_values['Code']
+          @message = error_values['Message']
+        end
+        @request_id = response.headers['x-oss-request-id']
+        @origin_response = response
+        super("#{@request_id} - #{@code}: #{@message}")
+      end
+    end
+
+    class MultipartPartNumberEmpty < Error; end
+    class MultipartUploadIdEmpty < Error; end
+    class MultipartSourceBucketEmptyError < Error; end
+    class MultipartSourceKeyEmptyError < Error; end
+    class MultipartPartsEmptyError < Error; end
+
+    class InvalidCorsRuleError < Error; end
+    class InvalidLifeCycleRuleError < Error; end
+  end
+end

data/lib/aliyun/oss/http.rb

@@ -1,3 +1,6 @@
+require 'httparty'
+require 'aliyun/oss/error'
+
 module Aliyun
   module Oss
     class Http # nodoc
@@ -39,25 +42,58 @@ module Aliyun
       private
 
       def request(verb, resource, options = {})
-        headers = options.delete(:headers) || {}
-        headers = default_headers.merge!(headers)
+        query = options.fetch(:query, {})
+        headers = options.fetch(:headers, {})
+        body = options.delete(:body)
+
+        append_headers!(headers, verb, body, options)
+
+        path = api_endpoint(headers['Host']) + resource
+        options = { headers: headers, query: query, body: body }
 
-        if options[:body]
-          headers.merge!('Content-MD5' => Utils.md5_digest(options[:body])) unless headers.key?('Content-MD5')
-          headers.merge!('Content-Length' => Utils.content_size(options[:body]).to_s) unless headers.key?('Content-Length')
+        wrap(HTTParty.__send__(verb.downcase, path, options))
+      end
+
+      def wrap(response)
+        case response.code
+        when 200..299
+          response
+        else
+          fail RequestError, response
         end
+      end
 
-        headers.merge!('Host' => get_host(options))
+      def append_headers!(headers, verb, body, options)
+        append_default_headers!(headers)
+        append_body_headers!(headers, body)
+        append_host_headers!(headers, options[:bucket], options[:location])
+        append_authorization_headers!(headers, verb, options)
+      end
 
-        auth_key = get_auth_key(options
-          .merge(verb: verb, headers: headers, date: headers['Date']))
-        headers.merge!('Authorization' => auth_key)
+      def append_default_headers!(headers)
+        headers.merge!(default_headers)
+      end
 
-        path = get_uri(headers['Host'], resource)
-        options = Utils
-        .hash_slice(options.merge(headers: headers), :query, :headers, :body)
+      def append_body_headers!(headers, body)
+        return headers unless body
 
-        HTTParty.__send__(verb.downcase, path, options)
+        unless headers.key?('Content-MD5')
+          headers.merge!('Content-MD5' => Utils.md5_digest(body))
+        end
+
+        return if headers.key?('Content-Length')
+        headers.merge!('Content-Length' => Utils.content_size(body).to_s)
+      end
+
+      def append_host_headers!(headers, bucket, location)
+        headers.merge!('Host' => get_host(bucket, location))
+      end
+
+      def append_authorization_headers!(headers, verb, options)
+        auth_key = get_auth_key(
+          options.merge(verb: verb, headers: headers, date: headers['Date'])
+        )
+        headers.merge!('Authorization' => auth_key)
       end
 
       def get_auth_key(options)
@@ -66,28 +102,34 @@ module Aliyun
 
       def default_headers
         {
-          'User-Agent' => "aliyun-oss-sdk-ruby/#{Aliyun::Oss::VERSION} " \
-          "(#{RbConfig::CONFIG['host_os']} ruby-#{RbConfig::CONFIG['ruby_version']})",
+          'User-Agent' => user_agent,
           'Date' => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
         }
       end
 
-      def get_host(options)
-        if options[:location] && options[:bucket]
-          "#{options[:bucket]}.#{options[:location]}.aliyuncs.com"
-        elsif options[:bucket]
-          "#{options[:bucket]}.#{@host}"
+      def get_host(bucket, location)
+        if location && bucket
+          "#{bucket}.#{location}.aliyuncs.com"
+        elsif bucket
+          "#{bucket}.#{@host}"
         else
           @host
         end
       end
 
       def default_content_type
-        { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      end
+
+      def api_endpoint(host)
+        "http://#{host}"
       end
 
-      def get_uri(host, resource)
-        "http://#{host}#{resource}"
+      def user_agent
+        "aliyun-oss-sdk-ruby/#{Aliyun::Oss::VERSION} " \
+        "(#{RbConfig::CONFIG['host_os']} ruby-#{RbConfig::CONFIG['ruby_version']})"
       end
     end
   end

data/lib/aliyun/oss/struct.rb

@@ -0,0 +1,26 @@
+module Aliyun
+  module Oss
+    module Struct
+      class Base
+        def initialize(attributes = {})
+          attributes.each do |key, value|
+            m = "#{Utils.underscore(key)}=".to_sym
+            send(m, value) if self.respond_to?(m)
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'aliyun/oss/struct/bucket'
+require 'aliyun/oss/struct/object'
+require 'aliyun/oss/struct/multipart'
+
+require 'aliyun/oss/struct/cors'
+require 'aliyun/oss/struct/lifecycle'
+require 'aliyun/oss/struct/referer'
+require 'aliyun/oss/struct/website'
+require 'aliyun/oss/struct/logging'
+
+require 'aliyun/oss/struct/part'