radosgw-s3 0.1

data/lib/s3/version.rb

@@ -0,0 +1,3 @@
+module S3
+  VERSION = "0.1"
+end

data/radosgw-s3.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+# Load version requiring the canonical "s3/version", otherwise Ruby will think
+# is a different file and complaint about a double declaration of S3::VERSION.
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "s3/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radosgw-s3"
+  s.version     = S3::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Thomas Alrin, Kishorekumar Neelamegam, Rajthilak, Kuba Kuźma"]
+  s.email       = ["thomasalrin@megam.io", "nkishore@megam.io", "rajthilak@megam.io", "kuba@jah.pl"]
+  s.homepage    = "http://github.com/megamsys/radosgw-s3"
+  s.summary     = "Library for accessing ceph objects and buckets"
+  s.description = "radosgw-s3 library provides access to your ceph-radosgw. It supports both: radosgw user creation and bucket operation using REST API."
+  s.license = "Apache V2"
+
+  s.add_dependency "proxies", "~> 0.2.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "json"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "bundler"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = "lib"
+end
+

data/test/bucket_test.rb

@@ -0,0 +1,245 @@
+require "test_helper"
+
+class BucketTest < Test::Unit::TestCase
+  def setup
+    @bucket_vhost = S3::Bucket.send(:new, S3::Service.new(access_key_id: 'test', secret_access_key: 'secret'), "Data-Bucket")
+    @bucket_path = S3::Bucket.send(:new, S3::Service.new(access_key_id: 'test', secret_access_key: 'secret', use_vhost: false), "Data_Bucket")
+    @secure_bucket = S3::Bucket.send(:new, S3::Service.new(access_key_id: 'test', secret_access_key: 'secret', use_ssl: true), "Data-Secured")
+    @bucket = @bucket_vhost
+
+    @bucket_location = "EU"
+    @bucket_location_body = <<-EOLocation
+    <?xml version="1.0" encoding="UTF-8"?>\n<LocationConstraint xmlns="http://s3.amazonaws.com/doc/2006-03-01/">EU</LocationConstraint>
+    EOLocation
+
+    @response_location = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_location.stubs(:body).returns(@bucket_location_body)
+
+    @bucket_owned_by_you_body = <<-EOOwnedByYou
+    <?xml version="1.0" encoding="UTF-8"?>\n<Error> <Code>BucketAlreadyOwnedByYou</Code> <Message>Your previous request to create the named bucket succeeded and you already own it.</Message> <BucketName>bucket</BucketName> <RequestId>117D08EA0EC6E860</RequestId> <HostId>4VpMSvmJ+G5+DLtVox6O5cZNgdPlYcjCu3l0n4HjDe01vPxxuk5eTAtcAkUynRyV</HostId> </Error>
+    EOOwnedByYou
+
+    @response_owned_by_you = Net::HTTPConflict.new("1.1", "409", "Conflict")
+    @response_owned_by_you.stubs(:body).returns(@bucket_owned_by_you_body)
+
+    @bucket_already_exists_body = <<-EOAlreadyExists
+    <?xml version="1.0" encoding="UTF-8"?>\n<Error> <Code>BucketAlreadyExists</Code> <Message>The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.</Message> <BucketName>bucket</BucketName> <RequestId>4C154D32807C92BD</RequestId> <HostId>/xyHQgXcUXTZQhoO+NUBzbaxbFrIhKlyuaRHFnmcId0bMePvY9Zwg+dyk2LYE4g5</HostId> </Error>
+    EOAlreadyExists
+
+    @response_already_exists = Net::HTTPConflict.new("1.1", "409", "Conflict")
+    @response_already_exists.stubs(:body).returns(@bucket_already_exists_body)
+
+    @objects_list_empty = []
+    @objects_list = [
+      S3::Object.send(:new, @bucket, :key => "obj1"),
+      S3::Object.send(:new, @bucket, :key => "obj2"),
+      S3::Object.send(:new, @bucket, :key => "prefix/"),
+      S3::Object.send(:new, @bucket, :key => "prefix/obj3")
+    ]
+
+    @objects_list_prefix = [
+      S3::Object.send(:new, @bucket, :key => "prefix/"),
+      S3::Object.send(:new, @bucket, :key => "prefix/obj3")
+    ]
+
+    @response_objects_list_empty_body = <<-EOEmpty
+    <?xml version="1.0" encoding="UTF-8"?>\n<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> </ListBucketResult>
+    EOEmpty
+
+    @response_objects_list_empty = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list_empty.stubs(:body).returns(@response_objects_list_empty_body)
+
+    @response_objects_list_body = <<-EOObjects
+    <?xml version="1.0" encoding="UTF-8"?>\n<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>obj1</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>obj2</Key> <LastModified>2009-07-03T11:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e586e1b12bca85a458c&quot;</ETag> <Size>179</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f17e247b037a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>prefix/</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>prefix/obj3</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> </ListBucketResult>
+    EOObjects
+
+    @response_objects_list = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list.stubs(:body).returns(@response_objects_list_body)
+
+    @response_objects_list_body_prefix = <<-EOObjectsPrefix
+    <?xml version="1.0" encoding="UTF-8"?>\n<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix>prefix</Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>prefix/</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <Contents> <Key>prefix/obj3</Key> <LastModified>2009-07-03T10:17:33.000Z</LastModified> <ETag>&quot;99519cdf14c255e580e1b7bca85a458c&quot;</ETag> <Size>1729</Size> <Owner> <ID>df864aeb6f42be43f1d9e60aaabe3f15e245b035a4b79d1cfe36c4deaec67205</ID> <DisplayName>owner</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> </ListBucketResult>
+    EOObjectsPrefix
+
+
+    @response_objects_list_prefix = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list_prefix.stubs(:body).returns(@response_objects_list_body_prefix)
+  end
+
+  test "name valid" do
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "") end # should not be valid with empty name
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "10.0.0.1") end # should not be valid with IP as name
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "as") end # should not be valid with name shorter than 3 characters
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "a" * 256) end # should not be valid with name longer than 255 characters
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, ".asdf") end # should not allow special characters as first character
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "-asdf") end # should not allow special characters as first character
+    assert_raise ArgumentError do S3::Bucket.send(:new, nil, "_asdf") end # should not allow special characters as first character
+
+    assert_nothing_raised do
+      S3::Bucket.send(:new, nil, "a-a-")
+      S3::Bucket.send(:new, nil, "a.a.")
+      S3::Bucket.send(:new, nil, "a_a_")
+    end
+  end
+
+  test "path prefix" do
+    expected = ""
+    actual = @bucket_vhost.path_prefix
+    assert_equal expected, actual
+
+    expected = "Data_Bucket/"
+    actual = @bucket_path.path_prefix
+    assert_equal expected, actual
+  end
+
+  test "host" do
+    expected = "Data-Bucket.s3.amazonaws.com"
+    actual = @bucket_vhost.host
+    assert_equal expected, actual
+
+    expected = "s3.amazonaws.com"
+    actual = @bucket_path.host
+    assert_equal expected, actual
+
+    expected = "s3.amazonaws.com"
+    actual = @secure_bucket.host
+    assert_equal expected, actual
+  end
+
+  test "vhost" do
+    assert @bucket_vhost.vhost?
+    assert ! @bucket_path.vhost?
+  end
+
+  test "exists" do
+    @bucket.expects(:retrieve).returns(@bucket_vhost)
+    assert @bucket.exists?
+
+    @bucket.expects(:retrieve).raises(S3::Error::NoSuchBucket.new(nil, nil))
+    assert ! @bucket.exists?
+  end
+
+  test "location and parse location" do
+    @bucket.expects(:bucket_request).with(:get, { :params => { :location => nil } }).returns(@response_location)
+
+    expected = @bucket_location
+    actual = @bucket.location
+    assert_equal expected, actual
+
+    @bucket.stubs(:bucket_request).with(:get, { :params => { :location => nil } })
+    actual = @bucket.location
+    assert_equal expected, actual
+  end
+
+  test "save" do
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} })
+    assert @bucket.save
+    # mock ensures that bucket_request was called
+  end
+
+  test "save failure owned by you" do
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} }).raises(S3::Error::BucketAlreadyOwnedByYou.new(409, @response_owned_by_you))
+    assert_raise S3::Error::BucketAlreadyOwnedByYou do
+      @bucket.save
+    end
+
+    @bucket.expects(:bucket_request).with(:put, { :headers => {} }).raises(S3::Error::BucketAlreadyExists.new(409, @response_already_exists))
+    assert_raise S3::Error::BucketAlreadyExists do
+      @bucket.save
+    end
+  end
+
+  test "objects" do
+    @bucket.expects(:list_bucket).returns(@objects_list_empty)
+    expected = @objects_list_empty
+    actual = @bucket.objects
+    assert_equal expected, actual
+
+    @bucket.stubs(:list_bucket).returns(@objects_list_empty)
+    actual = @bucket.objects
+    assert_equal expected, actual
+
+    @bucket.stubs(:list_bucket).returns(@objects_list)
+
+    expected = @objects_list
+    actual = @bucket.objects
+    assert_equal expected, actual
+
+    @bucket.stubs(:list_bucket).with(:prefix=>'prefix').returns(@objects_list_prefix)
+    expected = @objects_list_prefix
+    actual = @bucket.objects(:prefix => 'prefix')
+    assert_equal expected, actual
+  end
+
+  test "list bucket and parse objects" do
+    @bucket.expects(:bucket_request).with(:get, :params => { :test=>true }).returns(@response_objects_list_empty)
+    expected = @objects_list_empty
+    actual = @bucket.objects.find_all(:test => true)
+    assert_equal expected, actual
+
+    @bucket.expects(:bucket_request).with(:get, :params => { :test => true }).returns(@response_objects_list)
+    expected = @objects_list
+    actual = @bucket.objects.find_all(:test => true)
+    assert_equal expected, actual
+
+    @bucket.expects(:bucket_request).with(:get, :params => { :test => true }).returns(@response_objects_list_prefix)
+    expected = @objects_list_prefix
+    actual = @bucket.objects(:prefix => "prefix").find_all(:test => true)
+    assert_equal expected, actual
+  end
+
+  test "destroy" do
+    @bucket.expects(:bucket_request).with(:delete)
+    assert @bucket.destroy
+  end
+
+  test "objects build" do
+    @bucket.stubs(:bucket_request)
+
+    expected = "object_name"
+    actual = @bucket.objects.build("object_name")
+    assert_kind_of S3::Object, actual
+    assert_equal expected, actual.key
+  end
+
+  test "objects find first" do
+    assert_nothing_raised do
+      S3::Object.any_instance.stubs(:retrieve).returns(S3::Object.send(:new, nil, :key => "obj2"))
+      expected = "obj2"
+      actual = @bucket.objects.find_first("obj2")
+      assert_equal "obj2", actual.key
+    end
+  end
+
+  test "objects find first fail" do
+    assert_raise S3::Error::NoSuchKey do
+      S3::Object.any_instance.stubs(:retrieve).raises(S3::Error::NoSuchKey.new(404, nil))
+      @bucket.objects.find_first("obj3")
+    end
+  end
+
+  test "objects find all on empty list" do
+    @bucket.stubs(:list_bucket).returns(@objects_list_empty)
+    assert_nothing_raised do
+      expected = @objects_list_empty
+      actual = @bucket.objects.find_all
+      assert_equal expected, actual
+    end
+  end
+
+  test "objects find all" do
+    @bucket.stubs(:list_bucket).returns(@objects_list)
+    assert_nothing_raised do
+      expected = @objects_list
+      actual = @bucket.objects.find_all
+      assert_equal expected, actual
+    end
+  end
+
+  test "objects destroy all" do
+    @bucket.stubs(:list_bucket).returns(@objects_list)
+    @bucket.objects.each do |obj|
+      obj.expects(:destroy)
+    end
+    @bucket.objects.destroy_all
+  end
+end

data/test/connection_test.rb

@@ -0,0 +1,215 @@
+require "test_helper"
+
+class ConnectionTest < Test::Unit::TestCase
+  def setup
+    @connection = S3::Connection.new(
+      :access_key_id =>  "12345678901234567890",
+	:host =>  "192.168.1.248",
+      :secret_access_key =>  "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDF"
+    )
+    @http_request = Net::HTTP.new("")
+    @response_ok = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_not_found = Net::HTTPNotFound.new("1.1", "404", "Not Found")
+    @response_error = Net::HTTPInternalServerError.new("1.1", "500", "Internal Server Error")
+    @response_temporary_redirect = Net::HTTPInternalServerError.new("1.1", "307", "Temporary Redirect")
+    @connection.stubs(:http).returns(@http_request)
+
+    @http_request.stubs(:start).returns(@response_ok)
+  end
+
+  test "handle response not modify response when ok" do
+    assert_nothing_raised do
+      response = @connection.request(
+        :get,
+        :host => "s3.amazonaws.com",
+        :path => "/"
+      )
+      assert_equal @response_ok, response
+    end
+  end
+
+  test "handle response throws exception when error" do
+    response_body = <<-EOFakeBody
+    <?xml version=\"1.0\" encoding=\"UTF-8\"?>
+    <Error>
+      <Code>NoSuchBucket</Code>
+      <Message>The specified bucket does not exist</Message>
+    </Error>
+    EOFakeBody
+
+    @http_request.stubs(:start).returns(@response_not_found)
+    @response_not_found.stubs(:body).returns(response_body)
+
+    assert_raise S3::Error::NoSuchBucket do
+      response = @connection.request(
+        :get,
+        :host => "data.example.com.s3.amazonaws.com",
+        :path => "/"
+      )
+    end
+  end
+
+  test "handle response throws standard exception when error" do
+    @http_request.stubs(:start).returns(@response_error)
+    @response_error.stubs(:body)
+    assert_raise S3::Error::ResponseError do
+      response = @connection.request(
+        :get,
+        :host => "data.example.com.s3.amazonaws.com",
+        :path => "/"
+      )
+    end
+
+    @response_error.stubs(:body).returns("")
+    assert_raise S3::Error::ResponseError do
+      response = @connection.request(
+        :get,
+        :host => "data.example.com.s3.amazonaws.com",
+        :path => "/"
+      )
+    end
+  end
+
+  test "parse params empty" do
+    expected = ""
+    actual = S3::Connection.parse_params({})
+    assert_equal expected, actual
+  end
+
+  test "parse params only interesting params" do
+    expected = ""
+    actual = S3::Connection.parse_params(:param1 => "1", :maxkeys => "2")
+    assert_equal expected, actual
+  end
+
+  test "parse params remove underscore" do
+    expected = "max-keys=100"
+    actual = S3::Connection.parse_params(:max_keys => 100)
+    assert_equal expected, actual
+  end
+
+  test "parse params with and without values" do
+    params = S3::Connection.parse_params(:max_keys => 100, :prefix => nil)
+
+    splitted_params = params.split("&")
+    assert_equal 2, splitted_params.length
+    assert splitted_params.include?("max-keys=100")
+    assert splitted_params.include?("prefix")
+  end
+
+  test "headers empty" do
+    expected = {}
+    actual = S3::Connection.parse_headers({})
+    assert_equal expected, actual
+  end
+
+  test "parse only interesting headers" do
+    expected = {}
+    actual = S3::Connection.parse_headers(
+      :accept => "text/*, text/html, text/html;level=1, */*",
+      :accept_charset => "iso-8859-2, unicode-1-1;q=0.8"
+    )
+    assert_equal expected, actual
+  end
+
+  test "parse headers remove underscore" do
+    expected = {
+      "content-type" => nil,
+      "x-amz-acl" => nil,
+      "x-amz-storage-class" => nil,
+      "if-modified-since" => nil,
+      "if-unmodified-since" => nil,
+      "if-match" => nil,
+      "if-none-match" => nil,
+      "content-disposition" => nil,
+      "content-encoding" => nil
+    }
+    actual = S3::Connection.parse_headers(
+      :content_type => nil,
+      :x_amz_acl => nil,
+      :x_amz_storage_class => nil,
+      :if_modified_since => nil,
+      :if_unmodified_since => nil,
+      :if_match => nil,
+      :if_none_match => nil,
+      :content_disposition => nil,
+      :content_encoding => nil
+    )
+    assert_equal expected, actual
+  end
+
+  test "parse headers with values" do
+    expected = {
+      "content-type" => "text/html",
+      "x-amz-acl" => "public-read",
+      "x-amz-storage-class" => "STANDARD",
+      "if-modified-since" => "today",
+      "if-unmodified-since" => "tomorrow",
+      "if-match" => "1234",
+      "if-none-match" => "1243",
+      "content-disposition" => "inline",
+      "content-encoding" => "gzip"
+    }
+    actual = S3::Connection.parse_headers(
+      :content_type => "text/html",
+      :x_amz_acl => "public-read",
+      :x_amz_storage_class => "STANDARD",
+      :if_modified_since => "today",
+      :if_unmodified_since => "tomorrow",
+      :if_match => "1234",
+      :if_none_match => "1243",
+      :content_disposition => "inline",
+      :content_encoding => "gzip"
+    )
+    assert_equal expected, actual
+  end
+
+  test "parse headers with range" do
+    expected = {
+      "range" => "bytes=0-100"
+    }
+    actual = S3::Connection.parse_headers(
+      :range => 0..100
+    )
+    assert_equal expected, actual
+  end
+
+  test "response.body is nil on TemporaryRedirect" do
+    @http_request.stubs(:start).returns(@response_temporary_redirect)
+    @response_temporary_redirect.stubs(:body).returns(nil)
+
+    assert_nothing_raised do
+      response = @connection.request(
+        :get,
+        :host => "data.example.com.s3.amazonaws.com",
+        :path => "/"
+      )
+      assert_equal nil, response
+    end
+  end
+
+  test "response body with new host on TemporaryRedirect" do
+    response_body = <<-EOFakeBody
+    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+    <Error>
+      <Code>TemporaryRedirect</Code>
+      <Message>Please re-send this request to the specified temporary endpoint. Continue to use the original request endpoint for future requests.</Message>
+      <RequestId>24A0BB91158D470B</RequestId>
+      <Bucket>data.example.com</Bucket>
+      <HostId>DFcq9ktw5HvWZLduutz8fnVzqtXLwIZcAezc7mgyS7lJ2ux+RChY4qAJGa2fQDjV</HostId>
+      <Endpoint>data.example.com.s3-external-3.amazonaws.com</Endpoint>
+    </Error>"
+    EOFakeBody
+
+    @response_temporary_redirect.stubs(:body).returns(response_body)
+
+    assert_nothing_raised do
+      response = @connection.request(
+        :get,
+        :host => "data.example.com.s3.amazonaws.com",
+        :path => "/"
+      )
+      assert_equal @response_ok, response
+    end
+  end
+end