redis-throttler 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8867c14afca284cff1a0120b80bd260a75e20457
-  data.tar.gz: ebd9aeef2e2aea7e045d22799cd832d5f6a80149
+  metadata.gz: 2b589098c335605b23f3d2db1102accd163b8ccf
+  data.tar.gz: ad9e138f8a639c34a546e7f1dcba365c0b7b55d8
 SHA512:
-  metadata.gz: 378dd004616c326d80ae8534fccb0f59d4075faf3ca0b6c950fe259f115b73dddaf4aac2fe2b6d3f8a41de388a5dd6b0efff1cfe423ced94da663566029809ab
-  data.tar.gz: 94916b706112edc47d883eea54c93fc7f1f665809ff60ac41b773a92a996b9e498325e4f85a5e645621f5a2384561c0d46f40fb4547204baffefb637817e91c6
+  metadata.gz: 397f06f7b92833db7a96b6ffc9933aa72f4332a73bc68797a2dfd4d89f0d0a2df265b0216e4cfe690ce1f30814fe96418ae03b1771d627e36a417f453cf9637d
+  data.tar.gz: 737c45f3a4d19bfd171ffcfbc798e7b7dedf1f78c458a1b7db573ecd2ba60d82c812fee031665e210262a52766cb20b960a3d8ffddcf52a7c457f1e3cbfac723

data/.gitignore

@@ -1,4 +1,4 @@
-/.ideo
+/.idea
 *DS_Store
 /.ruby-*
 /.bundle

data/gemspec.yml

@@ -6,6 +6,9 @@ authors: Evan Surdam
 email: es@cosi.io
 homepage: https://github.com/esurdam/redis-throttler#readme
 
+dependencies:
+  redis: ~> 3
+
 development_dependencies:
   bundler: ~> 1.10
   rake: ~> 10.0

data/lib/redis-throttler/model.rb

@@ -0,0 +1,55 @@
+require 'redis-throttler'
+class RedisThrottler
+  module Model
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.instance_eval { @limits ||= {} }
+    end
+
+    module ClassMethods
+      # @param [Symbol] key
+      # @param [Hash] opts
+      def throttle(key, opts = {})
+        klass = self.to_s.downcase
+        key = "#{key.to_s}"
+
+        subject = opts[:by] || :id
+        limit = opts[:limit] || 5
+        threshold = opts[:for] || 900
+        interval = opts[:interval] || 5
+
+        limiter = RedisThrottler.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: threshold)
+        @limits[key] = "#{subject.to_s} limit #{limit} per #{threshold} sec"
+
+        # includes('?') will return true
+        method = "#{key}_limiter"
+
+        %w(limits limits?).each do |string|
+          define_singleton_method(string) { string.include?('?') || @limits }
+          define_method(string) { string.include?('?') || @limits }
+        end
+
+        # i used Procs because they don't complain about arity
+        # these Procs will return a string to be evaluated in context
+
+        methods = {
+            :exceeded? => proc { |to_call| "#{method}.exceeded? \"#{to_call}\", threshold: #{limit}, interval: #{threshold}" },
+            :increment => proc { |to_call| "#{method}.add(\"#{to_call}\")" },
+            :count => proc { |to_call, within| "#{method}.count(\"#{to_call}\", #{within})" }
+        }
+
+        # define the class & instance methods
+        # pass the id to access counters
+        define_singleton_method(method) { limiter }
+        define_method(method) { self.class.send method }
+
+        methods.each do |magic, meth|
+          define_singleton_method("#{key}_#{magic.to_s}") { |id, within = threshold| eval meth.call(id, within) }
+          define_method("#{key}_#{magic.to_s}") { |within = threshold| eval meth.call("#{self.send subject}", within) }
+        end
+
+      end
+    end
+  end
+end

data/lib/redis-throttler/version.rb

@@ -0,0 +1,3 @@
+class RedisThrottler
+   VERSION = '0.1.2'
+end

data/lib/redis-throttler.rb

