grape-throttle 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e419d5ca87035a859306e47417bbe6be06d92193
+  data.tar.gz: f5713a6a7001d0a7299f020d479a0068b37f1147
+SHA512:
+  metadata.gz: cdb974ec369262a56552f919ffd0b9b1d40f63f7796f2a9271e2bc74f8c57173e77c599c0d31d21f3629ae06f9351f12d430c07db2408a0f5911721f88d4cff3
+  data.tar.gz: 522e49d89f4dacda20ca044f8e1370f7287886ebf21250fa8380b99b8a9b4027dda1c947782a0cf1350788ecdcd6304bd2b6bbf97ed131c50e3aeda1b7da70e3

data/lib/grape-throttle.rb

@@ -0,0 +1,8 @@
+require 'grape'
+require 'grape/extensions/throttle_extension'
+
+module Grape
+  module Middleware
+    autoload :ThrottleMiddleware,   'grape/middleware/throttle_middleware'
+  end
+end

data/lib/grape/extensions/throttle_extension.rb

@@ -0,0 +1,14 @@
+module Grape
+  module Extensions
+    module ThrottleExtension
+
+      def throttle(options={})
+        route_setting :throttle, options
+        options
+      end
+
+      Grape::API.extend self
+    end
+
+  end
+end

data/lib/grape/middleware/throttle_middleware.rb

@@ -0,0 +1,39 @@
+module Grape
+  module Middleware
+    class ThrottleMiddleware < Grape::Middleware::Base
+      def before
+        endpoint = env['api.endpoint']
+        return unless throttle_options = endpoint.route_setting(:throttle)
+
+        if limit = throttle_options[:hourly]
+          period = 1.hour
+        elsif limit = throttle_options[:daily]
+          period = 1.day
+        elsif limit = throttle_options[:monthly]
+          period = 1.month
+        end
+
+        user_key = options[:user_key]
+        user_value = nil
+        user_value = user_key.call(env) unless user_key.nil?
+        user_value ||= "ip:#{env['REMOTE_ADDR']}"
+
+        r = endpoint.routes.first
+        rate_key = "#{r.route_method}:#{r.route_path}:#{user_value}"
+
+        redis = options[:cache]
+        current = redis.get(rate_key).to_i
+        if !current.nil? && current >= limit
+          endpoint.error!("too many requests, please try again later", 403)
+        else
+          redis.multi do
+            redis.incr(rate_key)
+            redis.expire(rate_key, period.to_i)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/simple_api_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe "ThrottleHelper" do
+  subject do
+    Class.new(Grape::API) do
+      use Grape::Middleware::ThrottleMiddleware, cache: Redis.new
+
+      throttle daily: 3
+      get('/throttle') do
+        "step on it"
+      end
+    end
+  end
+
+  def app
+    subject
+  end
+
+  describe "#throttle" do
+    it "is not throttled within the rate limit" do
+      3.times { get "/throttle" }
+      expect(last_response.status).to eq(200)
+    end
+
+    it "is throttled beyond the rate limit" do
+      4.times { get "/throttle" }
+      expect(last_response.status).to eq(403)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'grape-throttle'
+require 'fakeredis'
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :test
+
+require 'rack/test'
+
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: grape-throttle
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alejandro Wainzinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A middleware for Grape to add endpoint-specific throttling.
+email:
+- alejandro.wainzinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/grape-throttle.rb
+- lib/grape/extensions/throttle_extension.rb
+- lib/grape/middleware/throttle_middleware.rb
+- spec/simple_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/xevix/grape-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.4
+signing_key: 
+specification_version: 4
+summary: A middleware for Grape to add endpoint-specific throttling.
+test_files:
+- spec/simple_api_spec.rb
+- spec/spec_helper.rb