active_interaction-active_job 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3fdaf56bdba70f7b40df2b577add8be2f91cc3d3
-  data.tar.gz: be1fd8057bdcf537341cf6e21cd15960005ebb7a
+SHA256:
+  metadata.gz: 7fa4e8c87d430b63f62d6d62a9ed877e4b243ac0da4935c47f38d26a421f7bf5
+  data.tar.gz: c0365d6efc7e71654d19f6a80fd17004d2a724fb09f2eb4dc0f3e2e7dedc1a36
 SHA512:
-  metadata.gz: e86251a810ba452ed36ee67fde2ee8891625e9c3e79109f9f5eed0ad02c6c9937ebc0ed24952429df362458b5170c070081cff8256eba37c5350ba5b3adf538a
-  data.tar.gz: 7cb0e3ed64582a667de99b58a4ab63be54cce5447828c9d0cf03361fabe421fa37d729669e49b17386c2aac86617dfbe32869f894b4858b56953ed85dd197b44
+  metadata.gz: 017d448d6431190a8b15deb81cfd0d507c5911aaba8481a625a684d2fc1f9af334fe7cbc82bc361422b62131346da28e7ddf796af1ffb03f17448d676936cd06
+  data.tar.gz: 468d32049f3a229cf3f6e1b0c728cfd51126ceadea09b20042208e537ea94bc80d8216e1953d4d43675037e59472fe6422077256d9fc971d4379ce0da2682b36

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 0.3.2
+- Fix rails 6 deprecation warning (#2)
+
+### 0.3.1
+- Add support for Sidekiq Enterprise Encryption 
+
+### 0.3.0
+
+- **BREAKING CHANGE** `class.async` method is removed, use `delay.run` or alias it yourself
+- **BREAKING CHANGE** Job class is no longer is created by default, you need to manually create it yourself
+- added sidekiq support
+- added alias `job` to `active_job` interaction class method

data/README.md

@@ -1,5 +1,7 @@
 # ActiveInteraction::ActiveJob
 
+[![Gem Version](https://badge.fury.io/rb/active_interaction-active_job.svg)](https://badge.fury.io/rb/active_interaction-active_job)
+
 This gem adds [active_job](http://edgeguides.rubyonrails.org/active_job_basics.html) support to [active_interaction](https://github.com/orgsync/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.
@@ -18,7 +20,10 @@ gem 'active_interaction-active_job'
 ```ruby
 class Add < ActiveInteraction::Base
   include ActiveInteraction::ActiveJob::Core
-  # This creates Add::Job class
+
+  class Job < ActiveJob::Base
+    include ActiveInteraction::ActiveJob::JobHelper
+  end
 
   integer :x, :y
 
@@ -29,8 +34,6 @@ end
 
 
 Add.delay.run(x: 1, y: 2)
-Add.async(x: 1, y: 2) # same as above
-
 Add.delay(queue_name: 'fast', wait: 1.week).run(x: 1, y: 2)
 ```
 
@@ -83,11 +86,39 @@ end
 
 
 AddOrDivide.delay.run(x: 4, y: 2, divide: true)
-AddOrDivide.async(x: 4, y: 2, divide: true) # same as above
-
 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.
+
+```ruby
+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](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) (`queue`, `retry`, `backtrace`, etc) plus two additional: `wait` and `wait_until`.
+
 
 ## Development
 

data/active_interaction-active_job.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "active_interaction"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0.1"
+  spec.add_development_dependency "rake", "~> 13.0.1"
 end

data/lib/active_interaction/active_job.rb

@@ -11,7 +11,14 @@ module ActiveInteraction
 
     autoload :Core
     autoload :ConfiguredJob
-    autoload :DefaultJob
     autoload :JobHelper
+
+    module Sidekiq
+      extend ActiveSupport::Autoload
+
+      autoload :Core
+      autoload :ConfiguredJob
+      autoload :JobHelper
+    end
   end
 end

data/lib/active_interaction/active_job/configured_job.rb

@@ -1,13 +1,6 @@
-class ActiveInteraction::ActiveJob::ConfiguredJob
-  def initialize job_class, service_class, options={}
-    @options = options
-    @service_class = service_class
-    @job_class = job_class
-  end
+class ActiveInteraction::ActiveJob::ConfiguredJob < ::ActiveJob::ConfiguredJob
 
-  def run *args
-    @job_class.new(@service_class.name, *args).enqueue @options
-  end
+  alias_method :run!, :perform_later
+  alias_method :run, :perform_later
 
-  alias_method :run!, :run
 end

data/lib/active_interaction/active_job/core.rb

@@ -1,24 +1,17 @@
 module ActiveInteraction::ActiveJob::Core
   extend ActiveSupport::Concern
 
-  included do
-    define_job_class
-  end
-
   module ClassMethods
-    def define_job_class
+    def define_job_class klass
       unless const_defined?(:Job, false)
-        const_set(:Job, Class.new(default_job_class))
+        const_set(:Job, Class.new(klass))
       end
     end
 
-    def default_job_class
-      ActiveInteraction::ActiveJob::DefaultJob
-    end
-
     def active_job &block
       job_class.class_exec(&block)
     end
+    alias_method :job, :active_job
 
     def job_class
       const_get(:Job, false)
@@ -26,17 +19,11 @@ module ActiveInteraction::ActiveJob::Core
 
     def inherited subclass
       super
-      subclass.const_set(:Job, Class.new(job_class))
+      subclass.define_job_class job_class
     end
 
-    def set options = {}
-      ActiveInteraction::ActiveJob::ConfiguredJob.new(job_class, self, options)
-    end
-
-    alias_method :delay, :set
-
-    def async *args
-      delay.run! *args
+    def delay options = {}
+      ::ActiveInteraction::ActiveJob::ConfiguredJob.new(job_class, options)
     end
   end
 end

data/lib/active_interaction/active_job/job_helper.rb

@@ -1,5 +1,9 @@
 module ActiveInteraction::ActiveJob::JobHelper
-  def perform interaction_klass_name, *args
-    interaction_klass_name.constantize.run!(*args)
+  def perform *args
+    if self.class.respond_to?(:module_parent)
+      self.class.module_parent.run!(*args)
+    else
+      self.class.parent.run!(*args)
+    end
   end
 end

data/lib/active_interaction/active_job/sidekiq/configured_job.rb

@@ -0,0 +1,25 @@
+class ActiveInteraction::ActiveJob::Sidekiq::ConfiguredJob < ::ActiveJob::ConfiguredJob
+  def perform_now(*args)
+    @job_class.run!(*args)
+  end
+
+  def perform_later(*args)
+    args = ActiveJob::Arguments.serialize(args)
+    scope = @job_class.set(@options.except(:wait, :wait_until))
+
+    if @job_class.sidekiq_options['encrypt']
+      args.prepend(nil)
+    end
+
+    if @options[:wait]
+      scope.perform_in @options[:wait], *args
+    elsif @options[:wait_until]
+      scope.perform_at @options[:wait_until], *args
+    else
+      scope.perform_async *args
+    end
+  end
+
+  alias_method :run!, :perform_later
+  alias_method :run, :perform_later
+end

data/lib/active_interaction/active_job/sidekiq/core.rb

@@ -0,0 +1,10 @@
+module ActiveInteraction::ActiveJob::Sidekiq::Core
+  extend ActiveSupport::Concern
+  include ActiveInteraction::ActiveJob::Core
+
+  module ClassMethods
+    def delay options = {}
+      ::ActiveInteraction::ActiveJob::Sidekiq::ConfiguredJob.new(job_class, options)
+    end
+  end
+end

data/lib/active_interaction/active_job/sidekiq/job_helper.rb

@@ -0,0 +1,15 @@
+module ActiveInteraction::ActiveJob::Sidekiq::JobHelper
+  def perform *args
+    # support for sidekiq encrypted params
+    if args.length > 1 && args[0].nil?
+      args.shift
+    end
+
+    args = ActiveJob::Arguments.deserialize(args)
+    if self.class.respond_to?(:module_parent)
+      self.class.module_parent.run!(*args)
+    else
+      self.class.parent.run!(*args)
+    end
+  end
+end

data/lib/active_interaction/active_job/version.rb

@@ -1,5 +1,5 @@
 module ActiveInteraction
   module ActiveJob
-    VERSION = "0.1.0"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction-active_job
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Anton Katunin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 description: Add ActiveJob support to ActiveInteraction gem
 email:
 - antulik@gmail.com
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -101,6 +102,9 @@ files:
 - lib/active_interaction/active_job/core.rb
 - lib/active_interaction/active_job/default_job.rb
 - lib/active_interaction/active_job/job_helper.rb
+- lib/active_interaction/active_job/sidekiq/configured_job.rb
+- lib/active_interaction/active_job/sidekiq/core.rb
+- lib/active_interaction/active_job/sidekiq/job_helper.rb
 - lib/active_interaction/active_job/version.rb
 homepage: https://github.com/antulik/active_interaction-active_job
 licenses:
@@ -121,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Add ActiveJob support to ActiveInteraction gem