muffin-rest 7.3.5__py3-none-any.whl → 8.0.0__py3-none-any.whl

muffin_rest/handler.py

@@ -87,10 +87,7 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
         else:
             router.bind(cls, f"/{ cls.meta.name }", methods=methods, **params)
             router.bind(
-                cls,
-                f"/{ cls.meta.name }/{{{ cls.meta.name_id }}}",
-                methods=methods,
-                **params,
+                cls, f"/{ cls.meta.name }/{{{ cls.meta.name_id }}}", methods=methods, **params
             )
 
         for _, method in inspect.getmembers(cls, lambda m: hasattr(m, "__route__")):
@@ -102,14 +99,17 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
     async def __call__(self, request: Request, *, method_name: Optional[str] = None, **_) -> Any:
         """Dispatch the given request by HTTP method."""
         method = getattr(self, method_name or request.method.lower())
+        meta = self.meta
         self.auth = await self.authorize(request)
+        if meta.rate_limit:
+            await self.rate_limit(request)
+
         self.collection = await self.prepare_collection(request)
         resource = await self.prepare_resource(request)
         if not (request.method == "GET" and resource is None):
             return await method(request, resource=resource)
 
         headers = None
-        meta = self.meta
 
         # Filter collection
         if meta.filters:
@@ -148,6 +148,11 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
             raise APIError.UNAUTHORIZED()
         return auth
 
+    async def rate_limit(self, request: Request):
+        """Default rate limit method. Proxy rate limit to self.api."""
+        if not await self.meta.rate_limiter.check(f"{self.auth}"):
+            raise APIError.TOO_MANY_REQUESTS()
+
     # Prepare data
     # ------------
     @abc.abstractmethod

muffin_rest/limits.py

@@ -0,0 +1,73 @@
+import abc
+from time import time
+
+
+class RateLimiter(abc.ABC):
+    """Rate limiter."""
+
+    def __init__(self, limit: int, period: int, **opts):
+        """Initialize the rate limiter.
+
+        Args:
+            limit (int): The limit of requests.
+            period (int): The period of time in seconds.
+        """
+        self.limit = limit
+        self.period = period
+
+    @abc.abstractmethod
+    async def check(self, key: str) -> bool:
+        """Check the request."""
+        raise NotImplementedError
+
+
+RATE_LIMITS = {}
+
+
+class MemoryRateLimiter(RateLimiter):
+    """Memory rate limiter. Do not use in production."""
+
+    async def check(self, key: str) -> bool:
+        """Check the request."""
+        now = time()
+        if key not in RATE_LIMITS:
+            RATE_LIMITS[key] = (now, 1)
+            return True
+
+        last, count = RATE_LIMITS[key]
+        if now - last > self.period:
+            RATE_LIMITS[key] = (now, 1)
+            return True
+
+        if count < self.limit:
+            RATE_LIMITS[key] = (last, count + 1)
+            return True
+
+        return False
+
+
+class RedisRateLimiter(RateLimiter):
+    """Redis rate limiter."""
+
+    # TODO: Asyncio lock
+
+    def __init__(self, limit: int, period: int, *, redis, **opts):
+        """Initialize the rate limiter.
+
+        Args:
+            limit (int): The limit of requests.
+            period (int): The period of time in seconds.
+            redis (aioredis.Redis): The Redis connection.
+        """
+        super().__init__(limit, period)
+        self.redis = redis
+
+    async def check(self, key: str) -> bool:
+        """Check the request."""
+        value = await self.redis.get(key)
+        if value is None:
+            await self.redis.setex(key, self.period, 1)
+            return True
+
+        await self.redis.incr(key)
+        return int(value) < self.limit

muffin_rest/options.py

@@ -1,9 +1,11 @@
 """REST Options."""
 
-from typing import Dict, Type
+from typing import Any, Dict, Type
 
 import marshmallow as ma
 
+from muffin_rest.limits import MemoryRateLimiter, RateLimiter
+
 from .filters import Filters
 from .sorting import Sorting
 
@@ -13,6 +15,10 @@ class RESTOptions:
 
     name: str = ""
     name_id: str = "id"
+    base_property: str = "name"
+
+    # Pagination
+    # ----------
 
     # limit: Paginate results (set to None for disable pagination)
     limit: int = 0
@@ -23,14 +29,23 @@ class RESTOptions:
     # limit_total: Return total count of results
     limit_total: bool = True
 
+    # Filters
+    # -------
+
     # Base class for filters
     filters: Filters
     filters_cls: Type[Filters] = Filters
 
+    # Sorting
+    # -------
+
     # Base class for sorting
     sorting: Sorting
     sorting_cls: Type[Sorting] = Sorting
 
+    # Serialization/Deserialization
+    # -----------------------------
+
     # Auto generation for schemas
     Schema: Type[ma.Schema]
     schema_base: Type[ma.Schema] = ma.Schema
@@ -38,7 +53,13 @@ class RESTOptions:
     schema_meta: Dict = {}
     schema_unknown: str = ma.EXCLUDE
 
-    base_property: str = "name"
+    # Rate Limiting
+    # -------------
+
+    rate_limit: int = 0
+    rate_limit_period: int = 60
+    rate_limit_cls: Type[RateLimiter] = MemoryRateLimiter
+    rate_limit_cls_opts: Dict[str, Any] = {}
 
     def __init__(self, cls):
         """Inherit meta options."""
