prop 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6876580ba3b335c884fbf9f549931b1a200f8be
-  data.tar.gz: 062fa3bf0d3f237e09ad258a1257559581bdfcf5
+  metadata.gz: c5753d3ad85cbb0e81257570a59b12362e7da611
+  data.tar.gz: 7ff4f5c528bfe42bc8b15a0a7e9193e6e13238bb
 SHA512:
-  metadata.gz: 75bf0a8a9c115a60e1ffaafa00aaf14c28837174a4a6efbb84183838963bc022c53dc5625bdfdb9ea71145b63a4edfd3127d6684744e5ad993c3b4d09d9231b2
-  data.tar.gz: ed67700ce432878bd7790145779f309d6a7b82192421cd5bbefe99133f6d99e3f385a5ec7a17360e79de8a05835cc60c5cda3bc0dacf0e5b8b15f47234ac7ebd
+  metadata.gz: b1b0d1f4239241457b30e60bd80db2301d47b38c1f6de67cbacce29f16de80d777d91ba21f1043f5f73f6f532fbdc487076d3fc97f8f5ffa20d4da3299a8a380
+  data.tar.gz: 160b608c60ed35e72426f2c053d4a8d77643cd1506dfe9a742819b23005373ac5550a4bb7f9bcab67f406ac70d04594f085027e17fc6da45990cce44bf76d6a8

data/README.md

@@ -142,10 +142,37 @@ Prop.throttle!(:mails_per_hour, nil)
 The default (and smallest possible) increment is 1, you can set that to any integer value using :increment which is handy for building time based throttles:
 
 ```ruby
-Prop.setup(:execute_time, :threshold => 10, :interval => 1.minute)
+Prop.configure(:execute_time, :threshold => 10, :interval => 1.minute)
 Prop.throttle!(:execute_time, account.id, :increment => (Benchmark.realtime { execute }).to_i)
 ```
 
+## Optional configuration
+
+You can add optional configuration to a prop and retrieve it using `Prop.configurations[:foo]`:
+
+```ruby
+Prop.configure(:api_query, :threshold => 10, :interval => 1.minute, :category => :api)
+Prop.configure(:api_insert, :threshold => 50, :interval => 1.minute, :category => :api)
+Prop.configure(:password_failure, :threshold => 5, :interval => 1.minute, :category => :auth)
+```
+
+```
+Prop.configurations[:api_query][:category]
+```
+
+You can use `Prop::RateLimited#config` to distinguish between errors:
+
+```ruby
+rescue Prop::RateLimited => e
+  case e.config[:category]
+  when :api
+    raise APIRateLimit
+  when :auth
+    raise AuthFailure
+  ...
+end 
+```
+
 ## License
 
 Copyright 2013 Zendesk

data/lib/prop.rb

@@ -2,12 +2,12 @@ require "prop/limiter"
 require "forwardable"
 
 module Prop
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 
   # Short hand for accessing Prop::Limiter methods
   class << self
     extend Forwardable
-    def_delegators :"Prop::Limiter", :read, :write, :configure, :disabled, :before_throttle
+    def_delegators :"Prop::Limiter", :read, :write, :configure, :configurations, :disabled, :before_throttle
     def_delegators :"Prop::Limiter", :throttle, :throttle!, :throttled?, :count, :query, :reset
   end
 end

data/lib/prop/limiter.rb

@@ -127,6 +127,11 @@ module Prop
       end
       alias :query :count
 
+      def handles
+        @handles ||= {}
+      end
+      alias :configurations :handles
+
       private
 
       def at_threshold?(mark, threshold)
@@ -146,7 +151,6 @@ module Prop
 
         [ options, cache_key ]
       end
-
     end
   end
 end

data/lib/prop/rate_limited.rb

@@ -15,5 +15,9 @@ module Prop
       self.cache_key   = cache_key
       self.retry_after = interval - Time.now.to_i % interval
     end
+
+    def config
+      Prop.configurations[@handle]
+    end
   end
 end

data/prop.gemspec

@@ -1,7 +1,7 @@
-Gem::Specification.new "prop", "1.0.2" do |s|
+Gem::Specification.new "prop", "1.1.0" do |s|
   s.name              = 'prop'
-  s.version           = '1.0.2'
-  s.date              = '2012-04-24'
+  s.version           = '1.1.0'
+  s.date              = '2014-12-31'
   s.rubyforge_project = 'prop'
   s.license           = "Apache License Version 2.0"
 

data/test/test_limiter.rb

@@ -1,6 +1,5 @@
 require 'helper'
 
-
 describe Prop::Limiter do
   before do
     @store = {}

data/test/test_prop.rb

@@ -111,12 +111,14 @@ describe Prop do
 
   describe "#throttle!" do
     it "increment counter correctly" do
+      Prop.configure(:hello, :threshold => 20, :interval => 20)
       3.times do |i|
         assert_equal (i + 1), Prop.throttle!(:hello, nil, :threshold => 10, :interval => 10)
       end
     end
 
     it "reset counter when time window is passed" do
+      Prop.configure(:hello, :threshold => 20, :interval => 20)
       3.times do |i|
         assert_equal (i + 1), Prop.throttle!(:hello, nil, :threshold => 10, :interval => 10)
       end
@@ -192,4 +194,12 @@ describe Prop do
     end
   end
 
+  describe "#configurations" do
+    it "returns the configuration" do
+      Prop.configure(:something, :threshold => 100, :interval => 30)
+      config = Prop.configurations[:something]
+      assert_equal 100, config[:threshold]
+      assert_equal 30, config[:interval]
+    end
+  end
 end

data/test/test_rate_limited.rb

@@ -1,19 +1,27 @@
 require 'helper'
 
 describe Prop::RateLimited do
-  describe "#initialize" do
-    before do
-      time = Time.at(1333685680)
-      Time.stubs(:now).returns(time)
+  before do
+    time = Time.at(1333685680)
+    Time.stubs(:now).returns(time)
 
-      @error = Prop::RateLimited.new(:handle => "foo", :threshold => 10, :interval => 60, :cache_key => "wibble", :description => "Boom!")
-    end
+    Prop.configure :foo, :threshold => 10, :interval => 60, :category => :api
+
+    @error = Prop::RateLimited.new(
+      :handle => :foo,
+      :threshold => 10,
+      :interval => 60,
+      :cache_key => "wibble",
+      :description => "Boom!"
+    )
+  end
 
-    it "return an error instance" do
+  describe "#initialize" do
+    it "returns an error instance" do
       assert @error.is_a?(StandardError)
       assert @error.is_a?(Prop::RateLimited)
 
-      assert_equal "foo", @error.handle
+      assert_equal :foo, @error.handle
       assert_equal "wibble", @error.cache_key
       assert_equal "Boom!", @error.description
       assert_equal "foo threshold of 10 tries per 60s exceeded for key 'nil', hash wibble", @error.message
@@ -21,4 +29,11 @@ describe Prop::RateLimited do
     end
   end
 
+  describe "#config" do
+    it "returns the original configuration" do
+      assert_equal 10, @error.config[:threshold]
+      assert_equal 60, @error.config[:interval]
+      assert_equal :api, @error.config[:category]
+    end
+  end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: prop
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   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'
 - !ruby/object:Gem::Dependency
   name: mocha
   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: Gem for implementing rate limits.
@@ -72,10 +72,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gemtest
-- .gitignore
-- .travis.yml
+- ".document"
+- ".gemtest"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -104,17 +104,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: prop
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem for implementing rate limits.