@@ -0,0 +1,123 @@
+require 'redis'
+
+class RedisThrottler
+  def self.included(base)
+    base.extend(RedisThrottler::Model)
+  end
+  # Create a RedisThrottler object.
+  #
+  # @param [String] key A name to uniquely identify this rate limit. For example, 'emails'
+  # @param [Hash] options Options hash
+  # @option options [Integer] :bucket_span (600) Time span to track in seconds
+  # @option options [Integer] :bucket_interval (5) How many seconds each bucket represents
+  # @option options [Integer] :bucket_expiry (@bucket_span) How long we keep data in each bucket before it is auto expired. Cannot be larger than the bucket_span.
+  # @option options [Redis]   :redis (nil) Redis client if you need to customize connection options
+  #
+  # @return [RedisThrottler] RedisThrottler instance
+  #
+  def initialize(key, options = {})
+    @key = key
+    @bucket_span = options[:bucket_span] || 600
+    @bucket_interval = options[:bucket_interval] || 5
+    @bucket_expiry = options[:bucket_expiry] || @bucket_span
+    if @bucket_expiry > @bucket_span
+      raise ArgumentError.new("Bucket expiry cannot be larger than the bucket span")
+    end
+    @bucket_count = (@bucket_span / @bucket_interval).round
+    if @bucket_count < 3
+      raise ArgumentError.new("Cannot have less than 3 buckets")
+    end
+    @redis = options[:redis]
+  end
+
+  # Increment counter for a given subject.
+  #
+  # @param [String]   subject A unique key to identify the subject. For example, 'user@foo.com'
+  # @param [Integer]  count   The number by which to increment the counter
+  #
+  # @return [Integer] increments within interval
+  def add(subject, count = 1)
+    bucket = get_bucket
+    subject = "#{@key}:#{subject}"
+    redis.pipelined do
+      redis.hincrby(subject, bucket, count)
+      redis.hdel(subject, (bucket + 1) % @bucket_count)
+      redis.hdel(subject, (bucket + 2) % @bucket_count)
+      redis.expire(subject, @bucket_expiry)
+    end.first
+  end
+
+  # Returns the count for a given subject and interval
+  #
+  # @param [String] subject Subject for the count
+  # @param [Integer] interval How far back (in seconds) to retrieve activity.
+  #
+  # @return [Integer] current count for subject
+  def count(subject, interval)
+    bucket = get_bucket
+    interval = [interval, @bucket_interval].max
+    count = (interval / @bucket_interval).floor
+    subject = "#{@key}:#{subject}"
+
+    keys = (0..count - 1).map do |i|
+      (bucket - i) % @bucket_count
+    end
+    redis.hmget(subject, *keys).inject(0) {|a, i| a + i.to_i}
+  end
+
+  # Check if the rate limit has been exceeded.
+  #
+  # @param [String] subject Subject to check
+  # @param [Hash] options Options hash
+  # @option options [Integer] :interval How far back to retrieve activity.
+  # @option options [Integer] :threshold Maximum number of actions
+  #
+  # @return [Boolean] true if exceeded
+  def exceeded?(subject, options = {})
+    count(subject, options[:interval]) >= options[:threshold]
+  end
+
+  # Check if the rate limit is within bounds
+  #
+  # @param [String] subject Subject to check
+  # @param [Hash] options Options hash
+  # @option options [Integer] :interval How far back to retrieve activity.
+  # @option options [Integer] :threshold Maximum number of actions
+  #
+  # @return [Integer] true if within bounds
+  def within_bounds?(subject, options = {})
+    !exceeded?(subject, options)
+  end
+
+  # Execute a block once the rate limit is within bounds
+  # *WARNING* This will block the current thread until the rate limit is within bounds.
+  #
+  # @param [String] subject Subject for this rate limit
+  # @param [Hash] options Options hash
+  # @option options [Integer] :interval How far back to retrieve activity.
+  # @option options [Integer] :threshold Maximum number of actions
+  # @yield The block to be run
+  #
+  # @example Send an email as long as we haven't send 5 in the last 10 minutes
+  #   RedisThrottler.exec_with_threshold(email, [:threshold => 5, :interval => 600]) do
+  #     send_another_email
+  #   end
+  def exec_within_threshold(subject, options = {}, &block)
+    options[:threshold] ||= 30
+    options[:interval] ||= 30
+    while exceeded?(subject, options)
+      sleep @bucket_interval
+    end
+    yield(self)
+  end
+
+  private
+
+  def get_bucket(time = Time.now.to_i)
+    ((time % @bucket_span) / @bucket_interval).floor
+  end
+
+  def redis
+    @redis ||= Redis.new(host: '192.168.99.100', port: 32771)
+  end
+end

data/redis-throttler.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
                   lib_dir = File.join(File.dirname(__FILE__),'lib')
                   $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-                  require 'redis/throttler/version'
-                  Redis::Throttler::VERSION
+                  require 'redis-throttler/version'
+                  RedisThrottler::VERSION
                 end
 
   gem.summary     = gemspec['summary']

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
 require 'rspec'
