resque-state 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee02ba0efe475ce49466785c81bc08757700c62e
-  data.tar.gz: 72d383d06b2d4c659a5f36eb08b3a4d2fc5da06d
+  metadata.gz: 56b1a83d2e91b7ac03c1c7acb4070eccb33075c2
+  data.tar.gz: c144dda6b15b35f88e78f23a08d02b0da589ee81
 SHA512:
-  metadata.gz: 51c852a08c55d06c4f2254c0c6a6f3336d72ea9586ee23e443fa605615de45bcab5ec3c940f77c1252ce20f8bad5b26f6d8e7414591b1a9bbe4991e6ee0b8134
-  data.tar.gz: 1c31cbdbbf5fbe60f6e262e209d1dc07dad9191da971e4a2cbb92755c886b96ef919f41342d118d3bc2ce409c199d636a9b6bd011168bc54784c9acfe85ec65f
+  metadata.gz: b8dd4139d3dabd4804f95a1f1d156515f2a5aaebfaa76ccb3c13afc39a79bfb00ae85b3731fdd1637663919ba553abd0ed6c8e0081bd1558d9f550e10093c11e
+  data.tar.gz: ea5e97309395a4ed38eecec4e7bc41c4b61043a1668fd0f320d81fdc721c03f97e8ba2832404fb28622ea6c0d6aff651eb5f559496b039517ce43d1cb2a22b00

data/Gemfile

@@ -1,15 +1,15 @@
 source 'https://rubygems.org'
 
-gem 'resque', '~>1.19'
+gem 'resque', '~>1.27'
 
 group :test do
-  gem 'mocha', '~>0.9'
-  gem 'minitest', '~> 5.9'
-  gem 'simplecov'
-  gem 'fakeredis', '~> 0.5.0'
-  gem "codeclimate-test-reporter", require: nil
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'fakeredis', '~> 0.6'
+  gem 'minitest', '~> 5.10'
+  gem 'mocha', '~> 1.2'
+  gem 'simplecov', '~> 0.14'
 end
 
 group :development do
-  gem 'jeweler', '~> 2.1'
+  gem 'jeweler', '~> 2.3'
 end

data/Gemfile.lock

@@ -1,87 +1,93 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    builder (3.2.2)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.1.5)
-    fakeredis (0.5.0)
-      redis (~> 3.0)
+    fakeredis (0.6.0)
+      redis (~> 3.2)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
-    github_api (0.14.5)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      oauth2 (~> 1.0)
-    hashie (3.4.4)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.5.5)
     highline (1.7.8)
-    jeweler (2.1.1)
+    jar-dependencies (0.3.11)
+    jeweler (2.3.3)
       builder
       bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.11.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych (~> 2.2)
       rake
       rdoc
-      semver
-    json (1.8.3)
-    json (1.8.3-java)
-    jwt (1.5.4)
+      semver2
+    json (2.1.0)
+    json (2.1.0-java)
+    jwt (1.5.6)
     metaclass (0.0.4)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    mocha (0.14.0)
+    minitest (5.10.1)
+    mocha (1.2.1)
       metaclass (~> 0.0.1)
     mono_logger (1.1.0)
     multi_json (1.12.1)
-    multi_xml (0.5.5)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.6.8)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    nokogiri (1.6.8-java)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
+    nokogiri (1.6.8.1-java)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    pkg-config (1.1.7)
-    rack (1.6.4)
+    psych (2.2.4)
+    psych (2.2.4-java)
+      jar-dependencies (>= 0.1.7)
+    public_suffix (2.0.5)
+    rack (1.6.5)
     rack-protection (1.5.3)
       rack
-    rake (11.2.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    redis (3.3.1)
-    redis-namespace (1.5.2)
+    rake (12.0.0)
+    rdoc (5.1.0)
+    redis (3.3.3)
+    redis-namespace (1.5.3)
       redis (~> 3.0, >= 3.0.4)
-    resque (1.26.0)
+    resque (1.27.4)
       mono_logger (~> 1.0)
       multi_json (~> 1.0)
       redis-namespace (~> 1.3)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    semver (1.0.1)
-    simplecov (0.12.0)
+    semver2 (3.4.2)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sinatra (1.4.7)
+    sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    thread_safe (0.3.5)
-    thread_safe (0.3.5-java)
-    tilt (2.0.5)
+    thread_safe (0.3.6)
+    thread_safe (0.3.6-java)
+    tilt (2.0.7)
     vegas (0.1.11)
       rack (>= 1.0.0)
 
@@ -91,12 +97,12 @@ PLATFORMS
 
 DEPENDENCIES
   codeclimate-test-reporter
-  fakeredis (~> 0.5.0)
-  jeweler (~> 2.1)
-  minitest (~> 5.9)
-  mocha (~> 0.9)
-  resque (~> 1.19)
-  simplecov
+  fakeredis (~> 0.6)
+  jeweler (~> 2.3)
+  minitest (~> 5.10)
+  mocha (~> 1.2)
+  resque (~> 1.27)
+  simplecov (~> 0.14)
 
 BUNDLED WITH
-   1.12.5
+   1.14.3

data/Rakefile

@@ -10,12 +10,12 @@ begin
     gem.name = 'resque-state'
     gem.version = Resque::Plugins::State::VERSION.dup
     gem.summary = %(resque-state is an extension to the resque queue system
-      that provides simple trackable jobs.).gsub("\n", ' ').squeeze(' ')
+      that provides simple trackable jobs.).tr("\n", ' ').squeeze(' ')
     gem.description = %(resque-state is an extension to the resque queue
       system that provides simple trackable jobs. It provides a
       Resque::Plugins::State::Hash class which can set/get the statuses of jobs
       and a Resque::Plugins::State class that, when included, provides easily
-      trackable/killable/pausable jobs.).gsub("\n", ' ').squeeze(' ')
+      trackable/killable/pausable jobs.).tr("\n", ' ').squeeze(' ')
     gem.email = 'nathan.v@gmail.com'
     gem.homepage = 'http://github.com/nathan-v/resque-state'
     gem.rubyforge_project = 'nathan-v'
@@ -27,7 +27,7 @@ begin
   Jeweler::RubygemsDotOrgTasks.new
 rescue LoadError
   puts 'Jeweler (or a dependency) not available. Install it with: gem install'\
-  ' jeweler'.gsub("\n", ' ').squeeze(' ')
+  ' jeweler'.tr("\n", ' ').squeeze(' ')
 end
 
 require 'rake/testtask'

data/examples/sleep_job.rb

@@ -1,12 +1,11 @@
 require 'resque/job_with_state' # in rails you would probably do this in an initializer
 
 # sleeps for _length_ seconds updating the status every second
-
 class SleepJob
   include Resque::Plugins::State
 
   def perform
-    total = options.has_key?('length') ? options['length'].to_i : 1000
+    total = options.key?('length') ? options['length'].to_i : 1000
     num = 0
     while num < total
       at(num, total, "At #{num} of #{total}")
@@ -15,21 +14,19 @@ class SleepJob
     end
     completed
   end
-
 end
 
-
-if __FILE__ == $0
+if __FILE__ == $PROGRAM_NAME
   # Make sure you have a worker running
   # rake -rexamples/sleep_job.rb resque:work QUEUE=statused
 
   # running the job
-  puts "Creating the SleepJob"
-  job_id = SleepJob.create :length => 100
+  puts 'Creating the SleepJob'
+  job_id = SleepJob.create length: 100
   puts "Got back #{job_id}"
 
   # check the status until its complete
-  while status = Resque::Plugins::State::Hash.get(job_id) and !status.completed? && !status.failed?
+  while (status = Resque::Plugins::State::Hash.get(job_id)) && !status.completed? && !status.failed?
     sleep 1
     puts status.inspect
   end

data/lib/resque/job_with_state.rb

