yabeda-rack-ratelimit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af2a7c5a6f86aba9c2dfde74aa7042732a7c1e6708837dd1f324177cee148e3e
+  data.tar.gz: ee0609741e37b5362955d8e3bc12340bbb7658bb500f51f7ffae2c9d0ad92d00
+SHA512:
+  metadata.gz: fe569e5fe14eeebf4b2ef6d52a5fdbfdb0c0e9b8bdaa5f9b1731e3fd4511f11e69c915377dd3ccb23f7c389ed0f4d854d39bf50f1ebf2e680653769723db47b1
+  data.tar.gz: e618a108d82029b62f542f984254d6806c7834fd933f86429403a25d601fdd795df360df86d820d7ed7cfa9a645d846177133dde1e3a09012d7877972a26684d

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.8
+          rubygems: latest
+
+      - name: Cache gem dependencies
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-bundler-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: ${{ runner.os }}-bundler-
+
+      - name: Install dependencies
+        run: gem install bundler && bundle install --jobs 4 --retry 3 --path vendor/bundle
+
+      - name: Run tests
+        run: bundle exec rake test

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    yabeda-rack-ratelimit (0.1.0)
+      rack-ratelimit
+      yabeda
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    anyway_config (2.4.2)
+      ruby-next-core (>= 0.14.0)
+    concurrent-ruby (1.2.2)
+    dry-initializer (3.1.1)
+    minitest (5.18.1)
+    rack-ratelimit (1.2.1)
+    rake (13.0.6)
+    ruby-next-core (0.15.3)
+    yabeda (0.11.0)
+      anyway_config (>= 1.0, < 3)
+      concurrent-ruby
+      dry-initializer
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  minitest
+  rake
+  yabeda-rack-ratelimit!
+
+BUNDLED WITH
+   2.4.17

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2023 37signals
+
+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,37 @@
+# yabeda-rack-ratelimit
+
+![CI](https://github.com/basecamp/yabeda-rack-ratelimit/actions/workflows/ci.yml/badge.svg)
+[![Gem Version](https://img.shields.io/gem/v/yabeda-rack-ratelimit.svg)](https://rubygems.org/gems/yabeda-rack-ratelimit)
+
+[Yabeda] plugin to collect metrics for [Rack::Ratelimit].
+
+## Get started
+
+To install the latest version using [Bundler][bundler]:
+
+```ruby
+gem "yabeda-rack-ratelimit"
+```
+
+## Metrics
+
+| Metric            | Type        | Tags                        | Description                                                        |
+|-------------------|-------------|-----------------------------|--------------------------------------------------------------------|
+| `requests_total`   | counter     | name | The total number of requests considered for rate limiting for a named ratelimit |
+| `exceeded_requests_total`  | counter   | name | The total number of requests that exceeded a named rate limit |
+| `clients_total`  | counter   | name | The total number of clients considered for rate limiting for a named ratelimit |
+| `exceeded_clients_total`  | counter   | name | The total number of clients that exceeded a named rate limit |
+| `quota_consumed_ratio`  | gauge   | name | The ratio of quota consumed to quota available for a named rate limit |
+
+## Acknowledgments
+
+yabeda-rack-ratelimit is [MIT-licensed](LICENSE.md) open-source software from [37signals](https://37signals.com/), the creators of [Ruby on Rails](https://rubyonrails.org).
+
+---
+
+© 2023 37signals, LLC.
+
+[Yabeda]: https://github.com/yabeda-rb/yabeda
+[Rack::Ratelimit]: https://github.com/jeremy/rack-ratelimit
+[bundler]: https://bundler.io
+[rubygems]: https://rubygems.org

data/Rakefile

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler/setup"
+require "rake"
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/bin/release

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+printf "module Yabeda\n  module Rack\n    module Ratelimit\n      VERSION = \"$VERSION\"\n    end\n  end\nend\n" > ./lib/yabeda/rack/ratelimit/version.rb
+bundle
+git add Gemfile.lock lib/yabeda/rack/ratelimit/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+gem build yabeda-rack-ratelimit.gemspec
+gem push "yabeda-rack-ratelimit-$VERSION.gem" --host https://rubygems.org
+rm "yabeda-rack-ratelimit-$VERSION.gem"

data/lib/yabeda/rack/ratelimit/instrumentation.rb

@@ -0,0 +1,31 @@
+module Yabeda
+  module Rack
+    module Ratelimit
+      module Instrumentation
+        private
+          def ratelimit_json(remaining, epoch)
+            report_stats(remaining)
+            super
+          end
+
+          def report_stats(remaining)
+            quota_consumed_ratio = (1 - remaining.to_f / @max)
+
+            Yabeda.rack_ratelimit.requests_total.increment({ name: @name })
+            Yabeda.rack_ratelimit.quota_consumed_ratio.set({ name: @name }, quota_consumed_ratio)
+
+            case remaining
+            when @max - 1 # On the first request within a rate-limiting period
+              Yabeda.rack_ratelimit.clients_total.increment({ name: @name })
+            when -1 # On the first request that exceeds the rate limit
+              Yabeda.rack_ratelimit.exceeded_clients_total.increment({ name: @name })
+            end
+
+            if remaining < 0
+              Yabeda.rack_ratelimit.exceeded_requests_total.increment({ name: @name })
+            end
+          end
+      end
+    end
+  end
+end

data/lib/yabeda/rack/ratelimit/version.rb

@@ -0,0 +1,7 @@
+module Yabeda
+  module Rack
+    module Ratelimit
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/yabeda/rack/ratelimit.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "yabeda"
+
+Yabeda.configure do
+  group :rack_ratelimit
+
+  default_tag :name, "", group: :rack_ratelimit
+
+  counter :requests_total, comment: "The total number of requests considered for rate limiting"
+  counter :exceeded_requests_total, comment: "The total number of requests that exceeded rate limits"
+  counter :clients_total, comment: "The total number of clients considered for rate limiting"
+  counter :exceeded_clients_total, comment: "The total number of clients that exceeded rate limits"
+  gauge   :quota_consumed_ratio, comment: "The ratio of quota consumed to quota available"
+end
+
+require_relative "ratelimit/instrumentation"
+Rack::Ratelimit.prepend Yabeda::Rack::Ratelimit::Instrumentation

data/yabeda-rack-ratelimit.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/yabeda/rack/ratelimit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-rack-ratelimit"
+  spec.version       = Yabeda::Rack::Ratelimit::VERSION
+  spec.authors       = ["Lewis Buckley"]
+  spec.email         = ["lewis@37signals.com"]
+
+  spec.summary       = "Instrumentation for Rack::Ratelimit"
+  spec.homepage      = "https://github.com/basecamp/yabeda-rack-ratelimit"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/basecamp/yabeda-rack-ratelimit"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|example|docs)/})
+    end
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "yabeda"
+  spec.add_runtime_dependency "rack-ratelimit"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-rack-ratelimit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lewis Buckley
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-ratelimit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- lewis@37signals.com
+executables:
+- release
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/release
+- lib/yabeda/rack/ratelimit.rb
+- lib/yabeda/rack/ratelimit/instrumentation.rb
+- lib/yabeda/rack/ratelimit/version.rb
+- yabeda-rack-ratelimit.gemspec
+homepage: https://github.com/basecamp/yabeda-rack-ratelimit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/basecamp/yabeda-rack-ratelimit
+  source_code_uri: https://github.com/basecamp/yabeda-rack-ratelimit
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Instrumentation for Rack::Ratelimit
+test_files: []