Update tests and method descriptions

Author: fatimarahman

src/nypl_py_utils/classes/cloudlibrary_client.py

@@ -32,7 +32,7 @@ def get_library_events(self, start_date=None,
                            end_date=None) -> requests.Response:
         """
         Retrieves all the events related to library-owned items within the
-        optional timeframe. Pulls yesterday's events by default.
+        optional timeframe. Pulls past 24 hours of events by default.
 
         start_date and end_date are optional parameters, and must be
         formatted either YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS
@@ -80,8 +80,8 @@ def request(self, path, method_type="GET",
         This method is necessary for building headers/authorization.
         Example usage of this method is in the get_library_events function.
 
-        Returns Response object by default -- you will need to parse the object
-        to retrieve text, status code, etc.
+        Returns Response object by default -- you will need to parse this
+        object to retrieve response text, status codes, etc.
         """
         extended_path = f"/cirrus/library/{self.library_id}/{path}"
         headers = self._build_headers(method_type, extended_path)

tests/test_cloudlibrary_client.py

@@ -103,23 +103,72 @@ def test_get_library_events_exception_when_connection_timeout(
         with pytest.raises(CloudLibraryClientError):
             test_instance.get_library_events()
 
-    def test_request_success(self, test_instance, mocker):
+    def test_get_request_success(self, test_instance, requests_mock):
         start = "2024-11-10T10:00:00"
         end = "2024-11-11T10:00:00"
-        expected_headers = {'3mcl-Datetime': 'Mon, 11 Nov 2024 10:00:00 GMT',
-                            '3mcl-Authorization': '3MCLAUTH account_id:KipNmbVsmsT2xPjP4oHAaR3n00JgcszfF6mQRffBoRk=', # noqa
-                            '3mcl-APIVersion': '3.0.2',
-                            'Accept': 'application/xml'}
-        mock_get = mocker.patch("requests.sessions.Session.get")
-        test_instance.request(
+        url = f"{_API_URL}{test_instance.library_id}/data/cloudevents?startdate={start}&enddate={end}" # noqa
+        expected_headers = {"3mcl-Datetime": "Mon, 11 Nov 2024 10:00:00 GMT",
+                            "3mcl-Authorization": "3MCLAUTH account_id:KipNmbVsmsT2xPjP4oHAaR3n00JgcszfF6mQRffBoRk=", # noqa
+                            "3mcl-APIVersion": "3.0.2",
+                            "Accept": "application/xml"}
+        requests_mock.get(
+            url=url, text=_TEST_LIBRARY_EVENTS_RESPONSE)
+
+        response = test_instance.request(
             path=f"data/cloudevents?startdate={start}&enddate={end}",
             method_type="GET")
 
-        mock_get.assert_called_once_with(
-            url=f"{_API_URL}library_id/data/cloudevents?startdate={start}&enddate={end}", # noqa
-            data=None,
-            headers=expected_headers,
-            timeout=60)
+        assert response.text == _TEST_LIBRARY_EVENTS_RESPONSE
+        assert requests_mock.request_history[0].method == "GET"
+        assert requests_mock.request_history[0].url == url
+        assert expected_headers.items() <= dict(
+            requests_mock.request_history[0].headers).items()
+
+    def test_put_request_success(self, test_instance, requests_mock):
+        start = "2024-11-10T10:00:00"
+        end = "2024-11-11T10:00:00"
+        url = f"{_API_URL}{test_instance.library_id}/data/cloudevents?startdate={start}&enddate={end}" # noqa
+        expected_headers = {"3mcl-Datetime": "Mon, 11 Nov 2024 10:00:00 GMT",
+                            "3mcl-Authorization": "3MCLAUTH account_id:3M773C6ZVWmB/ISoSjQy9iBp48T4tUWhoNOwXaseMtE=", # noqa
+                            "3mcl-APIVersion": "3.0.2",
+                            "Content-Type": "application/xml"}
+        requests_mock.put(
+            url=url, text=_TEST_LIBRARY_EVENTS_RESPONSE)
+
+        response = test_instance.request(
+            path=f"data/cloudevents?startdate={start}&enddate={end}",
+            method_type="PUT",
+            body={"test": "test"})
+
+        assert response.text == _TEST_LIBRARY_EVENTS_RESPONSE
+        assert requests_mock.request_history[0].method == "PUT"
+        assert requests_mock.request_history[0].url == url
+        assert requests_mock.request_history[0].body == "test=test"
+        assert expected_headers.items() <= dict(
+            requests_mock.request_history[0].headers).items()
+
+    def test_post_request_success(self, test_instance, requests_mock):
+        start = "2024-11-10T10:00:00"
+        end = "2024-11-11T10:00:00"
+        url = f"{_API_URL}{test_instance.library_id}/data/cloudevents?startdate={start}&enddate={end}" # noqa
+        expected_headers = {"3mcl-Datetime": "Mon, 11 Nov 2024 10:00:00 GMT",
+                            "3mcl-Authorization": "3MCLAUTH account_id:vF0zI6ee1w1PbTLQ9EVvtxRly2vpCRxdBdAHb8DZQ4E=", # noqa
+                            "3mcl-APIVersion": "3.0.2",
+                            "Content-Type": "application/xml"}
+        requests_mock.post(
+            url=url, text=_TEST_LIBRARY_EVENTS_RESPONSE)
+
+        response = test_instance.request(
+            path=f"data/cloudevents?startdate={start}&enddate={end}",
+            method_type="POST",
+            body={"test": "test"})
+
+        assert response.text == _TEST_LIBRARY_EVENTS_RESPONSE
+        assert requests_mock.request_history[0].method == "POST"
+        assert requests_mock.request_history[0].url == url
+        assert requests_mock.request_history[0].body == "test=test"
+        assert expected_headers.items() <= dict(
+            requests_mock.request_history[0].headers).items()
 
     def test_request_failure(self, test_instance, requests_mock):
         start = "2024-11-10T10:00:00"