Added small change to NGD API sync to allow usage of NGDFeatureCollection

Author: jmbraybrook

src/osdatahub/NGD/ngd_api.py

@@ -10,6 +10,7 @@
 import osdatahub
 from osdatahub import Extent
 from osdatahub.NGD.crs import get_crs
+from osdatahub.NGD.models import NGDFeatureCollection
 
 
 def _merge_geojsons(gj1: Union[dict], gj2: Union[dict]) -> Union[dict]:
@@ -96,7 +97,8 @@ def query(
         filter_crs: Union[str, int, None] = None,
         max_results: int = 100,
         offset: int = 0,
-    ) -> Union[dict]:
+        output_as_collection: bool = False
+    ) -> Union[dict, NGDFeatureCollection]:
         """
         Retrieves features from a Collection
 
@@ -121,9 +123,11 @@ def query(
             max_results (int, optional): The maximum number of features to return. Defaults to 100
             offset (int, optional): The offset number skips past the specified number of features in the collection.
                 Defaults to 0
-
-        Returns:
-            FeatureCollection: The results of the query in GeoJSON format
+            output_as_collection (bool, optional): Outputs as a NGDFeatureCollection which is more pythonic and structured.
+                Defaults to False to ensure backwards compatibility. 
+        Returns either:
+            Dict: The results of the query in GeoJSON format (if output_as_collection is set to False)
+            NGDFeatureCollection: The results of the query in structured form (if output_as_collection is set to True)
         """
 
         assert max_results > 0, (
@@ -209,9 +213,16 @@ def query(
             else:
                 n_required -= resp_json["numberReturned"]
 
+        # Added to allow the NGD Sync to work with the NGD ASync
+        if output_as_collection:
+            data = NGDFeatureCollection.from_dict(data)
+
         return data
 
-    def query_feature(self, feature_id: str, crs: Union[str, int] = None) -> dict:
+    def query_feature(self, 
+                      feature_id: str, 
+                      crs: Union[str, int] = None
+                      ) -> dict:
         """
         Retrieves a single feature from a collection
 

tests/test_ngd.py

@@ -5,6 +5,7 @@
 import pytest
 from osdatahub.NGD.crs import get_crs
 from osdatahub.NGD.ngd_api import _merge_geojsons, NGD
+from osdatahub.NGD.models import NGDFeatureCollection
 
 from tests.data import ngd_crs_data as crs_data
 from tests.data import ngd_merge_geojsons_data as merge_geojsons_data
@@ -94,6 +95,24 @@ def test_ngd_api_call(self, collection, extent, crs, start_datetime, end_datetim
 
         assert len(results["features"]) == max_results
 
+    @pytest.mark.skipif(not API_KEY, reason="Test API key not available")
+    @pytest.mark.parametrize(*query_data.test_ngd_query_live())
+    def test_ngd_api_call_collection(self, collection, extent, crs, start_datetime, end_datetime, cql_filter, filter_crs,
+                          max_results, offset):
+        ngd = NGD(key=API_KEY, collection=collection)
+        results = ngd.query(extent=extent,
+                  crs=crs,
+                  start_datetime=start_datetime,
+                  end_datetime=end_datetime,
+                  cql_filter=cql_filter,
+                  filter_crs=filter_crs,
+                  max_results=max_results,
+                  offset=offset,
+                  output_to_collection=True
+                )
+
+        assert type(results) is NGDFeatureCollection
+        assert len(results.features) == max_results
 
 class TestNGDGetCollections:
     @mock.patch('osdatahub.get')