Adds update_or_create function, and also adapts some views to kong 1.1 api

Signed-off-by: Bojan Jovanovic <bojan@kortechs.io>

Author: Bojan Jovanovic

.travis.yml

@@ -7,7 +7,7 @@ python:
   - "3.7-dev"  # 3.7 development branch
 # command to install dependencies
 install:
-  - pip install -r requirements.txt
+  - pip install .[testing]
   - npm install
 script:
   - ./scripts/tests.sh

kong/exceptions.py

@@ -1,2 +1,6 @@
 class SchemaViolation(Exception):
     pass
+
+
+class ObjectNotFound(Exception):
+    pass

kong/kong_clients.py

@@ -1,9 +1,14 @@
+import logging
 from abc import abstractmethod
+
+import dictdiffer
 from urllib3.util.url import Url, parse_url
 from requests import session
 from kong.structures import ApiData, ServiceData, ConsumerData, \
     PluginData, RouteData, TargetData, UpstreamData
-from kong.exceptions import SchemaViolation
+from kong.exceptions import SchemaViolation, ObjectNotFound
+
+logger = logging.getLogger(__name__)
 
 
 class RestClient:  # pylint:disable=too-few-public-methods
@@ -68,6 +73,17 @@ def _to_object_data(self, data_dict):
     def _to_list_object_data(self, list_data_dict):
         return map(self._to_object_data, list_data_dict)
 
+    def update_or_create(self, **kwargs):
+        pk_or_id = kwargs.get(self._object_data_class.pk_identifier)
+        try:
+            data_dict = self._perform_retrieve(pk_or_id)
+        except ObjectNotFound:
+            return self.create(**kwargs)
+
+        self.update(pk_or_id, **kwargs)
+
+        return self._to_object_data(data_dict)
+
     def create(self, **kwargs):
         data_dict = self._perform_create(**kwargs)
         return self._to_object_data(data_dict)
@@ -177,6 +193,9 @@ def _send_retrieve(self, name_or_id, endpoint=None):
         response = self.session.get(url)
 
         if response.status_code == 404:
+            if response.json().get('message') == "Not found":
+                raise ObjectNotFound(response.content)
+
             raise NameError(response.content)
 
         if response.status_code != 200:
@@ -188,7 +207,7 @@ def _validate_params(self, query_params, allowed_params):
         validated_params = {}
         for k, val in query_params.items():
             if k in allowed_params:
-                validated_params[k] = self._stringify_if_list(val)
+                validated_params[k] = val  # self._stringify_if_list(val)
             else:
                 raise KeyError('invalid query parameter: %s' % k)
         return validated_params
@@ -409,11 +428,11 @@ def _object_data_class(self):
     def _allowed_update_params(self):
         return 'name', 'protocol', 'host', 'port', 'path', \
                'retries', 'connect_timeout', 'send_timeout', \
-               'read_timeout', 'url'
+               'read_timeout', 'url', "tags"
 
     @property
     def _allowed_query_params(self):
-        return []
+        return ["tags"]
 
     @property
     def _path(self):
@@ -432,9 +451,9 @@ def _object_data_class(self):
 
     @property
     def _allowed_update_params(self):
-        return 'protocols', 'methods', 'hosts',\
+        return 'name', 'protocols', 'methods', 'hosts',\
                'paths', 'strip_path', 'preserve_host',\
-               'service',
+               'service', 'tags'
 
     @property
     def _allowed_query_params(self):
@@ -444,6 +463,13 @@ def _allowed_query_params(self):
     def _path(self):
         return 'routes/'
 
+    #  pylint: disable=arguments-differ
+    def _perform_update(self, pk_or_id, **kwargs):
+        if 'service' in kwargs.keys():
+            kwargs['service'] = {"id": self.get_service_id(kwargs['service'])}
+
+        return super(RouteAdminClient, self)._perform_update(pk_or_id, **kwargs)
+
     #  pylint: disable=arguments-differ
     def _perform_create(self, service, **kwargs):
 

kong/structures.py

@@ -89,6 +89,7 @@ def __normalize_uri(uri):
 
 
 class ServiceData(ObjectData):
+    pk_identifier = 'name'
 
     def validate_semi_optional_parameters(self, **kwargs):
         pass
@@ -128,7 +129,7 @@ def allowed_parameters(self):
         return 'name', 'protocol', 'host', 'port', 'path',\
                'retries', 'connect_timeout', 'send_timeout',\
                'read_timeout', 'url', 'id', \
-               'created_at', 'updated_at', 'write_timeout'
+               'created_at', 'updated_at', 'write_timeout', 'tags'
 
     @property
     def url(self):
@@ -156,7 +157,7 @@ def validate_obligatory_parameters(self, **kwargs):
 
     @property
     def allowed_parameters(self):
-        return "id", "username", "custom_id", "created_at"
+        return "id", "username", "custom_id", "created_at", "tags"
 
     def validate_semi_optional_parameters(self, **kwargs):
         if ("username" not in kwargs) and ("custom_id" not in kwargs):
@@ -166,6 +167,7 @@ def validate_semi_optional_parameters(self, **kwargs):
 
 
 class RouteData(ObjectData):
+    pk_identifier = 'name'
 
     def validate_semi_optional_parameters(self, **kwargs):
         if not ('hosts' in kwargs
@@ -178,10 +180,11 @@ def validate_obligatory_parameters(self, **kwargs):
 
     @property
     def allowed_parameters(self):
-        return "id", "created_at", "updated_at", \
+        return "name", "id", "created_at", "updated_at", \
                "protocols", "methods", "hosts", \
                "paths", "regex_priority", "strip_path", \
-               "preserve_host", "service"
+               "preserve_host", "service", "snis", "sources", \
+                "destinations", "tags"
 
 
 class TargetData(ObjectData):

readme.md

@@ -12,6 +12,7 @@ Supported Information Routes
 - node_information
 
 Supported operations for Services, Routes, Apis, Consumers, Plugins and Upstreams
+- update_or_create
 - create
 - delete
 - retrieve
@@ -33,7 +34,6 @@ Additional supported operations for Targets
 - set_healthy
 
 Not supported
-- update_or_create
 - count (dropped in 0.16/kong 0.13.0)
 - Certificates object routes (yet)
 - SNI object routes (yet)

requirements/testing.txt

@@ -1,4 +1,3 @@
--r base.txt
 flake8==3.5.0 # This covers pycodestyle
 pylint==1.8.2
 pytest==3.4.0

setup.py

@@ -3,7 +3,7 @@
 from os.path import dirname
 from os.path import join
 
-
+from pip._internal.req import parse_requirements
 from setuptools import setup
 
 __version__ = '0.1.7'
@@ -18,9 +18,12 @@ def read(*names, **kwargs):
     ).read()
 
 
-# parse_requirements() returns generator of pip.req.InstallRequirement objects
-requirements = []
-# requirements_test = [str(ir.req) for ir in parse_requirements('./requirements-test.txt', session=False)]
+with open(os.path.join(BASE_DIR, 'requirements', 'base.txt')) as f:
+    requirements = f.read().splitlines()
+
+with open(os.path.join(BASE_DIR, 'requirements', 'testing.txt')) as f:
+    requirements_test = f.read().splitlines()
+
 
 setup(
     name='python-kong-client',
@@ -42,5 +45,7 @@ def read(*names, **kwargs):
     ],
     keywords=[],
     install_requires=requirements,
-    extras_require={},
+    extras_require={
+        "tests": requirements_test
+    },
 )