travel_time 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5a9aeefc7ffae8034c512e9660c78656c91fa84c71de55f4b5a97c9bfaa6901
-  data.tar.gz: 2b937c7ac78351fcbae0e18a474496cd360a4aa0a75a97d5c804f97144301e8a
+  metadata.gz: 22ddf5718e4967068134f04536b54a127cedde39cb025d43a1050865971d0ec4
+  data.tar.gz: 5bad3e0cbfd81665f61cbe40e056eba8ff9104fb1f7881a7b6bd9989881a74e9
 SHA512:
-  metadata.gz: 16e978db89506fd9a64eeaa4a16de55e726879ff85c1e2eb8f0ee12079db2a3124ef59bf6c78b80b2dc7ebceb69b9180a2e01933dab04a593f6b175a832894ab
-  data.tar.gz: 4fea230701c3363d583c00b2419741fb104bacb874669ee55d190bf910dab2fce4c160f1c47d6c9cbfb046a4c29ffa44f4ebe47cc137021a7fe76c9d361bdc40
+  metadata.gz: be46a19323f7df166f72bea1e30cbb971d1b4e6bfa5951a23fe049a1c771f59a72fa72964e4d1225588ec061775f155ee27e2ee0d3be4f856addb10e06d7ed9d
+  data.tar.gz: 5effc9f42c9a2396d7ddfe75548417e5800ff93b073df6738eb260039c8a769d5aa5b3a41a8a776dc3e62ca59982380dd2857124c822d851d392337a50c5c6d1

data/README.md

@@ -356,7 +356,7 @@ Body attributes:
 * origin: Origin point.
 * destinations: Destination points. Cannot be more than 200,000.
 * country: Return the results that are within the specified country.
-* transport: Transportation type.
+* transport: Transportation type (string) or Transportation object.
 * traveltime: Time limit.
 
 ```ruby
@@ -382,6 +382,54 @@ puts(response.body)
 
 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.
 
+When picking transportation mode for proto requests take note that some of the transportation modes
+support extra configuration parameters.
+
+#### Public Transport Details
+
+```ruby
+response = client.time_filter_fast_proto(
+  country: 'UK',
+  origin: origin,
+  destinations: destinations,
+  transport: {
+    type: 'pt',
+    walking_time_to_station: 900
+  },
+  traveltime: 7200
+)
+```
+
+* `walking_time_to_station` - limits the possible duration of walking paths.
+  This limit is of low precedence and will not override the global travel time limit
+  Optional. Must be > 0 and <= 1800.
+
+#### Driving and Public Transport Details
+
+```ruby
+response = client.time_filter_fast_proto(
+  country: 'UK',
+  origin: origin,
+  destinations: destinations,
+  transport: {
+    type: 'driving+pt',
+    walking_time_to_station: 900,
+    driving_time_to_station: 900,
+    parking_time: 200,
+  },
+  traveltime: 7200
+)
+```
+
+* `walking_time_to_station` - limits the possible duration of walking paths.
+  This limit is of low precedence and will not override the global travel time limit.
+  Optional. Must be > 0 and <= 1800.
+* `driving_time_to_station` - limits the possible duration of driving paths.
+  This limit is of low precedence and will not override the global travel time limit
+  Optional. Must be > 0 and <= 1800.
+* `parking_time` - constant penalty to apply to simulate the difficulty of finding a parking spot.
+  Optional. Must be non-negative. Cannot be greater than the global travel time limit.
+
 ### [Routes](https://docs.traveltime.com/api/reference/routes)
 Returns routing information between source and destinations.
 
@@ -656,6 +704,16 @@ Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+### Updating proto files
+
+Ruby proto files are currently generated manually and pushed to the repo.
+
+If `.proto` files were changed, you can generate Ruby code like this:
+
+```bash
+# For example, if current dir is project root
+protoc --proto_path=lib/travel_time/proto/source --ruby_out=lib lib/travel_time/proto/source/*.proto
+
 ### Release
 
 To release a new version, update the version number in `version.rb` and then create a GitHub release. This will trigger

data/lib/RequestsCommon_pb.rb

@@ -0,0 +1,72 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: RequestsCommon.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("RequestsCommon.proto", :syntax => :proto3) do
+    add_message "com.igeolise.traveltime.rabbitmq.requests.Coords" do
+      optional :lat, :float, 1
+      optional :lng, :float, 2
+    end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.Transportation" do
+      optional :type, :enum, 1, "com.igeolise.traveltime.rabbitmq.requests.TransportationType"
+      oneof :transportationDetails do
+        optional :publicTransport, :message, 2, "com.igeolise.traveltime.rabbitmq.requests.PublicTransportDetails"
+        optional :drivingAndPublicTransport, :message, 3, "com.igeolise.traveltime.rabbitmq.requests.DrivingAndPublicTransportDetails"
+      end
+    end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.PublicTransportDetails" do
+      optional :walkingTimeToStation, :message, 1, "com.igeolise.traveltime.rabbitmq.requests.OptionalPositiveUInt32"
+    end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.DrivingAndPublicTransportDetails" do
+      optional :walkingTimeToStation, :message, 1, "com.igeolise.traveltime.rabbitmq.requests.OptionalPositiveUInt32"
+      optional :drivingTimeToStation, :message, 2, "com.igeolise.traveltime.rabbitmq.requests.OptionalPositiveUInt32"
+      optional :parkingTime, :message, 3, "com.igeolise.traveltime.rabbitmq.requests.OptionalNonNegativeUInt32"
+    end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.OptionalPositiveUInt32" do
+      optional :value, :uint32, 1
+    end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.OptionalNonNegativeUInt32" do
+      optional :value, :uint32, 1
+    end
+    add_enum "com.igeolise.traveltime.rabbitmq.requests.TransportationType" do
+      value :PUBLIC_TRANSPORT, 0
+      value :DRIVING, 1
+      value :DRIVING_AND_PUBLIC_TRANSPORT, 2
+      value :DRIVING_AND_FERRY, 3
+      value :WALKING, 4
+      value :WALKING_AND_FERRY, 7
+      value :CYCLING, 5
+      value :CYCLING_AND_FERRY, 6
+    end
+    add_enum "com.igeolise.traveltime.rabbitmq.requests.TimePeriod" do
+      value :WEEKDAY_MORNING, 0
+    end
+    add_enum "com.igeolise.traveltime.rabbitmq.requests.CellPropertyType" do
+      value :MEAN, 0
+      value :MIN, 1
+      value :MAX, 2
+    end
+  end
+end
+
+module Com
+  module Igeolise
+    module Traveltime
+      module Rabbitmq
+        module Requests
+          Coords = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.Coords").msgclass
+          Transportation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.Transportation").msgclass
+          PublicTransportDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.PublicTransportDetails").msgclass
+          DrivingAndPublicTransportDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.DrivingAndPublicTransportDetails").msgclass
+          OptionalPositiveUInt32 = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.OptionalPositiveUInt32").msgclass
+          OptionalNonNegativeUInt32 = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.OptionalNonNegativeUInt32").msgclass
+          TransportationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TransportationType").enummodule
+          TimePeriod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimePeriod").enummodule
+          CellPropertyType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.CellPropertyType").enummodule
+        end
+      end
+    end
+  end
+end

data/lib/{travel_time/proto/v2/TimeFilterFastRequest_pb.rb → TimeFilterFastRequest_pb.rb}

@@ -3,12 +3,13 @@
 
 require 'google/protobuf'
 
-require_relative 'RequestsCommon_pb'
+require 'RequestsCommon_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("TimeFilterFastRequest.proto", :syntax => :proto3) do
     add_message "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest" do
       optional :oneToManyRequest, :message, 1, "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.OneToMany"
+      optional :manyToOneRequest, :message, 2, "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.ManyToOne"
     end
     add_message "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.OneToMany" do
       optional :departureLocation, :message, 1, "com.igeolise.traveltime.rabbitmq.requests.Coords"
@@ -18,6 +19,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :travelTime, :sint32, 5
       repeated :properties, :enum, 6, "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.Property"
     end
+    add_message "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.ManyToOne" do
+      optional :arrivalLocation, :message, 1, "com.igeolise.traveltime.rabbitmq.requests.Coords"
+      repeated :locationDeltas, :sint32, 2
+      optional :transportation, :message, 3, "com.igeolise.traveltime.rabbitmq.requests.Transportation"
+      optional :arrivalTimePeriod, :enum, 4, "com.igeolise.traveltime.rabbitmq.requests.TimePeriod"
+      optional :travelTime, :sint32, 5
+      repeated :properties, :enum, 6, "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.Property"
+    end
     add_enum "com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.Property" do
       value :FARES, 0
       value :DISTANCES, 1
@@ -32,6 +41,7 @@ module Com
         module Requests
           TimeFilterFastRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest").msgclass
           TimeFilterFastRequest::OneToMany = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.OneToMany").msgclass
+          TimeFilterFastRequest::ManyToOne = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.ManyToOne").msgclass
           TimeFilterFastRequest::Property = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimeFilterFastRequest.Property").enummodule
         end
       end

data/lib/{travel_time/proto/v2/TimeFilterFastResponse_pb.rb → TimeFilterFastResponse_pb.rb}

@@ -31,6 +31,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :SOURCE_OUT_OF_REACH, 10
       value :INTERLEAVED_DELTAS_INVALID_COORDINATE_PAIRS, 11
       value :DISTANCE_PROPERTY_NOT_SUPPORTED, 12
+      value :BOTH_MANY_TO_ONE_AND_ONE_TO_MANY_CANNOT_BE_SENT, 13
+      value :ONE_TO_MANY_OR_MANY_TO_ONE_MUST_NOT_BE_NULL, 14
+      value :INVALID_PROTO_REQUEST, 15
     end
   end
 end

data/lib/travel_time/client.rb

@@ -3,6 +3,7 @@
 require 'faraday'
 require 'travel_time/middleware/authentication'
 require 'travel_time/middleware/proto'
+require 'travel_time/transport'
 require 'limiter'
 
 module TravelTime
@@ -143,19 +144,21 @@ module TravelTime
     end
 
     def time_filter_fast_proto(country:, origin:, destinations:, transport:, traveltime:)
-      message = ProtoUtils.make_proto_message(origin, destinations, transport, traveltime)
+      transport_obj = Transport.new(transport)
+      message = ProtoUtils.make_proto_message(origin, destinations, transport_obj, traveltime)
       payload = ProtoUtils.encode_proto_message(message)
       perform_request_proto do
-        proto_connection.post("http://proto.api.traveltimeapp.com/api/v2/#{country}/time-filter/fast/#{transport}",
+        proto_connection.post("http://proto.api.traveltimeapp.com/api/v2/#{country}/time-filter/fast/#{transport_obj.url_name}",
                               payload)
       end
     end
 
     def time_filter_fast_proto_distance(country:, origin:, destinations:, transport:, traveltime:)
-      message = ProtoUtils.make_proto_message(origin, destinations, transport, traveltime, properties: [1])
+      transport_obj = Transport.new(transport)
+      message = ProtoUtils.make_proto_message(origin, destinations, transport_obj, traveltime, properties: [1])
       payload = ProtoUtils.encode_proto_message(message)
       perform_request_proto do
-        proto_connection.post("https://proto-with-distance.api.traveltimeapp.com/api/v2/#{country}/time-filter/fast/#{transport}",
+        proto_connection.post("https://proto-with-distance.api.traveltimeapp.com/api/v2/#{country}/time-filter/fast/#{transport_obj.url_name}",
                               payload)
       end
     end

data/lib/travel_time/proto/source/RequestsCommon.proto

@@ -9,16 +9,69 @@ message Coords {
 
 message Transportation {
   TransportationType type = 1;
+
+  // override defaults for some of the transportation modes
+  oneof transportationDetails {
+    PublicTransportDetails publicTransport = 2;
+    DrivingAndPublicTransportDetails drivingAndPublicTransport = 3;
+  }
+}
+
+// semantically valid only for TransportationType.PUBLIC_TRANSPORT
+message PublicTransportDetails {
+  // limits the possible duration of walking paths
+  //
+  // walkingTimeToStation limit is of low precedence and will not override the global
+  // travel time limit
+  //
+  // walkingTimeToStation must be 0 > and <= 1800
+  // if walkingTimeToStation is not set: use service default 
+  // if walkingTimeToStation > 0: limit the path to at most this value
+  OptionalPositiveUInt32 walkingTimeToStation = 1;
+}
+
+// semantically valid only for TransportationType.DRIVING_AND_PUBLIC_TRANSPORT
+message DrivingAndPublicTransportDetails {
+  // limits the possible duration of walking paths
+  //
+  // walkingTimeToStation limit is of low precedence and will not override the global
+  // travel time limit
+  //
+  // walkingTimeToStation must be > 0 and <= 1800
+  // if walkingTimeToStation is not set: use service default
+  // if walkingTimeToStation > 0: limit the walking path to at most this value
+  OptionalPositiveUInt32 walkingTimeToStation = 1;
+
+  // limits the possible duration of driving paths
+  //
+  // drivingTimeToStation limit is of low precedence and will not override the global
+  // travel time limit
+  //
+  // drivingTimeToStation must be > 0 and <= 1800
+  // if drivingTimeToStation is not set: use service default
+  // if drivingTimeToStation > 0: limit the path to at most this value
+  OptionalPositiveUInt32 drivingTimeToStation = 2;
+
+  // constant penalty to apply to simulate the difficulty of finding a parking
+  // spot
+  //
+  // if parkingTime < 0: use service default (300s)
+  // if parkingTime >= 0: apply the parking penalty when searching for possible
+  //                      paths
+  //
+  // NOTE: parkingTime penalty cannot be greater than the global travel time
+  // limit
+  OptionalNonNegativeUInt32 parkingTime = 3;
 }
 
 enum TransportationType {
   // Considers all paths found by the following steps:
   // * up to 30 minutes of walking (always included even if no stops found)
   // * all connections in the 30 minute walking range from public transport
-  //   stops to other public transport stops in travel_time_limit, AND
+  //   stops to other public transport stops in travel_time_limit, AND 
   // * up to 30 minutes of walking from public transport stops that were visited
   //   by public transport (IOW a path
-  //     [origin]--walking->[stop]--walking-->[destination] is not possible but
+  //     [origin]--walking->[stop]--walking-->[destination] is not possible but 
   //     [origin]--walking->[stop]--public_transport-->[stop]--walking--> is.
   PUBLIC_TRANSPORT = 0;
   // Considers all paths found traveling by car from origin(s) to
@@ -30,9 +83,9 @@ enum TransportationType {
   //   to other public transport stops in travel_time_limit, AND
   // * up to 30 minutes of walking from public transport stops that were visited
   //   by public transport (IOW a path
-  //     [origin]--driving->[stop]--walking-->[destination] is not possible but
+  //     [origin]--driving->[stop]--walking-->[destination] is not possible but 
   //     [origin]--driving->[stop]--public_transport-->[stop]--walking--> is.
-  // AND/OR
+  // AND/OR 
   // * up to 30 minutes of walking
   //
   DRIVING_AND_PUBLIC_TRANSPORT = 2;
@@ -59,3 +112,25 @@ enum TransportationType {
 enum TimePeriod {
   WEEKDAY_MORNING = 0;
 }
+
+enum CellPropertyType {
+  MEAN = 0;
+  MIN = 1;
+  MAX = 2;
+}
+
+// represents an optional positive (strictly greater than 0) uint32 parameter
+//
+// the positive requirement cannot be checked at the protocol level and will
+// only be verified by the server
+message OptionalPositiveUInt32 {
+  uint32 value = 1;
+}
+
+// represents an optional non negative (greater or equal than 0) uint32 parameter
+//
+// the non negative requirement  cannot be checked at the protocol level and will only
+// be verified by the server
+message OptionalNonNegativeUInt32 {
+  uint32 value = 1;
+}

data/lib/travel_time/proto/source/TimeFilterFastRequest.proto

@@ -31,5 +31,28 @@ message TimeFilterFastRequest {
     repeated Property properties = 6;
   }
 
+  message ManyToOne {
+    Coords arrivalLocation = 1;
+    /*
+     *  We encode arrival locations as deltas (relative to the source) using a fixedpoint encoding i.e
+     *    deltaLat = round((lat - sourceLat) * 10^5).toInt
+     *    deltaLon = round((lon - sourceLon) * 10^5).toInt
+     *
+     * The deltas should be interleaved in the `locationDeltas` field i.e
+     *
+     * locationDeltas[0] should be the first lat
+     * locationDeltas[1] should be the first lon
+     * locationDeltas[2] should be the second lat
+     * ...
+     * etc
+     */
+    repeated sint32 locationDeltas = 2;
+    Transportation transportation = 3;
+    TimePeriod arrivalTimePeriod = 4;
+    sint32 travelTime = 5;
+    repeated Property properties = 6;
+  }
+
   OneToMany oneToManyRequest = 1;
-}
+  ManyToOne manyToOneRequest = 2;
+}

data/lib/travel_time/proto/source/TimeFilterFastResponse.proto

@@ -17,68 +17,82 @@ message TimeFilterFastResponse {
      /*
       * Catch all unknown error type
       */
-     UNKNOWN                                    = 0;
+     UNKNOWN                                    = 0 [deprecated = true];
      /*
       * oneToManyRequest to many field must not be null
       */
-     ONE_TO_MANY_MUST_NOT_BE_NULL               = 1;
+     ONE_TO_MANY_MUST_NOT_BE_NULL               = 1 [deprecated = true];
      /*
       * Source (either departure or arrival location) must not be null
       */
-     SOURCE_MUST_NOT_BE_NULL                    = 2;
+     SOURCE_MUST_NOT_BE_NULL                    = 2 [deprecated = true];
      /*
       * Transportation mode must not be null.
       */
-     TRANSPORTATION_MUST_NOT_BE_NULL            = 3;
+     TRANSPORTATION_MUST_NOT_BE_NULL            = 3 [deprecated = true];
      /*
       * Source (either departure or arrival location) must not be null
       */
-     SOURCE_NOT_IN_GEOMETRY                     = 4;
+     SOURCE_NOT_IN_GEOMETRY                     = 4 [deprecated = true];
 
      /*
       * Transportation mode unrecognized.
       */
-     UNRECOGNIZED_TRANSPORTATION_MODE           = 5;
+     UNRECOGNIZED_TRANSPORTATION_MODE           = 5 [deprecated = true];
 
      /*
       * The travel time limit is too low to process this request.
       */
-     TRAVEL_TIME_LIMIT_TOO_LOW                  = 6;
+     TRAVEL_TIME_LIMIT_TOO_LOW                  = 6 [deprecated = true];
 
      /*
       * The travel time limit is too high to process this request.
       */
-     TRAVEL_TIME_LIMIT_TOO_HIGH                 = 7;
+     TRAVEL_TIME_LIMIT_TOO_HIGH                 = 7 [deprecated = true];
 
      /*
       * User id not set.
       */
-     AUTH_ERROR_NO_USER_ID                      = 8;
+     AUTH_ERROR_NO_USER_ID                      = 8 [deprecated = true];
 
      /*
       * Message sent to wrong queue - transportation mode cannot be handled.
       */
-     SERVICE_MISMATCH_WRONG_TRANSPORTATION_MODE = 9;
+     SERVICE_MISMATCH_WRONG_TRANSPORTATION_MODE = 9 [deprecated = true];
 
      /*
       * Source is in a area that doesn't have any points that can be out of
       * search e.g a lake, mountains or other desolate areas.
       */
-     SOURCE_OUT_OF_REACH = 10;
+     SOURCE_OUT_OF_REACH = 10 [deprecated = true];
 
      /*
       * The interleaved deltas array should have (lat/lon) deltas and have an
       * even number of elements
       */
-     INTERLEAVED_DELTAS_INVALID_COORDINATE_PAIRS = 11;
+     INTERLEAVED_DELTAS_INVALID_COORDINATE_PAIRS = 11 [deprecated = true];
 
      /*
       * Public transport requests do not support returning distances for
       * returned points.
       */
-     DISTANCE_PROPERTY_NOT_SUPPORTED = 12;
+     DISTANCE_PROPERTY_NOT_SUPPORTED = 12 [deprecated = true];
+
+     /*
+      * ManyToOne and OneToMany cannot be sent at the same time
+      */
+     BOTH_MANY_TO_ONE_AND_ONE_TO_MANY_CANNOT_BE_SENT = 13 [deprecated = true];
+
+     /*
+      * ManyToOne or OneToMany cannot be null
+      */
+     ONE_TO_MANY_OR_MANY_TO_ONE_MUST_NOT_BE_NULL = 14 [deprecated = true];
+     /*
+      * Invalid proto request
+      */
+     INVALID_PROTO_REQUEST = 15 [deprecated = true];
   }
 
