travel_time 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479666f568d16431cf279ead2c1bf61c7f8e1f29596970afbd255750bf808f12
-  data.tar.gz: 0a83062eebe1621bb576ca3629e35f13c42f4e4ce0145f08d42ff12cce78e224
+  metadata.gz: 3d61024c00091bdbbf0036dcb0f0b3cbc13dfdf0f0690aa847cd2720ba9d7866
+  data.tar.gz: b7eb9f385d345cb2d115e34a37b85e6128730f3b87ca6ee6f34e79988b93236d
 SHA512:
-  metadata.gz: 587e2360688195fa2caebf53530bd6c8ca0969e757c1f9c9c071903c7ef8f0106f7225915c9e1c0a8c947fbc6d40ac291f30ad1862ed52b8adf5b200cc36c349
-  data.tar.gz: 1893e32110aeda9fbea6bec890d59b5f0c3ffeacd38bb9a0bb6668894761a3dce2d9a651b3f8f6afb88e9202bb10ed460518a31004e4c3dca618e7b1fe0a0ada
+  metadata.gz: 16b1444ca180d2a151794b3eacc38d7f88b7873cb1c7c83446d53e19bee5b7b9ce4bf502075fd8f9215489a8132d6296288ecbe85e14ffad48f74ac10e3cd999
+  data.tar.gz: 9f670c473b8536204514f9f638e4cd654eeab197224f46c0a91552a6852d6a9ff35dcdf620220f07b7afbd915ac536c60a5fcfa87ebe45c657ad1f38323e56dd

data/README.md

@@ -68,6 +68,14 @@ departure_search = {
 client.time_map(departure_searches: [departure_search])
 ```
 
+### Rate Limiting
+
+You may specify an optional rate limit when initializing your client. The `rate_limit` parameter sets a cap on the number of requests that can be made to the API in 60 seconds. Requests are balanced at equal intervals.
+
+```ruby
+client = TravelTime::Client.new(rate_limit = 60)
+```
+
 ### [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.
@@ -215,77 +223,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 +323,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 +423,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 +432,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 +470,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 +478,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 +491,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 +501,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

@@ -3,15 +3,28 @@
 require 'faraday'
 require 'travel_time/middleware/authentication'
 require 'travel_time/middleware/proto'
+require 'limiter'
 
 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
 
-    def initialize
+    def initialize(rate_limit = nil)
+      init_connection
+      init_proto_connection
+
+      return unless rate_limit
+
+      %i[perform_request perform_request_proto].each do |method_name|
+        self.class.limit_method method_name, balanced: true, rate: rate_limit
+      end
+    end
+
+    def init_connection
       @connection = Faraday.new(API_BASE_URL) do |f|
         f.request :json
         f.response :raise_error if TravelTime.config.raise_on_failure
@@ -20,8 +33,6 @@ module TravelTime
         f.use TravelTime::Middleware::Authentication
         f.adapter TravelTime.config.http_adapter || Faraday.default_adapter
       end
-
-      init_proto_connection
     end
 
     def init_proto_connection

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.6'
 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.6
 platform: ruby
 authors:
 - TravelTime Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -64,6 +64,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.21.9
+- !ruby/object:Gem::Dependency
+  name: ruby-limiter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: TravelTime SDK for Ruby programming language
 email:
 - support@traveltime.com