rate_limiter 0.0.6 → 0.1.0

data/lib/rate_limiter/model_config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rate_limiter/validator'
+
+module RateLimiter
+  # Sets up RateLimiter configuration for an ActiveRecord model.
+  class ModelConfig
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    # Set up `@model_class` for RateLimiter. Includes callbacks, class
+    # attributes, instance methods, etc.
+    def setup(options = {})
+      @model_class.send(:include, Model::InstanceMethods)
+      setup_options(options)
+      setup_validations
+    end
+
+    private
+
+    def setup_options(options)
+      @model_class.class_attribute :rate_limiter_options
+      @model_class.rate_limiter_options = options.dup
+    end
+
+    def setup_validations
+      # TODO: Maybe make it so the context can be configured.
+      @model_class.validate(on: :create) do |record|
+        Validator.new(record).validate
+      end
+    end
+  end
+end

data/lib/rate_limiter/request.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'request_store'
+
+module RateLimiter
+  # Manages configuration and state for the current HTTP request such as
+  # `source`.
+  #
+  # It is recommended you don't use `RateLimiter::Request` directly. Instead
+  # use `RateLimiter.request`.
+  module Request
+    class InvalidOption < RuntimeError; end
+
+    class << self
+      # Turn off RateLimiter for the given model for this request.
+      def disable_model(model_class)
+        enabled_for_model(model_class, false)
+      end
+
+      # Turn on RateLimiter for the given model for this request.
+      def enable_model(model_class)
+        enabled_for_model(model_class, true)
+      end
+
+      # Returns `true` if RateLimiter is enabled for the current request,
+      # `false` otherwise.
+      def enabled?
+        !!store[:enabled]
+      end
+
+      # Sets whether RateLimiter is enabled or disabled for the current request.
+      def enabled=(value)
+        store[:enabled] = value
+      end
+
+      # Sets wheterh RateLimiter is enabled or disabled for this model for the
+      # current request.
+      def enabled_for_model(model, value)
+        store[:"enabled_for_#{model}"] = value
+      end
+
+      # Returns `true` if RateLimiter is enabled for this model for the current
+      # request, `false` otherwise.
+      def enabled_for_model?(model)
+        model.include?(Model::InstanceMethods) && !!store.fetch(:"enabled_for_#{model}", true)
+      end
+
+      def merge(options)
+        options.to_h.each do |k, v|
+          store[k] = v
+        end
+      end
+
+      def set(options)
+        store.clear
+        merge(options)
+      end
+
+      # Returns who is responsible for attempting to create a new record.
+      def source
+        who = store[:source]
+        who.respond_to?(:call) ? who.call : who
+      end
+
+      # Sets who is responsible for attempting to create a new record.
+      def source=(value)
+        store[:source] = value
+      end
+
+      # Returns a deep copy of the RequestStore.
+      def to_h
+        store.deep_dup
+      end
+
+      # Temporarily set options and execute a block.
+      def with(options)
+        return unless block_given?
+
+        before = to_h
+        validate_public_options(options)
+        merge(options)
+        yield
+      ensure
+        set(before)
+      end
+
+      private
+
+      # Internal store for the options for this request.
+      def store
+        RequestStore.store[:rate_limiter] ||= {
+          enabled: true
+        }
+      end
+
+      # Double checks that the options passed are known. Does not validate
+      # the values of the options.
+      def validate_public_options(options)
+        options.each do |k, _v|
+          case k
+          when /enabled_for_/,
+              :enabled,
+              :source
+            next
+          else
+            raise InvalidOption, "Invalid option: #{k}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rate_limiter/throttle.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RateLimiter
+  # Limits the rate at which new records of an ActiveRecord model can be saved.
+  # Checks to see if RateLimiter is enabled and, if all conditions are satisfied
+  # and if any other records have been created within the time interval for rate
+  # limiting.
+  class Throttle
+    DEFAULT_INTERVAL = 1.minute
+    DEFAULT_ON_FIELD = :ip_address
+    DEFAULT_TIMESTAMP_FIELD = :created_at
+
+    def initialize(record, options = {})
+      @record = record
+      @options = options
+    end
+
+    # Has the rate limit been exceeded?
+    def exceeded?
+      enabled? && rate_limit? && others_for_rate_limiting.present?
+    end
+
+    private
+
+    # Is RateLimiter enabled for this particular record?
+    def enabled?
+      RateLimiter.enabled? &&
+        RateLimiter.request.enabled? &&
+        RateLimiter.request.enabled_for_model?(@record.class)
+    end
+
+    # Proc that if present must return true for RateLimiter to be enabled for
+    # this particular record.
+    def if_condition
+      @options[:if_condition]
+    end
+
+    # The time interval (in seconds)
+    def interval
+      @options[:interval] || DEFAULT_INTERVAL
+    end
+
+    # Arel query for finding records within the interval.
+    def interval_query_params
+      @record.class.arel_table[timestamp_field].gteq(Time.current - interval)
+    end
+
+    # An Array of model attribute names to match against.
+    def on
+      Array(@options[:on] || DEFAULT_ON_FIELD)
+    end
+
+    # Arel query for finding records that match the on attributes.
+    def on_query_params
+      on.map { |attr| @record.class.arel_table[attr].eq(@record.send(attr)) }.inject(&:or)
+    end
+
+    # Other records that fall within the time interval.
+    def others_for_rate_limiting
+      @record.class.where(on_query_params).where(interval_query_params)
+    end
+
+    # Are all of the conditions for rate limiting met for this record?
+    def rate_limit?
+      (if_condition.blank? || if_condition.call(@record)) && !unless_condition.try(:call, @record)
+    end
+
+    # Timestamp field to test the interval against.
+    def timestamp_field
+      @options[:timestamp_field] || DEFAULT_TIMESTAMP_FIELD
+    end
+
+    # Proc that if present must return false for RateLimiter to be enabled for
+    # this particular record.
+    def unless_condition
+      @options[:unless_condition]
+    end
+  end
+end

