oppex_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ce463caa1bcc1b906080cb3d1ba1dbd4692a0fc9c4006e2a69671f8322b1e5e
+  data.tar.gz: dc4fc5631407d977ea9a1c793e93d5a5e438b1d7edfc4f74bb9c164b8d759de2
+SHA512:
+  metadata.gz: 6715b69c38246a93df9d9f9972375768f7d2ffceedd96990713cb58e2f23feb5629bb7b1f75ec04ccfe2f32f9495932427c3d69b76f8e7d2687295b415027c9e
+  data.tar.gz: 89ed9f0eafe9fa8895b25e21f4f8dc45feca6d1aec1ae8d21532ffb1e3b61a491d122a51c3576aced2b3563f1603b869e5d5096c11b3fef1b1f02cde7ff0cfd3

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,166 @@
+# Oppex Ruby SDK
+
+A dependency-free Ruby client for posting incidents to Oppex.
+
+```text
+POST https://api.oppex.ai/api/v1/incident/post
+```
+
+## Requirements
+
+Ruby 3.2 or newer. This SDK supports the current stable Ruby release only, and
+its `required_ruby_version` floor moves forward with it. The standard library is
+the only dependency.
+
+## Install
+
+```shell
+gem install oppex_sdk
+```
+
+```ruby
+gem "oppex_sdk", "~> 1.0"
+```
+
+## Usage
+
+Create one client per application, share it across threads, and close it during
+shutdown.
+
+```ruby
+require "oppex_sdk"
+
+client = Oppex::IncidentClient.new(
+  api_key: ENV.fetch("OPPEX_API_KEY"),
+  service_key: ENV.fetch("OPPEX_SERVICE_KEY")
+)
+
+response = client.post(
+  Oppex::IncidentRequest.new(
+    title: "Checkout latency breached the SLO",
+    source: "checkout-api",
+    severity: Oppex::Severity::HIGH,
+    details: JSON.generate({ p99Millis: 1200 })
+  )
+)
+puts response.incident_id
+
+client.close
+```
+
+`IncidentClient.open` closes the client for you, even if the block raises:
+
+```ruby
+Oppex::IncidentClient.open(api_key: ENV.fetch("OPPEX_API_KEY")) do |client|
+  client.post_with_service_routing(request)
+end
+```
+
+`title`, `source` and `severity` are required. Every other field is optional, and
+an absent optional field is left out of the payload rather than sent as null. An
+optional field that is *present but blank* is rejected, because that is nearly
+always a bug at the call site. `priority` defaults to 1 and `src_timestamp`
+defaults to the current time in milliseconds since the Unix epoch.
+
+`IncidentRequest` validates in its constructor and freezes itself, so a malformed
+incident is rejected at the call site rather than inside a worker thread.
+
+### Service routing
+
+The service key is optional. A client built with only an `api_key` posts with
+`post_with_service_routing`, which omits `serviceKey` so Oppex resolves the
+target service itself. The request must not carry its own service key in that
+case.
+
+A request's own `service_key` overrides the client's.
+
+### Fire and forget
+
+`post_async` and `post_async_with_service_routing` queue a best-effort delivery
+and return immediately. The closed-client and service-key checks still run on the
+calling thread, so a misuse is raised to you rather than lost in a worker. A
+delivery failure after queueing is logged at debug level.
+
+### Errors
+
+| Situation | Raised |
+| --- | --- |
+| Invalid argument value | `ArgumentError` |
+| Argument of the wrong type | `TypeError` |
+| Any post after `close` | `Oppex::ClientClosedError` |
+| Delivery failure | `Oppex::IncidentError` |
+
+`Oppex::ClientClosedError` and `Oppex::IncidentError` both descend from
+`Oppex::Error`, so one `rescue` catches everything this SDK raises on its own.
+
+```ruby
+begin
+  client.post(request)
+rescue Oppex::IncidentError => e
+  retry_later if e.retryable?
+  logger.error("oppex rejected the incident: HTTP #{e.status_code}") if e.http_status?
+end
+```
+
+`IncidentError#status_code` is `-1` when the delivery never reached a status
+line; `#http_status?` answers that directly.
+
+### Severity
+
+`Oppex::Severity::LOWEST` (1) through `Oppex::Severity::CRITICAL` (5). The
+constants are the wire values, so an integer from another system can be passed
+straight through after `Oppex::Severity.validate!`.
+
+### Logging
+
+Pass any object that responds to `debug`, `info`, `warn` and `error`:
+
+```ruby
+Oppex::IncidentClient.new(api_key: key, logger: Rails.logger)
+```
+
+The default writes to standard error. This SDK deliberately does not require the
+`logger` standard library, which stops being a default gem in Ruby 4.0 — duck
+typing keeps the gem dependency-free and accepts your logger either way.
+
+## Delivery behavior
+
+- 3 second open timeout, 5 second read and write timeouts.
+- HTTP 429, 500, 502, 503 and 504, plus failures that never reached a status
+  line, retry after 0.5s, 1s, 2s, 4s and 8s. Every other status fails
+  immediately.
+- Asynchronous delivery is best effort through a queue bounded at 5000 that drops
+  the oldest entry under saturation. Drops are counted and summarized at most once
+  a minute.
+- `close` drains for up to 10 seconds, then abandons the rest.
+
+None of these are configurable. They are part of the incident contract every
+Oppex SDK shares, not per-caller settings.
+
+## Build and test
+
+```shell
+cd ruby
+bundle install
+bundle exec rake        # rubocop, then the minitest suite
+```
+
+Tests run against a loopback stub server, so the suite is network-free beyond
+loopback and never reaches the real Oppex service.
+
+## Release
+
+Tag `ruby-vX.Y.Z`. The release workflow builds the gem, verifies those exact
+bytes against an external consumer, and pushes them to RubyGems without
+rebuilding.
+
+```shell
+git tag ruby-v1.0.0
+git push origin ruby-v1.0.0
+```
+
+The tag's version must match `Oppex::VERSION`; the workflow fails if it does not.
+
+## License
+
+[Apache License 2.0](LICENSE).

