faktory_worker_ruby 0.8.0 → 1.0.3

data/lib/faktory/tracking.rb

@@ -0,0 +1,41 @@
+module Faktory
+  module Trackable
+
+    ##
+    # Tracking allows a long-running Faktory job to report its progress:
+    #
+    #   def perform(...)
+    #     track_progress(10, "Calculating values")
+    #     # do some work
+    #
+    #     track_progress(20, "Sending emails")
+    #     # do some more work
+    #
+    #     track_progress(20, "Sending emails", reserve_until: 10.minutes.from_now)
+    #     # do some more work
+    #   end
+    #
+    # Note:
+    # 1. jobs should be small and fine-grained (and so fast) if possible.
+    # 2. tracking is useful for long-running jobs, tracking a fast job will only add overhead
+    # 3. tracking only works with a single job, use Batches to monitor a group of jobs
+    # 4. reserve_until allows a job to dynamically extend its reservation so it is not garbage collected by Faktory while running
+    # 5. you can only reserve up to 24 hours.
+    #
+    def track_progress(percent, desc=nil, reserve_until:nil)
+      hash = { 'jid' => jid, 'percent' => percent.to_i, 'desc' => desc }
+      hash["reserve_until"] = convert(reserve_until) if reserve_until
+      Faktory.server {|c| c.set_track(hash) }
+    end
+
+    private
+
+    def convert(ts)
+      raise ArgumentError, "Timestamp in the past: #{ts}" if Time.now > ts
+      raise ArgumentError, "Timestamp too far in the future: #{ts}" if (Time.now + 86400) < ts
+
+      tsf = ts.to_f
+      Time.at(tsf).utc.iso8601
+    end
+  end
+end

data/lib/faktory/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Faktory
-  VERSION = "0.8.0"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Mike Perham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -19,7 +19,7 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
         version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
 description: Ruby worker for Faktory.
 email:
 - mike@contribsys.com
@@ -106,21 +106,26 @@ files:
 - faktory_worker_ruby.gemspec
 - lib/active_job/queue_adapters/faktory_adapter.rb
 - lib/faktory.rb
+- lib/faktory/batch.rb
 - lib/faktory/cli.rb
 - lib/faktory/client.rb
 - lib/faktory/connection.rb
 - lib/faktory/exception_handler.rb
 - lib/faktory/fetch.rb
+- lib/faktory/io.rb
 - lib/faktory/job.rb
 - lib/faktory/job_logger.rb
 - lib/faktory/launcher.rb
 - lib/faktory/logging.rb
 - lib/faktory/manager.rb
+- lib/faktory/middleware/batch.rb
 - lib/faktory/middleware/chain.rb
 - lib/faktory/middleware/i18n.rb
+- lib/faktory/mutate.rb
 - lib/faktory/processor.rb
 - lib/faktory/rails.rb
 - lib/faktory/testing.rb
+- lib/faktory/tracking.rb
 - lib/faktory/util.rb
 - lib/faktory/version.rb
 - lib/faktory_worker_ruby.rb
@@ -128,7 +133,7 @@ homepage: https://github.com/contribsys/faktory_worker_ruby
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,16 +141,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.8
+signing_key:
 specification_version: 4
 summary: Ruby worker for Faktory
 test_files: []