sumo-wrapper-python 0.3.4__tar.gz → 0.3.5__tar.gz

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/.github/workflows/linting.yml

@@ -18,7 +18,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - uses: psf/black@stable
         with:
-          options: "--check --verbose --line-length 80"
+          options: "--check --verbose --line-length 79"
           src: "./src/sumo/wrapper"
   flake8:
     runs-on: ubuntu-latest
@@ -26,15 +26,15 @@ jobs:
       matrix:
         python-version: ["3.8"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8
-    - name: Analysing the code with flake8
-      run: |
-        flake8 src/sumo/wrapper --config .flake8
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8
+      - name: Analysing the code with flake8
+        run: |
+          flake8 src/sumo/wrapper --config .flake8

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/.gitignore

@@ -11,3 +11,4 @@ build
 /src/testing.py
 /docs/_build
 /docs/_static
+/src/sumo/wrapper/version.py

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sumo-wrapper-python
-Version: 0.3.4
+Version: 0.3.5
 Summary: Python wrapper for the Sumo API
 Home-page: https://github.com/equinor/sumo-wrapper-python
 Author: Equinor ASA

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/pyproject.toml

@@ -7,4 +7,4 @@ requires = [
 ]
 
 [tool.black]
-line-length = 80
+line-length = 79

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/requirements/requirements.txt

@@ -1,6 +1,6 @@
 msal>=1.18.0
 msal-extensions>=1.0.0
-requests>=2.24.0
 PyYAML>=5.4
 setuptools>=49.2.1
 pyjwt>=2.4.0
+httpx>=0.24.1

sumo-wrapper-python-0.3.5/src/sumo/wrapper/_blob_client.py

@@ -0,0 +1,58 @@
+import httpx
+
+from ._request_error import raise_request_error_exception
+
+
+class BlobClient:
+    """Upload blobs to blob store using pre-authorized URLs"""
+
+    def upload_blob(self, blob: bytes, url: str):
+        """Upload a blob.
+
+        Parameters:
+            blob: byte string to upload
+            url: pre-authorized URL to blob store
+        """
+
+        headers = {
+            "Content-Type": "application/octet-stream",
+            "Content-Length": str(len(blob)),
+            "x-ms-blob-type": "BlockBlob",
+        }
+
+        try:
+            response = httpx.put(url, data=blob, headers=headers)
+        except httpx.ProxyError as err:
+            raise_request_error_exception(503, err)
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response
+
+    async def upload_blob_async(self, blob: bytes, url: str):
+        """Upload a blob async.
+
+        Parameters:
+            blob: byte string to upload
+            url: pre-authorized URL to blob store
+        """
+
+        headers = {
+            "Content-Type": "application/octet-stream",
+            "Content-Length": str(len(blob)),
+            "x-ms-blob-type": "BlockBlob",
+        }
+
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.put(
+                    url=url, data=blob, headers=headers
+                )
+        except httpx.ProxyError as err:
+            raise_request_error_exception(503, err)
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo/wrapper/_call_azure_api.py

@@ -1,4 +1,4 @@
-import requests
+import httpx
 import logging
 
 from ._auth import Auth
@@ -154,9 +154,9 @@ class CallAzureApi:
 
         headers = {"Content-Type": "application/json", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.json()
@@ -182,9 +182,9 @@ class CallAzureApi:
 
         headers = {"Content-Type": "html/text", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers, stream=True)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return None
@@ -210,9 +210,9 @@ class CallAzureApi:
 
         headers = {"Content-Type": "application/json", "Authorization": bearer}
 
-        response = requests.get(url, headers=headers)
+        response = httpx.get(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.content
@@ -249,11 +249,11 @@ class CallAzureApi:
         }
 
         try:
-            response = requests.post(url, data=blob, json=json, headers=headers)
-        except requests.exceptions.ProxyError as err:
+            response = httpx.post(url, data=blob, json=json, headers=headers)
+        except httpx.ProxyError as err:
             _raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response
@@ -293,11 +293,11 @@ class CallAzureApi:
             headers["Authorization"] = bearer
 
         try:
-            response = requests.put(url, data=blob, json=json, headers=headers)
-        except requests.exceptions.ProxyError as err:
+            response = httpx.put(url, data=blob, json=json, headers=headers)
+        except httpx.ProxyError as err:
             _raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response
@@ -321,9 +321,9 @@ class CallAzureApi:
             "Authorization": bearer,
         }
 
-        response = requests.delete(url, headers=headers)
+        response = httpx.delete(url, headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             _raise_request_error_exception(response.status_code, response.text)
 
         return response.json()

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo/wrapper/_call_sumo_api.py

@@ -30,7 +30,9 @@ class CallSumoApi:
             self.base_url = f"https://main-sumo-{env}.radix.equinor.com/api/v1"
 
         resource_id = (
-            resource_id if resource_id else APP_REGISTRATION[env]["RESOURCE_ID"]
+            resource_id
+            if resource_id
+            else APP_REGISTRATION[env]["RESOURCE_ID"]
         )
         client_id = (
             client_id if client_id else APP_REGISTRATION[env]["CLIENT_ID"]
@@ -224,7 +226,9 @@ class CallSumoApi:
         Return
             string: The object id of the newly created object, or error message.
         """
-        return self._post_objects(object_id=parent_id, json=json, bearer=bearer)
+        return self._post_objects(
+            object_id=parent_id, json=json, bearer=bearer
+        )
 
     def update_child_level_json(
         self, json, object_id=None, url=None, bearer=None

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo/wrapper/sumo_client.py

@@ -1,13 +1,14 @@
-import requests
-import jwt
-import time
 import logging
+import time
+
+import httpx
+import jwt
 
-from .config import APP_REGISTRATION, TENANT_ID
-from ._new_auth import NewAuth
-from ._request_error import raise_request_error_exception
 from ._blob_client import BlobClient
 from ._logging import LogHandlerSumo
+from ._new_auth import NewAuth
+from ._request_error import raise_request_error_exception
+from .config import APP_REGISTRATION, TENANT_ID
 
 logger = logging.getLogger("sumo.wrapper")
 
@@ -97,6 +98,10 @@ class SumoClient:
                 sumo = SumoClient("dev")
 
                 sumo.blob_client.upload_blob(blob, blob_url)
+
+            Uploading blob async::
+
+                await sumo.blob_client.upload_blob_async(blob, blob_url)
         """
 
         return self._blob_client
@@ -190,13 +195,14 @@ class SumoClient:
             "authorization": f"Bearer {token}",
         }
 
-        response = requests.get(
+        response = httpx.get(
             f"{self.base_url}{path}",
             params=self._process_params(params),
             headers=headers,
+            follow_redirects=True,
         )
 
-        if not response.ok:
+        if response.is_error:
             raise_request_error_exception(response.status_code, response.text)
 
         if "/blob" in path:
@@ -210,7 +216,7 @@ class SumoClient:
         blob: bytes = None,
         json: dict = None,
         params: dict = None,
-    ) -> requests.Response:
+    ) -> httpx.Response:
         """Performs a POST-request to the Sumo API.
 
         Takes either blob or json as a payload,
@@ -262,7 +268,7 @@ class SumoClient:
         content_length = 0
 
         if blob or json:
-            content_length = len(json) if json else len(blob)
+            content_length = len(str(json)) if json else len(blob)
 
         headers = {
             "Content-Type": content_type,
@@ -271,24 +277,24 @@ class SumoClient:
         }
 
         try:
-            response = requests.post(
+            response = httpx.post(
                 f"{self.base_url}{path}",
                 data=blob,
                 json=json,
                 headers=headers,
                 params=params,
             )
-        except requests.exceptions.ProxyError as err:
+        except httpx.ProxyError as err:
             raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             raise_request_error_exception(response.status_code, response.text)
 
         return response
 
     def put(
         self, path: str, blob: bytes = None, json: dict = None
-    ) -> requests.Response:
+    ) -> httpx.Response:
         """Performs a PUT-request to the Sumo API.
 
         Takes either blob or json as a payload,
@@ -317,17 +323,17 @@ class SumoClient:
         headers = {
             "Content-Type": content_type,
             "authorization": f"Bearer {token}",
-            "Content-Length": str(len(json) if json else len(blob)),
+            "Content-Length": str(len(str(json)) if json else len(blob)),
         }
 
         try:
-            response = requests.put(
+            response = httpx.put(
                 f"{self.base_url}{path}", data=blob, json=json, headers=headers
             )
-        except requests.exceptions.ProxyError as err:
+        except httpx.ProxyError as err:
             raise_request_error_exception(503, err)
 
-        if not response.ok:
+        if response.is_error:
             raise_request_error_exception(response.status_code, response.text)
 
         return response
@@ -357,9 +363,9 @@ class SumoClient:
             "Authorization": f"Bearer {token}",
         }
 
-        response = requests.delete(f"{self.base_url}{path}", headers=headers)
+        response = httpx.delete(f"{self.base_url}{path}", headers=headers)
 
-        if not response.ok:
+        if response.is_error:
             raise_request_error_exception(response.status_code, response.text)
 
         return response.json()
@@ -381,3 +387,221 @@ class SumoClient:
         handler = LogHandlerSumo(self)
         logger.addHandler(handler)
         return logger
+
+    async def get_async(self, path: str, **params):
+        """Performs an async GET-request to the Sumo API.
+
+        Args:
+            path: Path to a Sumo endpoint
+            params: Keyword arguments treated as query parameters
+
+        Returns:
+            Sumo JSON response as a dictionary
+
+        Examples:
+            Retrieving user data from Sumo::
+
+                sumo = SumoClient("dev")
+
+                userdata = await sumo.getAsync(path="/userdata")
+
+            Searching for cases::
+
+                sumo = SuomClient("dev")
+
+                cases = await sumo.getAsync(
+                    path="/search",
+                    query="class:case",
+                    size=3
+                )
+        """
+        token = self._retrieve_token()
+
+        headers = {
+            "Content-Type": "application/json",
+            "authorization": f"Bearer {token}",
+        }
+
+        async with httpx.AsyncClient() as client:
+            response = await client.get(
+                f"{self.base_url}{path}",
+                params=self._process_params(params),
+                headers=headers,
+            )
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        if "/blob" in path:
+            return response.content
+
+        return response.json()
+
+    async def post_async(
+        self,
+        path: str,
+        blob: bytes = None,
+        json: dict = None,
+        params: dict = None,
+    ) -> httpx.Response:
+        """Performs an async POST-request to the Sumo API.
+
+        Takes either blob or json as a payload,
+        will raise an error if both are provided.
+
+        Args:
+            path: Path to a Sumo endpoint
+            blob: Blob payload
+            json: Json payload
+
+        Returns:
+            Sumo response object
+
+        Raises:
+            ValueError: If both blob and json parameters have been provided
+
+        Examples:
+            Uploading case metadata::
+
+                case_metadata = {...}
+                sumo = SumoClient("dev")
+
+                new_case = await sumo.postAsync(
+                    path="/objects",
+                    json=case_metadata
+                )
+
+                new_case_id = new_case.json()["_id"]
+
+            Uploading object metadata::
+
+                object_metadata = {...}
+                sumo = SumoClient("dev")
+
+                new_objet = await sumo.postAsync(
+                    path=f"/objects('{new_case_id}')",
+                    json=object_metadata
+                )
+        """
+
+        token = self._retrieve_token()
+
+        if blob and json:
+            raise ValueError("Both blob and json given to post.")
+
+        content_type = (
+            "application/octet-stream" if blob else "application/json"
+        )
+        content_length = 0
+
+        if blob or json:
+            content_length = len(str(json)) if json else len(blob)
+
+        headers = {
+            "Content-Type": content_type,
+            "authorization": f"Bearer {token}",
+            "Content-Length": str(content_length),
+        }
+
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.post(
+                    url=f"{self.base_url}{path}",
+                    data=blob,
+                    json=json,
+                    headers=headers,
+                    params=params,
+                )
+        except httpx.ProxyError as err:
+            raise_request_error_exception(503, err)
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response
+
+    async def put_async(
+        self, path: str, blob: bytes = None, json: dict = None
+    ) -> httpx.Response:
+        """Performs an async PUT-request to the Sumo API.
+
+        Takes either blob or json as a payload,
+        will raise an error if both are provided.
+
+        Args:
+            path: Path to a Sumo endpoint
+            blob: Blob payload
+            json: Json payload
+
+        Returns:
+            Sumo response object
+        """
+
+        token = self._retrieve_token()
+
+        if blob and json:
+            raise ValueError("Both blob and json given to post")
+
+        content_type = (
+            "application/json"
+            if json is not None
+            else "application/octet-stream"
+        )
+
+        headers = {
+            "Content-Type": content_type,
+            "authorization": f"Bearer {token}",
+            "Content-Length": str(len(str(json)) if json else len(blob)),
+        }
+
+        try:
+            async with httpx.AsyncClient() as client:
+                response = await client.put(
+                    url=f"{self.base_url}{path}",
+                    data=blob,
+                    json=json,
+                    headers=headers,
+                )
+        except httpx.ProxyError as err:
+            raise_request_error_exception(503, err)
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response
+
+    async def delete_async(self, path: str) -> dict:
+        """Performs an async DELETE-request to the Sumo API.
+
+        Args:
+            path: Path to a Sumo endpoint
+
+        Returns:
+            Sumo JSON resposne as a dictionary
+
+        Examples:
+            Deleting object::
+
+                object_id = ...
+                sumo = SumoClient("dev")
+
+                await sumo.deleteAsync(path=f"/objects('{object_id}')")
+        """
+
+        token = self._retrieve_token()
+
+        headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {token}",
+        }
+
+        async with httpx.AsyncClient() as client:
+            response = await client.delete(
+                url=f"{self.base_url}{path}",
+                headers=headers,
+            )
+
+        if response.is_error:
+            raise_request_error_exception(response.status_code, response.text)
+
+        return response.json()

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo/wrapper/version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '0.3.4'
-__version_tuple__ = version_tuple = (0, 3, 4)
+__version__ = version = '0.3.5'
+__version_tuple__ = version_tuple = (0, 3, 5)

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo_wrapper_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sumo-wrapper-python
-Version: 0.3.4
+Version: 0.3.5
 Summary: Python wrapper for the Sumo API
 Home-page: https://github.com/equinor/sumo-wrapper-python
 Author: Equinor ASA

{sumo-wrapper-python-0.3.4 → sumo-wrapper-python-0.3.5}/src/sumo_wrapper_python.egg-info/requires.txt

@@ -1,9 +1,9 @@
 msal>=1.18.0
 msal-extensions>=1.0.0
-requests>=2.24.0
 PyYAML>=5.4
 setuptools>=49.2.1
 pyjwt>=2.4.0
+httpx>=0.24.1
 
 [docs]
 sphinx

sumo-wrapper-python-0.3.4/src/sumo/wrapper/_blob_client.py

@@ -1,30 +0,0 @@
-import requests
-from ._request_error import raise_request_error_exception
-
-
-class BlobClient:
-    """Upload blobs to blob store using pre-authorized URLs"""
-
-    def upload_blob(self, blob: bytes, url: str):
-        """Upload a blob.
-
-        Parameters:
-            blob: byte string to upload
-            url: pre-authorized URL to blob store
-        """
-
-        headers = {
-            "Content-Type": "application/octet-stream",
-            "Content-Length": str(len(blob)),
-            "x-ms-blob-type": "BlockBlob",
-        }
-
-        try:
-            response = requests.put(url, data=blob, headers=headers)
-        except requests.exceptions.ProxyError as err:
-            raise_request_error_exception(503, err)
-
-        if not response.ok:
-            raise_request_error_exception(response.status_code, response.text)
-
-        return response