@@ -1,4 +1,5 @@
 module Resque
+  # Add the class for stateful jobs
   class JobWithState
     include Resque::Plugins::State
   end

data/lib/resque/plugins/state.rb

@@ -1,4 +1,6 @@
+# Resque root module
 module Resque
+  # Resque::Plugins root module
   module Plugins
     # Resque::Plugins::State is a module your jobs will include.
     # It provides helper methods for updating the status/etc from within an
@@ -28,7 +30,7 @@ module Resque
     # end we update the status telling anyone listening to this job that its
     # complete.
     module State
-      VERSION = '1.0.1'.freeze
+      VERSION = '1.0.3'.freeze
 
       STATUS_QUEUED = 'queued'.freeze
       STATUS_WORKING = 'working'.freeze
@@ -36,13 +38,15 @@ module Resque
       STATUS_FAILED = 'failed'.freeze
       STATUS_KILLED = 'killed'.freeze
       STATUS_PAUSED = 'paused'.freeze
+      STATUS_WAITING = 'waiting'.freeze
       STATUSES = [
         STATUS_QUEUED,
         STATUS_WORKING,
         STATUS_COMPLETED,
         STATUS_FAILED,
         STATUS_KILLED,
-        STATUS_PAUSED
+        STATUS_PAUSED,
+        STATUS_WAITING
       ].freeze
 
       autoload :Hash, 'resque/plugins/state/hash'
@@ -57,6 +61,7 @@ module Resque
         base.extend(ClassMethods)
       end
 
+      # Methods required for launching a state-ready job
       module ClassMethods
         # The default queue is :statused, this can be ovveridden in the specific
         # job class to put the jobs on a specific worker queue
@@ -209,6 +214,12 @@ module Resque
         Resque::Plugins::State::Hash.should_pause?(uuid)
       end
 
+      # Checks against the lock list if this specific job instance should wait
+      # before starting
+      def locked?(key)
+        Resque::Plugins::State::Hash.locked?(key)
+      end
+
       # set the status of the job for the current itteration. <tt>num</tt> and
       # <tt>total</tt> are passed to the status as well as any messages.
       # This will kill the job if it has been added to the kill list with
@@ -279,6 +290,31 @@ module Resque
         end
       end
 
+      # lock against a provided or automatic key to prevent duplicate jobs
+      def lock!(key = nil)
+        lock = Digest::SHA1.hexdigest @options.to_json
+        lock = key if key
+        if locked?(lock)
+          messages = ["Waiting at #{Time.now} due to existing job"]
+          job_status('status' => STATUS_WAITING,
+                     'message' => messages[0])
+          while locked?(lock)
+            kill! if should_kill?
+            pause! if should_pause?
+            sleep 10
+          end
+        else
+          Resque::Plugins::State::Hash.lock(lock)
+        end
+      end
+
+      # unlock the provided or automatic key at the end of a job
+      def unlock!(key = nil)
+        lock = Digest::SHA1.hexdigest @options.to_json
+        lock = key if key
+        Resque::Plugins::State::Hash.unlock(lock)
+      end
+
       private
 
       def job_status(*args)

data/lib/resque/plugins/state/hash.rb

@@ -3,16 +3,20 @@ require 'securerandom'
 module Resque
   module Plugins
     module State
-      # Resque::Plugins::State::Hash is a Hash object that has helper methods for dealing with
-      # the common status attributes. It also has a number of class methods for
-      # creating/updating/retrieving status objects from Redis
+      # Resque::Plugins::State::Hash is a Hash object that has helper methods
+      # for dealing with the common status attributes. It also has a number of
+      # class methods for creating/updating/retrieving status objects from Redis
       class Hash < ::Hash
-        # Create a status, generating a new UUID, passing the message to the status
+        # Create a status, a new UUID, passing the message to the status
         # Returns the UUID of the new status.
         def self.create(uuid, *messages)
           set(uuid, *messages)
           redis.zadd(set_key, Time.now.to_i, uuid)
-          redis.zremrangebyscore(set_key, 0, Time.now.to_i - @expire_in) if @expire_in
+          if @expire_in
+            redis.zremrangebyscore(
+              set_key, 0, Time.now.to_i - @expire_in
+            )
+          end
           uuid
         end
 
@@ -22,7 +26,7 @@ module Resque
           val ? Resque::Plugins::State::Hash.new(uuid, decode(val)) : nil
         end
 
-        # Get multiple statuses by UUID. Returns array of Resque::Plugins::State::Hash
+        # Get statuses by UUID. Returns array of Resque::Plugins::State::Hash
         def self.mget(uuids)
           return [] if uuids.empty?
           status_keys = uuids.map { |u| status_key(u) }
@@ -33,8 +37,8 @@ module Resque
           end
         end
 
-        # set a status by UUID. <tt>messages</tt> can be any number of strings or hashes
-        # that are merged in order to create a single status.
+        # set a status by UUID. <tt>messages</tt> can be any number of strings
+        # or hashes that are merged in order to create a single status.
         def self.set(uuid, *messages)
           val = Resque::Plugins::State::Hash.new(uuid, *messages)
           redis.set(status_key(uuid), encode(val))
@@ -42,8 +46,8 @@ module Resque
           val
         end
 
-        # clear statuses from redis passing an optional range. See `statuses` for info
-        # about ranges
+        # clear statuses from redis passing an optional range. See `statuses`
+        # for info about ranges
         def self.clear(range_start = nil, range_end = nil)
           status_ids(range_start, range_end).each do |id|
             remove(id)
@@ -81,7 +85,8 @@ module Resque
           redis.zrem(set_key, uuid)
         end
 
-        # Return <tt>num</tt> Resque::Plugins::State::Hash objects in reverse chronological order.
+        # Return <tt>num</tt> Resque::Plugins::State::Hash objects in reverse
+        # chronological order.
         # By default returns the entire set.
         # @param [Numeric] range_start The optional starting range
         # @param [Numeric] range_end The optional ending range
@@ -92,16 +97,18 @@ module Resque
           mget(ids).compact || []
         end
 
-        # Return the <tt>num</tt> most recent status/job UUIDs in reverse chronological order.
+        # Return the <tt>num</tt> most recent status/job UUIDs in reverse
+        # chronological order.
         def self.status_ids(range_start = nil, range_end = nil)
           if range_end && range_start
-            # Because we want a reverse chronological order, we need to get a range starting
-            # by the higest negative number. The ordering is transparent from the API user's
-            # perspective so we need to convert the passed params
+            # Because we want a reverse chronological order, we need to get a
+            # range starting by the higest negative number. The ordering is
+            # transparent from the API user's perspective so we need to convert
+            # the passed params
             (redis.zrevrange(set_key, range_start.abs, (range_end || 1).abs) || [])
           else
-            # Because we want a reverse chronological order, we need to get a range starting
-            # by the higest negative number.
+            # Because we want a reverse chronological order, we need to get a
+            # range starting by the higest negative number.
             redis.zrevrange(set_key, 0, -1) || []
           end
         end
@@ -180,8 +187,25 @@ module Resque
           redis.sismember(pause_key, uuid)
         end
 
-        # The time in seconds that jobs and statuses should expire from Redis (after
-        # the last time they are touched/updated)
+        # Set a lock key to allow jobs to run as singletons. Optional timeout in
+        # seconds
+        def self.lock(key, timeout = 3600)
+          redis.setnx("_lock-#{key}", key)
+          redis.expire("_lock-#{key}", timeout)
+        end
+
+        # Remove a key from the lock list
+        def self.unlock(key)
+          redis.srem("_lock-#{key}", key)
+        end
+
+        # Check whether a key on the wait list
+        def self.locked?(key)
+          redis.sismember("_lock-#{key}", key)
+        end
+
+        # The time in seconds that jobs and statuses should expire from Redis
+        # (after the last time they are touched/updated)
         class << self
           attr_reader :expire_in
         end
@@ -248,10 +272,10 @@ module Resque
         hash_accessor :num
         hash_accessor :total
 
-        # Create a new Resque::Plugins::State::Hash object. If multiple arguments are passed
-        # it is assumed the first argument is the UUID and the rest are status objects.
-        # All arguments are subsequentily merged in order. Strings are assumed to
-        # be messages.
+        # Create a new Resque::Plugins::State::Hash object. If multiple
+        # arguments are passed it is assumed the first argument is the UUID and
+        # the rest are status objects. All arguments are subsequentily merged in
+        # order. Strings are assumed to be messages.
         def initialize(*args)
           super nil
           base_status = {
@@ -266,8 +290,8 @@ module Resque
           replace(status_hash)
         end
 
-        # calculate the % completion of the job based on <tt>status</tt>, <tt>num</tt>
-        # and <tt>total</tt>
+        # calculate the % completion of the job based on <tt>status</tt>,
+        # <tt>num</tt> and <tt>total</tt>
         def pct_complete
           if completed?
             100
@@ -276,16 +300,16 @@ module Resque
           elsif failed?
             0
           else
-            if total.nil?
-              t = 1
-            else t = total
-            end
+            t = if total.nil?
+                  1
+                else total
+                end
             (((num || 0).to_f / t.to_f) * 100).to_i
           end
         end
 
-        # Return the time of the status initialization. If set returns a <tt>Time</tt>
-        # object, otherwise returns nil
+        # Return the time of the status initialization. If set returns a
+        # <tt>Time</tt> object, otherwise returns nil
         def time
           time? ? Time.at(self['time']) : nil
         end
@@ -302,8 +326,8 @@ module Resque
           !failed? && !completed? && !killed?
         end
 
-        # Can the job be paused? failed, completed, paused, and killed jobs can't be
-        # paused, for obvious reasons
+        # Can the job be paused? failed, completed, paused, and killed jobs
+        # can't be paused, for obvious reasons
         def pausable?
           !failed? && !completed? && !killed? && !paused?
         end

data/lib/resque/state.rb

@@ -1,7 +1,9 @@
 require 'resque'
 
+# Resque root module
 module Resque
   autoload :JobWithState, "#{File.dirname(__FILE__)}/job_with_state"
+  # Resque::Plugins root module
   module Plugins
     autoload :State, "#{File.dirname(__FILE__)}/plugins/state"
   end

data/resque-state.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: resque-state 1.0.2 ruby lib
+# stub: resque-state 1.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "resque-state".freeze
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

data/test/test_helper.rb

@@ -11,9 +11,6 @@ require 'resque-state'
 require 'minitest/autorun'
 require 'mocha/setup'
 require 'fakeredis'
-require 'codeclimate-test-reporter'
-
-CodeClimate::TestReporter.start
 
 Resque.redis = Redis.new
 

data/test/test_resque_plugins_state.rb

@@ -8,7 +8,7 @@ class TestResquePluginsStatus < Minitest::Test
 
   describe 'Resque::Plugins::State' do
     before do
-      Resque.redis.flushall
+      Redis.current.flushdb
     end
 
     describe '.create' do

data/test/test_resque_plugins_state_hash.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 class TestResquePluginsStatusHash < Minitest::Test
   describe 'Resque::Plugins::State::Hash' do
     before do
-      Resque.redis.flushall
+      Redis.current.flushdb
       Resque::Plugins::State::Hash.expire_in = nil
       @uuid = Resque::Plugins::State::Hash.create(
         Resque::Plugins::State::Hash.generate_uuid
@@ -223,7 +223,7 @@ class TestResquePluginsStatusHash < Minitest::Test
       end
 
       it 'return an empty array when no statuses are available' do
-        Resque.redis.flushall
+        Redis.current.flushdb
         statuses = Resque::Plugins::State::Hash.statuses
         assert_equal [], statuses
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-state
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Aaron Quint