Merge branch 'master' of https://github.com/ingrammicro/connect-python-sdk into master

Author: JaviCerveraIngram

.travis.yml

@@ -1,16 +1,39 @@
 language: python
-
 matrix:
   include:
-    - os: linux
-      python: 2.7
-    - os: linux
-      python: 3.5
-    - os: linux
-      python: 3.6
+  - os: linux
+    python: 2.7
+    env: BUILD=PYPI
+  - os: linux
+    python: 3.4
+  - os: linux
+    python: 3.5
+  - os: linux
+    python: 3.6
+  - os: linux
+    python: 3.7
+    dist: xenial
+    sudo: true
 
 install:
-- pip install -r test-requirements.txt
+- pip install -r requirements/test.txt
+- pip install -r requirements/sdk.txt
+- pip install pytest-cov
 
 script:
-- flake8 connectsdk
+- flake8 connect
+- pytest --cov-report=xml --cov=./connect
+
+after_success:
+- bash <(curl -s https://codecov.io/bash)
+
+deploy:
+  provider: pypi
+  user: apslite
+  password:
+    secure: nzWd7Fqgi/K5YKqrAPkIBkgRImWQyQgD2/qP3fYksyJnIFWNcea5T4EKqQKXIPZHh1K0cRhT7mSjIfIrQ6H3XKM/eMTAlz6pbisG2cuu4ueUBjbxHCVCkwzBPgF7+DuCJUXJ/SHyoqMnTdAQo8fb8g69/UCmnUp37YoDO1YHXIMjFVkNc6PFS7nQElXnWkvWd1SpQgA1ZdWdwBzEnIiq+L6IFeTa83PH0Schkem/vR9Ql9CmuliovNt3yHfFaeIqLUgOmsfrwOtDVs0/SkcF+Gg5tNds7DHH2TR4fHco5s8F+n4FVgv2DUPlvBbOVvUH1RiRB8hdATetUxe1cU8fT1nPdJASLWS5E4b4knGLH53+bGxqPVezHxghbVYZHPXp7yI1zWX/Wtn9MBiAo9S3f+Tf8zTk5PIjAJLG/Sdn0RX8mLn89fsslku3enH/FknwPtG+xVYSzUlrd+yzHKnqYkKJzMjsBq/F5+shmYSDlnGdGv+Ga3xZSjIoXlphO5qpxR7vrGnLMxEPJC06+mPgPZp1qfDMyrei/IAPRP8qYPC+Vnj8yclH/UyBKT66z2UEP1z5Op99fUXi3W59x2zdVaLHYniNf16UqtrE5kc7gdLvVcH+NtbO716SAbvO5ql/JsYYTmDSoWEC9KWZS+4E7p7n45c8DEieg8Q5HThWF9Y=
+  on:
+    tags: true
+    all_branches: true
+    distributions: sdist
+    condition: "$BUILD = PYPI"

MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements/sdk.txt
+include connect/logger/config.json
+include VERSION

README.md

@@ -1,7 +1,11 @@
 # Connect Python  SDK
 
+![pyversions](https://img.shields.io/pypi/pyversions/connect-sdk.svg)  [![PyPi Status](https://img.shields.io/pypi/v/connect-sdk.svg)](https://pypi.org/project/connect-sdk/) [![codecov](https://codecov.io/gh/ingrammicro/connect-python-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/ingrammicro/connect-python-sdk) [![Build Status](https://travis-ci.org/ingrammicro/connect-python-sdk.svg?branch=master)](https://travis-ci.org/ingrammicro/connect-python-sdk) [![PyPI status](https://img.shields.io/pypi/status/connect-sdk.svg)](https://pypi.python.org/pypi/connect-sdk/)
 ### Getting Started
 ---
+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 knowladge base article located here, 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:
@@ -25,13 +29,19 @@ Your code may use any scheduler to execute, from a simple cron to a cloud schedu
 ```sh
 $ pip install connect-sdk
 ```
+
+### Requirements
+* Python 2.7+ or Python 3.4+
+* Requests (https://pypi.org/project/requests/)
+* Marshmallow (https://pypi.org/project/marshmallow/)
+
 ### Example
 ```python
-from connectsdk.config import Config
-from connectsdk.logger import logger
-from connectsdk.models import ActivationTemplateResponse, ActivationTileResponse
-from connectsdk.models.exception import FulfillmentFail, FulfillmentInquire, Skip
-from connectsdk.resource import FulfillmentAutomation
+from connect import FulfillmentAutomation
+from connect.config import Config
+from connect.logger import logger
+from connect.models import ActivationTemplateResponse, ActivationTileResponse
+from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip
 
 Config(file='config.json')
 
@@ -76,6 +86,5 @@ class ExampleRequestProcessor(FulfillmentAutomation):
 if __name__ == '__main__':
     request = ExampleRequestProcessor()
     request.process()
-
 ```
 

VERSION

@@ -0,0 +1,11 @@
+from .resource import FulfillmentAutomation
+
+name = 'connect'
+
+__all__ = [
+    'config',
+    'resource',
+    'models',
+    'logger',
+    'FulfillmentAutomation'
+]

connect/__init__.py

@@ -1,8 +1,8 @@
+# -*- coding: utf-8 -*-
+
 import json
 import os
 
-from six import string_types
-
 
 class Config(object):
     api_url = None
@@ -46,7 +46,7 @@ def _set_attr(api_url, api_key, products=None):
         Config.api_url = api_url
         if products:
             Config.products = [products] if isinstance(
-                products, string_types) else products
+                products, str) else products
 
     @staticmethod
     def check_credentials(api_url, api_key, products):
@@ -60,7 +60,7 @@ def check_credentials(api_url, api_key, products):
             raise ValueError('Please provide your credentials.'
                              'Not set value for `api_key` or `api_url`')
 
-        if products and not isinstance(products, (string_types, list)):
+        if products and not isinstance(products, (str, list)):
             raise TypeError('Products can be string or string list. Found type '
                             + type(products).__name__)
 
@@ -89,9 +89,13 @@ def load_from_file(self, file):
             raise TypeError('Invalid config file `{}`\n'
                             'ERROR: {}'.format(file, str(ex)))
 
-        (api_url, api_key, products) = (configs.get('apiEndpoint'),
-                                        configs.get('apiKey'),
-                                        configs.get('products'))
+        (api_url, api_key, products) = (configs.get('apiEndpoint', ''),
+                                        configs.get('apiKey', ''),
+                                        configs.get('products', ''))
+
+        products = products.encode('utf-8') if not isinstance(products, (str, list)) else products
+        api_url = api_url.encode('utf-8') if not isinstance(api_url, str) else api_url
+        api_key = api_key.encode('utf-8') if not isinstance(api_key, str) else api_key
 
         self.check_credentials(api_url, api_key, products)
         self._set_attr(api_url, api_key, products)

connectsdk/config.py connect/config.pyconnectsdk/config.py renamed to connect/config.py

@@ -1,9 +1,11 @@
+# -*- coding: utf-8 -*-
+
 import json
 import logging
 import os
 from logging.config import dictConfig
 
-with open(os.path.join(os.path.dirname(__file__), 'config.json'), encoding="utf-8") as config_file:
+with open(os.path.join(os.path.dirname(__file__), 'config.json')) as config_file:
     config = json.load(config_file)
 
 dictConfig(config['logging'])
@@ -20,4 +22,5 @@ def decorator(self, *args, **kwargs):
         logger.debug(
             'Function `{}.{}` return: {}'.format(self.__class__.__name__, func.__name__, result))
         return result
+
     return decorator

connectsdk/logger/__init__.py connect/logger/__init__.pyconnectsdk/logger/__init__.py renamed to connect/logger/__init__.py

@@ -1,5 +1,8 @@
 from .activation_response import ActivationTemplateResponse, ActivationTileResponse
-from .schema import BaseScheme, FulfillmentScheme, Param, ParamScheme, ServerErrorScheme
+from .base import BaseScheme
+from .fulfillment import FulfillmentScheme
+from .parameters import Param, ParamScheme
+from .server_error import ServerErrorScheme
 
 __all__ = [
     'ActivationTemplateResponse',