fix!: update the view_host_events to return a dict instead of just a list

Author: thehappydinoa

censys/search/v2/hosts.py

@@ -259,7 +259,7 @@ def view_host_events(
         per_page: Optional[int] = None,
         cursor: Optional[str] = None,
         reversed: Optional[bool] = None,
-    ) -> List[dict]:
+    ) -> dict:
         """Fetches a list of events for the specified IP address.
 
         Args:
@@ -275,7 +275,7 @@ def view_host_events(
                 that is, return events in reversed chronological order.
 
         Returns:
-            List[dict]: A list of events.
+            dict: A list of events.
         """
         args = {"per_page": per_page, "cursor": cursor, "reversed": reversed}
         if start_time:
@@ -285,7 +285,7 @@ def view_host_events(
 
         return self._get(f"/v2/experimental/{self.INDEX_NAME}/{ip}/events", args)[
             "result"
-        ]["events"]
+        ]
 
     def list_hosts_with_tag(self, tag_id: str) -> List[str]:
         """Returns a list of hosts which are tagged with the specified tag.

examples/search/view_host_events.py

@@ -11,24 +11,24 @@
 from datetime import date
 
 events = h.view_host_events(
-    "1.1.1.1", start_time=date(2022, 1, 1), end_time=date(2022, 1, 31)
+    "1.1.1.1", per_page=1, start_time=date(2022, 1, 1), end_time=date(2022, 1, 31)
 )
 print(events)
-# [
-#     {
-#         "timestamp": "2022-01-01T00:00:01.713Z",
-#         "service_observed": {
-#             "id": {"port": 80, "service_name": "HTTP", "transport_protocol": "TCP"},
-#             "observed_at": "2021-12-31T23:59:39.910804158Z",
-#             "perspective_id": "PERSPECTIVE_NTT",
-#             "changed_fields": [
-#                 {"field_name": "http.request.uri"},
-#                 {"field_name": "http.response.headers.Cf-Ray.headers"},
-#                 {"field_name": "http.response.headers.Location.headers"},
-#                 {"field_name": "banner"},
-#             ],
-#         },
-#         "_event": "service_observed",
-#     },
-#     ...
-# ]
+# {
+#     'ip': '1.1.1.1',
+#     'events': [
+#         {
+#             'timestamp': '2022-01-01T00:00:01.713Z',
+#             'service_observed': {
+#                 'id': {'port': 80, 'service_name': 'HTTP', 'transport_protocol': 'TCP'},
+#                 'observed_at': '2021-12-31T23:59:39.910804158Z',
+#                 'perspective_id': 'PERSPECTIVE_NTT',
+#                 'changed_fields': [{'field_name': 'http.request.uri'}, {'field_name': 'http.response.headers.Cf-Ray.headers'}, {'field_name': 'http.response.headers.Location.headers'}, {'field_name': 'banner'}, {'field_name': 'banner_hashes'}]
+#             },
+#             '_event': 'service_observed'
+#         }
+#     ],
+#     'links': {
+#         'next': 'AS-RtkcKDRPshfT6ojz5ubSuyen_J_J2s9VLmJf9WCg7_jGt0KdU2JvoYW9QXof1Cskvm-b41QyRiR38kWADJuUA_w8rAA5ZNv9llYarhmPv22nIf88JFGGhH0h6dRZ7kDy5RfsiUxNFXeMQQXz0BWYrcQ=='
+#     }
+# }

tests/search/v2/test_hosts.py

@@ -820,7 +820,7 @@ def test_view_host_diff(self):
             ),
         ]
     )
-    def test_view_host_diff_params(self, kwargs, query_params):
+    def test_view_host_diff_params(self, kwargs: dict, query_params: str):
         self.responses.add(
             responses.GET,
             f"{V2_URL}/hosts/{TEST_HOST}/diff?{query_params}",
@@ -830,18 +830,9 @@ def test_view_host_diff_params(self, kwargs, query_params):
         results = self.api.view_host_diff(TEST_HOST, **kwargs)
         assert results == VIEW_HOST_DIFF_JSON["result"]
 
-    def test_view_host_events(self):
-        self.responses.add(
-            responses.GET,
-            f"{V2_URL}/experimental/hosts/{TEST_HOST}/events",
-            status=200,
-            json=VIEW_HOST_EVENTS_JSON,
-        )
-        results = self.api.view_host_events(TEST_HOST)
-        assert results == VIEW_HOST_EVENTS_JSON["result"]["events"]
-
     @parameterized.expand(
         [
+            ({}, ""),
             ({"per_page": 50}, "per_page=50"),
             (
                 {
@@ -856,12 +847,15 @@ def test_view_host_events(self):
             ),
         ]
     )
-    def test_view_host_events_params(self, kwargs, query_params):
+    def test_view_host_events_params(self, kwargs: dict, query_params: str):
+        url = f"{V2_URL}/experimental/hosts/{TEST_HOST}/events"
+        if query_params:
+            url += "?" + query_params
         self.responses.add(
             responses.GET,
-            f"{V2_URL}/experimental/hosts/{TEST_HOST}/events?{query_params}",
+            url,
             status=200,
             json=VIEW_HOST_EVENTS_JSON,
         )
         results = self.api.view_host_events(TEST_HOST, **kwargs)
-        assert results == VIEW_HOST_EVENTS_JSON["result"]["events"]
+        assert results == VIEW_HOST_EVENTS_JSON["result"]