https://github.com/madebylotus/request_store-sidekiq

Provides an easy integration between RequestStore and Sidekiq
https://github.com/madebylotus/request_store-sidekiq

ruby ruby-gem ruby-on-rails sidekiq

Last synced: about 1 month ago
JSON representation

Provides an easy integration between RequestStore and Sidekiq

• Host: GitHub
• URL: https://github.com/madebylotus/request_store-sidekiq
• Owner: madebylotus
• License: mit
• Created: 2017-03-03T15:26:50.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-02-02T08:28:59.000Z (almost 3 years ago)
• Last Synced: 2024-04-26T11:02:35.558Z (9 months ago)
• Topics: ruby, ruby-gem, ruby-on-rails, sidekiq
• Language: Ruby
• Size: 12.7 KB
• Stars: 40
• Watchers: 2
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# RequestStore::Sidekiq

[![Build Status](https://travis-ci.org/madebylotus/request_store-sidekiq.svg?branch=master)](https://travis-ci.org/madebylotus/request_store-sidekiq)

Provides an easy integration between [RequestStore](https://github.com/steveklabnik/request_store) and [Sidekiq](https://github.com/mperham/sidekiq).

RequestStore allows you to easily create threadsafe code, and this middleware for Sidekiq brings that functionality to Sidekiq workers, or even ActiveJob backed Sidekiq.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'request_store-sidekiq', '~> 0.1'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install request_store-sidekiq

## Usage

### Rails

If using Rails, the Sidekiq middleware is already inserted into the Sidekiq middleware stack for you automatically and there is nothing to do.

### Without Rails

Without Rails, you'll need to insert the middleware into the stack yourself.  In a Rack app, that might be in the `config.ru` file for instance.

```ruby

# insert middleware

RequestStore::Sidekiq.add_custom_middleware!

run MyRackApp

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/madebylotus/request_store-sidekiq. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).