ActiveInteraction::ActiveJob

This gem adds active_job support to active_interaction gem.

With this gem you no longer need to create a separate Job class for the each interaction, this gem does it automatically for you.

Installation

Add this line to your application's Gemfile:

gem 'active_interaction-active_job'

Usage

class Add < ActiveInteraction::Base
  include ActiveInteraction::ActiveJob::Core

  class Job < ActiveJob::Base
    include ActiveInteraction::ActiveJob::JobHelper
  end

  integer :x, :y

  def execute
    x + y
  end
end


Add.delay.run(x: 1, y: 2)
Add.delay(queue_name: 'fast', wait: 1.week).run(x: 1, y: 2)

Advanced Usage

class Add < ActiveInteraction::Base
  include ActiveInteraction::ActiveJob::Core

  # This class is created automatically, but you can provide your own
  class Job < ActionJob::Base
    include ActiveInteraction::ActiveJob::JobHelper

    queue_as 'default'
  end

  active_job do
    # this will be executed inside Job class

    # same as above
    # queue_as 'default'

    # any other active_job options here....
  end

  integer :x, :y

  def execute
    x + y
  end
end

class AddOrDivide < Add

  active_job do
    # Job class inheritance works
    queue_as 'slow'
  end

  boolean :divide

  def execute
    if divide
      x / y
    else
      super
    end
  end
end


AddOrDivide.delay.run(x: 4, y: 2, divide: true)
AddOrDivide.delay(queue_name: 'fast', wait: 1.week).run(x: 4, y: 2, divide: true)

Sidekiq without ActiveJob

You can use sidekiq directly if you need more control. Sidekiq integration comes with default GlobalID support.

class BaseInteraction < ActiveInteraction::Base
  include ActiveInteraction::ActiveJob::Sidekiq::Core

  class Job
    include Sidekiq::Worker
    include ActiveInteraction::ActiveJob::Sidekiq::JobHelper

    sidekiq_options queue: 'default'
  end
end

class Add < BaseInteraction
  job do
    sidekiq_options queue: 'critical'
  end

  def execute
  end
end

Add.delay(wait: 1.minute, queue: 'slow').run

In sidekiq mode delay method accepts anything sidekiq set method (queue, retry, backtrace, etc) plus two additional: wait and wait_until.

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/antulik/active_interaction-active_job. 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.