Module chatto.secrets

Expand source code
# Copyright (c) 2021-2022, Ethan Henderson
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from __future__ import annotations

import json
import logging
import os
import pathlib
import typing as t
from dataclasses import dataclass

import aiofiles

log = logging.getLogger(__name__)

SecretT = t.Union[str, t.List[str], pathlib.Path]


@dataclass(frozen=True)
class Secrets:
    """A dataclass representing an OAuth secrets file. All class
    variables are also parameters that should be passed into the
    constructor."""

    client_id: str
    project_id: str
    auth_uri: str
    token_uri: str
    auth_provider_x509_cert_url: str
    client_secret: str
    redirect_uris: list[str]
    path: pathlib.Path

    def __str__(self) -> str:
        return self.project_id

    def __getitem__(self, key: str) -> SecretT:
        return getattr(self, key)  # type: ignore

    @classmethod
    def from_file(cls, path: pathlib.Path | str) -> Secrets:
        """Create a `Secrets` object from a secrets file.

        ## Arguments
        * `path` -
            The path of the secrets file.

        ## Returns
        * `Secrets` -
            The newly created secrets object.
        """
        if not isinstance(path, pathlib.Path):
            path = pathlib.Path(path)

        if not path.is_file():
            raise FileNotFoundError("you must provide a valid path to a secrets file")

        with open(path, encoding="utf-8") as f:
            log.debug(f"Loading secrets from {path.resolve()}")
            data = json.load(f)["installed"]

        return cls(**data, path=path)

    @classmethod
    async def afrom_file(cls, path: pathlib.Path | str) -> Secrets:
        """Asynchronously create a `Secrets` object from a secrets file.

        ## Arguments
        * `path` -
            The path of the secrets file.

        ## Returns
        * `Secrets` -
            The newly created secrets object.
        """
        if not isinstance(path, pathlib.Path):
            path = pathlib.Path(path)

        if not os.path.isfile(path):
            raise FileNotFoundError("you must provide a valid path to a secrets file")

        async with aiofiles.open(path, encoding="utf-8") as f:
            log.debug(f"Loading secrets from {path.resolve()}")
            data = json.loads(await f.read())["installed"]

        return cls(**data, path=path)

    def to_dict(self) -> dict[str, SecretT]:
        """Output secrets data as a dictionary.

        ## Returns
        * `dict` -
            The secrets data.
        """
        return {
            "client_id": self.client_id,
            "project_id": self.project_id,
            "auth_uri": self.auth_uri,
            "token_uri": self.token_uri,
            "auth_provider_x509_cert_url": self.auth_provider_x509_cert_url,
            "client_secret": self.client_secret,
            "redirect_uris": self.redirect_uris,
        }

Classes

class Secrets (client_id: str, project_id: str, auth_uri: str, token_uri: str, auth_provider_x509_cert_url: str, client_secret: str, redirect_uris: list[str], path: pathlib.Path)

A dataclass representing an OAuth secrets file. All class variables are also parameters that should be passed into the constructor.

