sidekiq-running 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4ce8b7d274439f6f640e68d61011993c714025b3
4
+ data.tar.gz: d183d45a2fcad08c8ab4c6f5e618f3c5f66afdbe
5
+ SHA512:
6
+ metadata.gz: 6c6e87606e273c7d8ddfe2339da88b171a62479d4dfe0a005854480026535fc6679a13af983b1314e7d0ff9c2fcae45ef79544cd92c9e8549b1e3d3ebaa6fdb1
7
+ data.tar.gz: dee707672729711888c402bfc05c2fa07b991677bc3dd3f24ab3a007694b47bbc616a235c5ab482b1ebae3f577532c62ea5af1417af6acd811ef9302cd00c973
data/.gitignore ADDED
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in sidekiq-running.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 José Tomás Albornoz
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # Sidekiq::Running
2
+
3
+ Small extension to Sidekiq that allows you to see if a job is queued or running.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'sidekiq-running'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ ## Usage
16
+
17
+ Include ``Sidekiq::Running`` in your worker, like this:
18
+ ```ruby
19
+ class HardWorker
20
+ include Sidekiq::Worker
21
+ include Sidekiq::Running
22
+ def perform(name, count)
23
+ # do something
24
+ end
25
+ end
26
+ ```
27
+
28
+ Now, you can run
29
+ ```ruby
30
+ HardWorker.queued?("buy dr.pepper", 10) # => false
31
+ HardWorker.perform_async("buy dr.pepper", 10)
32
+ HardWorker.queued?("buy dr.pepper", 10) # => true
33
+ ```
34
+
35
+ ## Methods Available
36
+ ``Sidekiq::Running`` adds the following class methods to your sidekiq workers:
37
+
38
+ - queued?(*args)
39
+ - running?(*args)
40
+ - queued_or_running?(*args)
41
+ - queue_name
42
+
43
+ ## Contributing
44
+
45
+ 1. Fork it ( https://github.com/eljojo/sidekiq-running/fork )
46
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
47
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
48
+ 4. Push to the branch (`git push origin my-new-feature`)
49
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,5 @@
1
+ module Sidekiq
2
+ module Running
3
+ VERSION = "0.0.1"
4
+ end
5
+ end
@@ -0,0 +1,35 @@
1
+ require "sidekiq/running/version"
2
+
3
+ module Sidekiq
4
+ module Running
5
+ def self.included(base)
6
+ base.extend ClassMethods
7
+ end
8
+
9
+ module ClassMethods
10
+ def queue_name
11
+ sidekiq_options_hash["queue"].to_s || "default"
12
+ end
13
+
14
+ def queued?(*args)
15
+ queue = Sidekiq::Queue.new(queue_name)
16
+ queue.any? do |job|
17
+ job.klass == self.name && job.args == args
18
+ end
19
+ end
20
+
21
+ def running?(*args)
22
+ workers = Sidekiq::Workers.new
23
+ workers.to_a.any? do |worker_name, tid, work|
24
+ payload = work["payload"]
25
+ next unless payload
26
+ payload["queue"] == queue_name and payload["class"] == self.name && payload["args"] == args
27
+ end
28
+ end
29
+
30
+ def queued_or_running?(*args)
31
+ running?(*args) or queued?(*args)
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'sidekiq/running/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "sidekiq-running"
8
+ spec.version = Sidekiq::Running::VERSION
9
+ spec.authors = ["José Tomás Albornoz"]
10
+ spec.email = ["jojo@eljojo.net"]
11
+ spec.summary = %q{Sidekiq extension to check if you have a job queued or running}
12
+ spec.description = %q{Sidekiq extension to check if you have a job queued or running}
13
+ spec.homepage = "https://github.com/eljojo/sidekiq-running"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.6"
22
+ spec.add_development_dependency "rake", "~> 10.2"
23
+ end
metadata ADDED
@@ -0,0 +1,80 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sidekiq-running
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - José Tomás Albornoz
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-05-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.2'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.2'
41
+ description: Sidekiq extension to check if you have a job queued or running
42
+ email:
43
+ - jojo@eljojo.net
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - Gemfile
50
+ - LICENSE.txt
51
+ - README.md
52
+ - Rakefile
53
+ - lib/sidekiq/running.rb
54
+ - lib/sidekiq/running/version.rb
55
+ - sidekiq-running.gemspec
56
+ homepage: https://github.com/eljojo/sidekiq-running
57
+ licenses:
58
+ - MIT
59
+ metadata: {}
60
+ post_install_message:
61
+ rdoc_options: []
62
+ require_paths:
63
+ - lib
64
+ required_ruby_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ required_rubygems_version: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ requirements: []
75
+ rubyforge_project:
76
+ rubygems_version: 2.2.2
77
+ signing_key:
78
+ specification_version: 4
79
+ summary: Sidekiq extension to check if you have a job queued or running
80
+ test_files: []