travel_time 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a2b13991042791d77578dc894e869564b289137381fc5c8b319fd37efb2b11
-  data.tar.gz: 587fac0cd53502b30c3834c7320e9b66dce1589dcb3d8757e8f0f1c7356ef920
+  metadata.gz: 94289b84d4537470999d6c534d87f3471ab7975ad55f0c88a4926cdbc96e97f0
+  data.tar.gz: ad709dc58a04d251f394b7b268dff697cbbe7e20f4cc397f255d4c96b05a395d
 SHA512:
-  metadata.gz: 5cd13c389968b3b96684d9f36002dcc783f23c01cc90968af58e3ffb671dfb1ea6eed776e60cc7791bb15d78005753b5bc6fb5fa0574f58c0f6b92aa14157949
-  data.tar.gz: 6720fd0d83332a628d44743381c27c3d63f981c46f667fa228ca1fbb4ae015a84d127627a0acf91d76742d850c8794532fe0fae07e0cfc29ad2ff2c7adc10c45
+  metadata.gz: 9fc6e8b0a487da700f015594c1777ceee6b85c7728d7ff9269e97bbb8f687b5063234c0d4e8a0741fca7f6072d42fb46a515cb44335818a7a566f86ccc7901a8
+  data.tar.gz: d50f406b9301cf4e45379318fc4bc2403a87c340b0bc48f024a717deb4e17da0c2f037c3b2ae59d16367bb8641f4aad5532b8a5bdb88ca5fc64a5e392a34bd33

data/README.md

@@ -15,11 +15,15 @@ gem 'travel_time'
 
 And then execute:
 
-    $ bundle install
+```bash
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install travel_time
+```bash
+$ gem install travel_time
+```
 
 ## Usage
 
@@ -27,8 +31,8 @@ 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 app key>'
+  config.application_id = 'YOUR_APP_ID'
+  config.api_key = 'YOUR_APP_KEY'
 end
 ```
 
@@ -76,7 +80,7 @@ You may specify an optional rate limit when initializing your client. The `rate_
 client = TravelTime::Client.new(rate_limit = 60)
 ```
 
-### [Isochrones (Time Map)](https://traveltime.com/docs/api/reference/isochrones)
+### [Isochrones (Time Map)](https://docs.traveltime.com/api/reference/isochrones)
 Given origin coordinates, find shapes of zones reachable within corresponding travel time.
 Find unions/intersections between different searches.
 
