s3-restful 0.2.6

data/lib/s3-restful/s3/request.rb

@@ -0,0 +1,111 @@
+module S3Restful
+  module S3
+    class Request
+      include Utils
+      
+      VALID_HTTP_METHODS = [:head, :get, :aget, :put, :delete]
+      
+      attr_accessor :http_method, :url, :options, :response
+      
+      def initialize(http_method, url, options = {})
+        @options = {
+          :timeout => 10,
+          :retry_count => 4,
+          :headers => {},
+          :on_error => nil,
+          :on_success => nil,
+          :data => nil,
+          :ssl => {
+            :cert_chain_file => nil,
+            :verify_peer => false
+          }
+        }.update(options)
+        assert_valid_keys(options, :timeout, :on_success, :on_error, :retry_count, :headers, :data, :ssl, :file)
+        @http_method = http_method
+        @url = url
+        
+        validate
+      end
+      
+      def execute
+        S3Restful::Log.debug "Request: #{http_method.to_s.upcase} #{url}"
+        @response = http_class.new(url).send(http_method, :timeout => options[:timeout], :head => options[:headers], :body => options[:data], :ssl => options[:ssl], :file => options[:file])
+
+        @response.errback { error_callback }
+        @response.callback { success_callback }
+        @response
+      end
+      
+      def http_class
+        EventMachine::HttpRequest
+      end
+      
+    protected
+    
+      def validate
+        raise ArgumentError, "#{http_method} is not a valid HTTP method that #{self.class.name} understands." unless VALID_HTTP_METHODS.include?(http_method)
+      end
+      
+      def error_callback
+        S3Restful::Log.error "Response error: #{http_method.to_s.upcase} #{url}: #{response.response_header.status rescue ''}"
+        if should_retry?
+          S3Restful::Log.info "#{http_method.to_s.upcase} #{url}: retrying after error: status #{response.response_header.status rescue ''}"
+          handle_retry
+        elsif options[:on_error].respond_to?(:call)
+          call_user_error_handler
+        else
+          raise S3Restful::Error.new("#{http_method.to_s.upcase} #{url}: Failed reponse! Status code was #{response.response_header.status rescue ''}")
+        end
+      end
+      
+      def success_callback
+        S3Restful::Log.debug "Response success: #{http_method.to_s.upcase} #{url}: #{response.response_header.status rescue ''}"
+        case response.response_header.status
+        when 0, 400, 401, 404, 403, 409, 411, 412, 416, 500, 503
+          if should_retry?
+            S3Restful::Log.info "#{http_method.to_s.upcase} #{url}: retrying after: status #{response.response_header.status rescue ''}"
+            handle_retry
+          else
+            S3Restful::Log.error "#{http_method.to_s.upcase} #{url}: Re-tried too often - giving up"
+            error_callback
+          end
+        when 300, 301, 303, 304, 307
+          S3Restful::Log.info "#{http_method.to_s.upcase} #{url}: being redirected_to: #{response.response_header['LOCATION'] rescue ''}"
+          handle_redirect
+        else
+          call_user_success_handler
+        end
+      end
+      
+      def call_user_success_handler
+        options[:on_success].call(response) if options[:on_success].respond_to?(:call)
+      end
+      
+      def call_user_error_handler
+        options[:on_error].call(response) if options[:on_error].respond_to?(:call)
+      end
+      
+      def should_retry?
+        options[:retry_count] > 0
+      end
+      
+      def handle_retry
+        if should_retry?
+          new_request = self.class.new(http_method, url, options.update(:retry_count => options[:retry_count] - 1 ))
+          new_request.execute
+        else
+          S3Restful::Log.error "#{http_method.to_s.upcase} #{url}: Re-tried too often - giving up"
+        end
+      end
+      
+      def handle_redirect
+        new_location = response.response_header['LOCATION'] rescue ''
+        raise "Could not find the location to redirect to, empty location header?" if blank?(new_location)
+
+        new_request = self.class.new(http_method, new_location, options)
+        new_request.execute
+      end
+    
+    end
+  end
+end

data/lib/s3-restful/s3.rb

@@ -0,0 +1,16 @@
+module S3Restful
+  module S3
+
+    def self.ssl_options
+      @_ssl_options ||= {
+        :cert_chain_file => nil,
+        :verify_peer => false
+      }
+    end
+  
+    def self.ssl_options=(val)
+      @_ssl_options = val
+    end
+
+  end
+end

data/lib/s3-restful/utils.rb

@@ -0,0 +1,26 @@
+module S3Restful
+  module Utils
+    protected
+
+    def symbolize_keys(hash)
+      hash.inject({}) do |h, kv|
+        h[kv[0].to_sym] = kv[1]
+        h
+      end
+    end
+
+    def assert_valid_keys(hash, *valid_keys)
+      unknown_keys = hash.keys - [valid_keys].flatten
+      raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+    end
+
+    def present?(obj)
+      !blank?(obj)
+    end
+
+    def blank?(obj)
+      obj.respond_to?(:empty?) ? obj.empty? : !obj
+    end
+
+  end
+end

data/lib/s3-restful.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'em-http'
+require 'openssl'
+require 'logger'
+
+unless defined?(S3Restful)
+  $:<<(File.expand_path(File.dirname(__FILE__) + "/lib"))
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/utils')
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/log')
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/aws')
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/s3')
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/s3/request')
+  require File.expand_path(File.dirname(__FILE__) + '/S3-restful/s3/item')
+
+  module S3Restful
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 5
+
+    VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
+    class Error < RuntimeError; end
+  end
+end

data/s3-restful.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "s3-restful"
+  s.version = "0.2.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["João Pereira"]
+  s.date = "2012-06-08"
+  s.description = "An EventMachine based client for S3 compatible APIs"
+  s.email = "joaodrp@gmail.com"
+  s.extra_rdoc_files = [
+      "LICENSE.txt",
+      "README.md"
+  ]
+  s.files = [
+      "CHANGELOG.md",
+      "Gemfile",
+      "LICENSE.txt",
+      "README.md",
+      "Rakefile",
+      "VERSION",
+      "benchmark/right_aws.rb",
+      "s3-restful.gemspec",
+      "lib/s3-restful.rb",
+      "lib/s3-restful/aws.rb",
+      "lib/s3-restful/log.rb",
+      "lib/s3-restful/s3.rb",
+      "lib/s3-restful/s3/item.rb",
+      "lib/s3-restful/s3/request.rb",
+      "lib/s3-restful/utils.rb",
+      "test/aws_test.rb",
+      "test/s3/item_test.rb",
+      "test/s3/request_test.rb",
+      "test/s3_test.rb",
+      "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/joaodrp/s3-restful"
+  s.licenses = ["BSD"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "An EventMachine based client for S3 compatible APIs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<em-http-request>, ["~> 1.0.2"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<em-http-request>, ["~> 1.0.2"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<em-http-request>, ["~> 1.0.2"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/test/aws_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class ItemTest < Test::Unit::TestCase
+  context "An S3Restful::AWS instance" do
+    
+    setup do
+      @aws = S3Restful::AWS.new('the-aws-access-key', 'the-aws-secret-key')
+    end
+    
+    context "when constructing" do
+      should "require Access Key and Secret Key" do
+        assert_raise(ArgumentError) do
+          S3Restful::AWS.new(nil, nil)
+        end
+        
+        assert_raise(ArgumentError) do
+          S3Restful::AWS.new('', '')
+        end
+        
+        assert_nothing_raised do
+          S3Restful::AWS.new('abc', 'abc')
+        end
+      end
+    end
+    
+    context "when signing parameters" do
+      should "return a header hash" do
+        assert_not_nil @aws.sign("GET", '/')['Authorization']
+      end
+      
+      should "include the current date" do
+        assert_not_nil @aws.sign("GET", '/')['date']
+      end
+      
+      should "keep given headers" do
+        assert_equal 'bar', @aws.sign("GET", '/', {'foo' => 'bar'})['foo']
+      end
+    end
+    
+  end
+end