resque-queue-status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15aaeda470d56fd3be4c882cebdc13202142e1249912d370cec777281570e5d2
+  data.tar.gz: 320b4f768f732aaceba36456178ae317ab31a037e9c5d761c0c0c1535fb7e0b7
+SHA512:
+  metadata.gz: 85b0dd1fc916c71297b486ff511073aceaf5ec94ce9448588cf3340e2c401c82ed10c92be673483e0384245bc1162a3f5bacf83c2b31c478a0640c79df56e5ab
+  data.tar.gz: 58bc568242adbc26f1f4c39e6db8d262795ef0b3606a1059305b641914e47d7279e837c46ef0bde441fa1001aa0ba90f7c0850aadbd9dd099a78180a496d2f6b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in resque-queue-status.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ikuto
+
+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,48 @@
+# Resque::Queue::Status
+
+Resque Plugin adding simple queue statuses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-queue-status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-queue-status
+
+## Usage
+
+Extend Resque::Plugins::Queue::Status into your Resque Job.
+You can specify your own key for your queues and check the status.
+
+```
+class ExampleJob
+ extend Resque::Plugins::Queue::Status
+
+ def self.perform()
+  puts 'hoge'
+ end
+
+end
+
+Resque.enqueue(ExampleJob, queue_status_key: 'hoge')
+ExampleJob.current_queue_status('hoge')
+```
+
+Statuses are `IN_PROGESS`, `COMPLETED` and `FAILED`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ikuto0608/resque-queue-status.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/queue/status"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resque/plugins/queue/status.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'resque/plugins/queue/status/version'
+
+module Resque
+  module Plugins
+    module Queue
+      # Resque::Plugins::Queue::Status.
+      # It provides adding simple queue statuses for your jobs.
+      # You can specify your own key for your queues and check the status.
+      #
+      # You can use it doing extend Resque::Plugins::Queue::Status
+      #
+      # For example
+      #
+      #       class ExampleJob
+      #         extend Resque::Plugins::Queue::Status
+      #
+      #         def self.perform()
+      #           puts 'hoge'
+      #         end
+      #
+      #       end
+      #
+      #       Resque.enqueue(ExampleJob, queue_status_key: 'hoge')
+      #       ExampleJob.current_queue_status('hoge')
+      #
+      # The queue status key lasts 24 hours to expire
+      #
+      module Status
+        IN_PROGESS = 'IN_PROGESS'
+        COMPLETED = 'COMPLETED'
+        FAILED = 'FAILED'
+        STATUSES = [IN_PROGESS, COMPLETED, FAILED].freeze
+
+        def before_enqueue_queue_status(args)
+          _set_status(
+            queue_status_key: _queue_status_key(args),
+            status: IN_PROGESS
+          )
+        end
+
+        def after_perform_queue_status(args)
+          _set_status(
+            queue_status_key: _queue_status_key(args),
+            status: COMPLETED
+          )
+        end
+
+        def on_failure_queue_status(err, args)
+          _set_status(
+            queue_status_key: _queue_status_key(args),
+            status: FAILED,
+            meta: err.to_yaml
+          )
+        end
+
+        def current_queue_status(queue_status_key)
+          JSON.parse(
+            Resque.redis.get(_namespaced_queue_status(queue_status_key)) || '{}',
+            symbolize_names: true
+          )
+        end
+
+        def all_queue_statuses
+          Resque.redis.keys("#{_prefix}:*")
+        end
+
+        def clear_all_queue_statuses
+          Resque.redis.del(*all_queue_statuses) unless all_queue_statuses.empty?
+        end
+
+        def _queue_status_key(args)
+          args['queue_status_key'] || args[:queue_status_key]
+        end
+
+        def _namespaced_queue_status(queue_status_key)
+          return if queue_status_key.nil?
+
+          queue_status_key_name = Resque::Job.decode(
+            Resque::Job.encode(queue_status_key)
+          )
+          "#{_prefix}:#{queue_status_key_name}"
+        end
+
+        def _set_status(args)
+          queue_status = _namespaced_queue_status(args[:queue_status_key])
+          return if queue_status.nil?
+
+          Resque.redis.set(
+            queue_status,
+            args.slice(:status, :meta).to_json,
+            ex: 24 * 60 * 60
+          )
+
+          queue_status
+        end
+
+        def _prefix
+          "queuestatus:#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/queue/status/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Resque
+  module Plugins
+    module Queue
+      module Status
+        VERSION = '0.1.0'
+      end
+    end
+  end
+end

data/resque-queue-status.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "resque/plugins/queue/status/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-queue-status"
+  spec.version       = Resque::Plugins::Queue::Status::VERSION
+  spec.authors       = ["ikuto"]
+  spec.email         = ["ikuto0608@me.com"]
+
+  spec.summary       = %q(Resque Plugin adding simple queue statuses.)
+  spec.description   = %q(Resque Plugin adding simple queue statuses.)
+  spec.homepage      = "http://github.com/ikuto0608/resque-queue-status"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "resque"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: resque-queue-status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ikuto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Resque Plugin adding simple queue statuses.
+email:
+- ikuto0608@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque/plugins/queue/status.rb
+- lib/resque/plugins/queue/status/version.rb
+- resque-queue-status.gemspec
+homepage: http://github.com/ikuto0608/resque-queue-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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Resque Plugin adding simple queue statuses.
+test_files: []