Merge pull request #3 from sw360/feat/get-clearing-request

Feat/get clearing request

Author: tngraf

ChangeLog.md

@@ -1,5 +1,9 @@
 # SW360 Base Library for Python
 
+## V0.9.1
+* **New Features**:
+    * support to retrieve information about clearing requests (`get_clearing_request`, `get_clearing_request_for_project`).
+
 ## V0.9
 * relicensed to MIT.
 * **Breaking API changes**:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sw360"
-version = "0.9"
+version = "0.9.1"
 description = "Python interface to the SW360 software component catalogue"
 authors = ["Thomas Graf <thomas.graf@siemens.com>",
 "Gernot Hillier <gernot.hillier@siemens.com>"]

sw360/__init__.py

@@ -7,6 +7,6 @@
 # SPDX-License-Identifier: MIT
 # -------------------------------------------------------------------------------
 
-__version__ = (0, 9, 0)
+__version__ = (0, 9, 1)
 
 from .sw360_api import SW360, SW360Error  # noqa: F401

sw360/sw360_api.py

@@ -1424,6 +1424,38 @@ def get_health_status(self):
         resp = self.api_get(self.url + "resource/health/")
         return resp
 
+    # ----- Clearing Requests ------------------------------------------------
+
+    def get_clearing_request(self, request_id):
+        """Get information of about a clearing request
+
+        API endpoint: GET /clearingrequest/{id}
+
+        :param request_id: the id of the clearing request to be requested
+        :type request_id: string
+        :return: a clearing request
+        :rtype: JSON clearing request object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        resp = self.api_get(self.url + "resource/api/clearingrequest/" + request_id)
+        return resp
+
+    def get_clearing_request_for_project(self, project_id):
+        """Get information of about a clearing request for a specific project
+
+        API endpoint: GET /clearingrequest/project/{id}
+
+        :param request_id: the id of the clearing request to be requested
+        :type request_id: string
+        :return: a clearing request
+        :rtype: JSON clearing request object
+        :raises SW360Error: if there is a negative HTTP response
+        """
+
+        resp = self.api_get(self.url + "resource/api/clearingrequest/project/" + project_id)
+        return resp
+
     # ----- Support ----------------------------------------------------------
 
     @classmethod

tests/test_sw360_clearingrequests.py

@@ -0,0 +1,69 @@
+# -------------------------------------------------------------------------------
+# (c) 2021 Siemens AG
+# All Rights Reserved.
+# Author: thomas.graf@siemens.com
+#
+# Licensed under the MIT license.
+# SPDX-License-Identifier: MIT
+# -------------------------------------------------------------------------------
+
+import sys
+import warnings
+import unittest
+
+import responses
+
+sys.path.insert(1, "..")
+
+from sw360 import SW360   # noqa: E402
+
+
+class Sw360TestClearingRequests(unittest.TestCase):
+    MYTOKEN = "MYTOKEN"
+    MYURL = "https://my.server.com/"
+    ERROR_MSG_NO_LOGIN = "Unable to login"
+
+    def setUp(self):
+        warnings.filterwarnings(
+            "ignore", category=ResourceWarning,
+            message="unclosed.*<ssl.SSLSocket.*>")
+
+    def _add_login_response(self):
+        """
+        Add the response for a successfull login.
+        """
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/",
+            body="{'status': 'ok'}",
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+    @responses.activate
+    def test_get_clearing_request(self):
+        lib = SW360(self.MYURL, self.MYTOKEN, False)
+        self._add_login_response()
+        actual = lib.login_api()
+        self.assertTrue(actual)
+
+        responses.add(
+            method=responses.GET,
+            url=self.MYURL + "resource/api/clearingrequest/12345",
+            body='{"id": "12345",\
+              "requestedClearingDate": "2021-09-04",\
+              "projectId": "007",\
+              "clearingState": "NEW"}',  # noqa
+            status=200,
+            content_type="application/json",
+            adding_headers={"Authorization": "Token " + self.MYTOKEN},
+        )
+
+        vendor = lib.get_clearing_request("12345")
+        self.assertIsNotNone(vendor)
+        self.assertEqual("2021-09-04", vendor["requestedClearingDate"])
+
+
+if __name__ == "__main__":
+    unittest.main()