travel_time 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dad4d1a6f18d988d831dea4314c3f0f829279ed55448f44c923579fa49d1279
-  data.tar.gz: 7cfeb8f99c2c2be5145f38db72ba6b6865856d33cf935f401e445ca6d2764a3c
+  metadata.gz: 5a23e77e0a13c15dd74597ba0abe967096943c12c51493d9339793e4999d42ca
+  data.tar.gz: 8fe9d9beaf181102198577a66a93e3de64611305b720a72e2d9fc89929824291
 SHA512:
-  metadata.gz: 4b256ea7bfccf4754389a66a9e30ae4457838b793b295b5d12832408fa169d4c970443753194c2c54f49a73839a675f4d97005a9d1dc626631ab65a909ae55db
-  data.tar.gz: 5f79e53285c09f08123d8187f60f35882174663da1b85aa95420669ed87b867cb8024e7e5e5907b67398c8f9db520c7c4beed94afad314cdc82924ecec135a13
+  metadata.gz: 1bf0ae042c2c1d6f8721a6c9f69b4df925429462894b5d375a5075b0489897249577cc41397ecef6fd75229f3165e4e6acd0f498c02773e0833850199cf2f315
+  data.tar.gz: 23e1e54ee47eaf2b3921f8f62b66f3c11d44073997c9d7af545a805c8af621b6727088937c1bae3946544b17bb01fa3267fcfaf10f661a92c6461b2ead90efef

data/README.md

@@ -348,16 +348,17 @@ puts response.body
 ### [Time Filter Fast (Proto)](https://docs.traveltime.com/api/reference/travel-time-distance-matrix-proto)
 A fast version of time filter communicating using [protocol buffers](https://github.com/protocolbuffers/protobuf).
 
-The request parameters are much more limited and only travel time is returned. In addition, the results are only approximately correct (95% of the results are guaranteed to be within 5% of the routes returned by regular time filter).
-
-This inflexibility comes with a benefit of faster response times (Over 5x faster compared to regular time filter) and larger limits on the amount of destination points.
-
 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 (string) or Transportation object.
 * traveltime: Time limit.
+* with_distance: (Optional) If true, returns distances in addition to travel times.
+* request_type: (Optional) Specifies the request type - either `TravelTime::ProtoUtils::ONE_TO_MANY` (default) or `TravelTime::ProtoUtils::MANY_TO_ONE`.
+
+#### One-to-Many (default)
+Search from a single origin to multiple destinations:
 
 ```ruby
 origin = {
@@ -375,7 +376,34 @@ response = client.time_filter_fast_proto(
   origin: origin,
   destinations: destinations,
   transport: 'driving+ferry',
-  traveltime: 7200
+  traveltime: 7200,
+  with_distance: true, # To also get distances, optional
+  request_type: TravelTime::ProtoUtils::ONE_TO_MANY # Optional
+)
+puts(response.body)
+```
+
+#### Many-to-One
+Search from multiple origins to a single destination:
+
+```ruby
+arrival = {
+  lat: 51.508930,
+  lng: -0.131387,
+}
+
+origins = [
+  { lat: 51.508824, lng: -0.167093 },
+  { lat: 51.536067, lng: -0.153596 }
+]
+
+response = client.time_filter_fast_proto(
+  country: 'UK',
+  origin: arrival,              # arrival/destination point
+  destinations: origins,        # departure/origin points
+  transport: 'public_transport',
+  traveltime: 3600,
+  request_type: TravelTime::ProtoUtils::MANY_TO_ONE
 )
 puts(response.body)
 ```
@@ -501,6 +529,143 @@ response = client.routes(
 puts response.body
 ```
 
+### [H3](https://docs.traveltime.com/api/reference/h3)
+Returns travel time statistics for H3 cells in catchment areas.
+
+Body attributes:
+* resolution: H3 resolution level (higher = more granular cells).
+  Limitations can be found [here](https://docs.traveltime.com/api/reference/h3#limits-of-resolution-and-traveltime).
+* properties: Statistical properties to calculate for each H3 cell ('min', 'max', 'mean').
+* departure_searches: Departure-based searches with specific departure times.
+* arrival_searches: Arrival-based searches with specific arrival times.
+* unions: Union operations combining multiple search results.
+* intersections: Intersection operations finding overlapping areas.
+
+```ruby
+require 'time'
+
+departure_search = {
+  id: 'public transport from Trafalgar Square',
+  departure_time: Time.now.iso8601,
+  travel_time: 1800,
+  coords: { lat: 51.507609, lng: -0.128315 },
+  transportation: { type: 'public_transport' }
+}
+
+arrival_search = {
+  id: 'public transport to Hyde Park',
+  arrival_time: Time.now.iso8601,
+  travel_time: 1800,
+  coords: { lat: 51.508530, lng: -0.163925 },
+  transportation: { type: 'public_transport' }
+}
+
+response = client.h3(
+  resolution: 5,
+  properties: ['min', 'max', 'mean'],
+  departure_searches: [departure_search],
+  arrival_searches: [arrival_search]
+)
+
+puts response.body
+```
+
+### [H3 Fast](https://docs.traveltime.com/api/reference/h3-fast)
+A high performance version of the H3 endpoint. Returns travel time statistics for H3 cells in catchment areas.
+
+Body attributes:
+* resolution: H3 resolution level (higher = more granular cells, allowed values differ based on `travel_time`.
+  Limitations can be found [here](https://docs.traveltime.com/api/reference/h3-fast#limits-of-resolution-and-traveltime).
+* properties: Statistical properties to calculate for each H3 cell ('min', 'max', 'mean').
+* arrival_searches: Arrival-based searches with specific arrival times.
+* unions: Union operations combining multiple search results.
+* intersections: Intersection operations finding overlapping areas.
+
+```ruby
+require 'time'
+
+arrival_search = {
+  one_to_many: [{
+    id: 'public transport from Trafalgar Square',
+    arrival_time_period: 'weekday_morning',
+    travel_time: 1800,
+    coords: { lat: 51.507609, lng: -0.128315 },
+    transportation: { type: 'public_transport' }
+  }]
+}
+
+response = client.h3_fast(
+  resolution: 5,
+  properties: ['min', 'max', 'mean'],
+  arrival_searches: arrival_search
+)
+
+puts response.body
+```
+
+### [Geohash](https://docs.traveltime.com/api/reference/geohash)
+Returns travel times to geohash cells within travel time catchment areas.
+
+Body attributes:
+* resolution: Geohash resolution level (1-6).
+* properties: Statistical properties to calculate for each geohash cell ('min', 'max', 'mean').
+* departure_searches: Departure-based searches with specific departure times.
+* arrival_searches: Arrival-based searches with specific arrival time.
+* unions: Union operations combining multiple search results.
+* intersections: Intersection operations finding overlapping areas.
+
+```ruby
+require 'time'
+
+departure_search = {
+  id: 'public transport from Trafalgar Square',
+  departure_time: Time.now.iso8601,
+  travel_time: 1800,
+  coords: { lat: 51.507609, lng: -0.128315 },
+  transportation: { type: 'public_transport' }
+}
+
+response = client.geohash(
+  resolution: 3,
+  properties: ['min', 'max', 'mean'],
+  departure_searches: [departure_search]
+)
+
+puts response.body
+```
+
+### [Geohash Fast](https://docs.traveltime.com/api/reference/geohash-fast)
+A high performance version of the Geohash endpoint. Returns travel times to geohash cells within travel time catchment areas.
+
+Body attributes:
+* resolution: Geohash resolution level (1-6).
+* properties: Statistical properties to calculate for each geohash cell ('min', 'max', 'mean').
+* arrival_searches: Arrival-based searches with specific arrival times.
+* unions: Union operations combining multiple search results.
+* intersections: Intersection operations finding overlapping areas.
+
+```ruby
+require 'time'
+
+arrival_search = {
+  one_to_many: [{
+    id: 'public transport from Trafalgar Square',
+    arrival_time_period: 'weekday_morning',
+    travel_time: 1800,
+    coords: { lat: 51.507609, lng: -0.128315 },
+    transportation: { type: 'public_transport' }
+  }]
+}
+
+response = client.geohash_fast(
+  resolution: 3,
+  properties: ['min', 'max', 'mean'],
+  arrival_searches: arrival_search
+)
+
+puts response.body
+```
+
 ### [Geocoding (Search)](https://docs.traveltime.com/api/reference/geocoding-search) 
 Match a query string to geographic coordinates.
 
@@ -674,11 +839,11 @@ This is optional, but enables you not installing gems to system directories.
 
 1. Install RVM: https://rvm.io/
 2. Optional gnome-terminal integration: https://rvm.io/integration/gnome-terminal
-3. Install and set up Ruby with RVM:
+3. Install and set up Ruby with RVM (Ruby 3.2 or higher required):
 ```shell
-rvm install ruby-3.2.2
-rvm alias create default ruby-3.2.2
-rvm use ruby-3.2.2
+rvm install ruby-3.3.8
+rvm alias create default ruby-3.3.8
+rvm use ruby-3.3.8
 rvm gemset create traveltime-sdk
 ```
 

data/lib/travel_time/client.rb

@@ -10,6 +10,7 @@ module TravelTime
   # The Client class provides the main interface to interact with the TravelTime API
   class Client # rubocop:disable Metrics/ClassLength
     extend Limiter::Mixin
+
     API_BASE_URL = 'https://api.traveltimeapp.com/v4/'
 
     attr_reader :connection, :proto_connection
@@ -143,9 +144,13 @@ module TravelTime
       perform_request { connection.post('time-filter/fast', payload) }
     end
 
-    def time_filter_fast_proto(country:, origin:, destinations:, transport:, traveltime:)
+    def time_filter_fast_proto(country:, origin:, destinations:, transport:, traveltime:, with_distance: false,
+                               request_type: nil)
       transport_obj = Transport.new(transport)
-      message = ProtoUtils.make_proto_message(origin, destinations, transport_obj, traveltime)
+      distance_prop = Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest::Property::DISTANCES
+      properties = with_distance ? [distance_prop] : nil
+      message = ProtoUtils.make_proto_message(origin, destinations, transport_obj, traveltime,
+                                              properties: properties, request_type: request_type)
       payload = ProtoUtils.encode_proto_message(message)
       perform_request_proto do
         proto_connection.post("http://proto.api.traveltimeapp.com/api/v3/#{country}/time-filter/fast/#{transport_obj.url_name}",
@@ -153,18 +158,6 @@ module TravelTime
       end
     end
 
-    def time_filter_fast_proto_distance(country:, origin:, destinations:, transport:, traveltime:)
-      transport_obj = Transport.new(transport)
-      message = ProtoUtils.make_proto_message(origin, destinations, transport_obj, traveltime, properties: [1])
-      payload = ProtoUtils.encode_proto_message(message)
-
-      # FIXME: proto-with-distance is longer used
-      perform_request_proto do
-        proto_connection.post("https://proto-with-distance.api.traveltimeapp.com/api/v3/#{country}/time-filter/fast/#{transport_obj.url_name}",
-                              payload)
-      end
-    end
-
     def time_filter_postcodes(departure_searches: nil, arrival_searches: nil)
       payload = {
         departure_searches: departure_searches,
@@ -197,5 +190,52 @@ module TravelTime
       }.compact
       perform_request { connection.post('routes', payload) }
     end
+
+    def h3(resolution:, properties:, departure_searches: nil, arrival_searches: nil, unions: nil, intersections: nil)
+      payload = {
+        resolution: resolution,
+        properties: properties,
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact
+      perform_request { connection.post('h3', payload) }
+    end
+
+    def h3_fast(resolution:, properties:, arrival_searches:, unions: nil, intersections: nil)
+      payload = {
+        resolution: resolution,
+        properties: properties,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact
+      perform_request { connection.post('h3/fast', payload) }
+    end
+
+    def geohash(resolution:, properties:, departure_searches: nil, arrival_searches: nil, unions: nil,
+                intersections: nil)
+      payload = {
+        resolution: resolution,
+        properties: properties,
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact
+      perform_request { connection.post('geohash', payload) }
+    end
+
+    def geohash_fast(resolution:, properties:, arrival_searches:, unions: nil, intersections: nil)
+      payload = {
+        resolution: resolution,
+        properties: properties,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact
+      perform_request { connection.post('geohash/fast', payload) }
+    end
   end
 end

data/lib/travel_time/transport.rb

@@ -56,8 +56,7 @@ module TravelTime
         @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 }
+        @details = transport_input.except(:type)
         validate_details!
       end
     end

data/lib/travel_time/version.rb

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

data/lib/utils.rb

@@ -7,6 +7,10 @@ require 'TimeFilterFastResponse_pb'
 module TravelTime
   # Utilities for encoding/decoding protobuf requests
   class ProtoUtils
+    # Request type constants
+    ONE_TO_MANY = :one_to_many
+    MANY_TO_ONE = :many_to_one
+
     def self.encode_fixed_point(source, target)
       ((target - source) * 10.pow(5)).round
     end
@@ -32,12 +36,34 @@ module TravelTime
       )
     end
 
-    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_obj, traveltime, properties)
+    def self.make_many_to_one(arrival, origins, transport_obj, traveltime, properties)
+      transportation = Com::Igeolise::Traveltime::Rabbitmq::Requests::Transportation.new
+      transport_obj.apply_to_proto(transportation)
+      Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest::ManyToOne.new(
+        arrivalLocation: arrival,
+        locationDeltas: build_deltas(arrival, origins),
+        transportation: transportation,
+        arrivalTimePeriod: 0,
+        travelTime: traveltime,
+        properties: properties
       )
     end
 
+    def self.make_proto_message(origin, destinations, transport_obj, traveltime, properties: nil, request_type: nil)
+      request_type ||= ONE_TO_MANY
+      request = Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest.new
+
+      if request_type == ONE_TO_MANY
+        request.oneToManyRequest = make_one_to_many(origin, destinations, transport_obj, traveltime, properties)
+      elsif request_type == MANY_TO_ONE
+        request.manyToOneRequest = make_many_to_one(origin, destinations, transport_obj, traveltime, properties)
+      else
+        raise ArgumentError, "Invalid request_type: #{request_type}. Must be ONE_TO_MANY or MANY_TO_ONE"
+      end
+
+      request
+    end
+
     def self.encode_proto_message(message)
       Com::Igeolise::Traveltime::Rabbitmq::Requests::TimeFilterFastRequest.encode(message)
     end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: travel_time
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - TravelTime Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-17 00:00:00.000000000 Z
+date: 2025-11-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
 description: TravelTime SDK for Ruby programming language
 email:
 - support@traveltime.com
@@ -121,14 +135,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: TravelTime SDK for Ruby programming language