redis-throttle 1.0.0 → 1.1.0

data/lib/redis/throttle/class_methods.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./api"
-
-class Redis
-  class Throttle
-    module ClassMethods
-      # Syntax sugar for {Throttle#concurrency}.
-      #
-      # @see #concurrency
-      # @param (see Throttle#initialize)
-      # @param (see Throttle#concurrency)
-      # @return (see Throttle#concurrency)
-      def concurrency(bucket, limit:, ttl:, redis: nil)
-        new(:redis => redis).concurrency(bucket, :limit => limit, :ttl => ttl)
-      end
-
-      # Syntax sugar for {Throttle#rate_limit}.
-      #
-      # @see #concurrency
-      # @param (see Throttle#initialize)
-      # @param (see Throttle#rate_limit)
-      # @return (see Throttle#rate_limit)
-      def rate_limit(bucket, limit:, period:, redis: nil)
-        new(:redis => redis).rate_limit(bucket, :limit => limit, :period => period)
-      end
-
-      # Return usage info for all known (in use) strategies.
-      #
-      # @example
-      #   Redis::Throttle.info(:match => "*_api").each do |strategy, current_value|
-      #     # ...
-      #   end
-      #
-      # @param match [#to_s]
-      # @return (see Api#info)
-      def info(match: "*", redis: nil)
-        api        = Api.new(:redis => redis)
-        strategies = api.strategies(:match => match.to_s)
-
-        api.info(:strategies => strategies)
-      end
-    end
-  end
-end

data/lib/redis/throttle/concurrency.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-class Redis
-  class Throttle
-    class Concurrency
-      # @!attribute [r] bucket
-      #   @return [String] Throttling group name
-      attr_reader :bucket
-
-      # @!attribute [r] limit
-      #   @return [Integer] Max allowed concurrent units
-      attr_reader :limit
-
-      # @!attribute [r] ttl
-      #   @return [Integer] Time (in seconds) to hold the lock before
-      #     releasing it (in case it wasn't released already)
-      attr_reader :ttl
-
-      # @param bucket [#to_s] Throttling group name
-      # @param limit [#to_i] Max allowed concurrent units
-      # @param ttl [#to_i] Time (in seconds) to hold the lock before
-      #   releasing it (in case it wasn't released already)
-      def initialize(bucket, limit:, ttl:)
-        @bucket = -bucket.to_s
-        @limit  = limit.to_i
-        @ttl    = ttl.to_i
-      end
-
-      # Returns `true` if `other` is a {Concurrency} instance with the same
-      # {#bucket}, {#limit}, and {#ttl}.
-      #
-      # @see https://docs.ruby-lang.org/en/master/Object.html#method-i-eql-3F
-      # @param other [Object]
-      # @return [Boolean]
-      def ==(other)
-        return true  if equal? other
-        return false unless other.is_a?(self.class)
-
-        @bucket == other.bucket && @limit == other.limit && @ttl == other.ttl
-      end
-
-      alias eql? ==
-
-      # @api private
-      #
-      # Compare `self` with `other` strategy:
-      #
-      # - Returns `nil` if `other` is neither {Concurrency} nor {RateLimit}
-      # - Returns `1` if `other` is a {RateLimit}
-      # - Returns `1` if `other` is a {Concurrency} with lower {#limit}
-      # - Returns `0` if `other` is a {Concurrency} with the same {#limit}
-      # - Returns `-1` if `other` is a {Concurrency} with bigger {#limit}
-      #
-      # @return [-1, 0, 1, nil]
-      def <=>(other)
-        complexity <=> other.complexity if other.respond_to? :complexity
-      end
-
-      # @api private
-      #
-      # Generates an Integer hash value for this object.
-      #
-      # @see https://docs.ruby-lang.org/en/master/Object.html#method-i-hash
-      # @return [Integer]
-      def hash
-        @hash ||= [@bucket, @limit, @ttl].hash
-      end
-
-      # @api private
-      #
-      # @return [Array(Integer, Integer)] Strategy complexity pseudo-score
-      def complexity
-        [1, @limit]
-      end
-    end
-  end
-end

data/lib/redis/throttle/errors.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-class Redis
-  class Throttle
-    class Error < StandardError; end
-    class ScriptError < Error; end
-
-    class FrozenError < RuntimeError; end if RUBY_VERSION < "2.5"
-  end
-end

