cleanup

Author: rolzwy7

README.md

@@ -32,7 +32,9 @@
   <a href='#travis'>
     <img src='https://img.shields.io/travis/com/rolzwy7/RegonAPI.svg' alt='Build status' />
   </a>
-
+  <a href='#pypi_downloads'>
+    <img src='https://img.shields.io/pypi/dm/RegonAPI' alt='PyPi downloads' />
+  </a>
 </p>
 
 <p align="center">

RegonAPI/consts/__init__.py

@@ -1,8 +1,7 @@
 from RegonAPI.consts.voivodeships import VOIVODESHIPS
 from RegonAPI.consts.api_codes import API_CODES
 
-from RegonAPI.consts.bir_version_maps import BIR_SETTINGS
-from RegonAPI.consts.bir_version_maps import BIR_VERSIONS
-from RegonAPI.consts.bir_version_maps import OPERATIONS
-from RegonAPI.consts.bir_version_maps import DANE_POBIERZ_PELNY_RAPORT_REPORT_NAMES
-from RegonAPI.consts.bir_version_maps import REPORTS
+from RegonAPI.consts.bir_version_maps import *
+
+from RegonAPI.consts.dev_environment import API_KEY_TEST_ENV
+from RegonAPI.consts.dev_environment import WARNINGS as DEV_ENV_WARNINGS

RegonAPI/consts/bir_version_maps.py

@@ -6,7 +6,7 @@
         },
         "PROD": {
             "SERVICE_URL": "https://wyszukiwarkaregon.stat.gov.pl/wsBIR/UslugaBIRzewnPubl.svc",
-            # Yes, it's the same WSDL address for test and production.
+            # Yes, it's the same WSDL address for test and production in version 1.0
             "WSDL": "https://wyszukiwarkaregontest.stat.gov.pl/wsBIR/wsdl/UslugaBIRzewnPubl.xsd"
         }
     },
@@ -17,6 +17,7 @@
         },
         "PROD": {
             "SERVICE_URL": "https://wyszukiwarkaregon.stat.gov.pl/wsBIR/UslugaBIRzewnPubl.svc",
+            # Sneaky correction in version 1.1
             "WSDL": "https://wyszukiwarkaregon.stat.gov.pl/wsBIR/wsdl/UslugaBIRzewnPubl-ver11-prod.wsdl"
         }
     }

RegonAPI/consts/dev_environment.py

@@ -0,0 +1,24 @@
+# Test API key
+API_KEY_TEST_ENV = "abcde12345abcde12345"
+
+# Warnings
+WARNINGS = {
+    "WARN_IS_NOT_PRODUCTION": {
+        "eng": """
+        \n\r\tYou are using TEST environment.
+        \r\tSet `is_production=True` while constructing
+        \r\t`RegonAPI` instance to switch to production environment.
+
+        \r\tUsing test API key: '{API_KEY_TEST_ENV}'
+        \r\tKey provided to `authenticate` method will be overridden.\n
+        """.format(API_KEY_TEST_ENV=API_KEY_TEST_ENV),
+        "pl": """
+        \n\r\tUżywasz środowiska TESTOWEGO.
+        \r\tUstaw `is_production=True` podczas konstrukcji
+        \r\tinstancji klasy `RegonAPI` aby przejść do środowiska produkcyjnego.
+
+        \r\tUżywany jest klucz testowy: '{API_KEY_TEST_ENV}'
+        \r\tKlucz przekazany do metody `authenticate` zostanie nadpisany.\n
+        """.format(API_KEY_TEST_ENV=API_KEY_TEST_ENV),
+    }
+}

RegonAPI/exceptions.py

@@ -0,0 +1,2 @@
+from RegonAPI.exceptions.api import *
+from RegonAPI.exceptions.converters import *

RegonAPI/exceptions/__init__.py

@@ -0,0 +1,32 @@
+class ApiError(BaseException):
+    def __str__(self):
+        return repr(self.data)
+
+
+class ApiAuthenticationError(ApiError):
+
+    def __init__(self, data):
+        self.data = 'Authentication failed with key: "{data}"'.format(
+            data=data)
+
+
+class ApiCodeTranslationError(ApiError):
+
+    def __init__(self, data):
+        self.data = 'Can\'t translate: {data}'.format(
+            data=data)
+
+
+class ApiUnknownReportNameError(ApiError):
+
+    def __init__(self, data):
+        self.data = 'Invailid report name: {data}'.format(
+            data=data)
+
+
+class ApiInvalidBIRVersionProvided(ApiError):  # TODO: test case
+
+    def __init__(self, data, choices):
+        self.data = 'Invailid BIR version: {data} not in {choices}'.format(
+            data=data, choices=choices
+        )

RegonAPI/exceptions/api.py

@@ -0,0 +1,26 @@
+class ConvertionTypeError(BaseException):
+
+    def __init__(self, data, what=''):
+        self.data = 'Can\'t convert {what}: {data}'.format(
+            data=data, what=what)
+
+    def __str__(self):
+        return repr(self.data)
+
+
+class ConvertionLengthError(BaseException):
+
+    def __init__(self, data, what=''):
+        self.data = 'Invalid {what} length: {data}'.format(
+            data=data, what=what)
+
+    def __str__(self):
+        return repr(self.data)
+
+
+class RegonConvertionError(ConvertionTypeError):
+
+    def __init__(self, data):
+        super(RegonConvertionError, self).__init__(
+            data=data, what='regon'
+        )

RegonAPI/exceptions/converters.py

@@ -2,42 +2,41 @@
     RegonAPI main client class
 """
 
+# try:
+#     # from urllib.parse import urlparse
+# except ImportError:
+#     print('')
+#     quit()
+
 import logging
 
 from requests import Session
 from zeep.transports import Transport
 from zeep import Client
 
 from RegonAPI.api_codes import t
-from RegonAPI.exceptions import ApiInvalidBIRVersionProvided
-from RegonAPI.exceptions import ApiAuthenticationError
+from RegonAPI.exceptions import (
+    ApiInvalidBIRVersionProvided,
+    ApiAuthenticationError
+)
 from RegonAPI.operations import RegonAPIOperations
-from RegonAPI.settings import logging_level
-from RegonAPI.settings import logging_file_handler_level
-from RegonAPI.settings import logging_stream_handler_level
-from RegonAPI.settings import BIR_VERSIONS
-from RegonAPI.settings import BIR_SETTINGS
-from RegonAPI.settings import REPORTS
+from RegonAPI.settings import (
+    lang,
+    BIR_VERSIONS,
+    BIR_SETTINGS,
+    REPORTS,
+    DEV_ENV_WARNINGS,
+    API_KEY_TEST_ENV,
+    LOGGING_FORMAT
+)
 
 # logger configuration
+ROOT_LOGGING_LEVEL = logging.ERROR
+LOCAL_LOGGING_LEVEL = logging.WARNING
+logging.basicConfig(format=LOGGING_FORMAT)
+logging.root.setLevel(ROOT_LOGGING_LEVEL)
 logger = logging.getLogger(__name__)
-logger.setLevel(logging_level)
-
-# fh = logging.FileHandler('debug.log')
-# fh.setLevel(logging_file_handler_level)
-
-sh = logging.StreamHandler()
-sh.setLevel(logging_stream_handler_level)
-
-formatter = logging.Formatter(
-    '[%(levelname)s][%(asctime)s] %(name)s %(funcName)s - %(message)s')
-# fh.setFormatter(formatter)
-sh.setFormatter(formatter)
-
-# logger.addHandler(fh)
-logger.addHandler(sh)
-# logger configuration End
-
+logger.setLevel(LOCAL_LOGGING_LEVEL)
 
 # TODO: New class desc
 class RegonAPI(RegonAPIOperations):
@@ -70,7 +69,7 @@ class RegonAPI(RegonAPIOperations):
 
     def __init__(
         self,
-        bir_version="bir1",
+        bir_version="bir1.1",
         is_production=False,
         service_namespace='{http://tempuri.org/}e3'
     ):
@@ -84,6 +83,9 @@ def __init__(
 
         # Set API environment
         api_env = "PROD" if is_production else "TEST"
+        if not is_production:
+            logger.warning(DEV_ENV_WARNINGS["WARN_IS_NOT_PRODUCTION"][lang])
+
 
         # Set WSDL & SERVICE_URL based on BIR version
         self.wsdl = BIR_SETTINGS[bir_version][api_env]["WSDL"]
@@ -95,6 +97,7 @@ def __init__(
         self.service = None
         self.key = None
         self.sid = None
+        self.is_production = is_production
         self.service_namespace = service_namespace
         self._create_service()
 
@@ -127,6 +130,9 @@ def authenticate(self, key, verify=True):
         ApiAuthenticationError
             If authentication was a failure
         """
+        if not self.is_production:
+            key = API_KEY_TEST_ENV
+
         logger.debug('key=%s verify=%s' % (key, verify))
         sid = self.service.Zaloguj(key)
         session = Session()
@@ -138,7 +144,7 @@ def authenticate(self, key, verify=True):
         self._create_service()
         if verify:
             if not self._check_session():
-                logger.warning('Authentication failed')
+                logger.error('Authentication failed')
                 raise ApiAuthenticationError(key)
             else:
                 logger.debug('Authenticated successfully')
@@ -229,6 +235,7 @@ def _create_service(self):
         self.service = self.client.create_service(
             self.service_namespace, self.service_url)
 
+
     def _check_session(self):
         """Checks Regon API for confirmation of successfull authentication
 

RegonAPI/plugins/__init__.py

@@ -0,0 +1 @@
+from RegonAPI.settings.settings import *

RegonAPI/plugins/detailed.py

@@ -0,0 +1,12 @@
+import os
+import logging
+
+from RegonAPI.consts import *
+
+# Language - settings
+lang = 'eng'
+
+# Logger - settings
+available_languages = ["pl", "eng"]
+
+LOGGING_FORMAT = "\r%(asctime)s, %(levelname)-8s [`%(funcName)s` %(filename)s:%(lineno)d] %(message)s"

RegonAPI/plugins/fetch_all.py

@@ -0,0 +1,7 @@
+from RegonAPI import RegonAPI
+
+api = RegonAPI(bir_version="bir1.1", is_production=False)
+try:
+    api.authenticate(key="")
+except Exception as e:
+    raise