Start adding types for API responses. Work on adding a seperate Async…

…HTTP client with proper typehints

.gitignore

@@ -4,3 +4,4 @@ docs/_build/
 *.egg-info
 build/*
 dist/*
+*.json

redgifs/aio.py

@@ -26,6 +26,7 @@
 
 import io
 import os
+from datetime import datetime
 from typing import Any, Dict, List, Optional, Union
 
 import aiohttp
@@ -61,18 +62,18 @@ async def get_tags(self) -> List[Dict[str, Union[str, int]]]:
         return resp['tags']
 
     async def get_gif(self, id: str) -> GIF:
-        json: Dict[str, Any] = (await self.http.get_gif(id))['gif']
+        json = (await self.http.get_gif(id))['gif']
         urls = json['urls']
         return GIF(
             id=json['id'],
-            create_date=json['createDate'],
+            create_date=datetime.utcfromtimestamp(json['createDate']),
             has_audio=json['hasAudio'],
             width=json['width'],
             height=json['height'],
             likes=json['likes'],
             tags=json['tags'],
             verified=json['verified'],
-            views=json['views'],
+            views=json.get('views'),
             duration=json['duration'],
             published=json['published'],
             urls=URL(

redgifs/http.py

@@ -30,12 +30,14 @@
 import sys
 import logging
 from urllib.parse import quote
-from typing import Any, ClassVar, Coroutine, Dict, List, NamedTuple, Optional, Union
+from typing import TYPE_CHECKING, Any, ClassVar, Coroutine, Dict, List, NamedTuple, Optional, TypeVar, Union
 
 import requests
 import aiohttp
 import yarl
 
+from redgifs.types.response import GifResponse, SearchResponse
+
 from . import __version__
 from .errors import HTTPException
 from .enums import Order, Type
@@ -44,6 +46,10 @@
 
 _log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    T = TypeVar('T')
+    Response = Coroutine[Any, Any, T]
+
 class Route:
     BASE: ClassVar[str] = "https://api.redgifs.com"
 
@@ -110,11 +116,11 @@ def request(self, route: Route, **kwargs: Any) -> Any:
         else:
             raise HTTPException(r, js)
 
-    def close(self) -> Union[Coroutine[Any, Any, None], None]:
+    def close(self) -> None:
         self.__session.close()
 
     # TODO: Implement OAuth login support
-    def login(self, username: Optional[str] = None, password: Optional[str] = None) -> Union[Coroutine[Any, Any, None], None]:
+    def login(self, username: Optional[str] = None, password: Optional[str] = None) -> None:
         if (username and password) is None:
             temp_token = self.get_temp_token()['token']
             self.headers['authorization'] = f'Bearer {temp_token}'
@@ -245,7 +251,7 @@ def dl(url: str) -> int:
         raise TypeError(f'"{strip_ip(str_url)}" is not a valid RedGifs URL')
 
 
-class AsyncHttp(HTTP):
+class AsyncHttp:
     def __init__(
         self,
         session: Optional[aiohttp.ClientSession] = None,
@@ -270,14 +276,6 @@ def __init__(
         else:
             self._proxy_auth = None
 
-    # TODO: Implement OAuth login support
-    async def login(self, username: Optional[str] = None, password: Optional[str] = None) -> None:
-        if (username and password) is None:
-            temp_token = await self.get_temp_token()
-            self.headers['authorization'] = f'Bearer {temp_token["token"]}'
-        else:
-            raise NotImplementedError
-
     async def request(self, route: Route, **kwargs: Any) -> Any:
         url: str = route.url
         method: str = route.method
@@ -292,9 +290,105 @@ async def request(self, route: Route, **kwargs: Any) -> Any:
             else:
                 raise HTTPException(resp, js)
 
+    async def close(self) -> None:
+        await self.__session.close()
+
     async def get_temp_token(self):
         return (await self.request(Route('GET', '/v2/auth/temporary')))
 
+    # TODO: Implement OAuth login support
+    async def login(self, username: Optional[str] = None, password: Optional[str] = None) -> None:
+        if (username and password) is None:
+            temp_token = await self.get_temp_token()
+            self.headers['authorization'] = f'Bearer {temp_token["token"]}'
+        else:
+            raise NotImplementedError
+
+    # GIF methods
+
+    def get_feeds(self):
+        return self.request(Route('GET', '/v2/home/feeds'))
+
+    def get_tags(self, **params: Any):
+        return self.request(Route('GET', '/v1/tags'), **params)
+
+    def get_gif(self, id: str, **params: Any) -> Response[GifResponse]:
+        return self.request(Route('GET', '/v2/gifs/{id}', id=id), **params)
+
+    def search(self, search_text: str, order: Order, count: int, page: int, **params: Any) -> Response[SearchResponse]:
+        r = Route(
+            'GET', '/v2/gifs/search?search_text={search_text}&order={order}&count={count}&page={page}',
+            search_text=search_text, order=order.value, count=count, page=page
+        )
+        return self.request(r, **params)
+
+    # User/Creator methods
+
+    def search_creators(
+        self,
+        page: int,
+        order: Order,
+        verified: bool,
+        tags: Optional[List[str]],
+        **params: Any
+    ):
+        url = '/v1/creators/search?page={page}&order={order}'
+        if verified:
+            url += '&verified={verified}'
+        if tags:
+            url += '&tags={tags}'
+            r = Route(
+                'GET', url,
+                page=page, order=order.value, verified='y' if verified else 'n',
+                tags=','.join(t for t in tags)
+            )
+            return self.request(r, **params)
+        else:
+            r = Route(
+                'GET', url,
+                page=page, order=order.value, verified='y' if verified else 'n'
+            )
+            return self.request(r, **params)
+
+    def search_creator(self, username: str, page: int, count: int, order: Order, type: Type, **params):
+        r = Route(
+            'GET', '/v2/users/{username}/search?page={page}&count={count}&order={order}&type={type}',
+            username=username, page=page, count=count, order=order.value, type=type.value
+        )
+        return self.request(r, **params)
+
+    def get_trending_gifs(self):
+        r = Route('GET', '/v2/explore/trending-gifs')
+        return self.request(r)
+
+    # Pic methods
+
+    def search_image(self, search_text: str, order: Order, count: int, page: int, **params: Any):
+        r = Route(
+            'GET', '/v2/gifs/search?search_text={search_text}&order={order}&count={count}&page={page}&type=i',
+            search_text=search_text, order=order.value, count=count, page=page
+        )
+        return self.request(r, **params)
+
+    def get_trending_images(self):
+        r = Route('GET', '/v2/explore/trending-images')
+        return self.request(r)
+
+    # Tag methods
+
+    def get_trending_tags(self):
+        r = Route('GET', '/v2/search/trending')
+        return self.request(r)
+
+    def get_tag_suggestions(self, query: str):
+        r = Route(
+            'GET', '/v2/search/suggest?query={query}',
+            query=query
+        )
+        return self.request(r)
+
+    # download
+
     async def download(self, url: str, fp: Union[str, bytes, os.PathLike[Any], io.BufferedIOBase]) -> int:
         yarl_url = yarl.URL(url)
         str_url = str(yarl_url)
@@ -324,9 +418,8 @@ async def dl(url: str) -> int:
         if 'watch' in yarl_url.path:
             id = yarl_url.path.strip('/watch/')
             hd_url = (await self.get_gif(id))['gif']['urls']['hd']
+            # gif = await (await self.get_gif('id'))
+            # hd_url = gif['gif']['urls']['hd']
             return (await dl(hd_url))
 
         raise TypeError(f'"{strip_ip(str_url)}" is not a valid RedGifs URL')
-
-    async def close(self) -> None:
-        await self.__session.close()

redgifs/models.py

@@ -116,8 +116,8 @@ class GIF:
     likes: int
     tags: List[str]
     verified: bool
-    views: int
-    duration: int
+    views: Optional[int]
+    duration: float
     published: bool
     urls: URL
     username: str
@@ -245,9 +245,9 @@ class User:
     name: str
     profile_image_url: str
     profile_url: str
-    published_collections: int
+    published_collections: Optional[int]
     published_gifs: int
-    status: str
+    status: Optional[str]
     subscription: int
     url: str
     username: str

redgifs/parser.py

@@ -26,6 +26,8 @@
 from datetime import datetime
 from typing import Any, Dict
 
+from redgifs.types.response import SearchResponse
+
 from .enums import Type
 from .utils import _gifs_iter, _images_iter, _users_iter, build_file_url, to_web_url
 from .models import GIF, URL, CreatorResult, Feeds, Image, User, SearchResult, CreatorsResult
@@ -58,7 +60,7 @@ def parse_feeds(json: Dict[str, Any]) -> Feeds:
     )
 
 # For GIFs
-def parse_search(searched_for: str, json: Dict[str, Any]) -> SearchResult:
+def parse_search(searched_for: str, json: SearchResponse) -> SearchResult:
     _log.debug('Using `parse_search` for: {searched_for}')
     json_gifs = json['gifs']
     users = json['users']

redgifs/types/feeds.py

@@ -0,0 +1,14 @@
+from typing import List, TypedDict
+
+
+class Feeds(TypedDict):
+    horizontalGifs: List[...]
+    hotCreators: List[...]
+    hotGifs: List[]
+    hotImages: List[]
+    longGifs: List[]
+    newCreators: List[]
+    soundGifs: List[]
+    verifiedGifs: List[]
+    verifiedImages: List[]
+    verticalGifs: List[]

redgifs/types/gif.py

@@ -0,0 +1,50 @@
+from typing import List, Optional, TypedDict
+
+class UserInfo(TypedDict):
+    creationtime: int
+    description: str
+    followers: int
+    following: int
+    gifs: int
+    name: str
+    profileImageUrl: str
+    profileUrl: str
+    publishedCollections: Optional[int]
+    publishedGifs: int
+    status: Optional[str]
+    subscription: int
+    url: str
+    username: str
+    verified: bool
+    views: int
+    poster: Optional[str]
+    preview: Optional[str]
+    thumbnail: Optional[str]
+    likes: Optional[int]
+
+class MediaInfo(TypedDict):
+    sd: str
+    hd: str
+    gif: str
+    poster: str
+    thumbnail: str
+    vthumbnail: str
+
+class GifInfo(TypedDict):
+    id: str
+    client_id: Optional[str]
+    createDate: int
+    hasAudio: bool
+    width: int
+    height: int
+    likes: int
+    tags: List[str]
+    verified: bool
+    views: Optional[int]
+    duration: float
+    published: bool
+    type: int # Literal[1,2]
+    urls: MediaInfo
+    userName: str
+    avgColor: str
+    gallry: str

redgifs/types/response.py

@@ -0,0 +1,13 @@
+from typing import List, TypedDict
+from redgifs.types.gif import GifInfo, UserInfo
+
+class GifResponse(TypedDict):
+    gif: GifInfo
+
+class SearchResponse(TypedDict):
+    page: int
+    pages: int
+    total: int
+    gifs: List[GifInfo]
+    users: List[UserInfo]
+    tags: List[str]