@@ -131,6 +135,62 @@ response = client.time_map(
 puts response.body
 ```
 
+### [Distance Map](https://docs.traveltime.com/api/reference/distance-map)
+Given origin coordinates, find shapes of zones reachable within corresponding travel distance.
+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'
+
+departure_search = {
+  id: "driving from Trafalgar Square",
+  coords: {
+    lat: 51.506756,
+    lng: -0.128050
+  },
+  transportation: { type: "driving" },
+  departure_time: Time.now.iso8601,
+  travel_distance: 1800,
+}
+
+arrival_search = {
+  id: "cycling to Trafalgar Square",
+  coords: {
+    lat: 51.506756,
+    lng: -0.128050
+  },
+  transportation: { type: "cycling" },
+  arrival_time: Time.now.iso8601,
+  travel_distance: 1800,
+  range: { enabled: true, width: 3600 }
+}
+
+union = {
+  id: 'union of driving and cycling',
+  search_ids: ['driving from Trafalgar Square', 'cycling to Trafalgar Square']
+}
+
+intersection = {
+  id: 'intersection of driving and cycling',
+  search_ids: ['driving from Trafalgar Square', 'cycling to Trafalgar Square']
+}
+
+response = client.distance_map(
+  departure_searches: [departure_search], 
+  arrival_searches: [arrival_search], 
+  unions: [union], 
+  intersections: [intersection]
+)
+
+puts response.body
+```
+
 ### [Isochrones (Time Map) Fast](https://docs.traveltime.com/api/reference/isochrones-fast)
 A very fast version of Isochrone API. However, the request parameters are much more limited.
 
@@ -157,7 +217,7 @@ response = client.time_map_fast(
 puts response.body
 ```
 
-### [Distance Matrix (Time Filter)](https://traveltime.com/docs/api/reference/distance-matrix)
+### [Distance Matrix (Time Filter)](https://docs.traveltime.com/api/reference/distance-matrix)
 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.
 
@@ -223,10 +283,9 @@ response = client.time_filter(
 puts response.body
 ```
 
-### [Time Filter (Fast)](https://traveltime.com/docs/api/reference/time-filter-fast)
+### [Time Filter (Fast)](https://docs.traveltime.com/api/reference/time-filter-fast)
 A very fast version of `time_filter()`.
 However, the request parameters are much more limited.
-Currently only supports UK and Ireland.
 
 ```ruby
 locations = [
@@ -323,7 +382,7 @@ 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.
 
-### [Routes](https://traveltime.com/docs/api/reference/routes)
+### [Routes](https://docs.traveltime.com/api/reference/routes)
 Returns routing information between source and destinations.
 
 Body attributes:
@@ -394,7 +453,7 @@ response = client.routes(
 puts response.body
 ```
 
-### [Geocoding (Search)](https://traveltime.com/docs/api/reference/geocoding-search) 
+### [Geocoding (Search)](https://docs.traveltime.com/api/reference/geocoding-search) 
 Match a query string to geographic coordinates.
 
 ```ruby
@@ -402,7 +461,7 @@ response = client.geocoding(query: 'London', within_country: 'GB')
 puts response.body
 ```
 
-### [Reverse Geocoding](https://traveltime.com/docs/api/reference/geocoding-reverse)
+### [Reverse Geocoding](https://docs.traveltime.com/api/reference/geocoding-reverse)
 Attempt to match a latitude, longitude pair to an address.
 
 ```ruby
@@ -410,7 +469,7 @@ response = client.reverse_geocoding(lat: 51.506756, lng: -0.128050)
 puts response.body
 ```
 
-### [Time Filter (Postcodes)](https://traveltime.com/docs/api/reference/postcode-search)
+### [Time Filter (Postcodes)](https://docs.traveltime.com/api/reference/postcode-search)
 Find reachable postcodes from origin (or to destination) and get statistics about such postcodes.
 Currently only supports United Kingdom.
 
@@ -443,7 +502,7 @@ response = client.time_filter_postcodes(
 puts response.body
 ```
 
-### [Time Filter (Postcode Districts)](https://traveltime.com/docs/api/reference/postcode-district-filter)
+### [Time Filter (Postcode Districts)](https://docs.traveltime.com/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.
 
@@ -478,7 +537,7 @@ response = client.time_filter_postcode_districts(
 puts response.body
 ```
 
-### [Time Filter (Postcode Sectors)](https://traveltime.com/docs/api/reference/postcode-sector-filter)
+### [Time Filter (Postcode Sectors)](https://docs.traveltime.com/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.
 
@@ -513,7 +572,7 @@ response = client.time_filter_postcode_sectors(
 puts response.body
 ```
 
-### [Map Info](https://traveltime.com/docs/api/reference/map-info)
+### [Map Info](https://docs.traveltime.com/api/reference/map-info)
 Get information about currently supported countries.
 
 ```ruby
@@ -521,7 +580,7 @@ response = client.map_info
 puts response.body
 ```
 
-### [Supported Locations](https://traveltime.com/docs/api/reference/supported-locations)
+### [Supported Locations](https://docs.traveltime.com/api/reference/supported-locations)
 Find out what points are supported by the api.
 
 ```ruby

data/lib/travel_time/client.rb

@@ -108,6 +108,16 @@ module TravelTime
       perform_request { connection.post('time-map', payload, { 'Accept' => format }) }
     end
 
+    def distance_map(departure_searches: nil, arrival_searches: nil, unions: nil, intersections: nil, format: nil)
+      payload = {
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact
+      perform_request { connection.post('distance-map', payload, { 'Accept' => format }) }
+    end
+
     def time_map_fast(arrival_searches:, format: nil)
       payload = {
         arrival_searches: arrival_searches

data/lib/travel_time/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travel_time
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - TravelTime Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable