grape-attack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff307dec592ab729847359d3da1bbdfe624136b5
+  data.tar.gz: f20eff73c56b429c680a71a2db4a0cd7d53fd6f6
+SHA512:
+  metadata.gz: 8639ff18ef9e6d2a6123079bcd9071030e2bb5ee5d22056207ed48c01c4aa16667d4cde4ac74e1e175acf07ef69a2779b979d9afb3b2be4ace12f5af46c0b82a
+  data.tar.gz: b8849164cda638b09ea9e41fcad405778411096b6ca06876bee7983be090332f00b2710134b077d81a311230c5bf47bc52f64a2537d1e428c3c32fe0ecb3d3a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pierre-Louis Gottfrois
+
+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,137 @@
+[![Code Climate](https://codeclimate.com/github/gottfrois/grape-attack/badges/gpa.svg)](https://codeclimate.com/github/gottfrois/grape-attack)
+
+# Grape::Attack
+
+A middleware for Grape to add endpoint-specific throttling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-attack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-attack
+
+## Usage
+
+Mount the middleware in your API:
+
+```ruby
+class MyApi < Grape::API
+  use Grape::Attack::Throttle
+end
+```
+
+Define limits per endpoints using `throttle` DSL:
+
+```ruby
+class MyApi < Grape::API
+
+  use Grape::Attack::Throttle
+
+  resources :comments do
+
+    throttle max: 10, per: 1.minute
+    get do
+      Comment.all
+    end
+
+  end
+end
+```
+
+Use any [ActiveSupport Time extension to Numeric](http://edgeguides.rubyonrails.org/active_support_core_extensions.html#time) object.
+
+By default it will use the request ip address to identity the client making the request.
+You can pass your own identifier using a `Proc`:
+
+```ruby
+class MyApi < Grape::API
+
+  use Grape::Attack::Throttle
+
+  helpers do
+    def current_user
+      @current_user ||= User.authorize!(env)
+    end
+  end
+
+  resources :comments do
+
+    throttle max: 100, per: 1.day, identifier: Proc.new { current_user.id }
+    get do
+      Comment.all
+    end
+
+  end
+end
+```
+
+When rate limit is reached, it will raise `Grape::Attack::RateLimitExceededError` exception.
+You can catch the exception using `rescue_from`:
+
+```ruby
+class MyApi < Grape::API
+
+  use Grape::Attack::Throttle
+
+  rescue_from Grape::Attack::RateLimitExceededError do |e|
+    error!({ message: e.message }, 403)
+  end
+
+  resources :comments do
+
+    throttle max: 100, per: 1.day
+    get do
+      Comment.all
+    end
+
+  end
+end
+```
+
+Which would result in the following http response:
+
+```
+HTTP/1.1 403 Forbidden
+Content-Type: application/json
+
+{"message":"API rate limit exceeded for xxx.xxx.xxx.xxx."}
+```
+
+Finally the following headers will automatically be set:
+
+* `X-RateLimit-Limit` -- The maximum number of requests that the consumer is permitted to make per specified period.
+* `X-RateLimit-Remaining` -- The number of requests remaining in the current rate limit window.
+* `X-RateLimit-Reset` -- The time at which the current rate limit window resets in [UTC epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
+
+## Adapters
+
+Adapters are used to store the rate counter.
+Currently there is only a Redis adapter. You can set redis client url through `env['REDIS_URL']` varialble.
+
+Defaults to `redis://localhost:6379/0`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-attack.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grape/attack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grape-attack.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/attack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-attack"
+  spec.version       = Grape::Attack::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+
+  spec.summary       = %q{A middleware for Grape to add endpoint-specific throttling.}
+  spec.description   = %q{A middleware for Grape to add endpoint-specific throttling.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape", ">= 0.10"
+  spec.add_dependency "redis-namespace"
+  spec.add_dependency "activemodel", ">= 4.0"
+  spec.add_dependency "activesupport", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/grape/attack/adapters/memory.rb

@@ -0,0 +1,31 @@
+module Grape
+  module Attack
+    module Adapters
+      class Memory
+
+        attr_reader :data
+
+        def initialize
+          @data = {}
+        end
+
+        def get(key)
+          data[key]
+        end
+
+        def incr(key)
+          data[key] ||= 0
+          data[key] += 1
+        end
+
+        def expire(key, ttl_in_seconds)
+        end
+
+        def atomically(&block)
+          block.call
+        end
+
+      end
+    end
+  end
+end

data/lib/grape/attack/adapters/redis.rb

@@ -0,0 +1,61 @@
+require 'redis-namespace'
+
+module Grape
+  module Attack
+    module Adapters
+      class Redis
+
+        attr_reader :broker
+
+        def initialize
+          @broker = ::Redis::Namespace.new("grape-attack:#{env}:thottle", redis: ::Redis.new(url: url))
+        end
+
+        def get(key)
+          with_custom_exception do
+            broker.get(key)
+          end
+        end
+
+        def incr(key)
+          with_custom_exception do
+            broker.incr(key)
+          end
+        end
+
+        def expire(key, ttl_in_seconds)
+          with_custom_exception do
+            broker.expire(key, ttl_in_seconds)
+          end
+        end
+
+        def atomically(&block)
+          broker.multi(&block)
+        end
+
+        private
+
+        def with_custom_exception(&block)
+          block.call
+        rescue ::Redis::BaseError => e
+          raise ::Grape::Attack::StoreError.new(e.message)
+        end
+
+        def env
+          if defined?(::Rails)
+            ::Rails.env
+          elsif defined?(RACK_ENV)
+            RACK_ENV
+          else
+            ENV['RACK_ENV']
+          end
+        end
+
+        def url
+          ENV['REDIS_URL'] || 'redis://localhost:6379/0'
+        end
+
+      end
+    end
+  end
+end

data/lib/grape/attack/configurable.rb

@@ -0,0 +1,17 @@
+require 'grape/attack/configuration'
+
+module Grape
+  module Attack
+    module Configurable
+
+      def config
+        @config ||= ::Grape::Attack::Configuration.new
+      end
+
+      def configure
+        yield config if block_given?
+      end
+
+    end
+  end
+end

data/lib/grape/attack/configuration.rb

@@ -0,0 +1,14 @@
+module Grape
+  module Attack
+    class Configuration
+
+      attr_accessor :adapter, :disable
+
+      def initialize
+        @adapter = ::Grape::Attack::Adapters::Redis.new
+        @disable = Proc.new { false }
+      end
+
+    end
+  end
+end

data/lib/grape/attack/counter.rb

@@ -0,0 +1,40 @@
+module Grape
+  module Attack
+    class Counter
+
+      attr_reader :request, :adapter
+
+      def initialize(request, adapter)
+        @request = request
+        @adapter = adapter
+      end
+
+      def value
+        @value ||= begin
+          adapter.get(key).to_i
+        rescue ::Grape::Attack::StoreError
+          1
+        end
+      end
+
+      def update
+        adapter.atomically do
+          adapter.incr(key)
+          adapter.expire(key, ttl_in_seconds)
+        end
+      rescue ::Grape::Attack::StoreError
+      end
+
+      private
+
+      def key
+        "#{request.method}:#{request.path}:#{request.client_identifier}"
+      end
+
+      def ttl_in_seconds
+        request.throttle_options.per.to_i
+      end
+
+    end
+  end
+end

data/lib/grape/attack/exceptions.rb

@@ -0,0 +1,7 @@
+module Grape
+  module Attack
+    StoreError = Class.new(StandardError)
+    Exceptions = Class.new(StandardError)
+    RateLimitExceededError = Class.new(Exceptions)
+  end
+end

data/lib/grape/attack/extension.rb

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

data/lib/grape/attack/limiter.rb

@@ -0,0 +1,58 @@
+require 'grape/attack/request'
+require 'grape/attack/counter'
+
+module Grape
+  module Attack
+    class Limiter
+
+      attr_reader :request, :adapter, :counter
+
+      def initialize(env, adapter = ::Grape::Attack.config.adapter)
+        @request = ::Grape::Attack::Request.new(env)
+        @adapter = adapter
+        @counter = ::Grape::Attack::Counter.new(@request, @adapter)
+      end
+
+      def call!
+        return if disable?
+        return unless throttle?
+
+        if allowed?
+          update_counter
+          set_rate_limit_headers
+        else
+          fail ::Grape::Attack::RateLimitExceededError.new("API rate limit exceeded for #{request.client_identifier}.")
+        end
+      end
+
+      private
+
+      def disable?
+        ::Grape::Attack.config.disable.call
+      end
+
+      def throttle?
+        request.throttle?
+      end
+
+      def allowed?
+        counter.value < max_requests_allowed
+      end
+
+      def update_counter
+        counter.update
+      end
+
+      # Fix when https://github.com/ruby-grape/grape/issues/1069
+      # For now we use route_setting to store :remaining value.
+      def set_rate_limit_headers
+        request.context.route_setting(:throttle)[:remaining] = [0, max_requests_allowed - (counter.value + 1)].max
+      end
+
+      def max_requests_allowed
+        request.throttle_options.max.to_i
+      end
+
+    end
+  end
+end

data/lib/grape/attack/options.rb

@@ -0,0 +1,19 @@
+require 'active_model'
+
+module Grape
+  module Attack
+    class Options
+      include ActiveModel::Model
+
+      attr_accessor :max, :per, :identifier, :remaining
+
+      validates :max, presence: true
+      validates :per, presence: true
+
+      def identifier
+        @identifier || Proc.new {}
+      end
+
+    end
+  end
+end

data/lib/grape/attack/request.rb

@@ -0,0 +1,37 @@
+require 'grape/attack/options'
+
+module Grape
+  module Attack
+    class Request
+
+      attr_reader :env, :context, :request, :throttle_options
+
+      def initialize(env)
+        @env              = env
+        @context          = env['api.endpoint']
+        @request          = @context.routes.first
+        @throttle_options = ::Grape::Attack::Options.new(@context.route_setting(:throttle))
+      end
+
+      def method
+        request.route_method
+      end
+
+      def path
+        request.route_path
+      end
+
+      def client_identifier
+        context.instance_eval(&throttle_options.identifier) || env['REMOTE_ADDR']
+      end
+
+      def throttle?
+        return false unless context.route_setting(:throttle).present?
+        return true if throttle_options.valid?
+
+        fail ArgumentError.new(throttle_options.errors.full_messages)
+      end
+
+    end
+  end
+end

data/lib/grape/attack/throttle.rb

@@ -0,0 +1,28 @@
+require 'grape'
+require 'grape/attack/limiter'
+
+module Grape
+  module Attack
+    class Throttle < Grape::Middleware::Base
+
+      def before
+        ::Grape::Attack::Limiter.new(env).call!
+      end
+
+      # Fix when https://github.com/ruby-grape/grape/issues/1069
+      # For now we use route_setting to store :remaining value.
+      def after
+        request = ::Grape::Attack::Request.new(env)
+
+        return if ::Grape::Attack.config.disable.call
+        return unless request.throttle?
+
+        @app_response['X-RateLimit-Limit']     = request.context.route_setting(:throttle)[:max].to_s
+        @app_response['X-RateLimit-Remaining'] = request.context.route_setting(:throttle)[:remaining].to_s
+        @app_response['X-RateLimit-Reset']     = request.context.route_setting(:throttle)[:per].from_now.to_i.to_s
+        @app_response
+      end
+
+    end
+  end
+end

data/lib/grape/attack/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Attack
+    VERSION = '0.1.0'
+  end
+end

data/lib/grape/attack.rb

@@ -0,0 +1,14 @@
+require 'active_support/core_ext/numeric/time.rb'
+require 'grape/attack/version'
+require 'grape/attack/adapters/redis'
+require 'grape/attack/adapters/memory'
+require 'grape/attack/configurable'
+require 'grape/attack/extension'
+require 'grape/attack/exceptions'
+require 'grape/attack/throttle'
+
+module Grape
+  module Attack
+    extend Configurable
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: grape-attack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  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'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  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:
+- pierrelouis.gottfrois@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape-attack.gemspec
+- lib/grape/attack.rb
+- lib/grape/attack/adapters/memory.rb
+- lib/grape/attack/adapters/redis.rb
+- lib/grape/attack/configurable.rb
+- lib/grape/attack/configuration.rb
+- lib/grape/attack/counter.rb
+- lib/grape/attack/exceptions.rb
+- lib/grape/attack/extension.rb
+- lib/grape/attack/limiter.rb
+- lib/grape/attack/options.rb
+- lib/grape/attack/request.rb
+- lib/grape/attack/throttle.rb
+- lib/grape/attack/version.rb
+homepage: ''
+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.6
+signing_key: 
+specification_version: 4
+summary: A middleware for Grape to add endpoint-specific throttling.
+test_files: []