prorate 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db453351faca0b61a4517795368fe719fe5c07bb
-  data.tar.gz: 165c6088be69a4a3b291059aa4e872061e5f999f
+  metadata.gz: 415042776ee7b18bf44e586fe148c822a44746bd
+  data.tar.gz: 7e249159cd2b18b699fc1f7b4fcb0f3923f2082d
 SHA512:
-  metadata.gz: b9dd96de6c8915e8ef39f7737e930976d4f83909b8eb861456966ede6a2d62cd82f0b40b634af8da824bbd303d84e83205924d6ceb51369a17e82e6eec01523f
-  data.tar.gz: 5e349bc7288a6da431d9ef7177fc77f2041638ace47fe319af1e533846472fe234e1760ccd3d26bb208ad3e649eb99ecbed7733dc14871f53f63e19dd4b512f7
+  metadata.gz: f84dc40f3b0d789a2a8a3b0d9739b958958d895c2a43d2a60265a325465c46923ec8b5ce39fbf94d7942ce806315ffcb19bf39d4de9039853285aadfa8ecb933
+  data.tar.gz: 9335ecd1f3c25f082515dc5a7396aee2670748e6f287b481ef723699baaf355e5b67d0e23123721aefca894f0a2dd2e03065700ef581cad1b6bf9a64f963a1f9

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  wetransfer_style: ruby/default.yml

data/.travis.yml

@@ -10,6 +10,5 @@ dist: trusty # https://docs.travis-ci.com/user/trusty-ci-environment/
 sudo: false
 cache: bundler
 
-# Travis permits the following phases: before_install, install, after_install, before_script, script, after_script
 script:
-  - bundle exec rspec
+  - bundle exec rake

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+RuboCop::RakeTask.new(:rubocop)
+task default: [:spec, :rubocop]

data/lib/prorate/null_logger.rb

@@ -1,10 +1,15 @@
 module Prorate
   module NullLogger
     def self.debug(*); end
+
     def self.info(*); end
+
     def self.warn(*); end
+
     def self.error(*); end
+
     def self.fatal(*); end
+
     def self.unknown(*); end
   end
 end

data/lib/prorate/null_pool.rb

@@ -1,5 +1,7 @@
 module Prorate
   class NullPool < Struct.new(:conn)
-    def with; yield conn; end
+    def with
+      yield conn
+    end
   end
 end

data/lib/prorate/throttle.rb

@@ -1,14 +1,6 @@
 require 'digest'
 
 module Prorate
-  class Throttled < StandardError
-    attr_reader :retry_in_seconds
-    def initialize(try_again_in)
-      @retry_in_seconds = try_again_in
-      super("Throttled, please lower your temper and try again in #{retry_in_seconds} seconds")
-    end
-  end
-
   class ScriptHashMismatch < StandardError
   end
 
@@ -16,49 +8,48 @@ module Prorate
   end
 
   class Throttle < Ks.strict(:name, :limit, :period, :block_for, :redis, :logger)
-
-    def self.get_script_hash
-      script_filepath = File.join(__dir__,"rate_limit.lua")
+    def self.lua_script_hash
+      script_filepath = File.join(__dir__, "rate_limit.lua")
       script = File.read(script_filepath)
       Digest::SHA1.hexdigest(script)
     end
 
-    CURRENT_SCRIPT_HASH = get_script_hash
+    CURRENT_SCRIPT_HASH = lua_script_hash
 
     def initialize(*)
       super
       @discriminators = [name.to_s]
       self.redis = NullPool.new(redis) unless redis.respond_to?(:with)
-      raise MisconfiguredThrottle if ((period <= 0) || (limit <= 0))
+      raise MisconfiguredThrottle if (period <= 0) || (limit <= 0)
       @leak_rate = limit.to_f / period # tokens per second;
     end
-    
+
     def <<(discriminator)
       @discriminators << discriminator
     end
-    
+
     def throttle!
       discriminator = Digest::SHA1.hexdigest(Marshal.dump(@discriminators))
       identifier = [name, discriminator].join(':')
-      
+
       redis.with do |r|
         logger.info { "Applying throttle counter %s" % name }
         remaining_block_time, bucket_level = run_lua_throttler(redis: r, identifier: identifier, bucket_capacity: limit, leak_rate: @leak_rate, block_for: block_for)
 
         if remaining_block_time > 0
           logger.warn { "Throttle %s exceeded limit of %d in %d seconds and is blocked for the next %d seconds" % [name, limit, period, remaining_block_time] }
