raterr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4614602ed0eff315d079ff1c3bc3aa833b78c79
+  data.tar.gz: 39b4868b210bb9ab286e3cb8d7c1a150dfb0d680
+SHA512:
+  metadata.gz: fdde30dccf0a1222370af16f6e497d847e4d91d22982c3c3cd37cc8f8457c67f947ce6671ecf6974ce1ad9a310b6ab5ad2e08d4fcd0abfee9d5a8d2dd245e950
+  data.tar.gz: 71119931434fc2def696903d3523c42364455d63564c2a4ef5301f64a0fd49ab327cb429b80d3643cffbaf172f5ddcaa4761216d501df7caecebbc8edd3ddb14

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wizard.oneandonly@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raterr.gemspec
+gemspec
+gem 'byebug', require: false
+gem 'codecov', require: false, group: :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stefan Slaveykov
+
+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,88 @@
+# Raterr
+[![Build Status](https://travis-ci.org/wizardone/raterr.svg?branch=master)](https://travis-ci.org/wizardone/raterr)
+[![codecov](https://codecov.io/gh/wizardone/raterr/branch/master/graph/badge.svg)](https://codecov.io/gh/wizardone/raterr)
+
+`Raterr` allows you to enforce rate limiting restrictions on visitors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'raterr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raterr
+
+## Usage
+For Ruby based application you need to tell `Raterr` what store to use.
+Currently it supports a simple hash or a `ActiveSupport::Cache::MemoryStore`
+It is best to load the store in an initializer of any other kind of file
+that is loaded initially.
+```ruby
+# Use either
+Raterr::Cache.store = ActiveSupport::Cache::MemoryStore.new
+# Or
+Raterr::Cache.store = Hash.new
+```
+To enforce rate limiting use:
+```ruby
+Raterr.enforce(request, period: :minute, max: 200, code: 429)
+```
+The result of `Raterr.enforce` is always a pseudo status. In case the
+rate limit has not been reached you will get a pseudo `200` status + the
+number of attempts. This allows you to do additional checks. If
+it has been reached you will get whatever status you configured, or the
+default one, which is 429 + a text message.
+
+An example usage in a Rails application would be:
+```ruby
+class MyController < Base::ApplicationController
+  before_action :rate_limit, only: :index
+
+  def index
+    # Do something cool
+  end
+
+  private
+
+  def rate_limit
+    result = Raterr.enforce(request, period: :minute, max: 10)
+    if result[:status] == 429
+      # Do whatever you want to do when the rate limit is reached
+      render plain: result[:text], status: result[:status] and return
+    else
+      puts "Number of attempts: #{result[:attempts]}"
+    end
+  end
+end
+```
+If you want to add limiting to the whole app you would put it in an
+application controller and so on...
+
+You can configure the period error code and the max attempts. The allowed periods
+are: `:minute, :hour, :day`.
+
+Currently `Raterr` checks the unique ip address of the visitor to
+determine the amount of visits.
+## 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/wizardone/raterr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 "raterr"
+
+# 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/raterr/day.rb

@@ -0,0 +1,25 @@
+module Raterr
+  class Day
+
+    include Mixin
+
+    HOURS_PER_DAY = 24.freeze
+
+    private
+
+    def max_per_day
+      options[:max]
+    end
+    alias_method :max_per_period, :max_per_day
+
+    def rate_period
+      start_time + 3600 * HOURS_PER_DAY
+    end
+
+    def try_after
+      "#{HOURS_PER_DAY - ((Time.now - start_time) / 3600).ceil} hours"
+    end
+  end
+end
+
+

data/lib/raterr/hour.rb

@@ -0,0 +1,24 @@
+module Raterr
+  class Hour
+
+    include Mixin
+
+    MINUTES_PER_HOUR = 60.freeze
+
+    private
+
+    def max_per_hour
+      options[:max]
+    end
+    alias_method :max_per_period, :max_per_hour
+
+    def rate_period
+      start_time + 3600
+    end
+
+    def try_after
+      "#{MINUTES_PER_HOUR - ((Time.now - start_time) / MINUTES_PER_HOUR).ceil} minutes"
+    end
+  end
+end
+

data/lib/raterr/minute.rb

@@ -0,0 +1,23 @@
+module Raterr
+  class Minute
+
+    include Mixin
+
+    SECONDS_PER_MINUTE = 60.freeze
+
+    private
+
+    def max_per_minutes
+      options[:max]
+    end
+    alias_method :max_per_period, :max_per_minutes
+
+    def rate_period
+      start_time + SECONDS_PER_MINUTE
+    end
+
+    def try_after
+      "#{SECONDS_PER_MINUTE - (Time.now - start_time).ceil} seconds"
+    end
+  end
+end

data/lib/raterr/mixin.rb

@@ -0,0 +1,65 @@
+module Raterr
+  module Mixin
+
+    attr_reader :request, :options
+
+    def initialize(request, options)
+      @request = request
+      @options = options
+    end
+
+    def rate_limit_exceeded
+      {
+        status: options[:code] || Raterr::DEFAULTS[:code],
+        text: Raterr::DEFAULTS[:message] % { time: try_after }
+      }
+    end
+
+    def allowed?
+      reset_cache if Time.now > rate_period
+      fetch_cache[:attempts] <= max_per_period
+    end
+
+    def proceed
+      attempts = fetch_cache[:attempts] + 1
+      set_cache(attempts)
+
+      {
+        status: 200,
+        attempts: attempts
+      }
+    end
+
+    private
+
+    def identifier
+      # TODO: extend with other options from the request
+      request.ip.to_s
+    end
+
+    def fetch_cache
+      cache.fetch(identifier) { { attempts: 1, start_time: Time.now } }
+    end
+
+    def set_cache(value)
+      cache_attributes = {}.tap do |cache|
+        cache[:attempts] = value
+        cache[:start_time] = start_time
+      end
+      cache.is_a?(Hash) ? cache[identifier] = cache_attributes :
+                          cache.write(identifier, cache_attributes)
+    end
+
+    def reset_cache
+      cache.delete(identifier)
+    end
+
+    def cache
+      Raterr.store
+    end
+
+    def start_time
+      fetch_cache[:start_time]
+    end
+  end
+end

data/lib/raterr/period_builder.rb

@@ -0,0 +1,32 @@
+module Raterr
+  class PeriodBuilder
+
+    attr_reader :request, :period, :options
+
+    class << self
+      def call(request, options)
+        new(request, options).build
+      end
+    end
+
+    def initialize(request, options)
+      @period = options[:period] || DEFAULTS[:period]
+      @request = request
+      @options = options
+    end
+
+    def build
+      klass = case period
+        when :minute
+          Raterr::Minute
+        when :hour
+          Raterr::Hour
+        when :day
+          Raterr::Day
+        else
+          raise "Invalid limit period, available options are: #{Raterr::AVAILABLE_PERIODS.join(', ')}"
+        end
+      klass.new(request, options)
+    end
+  end
+end

data/lib/raterr/version.rb

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

data/lib/raterr.rb

@@ -0,0 +1,27 @@
+require 'raterr/version'
+require 'raterr/period_builder'
+require 'raterr/mixin'
+require 'raterr/hour'
+require 'raterr/day'
+require 'raterr/minute'
+
+module Raterr
+
+  AVAILABLE_PERIODS = [:minute, :hour, :day, :week, :month].freeze
+  DEFAULTS = {
+    max: 100,
+    code: 429,
+    message: "Rate limit exceeded. Try again in %{time}.",
+    period: :hour
+  }.freeze
+
+  class << self
+
+    attr_accessor :store
+
+    def enforce(request, **options)
+      period = PeriodBuilder.call(request, options)
+      period.allowed? ? period.proceed : period.rate_limit_exceeded
+    end
+  end
+end

data/raterr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raterr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "raterr"
+  spec.version       = Raterr::VERSION
+  spec.authors       = ["Stefan Slaveykov"]
+  spec.email         = ["wizard.oneandonly@gmail.com"]
+
+  spec.summary       = %q{Ruby rate limiter}
+  spec.description   = %q{A gem allowing you to set rate limiting on your application}
+  spec.homepage      = "https://github.com/wizardone/raterr"
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: raterr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Slaveykov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: A gem allowing you to set rate limiting on your application
+email:
+- wizard.oneandonly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/raterr.rb
+- lib/raterr/day.rb
+- lib/raterr/hour.rb
+- lib/raterr/minute.rb
+- lib/raterr/mixin.rb
+- lib/raterr/period_builder.rb
+- lib/raterr/version.rb
+- raterr.gemspec
+homepage: https://github.com/wizardone/raterr
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby rate limiter
+test_files: []