strait 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b40ba499b6bfc486b64738eef4de0a804d8d1a588f44ce2eeae8f2bc12bf3b70
+  data.tar.gz: 68bcbb30542760922e4c9719f333683a37698446a492585b7b6a6bc97f920e54
+SHA512:
+  metadata.gz: f4fcd37bc5522944443799ed209b90c12a65f3bd550e5bb0b2d6d0c84feb68d6e7019465d65f1ee16782b4e5ca078224179178289bde4c9610257934a45a2b15
+  data.tar.gz: fa5e4c6717dfe3bd1512ad82276fcf938e9bf0392aaa8b9003f26963bd0c715b102e79292d4062d5462913008cb9075edff750db3b2711db931b12c3e9748ca8

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+max_line_length = 100
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

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/.rubocop.yml

@@ -0,0 +1,292 @@
+AllCops:
+  Exclude:
+    - db/**/*
+    - bin/**/*
+    - Guardfile
+  DisplayCopNames: false
+  DisplayStyleGuide: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    inject: reduce
+    detect: find
+    find_all: select
+Style/CommentAnnotation:
+  Enabled: true
+  Keywords:
+  - TODO
+  - FIXME
+  - OPTIMIZE
+  - HACK
+  - REVIEW
+  - DEPRECATED
+Layout/DotPosition:
+  EnforcedStyle: leading
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Naming/FileName:
+  Enabled: true
+Style/FormatString:
+  Enabled: true
+  EnforcedStyle: format
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/GlobalVars:
+  Enabled: false
+Style/GuardClause:
+  Enabled: true
+  MinBodyLength: 3
+Style/IfUnlessModifier:
+  Enabled: true
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+Style/LambdaCall:
+  Enabled: true
+Style/Next:
+  Enabled: true
+  MinBodyLength: 3
+Style/NumericLiterals:
+  Enabled: true
+  MinDigits: 5
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    "%": "[]"
+    "%i": "[]"
+    "%q": "[]"
+    "%Q": "[]"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "[]"
+    "%W": "[]"
+    "%x": "[]"
+Naming/PredicateName:
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+Style/RaiseArgs:
+  Enabled: true
+  EnforcedStyle: exploded
+Style/SingleLineMethods:
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+  EnforcedStyle: space
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Style/SymbolProc:
+  Enabled: true
+Layout/TrailingBlankLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrivialAccessors:
+  Enabled: true
+  AllowDSLWriters: true
+Naming/VariableName:
+  Enabled: true
+  EnforcedStyle: snake_case
+Style/WordArray:
+  Enabled: true
+  MinSize: 2
+Metrics/AbcSize:
+  Enabled: true
+  Max: 25
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 5
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 500
+Metrics/ModuleLength:
+  Enabled: true
+  CountComments: false
+  Max: 500
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 10
+Metrics/LineLength:
+  Enabled: true
+  Max: 100
+  AllowURI: true
+  IgnoreCopDirectives: true
+  Exclude:
+    - config/routes.rb
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 100
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: false
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 8
+Lint/AssignmentInCondition:
+  Enabled: true
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Naming/AccessorMethodName:
+  Enabled: true
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/ArrayJoin:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Naming/AsciiIdentifiers:
+  Enabled: true
+Style/Attr:
+  Enabled: true
+Style/BlockComments:
+  Enabled: true
+Style/ColonMethodCall:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/EmptyLiteral:
+  Enabled: true
+Style/EvenOdd:
+  Enabled: true
+Layout/FlipFlop:
+  Enabled: true
+Style/IfWithSemicolon:
+  Enabled: true
+Style/Lambda:
+  EnforcedStyle: literal
+  # HACK: Until Rubocop is released with EnforcedStyle
+  Enabled: true
+Layout/LeadingCommentSpace:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: true
+Style/MultilineTernaryOperator:
+  Enabled: true
+Style/NegatedIf:
+  Enabled: true
+Style/NestedTernaryOperator:
+  Enabled: true
+Style/NilComparison:
+  Enabled: true
+Style/Not:
+  Enabled: true
+Style/OneLineConditional:
+  Enabled: true
+Style/PerlBackrefs:
+  Enabled: true
+Style/RedundantBegin:
+  Enabled: true
+Style/RedundantSelf:
+  Enabled: true
+Style/RescueModifier:
+  Enabled: true
+Style/SelfAssignment:
+  Enabled: true
+Style/ClassAndModuleChildren:
+  Enabled: true
+  Exclude:
+  - app/graphql/**/*
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+Layout/SpaceAfterColon:
+  Enabled: true
+Layout/SpaceAfterComma:
+  Enabled: true
+Layout/SpaceAroundKeyword:
+  Enabled: true
+Layout/SpaceAfterMethodName:
+  Enabled: true
+Layout/SpaceAfterNot:
+  Enabled: true
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+Layout/SpaceBeforeComma:
+  Enabled: true
+Layout/SpaceBeforeComment:
+  Enabled: true
+Layout/SpaceBeforeSemicolon:
+  Enabled: true
+Layout/SpaceAroundOperators:
+  Enabled: true
+Layout/SpaceInsideParens:
+  Enabled: true
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+Style/SpecialGlobalVars:
+  Enabled: true
+Layout/TrailingWhitespace:
+  Enabled: true
+Style/UnlessElse:
+  Enabled: true
+Style/VariableInterpolation:
+  Enabled: true
+Style/WhenThen:
+  Enabled: true
+Lint/Debugger:
+  Enabled: true
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Security/Eval:
+  Enabled: true
+Lint/HandleExceptions:
+  Enabled: true
+Lint/LiteralInInterpolation:
+  Enabled: true
+Lint/Loop:
+  Enabled: true
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+Lint/RequireParentheses:
+  Enabled: false
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+Lint/UselessSetterCall:
+  Enabled: true
+Rails/HasAndBelongsToMany:
+  Enabled: false
+Rails/TimeZone:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1f7851d1df80cc24da6903abf795ee7a81a60b2cceb7eedd147c59c4ec232dd4
+
+before_install: gem install bundler -v 2.0.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    strait (1.0.0)
+      connection_pool (>= 2.0, < 3.0)
+      redis (~> 4.0, >= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.2.0)
+    mock_redis (0.21.0)
+    rake (12.3.2)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  mock_redis (~> 0.21)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.17)
+  strait!
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Kitsu, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,80 @@
+# Strait
+
+Strait is a rate-limiting library designed to provide security you don't need to think about.  Whenever you have code to protect, put a Strait in front of it.
+
+It strikes an excellent balance between accuracy and memory usage, with a default accuracy of 1/60th of the limit period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strait'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strait
+
+## Usage
+
+Let's say you have a Rails controller with a lot of DoS attack potential.
+
+```ruby
+class SecureThingController
+  def do_a_scare
+    # Does some heavy work that could open it to a DoS attack!
+  end
+end
+```
+
+Well dang, that's no good.  Anybody could send thousands of requests to this and take your entire site down, right as you're meeting with an important investor!
+
+Let's put a Strait in front of it!
+
+```ruby
+class SecureThingController
+  ScareLimiter = Strait.new('do_a_scare') do
+    limit 5, per: 1.minute
+  end
+
+  rescue_from Strait::RateLimitExceeded do
+    render :rate_limit_exceeded
+  end
+
+  def do_a_scare
+    ScareLimiter.limit!(current_user)
+    # Does heavy work, but only if the user hasn't exceeded their rate limit!
+  end
+end
+```
+
+Viola, just like that, we've got rate limiting.  Now a user is limited to 5 per minute!
+
+## Accuracy
+
+To understand why Strait isn't perfectly accurate, we should understand how it's implemented.  Strait is based on [the bucketed-log pattern made popular by Figma][figma-post], which chooses lower memory usage over perfect accuracy.  Despite this decreased accuracy, it fails secure, and should have enough accuracy to not be noticed.
+
+Each rate limiter stores data as a set of _N buckets per period_.  For example, with 10 buckets and a 1-hour period, each bucket covers 6 minutes.  To check the limit, we sum all buckets which overlap the last hour.  If the buckets are large (like 6 minutes) this can be up to one bucket longer than the period, resulting in a longer block than 100% accuracy.
+
+The default accuracy in Strait is _60 buckets per period_.  For a 1-hour period, this is up to 1 minute of inaccuracy.  For a 1-minute period, it's up to 1-second.  For a 1-day period, it's up to 24 minutes.  You can adjust this to increase accuracy, but it will also use more memory.
+
+[figma-post]: https://www.figma.com/blog/an-alternative-approach-to-rate-limiting/
+
+## 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/hummingbird-me/strait.
+
+## License
+
+The gem is available as open source under the terms of the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).

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 'strait'
+
+# 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/strait/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'connection_pool'
+require 'forwardable'
+
+class Strait
+  class Configuration
+    extend Forwardable
+    attr_accessor :config
+    def_delegators :@config, :[], :[]=, :dig
+
+    class << self
+      attr_accessor :default
+    end
+
+    def initialize(config = {})
+      @config = config
+    end
+
+    def merge(new_config = nil)
+      return self if new_config.nil? || new_config.empty?
+
+      self.class.new(config.merge(new_config))
+    end
+
+    def redis_pool
+      @redis_pool ||= ConnectionPool.new(config[:pool] || {}) { Redis.new(config[:redis]) }
+    end
+  end
+end

data/lib/strait/dsl.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Strait
+  class DSL
+    attr_reader :rules
+
+    def initialize(&block)
+      @rules = []
+      instance_eval(&block)
+    end
+
+    def limit(count, per:, buckets: 60)
+      @rules << { count: count, period: per, buckets: buckets }
+    end
+  end
+end

data/lib/strait/rate_limit_exceeded.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Strait
+  class RateLimitExceeded < StandardError
+    def initialize(period:, count:, **_other)
+      @period = period
+      @count = count
+    end
+
+    def to_s
+      "Rate Limit Exceeded: #{@count} per #{@period} seconds"
+    end
+  end
+end

data/lib/strait/rule.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class Strait
+  class Rule
+    def initialize(name:, rule:, config:)
+      @name = name
+      @rule = rule
+      @config = config
+    end
+
+    def call(user)
+      period_count_for(user) <= @rule[:count]
+    end
+
+    def to_h
+      @rule
+    end
+
+    private
+
+    # Get the in-period hit count for a user
+    def period_count_for(user)
+      key = key_for(user)
+      # Round the timestamp to get the bucket
+      bucket_time = bucket_for(Time.now)
+      first_bucket = ((Time.now.to_i - @rule[:period]) / bucket_length).floor
+
+      @config.redis_pool.with do |redis|
+        redis.hincrby(key, bucket_time, 1)
+
+        # We need to iterate the list once to total the counts, so we use that one iteration to also
+        # find any buckets which should be removed.
+        results = redis.hgetall(key).each_with_object(total: 0, delete: []) do |(time, count), out|
+          if time.to_i < first_bucket
+            out[:delete] << time
+          else
+            out[:total] += count.to_i
+          end
+        end
+
+        redis.hdel(key, *results[:delete]) unless results[:delete].empty?
+        results[:total]
+      end
+    end
+
+    def bucket_for(time)
+      (time.to_f / bucket_length).floor * bucket_length
+    end
+
+    def bucket_length
+      @bucket_length ||= @rule[:period] / @rule[:buckets]
+    end
+
+    def key_for(user)
+      "strait:#{@name}-#{@rule[:count]}/#{@rule[:period]}:#{user}"
+    end
+  end
+end

data/lib/strait/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Strait
+  VERSION = '1.0.0'
+end

data/lib/strait.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'strait/configuration'
+require 'strait/dsl'
+require 'strait/rate_limit_exceeded'
+require 'strait/rule'
+require 'strait/version'
+
+# A rate-limiter which provides natural defenses for your nation-state. Or your API.
+class Strait
+  attr_reader :name, :config
+
+  def initialize(name, rules: [], **config)
+    @name = name
+    @raw_rules = rules
+    @config = Strait::Configuration.default.merge(config)
+
+    @raw_rules += Strait::DSL.new(&Proc.new).rules if block_given?
+  end
+
+  def limit!(user)
+    # Build a hash of { rule => acceptable } structure
+    results = rules.map { |rule| [rule, rule.call(user)] }.to_h
+
+    return if results.values.all?(true)
+
+    # Raise an exception for the first rate limit hit
+    results.each do |rule, acceptable|
+      raise Strait::RateLimitExceeded, rule.to_h unless acceptable
+    end
+  end
+
+  def self.configuration=(config)
+    Strait::Configuration.default = Strait::Configuration.new(config)
+  end
+
+  private
+
+  def rules
+    @rules ||= @raw_rules.map do |rule|
+      if rule.is_a?(Strait::Rule)
+        rule
+      else
+        Strait::Rule.new(config: @config, name: @name, rule: rule)
+      end
+    end
+  end
+end

data/strait.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strait/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'strait'
+  spec.version = Strait::VERSION
+  spec.authors = ['Emma Lejeck']
+  spec.email = ['nuck@kitsu.io']
+
+  spec.summary = 'Rate-limiting to defend your nation-state'
+  spec.description = <<~DESC
+    Strait is a rate-limiting library designed to provide security you don't need to think about.
+    Whenever you have code to protect, put a Strait in front of it.
+  DESC
+  spec.homepage = 'https://github.com/hummingbird-me/strait'
+  spec.license = 'Apache-2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hummingbird-me/strait'
+  # spec.metadata["changelog_uri"] = "https://github.com/hummingbird-me/strait/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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', '~> 2.0'
+  spec.add_development_dependency 'mock_redis', '~> 0.21'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_runtime_dependency 'connection_pool', '>= 2.0', '< 3.0'
+  spec.add_runtime_dependency 'redis', '>= 3.0', '~> 4.0'
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: strait
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Emma Lejeck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !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: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |
+  Strait is a rate-limiting library designed to provide security you don't need to think about.
+  Whenever you have code to protect, put a Strait in front of it.
+email:
+- nuck@kitsu.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strait.rb
+- lib/strait/configuration.rb
+- lib/strait/dsl.rb
+- lib/strait/rate_limit_exceeded.rb
+- lib/strait/rule.rb
+- lib/strait/version.rb
+- strait.gemspec
+homepage: https://github.com/hummingbird-me/strait
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/hummingbird-me/strait
+  source_code_uri: https://github.com/hummingbird-me/strait
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Rate-limiting to defend your nation-state
+test_files: []