rate_limit_mock_server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b9fb178144b8150f25d9b8c9bcbe5007157ff1fbd6017ba14f1ea757b3b9d59
+  data.tar.gz: e8519a29959d189058bffd6befdd8e3f85bf20f8f4b9089bc2582c7491e6f63a
+SHA512:
+  metadata.gz: 0c1e2fac0497c9068e8e141040963d4761c58867d99de765a6c2a72b5aa259da195fc522a2d971f35946caf73c14763334378c1edc48b1a2f4c1d9ad5614771b
+  data.tar.gz: dd7ddd4668028866c2a8a5c6c3fe47d14d430179a97c5b15aefb000182207a8c7c30ee9eba4d863ff134dc2da03d7f4590b4e7508509a89aa5761e2ef26644a8

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rate_limit_mock_server.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    rate_limit_mock_server (0.1.0)
+      sinatra
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rate_limit_mock_server!
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sammy Henningsson
+
+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,66 @@
+# RateLimitMockServer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rate_limit_mock_server`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rate_limit_mock_server'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rate_limit_mock_server
+
+## Usage
+To start the server from code, do this:
+```ruby
+  require 'rate_limit_mock_server`
+
+  # Start the server on port 4567 and block the current thread
+  RateLimitMockServer.start
+```
+
+Note, If you don't want the server to block the current thread, you can instead spawn a new thread for the server.
+```ruby
+  require 'rate_limit_mock_server`
+
+  thread = Thread.new do
+    # Start the server on port 4567 and block the current thread
+    RateLimitMockServer.start
+  end
+
+  # Add some sleep to allow the server to be started
+  sleep(2)
+  
+  do_some
+  other_stuff
+  # ...
+
+  RateLimitMockServer.quit!
+  thread.join
+```
+
+The server can be stopped by either `RateLimitMockServer.quit!` or by sending a GET to `http://localhost:4567/quit`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/sammyhenningsson/rate_limit_mock_server.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rate_limit_mock_server"
+
+# 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/rate_limit_mock_server

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$: << File.expand_path('../lib/', __dir__)
+  
+require 'rate_limit_mock_server'
+  
+RateLimitMockServer.start

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/certs/sammyhenningsson.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQsFADBGMRowGAYDVQQDDBFzYW1t
+eS5oZW5uaW5nc3NvbjETMBEGCgmSJomT8ixkARkWA2hleTETMBEGCgmSJomT8ixk
+ARkWA2NvbTAeFw0yMjA0MDYxOTAxMDJaFw0yNDA2MTQxOTAxMDJaMEYxGjAYBgNV
+BAMMEXNhbW15Lmhlbm5pbmdzc29uMRMwEQYKCZImiZPyLGQBGRYDaGV5MRMwEQYK
+CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+r5IMLWZ/KG5wnpVrbWsgdQaxwS1Ct2/IGrEUbWzZOA8wC/hFurB0lU9ruSO1sLOy
+UAOVQTWiu7YL6twmwy1UZfTa6Qwg8dPU6NPLLT8QyoupLLdZ5EjwA/INLEJVt76H
+kEx/fNmdh911HoB4buWfT1PU/+1f72VMxz4j4NbV9SVCBjjwI1RrK+0lHrWy9e9c
+yuEuGLb1JCKDWqYfpmh7bb8mAf6bYmSw+d1jkSneCp8NzoibC7a8a+YYSskPrcUH
+RdD/BvhZUfiXuwdBJN8oOnxIiYK3XGo2AjKPDnvxkbaB4Yuidy7GAOttD9QUgnXW
+UNl3i8t68yGcjFNImk+vZwIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
+AgSwMB0GA1UdDgQWBBS6SOPUJ3Z5rog4cMtl7TKbOzaNaTAkBgNVHREEHTAbgRlz
+YW1teS5oZW5uaW5nc3NvbkBoZXkuY29tMCQGA1UdEgQdMBuBGXNhbW15Lmhlbm5p
+bmdzc29uQGhleS5jb20wDQYJKoZIhvcNAQELBQADggEBAEcMp9iEErm3laanowRC
+xrvBR1uUyb73oTNPE2A3vknsLhJ/4tpJPcPkxgvh2P3bdwP//JHU9EYRKHY22R+7
+jS4iSTbD7PQr3xdD5cA9j36562Wmac9uNTxJ9amtTcdmQqSDo9NcECFn3IhD+ljf
+knR95SHUDD4FNQGLzrTTB8daYjO4Dro7vqOfZGcgk26uqWLrgcvdfzFyhZ8XwwzO
+Q3eW5l4nbscDR/o3jV8WX5Y+Gm2YptuRHWe2S9YI5YkHXtDzPDREv0GRJmaRmGCz
+hDgtXQiNH/WrZi6kriR8NgvZIZobYz4qKW9nAuVEa3qqegirIKi6BtcHr1pWrWt1
+FDc=
+-----END CERTIFICATE-----

data/lib/rate_limit_mock_server/counter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rate_limit_mock_server/rate_limit_error'
+
+module RateLimitMockServer
+  class Counter
+    class << self
+      def for(key, rps_limit)
+        counters[key] ||= Counter.new(rps_limit)
+        counters[key]
+      end
+
+      private
+
+      def counters
+        @counters ||= {}
+      end
+    end
+
+    def initialize(rps_limit)
+      @rps_limit = rps_limit
+      @window = []
+    end
+
+    def current
+      size
+    end
+
+    def increment
+      window << Time.now.to_f
+      window.shift while delta && 1.0 < delta
+      window.last
+    end
+
+    def increment!
+      increment
+      return if current <= rps_limit
+
+      raise RateLimitError.new(rate: current, limit: rps_limit)
+    end
+
+    private
+
+    def size
+      window.size
+    end
+
+    def delta
+      return if size < 2
+
+      window.last - window.first
+    end
+
+    attr_reader :rps_limit, :window
+  end
+end

data/lib/rate_limit_mock_server/rate_limit_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RateLimitMockServer
+  class RateLimitError < StandardError
+    MESSAGE_TEMPLATE = 'Received requests @%0.1f rps! Max allowed: %d rps'
+
+    attr_reader :rate, :limit
+
+    def initialize(rate:, limit:)
+      @rate = rate
+      @limit = limit
+
+      super format(MESSAGE_TEMPLATE, rate, limit)
+    end
+  end
+end

data/lib/rate_limit_mock_server/server.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'rate_limit_mock_server/counter'
+require 'rate_limit_mock_server/rate_limit_error'
+
+module RateLimitMockServer
+  class Server < Sinatra::Base
+    set :show_exceptions, false
+
+    DEFAULT_RPS_LIMIT = 4
+
+    error do |err|
+      [500, "Something is bork: #{err.message}"]
+    end
+
+    error RateLimitError do |error|
+      [429, "Current rate for #{request.path_info}: #{error.rate} (allowed #{error.limit})\n"]
+    end
+
+    get '/quit' do
+      self.class.quit!
+    end
+
+    get '/limit_test' do
+      raise RateLimitError.new(rate: 1, limit: 0)
+    end
+
+    get %r{/(\d+)?} do
+      counter.increment!
+
+      [200, "Current rate for #{request.path_info}: #{counter.current}\n"]
+    end
+
+    def rps_limit
+      params['captures']&.first&.to_i || DEFAULT_RPS_LIMIT
+    end
+
+    def counter
+      Counter.for(request.path_info, rps_limit)
+    end
+
+    def user_agent
+      request.env['HTTP_USER_AGENT']
+    end
+  end
+end

data/lib/rate_limit_mock_server/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RateLimitMockServer
+  VERSION = '0.1.0'
+end

data/lib/rate_limit_mock_server.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rate_limit_mock_server/version'
+require 'rate_limit_mock_server/server'
+
+module RateLimitMockServer
+  def self.start
+    Server.run!
+  end
+  
+  def self.quit!
+    Server.quit!
+  end
+end

data/rate_limit_mock_server.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rate_limit_mock_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rate_limit_mock_server'
+  spec.version       = RateLimitMockServer::VERSION
+  spec.authors       = ['Sammy Henningsson']
+  spec.email         = ['sammy.henningsson@hey.com']
+
+  spec.summary       = 'A mock server for testing out rate limiting in clients'
+  spec.homepage      = 'https://github.com/sammyhenningsson/rate_limit_mock_server'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.cert_chain  = ['certs/sammyhenningsson.pem']
+  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['rate_limit_mock_server']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'sinatra'
+  spec.add_development_dependency 'minitest'
+end

data.tar.gz.sig

@@ -0,0 +1 @@
+*��쐿�=#|��k��2��m	v%� �(O�Y�l:�[�8���N,�z|9n��2Rsy�j!�Μ���\߿N37�Fc�ZܓF��ywP��tO|����&Q�Zt��M�m1��ku��z,i�T�y�%e$`��n���4�"��i���‘N]���ݷ�#/��vU�

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rate_limit_mock_server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sammy Henningsson
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQsFADBGMRowGAYDVQQDDBFzYW1t
+  eS5oZW5uaW5nc3NvbjETMBEGCgmSJomT8ixkARkWA2hleTETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0yMjA0MDYxOTAxMDJaFw0yNDA2MTQxOTAxMDJaMEYxGjAYBgNV
+  BAMMEXNhbW15Lmhlbm5pbmdzc29uMRMwEQYKCZImiZPyLGQBGRYDaGV5MRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  r5IMLWZ/KG5wnpVrbWsgdQaxwS1Ct2/IGrEUbWzZOA8wC/hFurB0lU9ruSO1sLOy
+  UAOVQTWiu7YL6twmwy1UZfTa6Qwg8dPU6NPLLT8QyoupLLdZ5EjwA/INLEJVt76H
+  kEx/fNmdh911HoB4buWfT1PU/+1f72VMxz4j4NbV9SVCBjjwI1RrK+0lHrWy9e9c
+  yuEuGLb1JCKDWqYfpmh7bb8mAf6bYmSw+d1jkSneCp8NzoibC7a8a+YYSskPrcUH
+  RdD/BvhZUfiXuwdBJN8oOnxIiYK3XGo2AjKPDnvxkbaB4Yuidy7GAOttD9QUgnXW
+  UNl3i8t68yGcjFNImk+vZwIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
+  AgSwMB0GA1UdDgQWBBS6SOPUJ3Z5rog4cMtl7TKbOzaNaTAkBgNVHREEHTAbgRlz
+  YW1teS5oZW5uaW5nc3NvbkBoZXkuY29tMCQGA1UdEgQdMBuBGXNhbW15Lmhlbm5p
+  bmdzc29uQGhleS5jb20wDQYJKoZIhvcNAQELBQADggEBAEcMp9iEErm3laanowRC
+  xrvBR1uUyb73oTNPE2A3vknsLhJ/4tpJPcPkxgvh2P3bdwP//JHU9EYRKHY22R+7
+  jS4iSTbD7PQr3xdD5cA9j36562Wmac9uNTxJ9amtTcdmQqSDo9NcECFn3IhD+ljf
+  knR95SHUDD4FNQGLzrTTB8daYjO4Dro7vqOfZGcgk26uqWLrgcvdfzFyhZ8XwwzO
+  Q3eW5l4nbscDR/o3jV8WX5Y+Gm2YptuRHWe2S9YI5YkHXtDzPDREv0GRJmaRmGCz
+  hDgtXQiNH/WrZi6kriR8NgvZIZobYz4qKW9nAuVEa3qqegirIKi6BtcHr1pWrWt1
+  FDc=
+  -----END CERTIFICATE-----
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: 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:
+- sammy.henningsson@hey.com
+executables:
+- rate_limit_mock_server
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rate_limit_mock_server
+- bin/setup
+- certs/sammyhenningsson.pem
+- lib/rate_limit_mock_server.rb
+- lib/rate_limit_mock_server/counter.rb
+- lib/rate_limit_mock_server/rate_limit_error.rb
+- lib/rate_limit_mock_server/server.rb
+- lib/rate_limit_mock_server/version.rb
+- rate_limit_mock_server.gemspec
+homepage: https://github.com/sammyhenningsson/rate_limit_mock_server
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sammyhenningsson/rate_limit_mock_server
+  source_code_uri: https://github.com/sammyhenningsson/rate_limit_mock_server
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.6
+signing_key:
+specification_version: 4
+summary: A mock server for testing out rate limiting in clients
+test_files: []