Merge pull request #835 from tomkralidis/ogcapi-transactions

implement OGC API - Features - Part 4

Author: kalxas

owslib/ogcapi/__init__.py

@@ -1,5 +1,5 @@
 # =============================================================================
-# Copyright (c) 2020 Tom Kralidis
+# Copyright (c) 2022 Tom Kralidis
 #
 # Author: Tom Kralidis <tomkralidis@gmail.com>
 #
@@ -15,7 +15,8 @@
 import yaml
 
 from owslib import __version__
-from owslib.util import Authentication, http_get, http_post
+from owslib.util import (Authentication, http_delete, http_get, http_post,
+                         http_put)
 
 LOGGER = logging.getLogger(__name__)
 
@@ -114,7 +115,7 @@ def conformance(self) -> dict:
         """
 
         path = 'conformance'
-        return self._request(path)
+        return self._request(path=path)
 
     def _build_url(self, path: str = None, params: dict = {}) -> str:
         """
@@ -141,15 +142,20 @@ def _build_url(self, path: str = None, params: dict = {}) -> str:
 
         return url
 
-    def _request(self, path: str = None, as_dict: bool = True,
+    def _request(self, method: str = 'GET', path: str = None,
+                 data: str = None, as_dict: bool = True,
                  kwargs: dict = {}) -> dict:
         """
         helper function for request/response patterns against OGC API endpoints
 
         @type path: string
         @param path: path of request
+        @type method: string
+        @param method: HTTP method (default ``GET``)
+        @type data: string
+        @param data: request data payload
         @type as_dict: bool
-        @param as_dict: whether to return JSON dict (default True)
+        @param as_dict: whether to return JSON dict (default ``True``)
         @type kwargs: string
         @param kwargs: ``dict`` of keyword value pair request parameters
 
@@ -159,28 +165,35 @@ def _request(self, path: str = None, as_dict: bool = True,
         url = self._build_url(path)
         self.request = url
 
+        LOGGER.debug(f'Method: {method}')
         LOGGER.debug(f'Request: {url}')
+        LOGGER.debug(f'Data: {data}')
         LOGGER.debug(f'Params: {kwargs}')
 
-        if 'cql' not in kwargs:
+        if method == 'GET':
             response = http_get(url, headers=self.headers, auth=self.auth,
                                 params=kwargs)
-        else:
-            LOGGER.debug('CQL query detected')
-            kwargs2 = deepcopy(kwargs)
-            cql = kwargs2.pop('cql')
-            url2 = self._build_url(path, kwargs2)
-            response = http_post(url2, request=cql, auth=self.auth)
+        elif method == 'POST':
+            response = http_post(url, request=data, auth=self.auth)
+        elif method == 'PUT':
+            response = http_put(url, data=data, auth=self.auth)
+        elif method == 'DELETE':
+            response = http_delete(url, auth=self.auth)
 
         LOGGER.debug(f'URL: {response.url}')
+        LOGGER.debug(f'Response status code: {response.status_code}')
 
-        if response.status_code != requests.codes.ok:
+        if not response:
             raise RuntimeError(response.text)
 
         self.request = response.url
 
         if as_dict:
-            return response.json()
+            if len(response.content) == 0:
+                LOGGER.debug('Empty response')
+                return {}
+            else:
+                return response.json()
         else:
             return response.content
 
@@ -199,7 +212,7 @@ def collections(self) -> dict:
         """
 
         path = 'collections'
-        return self._request(path)
+        return self._request(path=path)
 
     def collection(self, collection_id: str) -> dict:
         """
@@ -212,7 +225,7 @@ def collection(self, collection_id: str) -> dict:
         """
 
         path = f'collections/{collection_id}'
-        return self._request(path)
+        return self._request(path=path)
 
     def collection_queryables(self, collection_id: str) -> dict:
         """
@@ -225,4 +238,4 @@ def collection_queryables(self, collection_id: str) -> dict:
         """
 
         path = f'collections/{collection_id}/queryables'
-        return self._request(path)
+        return self._request(path=path)

owslib/ogcapi/features.py

@@ -1,12 +1,14 @@
 # =============================================================================
-# Copyright (c) 2020 Tom Kralidis
+# Copyright (c) 2022 Tom Kralidis
 #
 # Author: Tom Kralidis <tomkralidis@gmail.com>
 #
 # Contact email: tomkralidis@gmail.com
 # =============================================================================
 
+from copy import deepcopy
 import logging
+from urllib.parse import urlencode
 
 from owslib.ogcapi import Collections
 from owslib.util import Authentication
@@ -65,8 +67,15 @@ def collection_items(self, collection_id: str, **kwargs: dict) -> dict:
         if 'bbox' in kwargs:
             kwargs['bbox'] = ','.join(list(map(str, kwargs['bbox'])))
 
-        path = f'collections/{collection_id}/items'
-        return self._request(path=path, kwargs=kwargs)
+        if 'cql' in kwargs:
+            LOGGER.debug('CQL query detected')
+            kwargs2 = deepcopy(kwargs)
+            cql = kwargs2.pop('cql')
+            path = f'collections/{collection_id}/items?{urlencode(kwargs2)}'
+            return self._request(method='POST', path=path, data=cql, kwargs=kwargs2)
+        else:
+            path = f'collections/{collection_id}/items'
+            return self._request(path=path, kwargs=kwargs)
 
     def collection_item(self, collection_id: str, identifier: str) -> dict:
         """
@@ -82,3 +91,57 @@ def collection_item(self, collection_id: str, identifier: str) -> dict:
 
         path = f'collections/{collection_id}/items/{identifier}'
         return self._request(path=path)
+
+    def collection_item_create(self, collection_id: str, data: str) -> bool:
+        """
+        implements POST /collections/{collectionId}/items
+
+        @type collection_id: string
+        @param collection_id: id of collection
+        @type data: string
+        @param data: raw representation of data
+
+        @returns: single feature result
+        """
+
+        path = f'collections/{collection_id}/items'
+        _ = self._request(method='POST', path=path, data=data)
+
+        return True
+
+    def collection_item_update(self, collection_id: str, identifier: str,
+                               data: str) -> bool:
+        """
+        implements PUT /collections/{collectionId}/items/{featureId}
+
+        @type collection_id: string
+        @param collection_id: id of collection
+        @type identifier: string
+        @param identifier: feature identifier
+        @type data: string
+        @param data: raw representation of data
+
+        @returns: ``bool`` of deletion result
+        """
+
+        path = f'collections/{collection_id}/items/{identifier}'
+        _ = self._request(method='PUT', path=path, data=data)
+
+        return True
+
+    def collection_item_delete(self, collection_id: str, identifier: str) -> bool:
+        """
+        implements DELETE /collections/{collectionId}/items/{featureId}
+
+        @type collection_id: string
+        @param collection_id: id of collection
+        @type identifier: string
+        @param identifier: feature identifier
+
+        @returns: ``bool`` of deletion result
+        """
+
+        path = f'collections/{collection_id}/items/{identifier}'
+        _ = self._request(method='DELETE', path=path)
+
+        return True

owslib/ogcapi/processes.py

@@ -30,7 +30,7 @@ def processes(self) -> dict:
         """
 
         path = 'processes'
-        return self._request(path)
+        return self._request(path=path)
 
     def process(self, process_id: str) -> dict:
         """
@@ -43,4 +43,4 @@ def process(self, process_id: str) -> dict:
         """
 
         path = f'processes/{process_id}'
-        return self._request(path)
+        return self._request(path=path)

owslib/util.py

@@ -1,6 +1,6 @@
 # -*- coding: ISO-8859-15 -*-
 # =============================================================================
-# Copyright (c) 2008 Tom Kralidis
+# Copyright (c) 2022 Tom Kralidis
 #
 # Authors : Tom Kralidis <tomkralidis@gmail.com>
 #
@@ -444,7 +444,7 @@ def http_post(url=None, request=None, lang='en-US', timeout=10, username=None, p
         return requests.post(url, json=request, headers=headers_, **rkwargs)
 
 
-def http_get(*args, **kwargs):
+def http_prepare(*args, **kwargs):
     # Copy input kwargs so the dict can be modified
     rkwargs = copy.deepcopy(kwargs)
 
@@ -475,9 +475,32 @@ def http_get(*args, **kwargs):
         rkwargs.setdefault('auth', None)
     rkwargs.setdefault('cert', rkwargs.get('cert'))
     rkwargs.setdefault('verify', rkwargs.get('verify', True))
+
+    return rkwargs
+
+
+def http_get(*args, **kwargs):
+    rkwargs = http_prepare(*args, **kwargs)
     return requests.get(*args, **rkwargs)
 
 
+def http_put(*args, **kwargs):
+    rkwargs = http_prepare(*args, **kwargs)
+
+    if 'data' in kwargs:
+        if isinstance(kwargs['data'], dict):
+            rkwargs['json'] = kwargs['data']
+        else:
+            rkwargs['data'] = kwargs['data']
+
+    return requests.put(*args, **rkwargs)
+
+
+def http_delete(*args, **kwargs):
+    rkwargs = http_prepare(*args, **kwargs)
+    return requests.delete(*args, **rkwargs)
+
+
 def element_to_string(element, encoding=None, xml_declaration=False):
     """
     Returns a string from a XML object