flagnetic-openfeature 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b8443b9c799dd20694cccb040452648192b3584cbcf6469e9868afe72b71fde
+  data.tar.gz: c34b9f5a3fc371ee2c43172c11c2b2b458790b8a1dd112d46b831e3918d3c86a
+SHA512:
+  metadata.gz: 42e444d782b790644d79c2f6c0beae51e8dc84ef56d63ba117ca3cecbef3baf720eee4bff2a5f9054d0836f63432d3d4e9ec2b46b091320e62ae5469d983778f
+  data.tar.gz: 04541702d6479b529b2bf999afe1a01298fe0c295c3ea8ecb4ecff58b258b0241411e9ad22fd288771ab1d36144a209a4454eab568cea9321414256b2edf3bc5

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,88 @@
+# Flagnetic OpenFeature provider for Ruby
+
+`flagnetic-openfeature` is an [OpenFeature](https://openfeature.dev) provider over the [Flagnetic Ruby SDK](../ruby/README.md), for a service already standardised on OpenFeature. It is a gem of its own, so `flagnetic` itself stays free of the OpenFeature dependency.
+
+Requires Ruby 3.4 or later and `openfeature-sdk` 0.6.1 or a later 0.x release.
+
+## Install
+
+```bash
+bundle add flagnetic-openfeature
+```
+
+## Wiring
+
+```ruby
+require "flagnetic/openfeature"
+
+provider = Flagnetic::OpenFeature::Provider.new(
+  ENV.fetch("FLAGNETIC_SDK_KEY"),
+  base_url: "https://flags.example.com",
+  unit_type: "user",  # the unit type of the targeting key
+  ready_timeout: 2,   # seconds init waits for the first ruleset
+  store: "/var/lib/myservice/flagnetic-ruleset.json" # any further option goes to Flagnetic::Client.new
+)
+OpenFeature::SDK.configure { |config| config.set_provider_and_wait(provider) }
+client = OpenFeature::SDK.build_client
+
+context = OpenFeature::SDK::EvaluationContext.new(targeting_key: "u-1001", plan: "pro")
+client.fetch_boolean_value(flag_key: "new_checkout", default_value: false, evaluation_context: context)
+```
+
+- Boolean, string, number, integer, float and object evaluations go through the client's `detail`. Integers follow its `int` getter: a number that is not whole serves the default with `TYPE_MISMATCH`. Floats serve a whole number as a `Float`.
+- The targeting key is the unit ID of `unit_type` (`user` by default); further unit types travel in the evaluation context's `units` attribute, as `units: { "anonymous" => "d-8f1c" }`. Every other attribute is an attribute of the Flagnetic context.
+- `init` waits for the first ruleset up to `ready_timeout` and never fails: a provider at built-in defaults still serves them. `shutdown` closes the client, flushing what is queued.
+- `provider.client` returns the wrapped `Flagnetic::Client`: local overrides, the recorder of an offline client (`offline:` for tests), flush and status.
+- A `logger:` keeps receiving every log event of the client.
+
+## Events
+
+| When | Event |
+|---|---|
+| `init` returns | `PROVIDER_READY`, or `PROVIDER_ERROR` when the SDK key was refused; `PROVIDER_STALE` follows when only a last good ruleset is held |
+| A ruleset is accepted, or a local override changes | `PROVIDER_CONFIGURATION_CHANGED` with the keys of the flags that may have changed |
+| The client falls back to its last good ruleset | `PROVIDER_STALE` |
+| The client is fresh again | `PROVIDER_READY` |
+| The SDK key is refused | `PROVIDER_ERROR` (`GENERAL`), kept until the key is accepted again |
+
+With `openfeature-sdk` releases before 0.7 the SDK itself sends `PROVIDER_READY` once `init` returns, so a key refused before then reads as ready until the client recovers.
+
+## Reasons
+
+Flagnetic reasons map to OpenFeature reasons the same way in every Flagnetic provider, in every language, fixed by [`conformance/openfeature/reasons.json`](../../conformance/openfeature/reasons.json):
+
+| Flagnetic | OpenFeature |
+|---|---|
+| `rule`, `prerequisite_failed`, `targeting_match`, `override` | `TARGETING_MATCH` |
+| `rollout`, `experiment` | `SPLIT` |
+| `fallthrough` | `DEFAULT` |
+| `off` | `DISABLED` |
+| `error`, `fallback` | `ERROR` |
+| `local_override` | `STATIC` |
+
+A fallback is an `ERROR` whose error code is `FLAG_NOT_FOUND`, `TYPE_MISMATCH` or `GENERAL`, with the Flagnetic error code as its message. The Flagnetic reason itself travels in the flag metadata under `flagnetic_reason`, beside `stage`, `ruleset_version`, `variation` and `overridden` (`ruleset_version` and `variation` only when there is one). An evaluation an experiment decided is a `SPLIT` whose metadata carries the experiment block: `experiment_key`, `experiment_variation`, `experiment_unit_type`, `experiment_unit_id`, `experiment_inclusion_bucket`, `experiment_variation_bucket` and `experiment_override`.
+
+## Track
+
+```ruby
+client.track("exposure", evaluation_context: context,
+                         tracking_event_details: OpenFeature::SDK::TrackingEventDetails.new(flag: "checkout_v2"))
+client.track("alias", tracking_event_details: OpenFeature::SDK::TrackingEventDetails.new(
+  fromUnitType: "anonymous", fromUnitId: "d-8f1c", toUnitType: "user", toUnitId: "u-1001"
+))
+```
+
+`exposure` records the exposure of the most recent evaluation of that flag for that context, as the client's `exposure` does, and `alias` links two unit IDs, as `alias` does. Any other event name, or one missing an attribute, does nothing. An evaluation alone never records an exposure, unless the flag asks for automatic exposure.
+
+## Development
+
+The provider is developed against the `flagnetic` gem in `../ruby`, whatever its version, through `tree.gemfile`; the plain `Gemfile` resolves `flagnetic` from RubyGems, as a consumer's bundle does.
+
+```bash
+export BUNDLE_GEMFILE=tree.gemfile
+bundle install
+bundle exec rake test   # every conformance case through the provider, the shared OpenFeature reasons, events and track
+bundle exec rubocop
+```
+
+`OPENFEATURE_SDK_VERSION=0.6.1` pins `openfeature-sdk` to the oldest release the gem supports, in either bundle.

data/lib/flagnetic/openfeature/mapping.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Flagnetic
+  # The mapping from Flagnetic to OpenFeature every Flagnetic provider
+  # shares: reasons, error codes, flag metadata and the evaluation context.
+  module OpenFeature
+    # REASON_METADATA_KEY is the flag metadata key carrying the Flagnetic
+    # evaluation reason, which OpenFeature's coarser reason cannot tell
+    # apart: a rule and a failed prerequisite are both TARGETING_MATCH.
+    REASON_METADATA_KEY = "flagnetic_reason"
+
+    # reason_of returns the OpenFeature reason of a Flagnetic evaluation
+    # reason (a Symbol or String). A reason a newer server adds is UNKNOWN
+    # rather than passed off as a known one; the Flagnetic reason still
+    # travels in the flag metadata.
+    def self.reason_of(reason)
+      Mapping::REASONS.fetch(reason.to_s, ::OpenFeature::SDK::Provider::Reason::UNKNOWN)
+    end
+
+    # Mapping turns what the client serves into what OpenFeature expects;
+    # Provider is its one user.
+    module Mapping
+      # REASONS maps every Flagnetic evaluation reason to its OpenFeature
+      # reason, identically in every provider of every language, so
+      # dashboards agree across services. targeting_match is what a client
+      # key is told in place of the reasons targeting decided, and error is
+      # the evaluator's reason a getter turns into fallback.
+      REASONS = {
+        "rule" => ::OpenFeature::SDK::Provider::Reason::TARGETING_MATCH,
+        "prerequisite_failed" => ::OpenFeature::SDK::Provider::Reason::TARGETING_MATCH,
+        "targeting_match" => ::OpenFeature::SDK::Provider::Reason::TARGETING_MATCH,
+        "override" => ::OpenFeature::SDK::Provider::Reason::TARGETING_MATCH,
+        "rollout" => ::OpenFeature::SDK::Provider::Reason::SPLIT,
+        "experiment" => ::OpenFeature::SDK::Provider::Reason::SPLIT,
+        "fallthrough" => ::OpenFeature::SDK::Provider::Reason::DEFAULT,
+        "off" => ::OpenFeature::SDK::Provider::Reason::DISABLED,
+        "error" => ::OpenFeature::SDK::Provider::Reason::ERROR,
+        "fallback" => ::OpenFeature::SDK::Provider::Reason::ERROR,
+        "local_override" => ::OpenFeature::SDK::Provider::Reason::STATIC
+      }.freeze
+
+      # ERROR_CODES names the two Flagnetic error codes OpenFeature has an
+      # identity for; every other reason for a fallback is GENERAL.
+      ERROR_CODES = {
+        flag_not_found: ::OpenFeature::SDK::Provider::ErrorCode::FLAG_NOT_FOUND,
+        type_mismatch: ::OpenFeature::SDK::Provider::ErrorCode::TYPE_MISMATCH
+      }.freeze
+
+      # The attribute of an evaluation context carrying further unit IDs by
+      # unit type, beside the targeting key.
+      UNITS_ATTRIBUTE = "units"
+
+      module_function
+
+      # resolution turns a served Flagnetic::Detail into OpenFeature
+      # ResolutionDetails: a fallback is an ERROR carrying the mapped error
+      # code and the Flagnetic one as its message, anything else the mapped
+      # reason with its variation as the variant.
+      def resolution(detail)
+        if detail.reason == :fallback
+          return ::OpenFeature::SDK::Provider::ResolutionDetails.new(
+            value: detail.value, reason: ::OpenFeature::SDK::Provider::Reason::ERROR,
+            error_code: ERROR_CODES.fetch(detail.error_code, ::OpenFeature::SDK::Provider::ErrorCode::GENERAL),
+            error_message: detail.error_code.to_s, flag_metadata: flag_metadata(detail)
+          )
+        end
+
+        ::OpenFeature::SDK::Provider::ResolutionDetails.new(
+          value: detail.value, variant: detail.variation, reason: OpenFeature.reason_of(detail.reason),
+          flag_metadata: flag_metadata(detail)
+        )
+      end
+
+      # flag_metadata carries a detail's Flagnetic reason, stage, ruleset
+      # version, variation and platform override, and its experiment block
+      # without the salts, flattened to the scalar values flag metadata
+      # holds. What the detail has none of is left out: a scalar has no
+      # value meaning absent.
+      def flag_metadata(detail)
+        metadata = { REASON_METADATA_KEY => detail.reason.to_s, "stage" => detail.stage.to_s,
+                     "ruleset_version" => detail.ruleset_version, "variation" => detail.variation,
+                     "overridden" => detail.overridden }.compact
+        experiment = detail.experiment
+        return metadata unless experiment
+
+        metadata.merge(
+          "experiment_key" => experiment.key, "experiment_variation" => experiment.variation,
+          "experiment_unit_type" => experiment.unit_type, "experiment_unit_id" => experiment.unit_id,
+          "experiment_inclusion_bucket" => experiment.inclusion_bucket,
+          "experiment_variation_bucket" => experiment.variation_bucket, "experiment_override" => experiment.override
+        )
+      end
+
+      # context turns an OpenFeature EvaluationContext, or nil, into a
+      # Flagnetic context: the targeting key is the unit ID of unit_type,
+      # the units attribute (a Hash of unit type to unit ID) adds further
+      # units, and every other attribute is an attribute.
+      def context(evaluation_context, unit_type)
+        units = {}
+        attributes = {}
+        evaluation_context&.fields&.each do |key, value|
+          next if key == ::OpenFeature::SDK::EvaluationContext::TARGETING_KEY
+
+          if key == UNITS_ATTRIBUTE
+            units.merge!(unit_ids(value))
+          else
+            attributes[key] = value
+          end
+        end
+        targeting_key = evaluation_context&.targeting_key
+        units[unit_type] = targeting_key if targeting_key.is_a?(String) && !targeting_key.empty?
+        { units: units, attributes: attributes }
+      end
+
+      def unit_ids(value)
+        return {} unless value.is_a?(Hash)
+
+        value.each_with_object({}) do |(unit_type, unit_id), out|
+          out[unit_type.to_s] = unit_id if unit_id.is_a?(String)
+        end
+      end
+    end
+    private_constant :Mapping
+  end
+end

data/lib/flagnetic/openfeature/provider.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module Flagnetic
+  module OpenFeature
+    # Provider serves the values of a Flagnetic::Client it builds and owns
+    # to the OpenFeature API.
+    #
+    #   provider = Flagnetic::OpenFeature::Provider.new(ENV.fetch("FLAGNETIC_SDK_KEY"),
+    #                                                   base_url: "https://flags.example.com")
+    #   OpenFeature::SDK.configure { |config| config.set_provider_and_wait(provider) }
+    #   client = OpenFeature::SDK.build_client
+    #   client.fetch_boolean_value(flag_key: "new_checkout", default_value: false,
+    #                              evaluation_context: OpenFeature::SDK::EvaluationContext.new(targeting_key: "u-1001"))
+    #
+    # Reasons map as every Flagnetic provider maps them (reason_of), the
+    # Flagnetic reason itself in the flag metadata under
+    # REASON_METADATA_KEY. Exposures and aliases go through track:
+    #
+    #   client.track("exposure", evaluation_context: context,
+    #                tracking_event_details: OpenFeature::SDK::TrackingEventDetails.new(flag: "pricing"))
+    #   client.track("alias", tracking_event_details: OpenFeature::SDK::TrackingEventDetails.new(
+    #     fromUnitType: "anonymous", fromUnitId: "d-1", toUnitType: "user", toUnitId: "u-1001"
+    #   ))
+    #
+    # Events: CONFIGURATION_CHANGED with the keys of the flags that may have
+    # changed; STALE when the client moves to stage last_good; READY when it
+    # is fresh again; ERROR when the SDK key is revoked, kept until the key
+    # is accepted again.
+    class Provider
+      include ::OpenFeature::SDK::Provider::EventEmitter
+
+      NAME = "flagnetic"
+      DEFAULT_UNIT_TYPE = "user"
+      DEFAULT_READY_TIMEOUT = 10
+
+      # The tracking event names every Flagnetic provider accepts, and the
+      # attributes alias reads.
+      TRACK_EXPOSURE = "exposure"
+      TRACK_ALIAS = "alias"
+      ALIAS_ATTRIBUTES = %w[fromUnitType fromUnitId toUnitType toUnitId].freeze
+      private_constant :TRACK_EXPOSURE, :TRACK_ALIAS, :ALIAS_ATTRIBUTES
+
+      # Whether the OpenFeature SDK lets a provider announce its own state
+      # after init (0.7 and later). Older releases send READY themselves
+      # once init returns, whatever the provider found.
+      LIFECYCLE_EVENTS = ::OpenFeature::SDK::Configuration.private_method_defined?(:emits_lifecycle_events?)
+      private_constant :LIFECYCLE_EVENTS
+
+      # client is the wrapped Flagnetic::Client: local overrides, the
+      # recorder of an offline client, flush and status.
+      attr_reader :client, :metadata
+
+      # new builds a Flagnetic::Client for sdk_key and base_url with every
+      # further option as Flagnetic::Client.new takes it (offline for tests
+      # included), and fails exactly when that does.
+      #
+      # - unit_type: the unit type the targeting key is a unit ID of;
+      #   default "user". The units attribute, a Hash of unit type to unit
+      #   ID, adds further units; every other attribute is an attribute of
+      #   the context.
+      # - ready_timeout: seconds init waits for the client's first fetch;
+      #   default 10. init never fails: at stage built_in the fallback
+      #   chain still serves the built-in defaults.
+      # - logger: as Flagnetic::Client.new; it keeps receiving every log
+      #   event.
+      def initialize(sdk_key = nil, base_url: nil, unit_type: DEFAULT_UNIT_TYPE,
+                     ready_timeout: DEFAULT_READY_TIMEOUT, logger: nil, **client_options)
+        @unit_type = unit_type.to_s
+        @ready_timeout = ready_timeout
+        @metadata = ::OpenFeature::SDK::Provider::ProviderMetadata.new(name: NAME).freeze
+        @log = Flagnetic::Logging.adapt(logger)
+        @initialized = false
+        @closed = false
+        @revoked = false
+        @client = Flagnetic::Client.new(sdk_key, base_url: base_url, logger: method(:observe), **client_options)
+        @unsubscribe = [@client.on_change { |keys| changed(keys) }, @client.on_stage { |stage| staged(stage) }]
+      end
+
+      # emits_lifecycle_events? tells the OpenFeature SDK that init
+      # announces the provider's state itself.
+      def emits_lifecycle_events? = true
+
+      # init waits for the client's first fetch, at most ready_timeout
+      # seconds, and never raises. Until it returns, stage changes and a
+      # revoked key send no event; init then announces what the client
+      # reached.
+      def init(_evaluation_context = nil)
+        @client.ready(timeout: @ready_timeout)
+        @initialized = true
+        announce if LIFECYCLE_EVENTS
+        nil
+      end
+
+      # shutdown closes the wrapped client, which reports what is queued
+      # one last time; no event is sent after it.
+      def shutdown
+        @closed = true
+        @unsubscribe.each(&:call)
+        @client.close
+        nil
+      end
+
+      def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+        Mapping.resolution(detail(flag_key, default_value, evaluation_context))
+      end
+
+      def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+        Mapping.resolution(detail(flag_key, default_value, evaluation_context))
+      end
+
+      # fetch_number_value serves a number flag as the ruleset has it, an
+      # Integer or a Float.
+      def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+        Mapping.resolution(detail(flag_key, default_value, evaluation_context))
+      end
+
+      # fetch_integer_value serves a number flag as an Integer, as the
+      # client's int getter does: a number that is not whole serves
+      # default_value with TYPE_MISMATCH rather than a truncated value.
+      def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+        Mapping.resolution(integral(detail(flag_key, default_value, evaluation_context), default_value))
+      end
+
+      # fetch_float_value serves a number flag as a Float.
+      def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+        served = detail(flag_key, default_value, evaluation_context)
+        served = Flagnetic::Detail.new(**served.to_h, value: served.value.to_f) if served.reason != :fallback
+        Mapping.resolution(served)
+      end
+
+      # fetch_object_value serves a JSON flag's value, parsed and frozen.
+      def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+        Mapping.resolution(detail(flag_key, default_value, evaluation_context))
+      end
+
+      # track reports the exposure of the flag named by the flag attribute
+      # for evaluation_context, as Flagnetic::Client#exposure does, for the
+      # event "exposure"; for "alias" it records the alias named by the
+      # fromUnitType, fromUnitId, toUnitType and toUnitId attributes. An
+      # event naming neither, or missing what its mapping needs, does
+      # nothing.
+      def track(tracking_event_name, evaluation_context: nil, tracking_event_details: nil)
+        fields = tracking_event_details&.fields || {}
+        case tracking_event_name
+        when TRACK_EXPOSURE
+          flag = fields["flag"]
+          @client.exposure(flag, context: context(evaluation_context)) if present?(flag)
+        when TRACK_ALIAS
+          units = fields.values_at(*ALIAS_ATTRIBUTES)
+          @client.alias(*units) if units.all? { |unit| present?(unit) }
+        end
+        nil
+      end
+
+      private
+
+      def detail(flag_key, default_value, evaluation_context)
+        @client.detail(flag_key, default: default_value, context: context(evaluation_context))
+      end
+
+      def context(evaluation_context) = Mapping.context(evaluation_context, @unit_type)
+
+      def present?(value) = value.is_a?(String) && !value.empty?
+
+      # integral narrows a served number to an Integer; one that is not
+      # whole is a type mismatch, served as the fallback the client's own
+      # int getter serves.
+      def integral(served, default_value)
+        return served if served.reason == :fallback || served.value.is_a?(Integer)
+
+        value = served.value
+        if value.is_a?(Float) && value.finite? && value.to_r.denominator == 1
+          return Flagnetic::Detail.new(**served.to_h, value: value.to_i)
+        end
+
+        Flagnetic::Detail.new(value: default_value, reason: :fallback, error_code: :type_mismatch,
+                              ruleset_version: served.ruleset_version, received_at: served.received_at,
+                              stage: served.stage)
+      end
+
+      # announce sends the state init found: ERROR on a revoked key, else
+      # READY, followed by STALE when only a last good ruleset is held.
+      def announce
+        return error if @revoked
+
+        emit(::OpenFeature::SDK::ProviderEvent::PROVIDER_READY)
+        stale if @client.stage == :last_good
+      end
+
+      def changed(keys)
+        emit(::OpenFeature::SDK::ProviderEvent::PROVIDER_CONFIGURATION_CHANGED, flags_changed: keys)
+      end
+
+      # staged sends READY on every move to fresh, so the OpenFeature status
+      # leaves STALE or ERROR when the client recovers, and STALE on a move
+      # to last_good. A revoked key moves a fresh client to last_good right
+      # after the ERROR it sent: STALE would hide the ERROR, so none is sent
+      # while the key stays revoked. A move to fresh clears the revoked key
+      # even before init returns, so init does not announce an ERROR the
+      # client has already recovered from.
+      def staged(stage)
+        @revoked = false if stage == :fresh
+        return unless @initialized
+
+        case stage
+        when :fresh
+          emit(::OpenFeature::SDK::ProviderEvent::PROVIDER_READY)
+        when :last_good
+          stale unless @revoked
+        end
+      end
+
+      def stale
+        emit(::OpenFeature::SDK::ProviderEvent::PROVIDER_STALE, message: "flagnetic: ruleset stage is last_good")
+      end
+
+      def error
+        emit(::OpenFeature::SDK::ProviderEvent::PROVIDER_ERROR,
+             error_code: ::OpenFeature::SDK::Provider::ErrorCode::GENERAL, message: "flagnetic: sdk key revoked")
+      end
+
+      # observe is the client's logger: the application's own, plus ERROR
+      # when the SDK key is revoked, the one fetch failure stage last_good
+      # alone does not tell from an ordinary outage. The event goes first:
+      # the client ignores a logger that raises, which would otherwise lose
+      # the event as well.
+      def observe(level, event, fields)
+        if event == :key_revoked
+          @revoked = true
+          error if @initialized
+        end
+        @log.call(level, event, fields)
+      end
+
+      def emit(event, details = {})
+        return if @closed
+
+        emit_event(event, details)
+      rescue StandardError => e
+        @log.call(:error, :listener_failed, { cause: "#{e.class}: #{e.message}" })
+      end
+    end
+  end
+end

data/lib/flagnetic/openfeature/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Flagnetic
+  module OpenFeature
+    VERSION = "0.1.0"
+  end
+end

data/lib/flagnetic/openfeature.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "flagnetic"
+require "open_feature/sdk"
+
+require_relative "openfeature/version"
+require_relative "openfeature/mapping"
+require_relative "openfeature/provider"
+
+module Flagnetic
+  # OpenFeature serves Flagnetic flags through the OpenFeature API. The
+  # flagnetic gem stays free of the OpenFeature dependency; an application
+  # on OpenFeature adds this gem beside it. Start with Provider.
+  module OpenFeature
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: flagnetic-openfeature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anatolii Zverev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flagnetic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: openfeature-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+description: Serves Flagnetic flags through the OpenFeature API, with exposures and
+  aliases through track.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/flagnetic/openfeature.rb
+- lib/flagnetic/openfeature/mapping.rb
+- lib/flagnetic/openfeature/provider.rb
+- lib/flagnetic/openfeature/version.rb
+homepage: https://github.com/azverinus/flagnetic
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/azverinus/flagnetic/tree/main/sdks/ruby-openfeature
+  changelog_uri: https://github.com/azverinus/flagnetic/blob/main/sdks/ruby-openfeature/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: OpenFeature provider for Flagnetic
+test_files: []