activejob-status 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91270803a5d6aedcc62a941ff58924eacfc41b8c
+  data.tar.gz: a56e19cb1959a274fa10aff9094f02b60ab10e9a
+SHA512:
+  metadata.gz: 75d8b48d03c42bc15d7c608d11bd304109215f020cde362c19708c3325b8f3789169c605c2b73ccab3c981ad950e9faa43aee0625c7d42f3a6060c5abd41d5e2
+  data.tar.gz: 2fa52788bbbab62b350ba48c10ac2fc5cc16fc11c68ef5149292fb2fcd3319f96886ec025888cea628fcd0c74f56e641a7b100db7f8db86889e6566a76bfffeb

data/lib/activejob-status.rb

@@ -0,0 +1,42 @@
+require 'activejob-status/storage'
+require 'activejob-status/status'
+require 'activejob-status/progress'
+
+module ActiveJob::Status
+  extend ActiveSupport::Concern
+  DEFAULT_EXPIRY = 60 * 30
+
+  included do
+    before_enqueue {|job| job.status.update(status: :queued) }
+    before_perform {|job| job.status.update(status: :working) }
+    after_perform  {|job| job.status.update(status: :completed) }
+
+    rescue_from(Exception) do |e|
+      self.status.update(status: :failed)
+      raise e
+    end
+  end
+
+  def status
+    @status ||= Status.new(self)
+  end
+
+  def progress
+    @progress ||= Progress.new(self)
+  end
+
+  class << self
+    def store= store
+      store = ActiveSupport::Cache.lookup_store(store) if store.is_a?(Symbol)
+      @@store = store
+    end
+
+    def store
+      @@store ||= (defined?(Rails) && Rails.cache)
+    end
+
+    def get(id)
+      Status.new(id)
+    end
+  end
+end

data/lib/activejob-status/progress.rb

@@ -0,0 +1,44 @@
+module ActiveJob::Status
+  class Progress
+    delegate :[], :to_s, :inspect, to: :hash
+
+    def initialize(job)
+      @job      = job
+      @total    = 100
+      @progress = 0
+    end
+
+    def total=(num)
+      @total = num
+      update
+    end
+
+    def progress=(num)
+      update { num }
+    end
+
+    def increment(num=1)
+      update { @progress + num }
+    end
+
+    def decrement(num=1)
+      update { @progress - num }
+    end
+
+    def finish
+      update { @total }
+    end
+
+  private
+
+    def update
+      @progress = yield if block_given?
+      @job.status.update(hash)
+      self
+    end
+
+    def hash
+      { progress: @progress, total: @total }
+    end
+  end
+end

data/lib/activejob-status/status.rb

@@ -0,0 +1,46 @@
+module ActiveJob::Status
+  class Status
+    delegate :[], :to_s, :inspect, to: :read
+    delegate :queued?, :working?, :completed?, to: :status_inquiry
+
+    def initialize(job)
+      @job = job
+    end
+
+    def []= key, value
+      update(key => value)
+    end
+
+    def read
+      Storage.read(@job)
+    end
+
+    def update(message)
+      Storage.update(@job, message)
+    end
+
+    def delete
+      Storage.delete(@job)
+    end
+
+    def job_id
+      Storage.job_id(@job)
+    end
+
+    def status
+      read[:status]
+    end
+
+    def progress
+      read[:progress].to_f / read[:total].to_f
+    end
+
+    def present?
+      read.present?
+    end
+
+    def status_inquiry
+      status.to_s.inquiry
+    end
+  end
+end

data/lib/activejob-status/storage.rb

@@ -0,0 +1,33 @@
+module ActiveJob::Status
+  module Storage
+    class << self
+      def store
+        ActiveJob::Status.store
+      end
+
+      def job_id(job)
+        job.is_a?(String) ? job : job.job_id
+      end
+
+      def key(job)
+        "activejob:status:#{job_id(job)}"
+      end
+
+      def read(job)
+        store.read(key(job)) || {}
+      end
+
+      def write(job, message)
+        store.write(key(job), message, expires_in: DEFAULT_EXPIRY)
+      end
+
+      def update(job, message)
+        write(job, read(job).merge(message))
+      end
+
+      def delete(job)
+        store.delete(key(job))
+      end
+    end
+  end
+end

data/lib/activejob-status/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Status
+    VERSION = '0.1.1'
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: activejob-status
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Savater Sebastien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Monitor jobs created by ActiveJob, check their status and progress
+email:
+- savater.sebastien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activejob-status.rb
+- lib/activejob-status/progress.rb
+- lib/activejob-status/status.rb
+- lib/activejob-status/storage.rb
+- lib/activejob-status/version.rb
+homepage: http://github.com/inkstak/activejob-status
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Monitor your jobs
+test_files: []