# S3-Outlet: Stores the results in an AWS S3 bucket.

Component that stores results from the Opener Web Services chain into an S3
bucket.


## Installation

### As part of a Gemfile in a Ruby application

Add this line to your application's Gemfile:

    gem 'opener-s3-outlet',
        :git=>"git@github.com:opener-project/s3-outlet.git"

And then execute:

    $ bundle install

## Usage

The Opener S3 Outlet comes equipped with a simple webservice. To start the
webservice type:

    s3-outlet-server

This will launch a mini webserver with the webservice. It defaults to port 9292,
so you can access it at:

    http://localhost:9292

To launch it on a different port provide the ```-p [port-number]``` option like
this:

    s3-outlet-server -p 1234

It then launches at ```http://localhost:1234```

When you run a chain of web services using callbacks, the last URL should be the
one that points to the S3 Outlet Web Service. A unique id is generated and once the
chain has finished processing the text, you can view the result in the URL that
you get.

## Contributing

### Procedure

1. Pull it
2. Create your feature branch (`git checkout -b features/my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin features/my-new-feature`)
5. If you're confident, merge your changes into master.

# What's next? 

If you're interested in the opener-s3-outlet, you also might want to check
out opener-project/s3-outlet.