mapricot-api 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/lib/mapricot/api.rb +4 -3
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f71eb9fc26e529343c43b463d9c39a189f27393570c7e4f874481f352e58246e
4
- data.tar.gz: 05eadfb4de87fa10ac0b07bc7e7684f2835cb84c1677bf13b29e1107d7603609
3
+ metadata.gz: 738ae3f3ba9a75663dfabf87e3009bb28f583a6b4f8beb9b3ff43fc823e95762
4
+ data.tar.gz: e883dc44c7857e96e357bfcce39ecfb98280e3c7a4c2b083a805ff006d2be46f
5
5
  SHA512:
6
- metadata.gz: 8b14fc259f3e6de0025ccfeb767fb4e0d5f7971f4fb082252e9485f7bd59bbd3a744a6279afc88159ffca4bd263e04e6efc6c0b9f85bcb1371e30c3795d45994
7
- data.tar.gz: a6d53c8cd4b0c370137491aa6862e30f1d8a457a2b870611b5bc519147fa3eb1f05b1725170b91877c19bfe2a3a18c8a9ee3626e0a6c8e26329ce942e5cd5c5e
6
+ metadata.gz: 0d71ee623decdd044207a89c64996367c031c740b6e3c7f72d836398c1f2f188c58b69a08456a2a494c9e94db2dea5d2ebc2d5de3d8972359b0399cda682af04
7
+ data.tar.gz: 299ffab402dfea95b853569fb4c25c145b525252e2fab8b90bf8c4e9375865b7f416fbda2de6d659c54e18dff3cd3494b5c431f67a998257725ab1122f5aebcc
data/README.md CHANGED
@@ -33,7 +33,7 @@ Each method returns the API's JSON as a Hash with string keys, with the same fie
33
33
  | `client.reverse(lat, lon, limit:, lang:)` | [`GET /v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
34
34
  | `client.nearby(lat, lon, category:, radius:, limit:, lang:)` | [`GET /v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
35
35
  | `client.place(id, lang:)` | [`GET /v1/places/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
36
- | `client.route(waypoints, mode:)` | [`POST /v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
36
+ | `client.route(waypoints, mode:, geometries:)` | [`POST /v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
37
37
  | `client.ip(address)` | [`GET /v1/ip/{ip}`](https://mapricot.com/docs/ip-geolocation/#look-up-an-address) |
38
38
  | `client.account` | `GET /v1/account`, which checks a key and is never billed |
39
39
 
@@ -45,7 +45,7 @@ route = client.route([{ lat: 45.5189, lon: -122.6793 }, { lat: 45.5214, lon: -12
45
45
  puts route["routes"][0]["durationSeconds"]
46
46
  ```
47
47
 
48
- A route's `polyline` is encoded with six decimal places. Decode it with precision 6, as [decoding a route polyline](https://mapricot.com/guides/polyline-decoder/) shows.
48
+ 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.
49
49
 
50
50
  If your app shows results, show the credits in each response's `attribution`.
51
51
 
data/lib/mapricot/api.rb CHANGED
@@ -6,7 +6,7 @@ require "net/http"
6
6
  # The official client for the Mapricot API: address and place search, reverse geocoding, nearby places, routing,
7
7
  # and IP geolocation. See https://mapricot.com/docs/ruby/.
8
8
  module Mapricot
9
- VERSION = "0.2.0"
9
+ VERSION = "0.3.0"
10
10
 
11
11
  # An error response from the API.
12
12
  class Error < StandardError
@@ -57,8 +57,9 @@ module Mapricot
57
57
  end
58
58
 
59
59
  # Find a route through 2 to 20 waypoints, each {lat:, lon:}. mode is "drive" (the default), "walk", or "bicycle".
60
- def route(waypoints, mode: nil)
61
- body = { waypoints: waypoints, mode: mode }.compact
60
+ # geometries is "polyline" (the default), "polyline6", or "geojson".
61
+ def route(waypoints, mode: nil, geometries: nil)
62
+ body = { waypoints: waypoints, mode: mode, geometries: geometries }.compact
62
63
  request(Net::HTTP::Post, URI("#{@base_url}/v1/route"), JSON.generate(body))
63
64
  end
64
65
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mapricot-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mapricot