mapricot-api 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e778f6345129b270ba0ba06c9e791051a9093d5c361dbd17afa00aa15a5f0f8e
-  data.tar.gz: '092b116567111f7fc1b702add90dff4caf06e7c7ef46307a58346b229ce62730'
+  metadata.gz: 3aa156c2854ba75ee6f5277d91f46bc586e5c1807b47057a253fa7b0b117a930
+  data.tar.gz: f321e6ebdbcceb3f94ae5b51e8af98da8aa1abc4fac9d05914f7377df6feb63c
 SHA512:
-  metadata.gz: '093e71c5a7d7ab43b19c13a30671e3c20b334ebf115daefd01204600f021c7abe97c83dbe0b467c3f8bdac914bf26033de7c956b283c8a102db34f532cc5ebfe'
-  data.tar.gz: 7ec4ba130fa05c424d2d19b5caa40c0d3ab4323962fe4a08363e295f01c15535d47b8f2feaab95a1caaef4f79b7e901d0bfbbe690c5c90a479ff6bba13ffd497
+  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 |
 | --- | --- |
@@ -36,7 +36,7 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | `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:, 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.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 |
 
@@ -70,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
@@ -84,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.10.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
 
@@ -175,9 +175,10 @@ module Mapricot
     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 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 })
+    # 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.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Mapricot