Expand source code
@dataclass(frozen=True)
class Secrets:
    """A dataclass representing an OAuth secrets file. All class
    variables are also parameters that should be passed into the
    constructor."""

    client_id: str
    project_id: str
    auth_uri: str
    token_uri: str
    auth_provider_x509_cert_url: str
    client_secret: str
    redirect_uris: list[str]
    path: pathlib.Path

    def __str__(self) -> str:
        return self.project_id

    def __getitem__(self, key: str) -> SecretT:
        return getattr(self, key)  # type: ignore

    @classmethod
    def from_file(cls, path: pathlib.Path | str) -> Secrets:
        """Create a `Secrets` object from a secrets file.

        ## Arguments
        * `path` -
            The path of the secrets file.

        ## Returns
        * `Secrets` -
            The newly created secrets object.
        """
        if not isinstance(path, pathlib.Path):
            path = pathlib.Path(path)

        if not path.is_file():
            raise FileNotFoundError("you must provide a valid path to a secrets file")

        with open(path, encoding="utf-8") as f:
            log.debug(f"Loading secrets from {path.resolve()}")
            data = json.load(f)["installed"]

        return cls(**data, path=path)

    @classmethod
    async def afrom_file(cls, path: pathlib.Path | str) -> Secrets:
        """Asynchronously create a `Secrets` object from a secrets file.

        ## Arguments
        * `path` -
            The path of the secrets file.

        ## Returns
        * `Secrets` -
            The newly created secrets object.
        """
        if not isinstance(path, pathlib.Path):
            path = pathlib.Path(path)

        if not os.path.isfile(path):
            raise FileNotFoundError("you must provide a valid path to a secrets file")

        async with aiofiles.open(path, encoding="utf-8") as f:
            log.debug(f"Loading secrets from {path.resolve()}")
            data = json.loads(await f.read())["installed"]

        return cls(**data, path=path)

    def to_dict(self) -> dict[str, SecretT]:
        """Output secrets data as a dictionary.

        ## Returns
        * `dict` -
            The secrets data.
        """
        return {
            "client_id": self.client_id,
            "project_id": self.project_id,
            "auth_uri": self.auth_uri,
            "token_uri": self.token_uri,
            "auth_provider_x509_cert_url": self.auth_provider_x509_cert_url,
            "client_secret": self.client_secret,
            "redirect_uris": self.redirect_uris,
        }

Class variables

var auth_provider_x509_cert_url : str
var auth_uri : str
var client_id : str
var client_secret : str
var path : pathlib.Path
var project_id : str
var redirect_uris : list[str]
var token_uri : str

Static methods

async def afrom_file(path: pathlib.Path | str) ‑> Secrets

Asynchronously create a Secrets object from a secrets file.

Arguments

  • path - The path of the secrets file.

Returns

  • Secrets - The newly created secrets object.
Expand source code
@classmethod
async def afrom_file(cls, path: pathlib.Path | str) -> Secrets:
    """Asynchronously create a `Secrets` object from a secrets file.

    ## Arguments
    * `path` -
        The path of the secrets file.

    ## Returns
    * `Secrets` -
        The newly created secrets object.
    """
    if not isinstance(path, pathlib.Path):
        path = pathlib.Path(path)

    if not os.path.isfile(path):
        raise FileNotFoundError("you must provide a valid path to a secrets file")

    async with aiofiles.open(path, encoding="utf-8") as f:
        log.debug(f"Loading secrets from {path.resolve()}")
        data = json.loads(await f.read())["installed"]

    return cls(**data, path=path)
def from_file(path: pathlib.Path | str) ‑> Secrets

Create a Secrets object from a secrets file.

Arguments

  • path - The path of the secrets file.

Returns

  • Secrets - The newly created secrets object.
Expand source code
@classmethod
def from_file(cls, path: pathlib.Path | str) -> Secrets:
    """Create a `Secrets` object from a secrets file.

    ## Arguments
    * `path` -
        The path of the secrets file.

    ## Returns
    * `Secrets` -
        The newly created secrets object.
    """
    if not isinstance(path, pathlib.Path):
        path = pathlib.Path(path)

    if not path.is_file():
        raise FileNotFoundError("you must provide a valid path to a secrets file")

    with open(path, encoding="utf-8") as f:
        log.debug(f"Loading secrets from {path.resolve()}")
        data = json.load(f)["installed"]

    return cls(**data, path=path)

Methods

def to_dict(self) ‑> dict[str, typing.Union[str, typing.List[str], pathlib.Path]]

Output secrets data as a dictionary.

Returns

  • dict - The secrets data.
Expand source code
def to_dict(self) -> dict[str, SecretT]:
    """Output secrets data as a dictionary.

    ## Returns
    * `dict` -
        The secrets data.
    """
    return {
        "client_id": self.client_id,
        "project_id": self.project_id,
        "auth_uri": self.auth_uri,
        "token_uri": self.token_uri,
        "auth_provider_x509_cert_url": self.auth_provider_x509_cert_url,
        "client_secret": self.client_secret,
        "redirect_uris": self.redirect_uris,
    }