resque-mission 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8460c78d2b6db3df9e9fff6dd2e59fb04e457d9
+  data.tar.gz: c4d4061e275cc2916dce4b1dafc142b673f0f53e
+SHA512:
+  metadata.gz: 9b33fdabb31a09315e9f6176554f999ded13b71849e8938178c45d7f6c816587150a7b1722c72a7555cad0d86fe6007e4f400d18da1f5cabeda4c5a31881d4ed
+  data.tar.gz: 5125b74e5e64a2ce799541929a5d08d697b8d767a80527dcd4df91c3756044b481668be9a86da895d56d7b9443c8c4bea3a1d50e60a9ad4616c76514eccb8775

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,69 @@
+resque-mission
+==============
+
+resque-mission adds Missions (multi-step jobs) to Resque.
+
+## Example
+
+```ruby
+require 'resque-mission'
+
+class TestMission < Resque::Plugins::Mission
+
+  # specify the queue (string/symbol)
+  queue :test
+
+  attr_reader :a, :b, :c
+
+  # called by create_from_options
+  def initialize(a, b, c)
+    @a = a
+    @b = b
+    @c = c
+  end
+
+  # implement this to rehydrate state from queue
+  # can modify what's passed to queue!(...) to whatever initialize wants
+  # eg: fetch an object from db by id, and pass obj to initialize 
+  def self.create_from_options(args={})
+    new(args['a'], args['b'], args['c'])
+  end
+
+  # steps are executed in the order they are declared here
+  # each one maps to a method of the same name
+  step :step1
+  step :step2
+
+  def step1
+    sleep 2
+    `echo '#{a} #{b} #{c}' > /tmp/step1.$(date -d "today" +"%Y%m%d%H%M%S").log`
+  end
+
+  def step2
+    sleep 5
+    `echo '#{a} #{b} #{c}' > /tmp/step2.$(date -d "today" +"%Y%m%d%H%M%S").log`
+  end
+
+end
+
+# enqueue
+TestMission.queue!({
+  :a => "Mission", 
+  :b => "Impossible",
+  :c => "Accomplished"
+})
+```
+
+## Requirements/Dependencies
+
+* [resque](http://github.com/defunkt/resque/) (1.8ish)
+* [resque-status](http://github.com/quirkey/resque-status/) (0.4ish)
+
+## Contributions
+
+Original implementation (and clever name) by [Matthew Lyon](http://github.com/mattly).
+Wrapping it up and delivering it as a plugin/gem (and maintaining it from here on out) by [Troy Howard](http://github.com/thoward)
+
+## Copyright
+
+Copyright © 2013 Troy Howard. See LICENSE for details.

data/lib/resque-mission.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'resque/plugins/mission'

data/lib/resque/plugins/mission.rb

@@ -0,0 +1,163 @@
+require 'resque'
+require 'resque-status'
+
+module Resque
+  module Plugins
+    class Mission
+
+      attr_reader :progress
+
+      # When subclassing Task, we also want to make it available as a resque job
+      def self.inherited(subklass)
+        subklass.const_set('Job', Class.new(Mission::Job))
+        subklass::Job.const_set('TASK_CLASS', subklass)
+      end
+
+      # Internal: The list of steps to be run on #call
+      def self.steps
+        @steps ||= []
+      end
+
+      # Public: Override this in your class to allow new tasks to be created from
+      # the queue. The given args will be what is fed to .queue
+      #
+      # args - from self.queue!
+      def self.create_from_options(args={})
+        new args
+      end
+
+      # Public: Create a Queue Job.
+      #
+      # args - Hash that will be fed to self.create_from_options from the queue.
+      def self.queue!(args={})
+        self::Job.create({'args' => args})
+      end
+
+      # Public: Sets the queue name for resque
+      def self.queue(q=nil)
+        if q then @queue = q.to_s
+        else @queue ||= "statused"
+        end
+      end
+
+      # Public: Declare a step to be run on #call. Steps will be run in the order
+      # they are declared.
+      #
+      # method_name - a symbol name for the method to be called.
+      # options - An optional Hash of information about the step.
+      #     current arguments:
+      #     - :message => Used for status updates, vs. method_name titlecased
+      def self.step(method_name, options={})
+        steps << [method_name, options]
+      end
+
+      # Public: Perform the Mission
+      #
+      # status - Optional Mission::Progress object
+      # block - if given, will yield idx, total, status message to the block
+      #         before performing the step
+      def call(status=nil, &block)
+        @progress = status || Progress.new
+        start_timer
+        self.class.steps.each_with_index do |step, index|
+          method_name, options = step
+          next if progress.completed?(method_name.to_s)
+          progress.start method_name.to_s
+          name = options[:message] || (method_name.to_s.gsub(/\w+/) {|word| word.capitalize})
+          yield index, self.class.steps.length, name if block_given?
+          send method_name
+        end
+        progress.finish
+      rescue Object => e
+        progress.failures += 1
+        raise e
+      end
+
+      private
+      # Private: start the timer
+      def start_timer
+        @start_time = Time.now.to_f
+      end
+
+      # Private: time since #call was called and now
+      def delta_time
+        return 0 unless @start_time
+        Time.now.to_f - @start_time
+      end
+
+      # Private: Key for Statsd
+      def stats_key(key=nil)
+        @key_base ||= self.class.name.downcase.gsub(/\s+/,"_").gsub('::','.')
+        key ? "#{@key_base}.#{key}" : @key_base
+      end
+
+      public
+
+      class Job < Resque::JobWithStatus
+        # Internal: used by Resque::JobWithStatus to get the queue name
+        def self.queue
+          self::TASK_CLASS.queue
+        end
+
+        # Internal: called by Resque::JobWithStatus to perform the job
+        def perform
+          task = self.class::TASK_CLASS.create_from_options(@options['args'])
+          @options['progress'] = Progress[@options['progress'] || {}]
+          task.call(@options['progress']) {|idx,total,msg| at idx, total, msg }
+          completed
+        end
+
+        # Internal: used by Resque::JobWithStatus to handle failure
+        # Stores the progress object on the exception so we can pass it through
+        # to the resque callback and store it in the failure.
+        def on_failure(e)
+          e.instance_variable_set :@job_progress, @options['progress']
+          raise e
+        end
+
+        # Internal: resque on failure callback, sorted
+        # Takes our progress object and injects it back into the arguments hash
+        # so that when the job is retried it knows where to resume.
+        def self.on_failure_1111_store_progress(e, *args)
+          args.last['progress'] = e.instance_variable_get :@job_progress
+        end
+      end
+
+      class Progress < Hash
+        def failures
+          self['failures'] ||= 0
+        end
+
+        def failures=(int)
+          self['failures'] = int
+        end
+
+        def start(step)
+          completed.push delete('working') if working
+          self['working'] = step
+        end
+
+        def working
+          self['working']
+        end
+
+        def completed
+          self['completed'] ||= []
+        end
+
+        def completed?(step)
+          completed.include?(step)
+        end
+
+        def finish
+          completed.push delete('working') if self['working']
+          self['finished'] = true
+        end
+
+        def finished?
+          self['finished'].present?
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/mission/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module Mission
+      Version = '1.0.0'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: resque-mission
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Lyon
+- Troy Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: resque-status
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: ''
+email: thoward37@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/resque/plugins/mission/version.rb
+- lib/resque/plugins/mission.rb
+- lib/resque-mission.rb
+homepage: http://github.com/thoward/resque-mission
+licenses:
+- Apache 2.0
+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.10
+signing_key: 
+specification_version: 3
+summary: resque-mission adds Missions (multi-step jobs) to Resque
+test_files: []