ipregistry 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac4136cfc952e92a327b985aa8d1b83d2903ed9ab1db81f123bc484a0dc3f038
+  data.tar.gz: ba13012fb035c71eece4bcaedf159e1e49b6ec0291714ec89f506164de63585b
+SHA512:
+  metadata.gz: 4818fd403064398abe2a8741b6e08f68812b0e981dea244e6e677153198545b03625464eadbf355388b3c3862eda28d215756518a6bbf365f95f756b3652949b
+  data.tar.gz: 603353339ff653723b71d474219daaf0a5cd7957e4cc035cd799850498db64acd33d55657123a0c87e81a64c4fa519420dcc9cac27c3ab91a79d50041c5b106c

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-07-04
+### Added
+- Initial release of the official Ruby client library for the Ipregistry API.
+- `Client#lookup` for single IP address lookups, `Client#lookup_origin` for origin (requester) lookups returning
+  parsed User-Agent data, and `Client#batch_lookup` for resolving many IP addresses at once. Batch lookups
+  transparently split arrays larger than the API's 1024-address limit into concurrently dispatched sub-requests
+  (configurable via `max_batch_size:` and `batch_concurrency:`) and reassemble results in input order.
+- `Client#parse_user_agents` for parsing raw User-Agent strings into structured data.
+- Batch results (`BatchResponse`) expose per-entry success or failure through `Result` objects, are `Enumerable`,
+  and support pattern matching.
+- Nil-safe response models: nested sections are always present, so chained access such as
+  `info.location.country.name` never raises; boolean fields are exposed as predicates (`security.vpn?`).
+- Optional in-memory caching (`Cache::Memory`) with LRU eviction and TTL, plus a duck-typed interface for custom
+  backends. Caching is disabled by default; origin lookups are never cached and batch lookups reuse cached entries.
+- Automatic retries with exponential backoff for transient network errors and 5xx responses, honoring the
+  `Retry-After` header. Retries on 429 Too Many Requests are disabled by default.
+- Typed errors rooted at `Ipregistry::Error`: every documented API error code maps to a dedicated `ApiError`
+  subclass (e.g. `InvalidApiKeyError`, `InsufficientCreditsError`), and client-side failures raise
+  `ConnectionError`, `TimeoutError`, or `ParseError`.
+- `Ipregistry.bot?` helper to skip lookups for crawler traffic.
+- Offline unit/behavior specs using WebMock, plus opt-in live system specs in `spec/system` (run with
+  `IPREGISTRY_API_KEY` set).
+- Zero runtime dependencies (standard library only).
+
+[Unreleased]: https://github.com/ipregistry/ipregistry-ruby/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/ipregistry/ipregistry-ruby/releases/tag/v1.0.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,285 @@
+[<img src="https://cdn.ipregistry.co/icons/favicon-96x96.png" alt="Ipregistry" width="64"/>](https://ipregistry.co/)
+# Ipregistry Ruby Client Library
+
+[![License](http://img.shields.io/:license-apache-blue.svg)](LICENSE)
+[![Gem Version](https://img.shields.io/gem/v/ipregistry)](https://rubygems.org/gems/ipregistry)
+[![CI](https://github.com/ipregistry/ipregistry-ruby/actions/workflows/ci.yaml/badge.svg)](https://github.com/ipregistry/ipregistry-ruby/actions/workflows/ci.yaml)
+
+This is the official Ruby client library for the [Ipregistry](https://ipregistry.co) IP geolocation and threat data
+API, allowing you to look up your own IP address or specified ones. Responses return multiple data points including
+carrier, company, currency, location, time zone, threat information, and more. The library can also parse raw
+User-Agent strings.
+
+The gem has **zero runtime dependencies** — it is built entirely on the Ruby standard library.
+
+## Getting Started
+
+You'll need an Ipregistry API key, which you can get along with 100,000 free lookups by signing up for a free account
+at [https://ipregistry.co](https://ipregistry.co).
+
+### Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem "ipregistry"
+```
+
+Or install it directly:
+
+```bash
+gem install ipregistry
+```
+
+Requires Ruby 3.1 or later.
+
+### Quick start
+
+#### Single IP lookup
+
+```ruby
+require "ipregistry"
+
+client = Ipregistry::Client.new("YOUR_API_KEY")
+
+# Look up data for a given IPv4 or IPv6 address.
+# On the server side, retrieve the client IP from the request headers.
+info = client.lookup("54.85.132.205")
+
+info.location.country.name  # => "United States"
+info.location.city          # => "Ashburn"
+info.connection.asn         # => 14618
+info.security.vpn?          # => false
+info.time_zone.id           # => "America/New_York"
+```
+
+Every response is a lightweight value object. Nested sections are always present, so chained access like
+`info.location.country.name` never raises — absent fields return `nil` and absent flags return `false`. The raw
+decoded payload is available through `info.to_h`, and any field (including ones without a dedicated reader) through
+`info["field"]`.
+
+#### Origin IP lookup
+
+To look up the IP address the request is sent from — no argument needed — use `lookup_origin`. It returns a
+`RequesterIpInfo`, which additionally carries parsed User-Agent data:
+
+```ruby
+origin = client.lookup_origin
+origin.ip                        # => your public IP
+origin.location.country.name
+origin.user_agent&.name          # => e.g. "Ruby" (nil when the API omits it)
+```
+
+#### Batch IP lookup
+
+`batch_lookup` resolves many IP addresses in a single request. Each entry may independently succeed or fail (for
+example on an invalid address), so results are inspected element by element:
+
+```ruby
+response = client.batch_lookup(["73.2.2.2", "8.8.8.8", "2001:67c:2e8:22::c100:68b"])
+
+response.each do |result|
+  if result.success?
+    puts result.value.location.country.name
+  else
+    # A per-entry error (e.g. invalid IP address); an Ipregistry::ApiError.
+    warn "entry failed: #{result.error.message}"
+  end
+end
+
+response[0].value!         # the first entry's IpInfo, raising its error if it failed
+response.values            # only the successfully resolved IpInfo objects, in order
+response.errors            # only the per-entry errors, in order
+```
+
+`BatchResponse` is `Enumerable`, so `map`, `select`, `zip`, and friends work as expected, and results support
+pattern matching (`in { error: Ipregistry::ApiError }`).
+
+The Ipregistry API accepts up to 1024 IP addresses per request. `batch_lookup` transparently splits larger arrays
+into several requests, dispatched with bounded concurrency, and reassembles the results in input order — so you can
+pass an arbitrarily long array without hitting `TOO_MANY_IPS`. Tune the behavior when needed:
+
+```ruby
+client = Ipregistry::Client.new("YOUR_API_KEY",
+  max_batch_size: 1024,    # addresses per request (max/default: 1024)
+  batch_concurrency: 4)    # concurrent sub-requests (default: 4; 1 = sequential)
+```
+
+Only cache misses are sent to the API; if a whole sub-request fails (network or API error), `batch_lookup` raises
+that error, whereas an individual bad address surfaces as a per-entry error as shown above.
+
+## Lookup options
+
+Lookups accept keywords that map to Ipregistry query parameters:
+
+```ruby
+info = client.lookup("8.8.8.8",
+  hostname: true,                            # resolve reverse-DNS hostname
+  fields: "location.country.name,security")  # select only these fields
+```
+
+| Keyword           | Description                                                                                                                 |
+|-------------------|-----------------------------------------------------------------------------------------------------------------------------|
+| `hostname:`       | Enable reverse-DNS hostname resolution (disabled by default).                                                              |
+| `fields:`         | Restrict the response to the given [fields](https://ipregistry.co/docs/filtering-selecting-fields), reducing payload size. |
+| any other keyword | Passed through as an arbitrary query parameter not covered by a dedicated keyword.                                         |
+
+The same keywords are accepted by `lookup_origin` and `batch_lookup`.
+
+## Caching
+
+Although the client has built-in support for in-memory caching, it is **disabled by default** to ensure data freshness.
+
+To enable caching, pass a `Cache::Memory` when constructing the client:
+
+```ruby
+client = Ipregistry::Client.new("YOUR_API_KEY", cache: Ipregistry::Cache::Memory.new)
+```
+
+The in-memory cache is thread-safe and supports size- and time-based eviction (LRU with a TTL):
+
+```ruby
+cache = Ipregistry::Cache::Memory.new(
+  max_size: 8192,  # maximum number of entries (default 4096)
+  ttl: 600)        # entry lifetime in seconds (default 600)
+
+client = Ipregistry::Client.new("YOUR_API_KEY", cache: cache)
+```
+
+Origin (requester) lookups are never cached, because the requester IP is only known from the response. Batch lookups
+transparently serve already-cached entries and only request the remainder from the API.
+
+You can provide your own cache backend (Redis, `Rails.cache`, ...) with any object responding to:
+
+```ruby
+get(key)         # => value or nil
+set(key, value)
+delete(key)
+clear
+```
+
+## Retries
+
+Failed requests are automatically retried with an exponential backoff. By default, up to 3 retries are performed on
+transient network errors and 5xx server responses.
+
+Because Ipregistry does not rate limit by default (rate limiting is opt-in per API key), retries on
+_429 Too Many Requests_ responses are **disabled by default**. Enable them if your API key is configured with a rate
+limit and you want the client to wait and retry (honoring the `Retry-After` header when present):
+
+```ruby
+client = Ipregistry::Client.new("YOUR_API_KEY",
+  max_retries: 3,                     # 0 disables retries entirely
+  retry_interval: 1,                  # base backoff in seconds (interval * 2^attempt)
+  retry_on_server_error: true,        # retry on 5xx (default: true)
+  retry_on_too_many_requests: true)   # retry on 429 (default: false)
+```
+
+## Timeouts and concurrency
+
+By default every request times out after 15 seconds (applied to connection open, read, and write). Adjust it with the
+`timeout:` keyword:
+
+```ruby
+client = Ipregistry::Client.new("YOUR_API_KEY", timeout: 5)
+```
+
+A `Client` is safe for concurrent use, so share one instance across threads; batch lookups already parallelize their
+sub-requests internally.
+
+## Errors
+
+Every error raised by the library inherits from `Ipregistry::Error`, so a single rescue clause covers everything:
+
+- **`Ipregistry::ApiError`** — the API reported a failure (e.g. insufficient credits, throttling, invalid input). It
+  carries the raw `code`, the suggested `resolution`, and the `http_status`. Each documented error code maps to a
+  dedicated subclass, so you can rescue exactly the condition you care about.
+- **`Ipregistry::ClientError`** — a client-side failure, further specialized as `ConnectionError`, `TimeoutError`, or
+  `ParseError`. The underlying exception, when any, is available through `#cause`.
+
+```ruby
+begin
+  info = client.lookup("8.8.8.8")
+rescue Ipregistry::InsufficientCreditsError
+  # handle exhausted credits
+rescue Ipregistry::TooManyRequestsError
+  # handle rate limiting
+rescue Ipregistry::ApiError => e
+  # any other API failure
+  warn "#{e.message} (#{e.code}): #{e.resolution}"
+rescue Ipregistry::ClientError => e
+  # network / timeout / decoding error
+  warn e.cause&.message || e.message
+end
+```
+
+Error classes include `BadRequestError`, `DisabledApiKeyError`, `ForbiddenIpError`, `InsufficientCreditsError`,
+`InvalidApiKeyError`, `InvalidIpAddressError`, `MissingApiKeyError`, `ReservedIpAddressError`, `TooManyIpsError`,
+`TooManyRequestsError`, and more — see `Ipregistry::ERRORS_BY_CODE` for the full mapping and
+[ipregistry.co/docs/errors](https://ipregistry.co/docs/errors) for the documented codes.
+
+## Parsing User-Agents
+
+Parse one or more raw User-Agent strings (such as the `User-Agent` header of an incoming request) into structured
+data. Like batch lookups, results are per-entry:
+
+```ruby
+response = client.parse_user_agents(
+  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Chrome/120.0")
+
+ua = response[0].value!
+ua.name                    # => "Chrome"
+ua.operating_system.name   # => "macOS"
+ua.device.type             # => "desktop"
+```
+
+## Filtering bots
+
+You might want to prevent Ipregistry API calls for crawlers or bots browsing your pages. To help identify bots from
+the User-Agent, the library includes a lightweight helper:
+
+```ruby
+unless Ipregistry.bot?(request.user_agent)
+  info = client.lookup(request.remote_ip)
+  # ...
+end
+```
+
+## Examples
+
+Runnable examples live in the [`examples/`](examples) directory. Set your key and run one:
+
+```bash
+IPREGISTRY_API_KEY=YOUR_API_KEY ruby examples/single.rb
+```
+
+## Testing
+
+The library ships with two tiers of tests:
+
+- **Unit / behavior specs** run offline against [WebMock](https://github.com/bblimke/webmock) stubs — no API key or
+  network is required. This is the default `bundle exec rake spec` and what CI runs.
+- **System specs** exercise the live Ipregistry API. They live in `spec/system` and are skipped unless
+  `IPREGISTRY_API_KEY` is set (each successful lookup consumes credits):
+
+  ```bash
+  IPREGISTRY_API_KEY=YOUR_API_KEY bundle exec rake system
+  ```
+
+Common tasks are wired through the `Rakefile`: `rake spec`, `rake system`, `rake rubocop`, and `rake build`. The
+default task runs RuboCop and the unit specs.
+
+## Other Libraries
+
+There are official Ipregistry client libraries available for many languages including
+[Java](https://github.com/ipregistry/ipregistry-java),
+[Javascript](https://github.com/ipregistry/ipregistry-javascript),
+[Python](https://github.com/ipregistry/ipregistry-python),
+[Go](https://github.com/ipregistry/ipregistry-go) and more.
+
+Are you looking for an official client with a programming language or framework we do not support yet?
+[Let us know](mailto:support@ipregistry.co).
+
+## License
+
+This library is released under the [Apache 2.0 license](LICENSE).

data/lib/ipregistry/batch_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Ipregistry
+  # Ordered results of a batch operation ({Client#batch_lookup} or
+  # {Client#parse_user_agents}). Each entry may independently succeed or fail
+  # (for example on an invalid IP address), so entries are {Result} objects
+  # inspected element by element:
+  #
+  #   response = client.batch_lookup(["8.8.8.8", "not-an-ip"])
+  #   response.each do |result|
+  #     if result.success?
+  #       puts result.value.location.country.name
+  #     else
+  #       warn "entry failed: #{result.error.message}"
+  #     end
+  #   end
+  #
+  # BatchResponse is Enumerable, so +map+, +select+, +zip+, and friends work
+  # as expected. Use {#values} for the successful values only, or
+  # {Result#value!} to raise a failed entry's error.
+  class BatchResponse
+    include Enumerable
+
+    # One entry of a batch operation: either a value (an {Models::IpInfo} or
+    # {Models::UserAgent}) or the {ApiError} explaining why this particular
+    # entry failed.
+    class Result
+      # @return [Object, nil] the resolved value, or nil when the entry failed
+      attr_reader :value
+
+      # @return [ApiError, nil] the entry's failure, or nil when it succeeded
+      attr_reader :error
+
+      def self.success(value)
+        new(value: value)
+      end
+
+      def self.failure(error)
+        new(error: error)
+      end
+
+      def initialize(value: nil, error: nil)
+        @value = value
+        @error = error
+      end
+
+      def success?
+        @error.nil?
+      end
+
+      def failure?
+        !success?
+      end
+
+      # The resolved value, raising the entry's error when it failed.
+      def value!
+        raise @error if @error
+
+        @value
+      end
+
+      def deconstruct_keys(_keys)
+        { value: @value, error: @error }
+      end
+    end
+
+    # @return [Array<Result>] the entries, in input order
+    attr_reader :results
+
+    def initialize(results)
+      @results = results.freeze
+    end
+
+    # Yields each {Result} in input order.
+    def each(&)
+      @results.each(&)
+    end
+
+    # The {Result} at the given index.
+    def [](index)
+      @results[index]
+    end
+
+    def size
+      @results.size
+    end
+    alias length size
+
+    # The successfully resolved values, in order, skipping failed entries.
+    def values
+      @results.select(&:success?).map(&:value)
+    end
+
+    # The per-entry errors, in order, skipping successful entries.
+    # @return [Array<ApiError>]
+    def errors
+      @results.select(&:failure?).map(&:error)
+    end
+  end
+end