fix issues (#23)

* fix typing error

* fix default value error

* fix response type

* fixes

Signed-off-by: Aayush Jain <f20180320@hyderabad.bits-pilani.ac.in>

Author: jain-aayush1123

docs/source/dest_weather.rst

@@ -85,12 +85,12 @@ Attributes
 ====================   ===============================================================================================================       ===
 Attribute              Type                                                                                                                  Doc
 ====================   ===============================================================================================================       ===
-geometry               Point or LineString or Polygon or MultiPolygon                                                                        Point or LineString or Polygon or MultiPolygon defining the route or a single location
+geometry               Point or LineString                                                                                                   Point or LineString defining the route or a single location
 start_time             :func:`datetime.datetime`                                                                                             Start time of the event
 id                     str                                                                                                                   optional Unique weather alert id.
 weather_severity       :class:`WeatherSeverity <here_location_services.config.dest_weather_config.WeatherSeverity>`                          optional Defines the severity of the weather event
 weather_type           :class:`WeatherType <here_location_services.config.dest_weather_config.WeatherType>`                                  optional Defines the type of the weather event
 country                str                                                                                                                   optional String for ISO-3166-1 2-letter country code.
 end_time               :func:`datetime.datetime`                                                                                             optional End time of the event. If not present, warning is valid until it is not removed from the feed by national weather institutes (valid until warning is present in the response)
-width                  int                                                                                                                   optional int. default 50000
+width                  int                                                                                                                   optional int.
 ====================   ===============================================================================================================       ===

here_location_services/destination_weather_api.py

@@ -8,7 +8,7 @@
 from datetime import date, datetime
 from typing import Any, Dict, List, Optional, Union
 
-from geojson import Feature, FeatureCollection, LineString, MultiPolygon, Point, Polygon
+from geojson import Feature, FeatureCollection, LineString, Point
 
 from here_location_services.platform.auth import Auth
 
@@ -93,21 +93,20 @@ def get_dest_weather(
 
     def get_weather_alerts(
         self,
-        geometry: Union[Point, LineString, Polygon, MultiPolygon],
+        geometry: Union[Point, LineString],
         start_time: datetime,
         id: Optional[str] = None,
         weather_severity: Optional[int] = None,
         weather_type: Optional[str] = None,
         country: Optional[str] = None,
         end_time: Optional[datetime] = None,
-        width: Optional[int] = 50000,
+        width: Optional[int] = None,
     ):
         """Retrieves weather reports, weather forecasts, severe weather alerts and moon and sun rise and set information.
 
         See further information `Here Destination Weather API <https://developer.here.com/documentation/destination-weather/dev_guide/topics/overview.html>_`.
 
-        :param geometry: Point or LineString or Polygon or MultiPolygon defining the route or
-            a single location
+        :param geometry: Point or LineString defining the route or a single location
         :param start_time: Start time of the event
         :param id: Unique weather alert id.
         :param weather_severity: Defines the severity of the weather event as defined
@@ -118,7 +117,7 @@ def get_weather_alerts(
         :param end_time: End time of the event. If not present, warning is valid until
             it is not removed from the feed by national weather institutes
             (valid until warning is present in the response)
-        :param width: int. default 50000
+        :param width: int
         :return: :class:`requests.Response` object.
         :raises ApiError: If ``status_code`` of API response is not 200.
         """  # noqa E501

here_location_services/ls.py

@@ -10,7 +10,7 @@
 from time import sleep
 from typing import Dict, List, Optional, Tuple, Union
 
-from geojson import LineString, MultiPolygon, Point, Polygon
+from geojson import LineString, Point
 
 from here_location_services.config.routing_config import Scooter, Via
 from here_location_services.platform.apis.aaa_oauth2_api import AAAOauth2Api
@@ -44,6 +44,7 @@
     MatrixRoutingResponse,
     ReverseGeocoderResponse,
     RoutingResponse,
+    WeatherAlertsResponse,
 )
 from .routing_api import RoutingApi
 
@@ -373,20 +374,19 @@ def get_dest_weather(
 
     def get_weather_alerts(
         self,
-        geometry: Union[Point, LineString, Polygon, MultiPolygon],
+        geometry: Union[Point, LineString],
         start_time: datetime,
         id: Optional[str] = None,
         weather_severity: Optional[int] = None,
         weather_type: Optional[str] = None,
         country: Optional[str] = None,
         end_time: Optional[datetime] = None,
-        width: Optional[int] = 50000,
-    ) -> DestinationWeatherResponse:
+        width: Optional[int] = None,
+    ) -> WeatherAlertsResponse:
         """Retrieves weather reports, weather forecasts, severe weather alerts
             and moon and sun rise and set information.
 
-        :param geometry: Point or LineString or Polygon or MultiPolygon defining the route or
-            a single location
+        :param geometry: Point or LineString defining the route or a single location
         :param start_time: Start time of the event
         :param id: Unique weather alert id.
         :param weather_severity: Defines the severity of the weather event as defined
@@ -397,10 +397,17 @@ def get_weather_alerts(
         :param end_time: End time of the event. If not present, warning is valid until
             it is not removed from the feed by national weather institutes
             (valid until warning is present in the response)
-        :param width: int. default 50000
-        :return: :class:`DestinationWeatherResponse` object.
+        :param width: int
+        :raises ValueError: If maximum width exceeds 100000 for point type geometry
+            or width exceeds 25000 for LineString geometry
+        :return: :class:`WeatherAlertsResponse` object.
         """
 
+        if type(geometry) is Point and width and width > 100000:
+            raise ValueError("Maximum width is 100000 for Point geometry")
+        if type(geometry) is LineString and width and width > 25000:
+            raise ValueError("Maximum width is 25000 for LineString geometry")
+
         resp = self.destination_weather_api.get_weather_alerts(
             geometry=geometry,
             id=id,
@@ -411,7 +418,7 @@ def get_weather_alerts(
             end_time=end_time,
             width=width,
         )
-        response = DestinationWeatherResponse.new(resp.json())
+        response = WeatherAlertsResponse.new(resp.json())
         return response
 
     def discover(

here_location_services/responses.py

@@ -200,6 +200,28 @@ class DestinationWeatherResponse(ApiResponse):
 
     def __init__(self, **kwargs):
         super().__init__()
-        self._filters = {"places": None, "features": None}
+        self._filters = {"places": None}
         for param, default in self._filters.items():
             setattr(self, param, kwargs.get(param, default))
+
+    def to_geojson(self):
+        """Return API response as GeoJSON."""
+        raise NotImplementedError("This method is not valid for DestinationWeatherResponse.")
+
+
+class WeatherAlertsResponse(ApiResponse):
+    """A class representing the Destination Weather API response data."""
+
+    def __init__(self, **kwargs):
+        super().__init__()
+        self._filters = {"features": None}
+        for param, default in self._filters.items():
+            setattr(self, param, kwargs.get(param, default))
+
+    def to_geojson(self):
+        """Return API response as GeoJSON."""
+        feature_collection = FeatureCollection([])
+        for feature in self.response["features"]:
+            f = Feature(geometry=feature["geometry"], properties=feature["properties"])
+            feature_collection.features.append(f)
+        return feature_collection

tests/test_ls.py

@@ -8,6 +8,7 @@
 import pytest
 import pytz
 from geojson import FeatureCollection, Point
+from geojson.geometry import LineString
 
 from here_location_services import LS
 from here_location_services.config.autosuggest_config import POLITICAL_VIEW, SHOW, SearchCircle
@@ -63,11 +64,13 @@ def test_ls_weather_alerts():
     """Test weather alerts endpoint of destination weather api."""
     ls = LS(api_key=LS_API_KEY)
     resp = ls.get_weather_alerts(
-        geometry=Point(coordinates=[15.256, 23.456]),
+        geometry=LineString([(8.919, 44.4074), (8.923, 44.4075)]),
         start_time=datetime.now(),
-        width=3000,
+        width=25000,
     )
     assert resp
+    geo_json = resp.to_geojson()
+    assert geo_json.type == "FeatureCollection"
 
     resp2 = ls.get_weather_alerts(
         geometry=Point(coordinates=[15.256, 23.456]),
@@ -79,6 +82,20 @@ def test_ls_weather_alerts():
     )
     assert resp2
 
+    with pytest.raises(ValueError):
+        ls.get_weather_alerts(
+            geometry=LineString([(8.919, 44.4074), (8.923, 44.4075)]),
+            start_time=datetime.now(),
+            width=50000,
+        )
+
+    with pytest.raises(ValueError):
+        ls.get_weather_alerts(
+            geometry=Point(coordinates=[15.256, 23.456]),
+            start_time=datetime.now(),
+            width=1000000,
+        )
+
     with pytest.raises(ApiError):
         ls2 = LS(api_key="dummy")
         ls2.get_weather_alerts(