travel_time 0.5.1 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf2f0de892f4913899dc12a618af54bdc0d0cd531233407608e9f95962900c8
-  data.tar.gz: d78ae9c592b7c8dbab7c29204f81543cda363dc03928182fe34243e7c5893951
+  metadata.gz: 980351a64bc02a09468036537289c94c69e92524ced3303539a4849254f1ad6b
+  data.tar.gz: 70232585d25f0a8dfa63b4f4b4a2fef827381e509ded12f3f641cfff58c88482
 SHA512:
-  metadata.gz: de6eda8e48059030a5f42fce898f444fd9ff93cdf0e0d22357f038ffc65e989fc818fe0adc2d97479ded35bc469fc20d1477c811390ab6e810a91825e270be76
-  data.tar.gz: 57ae66632a19f79ee6f8649551b6f4a397634d60a025c98e047c511e257a0e813fcd77699d9a4fe952b373e2b3d954ca497e05a57a01e346d169854024f7e805
+  metadata.gz: 7f5c2aec26726acb47a74cfdd6608a0db0243fcfb7fa8c24ab4e86e9bf36bad03294b16bbeb8cbe6d1b1b671c801fb34227a140e1e6053b9612213e12e270d70
+  data.tar.gz: 8c43d33f903df991fa35162d170ef71fa9ebb44cf21dd1570e718ae8e6adf98bbf825117dc4235dc38b843a4956f664f62e42968f03fb98461082569af78336d

data/README.md

@@ -3,9 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/travel_time.svg)](https://rubygems.org/gems/travel_time)
 [![GitHub Actions CI](https://github.com/traveltime-dev/traveltime-sdk-ruby/workflows/CI/badge.svg)](https://github.com/traveltime-dev/traveltime-sdk-ruby/actions?query=workflow%3ACI)
 
-
-This open-source library allows you to access [TravelTime API](https://docs.traveltime.com/overview/introduction)
-endpoints.
+[Travel Time](https://docs.traveltime.com/api/overview/introduction) Ruby SDK helps users find locations by journey time rather than using ‘as the crow flies’ distance. Time-based searching gives users more opportunities for personalisation and delivers a more relevant search.
 
 ## Installation
 
@@ -30,7 +28,7 @@ In order to be able to call the API, you'll first need to set your Application I
 ```ruby
 TravelTime.configure do |config|
   config.application_id = '<your app id>'
-  config.api_key = '<your api key>'
+  config.api_key = '<your app key>'
 end
 ```
 
@@ -70,11 +68,16 @@ departure_search = {
 client.time_map(departure_searches: [departure_search])
 ```
 
-
 ### [Isochrones (Time Map)](https://traveltime.com/docs/api/reference/isochrones)
 Given origin coordinates, find shapes of zones reachable within corresponding travel time.
 Find unions/intersections between different searches.
 
+Body attributes:
+* departure_searches: Searches based on departure times. Leave departure location at no earlier than given time. You can define a maximum of 10 searches.
+* arrival_searches: Searches based on arrival times. Arrive at destination location at no later than given time. You can define a maximum of 10 searches.
+* unions: Define unions of shapes that are results of previously defined searches.
+* intersections: Define intersections of shapes that are results of previously defined searches.
+
 ```ruby
 require 'time'
 
@@ -133,25 +136,14 @@ arrival_search = {
     lng: -0.128050
   },
   transportation: { type: "public_transport" },
-  arrival_time: Time.now.iso8601,
+  arrival_time_period: 'weekday_morning',
   travel_time: 1800,
 }
 
-union = {
-  id: 'union of driving and public transport',
-  search_ids: ['public transport from Trafalgar Square', 'public transport to Trafalgar Square']
-}
-intersection = {
-  id: 'intersection of driving and public transport',
-  search_ids: ['public transport from Trafalgar Square', 'public transport to Trafalgar Square']
-}
-
 response = client.time_map_fast(
   arrival_searches: {
     one_to_many: [arrival_search]
-  }, 
-  unions: [union], 
-  intersections: [intersection]
+  },
 )
 
 puts response.body
@@ -161,6 +153,11 @@ puts response.body
 Given origin and destination points filter out points that cannot be reached within specified time limit.
 Find out travel times, distances and costs between an origin and up to 2,000 destination points.
 
+Body attributes:
+* locations: Locations to use. Each location requires an id and lat/lng values
+* departure_searches: Searches based on departure times. Leave departure location at no earlier than given time. You can define a maximum of 10 searches
+* arrival_searches: Searches based on arrival times. Arrive at destination location at no later than given time. You can define a maximum of 10 searches
+
 ```ruby
 require 'time'
 
@@ -218,74 +215,8 @@ response = client.time_filter(
 puts response.body
 ```
 
-### [Routes](https://traveltime.com/docs/api/reference/routes)
-Returns routing information between source and destinations.
-
-```ruby
-require 'time'
-
-locations = [{
-  id: 'London center',
-  coords: {
-    lat: 51.508930,
-    lng: -0.131387
-  }
-},
-{
-  id: 'Hyde Park',
-  coords: {
-    lat: 51.508824,
-    lng: -0.167093
-  }
-},
-{
-  id: 'ZSL London Zoo',
-  coords: {
-    lat: 51.536067,
-    lng: -0.153596
-  }
-}]
-
-departure_search = {
-  id: 'forward search example',
-  departure_location_id: 'London center',
-  arrival_location_ids: ['Hyde Park', 'ZSL London Zoo'],
-  transportation: {
-    type: 'bus'
-  },
-  departure_time: Time.now.iso8601,
-  travel_time: 1800,
-  properties: ['travel_time'],
-  range: {
-    enabled: true,
-    max_results: 3,
-    width: 600
-  }
-}
-
-arrival_search = {
-  id: 'backward search example',
-  departure_location_ids: ['Hyde Park', 'ZSL London Zoo'],
-  arrival_location_id: 'London center',
-  transportation: {
-    type: 'public_transport'
-  },
-  arrival_time: Time.now.iso8601,
-  travel_time: 1800,
-  properties: ['travel_time', 'distance', 'fares', 'route']
-}
-
-response = client.routes(
-  locations: locations,
-  departure_searches: [departure_search],
-  arrival_searches: [arrival_search]
-)
-
-puts response.body
-```
-
 ### [Time Filter (Fast)](https://traveltime.com/docs/api/reference/time-filter-fast)
-A very fast version of time_filter().
+A very fast version of `time_filter()`.
 However, the request parameters are much more limited.
 Currently only supports UK and Ireland.
 
@@ -347,7 +278,7 @@ response = client.time_filter_fast(
 puts response.body
 ```
 
-### [Time Filter (Fast) Proto](https://docs.traveltime.com/api/reference/travel-time-distance-matrix-proto)
+### [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).
@@ -357,9 +288,9 @@ This inflexibility comes with a benefit of faster response times (Over 5x faster
 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.
-* travelTime: Time limit;
-* country: Return the results that are within the specified country
+* traveltime: Time limit.
 
 ```ruby
 origin = {
@@ -382,42 +313,97 @@ response = client.time_filter_fast_proto(
 puts(response.body)
 ```
 
-### Time Filter (Fast) Proto Distance
-A version of `Time Filter (Fast) Proto` endpoint that also returns distance information. Request parameters are even more limited than `Time Filter (Fast) Proto`.
+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.
 
-This endpoint is not enabled by default, please [contact us](https://traveltime.com/contact-us) if you wish to obtain access. 
+### [Routes](https://traveltime.com/docs/api/reference/routes)
+Returns routing information between source and destinations.
 
 Body attributes:
-* origin: Origin point.
-* destinations: Destination points. Cannot be more than 200,000.
-* transport: Transportation type.
-* travelTime: Time limit;
-* country: Return the results that are within the specified country
+* locations: Locations to use. Each location requires an id and lat/lng values.
+* departure_searches: Searches based on departure times. Leave departure location at no earlier than given time. You can define a maximum of 10 searches.
+* arrival_searches: Searches based on arrival times. Arrive at destination location at no later than given time. You can define a maximum of 10 searches.
 
 ```ruby
-origin = {
-  lat: 51.508930,
-  lng: -0.131387,
-}
+require 'time'
 
-destinations = [{
-  lat: 51.508824,
-  lng: -0.167093,
+locations = [{
+  id: 'London center',
+  coords: {
+    lat: 51.508930,
+    lng: -0.131387
+  }
+},
+{
+  id: 'Hyde Park',
+  coords: {
+    lat: 51.508824,
+    lng: -0.167093
+  }
+},
+{
+  id: 'ZSL London Zoo',
+  coords: {
+    lat: 51.536067,
+    lng: -0.153596
+  }
 }]
 
-response = client.time_filter_fast_proto_distance(
-  country: 'UK',
-  origin: origin,
-  destinations: destinations,
-  transport: 'driving+ferry',
-  traveltime: 7200
+departure_search = {
+  id: 'forward search example',
+  departure_location_id: 'London center',
+  arrival_location_ids: ['Hyde Park', 'ZSL London Zoo'],
+  transportation: {
+    type: 'bus'
+  },
+  departure_time: Time.now.iso8601,
+  travel_time: 1800,
+  properties: ['travel_time'],
+  range: {
+    enabled: true,
+    max_results: 3,
+    width: 600
+  }
+}
+
+arrival_search = {
+  id: 'backward search example',
+  departure_location_ids: ['Hyde Park', 'ZSL London Zoo'],
+  arrival_location_id: 'London center',
+  transportation: {
+    type: 'public_transport'
+  },
+  arrival_time: Time.now.iso8601,
+  travel_time: 1800,
+  properties: ['travel_time', 'distance', 'fares', 'route']
+}
+
+response = client.routes(
+  locations: locations,
+  departure_searches: [departure_search],
+  arrival_searches: [arrival_search]
 )
-puts(response.body)
+
+puts response.body
 ```
 
+### [Geocoding (Search)](https://traveltime.com/docs/api/reference/geocoding-search) 
+Match a query string to geographic coordinates.
+
+```ruby
+response = client.geocoding(query: 'London', within_country: 'GB')
+puts response.body
+```
 
-### [Time Filter (Postcode Districts)](https://traveltime.com/docs/api/reference/postcode-district-filter)
-Find districts that have a certain coverage from origin (or to destination) and get statistics about postcodes within such districts.
+### [Reverse Geocoding](https://traveltime.com/docs/api/reference/geocoding-reverse)
+Attempt to match a latitude, longitude pair to an address.
+
+```ruby
+response = client.reverse_geocoding(lat: 51.506756, lng: -0.128050)
+puts response.body
+```
+
+### [Time Filter (Postcodes)](https://traveltime.com/docs/api/reference/postcode-search)
+Find reachable postcodes from origin (or to destination) and get statistics about such postcodes.
 Currently only supports United Kingdom.
 
 ```ruby
@@ -429,8 +415,7 @@ departure_search = {
   travel_time: 1800,
   coords: { lat: 51.507609, lng: -0.128315 },
   transportation: { type: 'public_transport' },
-  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
-  reachable_postcodes_threshold: 0.1
+  properties: ['travel_time', 'distance']
 }
 
 arrival_search = {
@@ -439,20 +424,19 @@ arrival_search = {
   travel_time: 1800,
   coords: { lat: 51.507609, lng: -0.128315 },
   transportation: { type: 'public_transport' },
-  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
-  reachable_postcodes_threshold: 0.1
+  properties: ['travel_time', 'distance']
 }
 
-response = client.time_filter_postcode_districts(
-  departure_searches: [departure_search],
+response = client.time_filter_postcodes(
+  departure_searches: [departure_search], 
   arrival_searches: [arrival_search]
 )
 
 puts response.body
 ```
 
-### [Time Filter (Postcode Sectors)](https://traveltime.com/docs/api/reference/postcode-sector-filter)
-Find sectors that have a certain coverage from origin (or to destination) and get statistics about postcodes within such sectors.
+### [Time Filter (Postcode Districts)](https://traveltime.com/docs/api/reference/postcode-district-filter)
+Find districts that have a certain coverage from origin (or to destination) and get statistics about postcodes within such districts.
 Currently only supports United Kingdom.
 
 ```ruby
@@ -478,7 +462,7 @@ arrival_search = {
   reachable_postcodes_threshold: 0.1
 }
 
-response = client.time_filter_postcode_sectors(
+response = client.time_filter_postcode_districts(
   departure_searches: [departure_search],
   arrival_searches: [arrival_search]
 )
@@ -486,8 +470,8 @@ response = client.time_filter_postcode_sectors(
 puts response.body
 ```
 
-### [Time Filter (Postcodes)](https://traveltime.com/docs/api/reference/postcode-search)
-Find reachable postcodes from origin (or to destination) and get statistics about such postcodes.
+### [Time Filter (Postcode Sectors)](https://traveltime.com/docs/api/reference/postcode-sector-filter)
+Find sectors that have a certain coverage from origin (or to destination) and get statistics about postcodes within such sectors.
 Currently only supports United Kingdom.
 
 ```ruby
@@ -499,7 +483,8 @@ departure_search = {
   travel_time: 1800,
   coords: { lat: 51.507609, lng: -0.128315 },
   transportation: { type: 'public_transport' },
-  properties: ['travel_time', 'distance']
+  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
+  reachable_postcodes_threshold: 0.1
 }
 
 arrival_search = {
@@ -508,33 +493,18 @@ arrival_search = {
   travel_time: 1800,
   coords: { lat: 51.507609, lng: -0.128315 },
   transportation: { type: 'public_transport' },
-  properties: ['travel_time', 'distance']
+  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
+  reachable_postcodes_threshold: 0.1
 }
 
-response = client.time_filter_postcodes(
-  departure_searches: [departure_search], 
+response = client.time_filter_postcode_sectors(
+  departure_searches: [departure_search],
   arrival_searches: [arrival_search]
 )
 
 puts response.body
 ```
 
-### [Geocoding (Search)](https://traveltime.com/docs/api/reference/geocoding-search) 
-Match a query string to geographic coordinates.
-
-```ruby
-response = client.geocoding(query: 'London', within_country: 'GB')
-puts response.body
-```
-
-### [Reverse Geocoding](https://traveltime.com/docs/api/reference/geocoding-reverse)
-Attempt to match a latitude, longitude pair to an address.
-
-```ruby
-response = client.reverse_geocoding(lat: 51.506756, lng: -0.128050)
-puts response.body
-```
-
 ### [Map Info](https://traveltime.com/docs/api/reference/map-info)
 Get information about currently supported countries.
 

data/lib/travel_time/client.rb

@@ -66,27 +66,25 @@ module TravelTime
     end
 
     def geocoding(query:, within_country: nil, format_name: nil, exclude: nil, limit: nil, force_postcode: nil,
-                  bounds: nil)
+                  bounds: nil, accept_language: nil)
       query = {
         query: query,
-        'within.country': within_country,
+        'within.country': within_country.is_a?(Array) ? within_country.join(',') : within_country,
         'format.name': format_name,
         'format.exclude.country': exclude,
         limit: limit,
         'force.add.postcode': force_postcode,
         bounds: bounds&.join(',')
       }.compact
-      perform_request { connection.get('geocoding/search', query) }
+      perform_request { connection.get('geocoding/search', query, { 'Accept-Language' => accept_language }) }
     end
 
-    def reverse_geocoding(lat:, lng:, within_country: nil, exclude: nil)
+    def reverse_geocoding(lat:, lng:, accept_language: nil)
       query = {
         lat: lat,
-        lng: lng,
-        'within.country': within_country,
-        'exclude.location.types': exclude
+        lng: lng
       }.compact
-      perform_request { connection.get('geocoding/reverse', query) }
+      perform_request { connection.get('geocoding/reverse', query, { 'Accept-Language' => accept_language }) }
     end
 
     def time_map(departure_searches: nil, arrival_searches: nil, unions: nil, intersections: nil, format: nil)
@@ -99,11 +97,9 @@ module TravelTime
       perform_request { connection.post('time-map', payload, { 'Accept' => format }) }
     end
 
-    def time_map_fast(arrival_searches:, unions: nil, intersections: nil, format: nil)
+    def time_map_fast(arrival_searches:, format: nil)
       payload = {
-        arrival_searches: arrival_searches,
-        unions: unions,
-        intersections: intersections
+        arrival_searches: arrival_searches
       }.compact
       perform_request { connection.post('time-map/fast', payload, { 'Accept' => format }) }
     end

data/lib/travel_time/middleware/authentication.rb

@@ -14,7 +14,7 @@ module TravelTime
       def on_request(env)
         env.request_headers[APP_ID_HEADER] = TravelTime.config.application_id
         env.request_headers[API_KEY_HEADER] = TravelTime.config.api_key
-        env.request_headers[USER_AGENT] = 'Travel Time Ruby SDK'
+        env.request_headers[USER_AGENT] = "Travel Time Ruby SDK #{TravelTime::VERSION}"
       end
     end
   end

data/lib/travel_time/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travel_time
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.5
 platform: ruby
 authors:
 - TravelTime Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable