Module cloudofficeprint.config.cloud

Expand source code 
import json
from typing import Dict, List
from abc import ABC, abstractmethod

__all__ = [
    "CloudAccessToken",
    "OAuthToken",
    "AWSToken",
    "FTPToken"
]

SERVICES = [
    "dropbox",
    "gdrive",
    "onedrive",
    "aws_s3",
    "sftp",
    "ftp"
]


class CloudAccessToken(ABC):
    """Abstract base class for classes used to specify cloud access information for outputting to a cloud service."""

    def __init__(self, service: str):
        """
        Args:
            service (str): name of the cloud service

        Raises:
            ValueError: raise error if the given name for the cloud service is not known
        """
        if not self.is_valid_service(service):
            raise ValueError(f'Unsupported cloud service "{service}".')
        self._service = service

    @property
    def service(self) -> str:
        """Returns which cloud service is being used.

        Returns:
            str: which cloud service is being used
        """
        return self._service

    @service.setter
    def service(self, value: str):
        """Setter for self._service

        Args:
            value (str): new value for self._service

        Raises:
            ValueError: raise error if the given name for the cloud service is not known
        """
        if not self.is_valid_service(value):
            raise ValueError(f'Unsupported cloud service "{value}".')
        self._service = value

    @property
    @abstractmethod
    def as_dict(self) -> Dict:
        """The cloud access token as a dict, for building the JSON.

        Returns:
            Dict: dict representation for this cloud access token
        """
        return {
            "output_location": self.service
        }

    @property
    def json(self) -> str:
        """The cloud access token as JSON.

        Returns:
            str: JSON representation for this cloud access token
        """
        return json.dumps(self.as_dict)

    @staticmethod
    def is_valid_service(value: str) -> bool:
        """Check if the given value is a valid service string.

        Args:
            value (str): the service to check

        Returns:
            bool: whether value is valid
        """
        return value in SERVICES

    @staticmethod
    def list_available_services() -> List[str]:
        """List all available services.

        Returns:
            List[str]: list of available service strings
        """
        return SERVICES

    @staticmethod
    def from_OAuth(service: str, token: str) -> 'OAuthToken':
        """Create a token from an OAuth string and service name.

        Args:
            service (str): cloud service
            token (str): OAuth access token

        Returns:
            OAuthToken: created token
        """
        return OAuthToken(service, token)

    @staticmethod
    def from_AWS(key_id: str, secret_key: str):
        """Create a token from Amazon S3 access key id and secret access key.

        Args:
            key_id (str): AWS access key ID
            secret_key (str): AWS secret access key

        Returns:
            AWSToken: created token
        """
        return AWSToken(key_id, secret_key)

    @staticmethod
    def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
        """Create a token from FTP info

        When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
        The Cloud Office Print server will then fill in default values.

        Args:
            host (str): host name or IP address
            port (int, optional): port to use. Defaults to None.
            user (str, optional): user name. Defaults to None.
            password (str, optional): password for user. Defaults to None.

        Returns:
            FTPToken: created token
        """
        return FTPToken(host, False, port, user, password)

    @staticmethod
    def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
        """Create a token from SFTP info

        When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
        The Cloud Office Print server will then fill in default values.

        Args:
            host (str): host name or IP address
            port (int, optional): port to use. Defaults to None.
            user (str, optional): user name. Defaults to None.
            password (str, optional): password for user. Defaults to None.

        Returns:
            FTPToken: created token
                      This is an FTPToken object, with sftp=True passed into the constructor.
                      The only difference with FTP is CloudAccessToken.servicename.
        """
        return FTPToken(host, True, port, user, password)


class OAuthToken(CloudAccessToken):
    """`CloudAccessToken` to be used for OAuth tokens"""

    def __init__(self, service: str, token: str):
        """
        Args:
            service (str): `CloudAccessToken.service`
            token (str): OAuth token
        """
        super().__init__(service)
        self.token: str = token

    @property
    def as_dict(self) -> Dict:
        result = super().as_dict
        result.update({
            "cloud_access_token": self.token
        })
        return result