data/lib/rate_limiter/validator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RateLimiter
+  # Validates whether a model's rate limit has been exceeded.
+  class Validator
+    def initialize(record, options = {})
+      @record = record
+      @options = options
+    end
+
+    def validate
+      return unless @record.rate_limit_exceeded?
+
+      @record.errors.add(:base, I18n.t('rate_limiter.errors.rate_limit_exceeded', object_type: object_type, default: default_error_message))
+
+      false
+    end
+
+    private
+
+    def default_error_message
+      "You cannot create a new #{object_type} yet."
+    end
+
+    def object_type
+      @record.class.name
+    end
+  end
+end

data/lib/rate_limiter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RateLimiter
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/rate_limiter.gemspec

@@ -1,32 +1,38 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+
 require 'rate_limiter/version'
 
 Gem::Specification.new do |s|
   s.name        = 'rate_limiter'
   s.version     = RateLimiter::VERSION
-  s.authors     = ['Sean Eshbaugh']
-  s.email       = ['seaneshbaugh@gmail.com']
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+  s.author      = 'Sean Eshbaugh'
+  s.email       = 'seaneshbaugh@gmail.com'
   s.homepage    = 'https://github.com/seaneshbaugh/rate_limiter'
   s.summary     = 'Adds creation rate limiting to ActiveRecord models.'
   s.description = 'Adds creation rate limiting to ActiveRecord models.'
 
-  s.rubyforge_project = 'rate_limiter'
+  s.required_ruby_version     = '>= 2.5.0'
+  s.required_rubygems_version = '>= 1.8.11'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = Dir['lib/**/*', 'CHANGELOG.md', 'LICENSE.txt', 'README.md', 'rate_limiter.gemspec']
+  s.executables   = []
   s.require_paths = ['lib']
 
