state_machine_job 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWUyMDg1Yjc1ZWUzNjE4NWMyNDliMjBiMGFlYzkyMDFkMzZhNTFmNg==
+  data.tar.gz: !binary |-
+    NWU5ZGNjN2IzOWE1NGVmMzU5MTEyNGZjOTMyMGM3NzQ2MTQ3Y2NmNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTUxMGEyOTVjYWE1Mzk1YzdiZjJmMDAxZmJkZjlmNTA4YWFmMTJjNTBlOTY0
+    MzA1MGM3ZGRmYjQyODMzMjkzYWVmMjAxYzlkNjExODQ0ZDFjZjliMzZlNmRh
+    ZDM1NWE2NjhiODY5YWYwOWZkYzRmYzM1NmEwNmNjNDEzZjkwNWM=
+  data.tar.gz: !binary |-
+    ZDdkZGFhZWU1MTdkMzkxOWNhMWEwNTcyZjRlY2QzMWIzOTkxODY4MjczZmFl
+    MjE1YmI5ODY0Mzc1NWY4NzQxOGE4MGY5MTAzNjVmZTk5YTFiMDdlMDI4Njhi
+    NWM5ZmYyMDFhNGU5MmE1NjBlNTFiODhkMjNhNjNhYTJjOTEzYTg=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+spec/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+
+script: "bundle exec rspec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_machine_job.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Codevise Solutions
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# State Machine Job
+
+Enqueue resque jobs on state machine transitions and change state
+according to job result.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state_machine_job'
+
+## Usage
+
+Extend your resque job with the `StateMachineJob` mixin and provide a
+`perform_with_result` class method instead of the normal `perform`
+method:
+
+    class SomeJob
+      extend StateMachineJob
+
+      def self.perform_with_result(record, payload)
+        # do something
+        :ok
+      end
+    end
+
+The `record` parameter is a reference to the object the state machine
+will be defined on.
+
+Now you can wire up the job in a state machine using the
+`StateMachineJob::Macro`:
+
+    state_machine :initial => 'idle' do
+      extend StateMachineJob::Macro
+
+      state 'idle'
+      state 'running'
+      state 'done'
+      state 'failed'
+
+      event :run do
+        transition 'idle' => "running"
+      end
+
+      job SomeJob do
+        on_enter 'running'
+
+        payload do |record|
+          {:some_attribute => record.some_attribute}
+        end
+
+        result :ok => 'done'
+        result :error => 'failed'
+      end
+    end
+
+When the `state` attribute changes to `'running'` (either by the `run`
+event or by manually updateing the attribute), `SomeJob` will
+automatically be enqueued. If `perform_with_result` returns `:ok`, the
+state machine transitions to the `'done'` state. You can specify as
+many results as you want. Note that any exception raised by
+`perform_with_result` is rescued and translated to the result
+`:error`.
+
+### Passing custom Payload
+
+You can specify further options to pass to the `perform_with_result`
+method using the `payload` method:
+
+    job SomeJob do
+      on_enter 'running'
+
+      payload do |record|
+        {:some_attribute => record.some_attribute}
+      end
+
+      result :ok => 'done'
+      result :error => 'failed'
+    end
+
+`perform_with_result` is now called with the given hash of options as
+the second parameter.
+
+### Retrying Jobs
+
+You can tell the state machine to retry a job based on its result:
+
+    job SomeJob do
+      on_enter 'running'
+
+      result :ok => 'done'
+      result :pending, :retry_after => 2.minutes
+      result :error => 'failed'
+    end
+
+When `perform_with_result` returns the result `:pending`, the state
+machine will remain in the `runnning` state and enqueue a delayed
+job. This functionality requires the `resque-scheduler` gem.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/state_machine_job.rb

@@ -0,0 +1,37 @@
+require 'state_machine_job/version'
+require 'state_machine_job/macro'
+
+require 'resque'
+require 'resque/plugins/logger'
+require 'resque_logger'
+
+module StateMachineJob
+  include Resque::Plugins::Logger
+
+  def perform(model_name, id, payload = {})
+    logger.info "#{self.name} - perform for #{model_name} #{id}"
+
+    record = model_name.constantize.find_by_id(id)
+
+    if record
+      result =
+        begin
+          perform_with_result(record, payload)
+        rescue Exception => e
+          logger.error "#{self.name} - exception for #{model_name} #{id}: #{e.inspect}"
+          :error
+        end
+
+      logger.info "#{self.name} - result #{result} for #{model_name} #{id}"
+      record.send(event_name(result))
+    else
+      logger.info "#{self.name} - #{model_name} #{id} not found. Skipping job."
+    end
+  end
+
+  private
+
+  def event_name(result)
+    ([self.name.underscore.split('/'), result].flatten.join('_') + '!').to_sym
+  end
+end

data/lib/state_machine_job/macro.rb

@@ -0,0 +1,56 @@
+module StateMachineJob
+  module Macro
+    def job(job_class, queue = Resque, &block)
+      Job.new(job_class, self, queue).instance_eval(&block)
+    end
+
+    class Job
+      def initialize(job, state_machine, queue)
+        @job = job
+        @state_machine = state_machine
+        @queue = queue
+        @payload = lambda do |*args|
+          {}
+        end
+      end
+
+      def result(job_result, options = {})
+        if job_result.is_a?(Hash)
+          return result(job_result.first.first, :state => job_result.first.last)
+        end
+
+        if options[:state]
+          @state_machine.event(job_result_event_name(job_result)) do
+            transition any => options[:state]
+          end
+        elsif options[:retry_after]
+          @state_machine.define_helper :instance, retry_job_method_name(job_result) do |machine, object|
+            @queue.enqueue_in(options[:retry_after], @job, object.class.name, object.id, @payload.call(object))
+          end
+        end
+      end
+
+      def on_enter(state)
+        job, state_machine, queue = @job, @state_machine, @queue
+
+        @state_machine.after_transition @state_machine.any => state do |object|
+          queue.enqueue(job, object.class.name, object.id, @payload.call(object))
+        end
+      end
+
+      def payload(&block)
+        @payload = block
+      end
+
+      private
+
+      def retry_job_method_name(result)
+        "#{job_result_event_name(result)}!"
+      end
+
+      def job_result_event_name(result)
+        [@job.name.underscore.split('/'), result].flatten.join('_').to_sym
+      end
+    end
+  end
+end

data/lib/state_machine_job/version.rb

@@ -0,0 +1,3 @@
+module StateMachineJob
+  VERSION = "0.0.5"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+
+require 'active_support/inflector'
+require 'state_machine'
+require 'state_machine_job'
+
+Dir[File.join(PROJECT_ROOT, 'spec', 'support', '**', '*.rb')].each { |file| require(file) }

data/spec/state_machine_job/macro_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+module StateMachineJob
+  describe Macro do
+    class TestJob
+    end
+
+    it 'enques job with model name, record id and payload arguments when entering on_enter state' do
+      queue = double('queue')
+      model = Class.new do
+        attr_accessor :some_attribute
+
+        def initialize(some_attribute)
+          self.some_attribute = some_attribute
+          super()
+        end
+
+        def id
+          43
+        end
+
+        state_machine :initial => :idle do
+          extend StateMachineJob::Macro
+
+          state :idle
+          state :running
+          state :done
+          state :failed
+
+          event :run do
+            transition :idle => :running
+          end
+
+          job TestJob, queue do
+            on_enter :running
+            payload do |record|
+              {:some_attribute => record.some_attribute}
+            end
+            result :ok => :done
+          end
+        end
+      end
+      record = model.new('value')
+
+      def model.name
+        'Model'
+      end
+
+      expect(queue).to receive(:enqueue).with(TestJob, 'Model', 43, {:some_attribute => 'value'})
+      record.run
+    end
+
+    it 'enques job after retry time with model name, record id and payload arguments when retry after result event is invoked' do
+      queue = double('queue')
+      model = Class.new do
+        attr_accessor :some_attribute
+
+        def initialize(some_attribute)
+          self.some_attribute = some_attribute
+          super()
+        end
+
+        def id
+          43
+        end
+
+        state_machine :initial => :idle do
+          extend StateMachineJob::Macro
+
+          state :idle
+          state :running
+          state :done
+          state :failed
+
+          job TestJob, queue do
+            on_enter :running
+            payload do |record|
+              {:some_attribute => record.some_attribute}
+            end
+            result :failed, :retry_after => 60
+            result :ok => :done
+          end
+        end
+      end
+      record = model.new('value')
+
+      def model.name
+        'Model'
+      end
+
+      expect(queue).to receive(:enqueue_in).with(60, TestJob, 'Model', 43, {:some_attribute => 'value'})
+      record.state_machine_job_test_job_failed!
+    end
+
+    it 'has event for job result which transitions to result state' do
+      object = Class.new do
+        state_machine :initial => :idle  do
+          extend StateMachineJob::Macro
+
+          state :idle
+          state :running
+          state :done
+          state :failed
+
+          event :run do
+            transition :idle => :running
+          end
+
+          job TestJob do
+            on_enter :running
+            result :ok => :done
+          end
+        end
+      end.new
+
+      object.state = :running
+      object.state_machine_job_test_job_ok
+
+      expect(object.state).to eq('done')
+    end
+
+    it 'result supports state option signature' do
+      object = Class.new do
+        state_machine :initial => :idle  do
+          extend StateMachineJob::Macro
+
+          state :idle
+          state :running
+          state :done
+
+          event :run do
+            transition :idle => :running
+          end
+
+          job TestJob do
+            on_enter :running
+            result :ok, :state => :done
+          end
+        end
+      end.new
+
+      object.state = :running
+      object.state_machine_job_test_job_ok
+
+      expect(object.state).to eq('done')
+    end
+  end
+end

