openfeature-rollout-provider 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b87a7980c84c5cf5a03b35648b5f82aaf64c8e5e6f94ae3c61a32690e3f7e17
+  data.tar.gz: abd33d41673d31d9903fab54b2f9be604a612fe316edf463fb64838b05a530f6
+SHA512:
+  metadata.gz: 2c97f2551ed8e2c1294bc48543bff39892df33828e54e9b3b54958a831410e6f2eae520427a3208a3d08591195592e77eb307a36b6c8e6fe2142aed579a4579c
+  data.tar.gz: 3499aa31081896aab26e337d7bcf4016c24a07bc579ffa03944bc770fddbe373a0c07548589c021bb0e02dae24915b555161288d5cce78866c48908f26040df7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,31 @@
+# OpenFeature rollout Provider for Ruby
+
+This is the Ruby [provider](https://openfeature.dev/docs/specification/sections/providers) implementation of rollout
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openfeature-rollout-provider'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install openfeature-rollout-provider
+```
+
+## Example
+
+```ruby
+OpenFeature::SDK.configure do |config|
+  config.provider = OpenFeature::Rollout::Provider.build_client(::Rollout.new(Redis.new))
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "openfeature/rollout/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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/rollout/provider/version.rb

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

data/lib/openfeature/rollout/provider.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "rollout"
+
+require_relative "provider/version"
+
+module OpenFeature
+  module Rollout
+    # Provider represents the entry point for interacting with the rollout provider
+    # values. The implementation follows the details specified in https://openfeature.dev/docs/specification/sections/providers
+    #
+    # Provider contains functionality to configure the redis connection via
+    #   rollout_client = OpenFeature::Rollout::Provider.build_client
+    #   rollout_client.configure do |config|
+    #     config.redis = Redis.new
+    #   end
+    #
+    # The Provider provides the following methods and attributes:
+    #
+    # * <tt>metadata</tt> - Returns the associated provider metadata with the name
+    #
+    # * <tt>resolve_boolean_value(flag_key:, default_value:, context: nil)</tt>
+    #   manner; <tt>client.resolve_boolean(flag_key: 'boolean-flag', default_value: false)</tt>
+    #
+    # * <tt>resolve_integer_value(flag_key:, default_value:, context: nil)</tt>
+    #   manner; <tt>client.resolve_integer_value(flag_key: 'integer-flag', default_value: 2)</tt>
+    #
+    # * <tt>resolve_float_value(flag_key:, default_value:, context: nil)</tt>
+    #   manner; <tt>client.resolve_float_value(flag_key: 'float-flag', default_value: 2.0)</tt>
+    #
+    # * <tt>resolve_string_value(flag_key:, default_value:, context: nil)</tt>
+    #   manner; <tt>client.resolve_string_value(flag_key: 'string-flag', default_value: 'some-default-value')</tt>
+    #
+    # * <tt>resolve_object_value(flag_key:, default_value:, context: nil)</tt>
+    #   manner; <tt>client.resolve_object_value(flag_key: 'object-flag', default_value: { default_value: 'value'})</tt>
+    class Provider
+      def self.build_client(rollout_client = nil)
+        unless rollout_client
+          rollout_client = ::Rollout.new(Redis.new)
+        end
+
+        new(rollout_client: rollout_client)
+      end
+
+      PROVIDER_NAME = "rollout Provider"
+
+      attr_reader :metadata
+
+      def initialize(rollout_client: nil)
+        @metadata = OpenFeature::SDK::Provider::ProviderMetadata.new(name: PROVIDER_NAME)
+        @rollout_client = rollout_client
+      end
+
+      def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+        res = @rollout_client.active?(flag_key, evaluation_context&.targeting_key)
+
+        OpenFeature::SDK::Provider::ResolutionDetails.new(
+          value: res,
+          reason: "UNKNOWN", # "STATIC", "DEFAULT", "TARGETING_MATCH", "SPLIT", "CACHED", "DISABLED", "UNKNOWN", "STALE", "ERROR"
+          variant: nil,
+          error_code: nil,
+          error_message: nil,
+          flag_metadata: nil
+        )
+      end
+
+      def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+        error_response(default_value, "TYPE_MISMATCH", "Rollout does not support numeric flag values")
+      end
+
+      def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+        error_response(default_value, "TYPE_MISMATCH", "Rollout does not support numeric flag values")
+      end
+
+      def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+        error_response(default_value, "TYPE_MISMATCH", "Rollout does not support numeric flag values")
+      end
+
+      def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+        error_response(default_value, "TYPE_MISMATCH", "Rollout does not support string flag values")
+      end
+
+      def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+        error_response(default_value, "TYPE_MISMATCH", "Rollout does not support object flag values")
+      end
+
+      def error_response(default_value, error_code, error_message)
+        OpenFeature::SDK::Provider::ResolutionDetails.new(
+          value: default_value,
+          reason: "ERROR",
+          variant: nil,
+          error_code: error_code,
+          error_message: error_message,
+          flag_metadata: nil
+        )
+      end
+    end
+  end
+end

data/openfeature-rollout-provider.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/openfeature/rollout/provider/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openfeature-rollout-provider"
+  spec.version = OpenFeature::Rollout::VERSION
+  spec.authors = ["Bryan Alves"]
+  spec.email = ["bryanalves@gmail.com"]
+
+  spec.summary = "The rollout provider for the OpenFeature Ruby SDK"
+  spec.description = "The rollout provider for the OpenFeature Ruby SDK"
+  spec.homepage = "https://github.com/bryanalves/openfeature-rollout-provider"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bryanalves/openfeature-rollout-provider/tree/main/"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/bryanalvees/openfeature-rollout-provider/issues"
+
+  # 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_runtime_dependency "openfeature-sdk", "~> 0.3"
+  spec.add_runtime_dependency "rollout"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: openfeature-rollout-provider
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bryan Alves
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openfeature-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rollout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: The rollout provider for the OpenFeature Ruby SDK
+email:
+- bryanalves@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openfeature/rollout/provider.rb
+- lib/openfeature/rollout/provider/version.rb
+- openfeature-rollout-provider.gemspec
+homepage: https://github.com/bryanalves/openfeature-rollout-provider
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bryanalves/openfeature-rollout-provider
+  source_code_uri: https://github.com/bryanalves/openfeature-rollout-provider/tree/main/
+  bug_tracker_uri: https://github.com/bryanalvees/openfeature-rollout-provider/issues
+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.3.26
+signing_key:
+specification_version: 4
+summary: The rollout provider for the OpenFeature Ruby SDK
+test_files: []