Project

exel-s3

0.0
No commit activity in last 3 years
No release in over 3 years
Add-on to EXEL (https://github.com/47colborne/exel) that provides support for Amazon S3.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

EXEL::S3

Gem Version Build Status

This gem implements a "remote provider" for EXEL using Amazon S3. The remote provider is used when an async command is executed and a context shift occurs. Its job is to move the context to a remote storage location when the async call is initiated, and retrieve it before the async block is executed.

Typically, this gem would be used in conjunction with an EXEL async provider, such as exel-sidekiq. In this case, the context is serialized and uploaded to S3 from the machine making the async call, then downloaded by the Sidekiq worker before it executes the async block.

Installation

Add this line to your application's Gemfile:

gem 'exel-s3'

And then execute:

$ bundle

Or install it yourself as:

$ gem install exel-s3

Usage

By requiring this gem, EXEL will automatically be configured to use S3 to upload and download the serialized context when an async command is executed.

The following configuration must be provided:

EXEL.configure do |config|
    config.aws = OpenStruct.new(
        access_key_id: 'your AWS access key ID',
        secret_access_key: 'your AWS secret access key'
    )
  
    config.s3_bucket = 'the name of the bucket to use'
    config.s3_region = 'us-east-1' # default
end

Contributing

  1. Fork it ( https://github.com/47colborne/exel-s3/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request