data/lib/redis/throttle/rate_limit.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-class Redis
-  class Throttle
-    class RateLimit
-      # @!attribute [r] bucket
-      #   @return [String] Throttling group name
-      attr_reader :bucket
-
-      # @!attribute [r] limit
-      #   @return [Integer] Max allowed units per {#period}
-      attr_reader :limit
-
-      # @!attribute [r] period
-      #   @return [Integer] Period in seconds
-      attr_reader :period
-
-      # @param bucket [#to_s] Throttling group name
-      # @param limit [#to_i] Max allowed units per `period`
-      # @param period [#to_i] Period in seconds
-      def initialize(bucket, limit:, period:)
-        @bucket = -bucket.to_s
-        @limit  = limit.to_i
-        @period = period.to_i
-      end
-
-      # Returns `true` if `other` is a {RateLimit} instance with the same
-      # {#bucket}, {#limit}, and {#period}.
-      #
-      # @see https://docs.ruby-lang.org/en/master/Object.html#method-i-eql-3F
-      # @param other [Object]
-      # @return [Boolean]
-      def ==(other)
-        return true  if equal? other
-        return false unless other.is_a?(self.class)
-
-        @bucket == other.bucket && @limit == other.limit && @period == other.period
-      end
-
-      alias eql? ==
-
-      # @api private
-      #
-      # Compare `self` with `other` strategy:
-      #
-      # - Returns `nil` if `other` is neither {Concurrency} nor {RateLimit}
-      # - Returns `-1` if `other` is a {Concurrency}
-      # - Returns `1` if `other` is a {RateLimit} with lower {#limit}
-      # - Returns `0` if `other` is a {RateLimit} with the same {#limit}
-      # - Returns `-1` if `other` is a {RateLimit} with bigger {#limit}
-      #
-      # @return [-1, 0, 1, nil]
-      def <=>(other)
-        complexity <=> other.complexity if other.respond_to? :complexity
-      end
-
-      # @api private
-      #
-      # Generates an Integer hash value for this object.
-      #
-      # @see https://docs.ruby-lang.org/en/master/Object.html#method-i-hash
-      # @return [Integer]
-      def hash
-        @hash ||= [@bucket, @limit, @period].hash
-      end
-
-      # @api private
-      #
-      # @return [Array(Integer, Integer)] Strategy complexity pseudo-score
-      def complexity
-        [0, @limit]
-      end
-    end
-  end
-end

data/lib/redis/throttle/script.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "digest"
-require "redis/errors"
-
-require_relative "./errors"
-
-class Redis
-  class Throttle
-    # @api private
-    #
-    # Lazy-compile and run acquire script by it's sha1 digest.
-    class Script
-      # Redis error fired when script ID is unkown.
-      NOSCRIPT = "NOSCRIPT"
-      private_constant :NOSCRIPT
-
-      LUA_ERROR_MESSAGE = %r{
-        ERR\s
-        (?<message>Error\s(?:compiling|running)\sscript)
-        \s\([^()]+\):\s
-        (?:@[^:]+:\d+:\s)?
-        [^:]+:(?<loc>\d+):\s
-        (?<details>.+)
-      }x.freeze
-      private_constant :LUA_ERROR_MESSAGE
-
-      def initialize(source)
-        @source = -source.to_s
-        @digest = Digest::SHA1.hexdigest(@source).freeze
-      end
-
-      def call(redis, keys: [], argv: [])
-        __eval__(redis, keys, argv)
-      rescue Redis::CommandError => e
-        md = LUA_ERROR_MESSAGE.match(e.message.to_s)
-        raise unless md
-
-        raise ScriptError, "#{md[:message]} @#{md[:loc]}: #{md[:details]}"
-      end
-
-      private
-
-      def __eval__(redis, keys, argv)
-        redis.evalsha(@digest, keys, argv)
-      rescue Redis::CommandError => e
-        raise unless e.message.include?(NOSCRIPT)
-
-        redis.eval(@source, keys, argv)
-      end
-    end
-  end
-end

data/lib/redis/throttle/version.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-class Redis
-  class Throttle
-    # Gem version.
-    VERSION = "1.0.0"
-  end
-end