I'm looking for Shoryuken maintainers, are you interested on helping to maintain Shoryuken? Join our Slack

Shoryuken

Shoryuken sho-ryu-ken is a super-efficient Amazon SQS thread-based message processor.

Key features

• Rails Active Job
• Queue Load balancing
• Concurrency per queue
• Long Polling
• Batch processing
• Auto extend visibility timeout
• Exponential backoff
• Middleware support
• Amazon SQS CLI. See shoryuken help sqs

Requirements

Ruby 2.4 or greater.

Installation

Add this line to your application's Gemfile:

gem 'shoryuken'

If you are using AWS SDK version 3, please also add this line:

gem 'aws-sdk-sqs'

The extra gem aws-sdk-sqs is required in order to keep Shoryuken compatible with AWS SDK version 2 and 3.

And then execute:

$ bundle

Usage

Check the Getting Started page.

More Information

For more information check the wiki page.

Credits

Mike Perham, creator of Sidekiq, and everybody who contributed to it. Shoryuken wouldn't exist as it is without those contributions.

Contributing

1. Fork it ( https://github.com/phstc/shoryuken/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

Testing

To run all unit specs against the latest dependency versions, execute

bundle exec rake spec

To run all Rails-related specs against all supported versions of Rails, execute

bundle exec appraisal rake spec:rails

To run integration specs, start a mock SQS server on localhost:5000. One such option is cjlarose/moto-sqs-server. Then execute

bundle exec rake spec:integration

To release a new version

Compare latest tag with HEAD:

git log $(git describe --tags --abbrev=0)..HEAD --oneline

then update CHANGELOG.md.

Update version in lib/shoryuken/version.rb with the appropriate version number SEMVER.

then run:

bundle exec rake release