-  Error error = 1;
+  Error error = 1 [deprecated = true];
   Properties properties = 2;
 }

data/lib/travel_time/response.rb

@@ -19,7 +19,7 @@ module TravelTime
       new(
         status: response.status,
         headers: response.headers,
-        body: ProtoUtils.decode_proto_response(response.body)
+        body: response.success? ? ProtoUtils.decode_proto_response(response.body) : nil
       )
     end
 

data/lib/travel_time/transport.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module TravelTime
+  # The Transport class provides a way to set transportation details
+  class Transport
+    attr_reader :type, :code, :url_name, :details
+
+    # Define allowed details for each transport type
+    ALLOWED_DETAILS = {
+      'pt' => %i[walking_time_to_station],
+      'driving+pt' => %i[walking_time_to_station driving_time_to_station parking_time]
+    }.freeze
+
+    PROTO_TRANSPORT_MAP = {
+      pt: { code: 0, url_name: 'pt' },
+      'driving+pt': { code: 2, url_name: 'pt' },
+      driving: { code: 1, url_name: 'driving' },
+      walking: { code: 4, url_name: 'walking' },
+      cycling: { code: 5, url_name: 'driving' },
+      'driving+ferry': { code: 3, url_name: 'driving+ferry' },
+      'cycling+ferry': { code: 6, url_name: 'cycling+ferry' },
+      'walking+ferry': { code: 7, url_name: 'walking+ferry' }
+    }.freeze
+
+    def initialize(transport_input)
+      setup_type_and_details(transport_input)
+      set_transport_info
+    end
+
+    # Validate that the provided details are allowed for this transport type
+    def validate_details!
+      return if @details.empty?
+
+      validate_transport_type_supports_details
+      validate_unexpected_details
+    end
+
+    def apply_to_proto(transportation)
+      # Set the base type
+      transportation.type = @code
+
+      # Apply PublicTransport details - Only for type "pt" (code 0)
+      apply_public_transport_details(transportation) if @code.zero? && @details[:walking_time_to_station]
+
+      # Apply DrivingAndPublicTransport details - Only for type "driving+pt" (code 2)
+      apply_driving_pt_details(transportation) if @code == 2
+
+      transportation
+    end
+
+    private
+
+    def setup_type_and_details(transport_input)
+      if transport_input.is_a?(String)
+        @type = transport_input
+        @details = {}
+      else
+        @type = transport_input[:type]
+        # Ruby 3.0+ has #except which is a bit simpler, but using #reject for v2.7 compatibility
+        @details = transport_input.reject { |k, _| k == :type }
+        validate_details!
+      end
+    end
+
+    def set_transport_info
+      info = PROTO_TRANSPORT_MAP[@type.to_sym]
+      @code = info[:code]
+      @url_name = info[:url_name]
+    end
+
+    def validate_transport_type_supports_details
+      return if ALLOWED_DETAILS.key?(@type)
+
+      detail_keys = @details.keys
+      error_msg = "Transport type '#{@type}' doesn't support additional details, but #{detail_keys.join(', ')} provided"
+      raise ArgumentError, error_msg
+    end
+
+    def validate_unexpected_details
+      allowed = ALLOWED_DETAILS[@type]
+      unexpected = @details.keys - allowed
+
+      return if unexpected.empty?
+
+      allowed_msg = allowed.empty? ? 'no details' : allowed.join(', ')
+      error_msg = "Unexpected details for transport type '#{@type}': #{unexpected.join(', ')}. Allowed: #{allowed_msg}"
+      raise ArgumentError, error_msg
+    end
+
+    def create_positive_uint32(value)
+      Com::Igeolise::Traveltime::Rabbitmq::Requests::OptionalPositiveUInt32.new(value: value)
+    end
+
+    def create_non_negative_uint32(value)
+      Com::Igeolise::Traveltime::Rabbitmq::Requests::OptionalNonNegativeUInt32.new(value: value)
+    end
+
+    def set_optional_fields(details_obj, field_mappings)
+      field_mappings.each do |detail_key, field_info|
+        field_name, creator_method = field_info
+
+        details_obj.send("#{field_name}=", send(creator_method, @details[detail_key])) if @details.key?(detail_key)
+      end
+    end
+
+    # Simplified methods for each transportation type
+    def apply_public_transport_details(transportation)
+      return unless @details[:walking_time_to_station]
+
+      transport_details = Com::Igeolise::Traveltime::Rabbitmq::Requests::PublicTransportDetails.new
+      set_optional_fields(
+        transport_details, {
+          walking_time_to_station: %i[walkingTimeToStation create_positive_uint32]
+        }
+      )
+
+      transportation.publicTransport = transport_details
+    end
+
+    def apply_driving_pt_details(transportation)
+      return unless need_driving_pt_details?
+
+      transport_details = Com::Igeolise::Traveltime::Rabbitmq::Requests::DrivingAndPublicTransportDetails.new
+      set_optional_fields(
+        transport_details, {
+          walking_time_to_station: %i[walkingTimeToStation create_positive_uint32],
+          driving_time_to_station: %i[drivingTimeToStation create_positive_uint32],
+          parking_time: %i[parkingTime create_non_negative_uint32]
+        }
+      )
+
+      transportation.drivingAndPublicTransport = transport_details
+    end
+
+    def need_driving_pt_details?
+      @details[:walking_time_to_station] ||
+        @details[:driving_time_to_station] ||
+        @details.key?(:parking_time)
+    end
+  end
+end

data/lib/travel_time/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TravelTime
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

data/lib/travel_time.rb

@@ -5,7 +5,7 @@ require 'travel_time/client'
 require 'travel_time/error'
 require 'travel_time/response'
 require 'travel_time/version'
-require 'travel_time/proto/utils'
+require 'utils'
 
 # Main TravelTime module
 module TravelTime

data/lib/{travel_time/proto/utils.rb → utils.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'travel_time/proto/v2/RequestsCommon_pb'
-require 'travel_time/proto/v2/TimeFilterFastRequest_pb'
-require 'travel_time/proto/v2/TimeFilterFastResponse_pb'
+require 'RequestsCommon_pb'
+require 'TimeFilterFastRequest_pb'
+require 'TimeFilterFastResponse_pb'
 
 module TravelTime
   # Utilities for encoding/decoding protobuf requests
@@ -19,32 +19,22 @@ module TravelTime
       deltas.flatten
     end
 
-    def self.get_proto_transport_code(transport)
-      proto_transport_map = {
-        pt: 0,
-        'driving+ferry': 3,
-        'cycling+ferry': 6,
-        'walking+ferry': 7
-      }
-      proto_transport_map[transport.to_sym]
-    end
-
-    def self.make_one_to_many(origin, destinations, transport, traveltime, properties)
+    def self.make_one_to_many(origin, destinations, transport_obj, traveltime, properties)
+      transportation = Com::Igeolise::Traveltime::Rabbitmq::Requests::Transportation.new
+      transport_obj.apply_to_proto(transportation)
       Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest::OneToMany.new(
         departureLocation: origin,
         locationDeltas: build_deltas(origin, destinations),
-        transportation: Com::Igeolise::Traveltime::Rabbitmq::Requests::Transportation.new(
-          { type: get_proto_transport_code(transport) }
-        ),
+        transportation: transportation,
         arrivalTimePeriod: 0,
         travelTime: traveltime,
         properties: properties
       )
     end
 
-    def self.make_proto_message(origin, destinations, transport, traveltime, properties: nil)
+    def self.make_proto_message(origin, destinations, transport_obj, traveltime, properties: nil)
       Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest.new(
-        oneToManyRequest: make_one_to_many(origin, destinations, transport, traveltime, properties)
+        oneToManyRequest: make_one_to_many(origin, destinations, transport_obj, traveltime, properties)
       )
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travel_time
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - TravelTime Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -91,6 +91,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/RequestsCommon_pb.rb
+- lib/TimeFilterFastRequest_pb.rb
+- lib/TimeFilterFastResponse_pb.rb
 - lib/travel_time.rb
 - lib/travel_time/client.rb
 - lib/travel_time/error.rb
@@ -99,12 +102,10 @@ files:
 - lib/travel_time/proto/source/RequestsCommon.proto
 - lib/travel_time/proto/source/TimeFilterFastRequest.proto
 - lib/travel_time/proto/source/TimeFilterFastResponse.proto
-- lib/travel_time/proto/utils.rb
-- lib/travel_time/proto/v2/RequestsCommon_pb.rb
-- lib/travel_time/proto/v2/TimeFilterFastRequest_pb.rb
-- lib/travel_time/proto/v2/TimeFilterFastResponse_pb.rb
 - lib/travel_time/response.rb
+- lib/travel_time/transport.rb
 - lib/travel_time/version.rb
+- lib/utils.rb
 homepage: https://traveltime.com
 licenses:
 - MIT

data/lib/travel_time/proto/v2/RequestsCommon_pb.rb

@@ -1,44 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: RequestsCommon.proto
-
-require 'google/protobuf'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("RequestsCommon.proto", :syntax => :proto3) do
-    add_message "com.igeolise.traveltime.rabbitmq.requests.Coords" do
-      optional :lat, :float, 1
-      optional :lng, :float, 2
-    end
-    add_message "com.igeolise.traveltime.rabbitmq.requests.Transportation" do
-      optional :type, :enum, 1, "com.igeolise.traveltime.rabbitmq.requests.TransportationType"
-    end
-    add_enum "com.igeolise.traveltime.rabbitmq.requests.TransportationType" do
-      value :PUBLIC_TRANSPORT, 0
-      value :DRIVING, 1
-      value :DRIVING_AND_PUBLIC_TRANSPORT, 2
-      value :DRIVING_AND_FERRY, 3
-      value :WALKING, 4
-      value :WALKING_AND_FERRY, 7
-      value :CYCLING, 5
-      value :CYCLING_AND_FERRY, 6
-    end
-    add_enum "com.igeolise.traveltime.rabbitmq.requests.TimePeriod" do
-      value :WEEKDAY_MORNING, 0
-    end
-  end
-end
-
-module Com
-  module Igeolise
-    module Traveltime
-      module Rabbitmq
-        module Requests
-          Coords = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.Coords").msgclass
-          Transportation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.Transportation").msgclass
-          TransportationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TransportationType").enummodule
-          TimePeriod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("com.igeolise.traveltime.rabbitmq.requests.TimePeriod").enummodule
-        end
-      end
-    end
-  end
-end