openfeature-ruby-sdk-contrib 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c405f0d8a129b8a8890acb6c7c23ff5a6503a4000a0e2cd794f376f905a4485
-  data.tar.gz: a13bf2b6d68a6b7e34dbd87a1a43d26bc5838f386f50db84959b521d77195f8c
+  metadata.gz: 2cf8cd0512f8cb54964eef7abc7152a8a1ff440b87ff180c3e5cf4d5672fe2be
+  data.tar.gz: f67486141dd2f5e0847b0884dd95d8aa3ec6e8176495164637f9fdca6c71fd99
 SHA512:
-  metadata.gz: af206ed84de4785ceaf8a68d2f9d90be936a864a76e52f807b77925584b43c4a3e6a484b185c5154c82722e1c65af7154f1196746bd5397ec473f27925035b10
-  data.tar.gz: 13919f472a49086f191a2172f6a61e86a4d09179b4ab8d0c3773ad4c52757deabe3bfc52e6d2e09c00468cb3ad596c7b2787c5ba5af4a3cb7197ebcb18411644
+  metadata.gz: ff01303ffef255120f9eb98855e25eff6669b88153ec04c40e7700a8dc14b1bb620be992a509067ff0c80352c12706a0faa50e9d2af42bb6c5dff917c1690562
+  data.tar.gz: 297f07e8736d693bf7f68b22aa2236e6836c8b86cbaa36d81e86e045f91771b985bc0595e8622fbe0889b810ca9ffd2f6a6aaaa08b66232e5ccf30334889b741

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-ruby-sdk-contrib (0.1.2)
+    openfeature-ruby-sdk-contrib (0.2.1)
       concurrent-ruby (~> 1.2.2)
       faraday (~> 2.7.10)
       openfeature-sdk (~> 0.1)
@@ -22,7 +22,7 @@ GEM
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     method_source (1.0.0)
-    openfeature-sdk (0.1.0)
+    openfeature-sdk (0.1.1)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)

data/README.md

@@ -68,12 +68,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+If you are using rails, this code will go in an initializer. If you aren't, replace the assignments for `Rails.application.config.openfeature_provider` and `Rails.application.config.openfeature_client` with constants that you will have access to application-wide.
+
+### File Provider
+
+```
+require "open_feature/sdk/contrib"
+
+Rails.application.config.openfeature_provider = OpenFeature::SDK::Contrib::Providers::FileProvider.new(
+cache_duration: 300,
+deep_keys: ["flags"], # If your flags are nested inside of a response, this array is a list of keys that will get to the array where the actual flags are defined
+format: :yaml, # json or yaml
+source: "/path/to/file.yml"
+)
+
+Rails.application.config.openfeature_client = OpenFeature::SDK::Contrib::Client.new(
+client_options: { name: "your arbitrary client name" },
+provider: Rails.application.config.openfeature_provider
+)
+```
+
+### HTTP Provider
+
 ```
 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
+Rails.application.config.openfeature_provider = OpenFeature::SDK::Contrib::Providers::HttpProvider.new(
+  cache_duration: 300,
+  deep_keys: ["flags"], # If your flags are nested inside of a response, this array is a list of keys that will get to the array where the actual flags are defined
+  extra_options: { Authorization: "Bearer <some token>" }, # This object can be anything that gets passed to Faraday.new
+  format: :json, # json or yaml
+  source: "https://some.url/feature-flags"
+)
+
+Rails.application.config.openfeature_client = OpenFeature::SDK::Contrib::Client.new(
+  client_options: { name: "your arbitrary client name" },
+  provider: Rails.application.config.openfeature_provider
+)
 ```
 
 ## Development

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

@@ -9,6 +9,15 @@ module OpenFeature
         def all_flags
           @provider.read_all_values_with_cache
         end
+
+        def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+          result = @provider.fetch_float_value(flag_key: flag_key, default_value: default_value, evaluation_context: evaluation_context)
+          result.value
+        end
+
+        def fetch_raw_flag(flag_key:)
+          @provider.fetch_raw_key(flag_key: flag_key)
+        end
       end
     end
   end

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

@@ -67,6 +67,10 @@ module OpenFeature
             @flag_contents = nil
           end
 
+          def fetch_raw_key(flag_key:)
+            read_all_values_with_cache.detect { |f| f["name"] == flag_key }
+          end
+
           # Returns a boolean value for the key specified
           #
           # @param flag_key [String] flag key to search for

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

@@ -3,7 +3,7 @@
 module OpenFeature
   module SDK
     module Contrib
-      VERSION = "0.1.2"
+      VERSION = "0.3.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-ruby-sdk-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby