simple_throttle 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88bc1f488ffad8621894918d48bbde5df0c68ef498ddaaf359d91f81914a27c5
-  data.tar.gz: c219a0b2a6b66e1e5427bdab8260dcfc4f0121618fd8c340a3e892f92dad1192
+  metadata.gz: cd25dd96b13df27a165952bee5a5ff4fd6731c164c88aaa586e2c990a47650d3
+  data.tar.gz: 4298862682b63ef05bebf1e70abb62bf1dad5e7c3a23835e4c9ad94ed38c8cd5
 SHA512:
-  metadata.gz: 9e30ae0a0a4dbfb09778fc1cfcd02d3376b020fc83d4166a2ab6066725a4c2c0e8680f38ac26c127b6b0952ed4558ff9c3e82e0301dda0dc4db9bf831cb8c383
-  data.tar.gz: 5cfb1b4e72a4b1014a131b50ddb028e41289b102016b54ba2a5eef4c03d2f7a5edd66b21c84924be54df1e01796d0c1c2c963a7cf8072bfc1ca7951bab983a47
+  metadata.gz: 52eda43dd29e5c4ceadb806c0a132abeb30737365aea897a33815e7aa40ca518ea97ed4506c3b612e4729f08e9e3534877dd9f3d6890925cdb8bf7afdc4a5e70
+  data.tar.gz: 839f5e758fe348fa974dd3b8e3b2d37827002ab39db178058095344ed90c94b25aeb6a477d93ac042a9d291bf3afd8bbf13672b60a91233fa09cb13861a94bf1

data/CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.4
+- Fix wait_time method to match the documentation from [bc-swoop](https://github.com/bc-swoop)
+
 ## 1.0.3
 
 ### Changed

data/README.md

@@ -60,7 +60,7 @@ $ gem install simple_throttle
 
 ## Contributing
 
-Open a pull request on GitHub.
+Fork the repository and open a pull request on GitHub.
 
 Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
 

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/simple_throttle.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "redis"
+
 # Create a simple throttle that can be used to limit the number of request for a resouce
 # per time period. These objects are thread safe.
 class SimpleThrottle
@@ -41,7 +42,15 @@ class SimpleThrottle
 
   class << self
     # Add a global throttle that can be referenced later with the [] method.
-    def add(name, limit:, ttl:, redis: nil)
+    # This can be used to configure global throttles that you want to setup once
+    # and then use in multiple places.
+    #
+    # @param name [String] unique name for the throttle
+    # @param ttl [Numeric] number of seconds that the throttle will remain active
+    # @param limit [Integer] number of allowed requests within the throttle ttl
+    # @param redis [Redis, Proc] Redis instance to use or a Proc that yields a Redos instance
+    # @return [void]
+    def add(name, ttl:, limit:, redis: nil)
       @lock.synchronize do
         @throttles ||= {}
         @throttles[name.to_s] = new(name, limit: limit, ttl: ttl, redis: redis)
@@ -49,6 +58,9 @@ class SimpleThrottle
     end
 
     # Returns a globally defined throttle with the specfied name.
+    #
+    # @param name [String, Symbol] name of the throttle
+    # @return [SimpleThrottle]
     def [](name)
       if defined?(@throttles) && @throttles
         @throttles[name.to_s]
@@ -60,11 +72,17 @@ class SimpleThrottle
     # it will be invoked at runtime to get the instance. Use this method if your Redis instance
     # isn't constant (for example if you're in a forking environment and re-initialize connections
     # on fork)
+    #
+    # @param client [Redis, Proc]
+    # @yieldreturn [Redis]
+    # @return [void]
     def set_redis(client = nil, &block)
       @redis_client = (client || block)
     end
 
     # Return the Redis instance where the throttles are stored.
+    #
+    # @return [Redis]
     def redis
       @redis_client ||= Redis.new
       if @redis_client.is_a?(Proc)
@@ -93,11 +111,12 @@ class SimpleThrottle
 
   attr_reader :name, :limit, :ttl
 
-  # Create a new throttle
+  # Create a new throttle.
+  #
   # @param name [String] unique name for the throttle
   # @param ttl [Numeric] number of seconds that the throttle will remain active
   # @param limit [Integer] number of allowed requests within the throttle ttl
-  # @param redis [Redis] Redis client to use
+  # @param redis [Redis, Proc] Redis instance to use or a Proc that yields a Redos instance
   def initialize(name, ttl:, limit:, redis: nil)
     @name = name.to_s
     @name = name.dup.freeze unless name.frozen?
@@ -108,17 +127,23 @@ class SimpleThrottle
 
   # Returns true if the limit for the throttle has not been reached yet. This method
   # will also track the throttled resource as having been invoked on each call.
+  #
+  # @return [Boolean]
   def allowed!
     size = current_size(true)
     size < limit
   end
 
   # Reset a throttle back to zero.
+  #
+  # @return [void]
   def reset!
     redis_client.del(redis_key)
   end
 
   # Peek at the current number for throttled calls being tracked.
+  #
+  # @return [Integer]
   def peek
     current_size(false)
   end
@@ -126,6 +151,8 @@ class SimpleThrottle
   # Returns when the next resource call should be allowed. Note that this doesn't guarantee that
   # calling allow! will return true if the wait time is zero since other processes or threads can
   # claim the resource.
+  #
+  # @return [Float]
   def wait_time
     if peek < limit
       0.0
@@ -133,7 +160,7 @@ class SimpleThrottle
       first = redis_client.lindex(redis_key, 0).to_f / 1000.0
       delta = Time.now.to_f - first
       delta = 0.0 if delta < 0
-      delta
+      ttl - delta
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_throttle
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - We Heart It
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis