Merge branch 'master' into feature/docs

Author: avara1986

.travis.yml

@@ -2,6 +2,7 @@ language: python
 python:
     - '3.6'
 install:
+  - pip install pipenv
   - pip install -U tox coveralls
 
 script:

Pipfile

@@ -0,0 +1,25 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "*"
+jaeger-client = "==3.12.0"
+python-json-logger = "==0.1.10"
+pyyaml = "==4.2b4"
+anyconfig = "==0.9.8"
+swagger-ui-bundle = "==0.0.2"
+connexion = {extras = ["swagger-ui"],version = "==2.1.0"}
+flask-opentracing = "==0.2.0"
+
+[dev-packages]
+requests-mock = "*"
+coverage = "*"
+mock = "*"
+nose = "*"
+pylint = "*"
+tox = "*"
+
+[requires]
+python_version = "3.6"

Pipfile.lock

@@ -40,6 +40,52 @@ Encapsulate common rest operations between business services propagating trace h
 ### pyms/tracer
 Create an injector `flask_opentracing.FlaskTracer` to use in our projects
 
+## Pipenv
+
+### Advantages over plain pip and requirements.txt
+[Pipenv](https://pipenv.readthedocs.io/en/latest/) generates two files: a `Pipfile`and a `Pipfile.lock`.
+* `Pipfile`: Is a high level declaration of the dependencies of your project. It can contain "dev" dependencies (usually test related stuff) and "standard" dependencies which are the ones you'll need for your project to function
+* `Pipfile.lock`: Is the "list" of all the dependencies your Pipfile has installed, along with their version and their hashes. This prevents two things: Conflicts between dependencies and installing a malicious module.
+
+### How to...
+
+Here the most 'common' `pipenv` commands, for a more in-depth explanation please refer to  the [official documentation](https://pipenv.readthedocs.io/en/latest/).
+
+#### Install pipenv
+```bash
+pip install pipenv
+```
+
+#### Install dependencies defined in a Pipfile
+```bash
+pipenv install
+```
+
+#### Install both dev and "standard" dependencies defined in a Pipfile
+```bash
+pipenv install --dev
+```
+
+#### Install a new module
+```bash
+pipenv install django
+```
+
+#### Install a new dev module (usually test related stuff)
+```bash
+pipenv install nose --dev
+```
+
+#### Install dependencies in production
+```bash
+pipenv install --deploy
+```
+
+#### Start a shell
+```bash
+pipenv shell
+```
+
 ## Documentation
 
 This project use MkDocs

README.md

@@ -1,6 +1,3 @@
-import os
-
 from pyms.flask.app import Microservice
 
-os.environ["CONFIGMAP_FILE"] = "config.yml"
-ms = Microservice(service="my-ms", path=__file__)
+ms = Microservice(service="my-ms", path=__file__)

examples/microservice_requests/__init__.py

@@ -1,8 +1,5 @@
-import os
-
 from pyms.flask.app import Microservice
 
-os.environ["CONFIGMAP_FILE"] = "config.yml"
 ms = Microservice(service="my-ms", path=__file__)
 app = ms.create_app()
 

examples/microservice_swagger/main.py

@@ -1,14 +1,15 @@
-import os
 from flask import jsonify
+
 from pyms.flask.app import Microservice
 
-os.environ["CONFIGMAP_FILE"] = "config.yml"
 ms = Microservice(service="my-minimal-microservice", path=__file__)
 app = ms.create_app()
 
+
 @app.route("/")
 def example():
     return jsonify({"main": "hello world"})
 
+
 if __name__ == '__main__':
     app.run()

examples/mininum_microservice/main.py

@@ -13,6 +13,7 @@
 
 class ConfFile(dict):
     empty_init = False
+    default_file = "config.yml"
 
     def __init__(self, *args, **kwargs):
         """
@@ -63,9 +64,9 @@ def __getattr__(self, name, *args, **kwargs):
                 raise AttrDoesNotExistException("Variable {} not exist in the config file".format(name))
 
     def _get_conf_from_env(self):
-        file = os.environ.get(CONFIGMAP_FILE_ENVIRONMENT)
-        logger.info("[CONF] Searching file in ENV[{}]: {}...".format(CONFIGMAP_FILE_ENVIRONMENT, file))
-        return self._get_conf_from_file(os.environ.get(CONFIGMAP_FILE_ENVIRONMENT))
+        config_file = os.environ.get(CONFIGMAP_FILE_ENVIRONMENT, self.default_file)
+        logger.info("[CONF] Searching file in ENV[{}]: {}...".format(CONFIGMAP_FILE_ENVIRONMENT, config_file))
+        return self._get_conf_from_file(config_file)
 
     def _get_conf_from_file(self, path: Text) -> dict:
         if not path or not os.path.isfile(path):

pyms/config/confile.py

@@ -6,8 +6,6 @@
 
 from pyms.flask.services.driver import DriverService
 
-DATA = 'data'
-
 
 class Service(DriverService):
     service = "requests"
@@ -26,7 +24,7 @@ def insert_trace_headers(self, headers):
 
         :rtype: dict
         """
-        self._tracer = current_app.tracer
+
         try:
             # FLASK https://github.com/opentracing-contrib/python-flask
             span = self._tracer.get_span()
@@ -46,6 +44,7 @@ def _get_headers(self, headers):
         if not headers:
             headers = {}
 
+        self._tracer = current_app.tracer
         if self._tracer:
             headers = self.insert_trace_headers(headers)
 
@@ -63,6 +62,23 @@ def _build_url(url, path_params=None):
 
         return url.format_map(path_params)
 
+    def parse_response(self, response):
+        """Parses response's json object. Checks configuration in order to parse a concrete node or the whole response.
+
+        :param response: request's response that contains a valid json
+
+        :rtype: dict
+        """
+
+        try:
+            data = response.json()
+            if self.config.data:
+                data = data.get(self.config.data, {})
+            return data
+        except ValueError:
+            current_app.logger.warning("Response.content is not a valid json {}".format(response.content))
+            return {}
+
     def get(self, url, path_params=None, params=None, headers=None, **kwargs):
         """Sends a GET request.
 
@@ -99,15 +115,7 @@ def get_for_object(self, url, path_params=None, params=None, headers=None, **kwa
         """
 
         response = self.get(url, path_params=path_params, params=params, headers=headers, **kwargs)
-
-        try:
-            data = response.json()
-            if self.config.data:
-                data = data.get(self.config.data, {})
-            return data
-        except ValueError:
-            current_app.logger.warning("Response.content is not a valid json {}".format(response.content))
-            return {}
+        return self.parse_response(response)
 
     def post(self, url, path_params=None, data=None, json=None, headers=None, **kwargs):
         """Sends a POST request.
@@ -147,12 +155,7 @@ def post_for_object(self, url, path_params=None, data=None, json=None, headers=N
         """
 
         response = self.post(url, path_params=path_params, data=data, json=json, headers=headers, **kwargs)
-
-        try:
-            return response.json().get(DATA, {})
-        except ValueError:
-            current_app.logger.warning("Response.content is not a valid json {}".format(response.content))
-            return {}
+        return self.parse_response(response)
 
     def put(self, url, path_params=None, data=None, headers=None, **kwargs):
         """Sends a PUT request.
@@ -192,12 +195,7 @@ def put_for_object(self, url, path_params=None, data=None, headers=None, **kwarg
         """
 
         response = self.put(url, path_params=path_params, data=data, headers=headers, **kwargs)
-
-        try:
-            return response.json().get(DATA, {})
-        except ValueError:
-            current_app.logger.warning("Response.content is not a valid json {}".format(response.content))
-            return {}
+        return self.parse_response(response)
 
     def delete(self, url, path_params=None, headers=None, **kwargs):
         """Sends a DELETE request.