simple_throttle 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47859d64b667fe3e43c8a98ecbce2fa305177530a5d625ed0bd38a500875d268
-  data.tar.gz: 3c0df333efeec1abc8487328a2d131a9ffc2c87273fb5f0ec4048bc340ba1d55
+  metadata.gz: 6777d3382abb6c7e07c503e56676a8fe62be43611b2c623ac18f89928708572e
+  data.tar.gz: da8f2432ec4bc9dcf68e42faaf6213d662379c3ded9dfb16c1eb8c2cd27cb62c
 SHA512:
-  metadata.gz: 88fb81aaa2ac35d7ae5932ccded080c05fe3dd718bcfa9d73b93e8cfd3eb1706b4b5da42b02a06bcd64c861de6f3c98df9bba6005d1b104881b0d5a91f111d06
-  data.tar.gz: b8a94b2c2a24b7c88266a70f052a93a0a6a0fac5b48842e2fd89e56200ebf72c0229defca71ee775cc4a72810a5d4c9c8ee4feac37ab8281d8e67a0a924bf311
+  metadata.gz: f90008dc9debdfb8e206d25f112c0e312c4c27060256464eba6b175aefb9b5be063bbcdfb1188bbcaab05caedb6f1197d28d7b4a5ee3b40819692e4d57e9642a
+  data.tar.gz: 31326e2b2ab31f4fbccf8dbd6fb7d0455acdd1e745da7d90ea77f526f320fef4d77c94cc98dffc03ce9d76f4c3fc7ed167aa5b9bd72761dfc0463296b7424459

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.1.1
+
+### Fixed
+
+- Fixed `increment!` method to return the correct value after removing expired requests rather than the raw count from Redis.
+
 ## 1.1.0
 
 ### Added

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/simple_throttle.rb

@@ -17,9 +17,10 @@ class SimpleThrottle
     local now = ARGV[3]
     local pause_to_recover = tonumber(ARGV[4])
     local amount = tonumber(ARGV[5])
+    local cleanup = tonumber(ARGV[6])
 
     local size = redis.call('llen', list_key)
-    if size >= limit then
+    if size >= limit or (cleanup > 0 and size > 0) then
       local expired = tonumber(now) - ttl
       while size > 0 do
         local t = redis.call('lpop', list_key)
@@ -152,7 +153,7 @@ class SimpleThrottle
   #
   # @return [Boolean]
   def allowed!
-    size = increment!
+    size = add_request(1, false)
     size <= limit
   end
 
@@ -163,15 +164,7 @@ class SimpleThrottle
   # @param amount [Integer] amount to increment the throttle by
   # @return [Integer]
   def increment!(amount = 1)
-    pause_to_recover_arg = (@pause_to_recover ? 1 : 0)
-    time_ms = (Time.now.to_f * 1000).round
-    ttl_ms = (ttl * 1000).ceil
-    self.class.send(
-      :execute_lua_script,
-      redis: redis_client,
-      keys: [redis_key],
-      args: [limit, ttl_ms, time_ms, pause_to_recover_arg, amount]
-    )
+    add_request(amount, true)
   end
 
   # Reset a throttle back to zero.
@@ -219,4 +212,16 @@ class SimpleThrottle
   def redis_key
     "simple_throttle.#{name}"
   end
+
+  def add_request(amount, cleanup)
+    pause_to_recover_arg = (@pause_to_recover ? 1 : 0)
+    time_ms = (Time.now.to_f * 1000).round
+    ttl_ms = (ttl * 1000).ceil
+    self.class.send(
+      :execute_lua_script,
+      redis: redis_client,
+      keys: [redis_key],
+      args: [limit, ttl_ms, time_ms, pause_to_recover_arg, amount, (cleanup ? 1 : 0)]
+    )
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_throttle
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis