ipmax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22a9cd90bd352d2b17a305334ed16546e7b06a95da4df13cd651aa3b68b65439
+  data.tar.gz: 9b3a39d9342ba437c095e725800946f112fcadd24f5c881b155ee5ef472f3c82
+SHA512:
+  metadata.gz: 88b34049838e96e9d4373b0c70f0cd4599baff1a8b8aa3ef69acdce7c4a39cb04ec064ebf244a9484ecafd2e3eeb79acf1b2542f04a14759bf3f4f4dfa6f09fb
+  data.tar.gz: 529749360503e9fbd4d080b12e8b4cdc931b2cfa55cda9729357b6442f45bbfe939f3598709055496792f0cde26f0c9bd0bd1264751d46e5ce7e3e9792307a4c

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,89 @@
+# ipmax
+
+Ruby client for the [IP-Max](https://ipm.ax) GeoIP and IP intelligence API, with immutable `Data` responses and RBS signatures.
+
+## Install
+
+```sh
+gem install ipmax
+```
+
+Requires Ruby 3.2 or newer. No runtime dependencies beyond the standard library.
+
+## Quickstart
+
+```ruby
+require "ipmax"
+
+client = IPMax::Client.new(api_key: "sg_live_...")
+
+geo = client.geoip("8.8.8.8")
+puts geo.geo.city, geo.geo.country_code, geo.as.name
+
+intel = client.intelligence("8.8.8.8")
+puts "hosting network" if intel.network_class.primary == IPMax::Models::NetworkClass::HOSTING
+
+catalog = client.catalog
+account = client.account
+```
+
+When no key is passed, the client reads `IPMAX_API_KEY` from the environment. `catalog` works without a key.
+
+Every lookup is billed and sends a fresh `Idempotency-Key`, which is reused when the request is retried. Pass your own with `client.geoip(ip, idempotency_key: "...")` to make a lookup safe to repeat across processes.
+
+Responses live in `IPMax::Models` and use snake_case members (`countryCode` becomes `country_code`; the wire field `class` becomes `network_class` on `NetworkClassEvidence` and `as_class` on `IntelligenceAs`). String enums such as `NetworkClass`, `RpkiStatus` or `LiveIntelligenceTag` are plain strings with constants for the known values, so new values from the API never break decoding. PTR results include `IPMax::Models::PtrIntelligence` and are `PtrLocatedIntelligence`, `PtrAsnMismatchIntelligence`, `PtrUnmatchedIntelligence`, or `PtrOtherIntelligence` for a status this version does not know yet.
+
+A client is safe to share between threads.
+
+## Configuration
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `api_key:` | `ENV["IPMAX_API_KEY"]` | API key sent as a bearer token |
+| `base_url:` | `"https://api.ipm.ax"` | API origin |
+| `timeout:` | `10` | Seconds for connecting, writing and reading, per attempt |
+| `max_retries:` | `2` | Retries on network errors, 408, 429 and 5xx, with exponential backoff and `Retry-After` support |
+| `cache_size:` | `1024` | Successful lookups kept in memory; `0` disables the cache |
+| `cache_ttl:` | `300` | Seconds a cached lookup stays fresh |
+| `http:` | new `Net::HTTP` per request | Any object with `request(Net::HTTPRequest)`, such as a preconfigured `Net::HTTP` for a proxy |
+
+Proxies from `http_proxy` and `https_proxy` are honoured by default.
+
+Cached lookups make no request and cost nothing. `catalog` and `account` are never cached. A lookup with an explicit idempotency key always goes to the API.
+
+## Error handling
+
+```ruby
+begin
+  client.geoip("8.8.8.8")
+rescue IPMax::InsufficientBalanceError => error
+  notify_billing(error.request_id)
+rescue IPMax::RateLimitError => error
+  sleep(error.retry_after || 1)
+rescue IPMax::ApiError => error
+  warn [error.status, error.code, error.message, error.request_id].join(" ")
+rescue IPMax::ConnectionError => error
+  warn "IP-Max is unreachable: #{error.message}"
+end
+```
+
+| Error | When |
+| --- | --- |
+| `IPMax::Error` | Base class for everything below |
+| `IPMax::ApiError` | Any non-2xx response; `status`, `code`, `message`, `request_id`, `retryable?`, `retry_after` |
+| `IPMax::InvalidRequestError` | 400, 413, 415 |
+| `IPMax::AuthenticationError` | 401 |
+| `IPMax::InsufficientBalanceError` | 402 |
+| `IPMax::NotFoundError` | 404 |
+| `IPMax::ConflictError` | 409 |
+| `IPMax::RateLimitError` | 429 |
+| `IPMax::ServerError` | 5xx |
+| `IPMax::ConnectionError` | The request could not be completed |
+| `IPMax::TimeoutError` | The request timed out; a subclass of `ConnectionError` |
+| `IPMax::DecodeError` | A successful response did not match the API contract |
+
+`IPMax::Models::ErrorCode` holds the known values of `error.code`, such as `ErrorCode::INSUFFICIENT_BALANCE`. New codes may appear and are passed through as plain integers.
+
+## License
+
+[Apache-2.0](LICENSE)

data/lib/ipmax/client.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+require "securerandom"
+require "uri"
+
+module IPMax
+  class Client
+    BACKOFF_BASE = 0.5
+    BACKOFF_CAP = 8.0
+    NETWORK_ERRORS = [SocketError, SystemCallError, IOError, OpenSSL::SSL::SSLError, Net::ProtocolError].freeze
+    private_constant :BACKOFF_BASE, :BACKOFF_CAP, :NETWORK_ERRORS
+
+    def initialize(
+      api_key: ENV["IPMAX_API_KEY"],
+      base_url: "https://api.ipm.ax",
+      timeout: 10,
+      max_retries: 2,
+      cache_size: 1024,
+      cache_ttl: 300,
+      http: nil
+    )
+      uri = URI(base_url)
+      @api_key = (api_key.nil? || api_key.empty?) ? nil : api_key
+      @host = uri.host || raise(ArgumentError, "base_url must be an absolute URL, got #{base_url.inspect}")
+      @port = uri.port || 443
+      @use_ssl = uri.scheme == "https"
+      @path_prefix = uri.path.to_s.delete_suffix("/")
+      @timeout = timeout
+      @max_retries = max_retries
+      @http = http
+      @cache = Internal::LruCache.new(cache_size, cache_ttl)
+    end
+
+    def catalog = fetch(request(Net::HTTP::Get, "/api/v1/catalog"), Models::CatalogResponse).data
+
+    def account = fetch(request(Net::HTTP::Get, "/api/v1/account"), Models::AccountResponse).data
+
+    def geoip(ip, idempotency_key: nil) = lookup(Models::Product::GEOIP, ip, idempotency_key, Models::GeoIpResponse)
+
+    def intelligence(ip, idempotency_key: nil) = lookup(Models::Product::INTELLIGENCE, ip, idempotency_key, Models::IntelligenceResponse)
+
+    private
+
+    def lookup(product, ip, idempotency_key, envelope)
+      address = ip.strip
+      key = [product, address]
+      cached = @cache.get(key) if idempotency_key.nil?
+      return cached unless cached.nil?
+
+      post = request(Net::HTTP::Post, "/api/v1/#{product}")
+      post["Content-Type"] = "application/json"
+      post["Idempotency-Key"] = idempotency_key || SecureRandom.uuid
+      post.body = JSON.generate(Models::LookupRequest.new(ip: address).to_h)
+      data = fetch(post, envelope).data
+      @cache.set(key, data)
+      data
+    end
+
+    def request(method, path)
+      request = method.new("#{@path_prefix}#{path}")
+      request["Accept"] = "application/json"
+      request["User-Agent"] = "ipmax-ruby/#{VERSION}"
+      request["Authorization"] = "Bearer #{@api_key}" if @api_key
+      request
+    end
+
+    def fetch(request, envelope)
+      attempt = 0
+      loop do
+        response = perform(request)
+        return Internal::Schema.build(envelope, parse(response.body)) if response.is_a?(Net::HTTPSuccess)
+
+        error = api_error(response)
+        raise error if attempt >= @max_retries || !retryable_status?(error.status)
+
+        sleep(error.retry_after || backoff(attempt))
+        attempt += 1
+      rescue ConnectionError
+        raise if attempt >= @max_retries
+
+        sleep(backoff(attempt))
+        attempt += 1
+      end
+    end
+
+    def perform(request)
+      connection.request(request)
+    rescue Timeout::Error => e
+      raise TimeoutError, "Request timed out after #{@timeout} seconds (#{e.class})"
+    rescue *NETWORK_ERRORS => e
+      raise ConnectionError, "Could not reach the IP-Max API: #{e.message}"
+    end
+
+    def connection
+      @http || Net::HTTP.new(@host, @port).tap do |http|
+        http.use_ssl = @use_ssl
+        http.open_timeout = @timeout
+        http.read_timeout = @timeout
+        http.write_timeout = @timeout
+      end
+    end
+
+    def api_error(response)
+      status = response.code.to_i
+      error = begin
+        Internal::Schema.build(Models::ErrorResponse, parse(response.body)).error
+      rescue DecodeError
+        nil
+      end
+      message, code, request_id, retryable =
+        if error
+          [error.message, error.code, error.request_id, error.retryable]
+        else
+          ["Unexpected HTTP #{status} response", nil, response["X-Request-ID"], retryable_status?(status)]
+        end
+      error_class(status).new(message, status:, code:, request_id:, retryable:, retry_after: retry_after(response["Retry-After"]))
+    end
+
+    def error_class(status)
+      case status
+      when 400, 413, 415 then InvalidRequestError
+      when 401 then AuthenticationError
+      when 402 then InsufficientBalanceError
+      when 404 then NotFoundError
+      when 409 then ConflictError
+      when 429 then RateLimitError
+      when 500.. then ServerError
+      else ApiError
+      end
+    end
+
+    def parse(body)
+      JSON.parse(body.to_s)
+    rescue JSON::ParserError => e
+      raise DecodeError, "Response body is not valid JSON: #{e.message}"
+    end
+
+    def retry_after(header)
+      seconds = Float(header, exception: false) if header
+      seconds if seconds&.finite? && seconds >= 0
+    end
+
+    def retryable_status?(status) = status == 408 || status == 429 || status >= 500
+
+    def backoff(attempt) = rand * [BACKOFF_CAP, BACKOFF_BASE * (2**attempt)].min
+  end
+end

data/lib/ipmax/errors.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module IPMax
+  class Error < StandardError; end
+
+  class ApiError < Error
+    attr_reader :status, :code, :request_id, :retry_after
+
+    def initialize(message, status:, code:, request_id:, retryable:, retry_after:)
+      super(message)
+      @status = status
+      @code = code
+      @request_id = request_id
+      @retryable = retryable
+      @retry_after = retry_after
+    end
+
+    def retryable? = @retryable
+  end
+
+  class InvalidRequestError < ApiError; end
+
+  class AuthenticationError < ApiError; end
+
+  class InsufficientBalanceError < ApiError; end
+
+  class NotFoundError < ApiError; end
+
+  class ConflictError < ApiError; end
+
+  class RateLimitError < ApiError; end
+
+  class ServerError < ApiError; end
+
+  class ConnectionError < Error; end
+
+  class TimeoutError < ConnectionError; end
+
+  class DecodeError < Error; end
+end

data/lib/ipmax/internal/lru_cache.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "monitor"
+
+module IPMax
+  module Internal
+    class LruCache
+      def initialize(capacity, ttl)
+        @capacity = capacity
+        @ttl = ttl
+        @entries = {}
+        @monitor = Monitor.new
+      end
+
+      def get(key)
+        @monitor.synchronize do
+          entry = @entries.delete(key)
+          next if entry.nil? || entry.first <= now
+
+          @entries[key] = entry
+          entry.last
+        end
+      end
+
+      def set(key, value)
+        return if @capacity <= 0
+
+        @monitor.synchronize do
+          @entries.delete(key)
+          @entries[key] = [now + @ttl, value]
+          @entries.shift if @entries.size > @capacity
+        end
+      end
+
+      private
+
+      def now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  end
+end

data/lib/ipmax/internal/schema.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module IPMax
+  module Internal
+    module Schema
+      Field = Data.define(:name, :key, :type, :required, :nullable)
+
+      Union = Data.define(:tag, :variants, :fallback)
+
+      class Builder
+        attr_reader :fields
+
+        def initialize
+          @fields = []
+        end
+
+        def required(name, type, null: false, key: name.to_s)
+          @fields << Field.new(name:, key:, type:, required: true, nullable: null)
+        end
+
+        def optional(name, type, key: name.to_s)
+          @fields << Field.new(name:, key:, type:, required: false, nullable: true)
+        end
+      end
+
+      MODELS = {}
+      UNIONS = {}
+      private_constant :Field, :Union, :Builder, :MODELS, :UNIONS
+
+      def self.define(*modules, &)
+        builder = Builder.new
+        builder.instance_eval(&)
+        model = Data.define(*builder.fields.map(&:name))
+        modules.each { |mod| model.include(mod) }
+        MODELS[model] = builder.fields.freeze
+        model
+      end
+
+      def self.union(mod, tag:, variants:, fallback:)
+        UNIONS[mod] = Union.new(tag:, variants:, fallback:)
+      end
+
+      def self.build(type, object, path = type.name)
+        raise DecodeError, "Expected a JSON object at #{path}" unless object.is_a?(Hash)
+
+        union = UNIONS[type]
+        model = union ? union.variants.fetch(object[union.tag], union.fallback) : type
+        model.new(**MODELS.fetch(model).to_h { |field| [field.name, attribute(field, object, path)] })
+      end
+
+      def self.attribute(field, object, path)
+        location = "#{path}.#{field.key}"
+        unless object.key?(field.key)
+          raise DecodeError, "Missing #{location}" if field.required
+
+          return nil
+        end
+        value = object[field.key]
+        (value.nil? && field.nullable) ? nil : coerce(field.type, value, location)
+      end
+
+      def self.coerce(type, value, path)
+        case [type, value]
+        in [:string, String] | [:integer, Integer] | [:boolean, true | false] | [:null, nil]
+          value
+        in [:float, Integer | Float]
+          value.to_f
+        in [[item], Array]
+          value.each_with_index.map { |entry, index| coerce(item, entry, "#{path}[#{index}]") }
+        in [Module, Hash]
+          build(type, value, path)
+        else
+          raise DecodeError, "Expected #{type.inspect} at #{path}, got #{value.inspect}"
+        end
+      end
+      private_class_method :attribute, :coerce
+    end
+  end
+end