grape-throttler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff44f961112b47773a75e7c195b909e33938d0ada801d01ddd981f1f8ca8c854
+  data.tar.gz: e3422fd5c83dbec806d859f62c1bc5a6560fbe0da905b1fc4d6acbe13bb101b7
+SHA512:
+  metadata.gz: 3ee5867e71b9de391fea4a5e37385b522abe52c724aa261f4f48510b30b076c417bd76eab1b1de27c1ee742096b3e493c7dcc92453242708574780873a8a216e
+  data.tar.gz: 47544b35bd03f981dd5c7dffa4f5c8cc8a9e155968507ded18c60e9971b9626f45e4f965382fc55b6af9e7c35be0d1c58e29eea0285df2f27a3c5bf932a6a054

data/.fasterer.yml

@@ -0,0 +1,19 @@
+speedups:
+  rescue_vs_respond_to: false
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.irbrc_history
+
+# rspec failure tracking
+.rspec_status

data/.irbrc

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Awesome print
+begin
+  require 'awesome_print'
+
+  AwesomePrint.irb!
+rescue LoadError => err
+  warn "Couldn't load awesome_print: #{err}"
+end
+
+# IRB
+require 'irb/completion'
+
+ARGV.concat %w[--readline --prompt-mode simple]
+
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:EVAL_HISTORY] = 1000
+IRB.conf[:SAVE_HISTORY] = 1000
+IRB.conf[:HISTORY_FILE] = File.expand_path('.irbrc_history')
+
+# Rails
+railsrc_path = File.expand_path('.irbrc_rails')
+
+if (ENV['RAILS_ENV'] || defined?(Rails)) && File.exist?(railsrc_path)
+  begin
+    load railsrc_path
+  rescue Exception => err
+    warn "Could not load: #{railsrc_path} because of #{err}"
+  end
+end
+
+# Object
+class Object
+
+  def interesting_methods
+    case self.class
+    when Class then public_methods.sort - Object.public_methods
+    when Module then public_methods.sort - Module.public_methods
+    else public_methods.sort - Object.new.public_methods
+    end
+  end
+
+end

data/.reek.yml

@@ -0,0 +1,22 @@
+---
+detectors:
+  Attribute:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+  MissingSafeMethod:
+    enabled: false
+  NilCheck:
+    enabled: false
+  TooManyInstanceVariables:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+    exclude:
+      - 'GrapeThrottler::Middleware::ThrottleMiddleware#before'
+  UncommunicativeVariableName:
+    accept:
+      - '/^.$/'
+      - '/[0-9]$/'
+  UtilityFunction:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--backtrace
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'lib/**/**/templates/*'
+    - 'spec/**/**/*'
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+LineLength:
+  Max: 100
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/RescueException:
+  Enabled: false
+Lint/ScriptPermission:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hacklines_extractors.gemspec
+gemspec

data/README.md

@@ -0,0 +1,127 @@
+Grape Throttle
+==============
+
+[![Gem Version](https://badge.fury.io/rb/grape-throttle.svg)](https://badge.fury.io/rb/grape-throttle)
+[![Build Status](https://travis-ci.org/xevix/grape-throttle.svg)](https://travis-ci.org/xevix/grape-throttle)
+
+**Deprecation Warning**
+
+This gem is no longer being actively maintained. For similar throttle functionality see [rack-attack](https://github.com/kickstarter/rack-attack). Integration of this gem with rack-attack is a future consideration.
+
+**Description**
+
+The grape-throttle gem provides a simple endpoint-specific throttling mechanism for Grape.
+
+## Requirements
+
+* Grape >= 0.10.0
+* Redis
+
+## Usage
+
+### Build and Install
+
+To use, just install the gem from RubyGems or via Bundler by requiring it in your Gemfile.
+
+```
+gem 'grape-throttle'
+```
+
+### Middleware Setup
+
+Then in your Grape API, install the middleware which will do the throttling. At a minimum, it requires a Redis instance for caching as the `cache` parameter.
+
+**Simple Case**
+
+```ruby
+use Grape::Middleware::ThrottleMiddleware, cache: Redis.new
+```
+
+In this simple case, you just set up the middleware, and pass it a Redis instance.
+
+**Advanced Case**
+
+```ruby
+use Grape::Middleware::ThrottleMiddleware, cache: $redis, user_key: ->(env) do
+  # Use the current_user's id as an identifier
+  user = current_user
+  user.nil? ? nil : user.id
+end
+```
+
+In this more advanced case, the Redis instance is in the global variable `$redis`.
+
+The `user_key` parameter is a function that can be used to determine a custom identifier for a user. This key is used to form the Redis key to identify this user uniquely. It defaults to the IP address. The `env` parameter given to the function is the Rack environment and can be used to determine information about the caller.
+
+**Logging**
+
+The gem will log errors to STDOUT by default. If you prefer a different logger you can use the `logger` option to pass in your own logger.
+
+```ruby
+use Grape::Middleware::ThrottleMiddleware, cache: Redis.new, logger: Logger.new('my_custom_log.log')
+```
+
+### Endpoint Usage
+
+This gem adds a `throttle` DSL-like method that can be used to throttle different endpoints differently.
+
+The `throttle` method takes a Hash of the period to throttle, and the maximum allowed hits. After the maximum, the middleware throws an error with Grape's `error!` function.
+
+Supported predefined periods are: `:hourly`, `:daily`, `:monthly`.
+
+Example:
+
+```ruby
+class API < Grape::API
+  resources :users do
+
+    # Allow start of competition only every 10 minutes
+    desc "Start competition"
+    throttle period: 10.minutes, limit: 1
+    params do
+      requires :id, type: Integer, desc: "id"
+    end
+    post "/:id/competition" do
+      User.find(params[:id]).start_competition
+    end
+
+    # 3 times a day max
+    desc "Fetch a user"
+    throttle daily: 3
+    params do
+      requires :id, type: Integer, desc: "id"
+    end
+    get "/:id" do
+      User.find(params[:id])
+    end
+
+    # Once a month or the user will go crazy
+    desc "Poke a user"
+    throttle monthly: 1
+    params do
+      requires :id, type: Integer, desc: "id"
+    end
+    post "/:id/poke" do
+      User.find(params[:id]).poke
+    end
+
+    # No limit to the amount we can annoy users
+    desc "Annoy a user"
+    params do
+      requires :id, type: Integer, desc: "id"
+    end
+    post "/:id/annoy" do
+      User.find(params[:id]).annoy
+    end
+  end
+end
+```
+
+## TODO
+
+* Custom error handling and error strings, status etc.
+* Allow use of something other than Redis for caching
+
+## Thanks
+
+Thanks to the awesome Grape community, and to @dblock for all the help getting this thing going.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'grape-throttler'
+
+# 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/rake

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

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-throttler.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape-throttler/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'grape-throttler'
+  spec.version = GrapeThrottler::VERSION
+  spec.authors = ['Juan Gomez']
+  spec.email = ['j.gomez@drexed.com']
+
+  spec.summary = 'Gem for throttling grape requests.'
+  spec.description = 'A middleware for Grape to add endpoint-specific throttling.'
+  spec.homepage = 'http://drexed.github.io/grape-throttler'
+  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 = %w[lib]
+
+  spec.add_runtime_dependency 'grape', '>= 0.16.0'
+  spec.add_runtime_dependency 'rails'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'fakeredis'
+  spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/grape-throttler.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+%w[grape logger].each do |file_name|
+  require file_name
+end
+
+%w[version extensions/throttle_extension].each do |file_name|
+  require "grape-throttler/#{file_name}"
+end
+
+module GrapeThrottler
+  module Middleware
+
+    autoload :ThrottleMiddleware, 'grape-throttler/middleware/throttle_middleware'
+
+  end
+end

data/lib/grape-throttler/extensions/throttle_extension.rb

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

data/lib/grape-throttler/middleware/throttle_middleware.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module GrapeThrottler
+  module Middleware
+    class ThrottleMiddleware < Grape::Middleware::Base
+
+      COUNTER_START ||= 0
+
+      def before
+        endpoint = env['api.endpoint']
+        logger = options[:logger] || Logger.new(STDOUT)
+
+        return unless throttle_options = endpoint.route_setting(:throttle)
+
+        limit, period = find_limit_and_period(throttle_options)
+
+        check_limit_and_period(limit, period)
+
+        limit = limit.call(env) if limit.is_a?(Proc)
+        return true if limit.negative?
+
+        user_value = find_user_value(options) || "ip:#{env['REMOTE_ADDR']}"
+        rate_key = generate_rate_key(endpoint, user_value)
+
+        begin
+          redis = options[:cache]
+          redis.ping
+
+          current = redis.get(rate_key).to_i
+
+          if !current.nil? && current >= limit
+            endpoint.error!('too many requests, please try again later', 429)
+          else
+            redis.multi do
+              redis.set(rate_key, COUNTER_START, { nx: true, ex: period.to_i })
+              redis.incr(rate_key)
+            end
+          end
+        rescue Exception => e
+          logger.warn(e.message)
+        end
+      end
+
+      private
+
+      def check_limit_and_period(limit, period)
+        return unless limit.nil? || period.nil?
+
+        raise ArgumentError, 'Please set a period and limit (see documentation)'
+      end
+
+      def find_limit_and_period(throttle_options)
+        if limit = throttle_options[:hourly]
+          period = 1.hour
+        elsif limit = throttle_options[:daily]
+          period = 1.day
+        elsif limit = throttle_options[:monthly]
+          period = 1.month
+        elsif period = throttle_options[:period]
+          limit = throttle_options[:limit]
+        end
+
+        [limit, period]
+      end
+
+      def find_user_value(options)
+        user_key = options[:user_key]
+        return if user_key.nil?
+
+        user_key.call(env)
+      end
+
+      def generate_rate_key(endpoint, user_value)
+        epoint = endpoint.routes.first
+        "#{epoint.request_method}:#{epoint.path}:#{user_value}"
+      end
+
+    end
+  end
+end

data/lib/grape-throttler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GrapeThrottler
+  VERSION ||= '1.0.0'
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: grape-throttler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  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: 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: 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: reek
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fasterer.yml"
+- ".gitattributes"
+- ".gitignore"
+- ".irbrc"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- grape-throttler.gemspec
+- lib/grape-throttler.rb
+- lib/grape-throttler/extensions/throttle_extension.rb
+- lib/grape-throttler/middleware/throttle_middleware.rb
+- lib/grape-throttler/version.rb
+homepage: http://drexed.github.io/grape-throttler
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Gem for throttling grape requests.
+test_files: []