mapricot-api 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 738ae3f3ba9a75663dfabf87e3009bb28f583a6b4f8beb9b3ff43fc823e95762
-  data.tar.gz: e883dc44c7857e96e357bfcce39ecfb98280e3c7a4c2b083a805ff006d2be46f
+  metadata.gz: 24849159506d71db67b1e674bf3cf9377f218c78260002730a2f1dab55b713f9
+  data.tar.gz: '07499083f22bd04f51f65704bb24e204c0f7767564e84de4f92114c6836aa09e'
 SHA512:
-  metadata.gz: 0d71ee623decdd044207a89c64996367c031c740b6e3c7f72d836398c1f2f188c58b69a08456a2a494c9e94db2dea5d2ebc2d5de3d8972359b0399cda682af04
-  data.tar.gz: 299ffab402dfea95b853569fb4c25c145b525252e2fab8b90bf8c4e9375865b7f416fbda2de6d659c54e18dff3cd3494b5c431f67a998257725ab1122f5aebcc
+  metadata.gz: 1b921d6fabb89653dbde12a181390f618e547dada82ea5587108d2e0acc069d8b43e1c427d30d96cf1abe2807933b670462f779aebe4e4499b0b20c23a045b13
+  data.tar.gz: e1f406517e97e473fcc7eece8890e609d26c2921523cb88e18c23f72bc84258d553e540b9e9724d883b057722c6137fd79327b04e75fb72b5d331de1e569dc88

data/README.md

@@ -28,14 +28,15 @@ Each method returns the API's JSON as a Hash with string keys, with the same fie
 
 | Method | Endpoint |
 | --- | --- |
-| `client.search(q, focus:, country:, limit:, lang:)` | [`GET /v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
-| `client.autocomplete(q, focus:, country:, limit:, lang:)` | [`GET /v1/autocomplete`](https://mapricot.com/docs/places/#suggest-as-people-type) |
-| `client.reverse(lat, lon, limit:, lang:)` | [`GET /v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
-| `client.nearby(lat, lon, category:, radius:, limit:, lang:)` | [`GET /v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
-| `client.place(id, lang:)` | [`GET /v1/places/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
-| `client.route(waypoints, mode:, geometries:)` | [`POST /v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
-| `client.ip(address)` | [`GET /v1/ip/{ip}`](https://mapricot.com/docs/ip-geolocation/#look-up-an-address) |
-| `client.account` | `GET /v1/account`, which checks a key and is never billed |
+| `client.search(q, focus:, country:, limit:, lang:)` | [`GET /geocoding/v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
+| `client.autocomplete(q, focus:, country:, limit:, lang:)` | [`GET /geocoding/v1/autocomplete`](https://mapricot.com/docs/geocoding/#suggest-as-people-type) |
+| `client.reverse(lat, lon, limit:, lang:)` | [`GET /geocoding/v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
+| `client.nearby(lat, lon, category:, radius:, limit:, lang:)` | [`GET /places/v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
+| `client.place(id, lang:)` | [`GET /places/v1/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
+| `client.route(waypoints, mode:, geometries:)` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.isochrone(location, minutes, mode:)` | [`POST /routing/v1/isochrone`](https://mapricot.com/docs/routing/#get-an-isochrone) |
+| `client.ip(address)` | [`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 |
 
 Every keyword argument is optional. `focus` and each waypoint are `{ lat:, lon: }`. `country` and `category` take an Array or a comma-separated String.
 
@@ -47,6 +48,13 @@ puts route["routes"][0]["durationSeconds"]
 
 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.
 
+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
+area = client.isochrone({ lat: 45.5189, lon: -122.6793 }, [5, 10], mode: "walk")
+puts area["features"].map { |feature| feature["properties"]["minutes"] }.inspect
+```
+
 If your app shows results, show the credits in each response's `attribution`.
 
 ## Errors and retries

data/lib/mapricot/api.rb

@@ -6,7 +6,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.3.0"
+  VERSION = "0.5.0"
 
   # An error response from the API.
   class Error < StandardError
@@ -33,44 +33,51 @@ module Mapricot
 
     # Find addresses and places matching free text. focus is {lat:, lon:}; country is an Array or a String.
     def search(q, focus: nil, country: nil, limit: nil, lang: nil)
-      get("/v1/search", q: q, focus: focus, country: country, limit: limit, lang: lang)
+      get("/geocoding/v1/search", q: q, focus: focus, country: country, limit: limit, lang: lang)
     end
 
     # Suggest addresses and places as someone types.
     def autocomplete(q, focus: nil, country: nil, limit: nil, lang: nil)
-      get("/v1/autocomplete", q: q, focus: focus, country: country, limit: limit, lang: lang)
+      get("/geocoding/v1/autocomplete", q: q, focus: focus, country: country, limit: limit, lang: lang)
     end
 
     # Find the address nearest a coordinate, or the area around it.
     def reverse(lat, lon, limit: nil, lang: nil)
-      get("/v1/reverse", lat: lat, lon: lon, limit: limit, lang: lang)
+      get("/geocoding/v1/reverse", lat: lat, lon: lon, limit: limit, lang: lang)
     end
 
     # List places around a coordinate, optionally by category, an Array or a String.
     def nearby(lat, lon, category: nil, radius: nil, limit: nil, lang: nil)
-      get("/v1/nearby", lat: lat, lon: lon, category: category, radius: radius, limit: limit, lang: lang)
+      get("/places/v1/nearby", lat: lat, lon: lon, category: category, radius: radius, limit: limit, lang: lang)
     end
 
     # Look up one place by its Mapricot ID.
     def place(id, lang: nil)
-      get("/v1/places/#{escape(id)}", lang: lang)
+      get("/places/v1/#{escape(id)}", lang: lang)
     end
 
     # 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".
     def route(waypoints, mode: nil, geometries: nil)
       body = { waypoints: waypoints, mode: mode, geometries: geometries }.compact
-      request(Net::HTTP::Post, URI("#{@base_url}/v1/route"), JSON.generate(body))
+      request(Net::HTTP::Post, URI("#{@base_url}/routing/v1/route"), JSON.generate(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)
+      body = { location: location, minutes: minutes, mode: mode }.compact
+      request(Net::HTTP::Post, URI("#{@base_url}/routing/v1/isochrone"), JSON.generate(body))
     end
 
     # Approximate location of a public IP address.
     def ip(address)
-      get("/v1/ip/#{escape(address)}")
+      get("/ip-geolocation/v1/#{escape(address)}")
     end
 
     # The key's account. Not billed, so it checks a key for free.
     def account
-      get("/v1/account")
+      get("/account")
     end
 
     private

metadata

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