README.md

ActiveJob::Cancel

activejob-cancel provides cancel method to Active Job. Currently it supports only Sidekiq, Delayed Job, resque and the Active Job TestAdapter.

Installation

Add this line to your application's Gemfile:

gem 'activejob-cancel'

And then execute:

$ bundle

Or install it yourself as:

$ gem install activejob-cancel

Usage

# app/jobs/hello_job.rb
class HelloJob < ActiveJob::Base
  def perform
  end
end

job = HelloJob.perform_later
job.cancel

Or

HelloJob.cancel(job id) # You must use the job id that Active Job provided.

If you want to use an id that backend job provided, use the cancel_by method.

HelloJob.cancel_by(provider_job_id: job_id)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/activejob-cancel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.