devcycle-ruby-server-sdk 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf57528da3b098cb3809b3263fa7d1c09c86b6d6c7659b18d8e4329b41f5db17
-  data.tar.gz: cf875a30fb7df01907cc855a6191cfb20026070211de1df85852039e5cf46578
+  metadata.gz: a7c2ca8abeadbfc07bc034899330813d7167dbd9f863432fd34c968ff7597f00
+  data.tar.gz: 8fbdbd190921633b72bbb32abbd918dd83dbacc4bf4306864fbb95c587c92677
 SHA512:
-  metadata.gz: 77453f3ef07274af1ab5eea8cb6d3f8daa139dcc32636888e27df9a0bbdd14e37b7318b25b7b941fb709ddcafc8d63fadf608f707ee5f943540b22ceae8373c1
-  data.tar.gz: d00d7bf1751382362d5eb57046744924fecd7ceb99eedba5765a1b3172dd9e6a06dd8300c4e87bb46a2333c24f2d66e26d7d7dd0e274ccdfdb3c5da64768129b
+  metadata.gz: 84184a82c8d20bc21cdddc0142b08d915e6c3f4f29f562659e2be56cbd3cba5aca1f76bc98f613b1f9a3f00b157a82052dd05b49bbea5317583fbfe85bcf6b7c
+  data.tar.gz: a5ef7dec4c798f9efdaaed7b7c414159ccad957be178dc0becc2e4f852067146f6ee3ae1233659910fcd5e793611d99d038727474062dfd25a59023539912906

data/Gemfile

@@ -15,3 +15,5 @@ group :development, :test do
   gem 'pry-byebug'
   gem 'rubocop', '~> 1.57.1'
 end
+
+gem "openfeature-sdk", "~> 0.4.0"

data/lib/devcycle-ruby-server-sdk/api/client.rb

@@ -3,6 +3,7 @@ require 'logger'
 
 module DevCycle
   class Client
+    attr_reader :open_feature_provider
     def initialize(sdkKey, dvc_options = Options.new, wait_for_init = false)
       if sdkKey.nil?
         raise ArgumentError.new('Missing SDK key!')
@@ -23,6 +24,7 @@ module DevCycle
         @local_bucketing = LocalBucketing.new(@sdkKey, dvc_options, wait_for_init)
         @event_queue = EventQueue.new(@sdkKey, dvc_options.event_queue_options, @local_bucketing)
       end
+      @open_feature_provider = Provider.new(self)
     end
 
     def close

data/lib/devcycle-ruby-server-sdk/api/dev_cycle_provider.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module DevCycle
+  class Provider
+    attr_reader :client
+    def initialize(client)
+      unless client.is_a?(DevCycle::Client)
+        fail ArgumentError('Client must be an instance of DevCycleClient')
+      end
+      @client = client
+    end
+
+    def init
+      # We handle all initialization on the DVC Client itself
+    end
+
+    def shutdown
+      @client.close
+    end
+
+    def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+      # Retrieve a boolean value from provider source
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+      @client.variable(Provider.user_from_openfeature_context(evaluation_context), flag_key, default_value)
+    end
+
+    def self.user_from_openfeature_context(context)
+      unless context.is_a?(OpenFeature::SDK::EvaluationContext)
+        raise ArgumentError, "Invalid context type, expected OpenFeature::SDK::EvaluationContext but got #{context.class}"
+      end
+      args = {}
+      if context.field('user_id')
+        args.merge!(user_id: context.field('user_id'))
+      elsif context.field('targeting_key')
+        args.merge!(user_id: context.field('targeting_key'))
+      end
+      customData = {}
+      privateCustomData = {}
+      context.fields.each do |field, value|
+        if field === 'user_id' || field === 'targeting_key'
+          next
+        end
+        case field
+        when 'email'
+          args.merge!(email: value)
+        when 'name'
+          args.merge!(name: value)
+        when 'language'
+          args.merge!(language: value)
+        when 'country'
+          args.merge!(country: value)
+        when 'appVersion'
+          if value.is_a?(String)
+            args.merge!(appVersion: value)
+          end
+          next
+        when 'appBuild'
+          if value.is_a?(Numeric)
+            args.merge!(appBuild: value)
+          end
+        when 'customData'
+          if value.is_a?(Hash)
+            customData.merge!(value)
+          end
+          next
+        when 'privateCustomData'
+          if value.is_a?(Hash)
+            privateCustomData.merge!(value)
+          end
+        else
+          customData.merge!(field => value)
+        end
+      end
+      args.merge!(customData: customData)
+      args.merge!(privateCustomData: privateCustomData)
+      User.new(**args)
+    end
+  end
+end

data/lib/devcycle-ruby-server-sdk/models/user.rb

@@ -1,15 +1,3 @@
-=begin
-#DevCycle Bucketing API
-
-#Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
-
-=end
-
 require 'date'
 require 'time'
 require 'oj'

data/lib/devcycle-ruby-server-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
 =end
 
 module DevCycle
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/lib/devcycle-ruby-server-sdk.rb

@@ -27,6 +27,7 @@ require 'devcycle-ruby-server-sdk/models/variable'
 
 # APIs
 require 'devcycle-ruby-server-sdk/api/client'
+require 'devcycle-ruby-server-sdk/api/dev_cycle_provider'
 
 require 'devcycle-ruby-server-sdk/localbucketing/options'
 require 'devcycle-ruby-server-sdk/localbucketing/local_bucketing'

data/spec/devcycle_provider_spec.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'open_feature/sdk'
+
+context 'user_from_openfeature_context' do
+  context 'user_id' do
+
+    it 'returns a user with the user_id from the context' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+    end
+
+    it 'returns a user with the targeting_key from the context' do
+      context = OpenFeature::SDK::EvaluationContext.new(targeting_key: 'targeting_key')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('targeting_key')
+    end
+  end
+  context 'email' do
+    it 'returns a user with a valid user_id and email' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', email: 'email')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.email).to eq('email')
+    end
+    it 'returns a user with a valid targeting_key and email' do
+      context = OpenFeature::SDK::EvaluationContext.new(targeting_key: 'targeting_key', email: 'email')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('targeting_key')
+      expect(user.email).to eq('email')
+    end
+  end
+
+  context 'customData' do
+    it 'returns a user with customData' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', customData: { 'key' => 'value' })
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.customData).to eq({ 'key' => 'value' })
+    end
+  end
+
+  context 'privateCustomData' do
+    it 'returns a user with privateCustomData' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', privateCustomData: { 'key' => 'value' })
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.privateCustomData).to eq({ 'key' => 'value' })
+    end
+  end
+
+  context 'appVersion' do
+    it 'returns a user with appVersion' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', appVersion: '1.0.0')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.appVersion).to eq('1.0.0')
+    end
+
+    it 'returns a user with appBuild' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', appBuild: 1)
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.appBuild).to eq(1)
+    end
+  end
+  context 'randomFields' do
+    it 'returns a user with customData fields mapped to any non-standard fields' do
+      context = OpenFeature::SDK::EvaluationContext.new(user_id: 'user_id', randomField: 'value')
+      user = DevCycle::Provider.user_from_openfeature_context(context)
+      expect(user.user_id).to eq('user_id')
+      expect(user.customData).to eq({ 'randomField' => 'value' })
+    end
+  end
+
+  context 'provider' do
+    before(:all) do
+      @dvc = DevCycle::Client.new('dvc_server_token_hash')
+      OpenFeature::SDK.configure do |config|
+        config.set_provider(@dvc.open_feature_provider)
+      end
+      @client = OpenFeature::SDK.build_client
+      sleep(3)
+    end
+    it 'returns a provider with a valid client' do
+      provider = @dvc.open_feature_provider
+      expect(provider).to be_instance_of(DevCycle::Provider)
+    end
+    it 'responds properly to fetch_boolean_value' do
+      expect(@client.fetch_boolean_value(flag_key: 'flag_key', default_value: false, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to be(false)
+    end
+    it 'responds properly to fetch_string_value' do
+      expect(@client.fetch_string_value(flag_key: 'flag_key', default_value: 'default', evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to eq('default')
+    end
+    it 'responds properly to fetch_number_value' do
+      expect(@client.fetch_number_value(flag_key: 'flag_key', default_value: 1, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to eq(1)
+    end
+    it 'responds properly to fetch_integer_value' do
+      expect(@client.fetch_integer_value(flag_key: 'flag_key', default_value: 1, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to eq(1)
+    end
+    it 'responds properly to fetch_float_value' do
+      expect(@client.fetch_float_value(flag_key: 'flag_key', default_value: 1.0, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to eq(1.0)
+    end
+    it 'responds properly to fetch_object_value' do
+      expect(@client.fetch_object_value(flag_key: 'flag_key', default_value: { 'key' => 'value' }, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'user_id'))).to eq({ 'key' => 'value' })
+    end
+    it 'returns a provider with a valid client' do
+      provider = @dvc.open_feature_provider
+      expect(provider).to be_instance_of(DevCycle::Provider)
+    end
+    it 'responds properly to fetch_boolean_value' do
+      expect(@client.fetch_boolean_value(flag_key: 'test', default_value: false, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).to be(true)
+    end
+    it 'responds properly to fetch_string_value' do
+      expect(@client.fetch_string_value(flag_key: 'test-string-variable', default_value: 'default', evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).not_to eq('default')
+    end
+    it 'responds properly to fetch_number_value' do
+      expect(@client.fetch_number_value(flag_key: 'test-number-variable', default_value: 1, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).not_to eq(1)
+    end
+    it 'responds properly to fetch_integer_value' do
+      expect(@client.fetch_integer_value(flag_key: 'test-number-variable', default_value: 1, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).not_to eq(1)
+    end
+    it 'responds properly to fetch_float_value' do
+      expect(@client.fetch_float_value(flag_key: 'test-float-variable', default_value: 1.0, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).not_to eq(1.0)
+    end
+    it 'responds properly to fetch_object_value' do
+      expect(@client.fetch_object_value(flag_key: 'test-json-variable', default_value: { 'key' => 'value' }, evaluation_context: OpenFeature::SDK::EvaluationContext.new(user_id:'test'))).not_to eq({ 'key' => 'value' })
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devcycle-ruby-server-sdk
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - DevCycleHQ
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -148,6 +148,7 @@ files:
 - devcycle-ruby-server-sdk.gemspec
 - lib/devcycle-ruby-server-sdk.rb
 - lib/devcycle-ruby-server-sdk/api/client.rb
+- lib/devcycle-ruby-server-sdk/api/dev_cycle_provider.rb
 - lib/devcycle-ruby-server-sdk/api_client.rb
 - lib/devcycle-ruby-server-sdk/api_error.rb
 - lib/devcycle-ruby-server-sdk/configuration.rb
@@ -175,6 +176,7 @@ files:
 - spec/api/devcycle_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
+- spec/devcycle_provider_spec.rb
 - spec/spec_helper.rb
 homepage: https://devcycle.com
 licenses:
@@ -203,4 +205,5 @@ test_files:
 - spec/api/devcycle_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
+- spec/devcycle_provider_spec.rb
 - spec/spec_helper.rb