openfeature-flipt-provider 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb9be79bc46fbd3ac78a380df63c7391733922b89d33c5101649e3436afee314
+  data.tar.gz: c63342abed2645787b29b5c14ccfeaddc6de919da2f9feb478448319b2a090ef
+SHA512:
+  metadata.gz: c2471f2694eaa22a34ad1754fb2dbcba3667270503842c548687b97099f4abb5ba1699fa8cacba03cfb883e196f3236f960676c12d2ac76e5fd6b52e2d3d000d
+  data.tar.gz: c4814922d78c7beb524dd82b2351585f8fe46fefa6875c5efba6641dbba6d5bc8fd503eecbebf11f5da9c56716daab9e400f45e721a7357e45deb9a25d841c4b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+-I lib
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: ../../shared_config/.rubocop.yml
+
+inherit_mode:
+  merge:
+    - Exclude

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [0.0.2](https://github.com/open-feature/ruby-sdk-contrib/compare/openfeature-flipt-provider-v0.0.1...openfeature-flipt-provider/v0.0.2) (2025-04-15)
+
+
+### 🐛 Bug Fixes
+
+* Update Gemfile.lock on flipt provider ([#55](https://github.com/open-feature/ruby-sdk-contrib/issues/55)) ([fd79d7b](https://github.com/open-feature/ruby-sdk-contrib/commit/fd79d7be189367d462c87c06e9a2a65a462c1a91))
+
+
+### ✨ New Features
+
+* Add Flipt provider gem with basic implementation ([#51](https://github.com/open-feature/ruby-sdk-contrib/issues/51)) ([8e0ae7c](https://github.com/open-feature/ruby-sdk-contrib/commit/8e0ae7ccd24b4c5334bfe6f794737a95ac8d18bb))

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openfeature-flipt-provider.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    openfeature-flipt-provider (0.0.2)
+      ffi (~> 1.17)
+      flipt_client (~> 0.10.0)
+      openfeature-sdk (~> 0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    diff-lcs (1.6.1)
+    ffi (1.17.1)
+    ffi (1.17.1-aarch64-linux-gnu)
+    ffi (1.17.1-aarch64-linux-musl)
+    ffi (1.17.1-arm-linux-gnu)
+    ffi (1.17.1-arm-linux-musl)
+    ffi (1.17.1-arm64-darwin)
+    ffi (1.17.1-x86-linux-gnu)
+    ffi (1.17.1-x86-linux-musl)
+    ffi (1.17.1-x86_64-darwin)
+    ffi (1.17.1-x86_64-linux-gnu)
+    ffi (1.17.1-x86_64-linux-musl)
+    flipt_client (0.10.0)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    openfeature-sdk (0.4.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.3)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.2)
+    rubocop (1.75.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.49.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.75.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  openfeature-flipt-provider!
+  rake (~> 13.0)
+  rspec (~> 3.12.0)
+  rubocop
+  standard (>= 1.35.1)
+
+BUNDLED WITH
+   2.5.16

data/README.md

@@ -0,0 +1,57 @@
+<p align="center">
+  <img width="400" src="https://raw.githubusercontent.com/flipt-io/flipt/main/logo.svg" alt="flipt logo" />
+</p>
+
+# Flipt - OpenFeature Ruby provider
+
+This repository contains the Ruby provider for [Flipt](https://www.flipt.io/), a feature flagging and experimentation platform.
+
+In conjunction with the [OpenFeature SDK](https://openfeature.dev/docs/reference/concepts/provider/) you can use this provider to integrate Flipt into your Ruby application.
+
+For documentation on how to use Flipt, please refer to the [Flipt documentation](https://docs.flipt.io/).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openfeature-flipt-provider'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+To use the Flipt provider, you need to create an instance of the provider and pass it to the OpenFeature SDK.
+
+```ruby
+require "open_feature/sdk"
+require "openfeature/flipt/provider"
+
+OpenFeature::SDK.configure do |config|
+  config.set_provider(
+    OpenFeature::Flipt::Provider.new(
+      namespace: "flipt-namespace",
+      options: {
+        url: "https://url-to-flipt-server",
+        update_interval: 60,
+        authentication: "token"
+      }
+    )
+  )
+end
+client = OpenFeature::SDK.build_client
+
+# Check if a feature is enabled
+if client.fetch_boolean_value(flag_key: "featureEnabled", default_value: false)
+  puts "Feature is enabled"
+else
+  puts "Feature is disabled"
+end
+```
+
+For a complete list of configuration options, such as authentication and error strategies, refer to the [Flipt Client Ruby SDK documentation](https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-ruby#constructor-arguments).
+
+## Contributing
+https://github.com/open-feature/ruby-sdk-contrib

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[standard spec]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "openfeature/flipt/provider"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openfeature/flipt/provider.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require "flipt_client"
+require "open_feature/sdk"
+
+module OpenFeature
+  module Flipt
+    class Provider
+      PROVIDER_NAME = "Flipt Provider"
+
+      # @param namespace [String] Namespace to use when fetching flags.
+      # @param options [Hash] Options to pass to the Flipt client.
+      def initialize(namespace: "default", options: {})
+        @client = ::Flipt::EvaluationClient.new(namespace, options)
+      end
+
+      def metadata
+        @_metadata ||= SDK::Provider::ProviderMetadata.new(name: PROVIDER_NAME).freeze
+      end
+
+      def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+        fetch_value(
+          flag_key: flag_key,
+          default_value: default_value,
+          evaluation_context: evaluation_context,
+          evaluation_method: :evaluate_boolean,
+          result_key: "enabled"
+        )
+      end
+
+      def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+        fetch_value(
+          flag_key: flag_key,
+          default_value: default_value,
+          evaluation_context: evaluation_context,
+          evaluation_method: :evaluate_variant,
+          result_key: "variant_key"
+        )
+      end
+
+      def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+        fetch_numeric_value(flag_key:, default_value:, evaluation_context:, allowed_types: [Numeric])
+      end
+
+      def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+        fetch_numeric_value(flag_key:, default_value:, evaluation_context:, allowed_types: [Integer])
+      end
+
+      def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+        fetch_numeric_value(flag_key:, default_value:, evaluation_context:, allowed_types: [Float])
+      end
+
+      def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+        result = fetch_value(
+          flag_key: flag_key,
+          default_value: default_value,
+          evaluation_context: evaluation_context,
+          evaluation_method: :evaluate_variant,
+          result_key: "variant_key"
+        )
+
+        unless result.value.is_a?(Hash)
+          begin
+            result.value = JSON.parse(result.value)
+          rescue JSON::ParserError, TypeError
+            return OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: default_value,
+              error_message: "Could not parse '#{result.value}' as JSON",
+              reason: OpenFeature::SDK::Provider::Reason::ERROR
+            )
+          end
+        end
+        result
+      end
+
+      private
+
+      def fetch_value(flag_key:, default_value:, evaluation_context:, evaluation_method:, result_key:)
+        transformed_eval_context = transform_context(evaluation_context)
+
+        begin
+          response = @client.send(evaluation_method, {
+            flag_key: flag_key,
+            entity_id: evaluation_context&.fetch("targeting_key", nil) || "default",
+            context: transformed_eval_context
+          })
+
+          if %w[FLAG_DISABLED_EVALUATION_REASON].include?(response["result"]["reason"])
+            OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: default_value,
+              reason: OpenFeature::SDK::Provider::Reason::DISABLED
+            )
+          elsif %w[DEFAULT_EVALUATION_REASON MATCH_EVALUATION_REASON].include?(response["result"]["reason"])
+            OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: response["result"][result_key],
+              reason: OpenFeature::SDK::Provider::Reason::TARGETING_MATCH
+            )
+          elsif %w[UNKNOWN_EVALUATION_REASON].include?(response["result"]["reason"])
+            OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: default_value,
+              reason: OpenFeature::SDK::Provider::Reason::UNKNOWN
+            )
+          else
+            OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: default_value,
+              reason: OpenFeature::SDK::Provider::Reason::DEFAULT
+            )
+          end
+        rescue => e
+          OpenFeature::SDK::Provider::ResolutionDetails.new(
+            value: default_value,
+            error_message: e.message,
+            reason: OpenFeature::SDK::Provider::Reason::ERROR
+          )
+        end
+      end
+
+      def fetch_numeric_value(flag_key:, default_value:, evaluation_context:, allowed_types:)
+        result = fetch_value(
+          flag_key: flag_key,
+          default_value: default_value,
+          evaluation_context: evaluation_context,
+          evaluation_method: :evaluate_variant,
+          result_key: "variant_key"
+        )
+
+        unless result.value.is_a?(Numeric)
+          begin
+            parsed_value = Float(result.value)
+            # Only convert to integer if it's a whole number and allowed_types is [Integer]
+            result.value = if allowed_types == [Integer] && parsed_value.to_i == parsed_value
+              parsed_value.to_i
+            else
+              parsed_value
+            end
+          rescue ArgumentError, TypeError
+            return OpenFeature::SDK::Provider::ResolutionDetails.new(
+              value: default_value,
+              error_message: "Could not convert '#{result.value}' to #{allowed_types.first.name.downcase}",
+              reason: OpenFeature::SDK::Provider::Reason::ERROR
+            )
+          end
+        end
+
+        unless allowed_types.any? { |type| result.value.is_a?(type) }
+          return OpenFeature::SDK::Provider::ResolutionDetails.new(
+            value: default_value,
+            error_message: "Value '#{result.value}' is not a #{allowed_types.first.name.downcase}",
+            reason: OpenFeature::SDK::Provider::Reason::ERROR
+          )
+        end
+
+        result
+      end
+
+      def transform_context(context)
+        eval_context = {}
+        context&.each do |key, value|
+          next if key == "targeting_key"
+
+          eval_context[key] = value.to_s
+        end
+        eval_context
+      end
+    end
+  end
+end

data/lib/openfeature/flipt/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OpenFeature
+  module Flipt
+    VERSION = "0.0.2"
+  end
+end

data/openfeature-flipt-provider.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/openfeature/flipt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openfeature-flipt-provider"
+  spec.version = OpenFeature::Flipt::VERSION
+  spec.authors = ["Firdaus Al Ghifari"]
+  spec.email = ["firdaus.alghifari@gmail.com"]
+
+  spec.summary = "OpenFeature Flipt Provider for Ruby"
+  spec.description = "OpenFeature Flipt Provider for Ruby"
+  spec.homepage = "https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider"
+  spec.metadata["changelog_uri"] = "https://github.com/open-feature/ruby-sdk-contrib/blob/main/providers/openfeature-flipt-provider/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/open-feature/ruby-sdk-contrib/issues"
+  spec.metadata["documentation_uri"] = "https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider/README.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi", "~> 1.17"
+  spec.add_dependency "openfeature-sdk", "~> 0.4.0"
+  spec.add_dependency "flipt_client", "~> 0.10.0"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12.0"
+  spec.add_development_dependency "standard", ">= 1.35.1"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: openfeature-flipt-provider
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Firdaus Al Ghifari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: openfeature-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: flipt_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.35.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OpenFeature Flipt Provider for Ruby
+email:
+- firdaus.alghifari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- lib/openfeature/flipt/provider.rb
+- lib/openfeature/flipt/version.rb
+- openfeature-flipt-provider.gemspec
+homepage: https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider
+  source_code_uri: https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider
+  changelog_uri: https://github.com/open-feature/ruby-sdk-contrib/blob/main/providers/openfeature-flipt-provider/CHANGELOG.md
+  bug_tracker_uri: https://github.com/open-feature/ruby-sdk-contrib/issues
+  documentation_uri: https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-flipt-provider/README.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: OpenFeature Flipt Provider for Ruby
+test_files: []