em_s3 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 'ruby-1.9.3-p125@em_s3'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in em_s3.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul Victor Raj
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,11 @@
+S3Interface :
+  This is a general purpose S3 upload/download library using EM::Deferrables which can retry while accessing from S3. Who doesn't want to retry when they get a 5xx from S3?
+
+S3Agent :
+  A serialization framework on top of S3Interface which could possibly occur when you are `put`ting objects in S3 in a reactor loop. Crude but works.
+
+Caveats :
+  * Doesn't (yet) run the event loop. I developed this when I was working on a Thin based app server. Future versions may have support for running an event loop.
+  * Works only for get_object and put_object. More methods coming soon.
+  * Do not define errbacks on instances of S3Interface. It uses errbacks to retry and __always__ succeeds and responds with an error code in case of an error.
+  * Feel free to fork and modify.

data/README.md

@@ -0,0 +1,29 @@
+# EmS3
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em_s3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em_s3
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/em_s3.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/em_s3/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Victor Raj"]
+  gem.email         = ["paulvictor@gmail.com"]
+  gem.description   = %q{Paul Victor Raj}
+  gem.summary       = %q{Enables evented access to S3 get and put interface}
+  gem.homepage      = ""
+
+  gem.add_dependency('em-http-request', '>=1.0.2')
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "em_s3"
+  gem.require_paths = ["lib"]
+  gem.version       = EmS3::VERSION
+end

data/examples/agent.rb

@@ -0,0 +1,22 @@
+EM.run{
+  s3a = S3Agent.new
+  s3a.set_keys('public_key', 'private_key')
+  bucket = "bucket"
+  object = "obj"
+  value = "value"
+  prefix = "prefix"
+  s3a.request_service(:get, bucket, object){|resp, code|
+    if code == 200
+      new_value = prefix + resp
+    elsif code == 404
+      new_value = prefix
+    else
+      s3a.revoke_service(bucket, object)
+      EM.stop
+    end
+    s3a.request_service(:put, bucket, object, new_value){|resp, code|
+      puts "AWS gave a #{code}"
+      EM.stop
+    }
+  }
+}

data/examples/read_write.rb

@@ -0,0 +1,17 @@
+EM.run{
+  s3i = S3Interface.new('your_aws_key', 'your_aws_secret')
+  s3i.callback{|resp, code|
+    puts "AWS replied with #{resp} and #{code}"
+    EM.stop
+  }
+  s3i.put_object('my_bucket', 'foo', 'bar')
+}
+
+EM.run{
+  s3i = S3Interface.new('your_aws_key', 'your_aws_secret')
+  s3i.callback{|resp, code|
+    puts "AWS replied with #{resp} and #{code}"
+    EM.stop
+  }
+  s3i.get_object('my_bucket', 'foo')
+}

data/lib/em_s3/version.rb

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

data/lib/em_s3.rb

@@ -0,0 +1,4 @@
+require "em_s3/version"
+require 'base64'
+require_relative 's3_interface'
+require_relative 's3_agent'

data/lib/s3_agent.rb

@@ -0,0 +1,69 @@
+class S3Agent < EM::Queue
+  include Singleton
+  # Refer to http://eventmachine.rubyforge.org/EventMachine/Queue.html for interface details
+  # This agent class solves the following problem
+  # RMW in S3.
+  # It has a pool of (s3) bucket, object names which are right now being processed.
+  # When a new request comes, we check if its right now sent out to S3.
+  # If yes, add it to the queue and add a pop request which will do the same thing again.
+  # If no, process it
+  # If a new read request for the same (object, bucket) comes, it will cycle through the push/pop cycle.
+  def initialize
+    @public_key = nil
+    @private_key = nil
+    @obj_pools = {}
+  end
+
+  def set_keys(public_key, private_key)
+    @public_key ||= public_key
+    @private_key ||= private_key
+    self
+  end
+
+  # Called from clients if due to some reason, they skip over the write part
+  # @param [String] bucket
+  #   The name of the bucket
+  # @param [String] object
+  #   The name of the object's key
+  # @return [true]
+  def revoke_service(bucket, object)
+    @obj_pools.delete("#{bucket}:#{object}")
+    true
+  end
+
+  # Requests any of :get or :put from S3.
+  # If the object is not being processed now, service it immediately.
+  # If not, push it in a queue and wait for the reactor to take it through.
+  # @param [Symbol] method
+  #   The HTTP method in lower case. Either :get or :put
+  # @param [String] bucket
+  #   The name of the bucket
+  # @param [String] object
+  #   The name of the object's key
+  # @param [String] value
+  #   The object's value
+  # @return [true]
+  def request_service(method, bucket, object, value = nil, &blk)
+    # Allow `put`s to go through.
+    # For `get`s, check if the object is not in use and only then, allow to pass though
+    if (!@obj_pools["#{bucket}:#{object}"]) || (method == :put)
+      # Some client is using the agent.
+      @obj_pools["#{bucket}:#{object}"] = true
+      s3i = S3Interface.new(@public_key, @private_key)
+      s3i.callback{|resp, status|
+        # Unblock the other client only if this is a write
+        revoke_service(bucket, object) if method == :put
+        yield resp, status if block_given?
+      }
+      method == :get ? s3i.get_object(bucket, object) : s3i.put_object(bucket, object, value)
+    else
+      push({:bucket => bucket, :object => object, :value => value})
+      pop{|request|
+        request_service(request[:bucket], request[:object], request[:value]){|resp, status|
+          yield resp, status if block_given?
+        }
+      }
+    end
+    true
+  end
+end