-require 'redis/throttler/version'
+require 'redis-throttler'
 
-include Redis::Throttler

data/spec/throttler_spec.rb

@@ -1,8 +1,102 @@
 require 'spec_helper'
-require 'redis/throttler'
 
-describe Redis::Throttler do
-  it "should have a VERSION constant" do
-    expect(subject.const_get('VERSION')).to_not be_empty
+describe RedisThrottler do
+
+  before do
+    @rl = RedisThrottler.new('test')
+    @rl.send(:redis).flushdb
+  end
+
+  it 'should set_bucket_expiry to the bucket_span if not defined' do
+    expect(@rl.instance_variable_get(:@bucket_span)).to eq(@rl.instance_variable_get(:@bucket_expiry))
+  end
+
+  it 'should not allow bucket count less than 3' do
+    expect do
+      RedisThrottler.new('test', {:bucket_span => 1, :bucket_interval => 1})
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'should not allow bucket expiry to be larger than the bucket span' do
+    expect do
+      RedisThrottler.new("key", {:bucket_expiry => 1200})
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'should be able to add to the count for a given subject' do
+    @rl.add("value1")
+    @rl.add("value1")
+    expect(@rl.count('value1', 1)).to eq(2)
+    expect(@rl.count("value2", 1)).to eq(0)
+    # Timecop.travel(600) do
+    #   expect(@rl.count("value1", 1)).to eq(0)
+    # end
+  end
+
+  it 'should be able to add to the count by more than 1' do
+    @rl.add("value1", 3)
+    expect(@rl.count("value1", 1)).to eq(3)
+  end
+
+  it 'should be able to add to the count for a non-string subject' do
+    @rl.add(123)
+    @rl.add(123)
+    expect(@rl.count(123, 1)).to eq(2)
+    expect(@rl.count(124, 1)).to eq(0)
+    # Timecop.travel(10) do
+    #   expect(@rl.count(123, 1)).to eq(0)
+    # end
+  end
+
+  it 'should return counter value' do
+    counter_value = @rl.add("value1")
+    expect(@rl.count("value1", 1)).to eq(counter_value)
+  end
+
+  it 'respond to exceeded? method correctly' do
+    5.times do
+      @rl.add("value1")
+    end
+
+    expect(@rl.exceeded?("value1", {:threshold => 10, :interval => 30})).to be false
+    expect(@rl.within_bounds?("value1", {:threshold => 10, :interval => 30})).to be true
+
+    10.times do
+      @rl.add("value1")
+    end
+
+    expect(@rl.exceeded?("value1", {:threshold => 10, :interval => 30})).to be true
+    expect(@rl.within_bounds?("value1", {:threshold => 10, :interval => 30})).to be false
+  end
+
+  # it "accept a threshold and a block that gets executed once it's below the threshold" do
+  #   expect(@rl.count("key", 30)).to eq(0)
+  #   31.times do
+  #     @rl.add("key")
+  #   end
+  #   expect(@rl.count("key", 30)).to eq(31)
+  #
+  #   @value = nil
+  #   expect do
+  #     timeout(1) do
+  #       @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
+  #         @value = 2
+  #       end
+  #     end
+  #   end.to raise_error(Timeout::Error)
+  #   expect(@value).to be nil
+  #   # Timecop.travel(40) do
+  #   #   @rl.exec_within_threshold("key", {:threshold => 30, :interval => 30}) do
+  #   #     @value = 1
+  #   #   end
+  #   # end
+  #   # expect(@value).to be 1
+  # end
+
+  it 'counts correclty if bucket_span equals count-interval  ' do
+    @rl = RedisThrottler.new('key', {:bucket_span => 10, bucket_interval: 1})
+    @rl.add('value1')
+    expect(@rl.count('value1', 10)).to eql(1)
   end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: redis-throttler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Evan Surdam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,8 +113,9 @@ files:
 - README.md
 - Rakefile
 - gemspec.yml
-- lib/redis/throttler.rb
-- lib/redis/throttler/version.rb
+- lib/redis-throttler.rb
+- lib/redis-throttler/model.rb
+- lib/redis-throttler/version.rb
 - redis-throttler.gemspec
 - spec/spec_helper.rb
 - spec/throttler_spec.rb

data/lib/redis/throttler/version.rb

@@ -1,6 +0,0 @@
-module Redis
-  module Throttler
-    # redis-throttler version
-    VERSION = "0.1.0"
-  end
-end

data/lib/redis/throttler.rb

@@ -1 +0,0 @@
-require 'redis/throttler/version'