Merge pull request #90 from traveltime-dev/add-distance-proto

Added distance calculation support for proto

README.md

@@ -342,17 +342,19 @@ larger limits on the amount of destination points.
 * country: ProtoCountry - Return the results that are within the specified country.
 * one_to_many: boolean - if one_to_many is equal to true, then it'll be a forward search (one to many matrix), false -
   backward search (many to one matrix). Default value is True.
+* properties: List[PropertyProto] - specifies which extra properties should be calculated in the response. 
 
 #### Returns:
 
-* travel_times: List[int] - The responses are in the form of a list where each position denotes either a travel time (in
-  seconds) of a journey, or if negative that the journey from the origin to the destination point is impossible.
-
+* results: TimeFilterProtoResponse - The response contains:
+  * list of travel times, where each position denotes either a travel time (in seconds)
+    of a journey, or if travel time is negative, that the journey from the origin to the destination point is impossible. 
+  * (optional) list of distances where each position denotes distance (in meters) to the specified location. 
 #### Example:
 
 ```python
 import asyncio
-from traveltimepy import ProtoCountry, Coordinates, ProtoTransportation, TravelTimeSdk
+from traveltimepy import ProtoCountry, Coordinates, ProtoTransportation, TravelTimeSdk, PropertyProto
 
 async def main():
     sdk = TravelTimeSdk("YOUR_APP_ID", "YOUR_APP_KEY")
@@ -364,7 +366,8 @@ async def main():
         ],
         transportation=ProtoTransportation.DRIVING_FERRY,
         travel_time=7200,
-        country=ProtoCountry.UNITED_KINGDOM
+        country=ProtoCountry.UNITED_KINGDOM,
+        properties=[PropertyProto.DISTANCE],
     )
 
     print(travel_times)

tests/time_filter_proto_test.py

@@ -1,6 +1,7 @@
 import pytest
 
 from traveltimepy import Coordinates
+from traveltimepy.dto.common import PropertyProto
 from traveltimepy.dto.requests.time_filter_proto import (
     ProtoTransportation,
     ProtoCountry,
@@ -9,7 +10,7 @@
 
 @pytest.mark.asyncio
 async def test_one_to_many(proto_sdk):
-    travel_times = await proto_sdk.time_filter_proto_async(
+    results = await proto_sdk.time_filter_proto_async(
         origin=Coordinates(lat=51.425709, lng=-0.122061),
         destinations=[
             Coordinates(lat=51.348605, lng=-0.314783),
@@ -19,12 +20,12 @@ async def test_one_to_many(proto_sdk):
         travel_time=7200,
         country=ProtoCountry.UNITED_KINGDOM,
     )
-    assert len(travel_times) == 2
+    assert len(results.travel_times) == 2 and len(results.distances) == 0
 
 
 @pytest.mark.asyncio
 async def test_many_to_one(proto_sdk):
-    travel_times = await proto_sdk.time_filter_proto_async(
+    results = await proto_sdk.time_filter_proto_async(
         origin=Coordinates(lat=51.425709, lng=-0.122061),
         destinations=[
             Coordinates(lat=51.348605, lng=-0.314783),
@@ -33,6 +34,39 @@ async def test_many_to_one(proto_sdk):
         transportation=ProtoTransportation.DRIVING_FERRY,
         travel_time=7200,
         country=ProtoCountry.UNITED_KINGDOM,
-        one_to_many=False
+        one_to_many=False,
     )
-    assert len(travel_times) == 2
+    assert len(results.travel_times) == 2 and len(results.distances) == 0
+
+
+@pytest.mark.asyncio
+async def test_one_to_many_with_distances(proto_sdk):
+    results = await proto_sdk.time_filter_proto_async(
+        origin=Coordinates(lat=51.425709, lng=-0.122061),
+        destinations=[
+            Coordinates(lat=51.348605, lng=-0.314783),
+            Coordinates(lat=51.337205, lng=-0.315793),
+        ],
+        transportation=ProtoTransportation.DRIVING_FERRY,
+        travel_time=7200,
+        country=ProtoCountry.UNITED_KINGDOM,
+        properties=[PropertyProto.DISTANCE],
+    )
+    assert len(results.travel_times) == 2 and len(results.distances) == 2
+
+
+@pytest.mark.asyncio
+async def test_many_to_one_with_distances(proto_sdk):
+    results = await proto_sdk.time_filter_proto_async(
+        origin=Coordinates(lat=51.425709, lng=-0.122061),
+        destinations=[
+            Coordinates(lat=51.348605, lng=-0.314783),
+            Coordinates(lat=51.337205, lng=-0.315793),
+        ],
+        transportation=ProtoTransportation.DRIVING_FERRY,
+        travel_time=7200,
+        country=ProtoCountry.UNITED_KINGDOM,
+        one_to_many=False,
+        properties=[PropertyProto.DISTANCE],
+    )
+    assert len(results.travel_times) == 2 and len(results.distances) == 2

traveltimepy/__init__.py

@@ -18,6 +18,7 @@
     Coordinates,
     Location,
     Property,
+    PropertyProto,
     FullRange,
     Range,
     Rectangle,
@@ -43,6 +44,7 @@
     "Coordinates",
     "Location",
     "Property",
+    "PropertyProto",
     "FullRange",
     "Range",
     "Rectangle",

traveltimepy/dto/common.py

@@ -107,6 +107,10 @@ class Property(str, Enum):
     FARES = "fares"
 
 
+class PropertyProto(int, Enum):
+    DISTANCE = 1
+
+
 class FullRange(BaseModel):
     enabled: bool
     max_results: int

traveltimepy/dto/responses/time_filter_proto.py

@@ -5,3 +5,4 @@
 
 class TimeFilterProtoResponse(BaseModel):
     travel_times: List[int]
+    distances: List[int]

traveltimepy/mapper.py

@@ -13,6 +13,7 @@
     Property,
     Range,
     LevelOfDetail,
+    PropertyProto,
 )
 from traveltimepy.dto.transportation import (
     PublicTransport,
@@ -667,6 +668,7 @@ def create_proto_request(
     origin: Coordinates,
     destinations: List[Coordinates],
     transportation: ProtoTransportation,
+    properties: Optional[List[PropertyProto]],
     travel_time: int,
     one_to_many: bool = True,
 ) -> TimeFilterFastRequest_pb2.TimeFilterFastRequest:
@@ -681,6 +683,8 @@ def create_proto_request(
         request.oneToManyRequest.arrivalTimePeriod = (
             TimeFilterFastRequest_pb2.TimePeriod.WEEKDAY_MORNING
         )
+        if properties is not None:
+            request.oneToManyRequest.properties.extend(properties)
 
         mult = math.pow(10, 5)
         for destination in destinations:
@@ -696,6 +700,8 @@ def create_proto_request(
         request.manyToOneRequest.arrivalTimePeriod = (
             TimeFilterFastRequest_pb2.TimePeriod.WEEKDAY_MORNING
         )
+        if properties is not None:
+            request.manyToOneRequest.properties.extend(properties)
 
         mult = math.pow(10, 5)
         for destination in destinations:

traveltimepy/proto_http.py

@@ -14,7 +14,7 @@ async def send_proto_async(
     data: TimeFilterFastRequest,
     app_id: str,
     api_key: str,
-) -> TimeFilterFastResponse:
+) -> TimeFilterProtoResponse:
     async with ClientSession(connector=TCPConnector(ssl=False)) as session:
         async with session.post(
             url=url,
@@ -36,5 +36,6 @@ async def _process_response(response: ClientResponse) -> TimeFilterProtoResponse
         response_body = TimeFilterFastResponse()
         response_body.ParseFromString(content)
         return TimeFilterProtoResponse(
-            travel_times=response_body.properties.travelTimes[:]
+            travel_times=response_body.properties.travelTimes[:],
+            distances=response_body.properties.distances[:],
         )

traveltimepy/sdk.py

@@ -9,7 +9,9 @@
     FullRange,
     Range,
     LevelOfDetail,
+    PropertyProto,
 )
+from traveltimepy.dto.responses.time_filter_proto import TimeFilterProtoResponse
 from traveltimepy.dto.transportation import (
     PublicTransport,
     Driving,
@@ -361,17 +363,23 @@ async def time_filter_proto_async(
         transportation: ProtoTransportation,
         travel_time: int,
         one_to_many: bool = True,
-    ) -> List[int]:
+        properties: Optional[List[PropertyProto]] = None,
+    ) -> TimeFilterProtoResponse:
         resp = await send_proto_async(
             f"https://{self._sdk_params.proto_host}/api/v2/{country.value}/time-filter/fast/{transportation.value.name}",  # noqa
             self._proto_headers(),
             create_proto_request(
-                origin, destinations, transportation, travel_time, one_to_many
+                origin,
+                destinations,
+                transportation,
+                properties,
+                travel_time,
+                one_to_many,
             ),
             self._app_id,
             self._api_key,
         )
-        return resp.travel_times
+        return resp
 
     async def intersection_async(
         self,

traveltimepy/version.py

@@ -1 +1 @@
-__version__ = "3.6.2"
+__version__ = "3.7.0"