data/spec/state_machine_job_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe StateMachineJob do
+  class TestQueue
+    def enqueue(job, *args)
+      job.perform(*args)
+    end
+
+    def self.instance
+      @instance ||= TestQueue.new
+    end
+  end
+
+  class TestJob1
+    @queue = 'test_job_1'
+    extend StateMachineJob
+  end
+
+  class TestJob2
+    @queue = 'test_job_2'
+    extend StateMachineJob
+  end
+
+  class Model
+    state_machine :initial => :idle do
+      extend StateMachineJob::Macro
+
+      state :idle
+      state :first_running
+      state :second_running
+      state :done
+
+      event :run do
+        transition :idle => :first_running
+      end
+
+      job TestJob1, TestQueue.instance do
+        on_enter :first_running
+        payload do |object|
+          {:n => 1}
+        end
+        result :ok => :second_running
+      end
+
+      job TestJob2, TestQueue.instance do
+        on_enter :second_running
+        payload do |object|
+          {:n => 2}
+        end
+        result :ok => :done
+      end
+    end
+  end
+
+  it 'calls find on model and passes record and payload to perform_with_result method' do
+    model = Model.new
+
+    allow(model).to receive(:id).and_return(5)
+    allow(Model).to receive(:find_by_id).and_return(model)
+    expect(TestJob1).to receive(:perform_with_result).with(model, {:n => 1}).and_return(:ok)
+    expect(TestJob2).to receive(:perform_with_result).with(model, {:n => 2}).and_return(:ok)
+
+    model.run
+  end
+
+  it 'invokes job result event on record' do
+    model = Model.new
+
+    allow(model).to receive(:id).and_return(5)
+    allow(Model).to receive(:find_by_id).and_return(model)
+    allow(TestJob1).to receive(:perform_with_result).and_return(:ok)
+    allow(TestJob2).to receive(:perform_with_result).and_return(:ok)
+
+    expect(model).to receive(:test_job1_ok!)
+
+    model.run
+  end
+
+  it 'job is skipped if record cannot be found' do
+    allow(Model).to receive(:find_by_id).and_return(nil)
+
+    expect {
+      TestJob1.perform(Model.name, -1, {})
+    }.not_to raise_exception
+  end
+end

data/spec/support/setup_resque_logger.rb

@@ -0,0 +1,11 @@
+require 'resque_logger'
+
+log_dir = 'spec/tmp/log'
+FileUtils.mkdir_p(log_dir)
+
+Resque.logger_config = {
+  folder: log_dir,
+  class_name: Logger,
+  level:      Logger::INFO,
+  formatter:  Logger::Formatter.new
+}

data/state_machine_job.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_machine_job/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "state_machine_job"
+  spec.version       = StateMachineJob::VERSION
+  spec.authors       = ["Codevise Solutions Ltd."]
+  spec.email         = ["info@codevise.de"]
+  spec.description   = %q{State Machine + Resque.}
+  spec.summary       = %q{Resque jobs class for rails state machines.}
+  spec.homepage      = "http://github.com/codevise/state_machine_job"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'gem_tasks'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'ci_reporter'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activesupport'
+
+  spec.add_runtime_dependency 'resque'
+  spec.add_runtime_dependency 'resque-logger'
+  spec.add_runtime_dependency 'state_machine'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: state_machine_job
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Codevise Solutions Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: gem_tasks
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque-logger
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: State Machine + Resque.
+email:
+- info@codevise.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/state_machine_job.rb
+- lib/state_machine_job/macro.rb
+- lib/state_machine_job/version.rb
+- spec/spec_helper.rb
+- spec/state_machine_job/macro_spec.rb
+- spec/state_machine_job_spec.rb
+- spec/support/setup_resque_logger.rb
+- state_machine_job.gemspec
+homepage: http://github.com/codevise/state_machine_job
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Resque jobs class for rails state machines.
+test_files:
+- spec/spec_helper.rb
+- spec/state_machine_job/macro_spec.rb
+- spec/state_machine_job_spec.rb
+- spec/support/setup_resque_logger.rb