-          raise Throttled.new(remaining_block_time)
+          raise ::Prorate::Throttled.new(name, remaining_block_time)
         end
-        available_calls = limit - bucket_level
+        return limit - bucket_level # How many calls remain
       end
     end
 
-    def run_lua_throttler(redis: , identifier: , bucket_capacity: , leak_rate: , block_for: )
+    def run_lua_throttler(redis:, identifier:, bucket_capacity:, leak_rate:, block_for:)
       redis.evalsha(CURRENT_SCRIPT_HASH, [], [identifier, bucket_capacity, leak_rate, block_for])
     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 of the Redis server (unless the script changes)
-        script_filepath = File.join(__dir__,"rate_limit.lua")
+        script_filepath = File.join(__dir__, "rate_limit.lua")
         script = File.read(script_filepath)
         raise ScriptHashMismatch if Digest::SHA1.hexdigest(script) != CURRENT_SCRIPT_HASH
         redis.script(:load, script)

data/lib/prorate/throttled.rb

@@ -0,0 +1,8 @@
+class Prorate::Throttled < StandardError
+  attr_reader :throttle_name, :retry_in_seconds
+  def initialize(throttle_name, try_again_in)
+    @throttle_name = throttle_name
+    @retry_in_seconds = try_again_in
+    super("Throttled, please lower your temper and try again in #{retry_in_seconds} seconds")
+  end
+end

data/lib/prorate/version.rb

@@ -1,3 +1,3 @@
 module Prorate
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/prorate.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'prorate/version'
@@ -29,8 +29,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "ks"
   spec.add_dependency "redis", ">= 2"
-  spec.add_development_dependency "connection_pool", "~> 1"
+  spec.add_development_dependency "connection_pool", "~> 2"
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'wetransfer_style', '0.6.0'
 end

data/scripts/bm.rb

@@ -6,7 +6,7 @@ require 'redis'
 require 'securerandom'
 
 def average_ms(ary)
-  ary.map{|x| x*1000}.inject(0,&:+) / ary.length
+  ary.map { |x| x * 1000 }.inject(0, &:+) / ary.length
 end
 
 r = Redis.new

data/scripts/bm_latency_lb_vs_mget.rb

@@ -6,7 +6,7 @@ require 'redis'
 require 'securerandom'
 
 def average_ms(ary)
-  ary.map{|x| x*1000}.inject(0,&:+) / ary.length
+  ary.map { |x| x * 1000 }.inject(0, &:+) / ary.length
 end
 
 r = Redis.new
@@ -31,24 +31,23 @@ end
 puts average_ms times
 def key_for_ts(ts)
   "th:%s:%d" % [@id, ts]
-end 
+end
 
 times = []
 15.times do
-  id = SecureRandom.hex(10)
   sec, _ = r.time # Use Redis time instead of the system timestamp, so that all the nodes are consistent
   ts = sec.to_i # All Redis results are strings
   k = key_for_ts(ts)
   times << Benchmark.realtime {
     r.multi do |txn|
-      # Increment the counter 
+      # Increment the counter
       txn.incr(k)
       txn.expire(k, 120)
 
       span_start = ts - 120
       span_end = ts + 1
-      possible_keys = (span_start..span_end).map{|prev_time| key_for_ts(prev_time) }
-            
+      possible_keys = (span_start..span_end).map { |prev_time| key_for_ts(prev_time) }
+
       # Fetch all the counter values within the time window. Despite the fact that this
       # will return thousands of elements for large sliding window sizes, the values are
       # small and an MGET in Redis is pretty cheap, so perf should stay well within limits.
@@ -58,4 +57,3 @@ times = []
 end
 
 puts average_ms times
-

data/scripts/reload_lua.rb

@@ -2,5 +2,5 @@
 require 'redis'
 r = Redis.new
 script = File.read('../lib/prorate/rate_limit.lua')
-sha = r.script(:load,script)
+sha = r.script(:load, script)
 puts sha

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prorate
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: wetransfer_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Can be used to implement all kinds of throttles
 email:
 - me@julik.nl
@@ -103,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -115,6 +130,7 @@ files:
 - lib/prorate/null_pool.rb
 - lib/prorate/rate_limit.lua
 - lib/prorate/throttle.rb
+- lib/prorate/throttled.rb
 - lib/prorate/version.rb
 - prorate.gemspec
 - scripts/bm.rb
@@ -141,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Time-restricted rate limiter using Redis