@@ -65,6 +86,11 @@ class RESTOptions:
         if not self.limit_max:
             self.limit_max = self.limit
 
+        if self.rate_limit:
+            self.rate_limiter = self.rate_limit_cls(
+                self.rate_limit, self.rate_limit_period, **self.rate_limit_cls_opts
+            )
+
     def setup_schema_meta(self, _):
         """Generate meta for schemas."""
         return type(

{muffin_rest-7.3.5.dist-info → muffin_rest-8.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: muffin-rest
-Version: 7.3.5
+Version: 8.0.0
 Summary: The package provides enhanced support for writing REST APIs with Muffin framework
 Home-page: https://github.com/klen/muffin-rest
 License: MIT

{muffin_rest-7.3.5.dist-info → muffin_rest-8.0.0.dist-info}/RECORD

@@ -2,7 +2,8 @@ muffin_rest/__init__.py,sha256=NBZeOEJgQHtFFhVgd9d0fpApFRgU405sbm0cu1y1MOU,1242
 muffin_rest/api.py,sha256=gCqRb5PgKEMkE84Y0ZnJw_laVRmVWZRxzBqBv0ns6w8,3882
 muffin_rest/errors.py,sha256=TIXSADZYSwx70dOVPRAzuNwGLfpLuzZZ1ugMZMwIGDo,1169
 muffin_rest/filters.py,sha256=lMnPMdy7h0nB9bH-Nf5Hv_qenAGzG0V3ULpizTK3OnM,5623
-muffin_rest/handler.py,sha256=LcPFFH01nwe2tYKYbq-KVDX5UBVMlaRmeisJ_s4jsCo,10035
+muffin_rest/handler.py,sha256=1v1I34K5DEuID3IQqwz4grsGruzXhdDTK7o7Ma0vAp0,10294
+muffin_rest/limits.py,sha256=pA5hnDQgrP-euDGjAoczlT_b7Dxzw5btQ-3okkHYKSA,1855
 muffin_rest/marshmallow.py,sha256=hHPLTLdaSz5jTLWBqyHeOwo2xfBv7aMIuJFD_trHRuE,715
 muffin_rest/mongo/__init__.py,sha256=unoEAKCU9H3EKhQqKGosn02tTS3H5nPOcTd3THM4Qs8,4675
 muffin_rest/mongo/filters.py,sha256=y2FleM_BqkICKGq3PmM_StOgKlE7RoSxt2NdQfCvnOE,921
@@ -11,7 +12,7 @@ muffin_rest/mongo/sorting.py,sha256=iJBnaFwE7g_JMwpGpQkoqSqbQK9XULx1K3skiRRgLgY,
 muffin_rest/mongo/types.py,sha256=Otqu_FyIVnDAUGcwtzY_B77CKNBYApQPO_LlS2aLAQk,206
 muffin_rest/mongo/utils.py,sha256=RZdAiKaTsgaFz8WbIPI_sjjVDsF_VmPu5Agzp5mpbvY,3946
 muffin_rest/openapi.py,sha256=XNhU4EffbKvFKr1HMCqFM-ZrukPqLyZwm3aJe2dNs40,8770
-muffin_rest/options.py,sha256=6K8YD3U-FdItFVjILQxH9h_Hwi68kgzWs97zrtSN_m4,2049
+muffin_rest/options.py,sha256=Ud8hYIEl9tFQ19n38JJy1QGgPRsivOC-2es-mDY5jc0,2663
 muffin_rest/peewee/__init__.py,sha256=94DSj_ftT6fbPksHlBv40AH2HWaiZommUFOMN2jd9a4,129
 muffin_rest/peewee/filters.py,sha256=dgbvTBm_V2Iu3penv5y--OWSysQ0ZnUfgGCuHcQKfhU,2433
 muffin_rest/peewee/handler.py,sha256=O84-TmiyNyEhEamTh-DY93ds0hZJzVG8_yekRpF9p3k,5359
@@ -32,7 +33,7 @@ muffin_rest/sqlalchemy/types.py,sha256=JnIw44XJ2ClWzOv-mTUrvFw1JPxAlvdX_jf7r4zau
 muffin_rest/swagger.html,sha256=2uGLu_KpkYf925KnDKHBJmV9pm6OHn5C3BWScESsUS8,1736
 muffin_rest/types.py,sha256=vy55ShzMcvs9zXjFpdjWlagv09dMrcmxb2-U4hTL3NM,521
 muffin_rest/utils.py,sha256=WT87AHXvBFBzBVTkwsYmDXgG3ZX1wNKFo4SOUJ9JiQY,2095
-muffin_rest-7.3.5.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
-muffin_rest-7.3.5.dist-info/METADATA,sha256=3S9RVEQb7kpUDE8b1IWRZg6Q27bzmlIS0J7u5SpsRcI,4177
-muffin_rest-7.3.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-muffin_rest-7.3.5.dist-info/RECORD,,
+muffin_rest-8.0.0.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
+muffin_rest-8.0.0.dist-info/METADATA,sha256=VzP0M8MWFNqAo3klSmKO0e-C0946Ohnwmbj2rDPvk94,4177
+muffin_rest-8.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+muffin_rest-8.0.0.dist-info/RECORD,,