berater 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a54a65428bf73c9a8840d95900215411a7320d87af5297cbc75039976e182c
-  data.tar.gz: 5804acf97ae46ab33bf8366438304a301d183fb0b8da48f4b872252769e79a54
+  metadata.gz: dec8c5d6d428f795d1489dace166451e2a3a42592d00d71155ed5cd0d5aaa909
+  data.tar.gz: 6956b6c2804b6d616074e239439d4f2a8e551e900db7801226948b9eb764d0fc
 SHA512:
-  metadata.gz: c4f2f7002db193351b915c0f21b4ff6a704c20e90e7ff5815a5bfef3f38064608a367e7e150cf430e2d87a8b7b10420a3ec00a1c211bc4edcd04d0c479af3eb8
-  data.tar.gz: '06489eb2f8769e349b163d49b9a6e6a0f1a8d55b97ded73fcdeb01652b0048e4dd3d940fc71075041129b1f280120d44eec906d258056d720c1f07ac23089cb7'
+  metadata.gz: 327cd2f3a7430c2b81bd1988abd636bfc7d97048c762d3807555e9c1196153570dbe3045fae813852a907ec00b89b8d2c36e9269ed0562419c8d98dd6c1d2b26
+  data.tar.gz: ea1cb39e9201091e4a1357e888ac36f630c326a271e3cfcafa13298b8f54424f776f4dd488e046e2178905d0df9fb5c3b1f0d454e331823cafe5dd338fe9ea6c

data/lib/berater.rb

@@ -1,53 +1,34 @@
-require 'berater/base_limiter'
-require 'berater/concurrency_limiter'
-require 'berater/inhibitor'
-require 'berater/rate_limiter'
-require 'berater/unlimiter'
 require 'berater/version'
+require 'berater/lock'
 
 
 module Berater
   extend self
 
-  Overloaded = BaseLimiter::Overloaded
+  class Overloaded < StandardError; end
 
   MODES = {}
 
-  attr_accessor :redis, :mode
+  attr_accessor :redis
 
   def configure
-    self.mode = :unlimited # default
-
     yield self
   end
 
-  def new(mode, *args, **opts)
+  def new(key, mode, *args, **opts)
     klass = MODES[mode.to_sym]
 
     unless klass
       raise ArgumentError, "invalid mode: #{mode}"
     end
 
-    klass.new(*args, **opts)
+    klass.new(key, *args, **opts)
   end
 
   def register(mode, klass)
     MODES[mode.to_sym] = klass
   end
 
-  def mode=(mode)
-    unless MODES.include? mode.to_sym
-      raise ArgumentError, "invalid mode: #{mode}"
-    end
-
-    @mode = mode.to_sym
-  end
-
-  def limit(*args, **opts, &block)
-    mode = opts.delete(:mode) { self.mode }
-    new(mode, *args, **opts).limit(&block)
-  end
-
   def expunge
     redis.scan_each(match: "#{self.name}*") do |key|
       redis.del key
@@ -56,6 +37,18 @@ module Berater
 
 end
 
+# convenience method
+def Berater(key, mode, *args, **opts, &block)
+  Berater.new(key, mode, *args, **opts).limit(&block)
+end
+
+# load and register limiters
+require 'berater/base_limiter'
+require 'berater/concurrency_limiter'
+require 'berater/inhibitor'
+require 'berater/rate_limiter'
+require 'berater/unlimiter'
+
 Berater.register(:concurrency, Berater::ConcurrencyLimiter)
 Berater.register(:inhibited, Berater::Inhibitor)
 Berater.register(:rate, Berater::RateLimiter)

data/lib/berater/base_limiter.rb

@@ -1,33 +1,25 @@
 module Berater
   class BaseLimiter
 
-    class Overloaded < RuntimeError; end
-
-    attr_reader :options
-
-    def initialize(**opts)
-      @options = opts
-    end
-
-    def key
-      if options[:key]
-        "#{self.class}:#{options[:key]}"
-      else
-        # default value
-        self.class.to_s
-      end
-    end
+    attr_reader :key, :options
 
     def redis
       options[:redis] || Berater.redis
     end
 
-    def limit(**opts)
+    def limit
       raise NotImplementedError
     end
 
-    def self.limit(*args, **opts, &block)
-      self.new(*args, **opts).limit(&block)
+    protected
+
+    def initialize(key, **opts)
+      @key = key
+      @options = opts
+    end
+
+    def cache_key(key)
+      "#{self.class}:#{key}"
     end
 
   end

data/lib/berater/concurrency_limiter.rb

@@ -5,14 +5,14 @@ module Berater
 
     attr_reader :capacity, :timeout
 
-    def initialize(capacity, **opts)
-      super(**opts)
+    def initialize(key, capacity, **opts)
+      super(key, **opts)
 
       self.capacity = capacity
       self.timeout = opts[:timeout] || 0
     end
 
-    def capacity=(capacity)
+    private def capacity=(capacity)
       unless capacity.is_a? Integer
         raise ArgumentError, "expected Integer, found #{capacity.class}"
       end
@@ -22,7 +22,7 @@ module Berater
       @capacity = capacity
     end
 
-    def timeout=(timeout)
+    private def timeout=(timeout)
       unless timeout.is_a? Integer
         raise ArgumentError, "expected Integer, found #{timeout.class}"
       end
@@ -32,117 +32,57 @@ module Berater
       @timeout = timeout
     end
 
-    class Lock
-      attr_reader :limiter, :id
-
-      def initialize(limiter, id)
-        @limiter = limiter
-        @id = id
-        @released = false
-        @locked_at = Time.now
-      end
-
-      def release
-        raise 'lock already released' if released?
-        raise 'lock expired' if expired?
-
-        @released = limiter.release(self)
-      end
-
-      def released?
-        @released
-      end
-
-      def expired?
-        @locked_at + limiter.timeout < Time.now
-      end
-    end
-
     LUA_SCRIPT = <<~LUA.gsub(/^\s*(--.*\n)?/, '')
       local key = KEYS[1]
+      local lock_key = KEYS[2]
       local capacity = tonumber(ARGV[1])
-      local ttl = tonumber(ARGV[2])
-
-      local exists
-      local count
+      local ts = tonumber(ARGV[2])
+      local ttl = tonumber(ARGV[3])
       local lock
-      local ts = unpack(redis.call('TIME'))
 
-      -- check to see if key already exists
-      if ttl == 0 then
-        exists = redis.call('EXISTS', key)
-      else
-        -- and refresh TTL while we're at it
-        exists = redis.call('EXPIRE', key, ttl * 2)
+      -- purge stale hosts
+      if ttl > 0 then
+        redis.call('ZREMRANGEBYSCORE', key, '-inf', ts - ttl)
       end
 
-      if exists == 1 then
-        -- purge stale hosts
-        if ttl > 0 then
-          redis.call('ZREMRANGEBYSCORE', key, '-inf', ts - ttl)
-        end
-
-        -- check capacity (subtract one for next lock entry)
-        count = redis.call('ZCARD', key) - 1
-
-        if count < capacity then
-          -- yay, grab a lock
-
-          -- regenerate next lock entry, which has score inf
-          lock = unpack(redis.call('ZPOPMAX', key))
-          redis.call('ZADD', key, 'inf', (lock + 1) % 2^52)
-
-          count = count + 1
-        end
-      else
-        count = 1
-        lock = "1"
+      -- check capacity
+      local count = redis.call('ZCARD', key)
 
-        -- create structure to track locks and next id
-        redis.call('ZADD', key, 'inf', lock + 1)
-
-        if ttl > 0 then
-          redis.call('EXPIRE', key, ttl * 2)
-        end
-      end
-
-      if lock then
-        -- store lock and timestamp
+      if count < capacity then
+        -- grab a lock
+        lock = redis.call('INCR', lock_key)
         redis.call('ZADD', key, ts, lock)
+        count = count + 1
       end
 
       return { count, lock }
     LUA
 
-    def limit(**opts, &block)
-      unless opts.empty?
-        return self.class.new(
-          capacity,
-          **options.merge(opts)
-          # **options.merge(timeout: timeout).merge(opts)
-        ).limit(&block)
-      end
-
-      count, lock_id = redis.eval(LUA_SCRIPT, [ key ], [ capacity, timeout ])
+    def limit
+      count, lock_id = redis.eval(
+        LUA_SCRIPT,
+        [ cache_key(key), cache_key('lock_id') ],
+        [ capacity, Time.now.to_i, timeout ]
+      )
 
       raise Incapacitated unless lock_id
 
-      lock = Lock.new(self, lock_id)
+      lock = Lock.new(self, lock_id, count, -> { release(lock_id) })
 
       if block_given?
         begin
-          yield
+          yield lock
         ensure
-          release(lock)
+          lock.release
         end
       else
         lock
       end
     end
 
-    def release(lock)
-      res = redis.zrem(key, lock.id)
-      res == true || res == 1
+    private def release(lock_id)
+      res = redis.zrem(cache_key(key), lock_id)
+      res == true || res == 1 # depending on which version of Redis
     end
 
   end

data/lib/berater/inhibitor.rb

@@ -3,17 +3,11 @@ module Berater
 
     class Inhibited < Overloaded; end
 
-    def initialize(*args, **opts)
-      super(**opts)
+    def initialize(key = :inhibitor, *args, **opts)
+      super(key, **opts)
     end
 
-    def limit(**opts, &block)
-      unless opts.empty?
-        return self.class.new(
-          **options.merge(opts)
-        ).limit(&block)
-      end
-
+    def limit
       raise Inhibited
     end
 

data/lib/berater/lock.rb

@@ -0,0 +1,36 @@
+module Berater
+  class Lock
+
+    attr_reader :limiter, :id, :contention
+
+    def initialize(limiter, id, contention, release_fn = nil)
+      @limiter = limiter
+      @id = id
+      @contention = contention
+      @locked_at = Time.now
+      @release_fn = release_fn
+      @released_at = nil
+    end
+
+    def locked?
+      @released_at.nil? && !expired?
+    end
+
+    def expired?
+      timeout > 0 && @locked_at + timeout < Time.now
+    end
+
+    def release
+      raise 'lock expired' if expired?
+      raise 'lock already released' unless locked?
+
+      @released_at = Time.now
+      @release_fn ? @release_fn.call : true
+    end
+
+    private def timeout
+      limiter.respond_to?(:timeout) ? limiter.timeout : 0
+    end
+
+  end
+end

data/lib/berater/rate_limiter.rb

@@ -5,14 +5,14 @@ module Berater
 
     attr_accessor :count, :interval
 
-    def initialize(count, interval, **opts)
-      super(**opts)
+    def initialize(key, count, interval, **opts)
+      super(key, **opts)
 
       self.count = count
       self.interval = interval
     end
 
-    def count=(count)
+    private def count=(count)
       unless count.is_a? Integer
         raise ArgumentError, "expected Integer, found #{count.class}"
       end
@@ -22,7 +22,7 @@ module Berater
       @count = count
     end
 
-    def interval=(interval)
+    private def interval=(interval)
       @interval = interval.dup
 
       case @interval
@@ -51,19 +51,11 @@ module Berater
       @interval
     end
 
-    def limit(**opts, &block)
-      unless opts.empty?
-        return self.class.new(
-          count,
-          interval,
-          options.merge(opts)
-        ).limit(&block)
-      end
-
+    def limit
       ts = Time.now.to_i
 
       # bucket into time slot
-      rkey = "%s:%d" % [ key, ts - ts % @interval ]
+      rkey = "%s:%d" % [ cache_key(key), ts - ts % @interval ]
 
       count, _ = redis.multi do
         redis.incr rkey
@@ -72,10 +64,16 @@ module Berater
 
       raise Overrated if count > @count
 
+      lock = Lock.new(self, count, count)
+
       if block_given?
-        yield
+        begin
+          yield lock
+        ensure
+          lock.release
+        end
       else
-        count
+        lock
       end
     end
 

data/lib/berater/unlimiter.rb

@@ -1,18 +1,23 @@
 module Berater
   class Unlimiter < BaseLimiter
 
-    def initialize(*args, **opts)
-      super(**opts)
+    def initialize(key = :unlimiter, *args, **opts)
+      super(key, **opts)
     end
 
-    def limit(**opts, &block)
-      unless opts.empty?
-        return self.class.new(
-          **options.merge(opts)
-        ).limit(&block)
-      end
+    def limit
+      count = redis.incr(cache_key('count'))
+      lock = Lock.new(self, count, count)
 
-      yield if block_given?
+      if block_given?
+        begin
+          yield lock
+        ensure
+          lock.release
+        end
+      else
+        lock
+      end
     end
 
   end