sndacs 0.0.1

data/lib/sndacs/signature.rb

@@ -0,0 +1,243 @@
+module Sndacs
+
+  # Class responsible for generating signatures to requests.
+  #
+  # Implements algorithm defined by Amazon Web Services to sign
+  # request with secret private credentials
+  #
+  # === See
+  # http://docs.amazonwebservices.com/AmazonS3/latest/index.html?RESTAuthentication.html
+
+  class Signature
+
+    # Generates signature for given parameters
+    #
+    # ==== Options
+    # * <tt>:host</tt> - Hostname
+    # * <tt>:request</tt> - Net::HTTPRequest object with correct
+    #   headers
+    # * <tt>:access_key_id</tt> - Access key id
+    # * <tt>:secret_access_key</tt> - Secret access key
+    #
+    # ==== Returns
+    # Generated signature string for given hostname and request
+    def self.generate(options)
+      request = options[:request]
+      access_key_id = options[:access_key_id]
+
+      options.merge!(:headers => request, :method => request.method, :resource => request.path)
+
+      signature = canonicalized_signature(options)
+
+      "SNDA #{access_key_id}:#{signature}"
+    end
+
+    # Generates temporary URL signature for given resource
+    #
+    # ==== Options
+    # * <tt>:bucket</tt> - Bucket in which the resource resides
+    # * <tt>:resource</tt> - Path to the resouce you want to create
+    #   a temporary link to
+    # * <tt>:secret_access_key</tt> - Secret access key
+    # * <tt>:expires_at</tt> - Unix time stamp of when the resouce
+    #   link will expire
+    # * <tt>:method</tt> - HTTP request method you want to use on
+    #   the resource, defaults to GET
+    # * <tt>:headers</tt> - Any additional HTTP headers you intend
+    #   to use when requesting the resource
+    def self.generate_temporary_url_signature(options)
+      bucket = options[:bucket]
+      resource = options[:resource]
+      secret_access_key = options[:secret_access_key]
+      expires = options[:expires_at]
+
+      headers = options[:headers] || {}
+      headers.merge!("date" => expires.to_i.to_s)
+
+      options.merge!(:resource => "/#{bucket}/#{URI.escape(resource)}",
+                     :method => options[:method] || :get,
+                     :headers => headers)
+      signature = canonicalized_signature(options)
+
+      CGI.escape(signature)
+    end
+
+    # Generates temporary URL for given resource
+    #
+    # ==== Options
+    # * <tt>:bucket</tt> - Bucket in which the resource resides
+    # * <tt>:resource</tt> - Path to the resouce you want to create
+    #   a temporary link to
+    # * <tt>:access_key</tt> - Access key
+    # * <tt>:secret_access_key</tt> - Secret access key
+    # * <tt>:expires_at</tt> - Unix time stamp of when the resouce
+    #   link will expire
+    # * <tt>:method</tt> - HTTP request method you want to use on
+    #   the resource, defaults to GET
+    # * <tt>:headers</tt> - Any additional HTTP headers you intend
+    #   to use when requesting the resource
+    def self.generate_temporary_url(options)
+      bucket = options[:bucket]
+      resource = options[:resource]
+      access_key = options[:access_key]
+      expires = options[:expires_at].to_i
+      signature = generate_temporary_url_signature(options)
+
+      url = "http://#{S3::HOST}/#{bucket}/#{resource}"
+      url << "?AWSAccessKeyId=#{access_key}"
+      url << "&Expires=#{expires}"
+      url << "&Signature=#{signature}"
+    end
+
+    private
+
+    def self.canonicalized_signature(options)
+      headers = options[:headers] || {}
+      host = options[:host] || ""
+      resource = options[:resource]
+      access_key_id = options[:access_key_id]
+      secret_access_key = options[:secret_access_key]
+
+      http_verb = options[:method].to_s.upcase
+      content_md5 = headers["content-md5"] || ""
+      content_type = headers["content-type"] || ""
+      date = headers["x-snda-date"].nil? ? headers["date"] : ""
+      canonicalized_resource = canonicalized_resource(host, resource)
+      canonicalized_snda_headers = canonicalized_snda_headers(headers)
+
+      string_to_sign = ""
+      string_to_sign << http_verb
+      string_to_sign << "\n"
+      string_to_sign << content_md5
+      string_to_sign << "\n"
+      string_to_sign << content_type
+      string_to_sign << "\n"
+      string_to_sign << date
+      string_to_sign << "\n"
+      string_to_sign << canonicalized_snda_headers
+      string_to_sign << canonicalized_resource
+
+      digest = OpenSSL::Digest::Digest.new("sha1")
+      hmac = OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)
+      base64 = Base64.encode64(hmac)
+      base64.chomp
+    end
+
+    # Helper method for extracting header fields from Net::HTTPRequest
+    # and preparing them for singing in #generate method
+    #
+    # ==== Parameters
+    # * <tt>request</tt> - Net::HTTPRequest object with header fields
+    #   filled in
+    #
+    # ==== Returns
+    # String containing interesting header fields in suitable order
+    # and form
+    def self.canonicalized_snda_headers(request)
+      headers = []
+
+      # 1. Convert each HTTP header name to lower-case. For example,
+      # "X-Amz-Date" becomes "x-snda-date".
+      request.each { |key, value| headers << [key.downcase, value] if key =~ /\Ax-snda-/io }
+      #=> [["c", 0], ["a", 1], ["a", 2], ["b", 3]]
+
+      # 2. Sort the collection of headers lexicographically by header
+      # name.
+      headers.sort!
+      #=> [["a", 1], ["a", 2], ["b", 3], ["c", 0]]
+
+      # 3. Combine header fields with the same name into one
+      # "header-name:comma-separated-value-list" pair as prescribed by
+      # RFC 2616, section 4.2, without any white-space between
+      # values. For example, the two metadata headers
+      # "x-snda-meta-username: fred" and "x-snda-meta-username: barney"
+      # would be combined into the single header "x-snda-meta-username:
+      # fred,barney".
+      combined_headers = headers.inject([]) do |new_headers, header|
+        existing_header = new_headers.find { |h| h.first == header.first }
+        if existing_header
+          existing_header.last << ",#{header.last}"
+        else
+          new_headers << header
+        end
+      end
+      #=> [["a", "1,2"], ["b", "3"], ["c", "0"]]
+
+      # 4. "Un-fold" long headers that span multiple lines (as allowed
+      # by RFC 2616, section 4.2) by replacing the folding white-space
+      # (including new-line) by a single space.
+      unfolded_headers = combined_headers.map do |header|
+        key = header.first
+        value = header.last
+        value.gsub!(/\s+/, " ")
+        [key, value]
+      end
+
+      # 5. Trim any white-space around the colon in the header. For
+      # example, the header "x-snda-meta-username: fred,barney" would
+      # become "x-snda-meta-username:fred,barney"
+      joined_headers = unfolded_headers.map do |header|
+        key = header.first.strip
+        value = header.last.strip
+        "#{key}:#{value}"
+      end
+
+      # 6. Finally, append a new-line (U+000A) to each canonicalized
+      # header in the resulting list. Construct the
+      # CanonicalizedResource element by concatenating all headers in
+      # this list into a single string.
+      joined_headers << "" unless joined_headers.empty?
+      joined_headers.join("\n")
+    end
+
+    # Helper methods for extracting caninocalized resource address
+    #
+    # ==== Parameters
+    # * <tt>host</tt> - Hostname
+    # * <tt>request</tt> - Net::HTTPRequest object with header fields
+    #   filled in
+    #
+    # ==== Returns
+    # String containing extracted canonicalized resource
+    def self.canonicalized_resource(host, resource)
+      # 1. Start with the empty string ("").
+      string = ""
+
+      # 2. If the request specifies a bucket using the HTTP Host
+      # header (virtual hosted-style), append the bucket name preceded
+      # by a "/" (e.g., "/bucketname"). For path-style requests and
+      # requests that don't address a bucket, do nothing. For more
+      # information on virtual hosted-style requests, see Virtual
+      # Hosting of Buckets.
+      bucket_name = host.sub(/\.?storage\.grandcloud\.cn\Z/, "")
+      string << "/#{bucket_name}" unless bucket_name.empty?
+
+      # 3. Append the path part of the un-decoded HTTP Request-URI,
+      # up-to but not including the query string.
+      uri = URI.parse(resource)
+      string << uri.path
+
+      # 4. If the request addresses a sub-resource, like ?location,
+      # ?acl, or ?torrent, append the sub-resource including question
+      # mark.
+      sub_resources = [
+        "acl",
+        "location",
+        "logging",
+        "notification",
+        "partNumber",
+        "policy",
+        "requestPayment",
+        "torrent",
+        "uploadId",
+        "uploads",
+        "versionId",
+        "versioning",
+        "versions",
+        "website"
+      ]
+      string << "?#{$1}" if uri.query =~ /&?(#{sub_resources.join("|")})(?:&|=|\Z)/
+      string
+    end
+  end
+end

data/lib/sndacs/version.rb

@@ -0,0 +1,3 @@
+module Sndacs
+  VERSION = "0.0.1"
+end

data/lib/sndacs.rb

@@ -0,0 +1,27 @@
+require "base64"
+require "cgi"
+require "digest/md5"
+require "forwardable"
+require "net/http"
+require "net/https"
+require "openssl"
+require "rexml/document"
+require "time"
+
+require "proxies"
+require "sndacs/objects_extension"
+require "sndacs/buckets_extension"
+require "sndacs/parser"
+require "sndacs/bucket"
+require "sndacs/connection"
+require "sndacs/exceptions"
+require "sndacs/object"
+require "sndacs/request"
+require "sndacs/service"
+require "sndacs/signature"
+require "sndacs/version"
+
+module Sndacs
+  # Default (and only) host serving S3 stuff
+  HOST = "storage.grandcloud.cn"
+end

data/sndacs.gemspec

@@ -0,0 +1,29 @@
+# -*- 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 "sndacs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sndacs"
+  s.version     = Sndacs::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["LI Daobing"]
+  s.email       = ["lidaobing@snda.com"]
+  s.homepage    = "https://github.com/grandcloud/sndacs-ruby"
+  s.summary     = "Library for accessing SNDA Cloud Storage objects and buckets"
+  s.description = "sndacs library provides access to SNDA Cloud Storage."
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_dependency "proxies", "~> 0.2.0"
+  s.add_development_dependency "test-unit", ">= 2.0"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.0"
+
+  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/spec/sndacs/service_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+require 'sndacs/service'
+
+module Sndacs
+  describe Service do
+    context "#buckets" do
+      context "when buckets is empty" do
+        it "should works" do
+          @service_empty_buckets_list = Sndacs::Service.new(
+            :access_key_id =>  "12345678901234567890",
+            :secret_access_key =>  "qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDF"
+          )
+          @response_empty_buckets_list = Net::HTTPOK.new("1.1", "200", "OK")
+          @service_empty_buckets_list.should_receive(:service_request).and_return(@response_empty_buckets_list)
+          @response_empty_buckets_list.should_receive(:body).and_return(@buckets_empty_list_body)
+          @buckets_empty_list_body = <<-EOEmptyBuckets
+    <?xml version="1.0" encoding="UTF-8"?>\n<ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Owner> <ID>123u1odhkhfoadf</ID> <DisplayName>JohnDoe</DisplayName> </Owner> <Buckets> </Buckets> </ListAllMyBucketsResult>
+          EOEmptyBuckets
+          @service_empty_buckets_list.buckets.should == []
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/test/bucket_test.rb

@@ -0,0 +1,215 @@
+require "test_helper"
+
+class BucketTest < Test::Unit::TestCase
+  def setup
+    @bucket_vhost = S3::Bucket.send(:new, nil, "Data-Bucket")
+    @bucket_path = S3::Bucket.send(:new, nil, "Data_Bucket")
+    @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
+
+    @reponse_owned_by_you = Net::HTTPConflict.new("1.1", "409", "Conflict")
+    @reponse_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
+
+    @reponse_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")
+    ]
+
+    @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> </ListBucketResult>
+    EOObjects
+
+    @response_objects_list = Net::HTTPOK.new("1.1", "200", "OK")
+    @response_objects_list.stubs(:body).returns(@response_objects_list_body)
+  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
+  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
+  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
+  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