full_throttle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 452b5545989069904cecc0d3ef959653fc9d21df
+  data.tar.gz: 3a83890b6ca55ce24fb3edfe8dfeb7d462f09fb9
+SHA512:
+  metadata.gz: dce830e7b8cb7a47a8459803255f355a635b69c0f2fea4558cbf9ffa97dc9b7d75b9e5612ddad575805884d9061ec04155fbd75ecd0f63b5f0cb335322c89d97
+  data.tar.gz: 83434f7de365a34edc82a3e0cec07d2bcf487a4cd9d30221f074d25e5ec0741594e0758506d9e3ac46f6d18ade72ba31e1f25e22304a9858c007c74f8096b372

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in throttle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    throttle (0.0.1)
+      redis (~> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    redis (3.0.7)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+    timecop (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec (~> 2.3)
+  throttle!
+  timecop (~> 0.7.1)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafael Bandeira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Throttle
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'throttle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install throttle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/throttle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/full_throttle.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'throttle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "full_throttle"
+  spec.version       = Throttle::VERSION
+  spec.authors       = ["Rafael Bandeira"]
+  spec.email         = ["rafaelbandeira3@gmail.com"]
+  spec.summary       = %q{Throttle mechanism for distributed work}
+  spec.description   = %q{Redis based throttle mechanism to be used by concurrent background jobs}
+  spec.homepage      = "https://github.com/rafaelbandeira3/full_throttle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis", "~> 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.3"
+  spec.add_development_dependency "timecop", "~> 0.7.1"
+end

data/lib/full_throttle.rb

@@ -0,0 +1 @@
+require "./throttle"

data/lib/throttle.lua

@@ -0,0 +1,15 @@
+local time            = tonumber(ARGV[1])
+local bucket_size     = tonumber(redis.call("get", KEYS[1])) or math.huge
+local bucket_time     = tonumber(redis.call("get", KEYS[2])) or time
+local bucket_count    = tonumber(redis.call("get", KEYS[3])) or 0
+local bucket_duration = tonumber(redis.call("get", KEYS[4])) or 1
+
+if time - bucket_time >= bucket_duration then -- reset bucket
+  redis.call("mset", KEYS[2], time, KEYS[3], 1)
+  return {1, 1, time}
+elseif bucket_count >= bucket_size then      -- throttled
+  return {0, bucket_count, bucket_time}
+else                                         -- good to go
+  redis.call("mset", KEYS[2], time, KEYS[3], bucket_count + 1)
+  return {1, bucket_count + 1, bucket_time}
+end

data/lib/throttle.rb

@@ -0,0 +1,28 @@
+require "redis"
+require "throttle/version"
+require "throttle/instance"
+require "throttle/redis_script"
+
+module Throttle
+  ThrottledError = Class.new(StandardError)
+
+  class << self
+    attr_accessor :default_redis_client,
+                  :default_timeout,
+                  :default_ns,
+                  :default_polling
+
+    def for(key, max_per_second, opts = {}, &block)
+      polling   = opts[:polling] || Throttle.default_polling
+      timeout   = opts[:timeout] || Throttle.default_timeout
+      redis     = opts[:redis]   || Throttle.default_redis_client
+      namespace = opts[:ns]      || Throttle.default_ns
+
+      strategy = RedisScript.new(redis, "#{namespace}:#{key}", max_per_second)
+      strategy.set_bucket_size!
+
+      instance = Instance.new(strategy, polling, timeout)
+      instance.limit(&block)
+    end
+  end
+end

data/lib/throttle/instance.rb

@@ -0,0 +1,31 @@
+require "timeout"
+
+module Throttle
+  class Instance
+    def initialize(strategy, polling, timeout)
+      @strategy = strategy
+      @polling = polling
+      @timeout = timeout
+    end
+
+    def limit(&block)
+      timeout(@timeout) do
+        loop do
+          go, count, time = @strategy.acquire
+          if go
+            return yield(count, time) if block.arity > 0
+            return yield
+          end
+          sleep @polling
+        end
+      end
+
+    rescue Timeout::Error
+      raise Throttle::ThrottledError, "can't execute at this time"
+    end
+
+    def status
+      @strategy.status
+    end
+  end
+end

data/lib/throttle/redis_script.rb

@@ -0,0 +1,45 @@
+require "digest"
+
+module Throttle
+  class RedisScript
+    SCRIPT      = File.read("lib/throttle.lua").freeze
+    SCRIPT_SHA1 = Digest::SHA1.hexdigest(SCRIPT)
+
+    def self.key(key, type)
+      "#{@key}:#{type}"
+    end
+
+    def initialize(redis, key, default_bucket_size)
+      @redis = redis
+      @key   = key
+      @default_bucket_size = default_bucket_size
+    end
+
+    def acquire
+      begin
+        keys = [key(:size), key(:time), key(:count), key(:duration)]
+        go, count, time = @redis.evalsha(SCRIPT_SHA1, keys, [Time.now.utc.to_i])
+        [go == 1, count, time]
+      rescue Redis::CommandError => e
+        raise unless e.message =~ /NOSCRIPT/
+
+        @redis.send("script", "load", SCRIPT)
+        acquire
+      end
+    end
+
+    def status
+      time, count, size = @redis.mget(key(:time), key(:count), key(:size))
+      [Time.at(time.to_i), count.to_i, size.to_i]
+    end
+
+    def set_bucket_size!(val = nil)
+      @redis.set(key(:size), val || @default_bucket_size)
+    end
+
+    private
+    def key(k)
+      self.class.key(@key, k)
+    end
+  end
+end

data/lib/throttle/version.rb

@@ -0,0 +1,3 @@
+module Throttle
+  VERSION = "0.0.1"
+end

data/spec/lib/throttle/instance_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Throttle::Instance do
+  let(:counter)  { double(:counter, count: nil) }
+  let(:strategy) { double(:throttle_strategy) }
+  let(:polling)  { 1 }
+  let(:timeout)  { 1 }
+  let(:key)      { "test" }
+
+  subject { described_class.new(strategy, polling, timeout) }
+
+  it "executes block if throttle strategy returns true" do
+    expect(strategy).to receive(:acquire).
+      exactly(3).times.and_return([true, :na, :na])
+    expect(counter).to receive(:count).exactly(3).times
+
+    3.times { subject.limit { counter.count } }
+  end
+
+  it "passes bucket count and time to block if it has arity" do
+    3.times do |n|
+      expect(strategy).to receive(:acquire).
+        and_return([true, n, t = Time.now])
+
+      subject.limit do |count, time|
+        expect(count).to eq n
+        expect(time).to  eq t
+      end
+    end
+  end
+
+  it "raises error if can't acquire before timeout" do
+    expect(strategy).to receive(:acquire).
+      once.and_return([false, :na, :na])
+    expect(counter).to_not receive(:count)
+
+    expect  { subject.limit { counter.count } }.to raise_error(Throttle::ThrottledError)
+  end
+
+  describe "retrying" do
+    let(:timeout)    { 0.60 }
+    let(:expected_repetition) { 4 }
+    let(:polling)    { timeout / expected_repetition }
+
+    it "retries once every `polling` seconds up to `timeout` seconds" do
+      expect(strategy).to receive(:acquire).
+        exactly(expected_repetition).times.and_return([false, :na, :na],
+                                                      [false, :na, :na],
+                                                      [false, :na, :na],
+                                                      [true, :na, :na])
+
+      subject.limit { counter.count }
+    end
+  end
+
+  it "returns status" do
+    expect(strategy).to receive(:status).and_return(:arbitrary_status)
+    expect(subject.status).to eq :arbitrary_status
+  end
+end

data/spec/lib/throttle/redis_script_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe Throttle::RedisScript do
+  let(:redis) { Redis.current }
+  let(:time)  { Time.now }
+
+  describe "instance" do
+    let(:key) { "test" }
+    let(:size) { 3 }
+    subject! { described_class.new(redis, key, size) }
+
+    describe "managing bucket size" do
+      let(:bucket_size) { redis.get(described_class.key(key, :size)).to_i }
+
+      it "sets to default if no value given" do
+        subject.set_bucket_size!
+        expect(bucket_size).to eq size
+      end
+
+      it "sets to given value" do
+        subject.set_bucket_size!(100)
+        expect(bucket_size).to eq 100
+      end
+    end
+
+    describe "status" do
+      it "returns info on window time, window runs, bucket size" do
+        expect(Time).to receive(:at).with(time.to_i).and_return(time)
+        redis.set(described_class.key(key, :time),  time.to_i)
+        redis.set(described_class.key(key, :count), "12")
+        redis.set(described_class.key(key, :size),  "24")
+        expect(subject.status).to eq [time, 12, 24]
+      end
+    end
+
+    describe "acquiring permission" do
+      before(:each) { subject.set_bucket_size! }
+
+      it "acquires entry on bucket if possible and returns time, count and flag" do
+        Timecop.freeze(time) do |t|
+          expect(subject.acquire).to eq [true,  1, t.to_i]
+          expect(subject.acquire).to eq [true,  2, t.to_i]
+          expect(subject.acquire).to eq [true,  3, t.to_i]
+          expect(subject.acquire).to eq [false, 3, t.to_i]
+          expect(subject.acquire).to eq [false, 3, t.to_i]
+        end
+      end
+
+      it "changes bucket size at runtime" do
+        Timecop.freeze(time) do |t|
+          expect(subject.acquire).to eq [true,  1, t.to_i]
+          expect(subject.acquire).to eq [true,  2, t.to_i]
+          expect(subject.acquire).to eq [true,  3, t.to_i]
+          expect(subject.acquire).to eq [false, 3, t.to_i]
+
+          subject.set_bucket_size!(4)
+          expect(subject.acquire).to eq [true,  4, t.to_i]
+        end
+      end
+    end
+  end
+end

data/spec/lib/throttle_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Throttle do
+  let(:key)     { :test }
+  let(:max)     { 30 }
+  let(:polling) { 0.25 }
+  let(:timeout) { 1 }
+  let(:redis)   { Redis.current }
+  let(:ns)      { :throttled_actions }
+  let(:counter) { double(:counter, count: nil) }
+  let(:opts)    { {} }
+
+  shared_examples "Throttle API" do
+    it "initializes throttle with options and limits given block" do
+      expect(described_class::RedisScript).to receive(:new).
+        with(redis, "#{ns}:#{key}", max).
+        and_call_original
+
+      expect(described_class::Instance).to receive(:new).
+        with(kind_of(described_class::RedisScript), polling, timeout).
+        and_call_original
+
+      expect(counter).to receive(:count)
+
+      described_class.for(key, max, opts) { counter.count }
+    end
+  end
+
+  describe "using options" do
+    let(:opts) { {polling: polling, timeout: timeout,  redis: redis, ns: ns} }
+    it_behaves_like "Throttle API"
+  end
+
+  describe "using defaults" do
+    before(:each) do
+      Throttle.default_polling = polling
+      Throttle.default_timeout = timeout
+      Throttle.default_redis_client = redis
+      Throttle.default_ns = ns
+    end
+    it_behaves_like "Throttle API"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "throttle")
+
+require "byebug"
+require "timecop"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    keys = Redis.current.scan_each.to_a
+    Redis.current.del(keys) if keys.any?
+  end
+end
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: full_throttle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael Bandeira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: Redis based throttle mechanism to be used by concurrent background jobs
+email:
+- rafaelbandeira3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- full_throttle.gemspec
+- lib/full_throttle.rb
+- lib/throttle.lua
+- lib/throttle.rb
+- lib/throttle/instance.rb
+- lib/throttle/redis_script.rb
+- lib/throttle/version.rb
+- spec/lib/throttle/instance_spec.rb
+- spec/lib/throttle/redis_script_spec.rb
+- spec/lib/throttle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rafaelbandeira3/full_throttle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Throttle mechanism for distributed work
+test_files:
+- spec/lib/throttle/instance_spec.rb
+- spec/lib/throttle/redis_script_spec.rb
+- spec/lib/throttle_spec.rb
+- spec/spec_helper.rb
+has_rdoc: