Refactor Endpoints

.github/workflows/main.yml

@@ -30,9 +30,9 @@ jobs:
         id: cache-poetry
         with:
           path: ~/.virtualenvs
-          key: poetry|pre-commit|v2|${{ matrix.os }}|${{ env.PY }}|${{ hashFiles('poetry.lock') }}
+          key: poetry|pre-commit|v3|${{ matrix.os }}|${{ env.PY }}|${{ hashFiles('poetry.lock') }}
           restore-keys: |
-            poetry|pre-commit|v2|${{ matrix.os }}|${{ env.PY }}|
+            poetry|pre-commit|v3|${{ matrix.os }}|${{ env.PY }}|
       - name: Install Project Dependencies (Poetry)
         run: |
           poetry install -vvv
@@ -78,9 +78,9 @@ jobs:
         id: cache-poetry
         with:
           path: ~/.virtualenvs
-          key: poetry|v2|${{ matrix.os }}|${{ env.PY }}|${{ hashFiles('poetry.lock') }}
+          key: poetry|v3|${{ matrix.os }}|${{ env.PY }}|${{ hashFiles('poetry.lock') }}
           restore-keys: |
-            poetry|v2|${{ matrix.os }}|${{ env.PY }}|
+            poetry|v3|${{ matrix.os }}|${{ env.PY }}|
       - name: Install Project Dependencies (Poetry)
         run: |
           poetry install -vvv

newsfragments/226.misc

@@ -0,0 +1 @@
+Refactor endpoints to ursl and make better use of yarl.

pyrh/models/base.py

@@ -1,13 +1,12 @@
 """Base Model."""
 
 from types import SimpleNamespace
-from typing import Any, Mapping
+from typing import Any, Dict, Mapping
 
 from marshmallow import INCLUDE, Schema, post_load
 
-from pyrh.common import JSON
-
 
+JSON = Dict[str, Any]
 MAX_REPR_LEN = 50
 
 

pyrh/models/portfolio.py

@@ -4,9 +4,7 @@
 
 from marshmallow import fields, post_load
 
-from pyrh.common import JSON
-
-from .base import BaseModel, BaseSchema
+from .base import JSON, BaseModel, BaseSchema
 
 
 class Portfolio(BaseModel):

pyrh/models/sessionmanager.py

@@ -2,7 +2,7 @@
 
 import uuid
 from datetime import datetime, timedelta
-from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union, cast
+from typing import TYPE_CHECKING, Any, Dict, Optional, Union, cast
 from urllib.request import getproxies
 
 import certifi
@@ -13,29 +13,24 @@
 from requests.structures import CaseInsensitiveDict
 from yarl import URL
 
-from pyrh.common import API_BASE, JSON
+from pyrh import urls
 from pyrh.exceptions import AuthenticationError
 
-from .base import BaseModel, BaseSchema
+from .base import JSON, BaseModel, BaseSchema
 from .oauth import CHALLENGE_TYPE_VAL, OAuth, OAuthSchema
 
 
-CLIENT_ID: str = "c82SH0WZOsabOXGP2sxqcj34FxkvfnWRZBKlBjFS"
-"""Robinhood client id."""
-
+# Types
 if TYPE_CHECKING:  # pragma: no cover
     CaseInsensitiveDictType = CaseInsensitiveDict[str]
 else:
     CaseInsensitiveDictType = CaseInsensitiveDict
+Proxies = Dict[str, str]
 
-# Endpoints
-OAUTH: URL = API_BASE.with_path("/oauth2/token/")
-OAUTH_REVOKE: URL = API_BASE.with_path("/oauth2/revoke_token/")
-CHALLENGE: Callable[[str], URL] = lambda cid: API_BASE.with_path(
-    f"/challenge/{cid}/respond/"
-)
 
-Proxies = Dict[str, str]
+# Constants
+CLIENT_ID: str = "c82SH0WZOsabOXGP2sxqcj34FxkvfnWRZBKlBjFS"
+"""Robinhood client id."""
 HEADERS: CaseInsensitiveDictType = CaseInsensitiveDict(
     {
         "Accept": "*/*",
@@ -48,15 +43,11 @@
     }
 )
 """Headers used when performing requests with robinhood api."""
-
 # 8.5 days (you have a small window to refresh after this)
 # I would refresh the token proactively every day in a script
 EXPIRATION_TIME: int = 734000
 """Default expiration time for requests."""
 
-# TODO: Watch this issue and remove the F811 ignores when it is fixed
-# https://gitlab.com/pycqa/flake8/-/merge_requests/417 (we need at least pyflakes 2.2.0)
-
 
 class SessionManager(BaseModel):
     """Mange connectivity with Robinhood API.
@@ -312,7 +303,7 @@ def _challenge_oauth2(self, oauth: OAuth, oauth_payload: JSON) -> OAuth:
 
         """
         # login challenge
-        challenge_url = CHALLENGE(oauth.challenge.id)
+        challenge_url = urls.build_challenge(oauth.challenge.id)
         print(
             f"Input challenge code from {oauth.challenge.type.capitalize()} "
             f"({oauth.challenge.remaining_attempts}/"
@@ -338,7 +329,7 @@ def _challenge_oauth2(self, oauth: OAuth, oauth_payload: JSON) -> OAuth:
                 return cast(
                     OAuth,
                     self.post(
-                        OAUTH,
+                        urls.OAUTH,
                         data=oauth_payload,
                         headers=challenge_header,
                         auto_login=False,
@@ -374,7 +365,7 @@ def _mfa_oauth2(self, oauth_payload: JSON, attempts: int = 3) -> OAuth:
         mfa_code = input()
         oauth_payload["mfa_code"] = mfa_code
         oauth, res = self.post(
-            OAUTH,
+            urls.OAUTH,
             data=oauth_payload,
             raise_errors=False,
             auto_login=False,
@@ -413,7 +404,7 @@ def _login_oauth2(self) -> None:
         }
 
         oauth = self.post(
-            OAUTH,
+            urls.OAUTH,
             data=oauth_payload,
             raise_errors=False,
             auto_login=False,
@@ -456,7 +447,10 @@ def _refresh_oauth2(self) -> None:
         self.session.headers.pop("Authorization", None)
         try:
             oauth = self.post(
-                OAUTH, data=relogin_payload, auto_login=False, schema=OAuthSchema()
+                urls.OAUTH,
+                data=relogin_payload,
+                auto_login=False,
+                schema=OAuthSchema(),
             )
         except HTTPError:
             raise AuthenticationError("Failed to refresh token")
@@ -472,7 +466,7 @@ def logout(self) -> None:
         """
         logout_payload = {"client_id": CLIENT_ID, "token": self.oauth.refresh_token}
         try:
-            self.post(OAUTH_REVOKE, data=logout_payload, auto_login=False)
+            self.post(urls.OAUTH_REVOKE, data=logout_payload, auto_login=False)
             self.oauth = OAuth()
             self.session.headers.pop("Authorization", None)
         except HTTPError: