grape-throttle 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7aa5547937fb454f0583fb0de8afa0bd4bc9f24
-  data.tar.gz: 5187f0ef73e75a02e5740a634070c88c46da05ba
+  metadata.gz: 7ed50ef26f42b2a23a70ca4980f489a0aa84054d
+  data.tar.gz: 9637edba76b7b8962e6c94d0d45cc97e3fb9820d
 SHA512:
-  metadata.gz: e5f9d9602b3b66a10407c56781a81f36443622106a70170ce05d52f2012d077df3962e4302ea6c81ab4d3257bd4283e76e1f00aaf1a71fd2ef294391c8eb21c4
-  data.tar.gz: 2344d9a392ebd39aed4f5c931509ace4ec989f5677633fc1ae6e893a6be947e689c55f495606126325c64d5970abd71b96ccbc25f6d60333ed2893492c33ed84
+  metadata.gz: 53d9d218043ac41857ba6cbde85eca9069a557ef4374b57dc3882f08447d12f68ddcf6c5626a464de02eeb4d27d023136b532e32d669501e95c4e48e8517e1b7
+  data.tar.gz: 636e71131d1aca85d3ade3eb523654127aec25a7b6a8cfd26823e640bd7e64122c88c3756dfbfb5cbbb24ff7180b0872b303e3d3dac8811f70a293189fe2da8f

data/lib/grape/middleware/throttle_middleware.rb

@@ -11,6 +11,11 @@ module Grape
           period = 1.day
         elsif limit = throttle_options[:monthly]
           period = 1.month
+        elsif period = throttle_options[:period]
+          limit = throttle_options[:limit]
+        end
+        if limit.nil? || period.nil?
+          raise ArgumentError.new('Please set a period and limit (see documentation)')
         end
 
         user_key = options[:user_key]

data/spec/simple_api_spec.rb

@@ -9,6 +9,20 @@ describe "ThrottleHelper" do
       get('/throttle') do
         "step on it"
       end
+
+      get('/no-throttle') do
+        "step on it"
+      end
+
+      throttle period: 10.minutes, limit: 3
+      get('/throttle-custom-period') do
+        "step on it"
+      end
+
+      throttle
+      get('/wrong-configuration') do
+        "step on it"
+      end
     end
   end
 
@@ -26,5 +40,31 @@ describe "ThrottleHelper" do
       4.times { get "/throttle" }
       expect(last_response.status).to eq(403)
     end
+
+    describe "with custom period" do
+
+      it "is not throttled within the rate limit" do
+        3.times { get "/throttle-custom-period" }
+        expect(last_response.status).to eq(200)
+      end
+
+      it "is throttled beyond the rate limit" do
+        4.times { get "/throttle-custom-period" }
+        expect(last_response.status).to eq(403)
+      end
+
+    end
+
+    it "throws an error if period or limit is missing" do
+      expect { get("wrong-configuration") }.to raise_exception
+    end
+
+    it "only throttles if explicitly specified" do
+      expect do
+        10.times { get "/no-throttle" }
+      end.not_to raise_exception
+      expect(last_response.status).to eq(200)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-throttle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alejandro Wainzinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test