Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

EM-Synchrony handler for AWS-SDK

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rspec
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 HISTORY.md
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 em_aws.gemspec
README.md

EmAws

An EM-Synchrony handler for Ruby AWS-SDK-Ruby

Installation

em_aws is available through Rubygems and can be installed via:

$ gem install em_aws

Requirements

  • EmAws 0.3.x requires AWS-SDK-Ruby >= 1.9.3
  • EmAws 0.2.x is available for those using AWS-SDK-Ruby <= 1.8.5
  • AWS-SDK-Ruby 1.9.0 to 1.9.2 are not compatible with any version of EmAws; see here

Rails 3 setup

Setup AWS-SDK-Ruby as you would normally.

Assuming you've already setup async-rails, add em_aws to your gemfile:

gem 'em_aws'

Then run:

bundle install

Add the following to your aws.rb initializer:

require 'aws-sdk'
require 'aws/core/http/em_http_handler'
AWS.config(
:http_handler => AWS::Http::EMHttpHandler.new(
     :proxy => { :host => '127.0.0.1',  # proxy address
        :port => 9000,                  # proxy port
        :type => :socks5 },
   :pool_size => 20,   # Default is 0, set to > 0 to enable pooling
   :async => false))   # If set to true all requests are handle asynchronously 
                       # and initially return nil

You are done.

All requests to AWS will use EM-Synchrony's implementation of em-http-request for non-block HTTP requests and fiber management. See EM-HTTP-Request for all client options

Connection Pooling (keep-alive)

We use HotTub to manage connection pooling. To enable connection pooling set the :pool_size to anything greater than 0. By default :inactivity_timeout is set to 0 which will leave the connection open for as long as the client allows. Connects are created lazy, so pools grow until they meet the set pool size.

require 'aws-sdk'
require 'aws/core/http/em_http_handler'
AWS.config(
  :http_handler => AWS::Http::EMHttpHandler.new({
    :pool_size => 20,
    :inactivity_timeout => 0, # number of seconds to timeout stale connections in the pool,
    :never_block => true) # if we run out of connections, create a new one
)

Streaming

Streaming from disk,You can pass an IO object in the :data option instead but the object must respond to :path. We cannot stream from memory at this time.

EM.synchrony do
  s3 = AWS::S3.new 
  s3.buckets['bucket_name'].objects["foo.txt"].write(:file => "path_to_file")
  EM.stop
end

# Stream from AWS
EM.synchrony do
  s3 = AWS::S3.new 
  s3.buckets['bucket_name'].objects["foo.txt"].read do |chunk|
    puts chunk
  end
  EM.stop
end

Asynchronous Requests

Requests can be set to perform asynchronously, returning nil initially and performing the actions in the background. If the request option :async are set to true, only that request will be handled asynchronously. If the client option :async is set to true, all requests will be handled asynchronously.

EM.synchrony do
  s3 = AWS::S3.new
  s3.buckets['bucket-name'].objects["foo"].write('test', :async => true) # => nil
  EM::Synchrony.sleep(2) # Let the pending fibers run
  s3.buckets['bucket-name'].objects["foo"].read # => # 'test'
  s3.buckets['bucket-name'].objects["foo"].delete(:async => true) # => nil
  EM::Synchrony.sleep(2) # Let the pending fibers run
  EM.stop
end

References

AWS-SDK-Ruby

Async-Rails

Phat

Contributing to em_aws

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Thanks

Code based on HTTP Handers in AWS-SDK-Ruby

License

EmAws license AWS-SDK-Ruby license

Something went wrong with that request. Please try again.