pynintendoparental 1.1.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

pynintendoparental/enum.py

@@ -1,9 +1,11 @@
 """Enums"""
 
-from enum import Enum
+from enum import Enum, StrEnum
+
 
 class AlarmSettingState(Enum):
     """Alarm setting states."""
+
     SUCCESS = 0
     TO_VISIBLE = 1
     TO_INVISIBLE = 2
@@ -13,10 +15,22 @@ class AlarmSettingState(Enum):
     def __str__(self) -> str:
         return self.name
 
+
 class RestrictionMode(Enum):
     """Restriction modes."""
+
     FORCED_TERMINATION = 0
     ALARM = 1
 
     def __str__(self) -> str:
         return self.name
+
+
+class DeviceTimerMode(StrEnum):
+    """Device timer modes."""
+
+    DAILY = "DAILY"
+    EACH_DAY_OF_THE_WEEK = "EACH_DAY_OF_THE_WEEK"
+
+    def __str__(self) -> str:
+        return self.name

pynintendoparental/exceptions.py

@@ -8,28 +8,13 @@ class RangeErrorKeys(StrEnum):
     DAILY_PLAYTIME = "daily_playtime_out_of_range"
     BEDTIME = "bedtime_alarm_out_of_range"
 
-class HttpException(Exception):
-    """A HTTP error occured"""
-    def __init__(self, status_code: int, message: str) -> None:
-        """Initialize the exception."""
-        super().__init__(message)
-        self.status_code = status_code
-        self.message = message
-
-    def __str__(self) -> str:
-        return f"HTTP {self.status_code}: {self.message}"
-
-class InvalidSessionTokenException(HttpException):
-    """Provided session token was invalid (invalid_grant)."""
-
-class InvalidOAuthConfigurationException(HttpException):
-    """The OAuth scopes are invalid."""
-
 class NoDevicesFoundException(Exception):
     """No devices were found for the account."""
 
+
 class InputValidationError(Exception):
     """Input Validation Failed."""
+
     value: object
     error_key: str
 
@@ -37,11 +22,13 @@ class InputValidationError(Exception):
         super().__init__(f"{self.__doc__} Received value: {value}")
         self.value = value
 
+
 class BedtimeOutOfRangeError(InputValidationError):
     """Bedtime is outside of the allowed range."""
 
     error_key = RangeErrorKeys.BEDTIME
 
+
 class DailyPlaytimeOutOfRangeError(InputValidationError):
     """Daily playtime is outside of the allowed range."""
 

pynintendoparental/player.py

@@ -2,8 +2,10 @@
 
 from .const import _LOGGER
 
+
 class Player:
     """Defines a single player on a Nintendo device."""
+
     def __init__(self):
         """Init a player."""
         self.player_image: str = None
@@ -25,7 +27,7 @@ class Player:
                 break
 
     @classmethod
-    def from_device_daily_summary(cls, raw: list[dict]) -> list['Player']:
+    def from_device_daily_summary(cls, raw: list[dict]) -> list["Player"]:
         """Converts a daily summary response into a list of players."""
         players = []
         _LOGGER.debug("Building players from device daily summary.")

pynintendoparental/utils.py

@@ -2,6 +2,7 @@
 
 import inspect
 
+
 def is_awaitable(func):
     """Check if a function is awaitable or not."""
     return inspect.iscoroutinefunction(func) or inspect.isasyncgenfunction(func)

{pynintendoparental-1.1.2.dist-info → pynintendoparental-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pynintendoparental
-Version: 1.1.2
+Version: 2.0.0
 Summary: A Python module to interact with Nintendo Parental Controls
 Home-page: http://github.com/pantherale0/pynintendoparental
 Author: pantherale0
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pynintendoauth~=1.0.0
 Provides-Extra: dev
 Requires-Dist: bandit<1.9,>=1.7; extra == "dev"
 Requires-Dist: black<26,>=23; extra == "dev"
@@ -29,6 +30,7 @@ Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
 Dynamic: provides-extra
+Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 

pynintendoparental-2.0.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pynintendoparental/__init__.py,sha256=gO3rH9gukrFoACVkdqj_liqcgtHxSZlitE0PrVQZGok,2334
+pynintendoparental/_version.py,sha256=_7OlQdbVkK4jad0CLdpI0grT-zEAb-qgFmH5mFzDXiA,22
+pynintendoparental/api.py,sha256=LmZei8WPzEhCEoVLXXHiaKRbDEbmGyD6CyfPS4fXxnc,7047
+pynintendoparental/application.py,sha256=8zTisF3_COgIzKCLIgLpYdHcX4OiwRQU5NH2WUngvxc,3995
+pynintendoparental/authenticator.py,sha256=WPAEAUKmIymIiQUXILYt4B2_3UgYRKEVi6btJRwzjmM,430
+pynintendoparental/const.py,sha256=2fq0VmqFetwLq1YBXatlb7tFaDeR0pnsdja4MLFdbDA,2174
+pynintendoparental/device.py,sha256=VSK1-fKcXA2AoGCKaVGyhy32T6VXYowuo7upNivaWyk,24521
+pynintendoparental/enum.py,sha256=NlkfrZTfiur6vTqqwHxeiM7wPQZ-1Y1PlY4Jh_gq4NQ,605
+pynintendoparental/exceptions.py,sha256=8a_7ocrlB0PwPM36Q4FqR-W0lkGXihOs79gGqQIWZoo,881
+pynintendoparental/player.py,sha256=rXYgUiy7DhBjosQlADr7Fa_HVdA1e-04oPZiC4Y68oM,1787
+pynintendoparental/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pynintendoparental/utils.py,sha256=gLMibsEOnKUZJgCQKF4Zk517fawZ3mBqMK6MS2g-Um0,199
+pynintendoparental-2.0.0.dist-info/licenses/LICENSE,sha256=zsxHgHVMnyWq121yND8zBl9Rl9H6EF2K9N51B2ZSm_k,1071
+pynintendoparental-2.0.0.dist-info/METADATA,sha256=5LTsNbTAUk98bovyA4h57PuFT6-iC470Hk98ErArp7Q,1931
+pynintendoparental-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pynintendoparental-2.0.0.dist-info/top_level.txt,sha256=QQ5bAl-Ljso16P8KLf1NHrFmKk9jLT7bVJG_rVlIXWk,19
+pynintendoparental-2.0.0.dist-info/RECORD,,

pynintendoparental/authenticator/__init__.py

@@ -1,226 +0,0 @@
-"""Nintendo Authentication."""
-from __future__ import annotations
-
-import logging
-import base64
-import hashlib
-import random
-import string
-
-from urllib.parse import urlencode, urlparse
-
-from datetime import datetime, timedelta
-
-import aiohttp
-
-from pynintendoparental.exceptions import (
-    HttpException,
-    InvalidOAuthConfigurationException,
-    InvalidSessionTokenException
-)
-from .const import (
-    TOKEN_URL,
-    SESSION_TOKEN_URL,
-    CLIENT_ID,
-    GRANT_TYPE,
-    MY_ACCOUNT_ENDPOINT,
-    REDIRECT_URI,
-    SCOPES,
-    AUTHORIZE_URL
-)
-
-_LOGGER = logging.getLogger(__name__)
-
-def _parse_response_token(token: str) -> dict:
-    """Parses a response token."""
-    _LOGGER.debug(">> Parsing response token.")
-    try:
-        url = urlparse(token)
-        params = url.fragment.split('&')
-        response = {}
-        for param in params:
-            response = {
-                **response,
-                param.split('=')[0]: param.split('=')[1]
-            }
-        return response
-    except Exception as exc:
-        raise ValueError("Invalid token provided.") from exc
-
-def _hash(text: str):
-    """Hash given text for login."""
-    text = hashlib.sha256(text.encode()).digest()
-    text = base64.urlsafe_b64encode(text).decode()
-    return text.replace("=", "")
-
-def _rand():
-    return ''.join(random.choice(string.ascii_letters) for _ in range(50))
-
-class Authenticator:
-    """Authentication functions."""
-
-    def __init__(
-            self,
-            session_token = None,
-            auth_code_verifier = None,
-            client_session: aiohttp.ClientSession = None
-        ):
-        """Basic init."""
-        _LOGGER.debug(">> Init authenticator.")
-        self._at_expiry: datetime = None
-        self._access_token: str = None
-        self.available_scopes: dict = None
-        self.account_id: str = None
-        self.account: dict = None
-        self._auth_code_verifier: str = auth_code_verifier
-        self._refresh_token: str = None
-        self._id_token: str = None
-        self._session_token: str = session_token
-        self.login_url: str = None
-        if client_session is None:
-            client_session = aiohttp.ClientSession()
-        self.client_session: aiohttp.ClientSession = client_session
-
-    @property
-    def get_session_token(self) -> str:
-        """Return the session token."""
-        return self._session_token
-
-    @property
-    def access_token(self) -> str:
-        """Return the formatted access token."""
-        return f"Bearer {self._id_token}" # v2 seems to use ID token for API access?
-
-    @property
-    def access_token_expired(self) -> bool:
-        """Check if the access token has expired."""
-        return self._at_expiry < (datetime.now()+timedelta(minutes=1))
-
-    async def _request_handler(self, method, url, json=None, data=None, headers: dict=None):
-        """Send a HTTP request"""
-        if headers is None:
-            headers = {}
-        response: dict = {
-            "status": 0,
-            "text": "",
-            "json": "",
-            "headers": ""
-        }
-        async with self.client_session.request(
-            method=method,
-            url=url,
-            json=json,
-            data=data,
-            headers=headers
-        ) as resp:
-            response["status"] = resp.status
-            response["text"] = await resp.text()
-            response["json"] = await resp.json()
-            response["headers"] = resp.headers
-        return response
-
-    def _read_tokens(self, tokens: dict):
-        """Reads tokens into self."""
-        self.available_scopes = tokens.get("scope")
-        self._at_expiry = datetime.now() + timedelta(seconds=tokens.get("expires_in"))
-        self._id_token = tokens.get("id_token")
-        self._access_token = tokens.get("access_token")
-
-    async def perform_login(self, session_token_code):
-        """Retrieves initial tokens."""
-        _LOGGER.debug("Performing initial login.")
-        session_token_form = aiohttp.FormData()
-        session_token_form.add_field("client_id", CLIENT_ID)
-        session_token_form.add_field("session_token_code", session_token_code)
-        session_token_form.add_field("session_token_code_verifier", self._auth_code_verifier)
-        session_token_response = await self._request_handler(
-            method="POST",
-            url=SESSION_TOKEN_URL,
-            data=session_token_form
-        )
-
-        if session_token_response.get("status") != 200:
-            raise HttpException(session_token_response.get("status"),
-                                session_token_response.get("text"))
-
-        self._session_token = session_token_response["json"]["session_token"]
-
-    async def perform_refresh(self):
-        """Refresh the access token."""
-        _LOGGER.debug("Refreshing access token.")
-        token_response = await self._request_handler(
-            method="POST",
-            url=TOKEN_URL,
-            json={
-                "client_id": CLIENT_ID,
-                "grant_type": GRANT_TYPE,
-                "session_token": self.get_session_token
-            }
-        )
-
-        if token_response["status"] == 400:
-            raise InvalidSessionTokenException(400, token_response["json"]["error"])
-
-        if token_response["status"] == 401:
-            raise InvalidOAuthConfigurationException(401, token_response["json"]["error"])
-
-        if token_response.get("status") != 200:
-            raise HttpException(token_response.get("status"), f"login error {token_response.get('status')}")
-
-        self._read_tokens(token_response.get("json"))
-        if self.account_id is None:
-            # fill account_id
-            account = await self._request_handler(
-                method="GET",
-                url=MY_ACCOUNT_ENDPOINT,
-                headers={
-                    "Authorization": f"Bearer {self._access_token}"
-                }
-            )
-            if account["status"] != 200:
-                raise HttpException(account["status"], f"Unable to get account_id {account['status']}")
-            self.account_id = account["json"]["id"]
-            self.account = account["json"]
-
-    @classmethod
-    def generate_login(
-        cls,
-        client_session: aiohttp.ClientSession | None = None) -> 'Authenticator':
-        """Starts configuration of the authenticator."""
-        verifier = _rand()
-
-        auth = cls(auth_code_verifier=verifier, client_session=client_session)
-
-        query = {
-            "client_id": CLIENT_ID,
-            # "interacted": 1,
-            "redirect_uri": REDIRECT_URI,
-            "response_type": "session_token_code",
-            "scope": "+".join(SCOPES),
-            "session_token_code_challenge": _hash(verifier),
-            "session_token_code_challenge_method": "S256",
-            "state": _rand(),
-            "theme": "login_form"
-        }
-
-        auth.login_url = AUTHORIZE_URL.format(urlencode(query)).replace("%2B", "+")
-        return auth
-
-    @classmethod
-    async def complete_login(cls,
-                     auth: Authenticator | None,
-                     response_token: str,
-                     is_session_token: bool=False,
-                     client_session: aiohttp.ClientSession | None = None) -> Authenticator:
-        """Creates and logs into Nintendo APIs"""
-        if is_session_token:
-            auth = cls(session_token=response_token, client_session=client_session)
-            await auth.perform_refresh()
-        else:
-            response_token = _parse_response_token(response_token)
-            await auth.perform_login(
-                session_token_code=response_token.get("session_token_code")
-            )
-            await auth.perform_refresh()
-
-        return auth

pynintendoparental/authenticator/const.py

@@ -1,29 +0,0 @@
-# pylint: disable=line-too-long
-"""Static values."""
-
-CLIENT_ID = "54789befb391a838"
-GRANT_TYPE = "urn:ietf:params:oauth:grant-type:jwt-bearer-session-token"
-
-REDIRECT_URI = f"npf{CLIENT_ID}://auth"
-SCOPES = [
-    "openid",
-    "user",
-    "user.mii",
-    "moonUser:administration",
-    "moonDevice:create",
-    "moonOwnedDevice:administration",
-    "moonParentalControlSetting",
-    "moonParentalControlSetting:update",
-    "moonParentalControlSettingState",
-    "moonPairingState",
-    "moonSmartDevice:administration",
-    "moonDailySummary",
-    "moonMonthlySummary",
-]
-
-AUTHORIZE_URL = "https://accounts.nintendo.com/connect/1.0.0/authorize?{}"
-SESSION_TOKEN_URL = "https://accounts.nintendo.com/connect/1.0.0/api/session_token"
-TOKEN_URL = "https://accounts.nintendo.com/connect/1.0.0/api/token"
-
-ACCOUNT_API_BASE = "https://api.accounts.nintendo.com/2.0.0"
-MY_ACCOUNT_ENDPOINT = f"{ACCOUNT_API_BASE}/users/me"

pynintendoparental-1.1.2.dist-info/RECORD

@@ -1,18 +0,0 @@
-pynintendoparental/__init__.py,sha256=pNcBsHRa4B85USP7uzwPEGF9fu3MA9YgW_hI82F_NXQ,2460
-pynintendoparental/_version.py,sha256=5SgGjThsHu_ITn8V83BvCziqCwxdXxTQqcC3KQMHPfM,22
-pynintendoparental/api.py,sha256=hMXq0eNIgFELlNZJtN0rK3plKyu9nirvwiUPNlkjOCY,7013
-pynintendoparental/application.py,sha256=l-oVwM4hrVVUf_2djQ7rJVya7LQP38yhaLPAWt8V8TY,3941
-pynintendoparental/const.py,sha256=sQZqU0f1NSClMPfCSJonlCunLdbPPiXjL-JS2LMZGd4,2101
-pynintendoparental/device.py,sha256=EEQfnab96CIGlB2n1gePQBn5SWx7cck8tX_qz8xAHjc,22956
-pynintendoparental/enum.py,sha256=lzacGti7fcQqAOROjB9782De7bOMYKSEM61SQd6aYG4,401
-pynintendoparental/exceptions.py,sha256=-KuRBoMtzWKycjdgIsRYPzSVi_uzPjROq7blJSgq-iw,1450
-pynintendoparental/player.py,sha256=WDl0pspHgrV9lGhDp-NKlfP8DV4Yxe02aYaGg9wTTeg,1785
-pynintendoparental/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pynintendoparental/utils.py,sha256=5-EP_rmPnSSWtbi18Y226GtjLhF3PLONKwmRdiy7m2c,198
-pynintendoparental/authenticator/__init__.py,sha256=MZdA6qqHV0i7rspNL9Z9xl7aRy-EJEm3NIapiIgEJBA,7688
-pynintendoparental/authenticator/const.py,sha256=_nUJVC0U64j_n1LaQd_KDg0EWFcezb87bQyYYXpbPPY,917
-pynintendoparental-1.1.2.dist-info/licenses/LICENSE,sha256=zsxHgHVMnyWq121yND8zBl9Rl9H6EF2K9N51B2ZSm_k,1071
-pynintendoparental-1.1.2.dist-info/METADATA,sha256=wV4_2Gwy86YLWZe8SOu5svDLpH2VWsi5ORPCVfYzLKk,1871
-pynintendoparental-1.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pynintendoparental-1.1.2.dist-info/top_level.txt,sha256=QQ5bAl-Ljso16P8KLf1NHrFmKk9jLT7bVJG_rVlIXWk,19
-pynintendoparental-1.1.2.dist-info/RECORD,,