oss-ruby 1.0.0.beta

data/spec/lib/client_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe OSS::Client do
+  before do
+    @endpoint = 'oss-cn-hangzhou.aliyuncs.com'
+    @access_key_id = 'ACCESS_KEY_ID'
+    @access_key_secret = 'ACCESS_KEY_SECRET'
+    config = OSS::Config.new({
+      endpoint: @endpoint,
+      access_key_id: @access_key_id,
+      access_key_secret: @access_key_secret
+    })
+    @client = OSS::Client.new(config)
+  end
+
+  it "respond to run methods" do
+    expect(@client).to respond_to(:run)
+  end
+
+  context "#run" do
+    it "returns instance of OSS::Response when request succeed" do
+      stub_request(:get, @endpoint).to_return(status: 200)
+      expect(@client.run :get, '/').to be_instance_of(OSS::Response)
+    end
+  end
+
+  context "#sign" do
+    before do
+      allow(@client.config).to receive(:access_key_secret) { "OtxrzxIsfpFjA7SwPzILwy8Bw21TLhquhboDYROV" }
+    end
+
+    it "returns the right signature" do
+      string_to_sign = "PUT\nODBGOERFMDMzQTczRUY3NUE3NzA5QzdFNUYzMDQxNEM=\n" \
+                       "text/html\nThu, 17 Nov 2005 18:49:58 GMT\n" \
+                       "x-oss-magic:abracadabra\nx-oss-meta-author:foo" \
+                       "@bar.com\n/oss-example/nelson"
+      expect(@client.send :sign, string_to_sign).to eq("26NBxoKdsyly4EDv6inkoDft/yA=")
+    end
+  end
+
+  context "#authorization_string" do
+    before do
+      allow(@client.options).to receive(:[]).with(:resource) { "/oss-example/nelson" }
+      allow(@client.options).to receive(:[]).with(:sub_resource) { nil }
+      allow(@client.config).to receive(:access_key_id) { "44CF9590006BF252F707" }
+      allow(@client.config).to receive(:access_key_secret) { "OtxrzxIsfpFjA7SwPzILwy8Bw21TLhquhboDYROV" }
+    end
+
+    it "returns with authorization_string" do
+      headers = {
+        'Content-MD5' => 'ODBGOERFMDMzQTczRUY3NUE3NzA5QzdFNUYzMDQxNEM=',
+        'Content-Type' => 'text/html',
+        'Date' => 'Thu, 17 Nov 2005 18:49:58 GMT',
+        'x-oss-magic' => 'abracadabra',
+        'x-oss-meta-author' => 'foo@bar.com'
+      }
+      expect(@client.send :authorization_string, :put, headers).to eq("OSS 44CF9590006BF252F707:26NBxoKdsyly4EDv6inkoDft/yA=")
+    end
+  end
+
+  context "#connection" do
+    it "returns a instance of Faraday::Connection" do
+      expect(@client.send :connection).to be_instance_of(Faraday::Connection)
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe OSS::Config do
+  before do
+    @config = OSS::Config.new({
+      endpoint: 'oss-cn-hangzhou.aliyuncs.com',
+      access_key_id: 'ACCESS_KEY_ID',
+      access_key_secret: 'ACCESS_KEY_SECRET'
+    })
+  end
+
+  it "has methods of endpoint, access_key_id, access_key_secret" do
+    expect(@config).to respond_to(:endpoint)
+    expect(@config).to respond_to(:access_key_id)
+    expect(@config).to respond_to(:access_key_secret)
+  end
+
+  it "use the configuration passed by options" do
+    expect(@config.endpoint).to eq('oss-cn-hangzhou.aliyuncs.com')
+    expect(@config.access_key_id).to eq('ACCESS_KEY_ID')
+    expect(@config.access_key_secret).to eq('ACCESS_KEY_SECRET')
+  end
+end

data/spec/lib/object_spec.rb

@@ -0,0 +1,268 @@
+require 'spec_helper'
+
+describe "Object API" do
+  before :each do
+    @endpoint = 'oss-cn-hangzhou.aliyuncs.com'
+    @access_key_id = 'ACCESS_KEY_ID'
+    @access_key_secret = 'ACCESS_KEY_SECRET'
+    @oss = OSS.new({
+      endpoint: @endpoint,
+      access_key_id: @access_key_id,
+      access_key_secret: @access_key_secret
+    })
+    @bucket_name = 'oss-ruby-sdk-test-bucket'
+    @object_name = 'oss-ruby-sdk-test-object'
+    @non_exist_bucket = 'non-exist-bucket'
+    @non_exist_object = 'non-exist-object'
+  end
+
+  describe "#put_object #put_object_from_file" do
+    before do
+      @body = File.read('spec/fixtures/test.txt')
+      stub_request(:put, "#{@bucket_name}.#{@endpoint}/#{@object_name}")
+        .with(headers: {'Content-Length' => @body.length.to_s}, body: @body)
+        .to_return(status: 200)
+      stub_request(:put, "#{@non_exist_bucket}.#{@endpoint}/#{@object_name}")
+        .with(headers: {'Content-Length' => @body.length.to_s}, body: @body)
+        .to_return(status: 404)
+    end
+
+    it "create object on bucket with file content given" do
+      response = @oss.put_object(@bucket_name, @object_name, File.read('spec/fixtures/test.txt'))
+      expect(response.status).to eq(200)
+    end
+
+    it "create object on bucket with file name specified" do
+      response = @oss.put_object_from_file(@bucket_name, @object_name, 'spec/fixtures/test.txt')
+      expect(response.status).to eq(200)
+    end
+
+    it "create object on non existed bucket will return 404" do
+      response = @oss.put_object(@non_exist_bucket, @object_name, File.read('spec/fixtures/test.txt'))
+      expect(response.status).to eq(404)
+    end
+  end
+
+  describe "#copy_object" do
+    before do
+      stub_request(:put, "#{@bucket_name}.#{@endpoint}/#{@object_name}")
+        .with(headers: {'x-oss-copy-source' => "/#{@bucket_name}/source-file-name"})
+        .to_return(status: 200)
+    end
+
+    it "copy object on bucket" do
+      response = @oss.copy_object(@bucket_name, 'source-file-name', @bucket_name, @object_name)
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "#get_object" do
+    before do
+      stub_request(:get, "#{@bucket_name}.#{@endpoint}/#{@object_name}")
+        .to_return(status: 200)
+    end
+
+    it "read object from bucket" do
+      response = @oss.get_object(@bucket_name, @object_name)
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "#append_object" do
+    before do
+      stub_request(:post, "#{@bucket_name}.#{@endpoint}/#{@object_name}?append&position=0")
+        .with(body: 'append content')
+        .to_return(status: 200, headers: {'x-oss-next-append-position' => '14'})
+    end
+
+    it "append object on bucket" do
+      response = @oss.append_object(@bucket_name, @object_name, 'append content')
+      expect(response.status).to eq(200)
+      expect(response.headers['x-oss-next-append-position']).to eq('14')
+    end
+  end
+
+  describe "#delete_object" do
+    before do
+      stub_request(:delete, "#{@bucket_name}.#{@endpoint}/#{@object_name}")
+        .to_return(status: 204)
+    end
+
+    it "delete object from bucket" do
+      response = @oss.delete_object(@bucket_name, @object_name)
+      expect(response.status).to eq(204)
+    end
+  end
+
+  describe "#delete_multiple_objects" do
+    before do
+      stub_request(:post, "#{@bucket_name}.#{@endpoint}/?delete")
+        .with(
+          body: hash_including(
+            'Delete' => {'Quiet' => 'false', 'Object' => {'Key' => @object_name}}
+          )
+        )
+        .to_return(status: 200)
+    end
+
+    it "delete multiple objects from bucket" do
+      response = @oss.delete_multiple_objects(@bucket_name, [@object_name])
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "#head_object" do
+    before do
+      stub_request(:head, "#{@bucket_name}.#{@endpoint}/#{@object_name}")
+        .to_return(status: 200, headers: {'x-oss-object-type' => 'Normal'})
+    end
+
+    it "read object meta information from bucket" do
+      response = @oss.head_object(@bucket_name, @object_name)
+      expect(response.status).to eq(200)
+      expect(response.headers['x-oss-object-type']).to eq('Normal')
+    end
+  end
+
+  describe "#put_object_acl" do
+    before do
+      @permission = 'private'
+      stub_request(:put, "#{@bucket_name}.#{@endpoint}/#{@object_name}?acl")
+        .with(headers: {'x-oss-object-acl' => @permission})
+        .to_return(status: 200)
+    end
+
+    it "modify object ACL on bucket" do
+      response = @oss.put_object_acl(@bucket_name, @object_name, @permission)
+      expect(response.status).to eq(200)
+    end
+  end
+
+  describe "#get_object_acl" do
+    before do
+      @permission = 'private'
+      stub_request(:get, "#{@bucket_name}.#{@endpoint}/#{@object_name}?acl")
+        .to_return(status: 200, body: File.read('spec/fixtures/get_object_acl.xml'))
+    end
+
+    it "modify object ACL on bucket" do
+      response = @oss.get_object_acl(@bucket_name, @object_name)
+      expect(response.status).to eq(200)
+      expect(response.xpath("//Grant").text).to eq(@permission)
+    end
+  end
+
+  describe "#init_multi_upload" do
+    before do
+      stub_request(:post, "#{@bucket_name}.#{@endpoint}/#{@object_name}?uploads")
+        .to_return(status: 200, body: File.read('spec/fixtures/init_multi_upload.xml'))
+    end
+
+    it "initialize multipart upload event on bucket" do
+      response = @oss.init_multi_upload(@bucket_name, @object_name)
+      expect(response.status).to eq(200)
+      expect(response.xpath("//UploadId").text).to be_instance_of(String)
+    end
+  end
+
+  describe "#upload_object_part" do
+    before do
+      @upload_id = '0004B9894A22E5B1888A1E29F8236E2D'
+      stub_request(:put, "#{@bucket_name}.#{@endpoint}/#{@object_name}?partNumber=1&uploadId=#{@upload_id}")
+        .with(body: File.read('spec/fixtures/test.txt'))
+        .to_return(status: 200, headers: {'ETag' => '7265F4D211B56873A381D321F586E4A9'})
+    end
+
+    it "upload object part on bucket" do
+      response = @oss.upload_object_part(@bucket_name, @object_name, File.read('spec/fixtures/test.txt'), @upload_id)
+      expect(response.status).to eq(200)
+      expect(response.headers['ETag']).to be_instance_of(String)
+    end
+  end
+
+  describe "#upload_object_part_copy" do
+    before do
+      @upload_id = '0004B9894A22E5B1888A1E29F8236E2D'
+      stub_request(:put, "#{@bucket_name}.#{@endpoint}/#{@object_name}?partNumber=1&uploadId=#{@upload_id}")
+        .with(headers: {'x-oss-copy-source' => "/#{@bucket_name}/source-file-name"})
+        .to_return(status: 200, body: File.read('spec/fixtures/upload_object_part_copy.xml'))
+    end
+
+    it "copy upload object part on bucket" do
+      response = @oss.upload_object_part_copy(@bucket_name, 'source-file-name', @bucket_name, @object_name, @upload_id)
+      expect(response.status).to eq(200)
+      expect(response.xpath("//ETag").text).to be_instance_of(String)
+    end
+  end
+
+  describe "#complete_multi_upload" do
+    before do
+      @upload_id = '0004B9894A22E5B1888A1E29F8236E2D'
+      stub_request(:post, "#{@bucket_name}.#{@endpoint}/#{@object_name}?uploadId=#{@upload_id}")
+        .with(
+          body: hash_including(
+            'CompleteMultipartUpload' => {
+              'Part' => {
+                'PartNumber' => '1',
+                'ETag' => '7265F4D211B56873A381D321F586E4A9'
+              }
+            }
+          )
+        )
+        .to_return(status: 200, body: File.read('spec/fixtures/complete_multi_upload.xml'))
+    end
+
+    it "complete multiple part upload event on bucket" do
+      response = @oss.complete_multi_upload(
+        @bucket_name,
+        @object_name,
+        @upload_id, [{
+          part_number: 1,
+          etag: "7265F4D211B56873A381D321F586E4A9"
+        }]
+      )
+      expect(response.status).to eq(200)
+      expect(response.xpath("//Key").text).to eq(@object_name)
+    end
+  end
+
+  describe "#abort_multi_upload" do
+    before do
+      @upload_id = '0004B9894A22E5B1888A1E29F8236E2D'
+      stub_request(:delete, "#{@bucket_name}.#{@endpoint}/#{@object_name}?uploadId=#{@upload_id}")
+        .to_return(status: 204)
+    end
+
+    it "abort multipart upload event on bucket" do
+      response = @oss.abort_multi_upload(@bucket_name, @object_name, @upload_id)
+      expect(response.status).to eq(204)
+    end
+  end
+
+  describe "#list_multi_upload" do
+    before do
+      stub_request(:get, "#{@bucket_name}.#{@endpoint}/?uploads")
+        .to_return(status: 200, body: File.read('spec/fixtures/list_multi_upload.xml'))
+    end
+
+    it "list multipart upload events on bucket" do
+      response = @oss.list_multi_upload(@bucket_name)
+      expect(response.status).to eq(200)
+      expect(response.xpath("//Bucket").text).to eq(@bucket_name)
+    end
+  end
+
+  describe "#list_object_parts" do
+    before do
+      @upload_id = '0004B9894A22E5B1888A1E29F8236E2D'
+      stub_request(:get, "#{@bucket_name}.#{@endpoint}/#{@object_name}?uploadId=#{@upload_id}")
+        .to_return(status: 200, body: File.read('spec/fixtures/list_object_parts.xml'))
+    end
+
+    it "list multiple upload object parts of specified upload id on bucket" do
+      response = @oss.list_object_parts(@bucket_name, @object_name, @upload_id)
+      expect(response.status).to eq(200)
+      expect(response.xpath("//Bucket").text).to eq(@bucket_name)
+    end
+  end
+end

