strait 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b67edb24f33952ec69ab17f533a8d3168e1f55260dbb319728dfe0fe5d0bb4a
-  data.tar.gz: 50dc7dc84ffb3fe38c28f8d26c8f326d84b3a4adc61f01fc0c2d6d597b584be7
+  metadata.gz: 459f330c3b15b42c2cd218e7bc60f4e1579288f60bb7e2cd6b286a970323f44d
+  data.tar.gz: 518f4012eeaa1170e0feddd5797f1b7777e47a0b0b64e5cd189978d14aa1c6ea
 SHA512:
-  metadata.gz: 174adfb33df0b92537baeb2d4ce741550896c52e3f63ab0f2dbf3a8392edeeede7616f40b54fbf1ee9fc2adc1bb7c2a7b9c9ac61012772845ff62fe4a9c8af5e
-  data.tar.gz: 9bb57fc4a10a8ad6bc1fe8241654dfb0dc76dcd343f0ddbaabedaf5fea0f267effb3ce310ac3e6aa1f6debcc27915d18a6d3db5b4d5dec54b301972b8e3b5b32
+  metadata.gz: 4185c8ad2907a75bc3577287193d35c5c7f35216d2ddd6c3e8a0d1e4063d2de043d735a38dc5f0d4134adf4fe0759311e3dbadf2bd5749be3d0e47b5a6692fb2
+  data.tar.gz: 21e760fc2801ffacff6a67f342ff7e0f204f4820c07503f0f9d830c2397b47b35c50427b2f4b0d4c2b3aef57029eb58fcb991cc852c7e58c9a4cdd22a5011fae

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "17:00"
+    timezone: America/Los_Angeles
+  open-pull-requests-limit: 10
+  reviewers:
+  - NuckChorris
+  ignore:
+  - dependency-name: connection_pool
+    versions:
+    - 2.2.4
+  - dependency-name: timecop
+    versions:
+    - 0.9.3

data/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release to rubygems
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "lib/strait/version.rb"
+
+jobs:
+  release:
+    name: Relase to Rubygems
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+
+      - name: Authenticate with Rubygems
+        run: |
+          mkdir -p $HOME/.gem/
+          echo "${RUBYGEMS_CREDENTIALS}" > $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+        env:
+          RUBYGEMS_CREDENTIALS: ${{ secrets.SENKO_SAN_RUBYGEMS_CREDENTIALS }}
+
+      - name: Publish Gem on Rubygems
+        run: bundle exec rake release:rubygem_push
+
+      - name: Create a Github Release
+        run: gh release create $(ruby -r './lib/strait/version' -e "puts Strait::VERSION") --target "${GITHUB_SHA}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.SENKO_SAN_KEY }}

data/.github/workflows/test.yml

@@ -0,0 +1,51 @@
+name: Strait Test Suite
+
+on:
+  push:
+  pull_request:
+    # Branches from forks have the form 'user:branch-name' so we only run
+    # this job on pull_request events for branches that look like fork
+    # branches. Without this we would end up running this job twice for non
+    # forked PRs, once for the push and then once for opening the PR.
+    branches:
+      - "**:**"
+
+env:
+  CC_TEST_REPORTER_ID: 1f7851d1df80cc24da6903abf795ee7a81a60b2cceb7eedd147c59c4ec232dd4
+
+jobs:
+  test:
+    name: RSpec Test Suite
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - ruby-2.6
+          - ruby-2.7
+        experimental: [false]
+        include:
+          - ruby: truffleruby-20
+            experimental: true
+          - ruby: ruby-3.0
+            experimental: true
+          - ruby: ruby-3.1
+            experimental: true
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby (${{ matrix.ruby }})
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run Tests
+        if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
+        run: bundle exec rspec
+
+      - name: Publish code coverage
+        uses: paambaati/codeclimate-action@v3.0.0

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    strait (1.1.0)
+    strait (1.2.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.3)
-    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)
+    connection_pool (2.2.5)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    mock_redis (0.31.0)
+      ruby2_keywords
+    rake (13.0.6)
+    redis (4.6.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    simplecov (0.17.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    timecop (0.9.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timecop (0.9.5)
 
 PLATFORMS
   ruby
@@ -41,11 +43,11 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   mock_redis (~> 0.21)
-  rake (~> 12.3)
+  rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (~> 0.17)
   strait!
   timecop (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.3.13

data/LICENSE.txt

@@ -175,18 +175,7 @@
 
    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.
+   Copyright 2021 Kitsu, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -2,16 +2,19 @@
 
 [![Coverage][shield-coverage]][coverage]
 [![Maintainability][shield-maintainability]][maintainability]
-[![Travis CI][shield-travis]][travis]
+[![Github Actions][shield-actions]][actions]
+[![Rubygem Version][shield-version]][version]
 
 [shield-coverage]: https://img.shields.io/codeclimate/coverage/hummingbird-me/strait.svg?logo=code-climate&style=for-the-badge
 [coverage]: https://codeclimate.com/github/hummingbird-me/strait/progress/coverage
 [shield-maintainability]: https://img.shields.io/codeclimate/maintainability/hummingbird-me/strait.svg?logo=code-climate&style=for-the-badge
 [maintainability]: https://codeclimate.com/github/hummingbird-me/strait/progress/maintainability
-[shield-travis]: https://img.shields.io/travis/com/hummingbird-me/strait/master.svg?logo=travis-ci&logoColor=white&style=for-the-badge
-[travis]: https://travis-ci.com/hummingbird-me/strait
+[shield-actions]: https://img.shields.io/github/checks-status/hummingbird-me/strait/main?style=for-the-badge
+[actions]: https://github.com/hummingbird-me/strait/actions
+[shield-version]: https://img.shields.io/gem/v/strait?label=%20&logo=rubygems&logoColor=white&style=for-the-badge
+[version]: https://rubygems.org/gems/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.
+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.
 
@@ -43,7 +46,7 @@ class SecureThingController
 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!
+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!
 
@@ -64,15 +67,15 @@ class SecureThingController
 end
 ```
 
-Viola, just like that, we've got rate limiting.  Now a user is limited to 5 per minute!
+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.
+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.
+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.
+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/
 

data/lib/strait/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Strait
-  VERSION = '1.1.0'
+  VERSION = '1.2.0' # Build 3
 end

data/lib/strait.rb

@@ -10,12 +10,12 @@ require 'strait/version'
 class Strait
   attr_reader :name, :config
 
-  def initialize(name, rules: [], **config)
+  def initialize(name, rules: [], **config, &block)
     @name = name
     @raw_rules = rules
     @config = Strait::Configuration.default.merge(config)
 
-    @raw_rules += Strait::DSL.new(&Proc.new).rules if block_given?
+    @raw_rules += Strait::DSL.new(&block).rules unless block.nil?
   end
 
   def limit!(user)
@@ -26,7 +26,7 @@ class Strait
 
     # Raise an exception for the first rate limit hit
     results.each do |rule, acceptable|
-      raise Strait::RateLimitExceeded, rule.to_h unless acceptable
+      raise Strait::RateLimitExceeded.new(**rule.to_h) unless acceptable
     end
   end
 

data/strait.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Emma Lejeck']
   spec.email = ['nuck@kitsu.io']
 
-  spec.summary = 'Rate-limiting to defend your nation-state'
+  spec.summary = 'Rate-limiting to defend your nation-state from pillagers'
   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.
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   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"
+  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.
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   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 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'timecop', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strait
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Emma Lejeck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,10 +144,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -168,6 +170,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/hummingbird-me/strait
   source_code_uri: https://github.com/hummingbird-me/strait
+  changelog_uri: https://github.com/hummingbird-me/strait/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -183,8 +186,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: Rate-limiting to defend your nation-state
+summary: Rate-limiting to defend your nation-state from pillagers
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
----
-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