mapricot-api 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ab17244df7dcde59e10619f66ad46c84678daaead1900996dc8a284500e8f8
-  data.tar.gz: 7b39f91e9e319ce5caa5600ab88bf5af044ad5749f3c114b8f9198535dcf918d
+  metadata.gz: 3aa156c2854ba75ee6f5277d91f46bc586e5c1807b47057a253fa7b0b117a930
+  data.tar.gz: f321e6ebdbcceb3f94ae5b51e8af98da8aa1abc4fac9d05914f7377df6feb63c
 SHA512:
-  metadata.gz: fd4c75fbb3ef76fe024d05639c0f6173c8916a920529d551fbd60023da3b40b26bed1efa2b4c9db9620654ecdde982cbf3b4e537fa74ca033da17649f5fb5d27
-  data.tar.gz: 80479d041ae94f4aed582895c778aff3e52979cc12742934ecdbabb2123599e22fea02c8bb7a7aae99e0e0b78f177db588ce632c40c4e5c40842a3f4be722aed
+  metadata.gz: 25afe81cbda109fc6272517af7b6bf1b3d3b29ec2a6d81eda812830834da030a3c7bbb23e7ef644f63875771b1ff907a97870c56d930a448965ab34195ef3866
+  data.tar.gz: 73c41d224dc22f7c5c90db74814fb7cb5202110bab0f0abc3610dced8adca8334c430887a28d4a02c279359eaf7a4c617d1baef53982ea5a61b754036dd9331c

data/README.md

@@ -24,7 +24,7 @@ puts place["label"], place["lat"], place["lon"]
 
 ## Methods
 
-Methods are grouped by product, the same way as the API's paths. Each returns the API's JSON as a Hash with string keys, with the same field names as the [API reference](https://mapricot.com/api-reference/).
+Methods are grouped by product, the same way as the API's paths. Each returns the API's JSON as a Hash with string keys, with the same field names as the [API reference](https://mapricot.com/docs/api-reference/).
 
 | Method | Endpoint |
 | --- | --- |
@@ -34,9 +34,9 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | `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:, generalize:)` | [`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 |
 
@@ -61,6 +61,8 @@ Pass `steps: true` and each leg's `steps` has its turn-by-turn directions: an `i
 
 `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
@@ -68,6 +70,8 @@ area = client.routing.isochrone({ lat: 45.5189, lon: -122.6793 }, [5, 10], mode:
 puts area["features"].map { |feature| feature["properties"]["minutes"] }.inspect
 ```
 
+`generalize` smooths each outline to within that many meters, from 10 to 5000, so it has fewer points. The API picks it from the travel time when you leave it out. A long drive's outlines are detailed and large, and `generalize: 300` makes them much smaller while keeping their shape at city scale.
+
 If your app shows results, show the credits in each response's `attribution`.
 
 ## Errors and retries
@@ -82,11 +86,11 @@ rescue Mapricot::Error => e
 end
 ```
 
-The client retries `503` responses and `429 concurrency_exceeded`, up to twice, waiting longer each time. Errors aren't billed. Pass `max_retries:` and `timeout:` (seconds) to `Mapricot::Client.new` to change this. The [API reference](https://mapricot.com/api-reference/#errors) lists every status.
+The client retries `503` responses and `429 concurrency_exceeded`, up to twice, waiting longer each time. Errors aren't billed. Pass `max_retries:` and `timeout:` (seconds) to `Mapricot::Client.new` to change this. The [API reference](https://mapricot.com/docs/api-reference/#errors) lists every status.
 
 ## Links
 
 - [Mapricot](https://mapricot.com/)
 - [Ruby docs](https://mapricot.com/docs/ruby/)
-- [API reference](https://mapricot.com/api-reference/)
+- [API reference](https://mapricot.com/docs/api-reference/)
 - [Pricing](https://mapricot.com/pricing/)

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.9.0"
+  VERSION = "0.11.0"
 
   # An error response from the API.
   class Error < StandardError
@@ -22,7 +22,7 @@ module Mapricot
   end
 
   # Methods are grouped by product, as in client.geocoding.search. Each returns the API's JSON as a Hash with string
-  # keys, as in https://mapricot.com/api-reference/.
+  # keys, as in https://mapricot.com/docs/api-reference/.
   class Client
     attr_reader :geocoding, :places, :routing, :ip_geolocation
 
@@ -159,24 +159,26 @@ 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. generalize smooths
+    # each outline to within that many meters, from 10 to 5000; left out, the API picks it from the travel time.
+    def isochrone(location, minutes, mode: nil, costing: nil, generalize: nil)
+      @post.call("/routing/v1/isochrone", { location: location, minutes: minutes, mode: mode, costing: costing, generalize: generalize })
     end
   end
 

metadata

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