Added support for views and changed how RedisLimiter and MemcachedLim…

…iter are imported.

.github/ISSUE_TEMPLATE/bug-report.md

@@ -10,7 +10,6 @@ assignees: Nebulizer1213
 # Bug Report
 
 Before you submit this request make sure you are using the latest version of aiohttp-ratelimiter.
-If you want faster support you can go to https://jgltechnologies.com/contact and link this issue in the message box.
 
 ### Python version
 

README.md

@@ -30,7 +30,9 @@ Example
 
 ```python
 from aiohttp import web
-from aiohttplimiter import default_keyfunc, Limiter, RedisLimiter, MemcachedLimiter
+from aiohttplimiter import default_keyfunc, Limiter
+from aiohttplimiter.redis_limiter import RedisLimiter
+from aiohttplimiter.memcached_limiter import MemcachedLimiter
 
 app = web.Application()
 routes = web.RouteTableDef()
@@ -116,5 +118,17 @@ def home(request):
     return web.Response(text="Hello")
 ```
 
+<br>
+
+Views Example 
+
+```python
+@routes.view("/")
+class Home(View):
+    @limiter.limit("1/second")
+    def get(self: web.Request):
+        return web.Response(text="hello")
+```
+
 
 

aiohttp_ratelimiter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aiohttp-ratelimiter
-Version: 4.0.1
+Version: 4.1.1
 Summary: A simple rate limiter for aiohttp.web
 Home-page: https://jgltechnologies.com/aiohttplimiter
 Author: George Luca
@@ -48,7 +48,9 @@ Example
 
 ```python
 from aiohttp import web
-from aiohttplimiter import default_keyfunc, Limiter, RedisLimiter, MemcachedLimiter
+from aiohttplimiter import default_keyfunc, Limiter
+from aiohttplimiter.redis_limiter import RedisLimiter
+from aiohttplimiter.memcached_limiter import MemcachedLimiter
 
 app = web.Application()
 routes = web.RouteTableDef()
@@ -134,6 +136,18 @@ def home(request):
     return web.Response(text="Hello")
 ```
 
+<br>
+
+Views Example 
+
+```python
+@routes.view("/")
+class Home(View):
+    @limiter.limit("1/second")
+    def get(self: web.Request):
+        return web.Response(text="hello")
+```
+
 
 
 

aiohttplimiter/__init__.py

@@ -1,4 +1,2 @@
 from .limiter import default_keyfunc, Allow, RateLimitExceeded
 from .memory_limiter import Limiter
-from .redis_limiter import RedisLimiter
-from .memcached_limiter import MemcachedLimiter

aiohttplimiter/limiter.py

@@ -2,16 +2,18 @@
 import json
 from typing import Callable, Awaitable, Union, Optional, Coroutine, Any
 import asyncio
-from aiohttp.web import Request, Response
+from aiohttp.web import Request, Response, View
 from limits.aio.storage import Storage, MemoryStorage
 from limits.aio.strategies import MovingWindowRateLimiter
 from limits import parse
 
 
-def default_keyfunc(request: Request) -> str:
+def default_keyfunc(request: Union[Request, View]) -> str:
     """
     Returns the user's IP
     """
+    if isinstance(request, View):
+        request = request.request
     ip = request.headers.get(
         "X-Forwarded-For") or request.remote or "127.0.0.1"
     ip = ip.split(",")[0]
@@ -51,9 +53,11 @@ def __init__(self, db: Storage, path_id: str, keyfunc: Callable,
         self.path_id = path_id
         self.moving_window = moving_window
 
-    def __call__(self, func: Union[Callable, Awaitable]) -> Coroutine[Any, Any, Response]:
+    def __call__(self, func: Union[Callable, Awaitable]) -> Callable[[Union[Request, View]], Coroutine[Any, Any, Response]]:
         @wraps(func)
-        async def wrapper(request: Request) -> Response:
+        async def wrapper(request: Union[Request, View]) -> Response:
+            if isinstance(request, View):
+                request = request.request
             key = self.keyfunc(request)
             db_key = f"{key}:{self.path_id or request.path}"
 

aiohttplimiter/memcached_limiter.py

@@ -1,4 +1,5 @@
-from typing import Callable, Awaitable, Union, Optional
+from typing import Callable, Awaitable, Union, Optional, Any, Coroutine
+from aiohttp.web import Request, Response, View
 from limits.aio.storage import MemcachedStorage
 from .limiter import BaseRateLimitDecorator
 from limits.aio.strategies import MovingWindowRateLimiter
@@ -26,7 +27,7 @@ def __init__(self, keyfunc: Callable, uri: str, exempt_ips: Optional[set] = None
 
     def limit(self, ratelimit: str, keyfunc: Callable = None, exempt_ips: Optional[set] = None,
               error_handler: Optional[Union[Callable, Awaitable]] = None, path_id: str = None) -> Callable:
-        def wrapper(func: Callable) -> Awaitable:
+        def wrapper(func: Callable) -> Callable[[Union[Request, View]], Coroutine[Any, Any, Response]]:
             _exempt_ips = exempt_ips or self.exempt_ips
             _keyfunc = keyfunc or self.keyfunc
             _error_handler = self.error_handler or error_handler

aiohttplimiter/memory_limiter.py

@@ -1,7 +1,8 @@
+from aiohttp.web import Request, Response, View
 from limits.aio.storage import MemoryStorage
 from limits.aio.strategies import MovingWindowRateLimiter
 from .limiter import BaseRateLimitDecorator
-from typing import Callable, Optional, Union, Awaitable
+from typing import Callable, Optional, Union, Awaitable, Any, Coroutine
 
 
 class Limiter:
@@ -26,7 +27,7 @@ def __init__(self, keyfunc: Callable, exempt_ips: Optional[set] = None,
 
     def limit(self, ratelimit: str, keyfunc: Callable = None, exempt_ips: Optional[set] = None,
               error_handler: Optional[Union[Callable, Awaitable]] = None, path_id: str = None) -> Callable:
-        def wrapper(func: Callable) -> Awaitable:
+        def wrapper(func: Callable) -> Callable[[Union[Request, View]], Coroutine[Any, Any, Response]]:
             _exempt_ips = exempt_ips or self.exempt_ips
             _keyfunc = keyfunc or self.keyfunc
             _error_handler = self.error_handler or error_handler

aiohttplimiter/redis_limiter.py

@@ -1,5 +1,6 @@
-from typing import Callable, Awaitable, Union, Optional
+from typing import Callable, Awaitable, Union, Optional, Any, Coroutine
 import coredis
+from aiohttp.web import Request, Response, View
 from limits.aio.storage import RedisStorage
 from .limiter import BaseRateLimitDecorator
 from limits.aio.strategies import MovingWindowRateLimiter
@@ -27,7 +28,7 @@ def __init__(self, keyfunc: Callable, uri: str, exempt_ips: Optional[set] = None
 
     def limit(self, ratelimit: str, keyfunc: Callable = None, exempt_ips: Optional[set] = None,
               error_handler: Optional[Union[Callable, Awaitable]] = None, path_id: str = None) -> Callable:
-        def wrapper(func: Callable) -> Awaitable:
+        def wrapper(func: Callable) -> Callable[[Union[Request, View]], Coroutine[Any, Any, Response]]:
             _exempt_ips = exempt_ips or self.exempt_ips
             _keyfunc = keyfunc or self.keyfunc
             _error_handler = self.error_handler or error_handler

setup.py

@@ -10,7 +10,7 @@ def get_long_description():
         return file.read()
 
 
-VERSION = "4.0.1"
+VERSION = "4.1.1"
 
 classifiers = [
     "Development Status :: 5 - Production/Stable",