pickpoint 2.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5da5d860abc72dddb7a6618c2a352678a109e2a41049e5df08bdce4b3b09b7a
+  data.tar.gz: 1666532c7873746f27d73862b833117476276de5ed46f265cbe643b11a4554dd
+SHA512:
+  metadata.gz: 55037a1ba536d3cf0223388c0476efe12d117096dda81ccd1a060b8b654bcf245973de5fb68cae587ad63a9ecd7785ad5bb2d5bba481786ea8cf98dd0e260e27
+  data.tar.gz: 93626ebdba3d0e21ad6ec7e04c9d9c746aed8d19fdfea2d43b1b8834d9b4d77936558651ae5c59ce924b8cb9467e92b3af02b0c3e6bd150eb061e52780e3a87e

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", "~> 5.25"
+gem "rake", "~> 13.2"
+gem "webmock", "~> 3.24"

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,132 @@
+# pickpoint (Ruby SDK)
+
+Official Ruby SDK for [Pickpoint](https://pickpoint.io) — geocoding, address search, routing, and device registry over HTTP.
+
+| API | What it does |
+|-----|----------------|
+| **Geocoding** | Address ↔ coordinates (forward, reverse, place lookup) |
+| **Address search** | Typeahead / autocomplete for address inputs |
+| **Routing** | Routes, matrices, optimized multi-stop, elevation |
+| **Devices** | Register / manage tracking devices over HTTP |
+
+This gem covers the **public HTTP API only** (no realtime WebSocket / gRPC tracking client). Docs: [pickpoint.io/docs](https://pickpoint.io/docs).
+
+Apache-2.0. Siblings: [`@pickpoint/sdk`](https://github.com/pickpoint/pickpoint-js), [`go-sdk`](https://github.com/pickpoint/go-sdk), [`python-sdk`](https://github.com/pickpoint/python-sdk), [`rust-sdk`](https://github.com/pickpoint/rust-sdk).
+
+```bash
+gem install pickpoint
+# or in Gemfile:
+# gem "pickpoint"
+```
+
+Requires Ruby **3.1+**. Zero runtime dependencies (stdlib `Net::HTTP` + `JSON`).
+
+---
+
+## Public API
+
+One `Client`, one auth session, whole public HTTP surface:
+
+```ruby
+require "pickpoint"
+
+pp = Pickpoint::Client.new(
+  Pickpoint::Config.new(api_key: ENV.fetch("PICKPOINT_API_KEY"))
+)
+
+places = pp.forward("q" => "Berlin", "limit" => "5")
+pp.reverse("lat" => "52.52", "lon" => "13.405")
+pp.search("q" => "Alexanderplatz")
+pp.route(
+  "locations" => [
+    { "lat" => 52.52, "lon" => 13.40 },
+    { "lat" => 52.53, "lon" => 13.42 }
+  ],
+  "costing" => "auto"
+)
+
+devices = pp.devices.list
+puts devices.total
+```
+
+### API map
+
+| Method | HTTP | Notes |
+|--------|------|--------|
+| `forward` / `geocoding.forward` | `GET /v2/geocode/forward` | Nominatim-style; returns `Array` |
+| `reverse` / `geocoding.reverse` | `GET /v2/geocode/reverse` | `Hash` or `nil` |
+| `lookup` / `geocoding.lookup` | `GET /v2/address/lookup` | e.g. `osm_ids` |
+| `forward_batch` / `reverse_batch` / `lookup_batch` | same | Geocoding **only**; conveyor ≤20 in flight |
+| `search` / `address.search` | `GET /v2/address/search` | Photon autocomplete |
+| `route` / `optimized_route` / `matrix` / `locate` / `elevation` | `POST /v2/route…` | Valhalla JSON body |
+| `devices.list` / `get` / `create` / `update` / `delete` | `/v2/devices` | Typed structs |
+| `devices.command` | `POST …/command` | Payload bytes (SDK base64-encodes) |
+| `Pickpoint.mint_client_tokens` | `POST /v2/client-tokens` | Needs secret `api_key` |
+
+Query params for geocode/address are plain `Hash` of strings (symbol keys are fine).
+
+### Auth
+
+Provide **exactly one** of:
+
+| Field | Header | Use |
+|-------|--------|-----|
+| `api_key` | `x-api-key` | Backends, workers, CLIs |
+| `client_auth` | `Authorization: Bearer` | Short-lived pair; auto-refresh |
+| `access_token` | `Authorization: Bearer` | Static token, no refresh |
+
+Keep the secret API key on the server. For client apps mint **client-tokens** and pass `client_auth`.
+
+```ruby
+pair = Pickpoint.mint_client_tokens(
+  Pickpoint::Config.new(api_key: ENV.fetch("PICKPOINT_API_KEY")),
+  scopes: %w[geocoding address routing devices],
+  ttl_sec: 600
+)
+
+pp = Pickpoint::Client.new(
+  Pickpoint::Config.new(
+    client_auth: Pickpoint::ClientAuth.new(
+      access_token: pair.access_token,
+      refresh_token: pair.refresh_token,
+      expires_at: pair.expires_at
+    )
+  )
+)
+```
+
+Refresh behavior (same as Go/Python/JS):
+
+1. Proactive refresh at **~50% of access TTL** (single-flight).
+2. On HTTP **401**, one refresh + retry.
+3. If refresh fails → `Pickpoint::APIError` with auth code.
+
+### Config
+
+```ruby
+Pickpoint::Config.new(
+  api_key: "…",
+  base_url: "https://api.pickpoint.io", # default
+  timeout: 30.0,
+  max_retries: 3,
+  retry_base: 1.0,
+  concurrency: 20
+)
+```
+
+| Constant | Value |
+|----------|--------|
+| `DEFAULT_BASE_URL` | `https://api.pickpoint.io` |
+| `DEFAULT_TIMEOUT` | 30s |
+| `DEFAULT_MAX_RETRIES` | 3 |
+| `DEFAULT_RETRY_BASE` | 1s (`MIN_RETRY_BASE` = 0.2s) |
+| `MAX_CONCURRENCY` | 20 |
+
+---
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+2.0.3

data/lib/pickpoint/address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Pickpoint
+  class AddressService
+    def initialize(transport)
+      @t = transport
+    end
+
+    def search(query)
+      q = (query || {}).transform_keys(&:to_s).transform_values(&:to_s)
+      raw = @t.do(Transport::RequestOpts.new(method: "GET", path: "/v2/address/search", query: q))
+      JSON.parse(raw)
+    end
+  end
+end

data/lib/pickpoint/auth.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "json"
+require "monitor"
+
+module Pickpoint
+  module Auth
+    module_function
+
+    def resolve(cfg, base_url, http)
+      n = 0
+      n += 1 if present?(cfg.api_key)
+      n += 1 if cfg.client_auth
+      n += 1 if present?(cfg.access_token)
+      if n > 1
+        raise InvalidConfigError, "provide only one of: api_key | client_auth | access_token"
+      end
+      if n.zero?
+        raise InvalidConfigError, "auth required: api_key, client_auth, or access_token"
+      end
+
+      if present?(cfg.api_key)
+        return State.new(api_key: cfg.api_key)
+      end
+      if cfg.client_auth
+        return State.new(session: ClientAuthSession.new(cfg.client_auth, base_url, http))
+      end
+
+      State.new(session: StaticSession.new(cfg.access_token))
+    end
+
+    def present?(s)
+      !s.nil? && !s.to_s.empty?
+    end
+
+    class State
+      def initialize(api_key: nil, session: nil)
+        @api_key = api_key
+        @session = session
+      end
+
+      def bearer?
+        !@session.nil?
+      end
+
+      def apply!(headers)
+        headers["Accept"] = "application/json"
+        if @api_key
+          headers["x-api-key"] = @api_key
+          return
+        end
+        headers["Authorization"] = "Bearer #{@session.token}"
+      end
+
+      def refresh_after_unauthorized
+        return false if @session.nil?
+
+        @session.refresh_after_unauthorized
+      end
+    end
+
+    class StaticSession
+      def initialize(access_token)
+        @token = access_token
+      end
+
+      def token
+        @token
+      end
+
+      def refresh_after_unauthorized
+        false
+      end
+    end
+
+    class ClientAuthSession
+      def initialize(initial, base_url, http)
+        if blank?(initial.access_token) || blank?(initial.refresh_token) || initial.expires_at.to_i.zero?
+          raise InvalidConfigError,
+                "client_auth requires access_token, refresh_token, and expires_at (unix ms)"
+        end
+        @mutex = Monitor.new
+        @cond = @mutex.new_cond
+        @access = initial.access_token
+        @refresh = initial.refresh_token
+        @expires_at = initial.expires_at.to_i
+        @issued_at = Time.now
+        @base_url = base_url
+        @http = http
+        @refreshing = false
+        @waiters = 0
+        @last_refresh_error = nil
+      end
+
+      def token
+        refresh if needs_proactive_refresh?
+        @mutex.synchronize { @access }
+      end
+
+      def refresh_after_unauthorized
+        refresh
+        true
+      rescue StandardError
+        false
+      end
+
+      def refresh
+        wait = false
+        refresh_tok = nil
+
+        @mutex.synchronize do
+          if @refreshing
+            @waiters += 1
+            wait = true
+          else
+            @refreshing = true
+            @last_refresh_error = nil
+            refresh_tok = @refresh
+          end
+        end
+
+        if wait
+          @mutex.synchronize do
+            @cond.wait_while { @refreshing }
+            err = @last_refresh_error
+            @waiters -= 1
+            raise err if err
+          end
+          return
+        end
+
+        err = nil
+        begin
+          do_refresh(refresh_tok)
+        rescue StandardError => e
+          err = e
+        end
+
+        @mutex.synchronize do
+          @last_refresh_error = err
+          @refreshing = false
+          @cond.broadcast
+        end
+
+        raise err if err
+      end
+
+      private
+
+      def blank?(s)
+        s.nil? || s.to_s.empty?
+      end
+
+      def needs_proactive_refresh?
+        now_ms = (Time.now.to_f * 1000).to_i
+        issued_ms = (@issued_at.to_f * 1000).to_i
+        ttl_ms = @expires_at - issued_ms
+        if ttl_ms <= 0
+          return now_ms >= (@expires_at - 30_000)
+        end
+
+        refresh_after_s = (ttl_ms * CLIENT_AUTH_REFRESH_AT) / 1000.0
+        (Time.now - @issued_at) >= refresh_after_s
+      end
+
+      def do_refresh(refresh_tok)
+        status, raw =
+          begin
+            @http.request(
+              "POST",
+              "#{@base_url}/v2/client-tokens/refresh",
+              headers: {
+                "Accept" => "application/json",
+                "Content-Type" => "application/json"
+              },
+              body: JSON.generate({ "refreshToken" => refresh_tok })
+            )
+          rescue StandardError => e
+            raise APIError.new(code: "REFRESH_FAILED", message: "client token refresh network error: #{e}")
+          end
+
+        unless status >= 200 && status < 300
+          raise APIError.new(
+            status: status,
+            code: "REFRESH_FAILED",
+            message: "client token refresh failed (#{status})",
+            body: raw
+          )
+        end
+
+        begin
+          pair = JSON.parse(raw)
+        rescue JSON::ParserError => e
+          raise APIError.new(code: "INVALID_TOKEN", message: "refresh returned invalid JSON: #{e}", body: raw)
+        end
+
+        access = pair["accessToken"].to_s
+        refresh = pair["refreshToken"].to_s
+        expires = pair["expiresAt"].to_i
+        if access.empty? || refresh.empty? || expires.zero?
+          raise APIError.new(code: "INVALID_TOKEN", message: "refresh returned invalid clientAuth pair", body: raw)
+        end
+
+        @mutex.synchronize do
+          @access = access
+          @refresh = refresh
+          @expires_at = expires
+          @issued_at = Time.now
+        end
+      end
+    end
+  end
+end

data/lib/pickpoint/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Pickpoint
+  # Unified public-api client (geocoding, address, routing, devices).
+  # This gem does not include realtime tracking.
+  class Client
+    attr_reader :geocoding, :address, :routing, :devices, :concurrency
+
+    def initialize(cfg)
+      base = Transport.trim_slash(cfg.base_url || DEFAULT_BASE_URL)
+      timeout = cfg.timeout && cfg.timeout.positive? ? cfg.timeout : DEFAULT_TIMEOUT
+      http = Http.new(timeout: timeout, adapter: cfg.http_adapter)
+
+      max_retries = cfg.max_retries && cfg.max_retries.positive? ? cfg.max_retries : DEFAULT_MAX_RETRIES
+      retry_base = cfg.retry_base && cfg.retry_base.positive? ? cfg.retry_base : DEFAULT_RETRY_BASE
+      retry_base = [retry_base, MIN_RETRY_BASE].max
+      concurrency = cfg.concurrency && cfg.concurrency.positive? ? cfg.concurrency : DEFAULT_CONCURRENCY
+      concurrency = [concurrency, MAX_CONCURRENCY].min
+
+      auth = Auth.resolve(cfg, base, http)
+      transport = Transport::Client.new(
+        base_url: base,
+        http: http,
+        auth: auth,
+        max_retries: max_retries,
+        retry_base: retry_base
+      )
+
+      @concurrency = concurrency
+      @geocoding = GeocodingService.new(transport, concurrency)
+      @address = AddressService.new(transport)
+      @routing = RoutingService.new(transport)
+      @devices = DevicesService.new(transport)
+    end
+
+    # Flat shortcuts
+    def forward(query) = geocoding.forward(query)
+    def reverse(query) = geocoding.reverse(query)
+    def lookup(query) = geocoding.lookup(query)
+    def forward_batch(queries) = geocoding.forward_batch(queries)
+    def reverse_batch(queries) = geocoding.reverse_batch(queries)
+    def lookup_batch(queries) = geocoding.lookup_batch(queries)
+    def search(query) = address.search(query)
+    def route(body) = routing.route(body)
+    def optimized_route(body) = routing.optimized(body)
+    def matrix(body) = routing.matrix(body)
+    def locate(body) = routing.locate(body)
+    def elevation(body) = routing.elevation(body)
+  end
+end