redis-throttler 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2efd874b28958cb9d0e7131dc9131162b51a6b8
-  data.tar.gz: 37a41540b2955373ab62e7acda33bfa404e6f931
+  metadata.gz: c3648bd744161a9c30693fd53fb7bfb490ab54f3
+  data.tar.gz: 1b7c3424b04912da66ed591db45e14a36e518e5d
 SHA512:
-  metadata.gz: 4cdf4289b6e02e4b75a2f57dbd61b6de2f4b770b99dfea206d77a826099549647513022295dc5a4c272e5f713e07409cdf0bf61495db8536827da9a8aca7779d
-  data.tar.gz: a4e7b42fbbdde3a74ada112876b67a26d65dc42dfecdb3c227d19e378e5c7299981aa7b07966c35d0002ba0ad1be7b542647333fe2f48c166708bca1ea7e9e63
+  metadata.gz: 7bff0a3c2299681c052da3d0333f6c7858ae5b689a2c434ead0e18de1bcfa83dbc94b9f241afb4509fe05c5eef3c2d5b9c5cd18cc0faf6b2aae0b20abd8f0bfa
+  data.tar.gz: bf0eac98c7f1cff826f20c79330f135b4252d58d8b47b77ce45000e20521d0df3dffebd52450efd4abb1d330e0217c2c289d15600d426a8f27610cf3af6ee1cd

data/lib/redis-throttler/base.rb

@@ -0,0 +1,120 @@
+module RedisThrottler
+  class Base
+    # 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
+end

data/lib/redis-throttler/model.rb

@@ -1,6 +1,4 @@
-require 'redis-throttler'
-
-class RedisThrottler
+module RedisThrottler
   module Model
 
     def self.included(base)
@@ -20,7 +18,7 @@ class RedisThrottler
         threshold = opts[:for] || 900
         interval = opts[:interval] || 5
 
-        limiter = RedisThrottler.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: threshold)
+        limiter = RedisThrottler::Base.new("#{klass}:#{key}", bucket_interval: interval, bucket_span: threshold)
         @limits[key] = "#{subject.to_s} limit #{limit} per #{threshold} sec"
 
         # includes('?') will return true

data/lib/redis-throttler/version.rb

@@ -1,3 +1,3 @@
-class RedisThrottler
-   VERSION = '0.1.4'
+module RedisThrottler
+   VERSION = '0.1.5'
 end

data/lib/redis-throttler.rb

@@ -1,120 +1,9 @@
 require 'redis'
+require 'redis-throttler/model'
+require 'redis-throttler/base'
 
-class RedisThrottler
-  # 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)
+module RedisThrottler
+  def self.included(base)
+    base.include(RedisThrottler::Model)
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 require 'rspec'
 require 'redis-throttler'
+require 'redis-throttler/base'
 

data/spec/throttler_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe RedisThrottler do
 
   before do
-    @rl = RedisThrottler.new('test')
+    @rl = RedisThrottler::Base.new('test')
     @rl.send(:redis).flushdb
   end
 
@@ -13,13 +13,13 @@ describe RedisThrottler do
 
   it 'should not allow bucket count less than 3' do
     expect do
-      RedisThrottler.new('test', {:bucket_span => 1, :bucket_interval => 1})
+      RedisThrottler::Base.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})
+      RedisThrottler::Base.new("key", {:bucket_expiry => 1200})
     end.to raise_error(ArgumentError)
   end
 
@@ -94,7 +94,7 @@ describe RedisThrottler do
   # end
 
   it 'counts correclty if bucket_span equals count-interval  ' do
-    @rl = RedisThrottler.new('key', {:bucket_span => 10, bucket_interval: 1})
+    @rl = RedisThrottler::Base.new('key', {:bucket_span => 10, bucket_interval: 1})
     @rl.add('value1')
     expect(@rl.count('value1', 10)).to eql(1)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-throttler
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Evan Surdam
@@ -114,6 +114,7 @@ files:
 - Rakefile
 - gemspec.yml
 - lib/redis-throttler.rb
+- lib/redis-throttler/base.rb
 - lib/redis-throttler/model.rb
 - lib/redis-throttler/version.rb
 - redis-throttler.gemspec