travel_time 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92636f6a9ef3ed92abd0fba69609a827923c4c2f0f617b8b986921749282224
-  data.tar.gz: aa5352c332805b59a3057d17cf983691f2866d72de765df7c65d4bf12dc9e91b
+  metadata.gz: ede2b3ca9b12f1d411227a72ecf78374b4c2e2440bd554750de51b5aa828c841
+  data.tar.gz: 37aec14a1fd0e9c09cd8d101dbbad7cc297b60abc27a596b980cd9884e64ebf7
 SHA512:
-  metadata.gz: 45cd2bd0a182a170afb7569720bbe4acb9010e307b75dcdce56917b0ed4efe073934a98d24f838319e7e64b0c020df4ada6340b798fde13de5da5c1b5c15e9da
-  data.tar.gz: c2ef831952436c81bd1519065c4217dde55fffce7f976a55564304b7b9fa395809b7d6a62893c7dc046d607e1b89fe108042a4c1afd21a4b02b8620604c66408
+  metadata.gz: 64831cb1d98876a2aab320c84dfc5b59ed27174c319810bac81800da4fd1a2a9cab0330737b393fd27fc7737cd44c0ccc8d14effbcea342bacbfdaf1f68b9da5
+  data.tar.gz: 923ac3cea840237a5e35eb8e4333cec5f84eea8b267851131a246b5f70841a7866205d236f53bbd7c084e10e97680054f275b6a8faf16eb9c73882a099407a01

data/README.md

@@ -4,7 +4,7 @@
 [![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](http://docs.traveltime.com/overview/introduction)
+This open-source library allows you to access [TravelTime API](https://docs.traveltime.com/overview/introduction)
 endpoints.
 
 ## Installation
@@ -70,6 +70,418 @@ 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.
+
+```ruby
+require 'time'
+
+departure_search = {
+  id: "public transport from Trafalgar Square",
+  coords: {
+    lat: 51.506756,
+    lng: -0.128050
+  },
+  transportation: { type: "public_transport" },
+  departure_time: Time.now.iso8601,
+  travel_time: 1800,
+}
+
+arrival_search = {
+  id: "public transport to Trafalgar Square",
+  coords: {
+    lat: 51.506756,
+    lng: -0.128050
+  },
+  transportation: { type: "public_transport" },
+  arrival_time: Time.now.iso8601,
+  travel_time: 1800,
+  range: { enabled: true, width: 3600 }
+}
+
+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(
+  departure_searches: [departure_search], 
+  arrival_searches: [arrival_search], 
+  unions: [union], 
+  intersections: [intersection]
+)
+
+puts response.body
+```
+
+### [Distance Matrix (Time Filter)](https://traveltime.com/docs/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.
+
+```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', 'distance_breakdown', 'fares']
+}
+
+response = client.time_filter(
+  locations: locations, 
+  departure_searches: [departure_search],
+  arrival_searches: [arrival_search]
+)
+
+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().
+However, the request parameters are much more limited.
+Currently only supports UK and Ireland.
+
+```ruby
+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
+    }
+  }
+]
+
+arrival_many_to_one = {
+  id: 'arrive-at many-to-one search example',
+  departure_location_ids: ['Hyde Park', 'ZSL London Zoo'],
+  arrival_location_id: 'London center',
+  transportation: { type: 'public_transport' },
+  arrival_time_period: 'weekday_morning',
+  travel_time: 1900,
+  properties: ['travel_time', 'fares']
+}
+
+arrival_one_to_many = {
+  id: 'arrive-at one-to-many search example',
+  arrival_location_ids: ['Hyde Park', 'ZSL London Zoo'],
+  departure_location_id: 'London center',
+  transportation: { type: 'public_transport' },
+  arrival_time_period: 'weekday_morning',
+  travel_time: 1900,
+  properties: ['travel_time', 'fares']
+}
+
+arrival_searches = {
+  many_to_one: [arrival_many_to_one],
+  one_to_many: [arrival_one_to_many]
+}
+
+response = client.time_filter_fast(
+  locations: locations,
+  arrival_searches: arrival_searches
+)
+
+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.
+Currently only supports United Kingdom.
+
+```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' },
+  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
+  reachable_postcodes_threshold: 0.1
+}
+
+arrival_search = {
+  id: 'public transport to Trafalgar Square',
+  arrival_time: Time.now.iso8601,
+  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
+}
+
+response = client.time_filter_postcode_districts(
+  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.
+Currently only supports United Kingdom.
+
+```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' },
+  properties: ['coverage', 'travel_time_reachable', 'travel_time_all'],
+  reachable_postcodes_threshold: 0.1
+}
+
+arrival_search = {
+  id: 'public transport to Trafalgar Square',
+  arrival_time: Time.now.iso8601,
+  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
+}
+
+response = client.time_filter_postcode_sectors(
+  departure_searches: [departure_search],
+  arrival_searches: [arrival_search]
+)
+
+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
+require 'time'
+
+TravelTime.configure do |config|
+  config.application_id = 'YOUR_API_ID'
+  config.api_key = 'YOUR_API_KEY'
+end
+
+client = TravelTime::Client.new
+
+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' },
+  properties: ['travel_time', 'distance']
+}
+
+arrival_search = {
+  id: 'public transport to Trafalgar Square',
+  arrival_time: Time.now.iso8601,
+  travel_time: 1800,
+  coords: { lat: 51.507609, lng: -0.128315 },
+  transportation: { type: 'public_transport' },
+  properties: ['travel_time', 'distance']
+}
+
+response = client.time_filter_postcodes(
+  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.
+
+```ruby
+response = client.map_info
+puts response.body
+```
+
+### [Supported Locations](https://traveltime.com/docs/api/reference/supported-locations)
+Find out what points are supported by the api.
+
+```ruby
+locations = [{
+  id: "London",
+  coords: {
+    lat: 51.506756,
+    lng: -0.128050
+  }
+},
+{
+  id: "Bangkok",
+  coords: {
+    lat: 13.761866,
+    lng: 100.544818
+  }
+},
+{
+  id: "Lisbon",
+  coords: {
+    lat: 38.721869,
+    lng: -9.138549
+  }
+},
+{
+  id: "Kaunas",
+  coords: {
+    lat: 54.900008,
+    lng: 23.957734
+  }
+}]
+
+response = client.supported_locations(locations: locations)
+
+puts response.body
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
@@ -82,5 +494,4 @@ a GitHub Action which will push the `.gem` file to [rubygems.org](https://rubyge
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/traveltime-dev/travel_time.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/traveltime-dev/travel_time.

data/lib/travel_time/client.rb

@@ -43,14 +43,15 @@ module TravelTime
       perform_request { connection.post('supported-locations', { locations: locations }) }
     end
 
-    def geocoding(query:, within_country: nil, exclude: nil, limit: nil, force_postcode: nil)
+    def geocoding(query:, within_country: nil, exclude: nil, limit: nil, force_postcode: nil, bounds: nil)
       query = {
         query: query,
         'within.country': within_country,
         'exclude.location.types': exclude,
         limit: limit,
-        'force.add.postcode': force_postcode
-      }.compact!
+        'force.add.postcode': force_postcode,
+        bounds: bounds ? bounds.join(',') : nil
+      }.compact
       perform_request { connection.get('geocoding/search', query) }
     end
 
@@ -60,7 +61,7 @@ module TravelTime
         lng: lng,
         'within.country': within_country,
         'exclude.location.types': exclude
-      }.compact!
+      }.compact
       perform_request { connection.get('geocoding/reverse', query) }
     end
 
@@ -70,7 +71,7 @@ module TravelTime
         arrival_searches: arrival_searches,
         unions: unions,
         intersections: intersections
-      }.compact!
+      }.compact
       perform_request { connection.post('time-map', payload) }
     end
 
@@ -79,7 +80,7 @@ module TravelTime
         locations: locations,
         departure_searches: departure_searches,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('time-filter', payload) }
     end
 
@@ -87,7 +88,7 @@ module TravelTime
       payload = {
         locations: locations,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('time-filter/fast', payload) }
     end
 
@@ -95,7 +96,7 @@ module TravelTime
       payload = {
         departure_searches: departure_searches,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('time-filter/postcodes', payload) }
     end
 
@@ -103,7 +104,7 @@ module TravelTime
       payload = {
         departure_searches: departure_searches,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('time-filter/postcode-districts', payload) }
     end
 
@@ -111,7 +112,7 @@ module TravelTime
       payload = {
         departure_searches: departure_searches,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('time-filter/postcode-sectors', payload) }
     end
 
@@ -120,7 +121,7 @@ module TravelTime
         locations: locations,
         departure_searches: departure_searches,
         arrival_searches: arrival_searches
-      }.compact!
+      }.compact
       perform_request { connection.post('routes', payload) }
     end
   end

data/lib/travel_time/version.rb

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

metadata

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