praroter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a107a6850338e77ecac23ff79c3ec477fbdf6615cb6b58a705e2f575752d2493
-  data.tar.gz: 595c3f911778b4fd1a8a6dd64da6e8c7b0185db0c3ca6fc34bfc3b6b4926f719
+  metadata.gz: a14e168451294700f7c71bed654256c51bcf6742f186f8201f9aebe7a1a6e3e5
+  data.tar.gz: 5d1995a758edad1c5f054bf665f101fa85ba00bb34eb729415eaf4a7a5f13c1e
 SHA512:
-  metadata.gz: 6bb75c4e204bb148c9f7928689c3bf7c0d5c8fb356820a34a6a0160fd7f97606914ae73b561fa9ec3bdb5d1862028ce778e01e5e8145e5f7d7bd1f9eb1d11f72
-  data.tar.gz: 99192564d7291ede39f07d5d7ee8c0f8c780c37f3faa45726ab141f8987445d5fa8b6c1eeb346cddb29de5e13e6bd241151d5080e26d3135a8a78a1e2f83a463
+  metadata.gz: bb3c8fb96ff6f5fdec4fe33eff582ba3db6be91caf2714e28f6ba3b4fb79dccc7dbece841a82de1c2becf507c65124cea12257bbebf7ef856cd4fdf261cef725
+  data.tar.gz: 4b242a9abeccf2844cdeba9a0c939f5846255db810f7cd14bafaf05eafebbf5e70f6b021d83683ca92be3e8205b796721ee1f2017990288c8a181c71e5cddfa8

data/README.md

@@ -72,6 +72,7 @@ To capture that exception, add this to the controller:
 
 ```ruby
 rescue_from Praroter::Throttled do |e|
+  response.set_header('X-Ratelimit-Cost', e.bucket_state.drained)
   response.set_header('X-Ratelimit-Level', e.bucket_state.level)
   response.set_header('X-Ratelimit-Capacity', e.bucket_state.capacity)
   response.set_header('X-Ratelimit-Retry-After', e.retry_in_seconds)
@@ -140,7 +141,8 @@ def index
   sleep(2.242)
 end
 
-rescue_from Praroter::FillyBucket::Throttled do |e|
+rescue_from Praroter::Throttled do |e|
+  response.set_header('X-Ratelimit-Cost', e.bucket_state.drained)
   response.set_header('X-Ratelimit-Level', e.bucket_state.level)
   response.set_header('X-Ratelimit-Capacity', e.bucket_state.capacity)
   response.set_header('X-Ratelimit-Retry-After', e.retry_in_seconds)
@@ -159,6 +161,7 @@ def api_ratelimit
   bucket_state = ratelimit_bucket.drain_block do
     yield
   end
+  response.set_header('X-Ratelimit-Cost', bucket_state.drained)
   response.set_header('X-Ratelimit-Level', bucket_state.level)
   response.set_header('X-Ratelimit-Capacity', bucket_state.capacity)
 end

data/lib/praroter/filly_bucket/bucket.rb

@@ -0,0 +1,57 @@
+module Praroter
+  module FillyBucket
+
+    class Bucket
+      attr_reader :key, :fill_rate, :capacity
+
+      def initialize(key, fill_rate, capacity, creator)
+        @key = key
+        @fill_rate = fill_rate
+        @capacity = capacity
+        @creator = creator
+      end
+
+      def state
+        @creator.run_lua_bucket_script(self, 0)
+      end
+
+      def empty?
+        state.empty?
+      end
+
+      def full?
+        state.full?
+      end
+
+      def throttle!
+        bucket_state = state
+        if bucket_state.empty?
+          remaining_block_time = ((bucket_state.capacity - bucket_state.level).abs / bucket_state.fill_rate) + 3
+          raise Praroter::Throttled.new(bucket_state, remaining_block_time)
+        end
+        bucket_state
+      end
+
+      def drain(amount)
+        raise ArgumentError, "drain amount must be positive" if amount < 0
+        @creator.run_lua_bucket_script(self, amount)
+      end
+
+      def drain_block
+        work_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+        work_end = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        drain(((work_end - work_start) * 1000).to_i)
+      end
+
+      def level_key
+        "filly_bucket.#{key}.bucket_level"
+      end
+
+      def last_updated_key
+        "filly_bucket.#{key}.last_updated"
+      end
+    end
+
+  end
+end

data/lib/praroter/filly_bucket/bucket_state.rb

@@ -0,0 +1,15 @@
+module Praroter
+  module FillyBucket
+
+    class BucketState < Struct.new(:level, :capacity, :fill_rate, :drained)
+      def empty?
+        level <= 0
+      end
+
+      def full?
+        level >= capacity
+      end
+    end
+
+  end
+end

data/lib/praroter/{filly_bucket.rb → filly_bucket/creator.rb}

@@ -1,69 +1,6 @@
 module Praroter
-
   module FillyBucket
 
-    class BucketState < Struct.new(:level, :capacity, :fill_rate)
-      def empty?
-        level <= 0
-      end
-
-      def full?
-        level >= capacity
-      end
-    end
-
-    class Bucket
-      attr_reader :key, :fill_rate, :capacity
-
-      def initialize(key, fill_rate, capacity, creator)
-        @key = key
-        @fill_rate = fill_rate
-        @capacity = capacity
-        @creator = creator
-      end
-
-      def state
-        @creator.run_lua_bucket_script(self, 0)
-      end
-
-      def empty?
-        state.empty?
-      end
-
-      def full?
-        state.full?
-      end
-
-      def throttle!
-        bucket_state = state
-        if bucket_state.empty?
-          remaining_block_time = ((bucket_state.capacity - bucket_state.level).abs / bucket_state.fill_rate) + 3
-          raise Praroter::Throttled.new(bucket_state, remaining_block_time)
-        end
-        bucket_state
-      end
-
-      def drain(amount)
-        raise ArgumentError, "drain amount must be positive" if amount < 0
-        @creator.run_lua_bucket_script(self, amount)
-      end
-
-      def drain_block
-        work_start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        yield
-        work_end = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        drain(((work_end - work_start) * 1000).to_i)
-      end
-
-      def level_key
-        "filly_bucket.#{key}.bucket_level"
-      end
-
-      def last_updated_key
-        "filly_bucket.#{key}.last_updated"
-      end
-    end
-
     class Creator
       LUA_SCRIPT_CODE = File.read(File.join(__dir__, "filly_bucket.lua"))
       LUA_SCRIPT_HASH = Digest::SHA1.hexdigest(LUA_SCRIPT_CODE)
@@ -86,7 +23,7 @@ module Praroter
               keys: [bucket.level_key, bucket.last_updated_key],
               argv: [bucket.capacity, bucket.fill_rate, amount]
             )
-            BucketState.new(new_bucket_level, bucket_capacity, fill_rate)
+            BucketState.new(new_bucket_level, bucket_capacity, fill_rate, amount)
           rescue Redis::CommandError => e
             if e.message.include? "NOSCRIPT"
               # The Redis server has never seen this script before. Needs to run only once in the entire lifetime
@@ -103,5 +40,4 @@ module Praroter
     end
 
   end
-
 end

data/lib/praroter/version.rb

@@ -1,3 +1,3 @@
 module Praroter
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praroter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kasper Grubbe
@@ -176,8 +176,10 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/praroter.rb
-- lib/praroter/filly_bucket.lua
-- lib/praroter/filly_bucket.rb
+- lib/praroter/filly_bucket/bucket.rb
+- lib/praroter/filly_bucket/bucket_state.rb
+- lib/praroter/filly_bucket/creator.rb
+- lib/praroter/filly_bucket/filly_bucket.lua
 - lib/praroter/null_logger.rb
 - lib/praroter/null_pool.rb
 - lib/praroter/throttled.rb