resque-stagger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2750c1757a945716e79e0f58ad4f32f15f8d20f5
-  data.tar.gz: 4b6c3d32a6721d4fa43cce4909f4b38ac79d3cf5
+SHA256:
+  metadata.gz: 53ae0e00d2158526b7b4fe759c68de683ef0d3c7d1f93db8723e36c470f92e21
+  data.tar.gz: 02c043493d56f334c2848916a411383ab6bf1cad5e4b66c7cab75386f7cf45a0
 SHA512:
-  metadata.gz: b3cff4560f6019f023f0caab822e1b2700d90c33fe8221914c3dcdcb27758ff024a73fe0914e79278ac8e5e3a350bd37500c262650b602663ad5f1ba60b30cb0
-  data.tar.gz: 85ab53b25b74eb50856c2cb97060aa565891b841c6cb8f4eac14b0f990c1fac22570a6eb73529cd4c22b121b35d5843fa1bc380a8a833e3e5fa1c0b65402a132
+  metadata.gz: 15ecf8e1b4d1e84d0a5cd796317e3e1220b7441ff63e27ec37f5a14c486cc8ec676b2591177dc2c50f08eacbb1202f95b598c6d21b9e87d19f8319d936e656b2
+  data.tar.gz: 728cd6efa8a97aa900e280fa2f939705bf711046fc1f0bef6a7157def42da8e6a6c46940573ad99280be240d0ec73f01951b7a6e67fa67db223268f2ed71bc2b

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.idea

data/.idea/resque-stagger.iml

@@ -9,8 +9,28 @@
       <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
     </content>
-    <orderEntry type="inheritedJdk" />
+    <orderEntry type="jdk" jdkName="Remote: ruby-2.3.8-p459" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.32, ruby-2.6.3-p62) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.2, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="et-orbi (v1.2.7, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fugit (v1.8.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mono_logger (v1.1.1, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.15.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mustermann (v2.0.2, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="raabro (v1.4.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.4, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack-protection (v2.2.4, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="redis (v4.4.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="redis-namespace (v1.6.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="resque (v2.0.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="resque-scheduler (v4.4.0, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby2_keywords (v0.0.5, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rufus-scheduler (v3.8.2, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sinatra (v2.2.4, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tilt (v2.0.11, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v1.2.10, Remote: ruby-2.3.8-p459) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="vegas (v0.1.11, Remote: ruby-2.3.8-p459) [gem]" level="application" />
   </component>
 </module>

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Parikshit Singh
+
+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

@@ -1,8 +1,6 @@
-# Resque::Stagger
+# Resque Stagger
 
-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/resque/stagger`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Resque plugin for adding a stagger effect to enqueuing jobs.
 
 ## Installation
 
@@ -14,7 +12,7 @@ gem 'resque-stagger'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,23 +20,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+You can use `Resque::Staggered` to enqueue jobs with a stagger effect.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+require "resque/stagger"
+
+staggered = Resque::Staggered.new(per_second: 2, start_from: Time.now + 5.seconds, queue: :low)
+
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 1.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 1.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 2.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 2.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 3.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 3.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 4.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 4.second
+staggered.enqueue(MyJob, "arg1", "arg2") # This will be enqueued at Time.now + 5.seconds + 5.second
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
 
-## Contributing
+The Staggered class takes three optional parameters: :per_second,  :start_from and :queue.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resque-stagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+> **:per_second** is the number of jobs to enqueue per second. The default value is nil, which means no limit on the number of jobs to enqueue per second.
 
-## License
+> **:start_from** is the starting time for enqueuing jobs. The default value is Time.current.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+> **:queue** is the queue you want to enqueue the staggered job at (when its time comes). Default value of queue is `nil` which is based on the assumption that the job class will be defining this queue explicitly and there is no need to give the queue name separately.
 
-## Code of Conduct
+## Contributing
 
-Everyone interacting in the Resque::Stagger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/resque-stagger/blob/master/CODE_OF_CONDUCT.md).
-# resque-stagger
+Bug reports and pull requests are welcome on GitHub at https://github.com/parikshit223933/resque-stagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

data/lib/resque/stagger/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module Stagger
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/resque/stagger.rb

@@ -1,36 +1,72 @@
 require "resque/stagger/version"
 
+# The Resque module contains the Stagger module.
 module Resque
   module Stagger
+    # The Staggered class is used to enqueue jobs with a stagger effect.
     class Staggered
+      # Initializes the Staggered class with given options.
+      #
+      # @param options [Hash] the options for the stagger effect.
+      # @option options [Time] :start_from starting time for enqueuing jobs.
+      # @option options [Integer] :per_second number of jobs to enqueue per second.
+      # @option options [String] :queue name of the queue to enqueue jobs in.
+      #
+      # @return [void]
       def initialize(**options)
         @options = options
       end
 
+      # Enqueues the given job with a stagger effect.
+      #
+      # @param klass [Class] the job class to be enqueued.
+      # @param args [Array] the arguments for the job.
+      #
+      # @return [void]
       def enqueue(klass, *args)
-        ::Resque.enqueue_at(current_enqueue_at, klass, *args)
+        if queue.present?
+          ::Resque.enqueue_at_with_queue(queue, current_enqueue_at, klass, *args)
+        else
+          ::Resque.enqueue_at(current_enqueue_at, klass, *args)
+        end
       end
 
       private
 
+      # Calculates the time at which the job should be enqueued.
+      #
+      # @return [Time, ActiveSupport::Duration] the enqueue time for the job.
       def current_enqueue_at
         return starting_from if per_second.to_i.zero?
-        return @last_enqueued_at = starting_from if @last_enqueued_at.blank?
+        return @last_enqueued_at = starting_from if @last_enqueued_at.nil?
 
         @enqueued_last_second = @enqueued_last_second.to_i + 1
-        return @last_enqueued_at if @enqueued_last_second < per_second
+        return @last_enqueued_at if @enqueued_last_second < per_second.to_i
 
         @enqueued_last_second = 0
         @last_enqueued_at += 1.second
       end
 
+      # Gets the starting time for enqueuing jobs.
+      #
+      # @return [Time] the starting time for enqueuing jobs.
       def starting_from
         @starting_from ||= @options[:start_from] || Time.current
       end
 
+      # Gets the number of jobs to enqueue per second.
+      #
+      # @return [Integer, nil] the number of jobs to enqueue per second.
       def per_second
         @options[:per_second] || nil
       end
+
+      # Returns the name of the queue to enqueue jobs in.
+      #
+      # @return [String, nil] the name of the queue, or nil if not specified.
+      def queue
+        @options[:queue] || nil
+      end
     end
   end
 end

data/resque-stagger.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/parikshit223933/resque-stagger"
-  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-stagger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Parikshit Singh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,7 +113,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/parikshit223933/resque-stagger
   source_code_uri: https://github.com/parikshit223933/resque-stagger
-  changelog_uri: 'TODO: Put your gem''s CHANGELOG.md URL here.'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -128,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: This will stagger your resque jobs over a configurable duration rather then