data/lib/s3_interface.rb

@@ -0,0 +1,134 @@
+class S3Interface
+  # Do not use the interfaces' errback to define custom events.
+  # Errbacks are used internally to retry.
+  include EM::Deferrable
+  # Credits to http://forrst.com/posts/Basic_Amazon_S3_Upload_via_PUT_Ruby_Class-4t6
+  # Refer to the following for S3 documentation
+  # http://docs.amazonwebservices.com/AmazonS3/latest/dev/RESTAuthentication.html#RESTAuthenticationConstructingCanonicalizedAmzHeaders
+  # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html
+  # http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html
+
+  attr_accessor :public_key, :private_key
+
+  def initialize(public_key, private_key, options = {})
+    @public_key = public_key
+    @private_key = private_key
+    @options = options.merge({:retry_count => 3})
+    @num_tries = 0
+    errback{|resp, status|
+      if (@num_tries += 1) < retry_count
+        retry_request
+      else
+        succeed resp, status
+      end
+    }
+  end
+
+  # Puts any of the objects into S3 buckets
+  # @param [String] bucket
+  #   The name of the bucket
+  # @param [String] object
+  #   The name of the object's key
+  # @param [String] value
+  #   The object's value
+  # @param [String] content_type
+  #   The value's MIME type
+  # @return [self]
+  def put_object(bucket, object, value, content_type = 'binary/octet-stream')
+    date = generate_date
+    sign_string = generate_signed_string('PUT', 'private', bucket, object, content_type)
+    signature = generate_signature(sign_string)
+    auth = generate_auth(signature)
+    headers = generate_put_headers(date, auth, 'private', content_type, value.size)
+    path = "/" << object
+
+    @req_options = {:method => :put, :head => headers, :path => path, :body => value}
+    @bucket = bucket
+    try_request
+    self
+  end
+
+  # Gets any of the objects from S3 buckets
+  # @param [String] bucket
+  #   The name of the bucket
+  # @param [String] object
+  #   The name of the object's key
+  # @return [self]
+  def get_object(bucket, object)
+    date = generate_date
+    sign_string = generate_signed_string('GET', nil, bucket, object, 'text/plain')
+    signature = generate_signature(sign_string)
+    auth = generate_auth(signature)
+    headers = generate_get_headers(date, auth, 'text/plain')
+    path = "/" << object
+
+    @req_options = {:method => :get, :head => headers, :path => path}
+    @bucket = bucket
+    try_request
+    self
+  end
+
+  private
+
+  # Perhaps an inappropriate method name, sonce we call it even the first time
+  def retry_request
+    # Explore persistent connections from within AWS
+    s3_conn = EM::HttpRequest.new("http://#{@bucket}.s3.amazonaws.com")
+    req_method = @req_options[:method]
+    s3_req = s3_conn.send(req_method, @req_options)
+    s3_req.callback{|cli|
+      if cli.response_header.http_status < 500
+        self.succeed cli.response, cli.response_header.http_status
+      else # Some S3 issue
+        self.fail cli.response, cli.response_header.http_status
+      end
+    }
+    s3_req.errback{|cli|
+      self.fail nil, nil
+    }
+  end
+
+  alias :try_request :retry_request
+
+  def generate_date
+    Time.now.httpdate
+  end
+
+  def generate_signed_string(request_type, access, bucket, object, content_type = 'binary/octet-stream')
+    signed_string = ""
+    signed_string << request_type << "\n\n"
+    if content_type == nil
+      signed_string << "\n"
+    else
+      signed_string << content_type << "\n"
+    end
+    signed_string << generate_date << "\n"
+    signed_string << "x-amz-acl:" << access << "\n" if access
+    signed_string << "/" << bucket << "/" << object
+  end
+
+  def generate_signature(signed_string)
+    Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), @private_key, signed_string)).gsub("\n", "")
+  end
+
+  def generate_auth(signature)
+    authString = "AWS"
+    authString << " "
+    authString << @public_key
+    authString << ":"
+    authString << signature
+    authString
+  end
+
+  def generate_put_headers(date_string, auth_string, access, content_type = nil, content_length = 0)
+    { 'Date' => date_string, 'Content-Type' => content_type, 'Content-Length' => content_length.to_s, 'Authorization' => auth_string, 'Expect' => "100-continue", 'x-amz-acl' => access }
+  end
+
+  def generate_get_headers(date_string, auth_string, content_type = 'text/plain')
+    { 'Date' => date_string, 'Authorization' => auth_string, 'Content-Type' => content_type }
+  end
+
+  def retry_count
+    @options[:retry_count]
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: em_s3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Victor Raj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: Paul Victor Raj
+email:
+- paulvictor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README
+- README.md
+- Rakefile
+- em_s3.gemspec
+- examples/agent.rb
+- examples/read_write.rb
+- lib/em_s3.rb
+- lib/em_s3/version.rb
+- lib/s3_agent.rb
+- lib/s3_interface.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Enables evented access to S3 get and put interface
+test_files: []