openfeature-ruby-sdk-contrib 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce92cec4c5146fcee215e7edca3f4daf9757a1cd4fda456176d197c861b0c620
-  data.tar.gz: bbfd473392d8143ae247ac862a6f6e591bb6e679d6bfad309bfb4ecf78f78976
+  metadata.gz: 33279a645ab02c54060f2842ae586d244b779d20c5a3bd275486f2dbecaf0687
+  data.tar.gz: 6a9c0a4ce90d78978ddb4ef95e2cc880ab2601ef03bf23b7e58700e2a4b9c809
 SHA512:
-  metadata.gz: d19265c25e33347ecb64eb29bd7d31384bd739a2e24564d7176feb60d51c34d0d5fef9190964fd67bd7c04672be7afad9926cabc9ad20fdbeb6293a6232f7f28
-  data.tar.gz: 757c5224f87fc475635c64b44c36fc87a8a183f6c51a225d207a9f437e89d54a15bb0606b72b8946e4753c372ad07d303e9e8a2cbe88d16a06b5c70d66e208c7
+  metadata.gz: bbf841634b916502ff751778337d6b81e8472eb1186b20a687bf7fa3accfe82a96cef52ede9a42567f04b4cdbd274d44733d07c4c043d15dc7340d0397c7e402
+  data.tar.gz: b52c456508a087aab56ef26a42f20177e3a71145c785ba44dff405462164d112c18a3a6e30dbd93d0c22a49690085ed0ed218f521ba56f9ff1ff83b366b8b544

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-ruby-sdk-contrib (0.1.0)
+    openfeature-ruby-sdk-contrib (0.0.2)
       concurrent-ruby (~> 1.2.2)
       faraday (~> 2.7.4)
       openfeature-sdk (~> 0.1)

data/README.md

@@ -68,7 +68,13 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+require "open_feature/sdk/contrib"
+
+OpenFeature::SDK.configure do |config|
+  config.provider = OpenFeature::SDK::Contrib::Providers::FileProvider.new(source: "path/to/file", format: :yaml)
+end
+```
 
 ## Development
 
@@ -78,7 +84,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eugene@xtreme-computers.net/openfeature-ruby-sdk-contrib.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ehowe/openfeature-ruby-sdk-contrib.
 
 ## License
 

data/lib/open_feature/sdk/contrib/client.rb

@@ -0,0 +1,13 @@
+require "openfeature/sdk/client"
+
+module OpenFeature
+  module SDK
+    module Contrib
+      class Client < OpenFeature::SDK::Client
+        def all_flags
+          @provider.read_all_values_with_cache
+        end
+      end
+    end
+  end
+end

data/lib/open_feature/sdk/contrib/providers/common.rb

@@ -3,8 +3,15 @@ module OpenFeature
     module Contrib
       module Providers
         module Common
-          # TODO: Should figure out how to use this...
-          ResolutionDetails = Struct.new(:value, :reason, :variant, :error_code, :error_message)
+          ResolutionDetails = Struct.new(
+            :enabled,
+            :error_code,
+            :error_message,
+            :reason,
+            :value,
+            :variant,
+            keyword_init: true
+          )
 
           # @return [String]
           attr_reader :source
@@ -109,6 +116,27 @@ module OpenFeature
             assert_type(value: source_value, default_value: default_value, return_types: [Hash])
           end
 
+          def read_all_values_with_cache
+            now = Time.now.to_i
+
+            read_from_cache = if !@flag_contents
+                                false
+                              elsif !@last_cache
+                                false
+                              elsif cache_duration == Float::INFINITY
+                                true
+                              else
+                                now - @last_cache < cache_duration
+                              end
+
+            unless read_from_cache
+              read_and_parse_flags
+              @last_cache = Time.now.to_i
+            end
+
+            deep_keys.empty? ? @flag_contents : @flag_contents.dig(*deep_keys)
+          end
+
           private
 
           # Returns a value for the requested flag_key
@@ -116,17 +144,7 @@ module OpenFeature
           # @param flag_key [String] requested flag key
           # @param type ["boolean", "number", "float", "string"]
           def read_value_with_cache(flag_key:, type:)
-            now = Time.now.to_i
-
-            resolve_keys = lambda do |contents|
-              flag_contents = deep_keys.empty? ? contents : contents.dig(*deep_keys)
-
-              flag_contents.detect { |f| f["kind"] == type && f["name"] == flag_key }
-            end
-
-            return resolve_keys.call(@flag_contents) if @flag_contents && (cache_duration == Float::INFINITY || (@last_cache && @flag_contents && now - @last_cache < cache_duration))
-
-            @flag_contents = resolve_keys.call(read_and_parse_flags)
+            read_all_values_with_cache.detect { |f| f["kind"] == type && f["name"] == flag_key }
           end
 
           def read_and_parse_flags
@@ -140,14 +158,14 @@ module OpenFeature
                              { "value" => default_value }
                            end
 
-            return actual_value if actual_value.nil?
+            return ResolutionDetails.new(value: nil) if actual_value.nil?
 
-            return_types = Array(return_types)
-            actual_value = actual_value["variants"] ? actual_value["variants"][actual_value["value"]] : actual_value["value"]
+            return_types  = Array(return_types)
+            variant_value = actual_value["variants"] ? actual_value["variants"][actual_value["value"]] : actual_value["value"]
 
-            raise OpenFeature::SDK::Contrib::InvalidReturnValueError, "Invalid flag value found: #{actual_value} is not in #{return_types.join(', ')}" unless return_types.include?(actual_value.class)
+            raise OpenFeature::SDK::Contrib::InvalidReturnValueError, "Invalid flag value found: #{variant_value} is not in #{return_types.join(', ')}" unless return_types.include?(variant_value.class)
 
-            actual_value
+            ResolutionDetails.new(value: variant_value, enabled: actual_value["enabled"], variant: actual_value["variant"])
           end
         end
       end

data/lib/open_feature/sdk/contrib/providers/file_provider.rb

@@ -31,11 +31,13 @@ module OpenFeature
 
             return custom_parser.call(file_contents) if custom_parser
 
-            if format == :yaml
-              YAML.safe_load(file_contents)
-            else
-              JSON.parse(file_contents)
-            end
+            @flag_contents = if format == :yaml
+                               YAML.safe_load(file_contents)
+                             else
+                               JSON.parse(file_contents)
+                             end
+
+            @flag_contents
           end
         end
       end

data/lib/open_feature/sdk/contrib/version.rb

@@ -3,7 +3,7 @@
 module OpenFeature
   module SDK
     module Contrib
-      VERSION = "0.0.1"
+      VERSION = "0.0.3"
     end
   end
 end

data/lib/open_feature/sdk/contrib.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "contrib/client"
 require_relative "contrib/version"
 require_relative "contrib/providers/common"
 require_relative "contrib/providers/file_provider"
@@ -10,4 +11,4 @@ module OpenFeature
       InvalidReturnValueError = Class.new(StandardError)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-ruby-sdk-contrib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Eugene Howe
@@ -179,6 +179,7 @@ files:
 - README.md
 - Rakefile
 - lib/open_feature/sdk/contrib.rb
+- lib/open_feature/sdk/contrib/client.rb
 - lib/open_feature/sdk/contrib/providers/common.rb
 - lib/open_feature/sdk/contrib/providers/file_provider.rb
 - lib/open_feature/sdk/contrib/version.rb