congestion 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743682fd626adfbbda32326f478c784b65b37681
-  data.tar.gz: 5a2b05c1e4248f9c0c46f6d6a33be25c1e4341c7
+  metadata.gz: 16e2c7689805fd59071ed37c3ca3948706b9523d
+  data.tar.gz: 96c12215e6403a4bf5f68f6668f4f5bc7384c8d4
 SHA512:
-  metadata.gz: d25cfb8a064c2237c43640eafb1405fa36118b3214f044fd512947d8e3a7feaa897232d90c0231ba9c9bc76ab4b4431daa02a5f834da5fc827ec310adf567b60
-  data.tar.gz: 607c8c1faf82fd729d08a9538ee2f5feb418b4aa0cb32f62c332d6c1905226db932f66ac1bc43942440dc8c676f7084d6acf74bb3245a9bec8bb52c739d7cebc
+  metadata.gz: d68a8e3a27f4cb38bcb4ae72d2ac45f84171abb4c0e5dc86e0f3b19ad61417d70f8957d11d8ef9204933e48ae6aa0eba8f6851847e1b03ff1fafca19500bb729
+  data.tar.gz: 982bc455e6a47aba8e950c1c96d0dfed4024bbf65fe92d93a0b6a25ab08892c0d8ebe04fa6b524525c908fac2d4aa091c8c1d2dc1456e492c8852ef7a6d83ab4

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/.travis.yml

@@ -1,3 +1,11 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
-  - 2.2.1
+  - 1.9.3
+  - 2.2.0
+  - jruby-19mode
+services:
+  - redis-server
+jruby_before_script: &jruby_before_script
+  - bundle exec jbundle install

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/#{ m[1] }_spec.rb" }
+  watch('spec/spec_helper.rb'){ 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}){ 'spec' }
+end

data/README.md

@@ -42,20 +42,45 @@ limiter.backoff       # => the number of seconds before a request will be permit
 
 ### Configuration
 
+A proc provides a Redis connection:
+
+```ruby
+Congestion.redis = ->{
+  Redis.new url: 'redis://:password@host:port/db'
+}
+```
+
+To pool, your Redis connections:
+
+```ruby
+require 'congestion/redis_pool'
+
+Congestion::RedisPool.redis_config = {
+  url: 'redis://:password@host:port/db'
+}
+
+Congestion::RedisPool.pool_size = 10  # number of connections to use
+Congestion::RedisPool.timeout = 10    # seconds before timing out an operation
+
+Congestion.redis = Congestion::RedisPool.instance
+```
+
 Global options can be set with:
 
 ```ruby
-  Congestion.default_options = {
-    interval: 1,        # The timeframe to limit within in seconds
-    max_in_interval: 1, # The number of allowed requests within the interval
-    min_delay: 0.0      # The minimum amount of time in seconds between requests
-  }
+Congestion.default_options = {
+  namespace: 'congestion' # The Redis key prefix (e.g. 'congestion:some_key')
+  interval: 1,            # The timeframe to limit within in seconds
+  max_in_interval: 1,     # The number of allowed requests within the interval
+  min_delay: 0.0,         # The minimum amount of time in seconds between requests
+  track_rejected: false   # True if rejected request count towards the limit
+}
 ```
 
 Per-request options can be set as well:
 
 ```ruby
-  Congestion.request 'some_key', interval: 60, min_delay: 1
+Congestion.request 'some_key', interval: 60, min_delay: 1
 ```
 
 ## Development

data/congestion.gemspec

@@ -19,8 +19,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_runtime_dependency     'redis', '>= 3.1'
+  spec.add_runtime_dependency     'connection_pool', '>= 2.0'
+  spec.add_development_dependency 'bundler', '>= 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'timecop', '~> 0.7'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/congestion/rate_limiter.rb

@@ -0,0 +1,104 @@
+module Congestion
+  class RateLimiter
+    attr_accessor :redis, :key, :options
+
+    def initialize(redis, key, opts = { })
+      self.redis = redis
+      self.key = "#{ opts[:namespace] }:#{ key }"
+      self.options = opts
+      self.options[:interval] *= 1_000
+      self.options[:min_delay] *= 1_000
+      allowed?
+    end
+
+    def total_requests
+      get_requests[1]
+    end
+
+    def first_request
+      first = get_requests[2].first
+      first ? first.to_i : nil
+    end
+
+    def last_request
+      last = get_requests[3].first
+      last ? last.to_i : nil
+    end
+
+    def allowed?
+      add_request unless rejected?
+      !rejected?
+    end
+
+    def rejected?
+      too_many? || too_frequent?
+    end
+
+    def too_many?
+      total_requests > options[:max_in_interval]
+    end
+
+    def too_frequent?
+      last_request && time_since_last_request < options[:min_delay]
+    end
+
+    def backoff
+      if too_many? && too_frequent?
+        [quantity_backoff, frequency_backoff].max
+      elsif too_many?
+        quantity_backoff
+      elsif too_frequent?
+        frequency_backoff
+      else
+        0
+      end
+    end
+
+    protected
+
+    def current_time
+      @current_time ||= (Time.now.utc.to_f * 1_000).round
+    end
+
+    def time_since_last_request
+      current_time - last_request
+    end
+
+    def time_since_first_request
+      current_time - first_request
+    end
+
+    def expired_at
+      current_time - options[:interval]
+    end
+
+    def quantity_backoff
+      millis = options[:interval] - time_since_first_request
+      (millis / 1_000.0).ceil
+    end
+
+    def frequency_backoff
+      millis = options[:min_delay] - time_since_last_request
+      (millis / 1_000.0).ceil
+    end
+
+    def add_request
+      unless options[:track_rejected]
+        redis.zadd key, current_time, current_time
+      end
+    end
+
+    def get_requests
+      @requests ||= redis.multi do |t|
+        t.zremrangebyscore key, 0, expired_at   # [0] - clear old requests
+        t.zcount key, '-inf', '+inf'            # [1] - number of requests
+        t.zrange key, 0, 0                      # [2] - first request
+        t.zrange key, -1, -1                    # [3] - last request
+        t.pexpire key, options[:interval]       # [4] - expire request key
+
+        # [5] - Add the request if tracking rejected
+        t.zadd(key, current_time, current_time) if options[:track_rejected]
+      end
+    end
+  end
+end

data/lib/congestion/redis_pool.rb

@@ -0,0 +1,32 @@
+require 'redis'
+require 'connection_pool'
+
+module Congestion
+  class RedisPool
+    class << self
+      attr_accessor :redis_config
+      attr_accessor :pool_size
+      attr_accessor :timeout
+    end
+
+    self.redis_config = { }
+    self.pool_size = 5
+    self.timeout = 5
+
+    attr_accessor :pool
+
+    def self.instance
+      @instance ||= new
+      @redis_pool ||= ->{ @instance.pool.with{ |redis| redis } }
+    end
+
+    private
+    def initialize
+      pool_config = { size: self.class.pool_size, timeout: self.class.timeout }
+
+      self.pool = ConnectionPool.new(pool_config) do
+        Redis.new self.class.redis_config
+      end
+    end
+  end
+end

data/lib/congestion/version.rb

@@ -1,3 +1,3 @@
 module Congestion
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/congestion.rb

@@ -1,4 +1,26 @@
+require 'redis'
 require 'congestion/version'
+require 'congestion/rate_limiter'
 
 module Congestion
+  class << self
+    attr_accessor :default_options
+    attr_accessor :redis
+  end
+
+  self.default_options = {
+    namespace: 'congestion', # Redis key namespace
+    interval: 1,             # 1 second
+    max_in_interval: 1,      # 1 / second
+    min_delay: 0,            # none
+    track_rejected: false
+  }
+
+  self.redis = ->{
+    Redis.new
+  }
+
+  def self.request(key, opts = { })
+    RateLimiter.new redis.call, key, default_options.merge(opts)
+  end
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: congestion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Parrish
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Redis rate limiter that provides both time-based limits and quantity-based
   limits
 email:
@@ -79,6 +163,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,6 +171,8 @@ files:
 - bin/setup
 - congestion.gemspec
 - lib/congestion.rb
+- lib/congestion/rate_limiter.rb
+- lib/congestion/redis_pool.rb
 - lib/congestion/version.rb
 homepage: https://github.com/parrish/Congestion
 licenses: