travel_time 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479666f568d16431cf279ead2c1bf61c7f8e1f29596970afbd255750bf808f12
-  data.tar.gz: 0a83062eebe1621bb576ca3629e35f13c42f4e4ce0145f08d42ff12cce78e224
+  metadata.gz: 980351a64bc02a09468036537289c94c69e92524ced3303539a4849254f1ad6b
+  data.tar.gz: 70232585d25f0a8dfa63b4f4b4a2fef827381e509ded12f3f641cfff58c88482
 SHA512:
-  metadata.gz: 587e2360688195fa2caebf53530bd6c8ca0969e757c1f9c9c071903c7ef8f0106f7225915c9e1c0a8c947fbc6d40ac291f30ad1862ed52b8adf5b200cc36c349
-  data.tar.gz: 1893e32110aeda9fbea6bec890d59b5f0c3ffeacd38bb9a0bb6668894761a3dce2d9a651b3f8f6afb88e9202bb10ed460518a31004e4c3dca618e7b1fe0a0ada
+  metadata.gz: 7f5c2aec26726acb47a74cfdd6608a0db0243fcfb7fa8c24ab4e86e9bf36bad03294b16bbeb8cbe6d1b1b671c801fb34227a140e1e6053b9612213e12e270d70
+  data.tar.gz: 8c43d33f903df991fa35162d170ef71fa9ebb44cf21dd1570e718ae8e6adf98bbf825117dc4235dc38b843a4956f664f62e42968f03fb98461082569af78336d

data/README.md

@@ -215,77 +215,6 @@ response = client.time_filter(
 puts response.body
 ```
 
-### [Routes](https://traveltime.com/docs/api/reference/routes)
-Returns routing information between source and destinations.
-
-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'
-
-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()`.
 However, the request parameters are much more limited.
@@ -386,8 +315,95 @@ 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.
 
-### [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.
+### [Routes](https://traveltime.com/docs/api/reference/routes)
+Returns routing information between source and destinations.
+
+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'
+
+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
+```
+
+### [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
+```
+
+### [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
@@ -399,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 = {
@@ -409,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
@@ -448,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]
 )
@@ -456,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
@@ -469,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 = {
@@ -478,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/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.4'
+  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.4
+  version: 0.5.5
 platform: ruby
 authors:
 - TravelTime Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable