osducli 0.0.43__tar.gz → 0.0.44__tar.gz

{osducli-0.0.43/src/osducli.egg-info → osducli-0.0.44}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: osducli
-Version: 0.0.43
+Version: 0.0.44
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.md
 Requires-Dist: click
 Requires-Dist: jmespath
-Requires-Dist: osdu-api[all]==0.28.0rc912
+Requires-Dist: osdu-api[all]==0.28.0rc949
 Requires-Dist: requests
 Requires-Dist: tabulate
 Requires-Dist: packaging
@@ -83,6 +83,11 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.44}/README.rst

@@ -35,6 +35,11 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.44}/pyproject.toml

@@ -26,7 +26,7 @@ keywords = ["osdu"]
 dependencies = [
     "click",
     "jmespath",
-    "osdu-api[all]==0.28.0rc912",
+    "osdu-api[all]==0.28.0rc949",
     "requests",
     "tabulate",
     "packaging",

{osducli-0.0.43 → osducli-0.0.44}/src/osducli/__init__.py

@@ -12,4 +12,4 @@
 
 """ OSDU command line environment"""
 
-__VERSION__ = "0.0.43"
+__VERSION__ = "0.0.44"

{osducli-0.0.43 → osducli-0.0.44}/src/osducli/cliclient.py

@@ -157,12 +157,14 @@ class CliOsduClient(BaseClient):
         return url
 
     def check_status_code(self, response: requests.Response, ok_status_codes: list = None):
+        """Check the status code of the response and raise an exception if not in the list of ok status codes"""
         if ok_status_codes is None:
             ok_status_codes = [200]
         if response.status_code not in ok_status_codes:
             raise HTTPError(response=response)
 
     def get_search_client(self) -> SearchClient:
+        """Get a client for the search service"""
         search_url = self.url_from_config(CONFIG_SEARCH_URL, "")
         if search_url.endswith("/"):
             search_url = search_url[:-1]
@@ -174,6 +176,7 @@ class CliOsduClient(BaseClient):
         )
 
     def get_storage_record_client(self) -> RecordClient:
+        """Get a client for the storage record service"""
         storage_url = self.url_from_config(CONFIG_STORAGE_URL, "")
         if storage_url.endswith("/"):
             storage_url = storage_url[:-1]
@@ -185,6 +188,7 @@ class CliOsduClient(BaseClient):
         )
 
     def get_entitlements_client(self) -> EntitlementsClient:
+        """Get a client for the entitlements service"""
         entitlements_url = self.url_from_config(CONFIG_ENTITLEMENTS_URL, "")
         if entitlements_url.endswith("/"):
             entitlements_url = entitlements_url[:-1]
@@ -195,7 +199,15 @@ class CliOsduClient(BaseClient):
             token_refresher=self.token_refresher
         )
 
-    def get_wellbore_ddms_client(self, url_extra_path: str) -> WellboreDdmsClient:
+    def get_wellbore_ddms_client(
+        self,
+        url_extra_path: str
+    ) -> WellboreDdmsClient:
+        """Get a client for the wellbore ddms service
+
+        Args:
+            url_extra_path (str): extra path to add to the base path
+        """
         wellbore_ddms_url = self.url_from_config(CONFIG_WELLBORE_DDMS_URL, url_extra_path)
         return WellboreDdmsClient(
             wellbore_ddms_url=wellbore_ddms_url,
@@ -205,9 +217,12 @@ class CliOsduClient(BaseClient):
         )
 
     def cli_get(
-        self, config_url_key: str, url_extra_path: str, ok_status_codes: list = None
+        self,
+        config_url_key: str,
+        url_extra_path: str,
+        ok_status_codes: list = None
     ) -> requests.Response:
-        """[summary]
+        """Basic GET call to the given url, returning the response object.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -220,9 +235,12 @@ class CliOsduClient(BaseClient):
         return response
 
     def cli_get_returning_json(
-        self, config_url_key: str, url_extra_path: str, ok_status_codes: list = None
+        self,
+        config_url_key: str,
+        url_extra_path: str,
+        ok_status_codes: list = None
     ) -> dict:
-        """[summary]
+        """Basic GET call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -241,7 +259,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> dict:
-        """[summary]
+        """Basic POST call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -253,6 +271,8 @@ class CliOsduClient(BaseClient):
             dict: returned json
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.POST, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response.json()
@@ -263,7 +283,7 @@ class CliOsduClient(BaseClient):
         url_extra_path: str,
         ok_status_codes: list = None,
     ) -> requests.Response:
-        """[summary]
+        """Basic DELETE call to the given url.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -289,7 +309,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> requests.Response:
-        """[summary]
+        """Basic PUT call to the given url.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -298,6 +318,8 @@ class CliOsduClient(BaseClient):
             ok_status_codes (list, optional): Optional status codes to check for successful call.
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.PUT, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response
@@ -309,7 +331,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> dict:
-        """PUT the data to the given url.
+        """Basic PUT call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -321,6 +343,8 @@ class CliOsduClient(BaseClient):
             dict: returned json
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.PUT, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response.json()

{osducli-0.0.43 → osducli-0.0.44/src/osducli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: osducli
-Version: 0.0.43
+Version: 0.0.44
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.md
 Requires-Dist: click
 Requires-Dist: jmespath
-Requires-Dist: osdu-api[all]==0.28.0rc912
+Requires-Dist: osdu-api[all]==0.28.0rc949
 Requires-Dist: requests
 Requires-Dist: tabulate
 Requires-Dist: packaging
@@ -83,6 +83,11 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.44}/src/osducli.egg-info/requires.txt

@@ -1,6 +1,6 @@
 click
 jmespath
-osdu-api[all]==0.28.0rc912
+osdu-api[all]==0.28.0rc949
 requests
 tabulate
 packaging

{osducli-0.0.43 → osducli-0.0.44}/tests/test_cliclient.py

@@ -15,6 +15,7 @@
 from unittest.mock import MagicMock, Mock
 
 import pytest
+import json
 from osdu_api.clients.base_client import BaseClient
 from osdu_api.model.http_method import HttpMethod
 
@@ -159,6 +160,8 @@ def test_cli_put(mocker, cli_client, config, path, data):
     response = cli_client.cli_put(config, path, data)
 
     mock_put.assert_called_once()
+    if isinstance(data, dict):
+        data = json.dumps(data)
     mock_put.assert_called_with(method=HttpMethod.PUT, url="https://dummy.com/core_" + config + path, data=data)
     assert response_mock == response