bump version (#6)

* bump version

* bump version and black formatter

Author: burak-upstash

examples/aws-lambda/main.py

@@ -8,18 +8,18 @@
 arate_limit = ARateLimit(ARedis.from_env(allow_telemetry=False))
 afixed_window = arate_limit.fixed_window(max_number_of_requests=1, window=10, unit="s")
 
+
 async def main():
-    res = await afixed_window.block_until_ready('timeout_1', 10)
+    res = await afixed_window.block_until_ready("timeout_1", 10)
     print(f"res: {res}")
 
+
 def lambda_handler(event, context):
     asyncio.run(main())
-    
+
     rate_limit = RateLimit(prefix="test")
 
     fixed_window = rate_limit.fixed_window(max_number_of_requests=2, window=5, unit="s")
 
-    res = fixed_window.block_until_ready('timeout_sync', 10)
+    res = fixed_window.block_until_ready("timeout_sync", 10)
     print(f"sync res: {res}")
-
-

examples/flask-server/hello.py

@@ -8,12 +8,14 @@
 
 app = Flask(__name__)
 
+
 @app.route("/")
 def hello_world():
     return "<p>Hello, World!</p>"
 
+
 @app.route("/request")
 def request():
     asyncio.run(fixed_window.limit("timeout_1"))
-    res = asyncio.run(fixed_window.block_until_ready('timeout_1', 10))
+    res = asyncio.run(fixed_window.block_until_ready("timeout_1", 10))
     return f"<p>{res}</p>"

examples/vercel-basic/api/index.py

@@ -6,29 +6,23 @@
 
 
 rate_limit = RateLimit(Redis.from_env(allow_telemetry=False))
-fixed_window = rate_limit.fixed_window(
-    max_number_of_requests=5,
-    window=5,
-    unit="s"
-)
+fixed_window = rate_limit.fixed_window(max_number_of_requests=5, window=5, unit="s")
+
 
 class handler(BaseHTTPRequestHandler):
- 
     async def do_GET(self):
-
         limited: RateLimitResponse = await fixed_window.limit("global")
-        self.send_header('Content-type','text/plain')
-        self.send_header('X-Ratelimit-Limit', limited["limit"])
-        self.send_header('X-Ratelimit-Remaining', limited["remaining"])
-        self.send_header('X-Ratelimit-Reset', limited["reset"])
+        self.send_header("Content-type", "text/plain")
+        self.send_header("X-Ratelimit-Limit", limited["limit"])
+        self.send_header("X-Ratelimit-Remaining", limited["remaining"])
+        self.send_header("X-Ratelimit-Reset", limited["reset"])
 
         self.end_headers()
         if not limited["is_allowed"]:
             self.send_response(429)
-            self.wfile.write('Come back later!'.encode('utf-8'))
+            self.wfile.write("Come back later!".encode("utf-8"))
         else:
             self.send_response(200)
-            self.wfile.write('Hello!'.encode('utf-8'))
+            self.wfile.write("Hello!".encode("utf-8"))
 
-        
-        return
+        return

examples/vercel/api/index.py

@@ -8,12 +8,14 @@
 
 app = Flask(__name__)
 
-@app.route('/')
+
+@app.route("/")
 def home():
-    return 'Hello, World!'
+    return "Hello, World!"
+
 
 @app.route("/request")
 def request():
     asyncio.run(fixed_window.limit("timeout_1"))
-    res = asyncio.run(fixed_window.block_until_ready('timeout_1', 10))
+    res = asyncio.run(fixed_window.block_until_ready("timeout_1", 10))
     return f"<p>{res}</p>"

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "upstash_ratelimit"
-version = "0.3.6"
+version = "0.4.0"
 description = "Serverless ratelimiting package from Upstash"
 authors = ["Upstash <support@upstash.com>", "Zgîmbău Tudor <tudor.zgimbau@gmail.com>"]
 readme = "README.md"
@@ -10,7 +10,7 @@ packages = [{include = "upstash_ratelimit"}]
 python = "^3.8"
 pytest = "^7.3.0"
 pytest-asyncio = "^0.21.0"
-upstash-redis = "^0.13.2"
+upstash-redis = "^0.14.4"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -2,23 +2,24 @@
 from tests.client import rate_limit
 from pytest import mark
 
-fixed_window = rate_limit.fixed_window(max_number_of_requests=1, window=10000, unit="ms")
+fixed_window = rate_limit.fixed_window(
+    max_number_of_requests=1, window=10000, unit="ms"
+)
+
 
 def test_below_max() -> None:
     assert (fixed_window.limit("fixed_window_1"))["is_allowed"] is True
 
 
-
 def test_above_max() -> None:
     fixed_window.limit("fixed_window_2")
 
     sleep(2)
-    
+
     assert (fixed_window.limit("fixed_window_2"))["is_allowed"] is False
     assert (fixed_window.limit("fixed_window_2"))["is_allowed"] is False
 
 
-
 def test_after_window() -> None:
     # Exhaust the request limit.
     fixed_window.limit("fixed_window_3")
@@ -34,19 +35,13 @@ def test_with_non_ms_unit() -> None:
         max_number_of_requests=1, window=10, unit="s"
     )
 