class AWSToken(CloudAccessToken):
    """`CloudAccessToken` to be used for AWS tokens"""

    def __init__(self, key_id: str, secret_key: str):
        """
        Args:
            key_id (str): AWS access key ID
            secret_key (str): AWS secret key
        """
        super().__init__("aws_s3")
        self.key_id: str = key_id
        self.secret_key: str = secret_key

    @property
    def as_dict(self) -> Dict:
        result = super().as_dict
        result.update({
            "cloud_access_token": {
                "access_key": self.key_id,
                "secret_access_key": self.secret_key
            }
        })
        return result


class FTPToken(CloudAccessToken):
    """`CloudAccessToken` to be used for FTP/SFTP tokens"""

    def __init__(self, host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None):
        """
        Args:
            host (str): Host name or IP address of the FTP/SFTP server.
            sftp (bool, optional): whether to use SFTP (else FTP). Defaults to False.
            port (int, optional): Port number of the FTP/SFTP server. Defaults to None.
            user (str, optional): User name for the FTP/SFTP server. Defaults to None.
            password (str, optional): Password for the user. Defaults to None.
        """
        super().__init__("sftp" if sftp else "ftp")
        self.host: str = host
        self.port: int = port
        self.user: str = user
        self.password: str = password

    @property
    def as_dict(self) -> Dict:
        cloud_access_token = {
            "host": self.host
        }
        if self.port is not None:
            cloud_access_token["port"] = self.port
        if self.user is not None:
            cloud_access_token["user"] = self.user
        if self.password is not None:
            cloud_access_token["password"] = self.password

        result = super().as_dict
        result.update({
            "cloud_access_token": cloud_access_token
        })

        return result

Classes

class AWSToken (key_id: str, secret_key: str)

CloudAccessToken to be used for AWS tokens

Args

key_id : str
AWS access key ID
secret_key : str
AWS secret key
Expand source code 
class AWSToken(CloudAccessToken):
    """`CloudAccessToken` to be used for AWS tokens"""

    def __init__(self, key_id: str, secret_key: str):
        """
        Args:
            key_id (str): AWS access key ID
            secret_key (str): AWS secret key
        """
        super().__init__("aws_s3")
        self.key_id: str = key_id
        self.secret_key: str = secret_key

    @property
    def as_dict(self) -> Dict:
        result = super().as_dict
        result.update({
            "cloud_access_token": {
                "access_key": self.key_id,
                "secret_access_key": self.secret_key
            }
        })
        return result

Ancestors

Inherited members

class CloudAccessToken (service: str)

Abstract base class for classes used to specify cloud access information for outputting to a cloud service.

Args

service : str
name of the cloud service

Raises

