mixpanel-ruby 2.3.0 → 3.1.0

data/openfeature-provider/RELEASE.md

@@ -0,0 +1,52 @@
+# Releasing the OpenFeature Provider
+
+The OpenFeature provider (`mixpanel-ruby-openfeature`) is published to RubyGems independently from the core SDK.
+
+## Release Order
+
+The OpenFeature provider depends on features added to `mixpanel-ruby` in version 3.1.0+ (e.g., `shutdown` methods on flags providers). You **must** publish the core SDK first:
+
+1. Publish `mixpanel-ruby` (bump version in `lib/mixpanel-ruby/version.rb`, build, push)
+2. Verify the new version is live on https://rubygems.org/gems/mixpanel-ruby
+3. Then publish `mixpanel-ruby-openfeature` (steps below)
+
+If you update the core SDK version, update the dependency constraint in `mixpanel-ruby-openfeature.gemspec` to match.
+
+## Prerequisites
+
+- Ruby 3.1+
+- A RubyGems account with permission to push to the `mixpanel-ruby-openfeature` gem
+  - For the first upload, you'll need owner access or to create the gem under the Mixpanel org
+  - Sign in and get your API key at https://rubygems.org/profile/edit
+
+## Releasing
+
+1. Update the version in `mixpanel-ruby-openfeature.gemspec`
+
+2. Build the gem:
+   ```bash
+   cd openfeature-provider
+   gem build mixpanel-ruby-openfeature.gemspec
+   ```
+
+3. Verify the built artifact:
+   ```bash
+   ls *.gem
+   # Should show: mixpanel-ruby-openfeature-<version>.gem
+   ```
+
+4. Push to RubyGems:
+   ```bash
+   gem push mixpanel-ruby-openfeature-<version>.gem
+   ```
+   You'll be prompted for your RubyGems credentials on first push. Alternatively, configure `~/.gem/credentials` with your API key:
+   ```yaml
+   ---
+   :rubygems_api_key: rubygems_<your-key>
+   ```
+
+5. Verify at https://rubygems.org/gems/mixpanel-ruby-openfeature
+
+## Versioning
+
+The OpenFeature provider is versioned independently from the core SDK. The core SDK dependency is declared in the gemspec (`mixpanel-ruby ~> 3.0`) — update it when the provider needs features from a newer core SDK release.

data/openfeature-provider/lib/mixpanel/openfeature/provider.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'open_feature/sdk'
+
+module Mixpanel
+  module OpenFeature
+    class Provider
+      attr_reader :metadata, :mixpanel
+
+      def self.from_local(token, config, error_handler: nil)
+        tracker = ::Mixpanel::Tracker.new(token, error_handler, local_flags_config: config)
+        flags_provider = tracker.local_flags
+        flags_provider.start_polling_for_definitions!
+        provider = new(flags_provider)
+        provider.instance_variable_set(:@mixpanel, tracker)
+        provider
+      end
+
+      def self.from_remote(token, config, error_handler: nil)
+        tracker = ::Mixpanel::Tracker.new(token, error_handler, remote_flags_config: config)
+        flags_provider = tracker.remote_flags
+        provider = new(flags_provider)
+        provider.instance_variable_set(:@mixpanel, tracker)
+        provider
+      end
+
+      def initialize(flags_provider)
+        @flags_provider = flags_provider
+        @metadata = ::OpenFeature::SDK::Provider::ProviderMetadata.new(name: 'mixpanel-provider').freeze
+      end
+
+      def shutdown
+        @flags_provider.shutdown if @flags_provider.respond_to?(:shutdown)
+      end
+
+      def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :boolean, evaluation_context)
+      end
+
+      def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :string, evaluation_context)
+      end
+
+      def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :number, evaluation_context)
+      end
+
+      def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :integer, evaluation_context)
+      end
+
+      def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :float, evaluation_context)
+      end
+
+      def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+        resolve(flag_key, default_value, :object, evaluation_context)
+      end
+
+      private
+
+      def resolve(flag_key, default_value, expected_type, evaluation_context)
+        unless flags_ready?
+          return error_result(default_value, ::OpenFeature::SDK::Provider::ErrorCode::PROVIDER_NOT_READY)
+        end
+
+        context = build_context(evaluation_context)
+        fallback = ::Mixpanel::Flags::SelectedVariant.new(variant_value: default_value)
+
+        begin
+          result = @flags_provider.get_variant(flag_key, fallback, context, report_exposure: true)
+        rescue StandardError
+          return error_result(default_value, ::OpenFeature::SDK::Provider::ErrorCode::GENERAL)
+        end
+
+        if result.equal?(fallback)
+          return ::OpenFeature::SDK::Provider::ResolutionDetails.new(
+            value: default_value,
+            error_code: ::OpenFeature::SDK::Provider::ErrorCode::FLAG_NOT_FOUND,
+            reason: ::OpenFeature::SDK::Provider::Reason::DEFAULT
+          )
+        end
+
+        value = result.variant_value
+
+        if value.nil? && expected_type != :object
+          return error_result(default_value, ::OpenFeature::SDK::Provider::ErrorCode::TYPE_MISMATCH)
+        end
+
+        coerced = coerce_value(value, expected_type)
+        if coerced.nil? && !value.nil?
+          return error_result(default_value, ::OpenFeature::SDK::Provider::ErrorCode::TYPE_MISMATCH)
+        end
+
+        ::OpenFeature::SDK::Provider::ResolutionDetails.new(
+          value: coerced.nil? ? value : coerced,
+          variant: result.variant_key,
+          reason: ::OpenFeature::SDK::Provider::Reason::TARGETING_MATCH
+        )
+      end
+
+      def coerce_value(value, expected_type)
+        case expected_type
+        when :boolean
+          value == true || value == false ? value : nil
+        when :string
+          value.is_a?(String) ? value : nil
+        when :integer
+          if value.is_a?(Integer)
+            value
+          elsif value.is_a?(Float) && value.finite? && value == value.floor
+            value.to_i
+          end
+        when :float
+          if value.is_a?(Float)
+            value
+          elsif value.is_a?(Integer)
+            value.to_f
+          end
+        when :number
+          value.is_a?(Numeric) ? value : nil
+        when :object
+          value
+        end
+      end
+
+      def build_context(evaluation_context)
+        return {} if evaluation_context.nil?
+
+        ctx = {}
+        if evaluation_context.respond_to?(:fields)
+          evaluation_context.fields.each { |k, v| ctx[k] = unwrap_value(v) }
+        end
+        if evaluation_context.respond_to?(:targeting_key) && evaluation_context.targeting_key
+          ctx['targetingKey'] = unwrap_value(evaluation_context.targeting_key)
+        end
+        ctx
+      end
+
+      def unwrap_value(value)
+        case value
+        when Float
+          value.finite? && value == value.floor ? value.to_i : value
+        when Array
+          value.map { |v| unwrap_value(v) }
+        when Hash
+          value.transform_values { |v| unwrap_value(v) }
+        else
+          value
+        end
+      end
+
+      def flags_ready?
+        if @flags_provider.respond_to?(:are_flags_ready)
+          @flags_provider.are_flags_ready
+        else
+          true
+        end
+      end
+
+      def error_result(default_value, error_code)
+        ::OpenFeature::SDK::Provider::ResolutionDetails.new(
+          value: default_value,
+          error_code: error_code,
+          reason: ::OpenFeature::SDK::Provider::Reason::ERROR
+        )
+      end
+    end
+  end
+end

data/openfeature-provider/lib/mixpanel/openfeature.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'openfeature/provider'

data/openfeature-provider/mixpanel-ruby-openfeature.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = 'mixpanel-ruby-openfeature'
+  spec.version = '0.1.0'
+  spec.authors = ['Mixpanel']
+  spec.email = 'support@mixpanel.com'
+  spec.summary = 'OpenFeature provider for Mixpanel feature flags'
+  spec.description = 'An OpenFeature provider that wraps the Mixpanel Ruby SDK feature flags'
+  spec.homepage = 'https://mixpanel.com'
+  spec.license = 'Apache-2.0'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.files = Dir['lib/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'openfeature-sdk', '~> 0.5'
+  spec.add_runtime_dependency 'mixpanel-ruby', '~> 3.1'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
+end