full_throttle 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 452b5545989069904cecc0d3ef959653fc9d21df
-  data.tar.gz: 3a83890b6ca55ce24fb3edfe8dfeb7d462f09fb9
+  metadata.gz: b46c0880281fcab9692c92cc16af9744b558af25
+  data.tar.gz: dbd5096b50d090cb1cb9e598fcedef8548c56324
 SHA512:
-  metadata.gz: dce830e7b8cb7a47a8459803255f355a635b69c0f2fea4558cbf9ffa97dc9b7d75b9e5612ddad575805884d9061ec04155fbd75ecd0f63b5f0cb335322c89d97
-  data.tar.gz: 83434f7de365a34edc82a3e0cec07d2bcf487a4cd9d30221f074d25e5ec0741594e0758506d9e3ac46f6d18ade72ba31e1f25e22304a9858c007c74f8096b372
+  metadata.gz: 13584c7e550fc25474d98f45da57177f848d53017c310f207ea3aff6464c4500e72aa6299d678df1e1151913eb929e5247893610df642505c99a59536ae9196b
+  data.tar.gz: 090680a38e771d545bbd26d8035677b4e7f0b2d49a401c4e37656cd42b3abfbac1c2064151ee813f085925a84bee50b0c1eb9e11f12e797b3a33a4729fa0dd3c

data/README.md

@@ -1,6 +1,45 @@
-# Throttle
+# Full Throttle
+
+![](http://www.necessarygames.com/sites/default/files/game_teaser_images/full_throttle_teaser.png)
+
+Pull the breaks on your background processing, protect api calls from abuse, and manage throughput with 0 hassle leveraging Redis to throttle concurrent processes.
+
+Atomicity and thread-safety of throttle guaranteed by good use of Redis.
+
+## Usage
+
+```ruby
+response = Throttle.for(:user_info, 200) { api["users/#{id}"].get }
+user.update(response)
+```
+
+There we have `:user_info` is the id of the throttle, `200` is the number of times that id can be executed in one second. *Full Throttle* is designed for high speed action, not long throttling windows.
+
+__get updated status__
+
+```ruby
+instance = Throttle.for(:user_info)
+instance.status # [ bucket_time, bucket_count, bucket_size ]
+```
+
+__handle or log throttled actions__
+
+```ruby
+begin
+  Throttle.for(:search_index, 300) { record.update_index! }
+rescue Throttle::ThrottledError => e
+  ...
+end
+```
+
+__manage throughput without code pushes__ running on the console or on a cronjob to raise the limits at night and take it easy during the day
+
+```ruby
+if (22...7).include?(Time.now.hour)
+  Throttle.for(:upstream_sync).set_bucket_size!(500)
+end
+```
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -18,13 +57,9 @@ 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 )
+1. Fork it ( https://github.com/rafaelbandeira3/full_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`)

data/full_throttle.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "redis", "~> 3.0.0"
+  spec.add_dependency "redis", "~> 3.0"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 2.3"

data/lib/throttle.rb

@@ -12,7 +12,7 @@ module Throttle
                   :default_ns,
                   :default_polling
 
-    def for(key, max_per_second, opts = {}, &block)
+    def for(key, max_per_second = nil, opts = {}, &block)
       polling   = opts[:polling] || Throttle.default_polling
       timeout   = opts[:timeout] || Throttle.default_timeout
       redis     = opts[:redis]   || Throttle.default_redis_client
@@ -22,7 +22,7 @@ module Throttle
       strategy.set_bucket_size!
 
       instance = Instance.new(strategy, polling, timeout)
-      instance.limit(&block)
+      block_given? ? instance.limit(&block) : instance
     end
   end
 end

data/lib/throttle/version.rb

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

data/spec/lib/throttle/redis_script_spec.rb

@@ -34,29 +34,49 @@ describe Throttle::RedisScript do
     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
+      before(:each) { Timecop.freeze(time) }
+      after(:each)  { Timecop.return }
+
+      it "returns time, count and flag" do
+        expect(subject.acquire).to eq [true,  1, time.to_i]
       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]
+      context do
+        before(:each) { subject.set_bucket_size! }
+        it "acquires entry on bucket isn't full" do
+          expect(subject.acquire).to eq [true,  1, time.to_i]
+          expect(subject.acquire).to eq [true,  2, time.to_i]
+          expect(subject.acquire).to eq [true,  3, time.to_i]
+          expect(subject.acquire).to eq [false, 3, time.to_i]
+          expect(subject.acquire).to eq [false, 3, time.to_i]
+        end
+
+        it "empties bucket after bucket duration" do
+          expect(subject.acquire).to eq [true,  1, time.to_i]
+          expect(subject.acquire).to eq [true,  2, time.to_i]
+          expect(subject.acquire).to eq [true,  3, time.to_i]
+          expect(subject.acquire).to eq [false, 3, time.to_i]
+
+          Timecop.freeze(time + 1)
+          expect(subject.acquire).to eq [true,  1, (time + 1).to_i]
+        end
+
+        it "changes bucket size at runtime" do
+          expect(subject.acquire).to eq [true,  1, time.to_i]
+          expect(subject.acquire).to eq [true,  2, time.to_i]
+          expect(subject.acquire).to eq [true,  3, time.to_i]
+          expect(subject.acquire).to eq [false, 3, time.to_i]
 
           subject.set_bucket_size!(4)
-          expect(subject.acquire).to eq [true,  4, t.to_i]
+          expect(subject.acquire).to eq [true,  4, time.to_i]
         end
       end
+
+      it "acquires always if no size set" do
+        credibility = ENV["CREDIBLE"] ? Float::INFINITY : 20
+
+        (0..credibility).each {|n| expect(subject.acquire).to eq [true,  n + 1, time.to_i] }
+      end
     end
   end
 end

data/spec/lib/throttle_spec.rb

@@ -11,7 +11,7 @@ describe Throttle do
   let(:opts)    { {} }
 
   shared_examples "Throttle API" do
-    it "initializes throttle with options and limits given block" do
+    before(:each) do
       expect(described_class::RedisScript).to receive(:new).
         with(redis, "#{ns}:#{key}", max).
         and_call_original
@@ -19,9 +19,14 @@ describe Throttle do
       expect(described_class::Instance).to receive(:new).
         with(kind_of(described_class::RedisScript), polling, timeout).
         and_call_original
+    end
 
-      expect(counter).to receive(:count)
+    it "initializes throttle with options" do
+      expect(described_class.for(key, max, opts)).to be_a(described_class::Instance)
+    end
 
+    it "initializes and returns limit" do
+      expect(counter).to receive(:count)
       described_class.for(key, max, opts) { counter.count }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: full_throttle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Rafael Bandeira
@@ -14,70 +14,70 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.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
@@ -113,17 +113,17 @@ 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
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Throttle mechanism for distributed work
@@ -132,4 +132,3 @@ test_files:
 - spec/lib/throttle/redis_script_spec.rb
 - spec/lib/throttle_spec.rb
 - spec/spec_helper.rb
-has_rdoc: