oss-ruby 1.0.0.beta

data/lib/oss/client.rb

@@ -0,0 +1,97 @@
+require 'base64'
+require 'time'
+
+module OSS
+  class Client
+    OSS_HEADER_PREFIX = 'x-oss-'
+    attr_reader :config, :options
+
+    def initialize(config, options = {})
+      @config = config
+      @options = options
+    end
+
+    def run(verb, url, params = {}, headers = {})
+      headers['Date'] = Time.now.httpdate
+      if !headers['Content-Type'] && (verb == :put || verb == :post)
+        headers['Content-Type'] = "application/x-www-form-urlencoded"
+      end
+      headers['Authorization'] = authorization_string(verb, headers)
+      response = connection.send verb do |conn|
+        conn.url url
+        conn.headers = headers
+        if verb == :get && params
+          conn.params = params
+        elsif (verb == :put || verb == :post) && params
+          conn.body = params
+        end
+      end
+      OSS::Response.new(response)
+    rescue Faraday::ClientError => e
+      raise OSS::HTTPClientError.new(e)
+    end
+
+    private
+
+    # "Authorization: OSS " + Access Key Id + ":" + Signature
+    def authorization_string(verb, headers)
+      data = [
+        verb.to_s.upcase,
+        headers['Content-MD5'],
+        headers['Content-Type'],
+        headers['Date']
+      ]
+
+      # Calculate OSS Headers
+      if headers.keys.any? { |key| key.to_s.downcase.start_with?(OSS_HEADER_PREFIX) }
+        oss_headers = headers
+          .select { |k, _| k.to_s.downcase.start_with?(OSS_HEADER_PREFIX) }
+          .map { |k, v| k.to_s.downcase.strip + ':' + v.strip }
+          .sort
+          .join("\n")
+        data.push oss_headers
+      end
+
+      # Calculate Canonicalized Resource
+      canonicalized_resource = options[:resource] ? options[:resource] : '/'
+      if options[:sub_resource]
+        unless options[:sub_resource].is_a?(Array)
+          options[:sub_resource] = [options[:sub_resource]]
+        end
+        query = options[:sub_resource].map(&:to_s).sort.join("&")
+        canonicalized_resource += "?#{query}"
+      end
+      data.push canonicalized_resource
+
+      "OSS " + config.access_key_id + ":" + sign(data.join("\n"))
+    end
+
+    # Signature = base64(hmac-sha1(AccessKeySecret,
+    #             VERB + "\n"
+    #             + CONTENT-MD5 + "\n"
+    #             + CONTENT-TYPE + "\n"
+    #             + DATE + "\n"
+    #             + CanonicalizedOSSHeaders
+    #             + CanonicalizedResource))
+    def sign(data)
+      key = config.access_key_secret
+      digest = OpenSSL::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, key, data)
+      Base64.encode64(hmac).strip
+    end
+
+    def connection
+      endpoint =
+        if options[:subdomain]
+          "#{options[:subdomain]}.#{config.endpoint}"
+        else
+          config.endpoint
+        end
+      @connection = Faraday.new(url: 'http://' + endpoint) do |conn|
+        conn.request  :url_encoded
+        conn.response :logger
+        conn.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/oss/config.rb

@@ -0,0 +1,12 @@
+module OSS
+  class Config
+    OPTIONS = [:endpoint, :access_key_id, :access_key_secret]
+    attr_accessor *OPTIONS
+
+    def initialize(options={})
+      options.each do |key, val|
+        self.send("#{key}=", val) if self.respond_to?("#{key}=")
+      end
+    end
+  end
+end

data/lib/oss/error.rb

@@ -0,0 +1,23 @@
+module OSS
+  class Error < StandardError
+    def inspect
+      %(#<#{self.class} message="#{self.message}">)
+    end
+  end
+
+  # Wrap Faraday client error
+  class HTTPClientError < Error
+    def initialize(exception)
+      @exception = exception
+      super(exception.message)
+    end
+
+    def backtrace
+      if @exception
+        @exception.backtrace
+      else
+        super
+      end
+    end
+  end
+end

data/lib/oss/object.rb

@@ -0,0 +1,141 @@
+require 'mime/types'
+
+module OSS
+  class Object < Service
+    def put_object(bucket, object, body, headers = {})
+      headers['Content-Type'] ||= 'binary/octet-stream'
+      headers['Content-Length'] = body.length.to_s
+      options = setup_options(bucket, object)
+      client(options).run :put, object, body, headers
+    end
+
+    def put_object_from_file(bucket, object, file_name, headers = {})
+      body = File.read(file_name)
+      if mime_type = MIME::Types.type_for(file_name).first
+        headers['Content-Type'] = mime_type.content_type
+      end
+      put_object(bucket, object, body, headers)
+    end
+
+    def copy_object(source_bucket, source_object, target_bucket, target_object, headers = {})
+      headers['x-oss-copy-source'] = "/#{source_bucket}/#{source_object}"
+      options = setup_options(target_bucket, target_object)
+      client(options).run :put, target_object, nil, headers
+    end
+
+    def get_object(bucket, object, headers = {})
+      options = setup_options(bucket, object)
+      client(options).run :get, object, nil, headers
+    end
+
+    def append_object(bucket, object, body, position = 0, headers = {})
+      headers['Content-Type'] ||= 'binary/octet-stream'
+      headers['Content-Length'] = body.length.to_s
+      options = setup_options(bucket, object, ['append', "position=#{position}"])
+      client(options).run :post, "#{object}?append&position=#{position}", body, headers
+    end
+
+    def delete_object(bucket, object)
+      options = setup_options(bucket, object)
+      client(options).run :delete, object
+    end
+
+    def delete_multiple_objects(bucket, objects, quiet = false)
+      body = '<?xml version="1.0" encoding="UTF-8"?><Delete>' \
+             "<Quiet>#{quiet}</Quiet>"
+      objects.each do |object|
+        body += "<Object><Key>#{object}</Key></Object>"
+      end
+      body += '</Delete>'
+
+      headers = {
+        'Content-Length' => body.length.to_s,
+        'Content-MD5' => OSS::Utils.content_md5_header(body),
+        'Content-Type' => 'application/xml'
+      }
+
+      options = setup_options(bucket, nil, 'delete')
+      client(options).run :post, '?delete', body, headers
+    end
+
+    def head_object(bucket, object, headers = {})
+      options = setup_options(bucket, object)
+      client(options).run :head, object, nil, headers
+    end
+
+    # permission: public-read-write，public-read, private
+    def put_object_acl(bucket, object, permission)
+      headers = {
+        'x-oss-object-acl' => permission
+      }
+      options = setup_options(bucket, object, 'acl')
+      client(options).run :put, "#{object}?acl", nil, headers
+    end
+
+    def get_object_acl(bucket, object)
+      options = setup_options(bucket, object, 'acl')
+      client(options).run :get, object, 'acl' => nil
+    end
+
+    def init_multi_upload(bucket, object, headers = {})
+      options = setup_options(bucket, object, 'uploads')
+      client(options).run :post, "#{object}?uploads", nil, headers
+    end
+
+    def upload_object_part(bucket, object, body, upload_id, part = 1)
+      headers = {
+        'Content-Length' => body.length.to_s,
+        'Content-MD5' => OSS::Utils.content_md5_header(body),
+        'Content-Type' => 'binary/octet-stream'
+      }
+      options = setup_options(bucket, object, ["partNumber=#{part}", "uploadId=#{upload_id}"])
+      client(options).run :put, "#{object}?partNumber=#{part}&uploadId=#{upload_id}", body, headers
+    end
+
+    def upload_object_part_copy(source_bucket, source_object, target_bucket, target_object, upload_id, part = 1, headers = {})
+      headers['x-oss-copy-source'] = "/#{source_bucket}/#{source_object}"
+      options = setup_options(target_bucket, target_object, ["partNumber=#{part}", "uploadId=#{upload_id}"])
+      client(options).run :put, "#{target_object}?partNumber=#{part}&uploadId=#{upload_id}", nil, headers
+    end
+
+    def complete_multi_upload(bucket, object, upload_id, parts = [])
+      body = '<?xml version="1.0" encoding="UTF-8"?><CompleteMultipartUpload>'
+      parts.each do |part|
+        body += "<Part><PartNumber>#{part[:part_number]}</PartNumber><ETag>#{part[:etag]}</ETag></Part>"
+      end
+      body += '</CompleteMultipartUpload>'
+
+      headers = {
+        'Content-Type' => 'application/xml'
+      }
+
+      options = setup_options(bucket, object, "uploadId=#{upload_id}")
+      client(options).run :post, "#{object}?uploadId=#{upload_id}", body, headers
+    end
+
+    def abort_multi_upload(bucket, object, upload_id)
+      options = setup_options(bucket, object, "uploadId=#{upload_id}")
+      client(options).run :delete, "#{object}?uploadId=#{upload_id}"
+    end
+
+    def list_multi_upload(bucket, headers = {})
+      options = setup_options(bucket, nil, 'uploads')
+      client(options).run :get, '/', { 'uploads' => nil }, headers
+    end
+
+    def list_object_parts(bucket, object, upload_id, headers = {})
+      options = setup_options(bucket, object, "uploadId=#{upload_id}")
+      client(options).run :get, object, { 'uploadId' => upload_id }, headers
+    end
+
+    private
+
+    def setup_options(bucket, object = nil, sub_resource = nil)
+      {
+        subdomain: bucket,
+        resource: "/#{bucket}/#{object}",
+        sub_resource: sub_resource
+      }
+    end
+  end
+end

data/lib/oss/response.rb

@@ -0,0 +1,37 @@
+module OSS
+  class APIError
+    attr_reader :code, :message, :request_id, :host_id
+
+    def inspect
+      %(#<#{self.class} message="#{self.message}">)
+    end
+
+    def initialize(doc)
+      @code       = doc.xpath('//Code').text
+      @message    = doc.xpath('//Message').text
+      @request_id = doc.xpath('//RequestId').text
+      @host_id    = doc.xpath('//HostId').text
+    end
+  end
+
+  class Response
+    extend Forwardable
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def doc
+      @doc ||= Nokogiri::XML(@response.body)
+    end
+
+    def error
+      return nil if status.to_s.start_with?('2')
+      @error ||= OSS::APIError.new(doc)
+    end
+
+    def_delegators :@response, :body, :headers, :status
+    def_delegators :doc, :xpath
+  end
+end

data/lib/oss/service.rb

@@ -0,0 +1,11 @@
+module OSS
+  class Service
+    def initialize(config)
+      @config = config
+    end
+
+    def client(options = {})
+      OSS::Client.new(@config, options)
+    end
+  end
+end

data/lib/oss/utils.rb

@@ -0,0 +1,14 @@
+module OSS
+  module Utils
+    # turn symbol keys to string keys, shallow mode
+    def indifferent_hash(hash)
+      Hash[hash.map {|k, v| Symbol === k ? [k.to_s, v] : [k, v] }]
+    end
+
+    def content_md5_header(content)
+      Digest::MD5.base64digest(content)
+    end
+
+    extend self
+  end
+end

data/lib/oss/version.rb

@@ -0,0 +1,3 @@
+module OSS
+  VERSION = '1.0.0.beta'
+end

data/oss-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oss-ruby"
+  spec.version       = OSS::VERSION
+  spec.authors       = ["Xiaoguang Chen"]
+  spec.email         = ["xg.chen87@gmail.com"]
+  spec.summary       = "Ruby SDK for Aliyun OSS"
+  spec.description   = %q{Ruby SDK for Aliyun OSS.}
+  spec.homepage      = "https://github.com/serco-chen/oss-ruby"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0") - %w[.gitignore]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'nokogiri', '~> 1.6.6'
+  spec.add_dependency 'mime-types', '~> 2.6'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/complete_multi_upload.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompleteMultipartUploadResult>
+  <Location>http://oss-ruby-sdk-test-bucket.oss-cn-hangzhou.aliyuncs.com/oss-ruby-sdk-test-object</Location>
+  <Bucket>oss-ruby-sdk-test-bucket</Bucket>
+  <Key>oss-ruby-sdk-test-object</Key>
+  <ETag>B864DB6A936D376F9F8D3ED3BBE540DD-3</ETag>
+</CompleteMultipartUploadResult>

data/spec/fixtures/get_bucket.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ListBucketResult>
+  <Name>oss-ruby-sdk-test-bucket</Name>
+  <Prefix></Prefix>
+  <Marker></Marker>
+  <MaxKeys>100</MaxKeys>
+  <Delimiter></Delimiter>
+  <IsTruncated>false</IsTruncated>
+  <Contents>
+    <Key>aaa.data</Key>
+    <LastModified>2015-11-12T09:10:02.000Z</LastModified>
+    <ETag>"4E672110E546ED7595087D10F8397678-2"</ETag>
+    <Type>Multipart</Type>
+    <Size>3384620</Size>
+    <StorageClass>Standard</StorageClass>
+    <Owner>
+      <ID>1306909297023357</ID>
+      <DisplayName>1306909297023357</DisplayName>
+    </Owner>
+  </Contents>
+  <Contents>
+    <Key>abc.pdf</Key>
+    <LastModified>2015-11-12T07:28:23.000Z</LastModified>
+    <ETag>"172F5D31191B965FE8CCB5A0F5BECD9A"</ETag>
+    <Type>Normal</Type>
+    <Size>1692310</Size>
+    <StorageClass>Standard</StorageClass>
+    <Owner>
+      <ID>1306909297023357</ID>
+      <DisplayName>1306909297023357</DisplayName>
+    </Owner>
+  </Contents>
+</ListBucketResult>

data/spec/fixtures/get_bucket_acl.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" ?>
+<AccessControlPolicy>
+    <Owner>
+        <ID>00220120222</ID>
+        <DisplayName>user_example</DisplayName>
+    </Owner>
+    <AccessControlList>
+        <Grant>private</Grant>
+    </AccessControlList>
+</AccessControlPolicy>

data/spec/fixtures/get_object_acl.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" ?>
+<AccessControlPolicy>
+    <Owner>
+        <ID>00220120222</ID>
+        <DisplayName>00220120222</DisplayName>
+    </Owner>
+    <AccessControlList>
+        <Grant>private</Grant>
+    </AccessControlList>
+</AccessControlPolicy>