rate_limit_mock_server 0.1.0 → 0.2.0

checksums.yaml

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

data/README.md

@@ -1,8 +1,6 @@
 # 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
+A mock server for testing rate limits.
 
 ## Installation
 
@@ -21,12 +19,26 @@ Or install it yourself as:
     $ gem install rate_limit_mock_server
 
 ## Usage
+Run the server in a shell:
+```sh
+# On default port: 4567
+$ rate_limit_mock_server
+
+# Or specify the port with
+$ rate_limit_mock_server --port= 3000
+# Or 
+$ rate_limit_mock_server -p 3000
+```
+
 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
+  # Start the server on the default port 4567 and block the current thread
   RateLimitMockServer.start
+
+  # Or start the server on the specified port and block the current thread
+  RateLimitMockServer.start(port: 1337)
 ```
 
 Note, If you don't want the server to block the current thread, you can instead spawn a new thread for the server.
@@ -34,7 +46,7 @@ Note, If you don't want the server to block the current thread, you can instead
   require 'rate_limit_mock_server`
 
   thread = Thread.new do
-    # Start the server on port 4567 and block the current thread
+    # Start the server on port 4567
     RateLimitMockServer.start
   end
 
@@ -49,7 +61,17 @@ Note, If you don't want the server to block the current thread, you can instead
   thread.join
 ```
 
-The server can be stopped by either `RateLimitMockServer.quit!` or by sending a GET to `http://localhost:4567/quit`.
+The server responds to the following routes:
+ - `GET /limit_test` - Returns a "429 Too Many Requests" response (only for showing how such a response look).
+ - `PUT /quit` - Stops the server.
+ - `GET /:rate_limit` - Rate limited resources where `:rate_limit` is an integer that specifies the rate limit.
+
+The "main" route (`GET /:rate_limit`) can be used to test different rate limits simultaneously. E.g. requests to
+`GET /5` will be limited at 5 rps, while requests to `GET /20` will be limited at 20 rps.
+
+Note: `:rate_limit` must be an integer greater than or equal to `1`. I.e it's not possible to user rate limits lower than 1 rps.
+
+The server can be stopped by either `RateLimitMockServer.quit!` or by sending a PUT request to `http://localhost:4567/quit`.
 
 ## Development
 

data/bin/rate_limit_mock_server

@@ -1,8 +1,21 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$: << File.expand_path('../lib/', __dir__)
-  
+$LOAD_PATH << File.expand_path('../lib/', __dir__)
+
 require 'rate_limit_mock_server'
-  
-RateLimitMockServer.start
+
+port = nil
+pattern = /\A-(?:-port(?:=(\d)*)?|p)\Z/
+index = ARGV.index do |arg|
+  next unless m = pattern.match(arg)
+
+  port = m[1] if m.size > 1
+  true
+end
+
+port ||= ARGV[index + 1] if index
+port &&= port.to_i
+port = nil if port&.zero?
+
+RateLimitMockServer.start(port: port)

data/lib/rate_limit_mock_server/server.rb

@@ -18,7 +18,7 @@ module RateLimitMockServer
       [429, "Current rate for #{request.path_info}: #{error.rate} (allowed #{error.limit})\n"]
     end
 
-    get '/quit' do
+    put '/quit' do
       self.class.quit!
     end
 

data/lib/rate_limit_mock_server/version.rb

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

data/lib/rate_limit_mock_server.rb

@@ -4,10 +4,11 @@ require 'rate_limit_mock_server/version'
 require 'rate_limit_mock_server/server'
 
 module RateLimitMockServer
-  def self.start
+  def self.start(port: nil)
+    Server.set :port, port if port
     Server.run!
   end
-  
+
   def self.quit!
     Server.quit!
   end

data.tar.gz.sig

@@ -1 +1,2 @@
-*��쐿�=#|��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�
+N�M��z )���j�Vzt������lۛ��q�ҷ��Qm����u7�Z(A9-�}��8�#b�y�E��<�����~rE׺]��)6z�Dkah�2�	�
+��]L�7N�d�������k���c�8fڑ�{v_��p� �/��틥â��.Y�@U��l�E��i`ň+K�M~{*���R��ܳm\\�Zt!-�(��=�m�z��}�*���H�U��Խ�yU��P2�����hFZ�[ͧ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rate_limit_mock_server
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -31,7 +31,7 @@ cert_chain:
   hDgtXQiNH/WrZi6kriR8NgvZIZobYz4qKW9nAuVEa3qqegirIKi6BtcHr1pWrWt1
   FDc=
   -----END CERTIFICATE-----
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra