dotstat_io 1.0.0__tar.gz → 1.0.2__tar.gz

{dotstat_io-1.0.0 → dotstat_io-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dotstat_io
-Version: 1.0.0
+Version: 1.0.2
 Summary: Utility to download or upload data from/to .Stat Suite using ADFS authentication to connect to it
 License: MIT
 Author: Gyorgy Gyomai

{dotstat_io-1.0.0 → dotstat_io-1.0.2}/dotstat_io/authentication.py

@@ -18,10 +18,6 @@ class AuthenticationMode(IntEnum):
 # super class to manage authentication
 class Authentication(ABC):
 
-    # protected constants
-    _ERROR_OCCURRED = "An error occurred: "
-    _SUCCESS = "Successful authentication"
-
     # protected variables
     _access_token = None
     _refresh_token = None
@@ -96,6 +92,10 @@ class Authentication(ABC):
 
 # sub class to manage ADFS authentication using OIDC flows
 class AdfsAuthentication(Authentication):
+    # private constants
+    __ERROR_OCCURRED = "An error occurred: "
+    __SUCCESSFUL_AUTHENTICATION = "Successful authentication"
+
     # 
     def _initialize_token(self):
         self._access_token = None
@@ -193,20 +193,20 @@ class AdfsAuthentication(Authentication):
                     self._refresh_token = response_interactive.get("refresh_token")
                     self._creation_time = time.time()
                     self._expiration_time = time.time() + int(response_interactive.get("expires_in")) -  60 # one minute margin
-                    self.init_status = self._SUCCESS
+                    self.init_status = self.__SUCCESSFUL_AUTHENTICATION
                 else:
-                    self.init_status = f'{self._ERROR_OCCURRED}{response_interactive.get("error")} Error description: {response_interactive.get("error_description")}'
+                    self.init_status = f'{self.__ERROR_OCCURRED}{response_interactive.get("error")} Error description: {response_interactive.get("error_description")}'
             else:
                 if "access_token" in response_silent:
                     self._access_token = response_silent.get("access_token")
                     self._refresh_token = response_silent.get("refresh_token")
                     self._creation_time = time.time()
                     self._expiration_time = time.time() + int(response_silent.get("expires_in")) -  60 # one minute margin
-                    self.init_status = self._SUCCESS
+                    self.init_status = self.__SUCCESSFUL_AUTHENTICATION
                 else:
-                    self.init_status = f'{self._ERROR_OCCURRED}{response_silent.get("error")} Error description: {response_silent.get("error_description")}'
+                    self.init_status = f'{self.__ERROR_OCCURRED}{response_silent.get("error")} Error description: {response_silent.get("error_description")}'
         except Exception as err:
-            self.init_status = f'{self._ERROR_OCCURRED}{err}\n'
+            self.init_status = f'{self.__ERROR_OCCURRED}{err}\n'
 
     # Authentication non-interactively using any account - aka Client Credentials flow
     def __acquire_token_noninteractive_with_secret(self):
@@ -216,12 +216,12 @@ class AdfsAuthentication(Authentication):
                 self._access_token = response.get("access_token")
                 self._creation_time = time.time()
                 self._expiration_time = time.time() + int(response.get("expires_in")) -  60 # one minute margin
-                self.init_status = self._SUCCESS
+                self.init_status = self.__SUCCESSFUL_AUTHENTICATION
             else:
-                self.init_status = f'{self._ERROR_OCCURRED}{response.get("error")} Error description: {response.get("error_description")}'
+                self.init_status = f'{self.__ERROR_OCCURRED}{response.get("error")} Error description: {response.get("error_description")}'
 
         except Exception as err:
-            self.init_status = f'{self._ERROR_OCCURRED}{err}\n'
+            self.init_status = f'{self.__ERROR_OCCURRED}{err}\n'
 
     # Authentication non-interactively using service account - aka Windows Client Authentication
     def __acquire_token_noninteractive_with_adfs(self):
@@ -250,26 +250,35 @@ class AdfsAuthentication(Authentication):
                     self._access_token = results_json['access_token']
                     self._creation_time = time.time()
                     self._expiration_time = time.time() + int(results_json['expires_in']) -  60 # one minute margin
-                    self.init_status = self._SUCCESS
+                    self.init_status = self.__SUCCESSFUL_AUTHENTICATION
                 else:
-                    message = f'{self._ERROR_OCCURRED} Error code: {response.status_code}'
+                    message = f'{self.__ERROR_OCCURRED} Error code: {response.status_code}'
                     if len(str(response.reason)) > 0:
                         message += os.linesep + 'Reason: ' + str(response.reason) + os.linesep
                     if len(response.text) > 0:
-                        message += f'{self._ERROR_OCCURRED}{results_json.get("error")} Error description: {results_json.get("error_description")}\n'
+                        message += f'{self.__ERROR_OCCURRED}{results_json.get("error")} Error description: {results_json.get("error_description")}\n'
                         
                     self.init_status = message
             except ValueError as err:
-                if len(response.text) > 0:
-                    self.init_status = self._ERROR_OCCURRED + os.linesep + str(response.text)
-                else:
-                    self.init_status = self._ERROR_OCCURRED + os.linesep + str(err)
+               self.init_status = self.__ERROR_OCCURRED + os.linesep
+               if len(str(response.status_code)) > 0:
+                  self.init_status += 'Error code: ' + str(response.status_code) + os.linesep
+               if len(str(response.reason)) > 0:
+                  self.init_status += 'Reason: ' + str(response.reason) + os.linesep
+               if len(response.text) > 0:
+                  self.init_status += str(response.text)
+               else:
+                  self.init_status += str(err)
         except Exception as err:
-            self.init_status = f'{self._ERROR_OCCURRED} {err}\n'
+            self.init_status = f'{self.__ERROR_OCCURRED} {err}\n'
 
 
 # sub class to manage Keycloak authentication
-class KeycloakAuthentication(Authentication):    
+class KeycloakAuthentication(Authentication):
+    # private constants
+    __ERROR_OCCURRED = "An error occurred: "
+    __SUCCESSFUL_AUTHENTICATION = "Successful authentication"
+ 
     #
     def _initialize_token(self):
         self._access_token = None
@@ -320,7 +329,7 @@ class KeycloakAuthentication(Authentication):
 
             response = requests.post(self._token_url, proxies=self._proxies, headers=headers, data=payload)
             if response.status_code not in {200, 201}:
-                self.init_status = f'{self._ERROR_OCCURRED}{response}'
+                self.init_status = f'{self.__ERROR_OCCURRED}{response}'
             else:
                 # If the response object cannot be converted to json, return an error
                 results_json = None
@@ -330,11 +339,16 @@ class KeycloakAuthentication(Authentication):
                     self._refresh_token = results_json['refresh_token']
                     self._creation_time = time.time()
                     self._expiration_time = time.time() + int(results_json['expires_in']) -  60 # one minute margin
-                    self.init_status = self._SUCCESS
+                    self.init_status = self.__SUCCESSFUL_AUTHENTICATION
                 except ValueError as err:
-                    if len(response.text) > 0:
-                        self.init_status = self._ERROR_OCCURRED + os.linesep + str(response.text)
-                    else:
-                        self.init_status = self._ERROR_OCCURRED + os.linesep + str(err)
+                  self.init_status = self.__ERROR_OCCURRED + os.linesep
+                  if len(str(response.status_code)) > 0:
+                     self.init_status += 'Error code: ' + str(response.status_code) + os.linesep
+                  if len(str(response.reason)) > 0:
+                     self.init_status += 'Reason: ' + str(response.reason) + os.linesep
+                  if len(response.text) > 0:
+                     self.init_status += str(response.text)
+                  else:
+                     self.init_status += str(err)
         except Exception as err:
-            self.init_status = f'{self._ERROR_OCCURRED}{err}\n'
+            self.init_status = f'{self.__ERROR_OCCURRED}{err}\n'

{dotstat_io-1.0.0 → dotstat_io-1.0.2}/dotstat_io/client.py

@@ -97,10 +97,15 @@ class Client():
                     self.__log.info('   ' + line)
         else:
             if response.status_code != 200:
-                returned_result = self.__ERROR_OCCURRED  + 'Error code: ' + \
-                    str(response.status_code) + ' Reason: ' + str(response.reason)
+                returned_result = self.__ERROR_OCCURRED
+                if len(str(response.status_code)) > 0:
+                    returned_result += 'Error code: ' + str(response.status_code) + os.linesep
+                if len(str(response.reason)) > 0:
+                    returned_result += 'Reason: ' + str(response.reason) + os.linesep
                 if len(response.text) > 0:
-                    returned_result += os.linesep + 'Text: ' + response.text
+                    returned_result += 'Text: ' + response.text
+
+                returned_result += os.linesep
             else:
                 if os.path.isfile(file_path):
                     os.remove(file_path)
@@ -237,22 +242,31 @@ class Client():
 
                         returned_result = returned_result + result + os.linesep
                 else:
-                    returned_result = self.__ERROR_OCCURRED  + 'Error code: ' + str(response.status_code) + os.linesep
+                    returned_result = self.__ERROR_OCCURRED
+                    if len(str(response.status_code)) > 0:
+                        returned_result += 'Error code: ' + str(response.status_code) + os.linesep
                     if len(str(response.reason)) > 0:
                         returned_result += 'Reason: ' + str(response.reason) + os.linesep
                     if len(response.text) > 0:
-                        returned_result = returned_result + os.linesep + 'Text: ' + response.text
+                        returned_result += 'Text: ' + response.text
 
-                    returned_result = returned_result + os.linesep
+                    returned_result += os.linesep
                     # Write the result to the log
                     for line in returned_result.split(os.linesep):
                         if len(line) > 0:
                             self.__log.info('   ' + line)
             except ValueError as err:
+                returned_result = self.__ERROR_OCCURRED
+                if len(str(response.status_code)) > 0:
+                    returned_result += 'Error code: ' + str(response.status_code) + os.linesep
+                if len(str(response.reason)) > 0:
+                    returned_result += 'Reason: ' + str(response.reason) + os.linesep
                 if len(response.text) > 0:
-                    self.init_status = self._ERROR + os.linesep + str(response.text)
+                    returned_result += 'Text: ' + str(response.text)
                 else:
-                    self.init_status = self._ERROR + os.linesep + str(err)
+                    returned_result += str(err)
+
+                returned_result += os.linesep
         finally:
             return returned_result
 
@@ -378,15 +392,27 @@ class Client():
                             returned_result = returned_result + 'Log' + str(index) + ': ' + results_json['logs'][index]['message'] + os.linesep
                             index += 1
                 else:
-                    returned_result = self.__ERROR_OCCURRED  + 'Error code: ' + \
-                        str(response.status_code) + ' Reason: ' + str(response.reason)
+                    returned_result = self.__ERROR_OCCURRED
+                    if len(str(response.status_code)) > 0:
+                        returned_result += 'Error code: ' + str(response.status_code) + os.linesep
+                    if len(str(response.reason)) > 0:
+                        returned_result += 'Reason: ' + str(response.reason) + os.linesep
                     if len(response.text) > 0:
-                        returned_result = returned_result + os.linesep + 'Text: ' + response.text
+                        returned_result += 'Text: ' + str(response.text)
+
+                    returned_result += os.linesep
             except ValueError as err:
+                returned_result = self.__ERROR_OCCURRED
+                if len(str(response.status_code)) > 0:
+                    returned_result += 'Error code: ' + str(response.status_code) + os.linesep
+                if len(str(response.reason)) > 0:
+                    returned_result += 'Reason: ' + str(response.reason) + os.linesep
                 if len(response.text) > 0:
-                    self.init_status = self._ERROR + os.linesep + str(response.text)
+                    returned_result += 'Text: ' + str(response.text)
                 else:
-                    self.init_status = self._ERROR + os.linesep + str(err)
+                    returned_result += str(err)
+
+                returned_result += os.linesep
         finally:
             return returned_result
     

{dotstat_io-1.0.0 → dotstat_io-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dotstat_io"
-version = "1.0.0"
+version = "1.0.2"
 description = "Utility to download or upload data from/to .Stat Suite using ADFS authentication to connect to it"
 license = "MIT"
 authors = ["Gyorgy Gyomai <gyorgy.gyomai@oecd.org>", "Abdel Aliaoui <abdel.aliaoui@oecd.org>"]