-    assert (fixed_window_with_seconds.limit("fixed_window_4"))[
-        "is_allowed"
-    ] is True
+    assert (fixed_window_with_seconds.limit("fixed_window_4"))["is_allowed"] is True
 
     sleep(1)
 
     # Exhaust the request limit.
-    assert (fixed_window_with_seconds.limit("fixed_window_4"))[
-        "is_allowed"
-    ] is False
+    assert (fixed_window_with_seconds.limit("fixed_window_4"))["is_allowed"] is False
 
     sleep(10)
 
-    assert (fixed_window_with_seconds.limit("fixed_window_4"))[
-        "is_allowed"
-    ] is True
+    assert (fixed_window_with_seconds.limit("fixed_window_4"))["is_allowed"] is True

tests/algorithm/limiting/test_fixed_window_limiting.py

@@ -6,15 +6,18 @@
     max_number_of_tokens=1, refill_rate=1, interval=3000, unit="ms"
 )
 
+
 def test_below_max() -> None:
     assert (token_bucket.limit("token_bucket_1"))["is_allowed"] is True
 
+
 def test_above_max() -> None:
     token_bucket.limit("token_bucket_2")
 
     assert (token_bucket.limit("token_bucket_2"))["is_allowed"] is False
     assert (token_bucket.limit("token_bucket_2"))["is_allowed"] is False
 
+
 def test_after_window() -> None:
     # Exhaust the request limit.
     token_bucket.limit("token_bucket_3")
@@ -24,33 +27,29 @@ def test_after_window() -> None:
 
     assert (token_bucket.limit("token_bucket_3"))["is_allowed"] is True
 
+
 def test_with_non_ms_unit() -> None:
     token_bucket_with_seconds = rate_limit.token_bucket(
         max_number_of_tokens=1, refill_rate=1, interval=3, unit="s"
     )
 
     # Exhaust the request limit.
-    assert (token_bucket_with_seconds.limit("token_bucket_4"))[
-        "is_allowed"
-    ] is True
+    assert (token_bucket_with_seconds.limit("token_bucket_4"))["is_allowed"] is True
 
-    assert (token_bucket_with_seconds.limit("token_bucket_4"))[
-        "is_allowed"
-    ] is False
+    assert (token_bucket_with_seconds.limit("token_bucket_4"))["is_allowed"] is False
 
     # Wait for the refill.
     sleep(3)
 
-    assert (token_bucket_with_seconds.limit("token_bucket_4"))[
-        "is_allowed"
-    ] is True
+    assert (token_bucket_with_seconds.limit("token_bucket_4"))["is_allowed"] is True
 
 
 # Use a client that has different maximum number of tokens and refill rate.
 burst_token_bucket = rate_limit.token_bucket(
     max_number_of_tokens=2, refill_rate=1, interval=2000, unit="ms"
 )
 
+
 def test_burst() -> None:
     # Exhaust the request limit.
     burst_token_bucket.limit("burst_token_bucket_1")
@@ -59,15 +58,10 @@ def test_burst() -> None:
     # Wait for the refill.
     sleep(2)
 
-    assert (burst_token_bucket.limit("burst_token_bucket_1"))[
-        "is_allowed"
-    ] is True
-    assert (burst_token_bucket.limit("burst_token_bucket_1"))[
-        "is_allowed"
-    ] is False
-    assert (burst_token_bucket.limit("burst_token_bucket_1"))[
-        "is_allowed"
-    ] is False
+    assert (burst_token_bucket.limit("burst_token_bucket_1"))["is_allowed"] is True
+    assert (burst_token_bucket.limit("burst_token_bucket_1"))["is_allowed"] is False
+    assert (burst_token_bucket.limit("burst_token_bucket_1"))["is_allowed"] is False
+
 
 def test_with_positive_number_of_tokens_before_the_refill() -> None:
     burst_token_bucket.limit("burst_token_bucket_2")
@@ -78,15 +72,10 @@ def test_with_positive_number_of_tokens_before_the_refill() -> None:
     """
     sleep(2)
 
-    assert (burst_token_bucket.limit("burst_token_bucket_2"))[
-        "is_allowed"
-    ] is True
-    assert (burst_token_bucket.limit("burst_token_bucket_2"))[
-        "is_allowed"
-    ] is True
-    assert (burst_token_bucket.limit("burst_token_bucket_2"))[
-        "is_allowed"
-    ] is False
+    assert (burst_token_bucket.limit("burst_token_bucket_2"))["is_allowed"] is True
+    assert (burst_token_bucket.limit("burst_token_bucket_2"))["is_allowed"] is True
+    assert (burst_token_bucket.limit("burst_token_bucket_2"))["is_allowed"] is False
+
 
 def test_multiple_refills() -> None:
     # Exhaust the request limit.
@@ -96,14 +85,6 @@ def test_multiple_refills() -> None:
     # Wait for 2 refills.
     sleep(4)
 
-    assert (burst_token_bucket.limit("burst_token_bucket_3"))[
-        "is_allowed"
-    ] is True
-    assert (burst_token_bucket.limit("burst_token_bucket_3"))[
-        "is_allowed"
-    ] is True
-    assert (burst_token_bucket.limit("burst_token_bucket_3"))[
-        "is_allowed"
-    ] is False
-
-
+    assert (burst_token_bucket.limit("burst_token_bucket_3"))["is_allowed"] is True
+    assert (burst_token_bucket.limit("burst_token_bucket_3"))["is_allowed"] is True
+    assert (burst_token_bucket.limit("burst_token_bucket_3"))["is_allowed"] is False

tests/algorithm/limiting/test_token_bucket_limiting.py

@@ -3,9 +3,11 @@
 
 fixed_window = rate_limit.fixed_window(max_number_of_requests=1, window=3000, unit="ms")
 
+
 def test_before_the_first_request() -> None:
     assert fixed_window.remaining("fixed_window_remaining_1") == 1
 
+
 def test_after_the_first_request() -> None:
     fixed_window.limit("fixed_window_remaining_2")
 

tests/algorithm/remaining/test_fixed_window_remaining.py

@@ -6,9 +6,11 @@
     max_number_of_tokens=1, refill_rate=1, interval=3000, unit="ms"
 )
 
+
 def test_before_the_first_request() -> None:
     assert token_bucket.remaining("token_bucket_remaining_1") == 1
 
+
 def test_after_the_first_request() -> None:
     token_bucket.limit("token_bucket_remaining_2")
 
@@ -22,6 +24,7 @@ def test_after_the_first_request() -> None:
     max_number_of_tokens=2, refill_rate=1, interval=2000, unit="ms"
 )
 
+
 def test_after_burst() -> None:
     # Exhaust the request limit.
     burst_token_bucket.limit("burst_token_bucket_remaining_1")
@@ -32,6 +35,7 @@ def test_after_burst() -> None:
 
     assert burst_token_bucket.remaining("burst_token_bucket_remaining_1") == 1
 
+
 def test_after_burst_with_positive_number_of_tokens_before_the_refill() -> None:
     burst_token_bucket.limit("burst_token_bucket_remaining_2")
 

tests/algorithm/remaining/test_token_bucket_remaining.py

@@ -6,12 +6,16 @@
 
 fixed_window = rate_limit.fixed_window(max_number_of_requests=1, window=3000, unit="ms")
 
+
 def test_before_the_first_request() -> None:
     assert fixed_window.reset("fixed_window_reset_1") == -1
 
+
 def test_after_the_first_request() -> None:
     fixed_window.limit("fixed_window_reset_2")
 
     sleep(0.3)
 
-    assert pytest.approx(floor((time_ns() / 1000000) / 3000) * 3000 + 3000, 0.1) == fixed_window.reset("fixed_window_reset_2")
+    assert pytest.approx(
+        floor((time_ns() / 1000000) / 3000) * 3000 + 3000, 0.1
+    ) == fixed_window.reset("fixed_window_reset_2")

tests/algorithm/reset/test_fixed_window_reset.py

@@ -6,16 +6,19 @@
     max_number_of_tokens=1, refill_rate=1, interval=3000, unit="ms"
 )
 
+
 def test_before_the_first_request() -> None:
     assert token_bucket.reset("token_bucket_reset_1") == -1
 
+
 def test_after_the_first_request() -> None:
     token_bucket.limit("token_bucket_reset_2")
 
     now: int = int(time_ns() / 1000000)
 
     assert now + 3000 - token_bucket.reset("token_bucket_reset_2") <= 500
 
+
 def test_after_multiple_refills() -> None:
     token_bucket.limit("token_bucket_reset_3")