mapricot-api 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ae66ee605316bfe6bf97ce5cdee87b0540c914a687d6d9fa32c94116599d91
-  data.tar.gz: a3614aa73d7395d146158da05b9a3dccb955fd656c646411ce1427c4026f294a
+  metadata.gz: e778f6345129b270ba0ba06c9e791051a9093d5c361dbd17afa00aa15a5f0f8e
+  data.tar.gz: '092b116567111f7fc1b702add90dff4caf06e7c7ef46307a58346b229ce62730'
 SHA512:
-  metadata.gz: 156e3cfd96b2ed32b0fa917d973852cf7df03421ad49b96d89fd4c5ff66dd6bbe3a601a9cfdd6ba95af616e48360ae0ef63127f4402ca1a94cfe22b21558e295
-  data.tar.gz: 0df9af5005e818d9ef4553fb6b11ada8d1e04d8de040682c2ede03f3ef3990983112e0161affee1d0a8cf4aa8f0d3e84bcd4bf0551bd8ec07d1a333f21c7ee8d
+  metadata.gz: '093e71c5a7d7ab43b19c13a30671e3c20b334ebf115daefd01204600f021c7abe97c83dbe0b467c3f8bdac914bf26033de7c956b283c8a102db34f532cc5ebfe'
+  data.tar.gz: 7ec4ba130fa05c424d2d19b5caa40c0d3ab4323962fe4a08363e295f01c15535d47b8f2feaab95a1caaef4f79b7e901d0bfbbe690c5c90a479ff6bba13ffd497

data/README.md

@@ -29,13 +29,14 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | Method | Endpoint |
 | --- | --- |
 | `client.geocoding.search(q, focus:, country:, limit:, lang:)` | [`GET /geocoding/v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
+| `client.geocoding.search_batch(queries)` | [`POST /geocoding/v1/search/batch`](https://mapricot.com/docs/geocoding/#search-a-list-of-addresses) |
 | `client.geocoding.autocomplete(q, focus:, country:, limit:, lang:)` | [`GET /geocoding/v1/autocomplete`](https://mapricot.com/docs/geocoding/#suggest-as-people-type) |
 | `client.geocoding.reverse(lat, lon, limit:, lang:)` | [`GET /geocoding/v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
 | `client.places.nearby(lat, lon, category:, radius:, limit:, lang:)` | [`GET /places/v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
 | `client.places.get(id, lang:)` | [`GET /places/v1/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
-| `client.routing.route(waypoints, mode:, geometries:, steps:, lang:)` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
-| `client.routing.optimize(waypoints, mode:, geometries:, steps:, lang:)` | [`POST /routing/v1/optimize`](https://mapricot.com/docs/routing/#optimize-the-order-of-stops) |
-| `client.routing.isochrone(location, minutes, mode:)` | [`POST /routing/v1/isochrone`](https://mapricot.com/docs/routing/#get-an-isochrone) |
+| `client.routing.route(waypoints, mode:, geometries:, steps:, lang:, costing:)` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.routing.optimize(waypoints, mode:, geometries:, steps:, lang:, costing:)` | [`POST /routing/v1/optimize`](https://mapricot.com/docs/routing/#optimize-the-order-of-stops) |
+| `client.routing.isochrone(location, minutes, mode:, costing:)` | [`POST /routing/v1/isochrone`](https://mapricot.com/docs/routing/#get-an-isochrone) |
 | `client.ip_geolocation.lookup(ip)` | [`GET /ip-geolocation/v1/{ip}`](https://mapricot.com/docs/ip-geolocation/#look-up-an-address) |
 | `client.account` | `GET /account`, which checks a key and is never billed |
 
@@ -47,12 +48,21 @@ route = client.routing.route([{ lat: 45.5189, lon: -122.6793 }, { lat: 45.5214,
 puts route["routes"][0]["durationSeconds"]
 ```
 
+`search_batch` runs up to 100 searches in one request. Each query is a Hash of `search`'s parameters, and `"responses"` answers them in the same order, each with `"results"` and `"attribution"`, or an `"error"` with the `"code"` and `"message"` that search would get, without raising. Each completed search is billed as one request; errors aren't.
+
+```ruby
+batch = client.geocoding.search_batch([{ q: "128 SW 3rd Ave, Portland", limit: 1 }, { q: "10 Downing Street, London", limit: 1 }])
+batch["responses"].each { |response| puts response.dig("error", "message") || response["results"][0]["label"] }
+```
+
 A route's path comes as an encoded `polyline` with five decimal places, which polyline decoders assume. Pass `geometries: "geojson"` to get it as a GeoJSON `LineString` in `geometry` instead, which maps draw without decoding, or `geometries: "polyline6"` for six decimal places.
 
 Pass `steps: true` and each leg's `steps` has its turn-by-turn directions: an `instruction`, its distance and time, and its `lat` and `lon`. They're in English unless you pass `lang`, such as `lang: "fr"`.
 
 `routing.optimize` takes the same arguments as `routing.route` and returns the route that visits the waypoints in a fast order, keeping the first and last in place. It adds `"waypointOrder"`: the indexes of your waypoints in visiting order, which `"legs"` follow. Every pair of waypoints must be within 400 km of each other for `drive`, or 200 km for `walk` and `bicycle`.
 
+`costing` changes how a route, optimized route, or isochrone picks its roads, with Valhalla's [costing options](https://mapricot.com/docs/routing/#costing-options) for the mode, such as `costing: { useTolls: 0, useHighways: 0 }` to drive avoiding tolls and highways where it can.
+
 An isochrone is a GeoJSON `FeatureCollection` with one polygon per time, largest first, so a map that draws them in order shows the smaller ones on top:
 
 ```ruby

data/lib/mapricot/api.rb

@@ -7,7 +7,7 @@ require "net/http"
 # The official client for the Mapricot API: address and place search, reverse geocoding, nearby places, routing,
 # and IP geolocation. See https://mapricot.com/docs/ruby/.
 module Mapricot
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 
   # An error response from the API.
   class Error < StandardError
@@ -33,7 +33,7 @@ module Mapricot
       @base_url = base_url
       @timeout = timeout
       @max_retries = max_retries
-      @geocoding = GeocodingService.new(method(:get))
+      @geocoding = GeocodingService.new(method(:get), method(:post), method(:query_value))
       @places = PlacesService.new(method(:get))
       @routing = RoutingService.new(method(:post))
       @ip_geolocation = IpGeolocationService.new(method(:get))
@@ -104,8 +104,10 @@ module Mapricot
 
   # client.geocoding: the /geocoding/v1 endpoints.
   class GeocodingService
-    def initialize(get)
+    def initialize(get, post, query_value)
       @get = get
+      @post = post
+      @query_value = query_value
     end
 
     # Find addresses and places matching free text. focus is {lat:, lon:}; country is an Array or a String.
@@ -113,6 +115,14 @@ module Mapricot
       @get.call("/geocoding/v1/search", q: q, focus: focus, country: country, limit: limit, lang: lang)
     end
 
+    # Run up to 100 searches in one request, each a Hash of search's parameters, as in { q: "…", limit: 1 }. Each
+    # completed search is billed as one request. "responses" answers them in order, each with "results" and
+    # "attribution", or an "error" with the code and message the search would get on its own, which isn't raised.
+    def search_batch(queries)
+      body = { queries: queries.map { |query| query.compact.transform_values { |value| @query_value.call(value) } } }
+      @post.call("/geocoding/v1/search/batch", body)
+    end
+
     # Suggest addresses and places as someone types.
     def autocomplete(q, focus: nil, country: nil, limit: nil, lang: nil)
       @get.call("/geocoding/v1/autocomplete", q: q, focus: focus, country: country, limit: limit, lang: lang)
@@ -149,24 +159,25 @@ module Mapricot
 
     # Find a route through 2 to 20 waypoints, each {lat:, lon:}. mode is "drive" (the default), "walk", or "bicycle".
     # geometries is "polyline" (the default), "polyline6", or "geojson". steps: true adds each leg's turn-by-turn
-    # steps, in lang, an ISO 639-1 language, English by default.
-    def route(waypoints, mode: nil, geometries: nil, steps: nil, lang: nil)
-      body = { waypoints: waypoints, mode: mode, geometries: geometries, steps: steps, lang: lang }
+    # steps, in lang, an ISO 639-1 language, English by default. costing takes Valhalla's costing options for the mode,
+    # such as { useTolls: 0 }: https://mapricot.com/docs/routing/#costing-options.
+    def route(waypoints, mode: nil, geometries: nil, steps: nil, lang: nil, costing: nil)
+      body = { waypoints: waypoints, mode: mode, geometries: geometries, steps: steps, lang: lang, costing: costing }
       @post.call("/routing/v1/route", body)
     end
 
     # Find a fast route through 2 to 20 waypoints, keeping the first and last in place and reordering the rest. It
     # takes the same arguments as route, and the route adds "waypointOrder": the indexes of the waypoints sent, in
     # visiting order.
-    def optimize(waypoints, mode: nil, geometries: nil, steps: nil, lang: nil)
-      body = { waypoints: waypoints, mode: mode, geometries: geometries, steps: steps, lang: lang }
+    def optimize(waypoints, mode: nil, geometries: nil, steps: nil, lang: nil, costing: nil)
+      body = { waypoints: waypoints, mode: mode, geometries: geometries, steps: steps, lang: lang, costing: costing }
       @post.call("/routing/v1/optimize", body)
     end
 
     # The areas reachable from a location, {lat:, lon:}, within 1 to 4 times, each 1 to 60 minutes, as a GeoJSON
-    # FeatureCollection with one polygon per time, largest first. mode is as for route.
-    def isochrone(location, minutes, mode: nil)
-      @post.call("/routing/v1/isochrone", { location: location, minutes: minutes, mode: mode })
+    # FeatureCollection with one polygon per time, largest first. mode and costing are as for route.
+    def isochrone(location, minutes, mode: nil, costing: nil)
+      @post.call("/routing/v1/isochrone", { location: location, minutes: minutes, mode: mode, costing: costing })
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mapricot-api
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Mapricot