Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruby-shoryuken/shoryuken
A super efficient Amazon SQS thread based message processor for Ruby
https://github.com/ruby-shoryuken/shoryuken
activejob aws-sdk-ruby aws-sqs concurrent-ruby message-processor rails ruby shoryuken sqs-commands
Last synced: 2 days ago
JSON representation
A super efficient Amazon SQS thread based message processor for Ruby
- Host: GitHub
- URL: https://github.com/ruby-shoryuken/shoryuken
- Owner: ruby-shoryuken
- License: other
- Created: 2014-09-02T13:04:10.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T21:11:07.000Z (6 months ago)
- Last Synced: 2024-10-29T14:15:15.601Z (3 months ago)
- Topics: activejob, aws-sdk-ruby, aws-sqs, concurrent-ruby, message-processor, rails, ruby, shoryuken, sqs-commands
- Language: Ruby
- Homepage:
- Size: 1.91 MB
- Stars: 2,052
- Watchers: 45
- Forks: 280
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Shoryuken
Shoryuken _sho-ryu-ken_ is a super-efficient [Amazon SQS](https://aws.amazon.com/sqs/) thread-based message processor.
[](https://github.com/ruby-shoryuken/shoryuken/actions)
## Key features
- [Rails Active Job](https://github.com/phstc/shoryuken/wiki/Rails-Integration-Active-Job)
- [Queue Load balancing](https://github.com/phstc/shoryuken/wiki/Shoryuken-options#load-balancing)
- [Concurrency per queue](https://github.com/phstc/shoryuken/wiki/Processing-Groups)
- [Long Polling](https://github.com/phstc/shoryuken/wiki/Long-Polling)
- [Batch processing](https://github.com/phstc/shoryuken/wiki/Worker-options#batch)
- [Auto extend visibility timeout](https://github.com/phstc/shoryuken/wiki/Worker-options#auto_visibility_timeout)
- [Exponential backoff](https://github.com/phstc/shoryuken/wiki/Worker-options#retry_intervals)
- [Middleware support](https://github.com/phstc/shoryuken/wiki/Middleware)
- Amazon SQS CLI. See `shoryuken help sqs`
## Requirements
Ruby 2.4 or greater.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'shoryuken'
```
If you are using AWS SDK version 3, please also add this line:
```ruby
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:
```shell
$ bundle
```
## Usage
Check the [Getting Started](https://github.com/phstc/shoryuken/wiki/Getting-Started) page.
## More Information
For more information check the [wiki page](https://github.com/phstc/shoryuken/wiki).
## Credits
[Mike Perham](https://github.com/mperham), creator of [Sidekiq](https://github.com/mperham/sidekiq), and [everybody who contributed to it](https://github.com/mperham/sidekiq/graphs/contributors). 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
```sh
bundle exec rake spec
```
To run all Rails-related specs against all supported versions of Rails, execute
```sh
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](https://github.com/cjlarose/moto-sqs-server). Then execute
```sh
bundle exec rake spec:integration
```
### To release a new version
Compare latest tag with HEAD:
```sh
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](https://semver.org/).
then run:
```sh
bundle exec rake release
```