data/spec/lib/oss_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe OSS do
+  it "instantiate an instance" do
+    oss = OSS.new({
+      endpoint: 'oss-cn-hangzhou.aliyuncs.com',
+      access_key_id: 'ACCESS_KEY_ID',
+      access_key_secret: 'ACCESS_KEY_SECRET'
+    })
+    expect(oss).to be_an_instance_of(OSS::Base)
+    expect(oss).to respond_to(:config)
+  end
+end

data/spec/lib/response_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe OSS::Response do
+  before do
+    response = Faraday::Response.new
+    @response = OSS::Response.new(response)
+  end
+
+  it "respond to methods" do
+    expect(@response).to respond_to(:response)
+    expect(@response).to respond_to(:body)
+    expect(@response).to respond_to(:headers)
+    expect(@response).to respond_to(:status)
+    expect(@response).to respond_to(:doc)
+    expect(@response).to respond_to(:xpath)
+  end
+
+  context "receive an api error" do
+    before do
+      body = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Error>\n" \
+            "<Code>NoSuchBucket</Code>\n  <Message>The specified bucket " \
+            "does not exist.</Message>\n  <RequestId>56482B096078C074024EA8A6" \
+            "</RequestId>\n  <HostId>test-bucket-2a.oss-cn-hangzhou.aliyuncs." \
+            "com</HostId>\n  <BucketName>test-bucket-2a</BucketName>\n</Error>\n"
+      allow(@response).to receive(:status) { 400 }
+      allow(@response).to receive(:doc) { Nokogiri::XML(body) }
+    end
+
+    it "respond to methods" do
+      expect(@response.error).to be_instance_of(OSS::APIError)
+      expect(@response.error).to respond_to(:code)
+      expect(@response.error).to respond_to(:message)
+      expect(@response.error).to respond_to(:request_id)
+      expect(@response.error).to respond_to(:host_id)
+    end
+
+    it "has error message and code" do
+      expect(@response.error.code).to eq('NoSuchBucket')
+      expect(@response.error.message).to eq('The specified bucket does not exist.')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'oss'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: oss-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Xiaoguang Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby SDK for Aliyun OSS.
+email:
+- xg.chen87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- docs/bucket_api.md
+- docs/cors.md
+- docs/multipart_upload.md
+- docs/object_api.md
+- docs/quick_start.md
+- lib/oss.rb
+- lib/oss/base.rb
+- lib/oss/bucket.rb
+- lib/oss/client.rb
+- lib/oss/config.rb
+- lib/oss/error.rb
+- lib/oss/object.rb
+- lib/oss/response.rb
+- lib/oss/service.rb
+- lib/oss/utils.rb
+- lib/oss/version.rb
+- oss-ruby.gemspec
+- spec/fixtures/complete_multi_upload.xml
+- spec/fixtures/get_bucket.xml
+- spec/fixtures/get_bucket_acl.xml
+- spec/fixtures/get_object_acl.xml
+- spec/fixtures/get_service.xml
+- spec/fixtures/init_multi_upload.xml
+- spec/fixtures/list_multi_upload.xml
+- spec/fixtures/list_object_parts.xml
+- spec/fixtures/test.txt
+- spec/fixtures/upload_object_part_copy.xml
+- spec/lib/base_spec.rb
+- spec/lib/bucket_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/object_spec.rb
+- spec/lib/oss_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/serco-chen/oss-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Aliyun OSS
+test_files:
+- spec/fixtures/complete_multi_upload.xml
+- spec/fixtures/get_bucket.xml
+- spec/fixtures/get_bucket_acl.xml
+- spec/fixtures/get_object_acl.xml
+- spec/fixtures/get_service.xml
+- spec/fixtures/init_multi_upload.xml
+- spec/fixtures/list_multi_upload.xml
+- spec/fixtures/list_object_parts.xml
+- spec/fixtures/test.txt
+- spec/fixtures/upload_object_part_copy.xml
+- spec/lib/base_spec.rb
+- spec/lib/bucket_spec.rb
+- spec/lib/client_spec.rb
+- spec/lib/config_spec.rb
+- spec/lib/object_spec.rb
+- spec/lib/oss_spec.rb
+- spec/lib/response_spec.rb
+- spec/spec_helper.rb