-  s.add_dependency 'railties', '>= 3.2'
-  s.add_dependency 'activerecord', '>= 3.2'
+  s.add_dependency 'activerecord', '>= 5.0.0'
+  s.add_dependency 'railties', '>= 5.0.0'
+  s.add_dependency 'request_store', '~> 1.4'
 
-  s.add_development_dependency 'capybara'
-  s.add_development_dependency 'database_cleaner'
-  s.add_development_dependency 'jquery-rails'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rails', '>= 3.2'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'shoulda-matchers'
-  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'minitest-spec-rails', '6.0.2'
+  s.add_development_dependency 'pry', '0.12.2'
+  s.add_development_dependency 'puma', '4.3.1'
+  s.add_development_dependency 'rails', '6.0.2.1'
+  s.add_development_dependency 'rake', '13.0.1'
+  s.add_development_dependency 'rubocop', '0.79.0'
+  s.add_development_dependency 'simplecov', '0.18.1'
+  s.add_development_dependency 'sqlite3', '1.4.2'
+  s.add_development_dependency 'timecop', '0.9.1'
 end

metadata

@@ -1,311 +1,226 @@
 --- !ruby/object:Gem::Specification
 name: rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean Eshbaugh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: request_store
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: minitest-spec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: puma
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.2.1
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
-  name: shoulda-matchers
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 description: Adds creation rate limiting to ActiveRecord models.
-email:
-- seaneshbaugh@gmail.com
+email: seaneshbaugh@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- LICENSE.txt
 - README.md
-- Rakefile
+- lib/generators/rate_limiter/install_generator.rb
+- lib/generators/rate_limiter/templates/rate_limiter.rb
 - lib/rate_limiter.rb
 - lib/rate_limiter/config.rb
-- lib/rate_limiter/controller.rb
+- lib/rate_limiter/frameworks/rails.rb
+- lib/rate_limiter/frameworks/rails/controller.rb
 - lib/rate_limiter/model.rb
+- lib/rate_limiter/model_config.rb
+- lib/rate_limiter/request.rb
+- lib/rate_limiter/throttle.rb
+- lib/rate_limiter/validator.rb
 - lib/rate_limiter/version.rb
 - rate_limiter.gemspec
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/images/rails.png
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/messages_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/mailers/.gitkeep
-- spec/dummy/app/models/message.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/messages/_form.html.erb
-- spec/dummy/app/views/messages/_message.html.erb
-- spec/dummy/app/views/messages/edit.html.erb
-- spec/dummy/app/views/messages/index.html.erb
-- spec/dummy/app/views/messages/new.html.erb
-- spec/dummy/app/views/messages/show.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/migrate/20121213101512_create_messages.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/seeds.rb
-- spec/dummy/lib/assets/.gitkeep
-- spec/dummy/lib/tasks/.gitkeep
-- spec/dummy/log/.gitkeep
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/script/rails
-- spec/rate_limiter/model_spec.rb
-- spec/rate_limiter_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/seaneshbaugh/rate_limiter
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
-rubyforge_project: rate_limiter
-rubygems_version: 1.8.24
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Adds creation rate limiting to ActiveRecord models.
-test_files:
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/images/rails.png
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/messages_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/mailers/.gitkeep
-- spec/dummy/app/models/message.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/messages/_form.html.erb
-- spec/dummy/app/views/messages/_message.html.erb
-- spec/dummy/app/views/messages/edit.html.erb
-- spec/dummy/app/views/messages/index.html.erb
-- spec/dummy/app/views/messages/new.html.erb
-- spec/dummy/app/views/messages/show.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/migrate/20121213101512_create_messages.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/seeds.rb
-- spec/dummy/lib/assets/.gitkeep
-- spec/dummy/lib/tasks/.gitkeep
-- spec/dummy/log/.gitkeep
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/script/rails
-- spec/rate_limiter/model_spec.rb
-- spec/rate_limiter_spec.rb
-- spec/spec_helper.rb
+test_files: []