ValueError
raise error if the given name for the cloud service is not known
Expand source code 
class CloudAccessToken(ABC):
    """Abstract base class for classes used to specify cloud access information for outputting to a cloud service."""

    def __init__(self, service: str):
        """
        Args:
            service (str): name of the cloud service

        Raises:
            ValueError: raise error if the given name for the cloud service is not known
        """
        if not self.is_valid_service(service):
            raise ValueError(f'Unsupported cloud service "{service}".')
        self._service = service

    @property
    def service(self) -> str:
        """Returns which cloud service is being used.

        Returns:
            str: which cloud service is being used
        """
        return self._service

    @service.setter
    def service(self, value: str):
        """Setter for self._service

        Args:
            value (str): new value for self._service

        Raises:
            ValueError: raise error if the given name for the cloud service is not known
        """
        if not self.is_valid_service(value):
            raise ValueError(f'Unsupported cloud service "{value}".')
        self._service = value

    @property
    @abstractmethod
    def as_dict(self) -> Dict:
        """The cloud access token as a dict, for building the JSON.

        Returns:
            Dict: dict representation for this cloud access token
        """
        return {
            "output_location": self.service
        }

    @property
    def json(self) -> str:
        """The cloud access token as JSON.

        Returns:
            str: JSON representation for this cloud access token
        """
        return json.dumps(self.as_dict)

    @staticmethod
    def is_valid_service(value: str) -> bool:
        """Check if the given value is a valid service string.

        Args:
            value (str): the service to check

        Returns:
            bool: whether value is valid
        """
        return value in SERVICES

    @staticmethod
    def list_available_services() -> List[str]:
        """List all available services.

        Returns:
            List[str]: list of available service strings
        """
        return SERVICES

    @staticmethod
    def from_OAuth(service: str, token: str) -> 'OAuthToken':
        """Create a token from an OAuth string and service name.

        Args:
            service (str): cloud service
            token (str): OAuth access token

        Returns:
            OAuthToken: created token
        """
        return OAuthToken(service, token)

    @staticmethod
    def from_AWS(key_id: str, secret_key: str):
        """Create a token from Amazon S3 access key id and secret access key.

        Args:
            key_id (str): AWS access key ID
            secret_key (str): AWS secret access key

        Returns:
            AWSToken: created token
        """
        return AWSToken(key_id, secret_key)

    @staticmethod
    def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
        """Create a token from FTP info

        When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
        The Cloud Office Print server will then fill in default values.

        Args:
            host (str): host name or IP address
            port (int, optional): port to use. Defaults to None.
            user (str, optional): user name. Defaults to None.
            password (str, optional): password for user. Defaults to None.

        Returns:
            FTPToken: created token
        """
        return FTPToken(host, False, port, user, password)

    @staticmethod
    def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
        """Create a token from SFTP info

        When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
        The Cloud Office Print server will then fill in default values.

        Args:
            host (str): host name or IP address
            port (int, optional): port to use. Defaults to None.
            user (str, optional): user name. Defaults to None.
            password (str, optional): password for user. Defaults to None.

        Returns:
            FTPToken: created token
                      This is an FTPToken object, with sftp=True passed into the constructor.
                      The only difference with FTP is CloudAccessToken.servicename.
        """
        return FTPToken(host, True, port, user, password)

Ancestors

  • abc.ABC

Subclasses

Static methods

def from_AWS(key_id: str, secret_key: str)

Create a token from Amazon S3 access key id and secret access key.

Args

key_id : str
AWS access key ID
secret_key : str
AWS secret access key

Returns

AWSToken
created token
Expand source code 
@staticmethod
def from_AWS(key_id: str, secret_key: str):
    """Create a token from Amazon S3 access key id and secret access key.

    Args:
        key_id (str): AWS access key ID
        secret_key (str): AWS secret access key

    Returns:
        AWSToken: created token
    """
    return AWSToken(key_id, secret_key)
def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken

Create a token from FTP info

When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. The Cloud Office Print server will then fill in default values.

Args

host : str
host name or IP address
port : int, optional
port to use. Defaults to None.
user : str, optional
user name. Defaults to None.
password : str, optional
password for user. Defaults to None.

Returns

FTPToken
created token
Expand source code 
@staticmethod
def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
    """Create a token from FTP info

    When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
    The Cloud Office Print server will then fill in default values.

    Args:
        host (str): host name or IP address
        port (int, optional): port to use. Defaults to None.
        user (str, optional): user name. Defaults to None.
        password (str, optional): password for user. Defaults to None.

    Returns:
        FTPToken: created token
    """
    return FTPToken(host, False, port, user, password)
def from_OAuth(service: str, token: str) ‑> OAuthToken

Create a token from an OAuth string and service name.

Args

service : str
cloud service
token : str
OAuth access token

Returns

OAuthToken
created token
Expand source code 
@staticmethod
def from_OAuth(service: str, token: str) -> 'OAuthToken':
    """Create a token from an OAuth string and service name.

    Args:
        service (str): cloud service
        token (str): OAuth access token

    Returns:
        OAuthToken: created token
    """
    return OAuthToken(service, token)
def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken

Create a token from SFTP info

When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. The Cloud Office Print server will then fill in default values.

Args

host : str
host name or IP address
port : int, optional
port to use. Defaults to None.
user : str, optional
user name. Defaults to None.
password : str, optional
password for user. Defaults to None.

Returns

FTPToken
created token This is an FTPToken object, with sftp=True passed into the constructor. The only difference with FTP is CloudAccessToken.servicename.
Expand source code 
@staticmethod
def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
    """Create a token from SFTP info

    When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
    The Cloud Office Print server will then fill in default values.

    Args:
        host (str): host name or IP address
        port (int, optional): port to use. Defaults to None.
        user (str, optional): user name. Defaults to None.
        password (str, optional): password for user. Defaults to None.

    Returns:
        FTPToken: created token
                  This is an FTPToken object, with sftp=True passed into the constructor.
                  The only difference with FTP is CloudAccessToken.servicename.
    """
    return FTPToken(host, True, port, user, password)
def is_valid_service(value: str) ‑> bool

Check if the given value is a valid service string.

Args

value : str
the service to check

Returns

bool
whether value is valid
Expand source code 
@staticmethod
def is_valid_service(value: str) -> bool:
    """Check if the given value is a valid service string.

    Args:
        value (str): the service to check

    Returns:
        bool: whether value is valid
    """
    return value in SERVICES
def list_available_services() ‑> List[str]

List all available services.

Returns

List[str]
list of available service strings
Expand source code 
@staticmethod
def list_available_services() -> List[str]:
    """List all available services.

    Returns:
        List[str]: list of available service strings
    """
    return SERVICES

Instance variables

var as_dict : Dict

The cloud access token as a dict, for building the JSON.

Returns

Dict
dict representation for this cloud access token
Expand source code 
@property
@abstractmethod
def as_dict(self) -> Dict:
    """The cloud access token as a dict, for building the JSON.

    Returns:
        Dict: dict representation for this cloud access token
    """
    return {
        "output_location": self.service
    }
var json : str

The cloud access token as JSON.

Returns

str
JSON representation for this cloud access token
Expand source code 
@property
def json(self) -> str:
    """The cloud access token as JSON.

    Returns:
        str: JSON representation for this cloud access token
    """
    return json.dumps(self.as_dict)
var service : str

Returns which cloud service is being used.

Returns

str
which cloud service is being used
Expand source code 
@property
def service(self) -> str:
    """Returns which cloud service is being used.

    Returns:
        str: which cloud service is being used
    """
    return self._service
class FTPToken (host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None)

CloudAccessToken to be used for FTP/SFTP tokens

Args

host : str
Host name or IP address of the FTP/SFTP server.
sftp : bool, optional
whether to use SFTP (else FTP). Defaults to False.
port : int, optional
Port number of the FTP/SFTP server. Defaults to None.
user : str, optional
User name for the FTP/SFTP server. Defaults to None.
password : str, optional
Password for the user. Defaults to None.
Expand source code 
class FTPToken(CloudAccessToken):
    """`CloudAccessToken` to be used for FTP/SFTP tokens"""

    def __init__(self, host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None):
        """
        Args:
            host (str): Host name or IP address of the FTP/SFTP server.
            sftp (bool, optional): whether to use SFTP (else FTP). Defaults to False.
            port (int, optional): Port number of the FTP/SFTP server. Defaults to None.
            user (str, optional): User name for the FTP/SFTP server. Defaults to None.
            password (str, optional): Password for the user. Defaults to None.
        """
        super().__init__("sftp" if sftp else "ftp")
        self.host: str = host
        self.port: int = port
        self.user: str = user
        self.password: str = password

    @property
    def as_dict(self) -> Dict:
        cloud_access_token = {
            "host": self.host
        }
        if self.port is not None:
            cloud_access_token["port"] = self.port
        if self.user is not None:
            cloud_access_token["user"] = self.user
        if self.password is not None:
            cloud_access_token["password"] = self.password

        result = super().as_dict
        result.update({
            "cloud_access_token": cloud_access_token
        })

        return result

Ancestors

Inherited members

class OAuthToken (service: str, token: str)

CloudAccessToken to be used for OAuth tokens

Args

service : str
CloudAccessToken.service
token : str
OAuth token
Expand source code 
class OAuthToken(CloudAccessToken):
    """`CloudAccessToken` to be used for OAuth tokens"""

    def __init__(self, service: str, token: str):
        """
        Args:
            service (str): `CloudAccessToken.service`
            token (str): OAuth token
        """
        super().__init__(service)
        self.token: str = token

    @property
    def as_dict(self) -> Dict:
        result = super().as_dict
        result.update({
            "cloud_access_token": self.token
        })
        return result

Ancestors

Inherited members