data/lib/oppex_sdk/endpoint.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Oppex
+  # The Oppex incident endpoint every client posts to.
+  DEFAULT_ENDPOINT = "https://api.oppex.ai/api/v1/incident/post"
+end

data/lib/oppex_sdk/errors.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Oppex
+  # Base class for every error this SDK raises on its own. Rescue this to catch
+  # them all without also catching an +ArgumentError+ from your own code.
+  class Error < StandardError; end
+
+  # Raised by any post made after IncidentClient#close.
+  class ClientClosedError < Error
+    def initialize(message = "the incident client is closed")
+      super
+    end
+  end
+
+  # Raised when delivery was attempted and failed.
+  class IncidentError < Error
+    # The HTTP status, or NO_STATUS_CODE when the delivery never reached a
+    # status line.
+    NO_STATUS_CODE = -1
+
+    # @return [Integer] the HTTP status, or {NO_STATUS_CODE}.
+    attr_reader :status_code
+
+    # @return [Exception, nil] the underlying transport or parsing failure.
+    attr_reader :cause_error
+
+    def initialize(message, status_code: NO_STATUS_CODE, retryable: false, cause_error: nil)
+      super(message)
+      @status_code = status_code
+      @retryable = retryable
+      @cause_error = cause_error
+    end
+
+    # @return [Boolean] whether the failure was eligible for retry.
+    def retryable?
+      @retryable
+    end
+
+    # @return [Boolean] whether an HTTP status was received at all.
+    def http_status?
+      @status_code != NO_STATUS_CODE
+    end
+  end
+end

data/lib/oppex_sdk/incident_client.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+require_relative "incident_request"
+require_relative "internal/async_dispatcher"
+require_relative "internal/http_executor"
+require_relative "internal/interrupt"
+require_relative "internal/retry_executor"
+require_relative "internal/wire_codec"
+require_relative "logging"
+
+module Oppex
+  # Posts incidents to Oppex.
+  #
+  #   client = Oppex::IncidentClient.new(api_key: "api-key", service_key: "service-key")
+  #   client.post(request)
+  #   client.close
+  #
+  # The client is thread safe and intended to be shared. Create one per
+  # application and close it during shutdown. It is also usable as a block:
+  #
+  #   Oppex::IncidentClient.open(api_key: "api-key") do |client|
+  #     client.post_with_service_routing(request)
+  #   end
+  class IncidentClient
+    # Creates a client, yields it, and closes it even if the block raises.
+    #
+    # @yieldparam client [IncidentClient]
+    def self.open(...)
+      client = new(...)
+      begin
+        yield client
+      ensure
+        client.close
+      end
+    end
+
+    # @param api_key [String] sent in the +X-API-KEY+ header. Required.
+    # @param service_key [String, nil] the default service for incidents that do
+    #   not carry their own. When omitted, incidents must either supply one or be
+    #   posted with {#post_with_service_routing}.
+    # @param logger [#debug, #info, #warn, #error] receives this client's
+    #   internal logging. Any object with those four methods works, including a
+    #   standard +Logger+, +Rails.logger+, or your own.
+    def initialize(api_key:, service_key: nil, logger: StderrLogger.new)
+      @api_key = validate_api_key(api_key)
+      @service_key = blank_to_nil(service_key, "service_key")
+      @logger = logger
+      @http_executor = Internal::HttpExecutor.new(@api_key)
+      @interrupt = Internal::Interrupt.new
+      @dispatcher = Internal::AsyncDispatcher.new(logger)
+      @retry_delays = Internal::RetryExecutor::DEFAULT_DELAYS
+      @closed = false
+      @lifecycle = Mutex.new
+    end
+
+    # Posts on the calling thread, including any retry delays. The request's own
+    # service key overrides the client's.
+    #
+    # @return [IncidentResponse]
+    # @raise [ClientClosedError] after {#close}
+    # @raise [ArgumentError] when neither the client nor the request carries a
+    #   service key
+    # @raise [IncidentError] when delivery fails
+    def post(request)
+      ensure_open!
+      require_service_key!(request)
+      deliver(request, @service_key)
+    end
+
+    # Posts without a service key so Oppex resolves the target service itself.
+    # The request must not carry its own service key. Otherwise identical to
+    # {#post}.
+    #
+    # @return [IncidentResponse]
+    def post_with_service_routing(request)
+      ensure_open!
+      require_service_routable!(request)
+      deliver(request, nil)
+    end
+
+    # Queues a best-effort delivery and returns immediately.
+    #
+    # The closed-client and service-key checks still run on the calling thread, so
+    # a misuse is raised to the caller rather than lost in a worker. A delivery
+    # failure after queueing is logged at debug level.
+    #
+    # @return [void]
+    def post_async(request)
+      ensure_open!
+      require_service_key!(request)
+      submit(request, @service_key)
+    end
+
+    # Queues a best-effort service-routed delivery. The request must not carry its
+    # own service key.
+    #
+    # @return [void]
+    def post_async_with_service_routing(request)
+      ensure_open!
+      require_service_routable!(request)
+      submit(request, nil)
+    end
+
+    # @return [Boolean] whether {#close} has been called.
+    def closed?
+      @lifecycle.synchronize { @closed }
+    end
+
+    # Drains queued work for up to ten seconds, then releases every owned
+    # resource. Idempotent, and safe to call from any thread.
+    #
+    # @return [void]
+    def close
+      @lifecycle.synchronize do
+        return if @closed
+
+        @closed = true
+      end
+      # Signalled before the drain so a worker sitting in an eight-second backoff
+      # gives up now instead of consuming the whole drain budget.
+      @interrupt.signal
+      @dispatcher.close
+      @http_executor.close
+      nil
+    end
+
+    private
+
+    def validate_api_key(api_key)
+      raise TypeError, "api_key must be a String" unless api_key.is_a?(String)
+      raise ArgumentError, "api_key must not be blank" if api_key.strip.empty?
+
+      api_key
+    end
+
+    def blank_to_nil(value, field)
+      return nil if value.nil?
+      raise TypeError, "#{field} must be a String" unless value.is_a?(String)
+
+      value.strip.empty? ? nil : value
+    end
+
+    def ensure_open!
+      raise ClientClosedError if closed?
+    end
+
+    # Service routing is the only delivery mode available when no service key is
+    # configured anywhere.
+    def require_service_key!(request)
+      return unless @service_key.nil? && request.service_key.nil?
+
+      raise ArgumentError, "no service_key is configured on the client or the request; " \
+                           "supply one or use post_with_service_routing"
+    end
+
+    def require_service_routable!(request)
+      return if request.service_key.nil?
+
+      raise ArgumentError, "request must not carry a service_key when service routing is used"
+    end
+
+    def submit(request, default_service_key)
+      accepted = @dispatcher.submit do
+        # No closed check here: close drains the dispatcher before releasing the
+        # transport, so a task queued before close still has a live connection,
+        # and a task submitted after close was already refused above.
+        deliver(request, default_service_key)
+      rescue IncidentError => e
+        @logger.debug("oppex: asynchronous incident delivery failed: #{e.message}")
+      end
+      raise ClientClosedError unless accepted
+
+      nil
+    end
+
+    # Serializes, sends and retries a single incident. The request's own service
+    # key wins over +default_service_key+.
+    def deliver(request, default_service_key)
+      service_key = request.service_key || default_service_key
+      payload = Internal::WireCodec.serialize_request(request, service_key)
+      Internal::RetryExecutor.execute(@interrupt, delays: @retry_delays) do
+        @http_executor.execute(payload)
+      end
+    end
+  end
+end