Merge branch 'listing-api-fix' into type-hints

Author: JaviCerveraIngram

README.md

@@ -5,7 +5,7 @@
 ---
 Connect Python SDK allows an easy and fast integration with Connect fulfillment API. Thanks to it you can automate the fulfillment of orders generated by your products.
 
-In order to use this library, please ensure that you have read first the documentation available on Connect knowledge base article located here, this one will provide you a great information on the rest api that this library implements.
+In order to use this library, please ensure that you have read first the documentation available on Connect knowledge base article located [here](http://help.vendor.connect.cloud.im/support/solutions/articles/43000030735-fulfillment-management-module), this one will provide you a great information on the rest api that this library implements.
 ### Class Features
 ---
 This library may be consumed in your project in order to automate the fulfillment of requests, this class once imported into your project will allow you to:

connect/config.py

@@ -15,12 +15,13 @@ class Config(object):
     # Global instance
     _instance = None  # type: Config
 
+    # noinspection PyShadowingBuiltins
     def __init__(
             self,
             api_url=None,
             api_key=None,
             products=None,
-            filename=None
+            file=None
     ):
         # type: (str, str, Union[str, List[str]], str) -> None
 
@@ -29,29 +30,29 @@ def __init__(
         :param api_url: Public api url
         :param api_key: Service user ApiKey
         :param products (optional): Id products
-        :param filename: Config file path
+        :param file: Config file path
         """
         # Check arguments
-        if not filename and not any([api_key, api_url]):
+        if not file and not any([api_key, api_url]):
             raise ValueError('Filename or api_key and api_url are expected'
                              'in Config initialization')
         if products and not isinstance(products, (str, list)):
             raise TypeError('Products can be string or string list. Found type '
                             + type(products).__name__)
 
         # Load config from file name
-        if filename:
-            if not os.path.exists(filename):
-                raise IOError('No filename `{}` on directory'.format(filename))
+        if file:
+            if not os.path.exists(file):
+                raise IOError('No file `{}` on directory'.format(file))
 
-            with open(filename) as config_file:
+            with open(file) as config_file:
                 configs = config_file.read()
 
             try:
                 configs = json.loads(configs)
             except Exception as ex:
-                raise TypeError('Invalid config filename `{}`\n'
-                                'ERROR: {}'.format(filename, str(ex)))
+                raise TypeError('Invalid config file `{}`\n'
+                                'ERROR: {}'.format(file, str(ex)))
 
             (api_url, api_key, products) = (configs.get('apiEndpoint', ''),
                                             configs.get('apiKey', ''),
@@ -77,7 +78,7 @@ def __init__(
     def get_instance(cls):
         # type: () -> Config
         if not cls._instance:
-            cls._instance = Config(filename='config.json')
+            cls._instance = Config(file='config.json')
         return cls._instance
 
     @property

example/example.py

@@ -16,7 +16,7 @@
 logger.setLevel("DEBUG")
 
 # If we remove this line, it is done implicitly
-Config(filename='config.json')
+Config(file='config.json')
 
 
 class ExampleRequestProcessor(FulfillmentAutomation):

tests/test_config.py

@@ -47,11 +47,11 @@ def test_global_config_immutable_properties():
 
 def test_init_config_with_non_existing_file():
     with pytest.raises(IOError):
-        Config(filename='non_existing_config.json')
+        Config(file='non_existing_config.json')
 
 
 def test_init_config_with_file():
-    _assert_config(Config(filename='config.json'))
+    _assert_config(Config(file='config.json'))
 
 
 def test_init_config_with_arguments():
@@ -73,7 +73,7 @@ def test_init_config_with_invalid_arguments():
 
 # noinspection PyPropertyAccess
 def test_config_immutable_properties():
-    config = Config(filename='config.json')
+    config = Config(file='config.json')
     with pytest.raises(AttributeError):
         config.api_key = conf_dict.get('apiKey')
         config.api_url = conf_dict.get('apiEndpoint')