Merge branch 'fix/add-exceptions' into 'develop'

Fix/add exceptions

See merge request ProtonVPN/linux/proton-python-client!32

Author: Alexandru Cheltuitor

arch/PKGBUILD

@@ -1,6 +1,6 @@
 # Maintainer: Proton Technologies AG <[email protected]>
 pkgname=python-proton-client
-pkgver=0.4.1
+pkgver=0.5.0
 pkgrel=1
 pkgdesc="Safely login with ProtonVPN credentials to connect to Proton."
 arch=("any")

debian/changelog

@@ -1,4 +1,11 @@
-proton-python-client (0.4.1-1) unstable; urgency=medium
+proton-python-client (0.5.0-1) unstable; urgency=medium
+
+  * Add new exceptions
+  * Throw custom exceptions in case of network errors, abstracting from the package that is being used for requests
+
+ -- Proton Technologies AG <[email protected]>  Fri, 30 Apr 2021 18:15:00 +0100
+ 
+ proton-python-client (0.4.1-1) unstable; urgency=medium
 
   * Add long description to setup.py
 

proton/__init__.py

@@ -1 +1,2 @@
-from .api import Session, ProtonError # noqa
+from .api import Session # noqa
+from .exceptions import ProtonError # noqa

proton/api.py

@@ -1,26 +1,12 @@
 import base64
 import json
-
 import gnupg
 import requests
 
 from .cert_pinning import TLSPinningAdapter
 from .srp import User as PmsrpUser
 from .constants import DEFAULT_TIMEOUT, SRP_MODULUS_KEY, SRP_MODULUS_KEY_FINGERPRINT
-
-
-class ProtonError(Exception):
-    def __init__(self, ret):
-        self.code = ret['Code']
-        self.error = ret['Error']
-        try:
-            self.headers = ret["Headers"]
-        except KeyError:
-            self.headers = ""
-
-        super().__init__("[{}] {} {}".format(
-            self.code, self.error, self.headers
-        ))
+from .exceptions import ProtonError, TLSPinningError, NewConnectionError, UnknownConnectionError
 
 
 class Session:
@@ -106,12 +92,19 @@ def api_request(
         if fct is None:
             raise ValueError("Unknown method: {}".format(method))
 
-        ret = fct(
-            self.__api_url + endpoint,
-            headers=additional_headers,
-            json=jsondata,
-            timeout=self.__timeout
-        )
+        try:
+            ret = fct(
+                self.__api_url + endpoint,
+                headers=additional_headers,
+                json=jsondata,
+                timeout=self.__timeout
+            )
+        except requests.exceptions.ConnectionError as e:
+            raise NewConnectionError(e)
+        except TLSPinningError as e:
+            raise TLSPinningError(e)
+        except (Exception, requests.exceptions.BaseHTTPError) as e:
+            raise UnknownConnectionError(e)
 
         try:
             ret = ret.json()

proton/cert_pinning.py

@@ -2,22 +2,15 @@
 import hashlib
 from ssl import DER_cert_to_PEM_cert
 
-import requests
 from OpenSSL import crypto
 from requests.adapters import HTTPAdapter
 from urllib3.connectionpool import HTTPSConnectionPool
 from urllib3.poolmanager import PoolManager
 from urllib3.util.timeout import Timeout
-
+from .exceptions import TLSPinningError
 from .constants import PUBKEY_HASH_DICT
 
 
-class TLSPinningError(requests.exceptions.SSLError):
-    def __init__(self, strerror):
-        self.strerror = strerror
-        super(TLSPinningError, self).__init__(strerror)
-
-
 class TLSPinningHTTPSConnectionPool(HTTPSConnectionPool):
     """Verify the certificate upon each connection"""
     def __init__(

proton/constants.py

@@ -1,5 +1,5 @@
 
-VERSION = "0.4.1"
+VERSION = "0.5.0"
 DEFAULT_TIMEOUT = (10, 30)
 PUBKEY_HASH_DICT = {
     "api.protonvpn.ch": [

proton/exceptions.py

@@ -0,0 +1,29 @@
+class ProtonError(Exception):
+    def __init__(self, ret):
+        self.code = ret['Code']
+        self.error = ret['Error']
+        try:
+            self.headers = ret["Headers"]
+        except KeyError:
+            self.headers = ""
+
+        super().__init__("{}".format(self.error))
+
+
+class ProtonNetworkError(Exception):
+    def __init__(self, message, additional_context=None):
+        self.message = message
+        self.additional_context = additional_context
+        super().__init__(self.message)
+
+
+class TLSPinningError(ProtonNetworkError):
+    """TLS Pinning exception"""
+
+
+class NewConnectionError(ProtonNetworkError):
+    """Network Error"""
+
+
+class UnknownConnectionError(ProtonNetworkError):
+    """UnknownConnectionError"""

rpmbuild/SPECS/python3-proton-client.spec

@@ -1,5 +1,5 @@
 %define unmangled_name proton-client
-%define version 0.4.1
+%define version 0.5.0
 %define release 1
 
 Prefix: %{_prefix}
@@ -48,6 +48,10 @@ rm -rf $RPM_BUILD_ROOT
 %defattr(-,root,root)
 
 %changelog
+* Wed Apr 21 2021 Proton Technologies AG <[email protected]> 0.5.0-1
+- Add new exceptions
+- Throw custom exceptions in case of network errors, abstracting from the package that is being used for requests
+
 * Wed Apr 21 2021 Proton Technologies AG <[email protected]> 0.4.1-1
 - Add long description to setup.py
 

setup.cfg

@@ -1,3 +1,7 @@
+[flake8]
+ignore = C901, W503, E402
+max-line-length = 100
+
 [metadata]
 long_description = file: README.md
 long_description_content_type = text/markdown