openfeature-ruby-sdk-contrib 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a769e314a26cad2d838cd2038cc0bf7c419bb341b3a1d84c8f25af1c86f431a4
-  data.tar.gz: f5fe644274b24df571e54d2128f39de106ca0e88a7e3c8d1ec354e2ead2fdbf2
+  metadata.gz: aa6213b99bd5852e81c1fe7184950031c35038513eeef5ac9003694197ba1633
+  data.tar.gz: 3aa3234f79d229c9520580d217d8cdf859f6f95ec80967b5a63c994bea83f454
 SHA512:
-  metadata.gz: 4295a9914e8e7be4f79e65e1879964d5ffa4ccb560b71a094f6618df9731afc39a611a199f99efa69ab759bb24b6d3e6bcd16fc6aa2a3fecac2e22e71fcb0458
-  data.tar.gz: 01e988330d77f7ec392c53ab253622141d4e698ed1662bc8dd70aa03085d15d35980367b96502afcf6a6d35042394735952567673a34d868b2d36c6971106638
+  metadata.gz: 0c7d32302bfe0f293e9a7aaf00413a289ee7c0805dc76f5d623b7a0f972d156a63b5783e51a1ef55c6a39d47f6e48608d665d6d714e7161abd7e2eb37eafec08
+  data.tar.gz: 48828fff61ed31bc5c97fabdccdf8c578091d8eb814cb9b21ec8a77a3ede301bed6f36a7fc87b32370b93dd494d15534605eaf83444e5375eb9c2fbc2a310b5b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openfeature-ruby-sdk-contrib (0.1.2)
+    openfeature-ruby-sdk-contrib (0.3.0)
       concurrent-ruby (~> 1.2.2)
       faraday (~> 2.7.10)
       openfeature-sdk (~> 0.1)
@@ -10,11 +10,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    faraday (2.7.10)
+    faraday (2.7.12)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -22,7 +24,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)
@@ -95,6 +97,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
 
 DEPENDENCIES
   openfeature-ruby-sdk-contrib!

data/README.md

@@ -107,6 +107,32 @@ Rails.application.config.openfeature_client = OpenFeature::SDK::Contrib::Client.
 )
 ```
 
+#### Custom Auth Strategy
+
+Some applications may require more finesse to authenticate, for example, an OAuth Flow. To use this style flow, the `extra_options` key that is passed to `HttpProvider.new` accepts an `authentication_strategy` key. This key gets passed to the internal Faraday client as a middleware, so it can be anything usable as a Faraday middleware. Example:
+
+```
+  module FaradayMiddleware
+    class MyCustomMiddleware < Faraday::Middleware
+      def initialize(args)
+        # do stuff
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+    end
+
+    Faraday::Request.register_middleware my_custom_middleware: -> { MyCustomMiddleware }
+  end
+
+  Rails.application.config.openfeature_provider = OpenFeature::SDK::Contrib::Providers::HttpProvider.new(
+    extra_options: {
+      authentication_strategy: [:my_custom_middleware, my_custom_middleware_arguments]
+    }
+  )
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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

@@ -14,6 +14,10 @@ module OpenFeature
           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
@@ -151,7 +155,7 @@ module OpenFeature
           # Returns a value for the requested flag_key
           #
           # @param flag_key [String] requested flag key
-          # @param type ["boolean", "number", "float", "string"]
+          # @param type ["boolean", "number", "float", "string", "array"]
           def read_value_with_cache(flag_key:, type:)
             read_all_values_with_cache.detect { |f| f["kind"] == type && f["name"] == flag_key }
           end

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

@@ -30,9 +30,10 @@ module OpenFeature
           NAME = "Http Provider"
 
           def read_and_parse_flags
-            headers  = extra_options.fetch(:headers, {})
-            uri      = URI(source)
-            base_url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+            headers                 = extra_options.fetch(:headers, {})
+            uri                     = URI(source)
+            base_url                = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+            authentication_strategy = extra_options.delete(:authentication_strategy)
 
             if format == :yaml
               headers["Content-Type"] ||= "application/yaml"
@@ -40,8 +41,11 @@ module OpenFeature
               headers["Content-Type"] ||= "application/json"
             end
 
-            client = Faraday.new(url: base_url, **extra_options, headers: headers)
-            res    = client.get(uri.request_uri)
+            client = Faraday.new(url: base_url, **extra_options, headers: headers) do |conn|
+              conn.request(*authentication_strategy) if authentication_strategy
+            end
+
+            res = client.get(uri.request_uri)
 
             return custom_parser.call(res.body) if custom_parser
 

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

@@ -3,7 +3,7 @@
 module OpenFeature
   module SDK
     module Contrib
-      VERSION = "0.2.0"
+      VERSION = "0.4.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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Providers and Hooks for the OpenFeature Ruby SDK