Merge pull request #40 from mmarquezs/develop

Version 1.0.7 that adds new exceptions. Thanks to @oribafi

Author: mmarquezs

myjdapi/__init__.py

@@ -1,2 +1,37 @@
-from .myjdapi import Myjdapi
-__version__ = '1.0.6'
+from .myjdapi import Myjdapi
+from .exception import (
+    MYJDException,
+    MYJDConnectionException,
+    MYJDDeviceNotFoundException,
+    MYJDDecodeException,
+    MYJDApiException,
+    MYJDApiCommandNotFoundException,
+    MYJDApiInterfaceNotFoundException,
+    MYJDAuthFailedException,
+    MYJDBadParametersException,
+    MYJDBadRequestException,
+    MYJDChallengeFailedException,
+    MYJDEmailForbiddenException,
+    MYJDEmailInvalidException,
+    MYJDErrorEmailNotConfirmedException,
+    MYJDFailedException,
+    MYJDFileNotFoundException,
+    MYJDInternalServerErrorException,
+    MYJDMaintenanceException,
+    MYJDMethodForbiddenException,
+    MYJDOfflineException,
+    MYJDOutdatedException,
+    MYJDOverloadException,
+    MYJDSessionException,
+    MYJDStorageAlreadyExistsException,
+    MYJDStorageInvalidKeyException,
+    MYJDStorageInvalidStorageIdException,
+    MYJDStorageKeyNotFoundException,
+    MYJDStorageLimitReachedException,
+    MYJDStorageNotFoundException,
+    MYJDTokenInvalidException,
+    MYJDTooManyRequestsException,
+    MYJDUnknownException,
+)
+
+__version__ = "1.0.7"

myjdapi/const.py

@@ -0,0 +1,36 @@
+"""Constants of the MyJDownloader API."""
+
+# API Documentation: https://my.jdownloader.org/developers
+
+# MyJdownloader exception source
+EXCEPTION_MYJD = "MYJD"
+EXCEPTION_DEVICE = "DEVICE"
+
+# MyJdownloader exception type
+EXCEPTION_API_COMMAND_NOT_FOUND = "API_COMMAND_NOT_FOUND"
+EXCEPTION_API_INTERFACE_NOT_FOUND = "API_INTERFACE_NOT_FOUND"
+EXCEPTION_AUTH_FAILED = "AUTH_FAILED"
+EXCEPTION_BAD_PARAMETERS = "BAD_PARAMETERS"
+EXCEPTION_BAD_REQUEST = "BAD_REQUEST"
+EXCEPTION_CHALLENGE_FAILED = "CHALLENGE_FAILED"
+EXCEPTION_EMAIL_FORBIDDEN = "EMAIL_FORBIDDEN"
+EXCEPTION_EMAIL_INVALID = "EMAIL_INVALID"
+EXCEPTION_ERROR_EMAIL_NOT_CONFIRMED = "ERROR_EMAIL_NOT_CONFIRMED"
+EXCEPTION_FAILED = "FAILED"
+EXCEPTION_FILE_NOT_FOUND = "FILE_NOT_FOUND"
+EXCEPTION_INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
+EXCEPTION_MAINTENANCE = "MAINTENANCE"
+EXCEPTION_METHOD_FORBIDDEN = "METHOD_FORBIDDEN"
+EXCEPTION_OFFLINE = "OFFLINE"
+EXCEPTION_OUTDATED = "OUTDATED"
+EXCEPTION_OVERLOAD = "OVERLOAD"
+EXCEPTION_SESSION = "SESSION"
+EXCEPTION_STORAGE_ALREADY_EXISTS = "STORAGE_ALREADY_EXISTS"
+EXCEPTION_STORAGE_INVALID_KEY = "STORAGE_INVALID_KEY"
+EXCEPTION_STORAGE_INVALID_STORAGEID = "STORAGE_INVALID_STORAGEID"
+EXCEPTION_STORAGE_KEY_NOT_FOUND = "STORAGE_KEY_NOT_FOUND"
+EXCEPTION_STORAGE_LIMIT_REACHED = "STORAGE_LIMIT_REACHED"
+EXCEPTION_STORAGE_NOT_FOUND = "STORAGE_NOT_FOUND"
+EXCEPTION_TOKEN_INVALID = "TOKEN_INVALID"
+EXCEPTION_TOO_MANY_REQUESTS = "TOO_MANY_REQUESTS"
+EXCEPTION_UNKNOWN = "UNKNOWN"

myjdapi/exception.py

@@ -0,0 +1,266 @@
+"""Exceptions of the MyJDownloader API."""
+
+from .const import (
+    EXCEPTION_API_COMMAND_NOT_FOUND,
+    EXCEPTION_API_INTERFACE_NOT_FOUND,
+    EXCEPTION_AUTH_FAILED,
+    EXCEPTION_BAD_PARAMETERS,
+    EXCEPTION_BAD_REQUEST,
+    EXCEPTION_CHALLENGE_FAILED,
+    EXCEPTION_EMAIL_FORBIDDEN,
+    EXCEPTION_EMAIL_INVALID,
+    EXCEPTION_ERROR_EMAIL_NOT_CONFIRMED,
+    EXCEPTION_FAILED,
+    EXCEPTION_FILE_NOT_FOUND,
+    EXCEPTION_INTERNAL_SERVER_ERROR,
+    EXCEPTION_MAINTENANCE,
+    EXCEPTION_METHOD_FORBIDDEN,
+    EXCEPTION_OFFLINE,
+    EXCEPTION_OUTDATED,
+    EXCEPTION_OVERLOAD,
+    EXCEPTION_SESSION,
+    EXCEPTION_STORAGE_ALREADY_EXISTS,
+    EXCEPTION_STORAGE_INVALID_KEY,
+    EXCEPTION_STORAGE_INVALID_STORAGEID,
+    EXCEPTION_STORAGE_KEY_NOT_FOUND,
+    EXCEPTION_STORAGE_LIMIT_REACHED,
+    EXCEPTION_STORAGE_NOT_FOUND,
+    EXCEPTION_TOKEN_INVALID,
+    EXCEPTION_TOO_MANY_REQUESTS,
+    EXCEPTION_UNKNOWN,
+)
+
+
+class MYJDException(BaseException):
+    """Base MyJDownloader Exception."""
+
+    pass
+
+
+class MYJDConnectionException(MYJDException):
+    """Connection Exception."""
+
+    pass
+
+
+class MYJDDeviceNotFoundException(MYJDException):
+    """Device not found Exception."""
+
+    pass
+
+
+class MYJDDecodeException(MYJDException):
+    """Decode Exception."""
+
+    pass
+
+
+class MYJDApiException(MYJDException):
+    """Base MyJDownloader API Exception."""
+
+    @classmethod
+    def get_exception(
+        cls, exception_source, exception_type=EXCEPTION_UNKNOWN, *args, **kwargs
+    ):
+        """Get exception object from MyJDownloader exception type."""
+        return EXCEPTION_CLASSES.get(exception_type.upper(), MYJDUnknownException)(
+            exception_source, *args, **kwargs
+        )
+
+    def __init__(self, exception_source, *args, **kwargs):
+        """Initialize MyJDownloader API exception."""
+        self.source = exception_source.upper()
+        super(MYJDApiException, self).__init__(*args, **kwargs)
+
+
+class MYJDApiCommandNotFoundException(MYJDApiException):
+    """MyJDownloader command not found API Exception."""
+
+    pass
+
+
+class MYJDApiInterfaceNotFoundException(MYJDApiException):
+    """MyJDownloader interface not found API Exception."""
+
+    pass
+
+
+class MYJDAuthFailedException(MYJDApiException):
+    """MyJDownloader auth failed API Exception."""
+
+    pass
+
+
+class MYJDBadParametersException(MYJDApiException):
+    """MyJDownloader bad parameters API Exception."""
+
+    pass
+
+
+class MYJDBadRequestException(MYJDApiException):
+    """MyJDownloader bad request API Exception."""
+
+    pass
+
+
+class MYJDChallengeFailedException(MYJDApiException):
+    """MyJDownloader challenge failed API Exception."""
+
+    pass
+
+
+class MYJDEmailForbiddenException(MYJDApiException):
+    """MyJDownloader email forbidden API Exception."""
+
+    pass
+
+
+class MYJDEmailInvalidException(MYJDApiException):
+    """MyJDownloader email invalid API Exception."""
+
+    pass
+
+
+class MYJDErrorEmailNotConfirmedException(MYJDApiException):
+    """MyJDownloader email not confirmed API Exception."""
+
+    pass
+
+
+class MYJDFailedException(MYJDApiException):
+    """MyJDownloader failed API Exception."""
+
+    pass
+
+
+class MYJDFileNotFoundException(MYJDApiException):
+    """MyJDownloader file not found API Exception."""
+
+    pass
+
+
+class MYJDInternalServerErrorException(MYJDApiException):
+    """MyJDownloader internal server error API Exception."""
+
+    pass
+
+
+class MYJDMaintenanceException(MYJDApiException):
+    """MyJDownloader maintenance API Exception."""
+
+    pass
+
+
+class MYJDMethodForbiddenException(MYJDApiException):
+    """MyJDownloader method forbidden API Exception."""
+
+    pass
+
+
+class MYJDOfflineException(MYJDApiException):
+    """MyJDownloader offline API Exception."""
+
+    pass
+
+
+class MYJDOutdatedException(MYJDApiException):
+    """MyJDownloader outdated API Exception."""
+
+    pass
+
+
+class MYJDOverloadException(MYJDApiException):
+    """MyJDownloader overload API Exception."""
+
+    pass
+
+
+class MYJDSessionException(MYJDApiException):
+    """MyJDownloader session API Exception."""
+
+    pass
+
+
+class MYJDStorageAlreadyExistsException(MYJDApiException):
+    """MyJDownloader storage already exists API Exception."""
+
+    pass
+
+
+class MYJDStorageInvalidKeyException(MYJDApiException):
+    """MyJDownloader storage invalid key API Exception."""
+
+    pass
+
+
+class MYJDStorageInvalidStorageIdException(MYJDApiException):
+    """MyJDownloader storage invalid storage id API Exception."""
+
+    pass
+
+
+class MYJDStorageKeyNotFoundException(MYJDApiException):
+    """MyJDownloader storage key not found API Exception."""
+
+    pass
+
+
+class MYJDStorageLimitReachedException(MYJDApiException):
+    """MyJDownloader storage limit reached API Exception."""
+
+    pass
+
+
+class MYJDStorageNotFoundException(MYJDApiException):
+    """MyJDownloader storage not found API Exception."""
+
+    pass
+
+
+class MYJDTokenInvalidException(MYJDApiException):
+    """MyJDownloader token invalid API Exception."""
+
+    pass
+
+
+class MYJDTooManyRequestsException(MYJDApiException):
+    """MyJDownloader too many request API Exception."""
+
+    pass
+
+
+class MYJDUnknownException(MYJDApiException):
+    """MyJDownloader unknown API Exception."""
+
+    pass
+
+
+EXCEPTION_CLASSES = {
+    EXCEPTION_API_COMMAND_NOT_FOUND: MYJDApiCommandNotFoundException,
+    EXCEPTION_API_INTERFACE_NOT_FOUND: MYJDApiInterfaceNotFoundException,
+    EXCEPTION_AUTH_FAILED: MYJDAuthFailedException,
+    EXCEPTION_BAD_PARAMETERS: MYJDBadParametersException,
+    EXCEPTION_BAD_REQUEST: MYJDBadRequestException,
+    EXCEPTION_CHALLENGE_FAILED: MYJDChallengeFailedException,
+    EXCEPTION_EMAIL_FORBIDDEN: MYJDEmailForbiddenException,
+    EXCEPTION_EMAIL_INVALID: MYJDEmailInvalidException,
+    EXCEPTION_ERROR_EMAIL_NOT_CONFIRMED: MYJDErrorEmailNotConfirmedException,
+    EXCEPTION_FAILED: MYJDFailedException,
+    EXCEPTION_FILE_NOT_FOUND: MYJDFileNotFoundException,
+    EXCEPTION_INTERNAL_SERVER_ERROR: MYJDInternalServerErrorException,
+    EXCEPTION_MAINTENANCE: MYJDMaintenanceException,
+    EXCEPTION_METHOD_FORBIDDEN: MYJDMethodForbiddenException,
+    EXCEPTION_OFFLINE: MYJDOfflineException,
+    EXCEPTION_OUTDATED: MYJDOutdatedException,
+    EXCEPTION_OVERLOAD: MYJDOverloadException,
+    EXCEPTION_SESSION: MYJDSessionException,
+    EXCEPTION_STORAGE_ALREADY_EXISTS: MYJDStorageAlreadyExistsException,
+    EXCEPTION_STORAGE_INVALID_KEY: MYJDStorageInvalidKeyException,
+    EXCEPTION_STORAGE_INVALID_STORAGEID: MYJDStorageInvalidStorageIdException,
+    EXCEPTION_STORAGE_KEY_NOT_FOUND: MYJDStorageKeyNotFoundException,
+    EXCEPTION_STORAGE_LIMIT_REACHED: MYJDStorageLimitReachedException,
+    EXCEPTION_STORAGE_NOT_FOUND: MYJDStorageNotFoundException,
+    EXCEPTION_TOKEN_INVALID: MYJDTokenInvalidException,
+    EXCEPTION_TOO_MANY_REQUESTS: MYJDTooManyRequestsException,
+    EXCEPTION_UNKNOWN: MYJDUnknownException,
+}