sidekiq_toolbelt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 246a7e53f443f35c42c3aa9ba268fb48639a3b96
-  data.tar.gz: f432c3ce0c7a73fe272f2a3d2a2a74c51421f731
+  metadata.gz: f190c0a217eed876f4a50fef4716649dc8a05c22
+  data.tar.gz: 0be3b9281a865acee3168f44bc85177ac9b92d11
 SHA512:
-  metadata.gz: f07db119641a5f8a7c0998f9a0ae9bed5ad951fd70d26e837e6ba31fe9bf1afb9523e60630a3ddf054e48cb9b40e87f89a64f54a237e00d63ecfa7573508686d
-  data.tar.gz: 106b528451be4877d690aa568e22ed2bb58d9f65efb18f1e37dcfbca7b2204820661b660d7e6587a0ad71722c0b30928755d3cd31fe66b74638768f07ccb33e9
+  metadata.gz: fa2016431fc89b7b31fb5623554d5990cf69bafdb8ba6c69d726c281114711066af531992fb0bf03fab9a9a57fe4184775af238336a6b941e021e5c8f3762713
+  data.tar.gz: fda8ff482ff4fb2c0ca99ee52f2e69a1050eb2129d6fcb2f720480671710bef6898468273f9925582f2b858e2c63b1deb943ab8133ec677eb07eea7b0fc5c59c

data/README.md

@@ -1,6 +1,4 @@
-# SidekiqToolbelt
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sidekiq_toolbelt`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Sidekiq Toolbelt
 
 ## Installation
 
@@ -20,7 +18,19 @@ Or install it yourself as:
 
 ## Usage
 
-TBD
+This library is meant to be used along with `Sidekiq`, probably from a Rails console.
+
+`SidekiqToolbelt.counts` or `SidekiqToolbelt.counts(queue: :important)` will print job counts.
+
+`SidekiqToolbelt.kill('User::SignupEmail')` or `SidekiqToolbelt.kill('User::SignupEmail', queue: :important)` will kill a job by class.
+
+`SidekiqToolbelt.kill('Net::HTTPForbidden')` or `SidekiqToolbelt.kill('Net::HTTPForbidden', queue: :important)` will kill a job by error.
+
+`SidekiqToolbelt.kill_retries('User::SignupEmail')` will kill a rescheduled job by class.
+
+`SidekiqToolbelt.kill_retries_by_error('Net::HTTPForbidden')` will kill a rescheduled job by error.
+
+`SidekiqToolbelt.clear('User::SignupEmail')` or `SidekiqToolbelt.clear('User::SignupEmail', 'User::SubscriptionJob', queue: :important)` will continuously delete jobs to keep the queue clear.
 
 ## Development
 

data/lib/sidekiq_toolbelt.rb

@@ -13,7 +13,7 @@ module SidekiqToolbelt
         counts[job.klass] += 1
       end
     end
-    
+
     pp counts.sort_by {|k,v| -v}.to_h
   end
 
@@ -41,11 +41,12 @@ module SidekiqToolbelt
     end
   end
 
-  def clear(*jobs)
+  def clear(*jobs, queue: :default)
     loop do
+      # update and reuse #kill?
       Sidekiq::Queue.new(:default).each do |job|
         if jobs.include? job.klass
-          job.delete 
+          job.delete
         end
       end
       puts 'clearing...'

data/lib/sidekiq_toolbelt/version.rb

@@ -1,3 +1,3 @@
 module SidekiqToolbelt
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sidekiq_toolbelt.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Scott Albertson"]
   spec.email         = ["ascottalbertson@gmail.com"]
 
-  spec.summary       = %q{TBD}
-  spec.description   = %q{TBD}
+  spec.summary       = %q{Sidekiq helpers for console}
+  spec.description   = %q{A collection of methods to monitor, delete and clear Sidekiq jobs.}
   spec.homepage      = "https://github.com/salbertson/sidekiq_toolbelt"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_toolbelt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Scott Albertson
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: TBD
+description: A collection of methods to monitor, delete and clear Sidekiq jobs.
 email:
 - ascottalbertson@gmail.com
 executables: []
@@ -93,5 +93,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: TBD
+summary: Sidekiq helpers for console
 test_files: []