rails-action_throttling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe356734bdea7706d3062cfbb3db7da1e144ca36cfcacb02a3da7b588d61c78c
+  data.tar.gz: 548932e79c8ea177dddfd10b98c2d016281412b8574e9c2b0c0efc783bfa0bb2
+SHA512:
+  metadata.gz: 8e7fff81eb30bedb1445bda6065bc00a11d54eab4c08ce7e48f9ea3eb52de654e68910a98d9e1e7f6e5e8cfa91b056646bc46ac53cc79df1db480a640d12a5d1
+  data.tar.gz: 13d5f6265c73bdd15d8d8f18ee3a472d80f45e2eb2a8bc4f58bff6efb87ed2fe1895c455d757e4ac6b0626636d27799cab47f6d111f59e35aaf9a4e5c986994f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    rails-action_throttling (0.1.0)
+      activesupport (~> 5.2)
+      http-errors (~> 0.1)
+      redis (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    http-errors (0.1.3)
+      activesupport (~> 5.1)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rails-action_throttling!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emil Kampp
+
+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,51 @@
+# Action throttling
+
+## Usage
+
+```
+gem 'rails-action_throtling'
+```
+
+Configure your bucket. There are no default values for this, since we can't know your application specific implementation, so this step is mandatory.
+
+```ruby
+ActionThrottling.configure do |config|
+  # The bucket_key is evaluated inside your application context
+  config.bucket_key = Proc.new { current_user.bucket }
+
+  # Set the interval in which the bucket is regenerated
+  config.regenerate_interval = 10.minutes
+
+  # Sets the number of tokens to be pub back into the bucket
+  config.regenerate_amount = 100
+
+  # (optional) If you're not running on a completely vanilla redis connection,
+  # you can supply your own redis instance here.
+  config.redis = Redis.new 'http://redis-server.com'
+end
+```
+
+Then call the `cost` method on your actions that you want to protect:
+
+```ruby
+def show
+  # Every call will cost one credit
+  # Based on the configuration above, this will allow the user to call this
+  # endpoint 100 times every minute.
+  #
+  # This will call the `deduct(1)` method on the configured `config.bucket` (see
+  # above)
+  cost 1
+  # ...
+end
+```
+
+If you have something like a create method, or some complex method that's costly on the server side, you can set the cost appropriately:
+
+```ruby
+def complex_method
+  # This will call `deduct(25)` on the `config.bucket` (see above)
+  cost 25
+  # ...
+end
+```

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 "rails/action_throttling"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/action_throttling/configuration.rb

@@ -0,0 +1,21 @@
+module ActionThrottling
+  class Configuration
+    attr_accessor :bucket_key, :regenerate_amount, :regenerate_interval, :redis
+
+    def initialize
+      self.redis = Redis.new
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/action_throttling/version.rb

@@ -0,0 +1,3 @@
+module ActionThrottling
+  VERSION = "0.1.0"
+end

data/lib/action_throttling.rb

@@ -0,0 +1,76 @@
+require "redis"
+require "active_support/all"
+require "http_error"
+require "action_throttling/version"
+require "action_throttling/configuration"
+
+module ActionThrottling
+  MissingConfiguration = Class.new StandardError
+
+  module InstanceMethods
+    def cost(price)
+      # If last time the bucket was called is older than the regeneration limit
+      # regenerate the bucket.
+      regenerate if last_called < regeneration_time
+
+      # Deduct the price from the bucket. If it's below zero we raiss a
+      # HttpError::ToManyRequests exception/
+      if redis.decrby(bucket_key, price) < 0
+        raise HttpError::ToManyRequests, "Throttling enabled. Please try again later"
+      end
+
+      # Store when the cost was last called so we can calculate regeneration
+      redis.set last_call_key, Time.now.httpdate
+    end
+
+    private
+
+      def last_call_key
+        "#{bucket_key}-last-call"
+      end
+
+      def regenerate
+        redis.set bucket_key, ActionThrottling.configuration.regenerate_amount
+      end
+
+      def last_called
+        value = redis.get(last_call_key).presence
+
+        # trigger regeneration when first cost is first called
+        value ||= (regeneration_time - 1.second).httpdate
+
+        Time.parse value
+      end
+
+      def bucket_key
+        instance_eval &ActionThrottling.configuration.bucket_key
+      end
+
+      def regeneration_time
+        ActionThrottling.configuration.regenerate_interval.ago
+      end
+
+      def redis
+        @redis ||= Redis.new
+      end
+  end
+
+  def self.included(receiver)
+    unless ActionThrottling.configuration.bucket_key
+      raise ActionThrottling::MissingConfiguration,
+        'Missing bucket_key configuration. See documentation'
+    end
+
+    unless ActionThrottling.configuration.regenerate_interval
+      raise ActionThrottling::MissingConfiguration,
+        'Missing regenerate_interval configuration. See documentation'
+    end
+
+    unless ActionThrottling.configuration.regenerate_amount
+      raise ActionThrottling::MissingConfiguration,
+        'Missing regenerate_amount configuration. See documentation'
+    end
+
+    receiver.send :include, InstanceMethods
+  end
+end

data/rails-action_throttling.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_throttling/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-action_throttling"
+  spec.version       = ActionThrottling::VERSION
+  spec.authors       = ["Emil Kampp"]
+  spec.email         = ["emil@kampp.me"]
+
+  spec.summary       = "Rails per-action request throttling"
+  spec.description   = "Allows request throttling on a per-action basis"
+  spec.homepage      = "https://github.com/YouWeApS/arctic-gems-rails-action_throttling"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_runtime_dependency "http-errors", "~> 0.1"
+  spec.add_runtime_dependency "activesupport", "~> 5.2"
+  spec.add_runtime_dependency "redis", "~> 4.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: rails-action_throttling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emil Kampp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: http-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+description: Allows request throttling on a per-action basis
+email:
+- emil@kampp.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/action_throttling.rb
+- lib/action_throttling/configuration.rb
+- lib/action_throttling/version.rb
+- rails-action_throttling.gemspec
+homepage: https://github.com/YouWeApS/arctic-gems-rails-action_throttling
+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.3
+signing_key: 
+specification_version: 4
+summary: Rails per-action request throttling
+test_files: []