openfeature-ruby-sdk-contrib 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf8cd0512f8cb54964eef7abc7152a8a1ff440b87ff180c3e5cf4d5672fe2be
-  data.tar.gz: f67486141dd2f5e0847b0884dd95d8aa3ec6e8176495164637f9fdca6c71fd99
+  metadata.gz: be2d89c0a27aff01c3af71cf16c50edb267f7b76347de4b390ff6130a1aa0217
+  data.tar.gz: 432c022ce3a40af8f9e58715aa9b6ca4b88dbfa067e8ba81ec2784a21b729d52
 SHA512:
-  metadata.gz: ff01303ffef255120f9eb98855e25eff6669b88153ec04c40e7700a8dc14b1bb620be992a509067ff0c80352c12706a0faa50e9d2af42bb6c5dff917c1690562
-  data.tar.gz: 297f07e8736d693bf7f68b22aa2236e6836c8b86cbaa36d81e86e045f91771b985bc0595e8622fbe0889b810ca9ffd2f6a6aaaa08b66232e5ccf30334889b741
+  metadata.gz: 65b1632d328b1d91ff91cdc5e021b88d23d9dcf342328778e56d64b31bacd8126ff6064be89735e1b7c7b9004ad757e8accb18c6b17a641d6d5fa934ae33f892
+  data.tar.gz: a3d906869ea5a09f5e0ee88649e04e021a5802f72e3465b0d17fd580c7a321bfab9e12a78a20cec37817409a8eb5ab056200c96600354947012915821ca23309

data/Gemfile.lock

@@ -1,30 +1,32 @@
 PATH
   remote: .
   specs:
-    openfeature-ruby-sdk-contrib (0.2.1)
+    openfeature-ruby-sdk-contrib (0.4.0)
       concurrent-ruby (~> 1.2.2)
       faraday (~> 2.7.10)
-      openfeature-sdk (~> 0.1)
+      openfeature-sdk (~> 0.2)
 
 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)
+    concurrent-ruby (1.2.3)
+    diff-lcs (1.5.1)
+    faraday (2.7.12)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    json (2.6.3)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     method_source (1.0.0)
-    openfeature-sdk (0.1.1)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    openfeature-sdk (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -33,24 +35,24 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    racc (1.7.1)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.52.1)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -61,19 +63,19 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
-      rubocop (~> 1.33)
     rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.23.0)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.27.1)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
@@ -90,11 +92,11 @@ GEM
     standard-performance (1.1.2)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.18.0)
-    unicode-display_width (2.4.2)
-    yard (0.9.34)
+    unicode-display_width (2.5.0)
+    yard (0.9.36)
 
 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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openfeature/sdk/client"
+require "open_feature/sdk/client"
 
 module OpenFeature
   module SDK

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

@@ -134,7 +134,7 @@ module OpenFeature
           def read_all_values_with_cache
             now = Time.now.to_i
 
-            read_from_cache = if !@flag_contents && !@last_cache
+            read_from_cache = if !@flag_contents || !@last_cache
                                 false
                               elsif cache_duration == Float::INFINITY
                                 true
@@ -155,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/file_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openfeature/sdk"
+require "open_feature/sdk"
 require "erb"
 
 module OpenFeature

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "openfeature/sdk"
+require "open_feature/sdk"
 require "faraday"
 
 module OpenFeature
@@ -30,9 +30,12 @@ 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}"
+            options                 = extra_options.clone
+            headers                 = options.fetch(:headers, {})
+            uri                     = URI(source)
+            base_url                = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+            authentication_strategy = options.delete(:authentication_strategy)
+            logger                  = options.delete(:logger)
 
             if format == :yaml
               headers["Content-Type"] ||= "application/yaml"
@@ -40,8 +43,12 @@ 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, **options, headers: headers) do |conn|
+              conn.request(*authentication_strategy) if authentication_strategy
+              conn.response(:logger, logger) if logger
+            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.3.0"
+      VERSION = "0.5.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description:
 email:
 - eugene.howe@protonmail.com
@@ -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