openfeature-sdk 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5a6e99d67eb65e8880d796b8785091679e353eabe7f619282d0aa30a14541d
-  data.tar.gz: 1e56499af1beac4c98245c40fcd840aad5a6327dc010320b76320f5f29065026
+  metadata.gz: 5e0ab3e707e31b5e81d0a804445506bf8cf08b4be649f6f3eee1f38c61b5c286
+  data.tar.gz: e4fa9d61a1c04de6b058c62ea31b4d359f251cf17c3a2323366118baaf64dea7
 SHA512:
-  metadata.gz: 7e93027418e168d45dfdb874e9eafd9e8d94c479d0e31f4db09fad10ce6b454b0beb01e5fd42217d4f68ab0ecfb1be2402f673b02bc0399ff0469258a4b82558
-  data.tar.gz: 4ee653114169ef9ee3af004b65ca6fca4df1674f07cdb1493e28737667fa4d30f2ab1e7245de0b11627c9ae43fcfe175b4e24d6b5b40e0534b38a6bfabb0878a
+  metadata.gz: 2b2e10cc74a605dabbc540cb3eeaa15d887f4173170bd4189526cae141312fdd2f71cbf3f02a41693b6b9eb76716ae8896680072f90f0ce9e89a39aed46c121d
+  data.tar.gz: 696d50f1ff5b0632a77cfb4956fe3fe9b20132d2a39f0850a7b6514c154cf8ae93722bab2348b15443e6b7c6fd1ad354b053828ad7c95140873713025fbf5cd5

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.0.3"
+  ".": "0.1.1"
 }

data/.rspec

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

data/.rubocop.yml

@@ -12,6 +12,17 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'openfeature-sdk.gemspec'
 
 Gemspec/RequireMFA:
   Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  # TODO re-enable after figuring out what it actually wants
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.2

data/.simplecov

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "simplecov-cobertura"
+
+SimpleCov.start do
+  add_filter "/spec/"
+  if ENV["CI"] == "true"
+    formatter SimpleCov::Formatter::CoberturaFormatter
+  else
+    formatter SimpleCov::Formatter::HTMLFormatter
+  end
+end

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.1.1](https://github.com/open-feature/ruby-sdk/compare/v0.1.0...v0.1.1) (2023-09-13)
+
+
+### Bug Fixes
+
+* OpenFeature::SDK::Configuration uses concurrent-ruby gem even though it doesn't depend on it ([#61](https://github.com/open-feature/ruby-sdk/issues/61)) ([c3c1222](https://github.com/open-feature/ruby-sdk/commit/c3c12226a21e43d62358562f4008a4a44a10e72b))
+
+## [0.1.0](https://github.com/open-feature/ruby-sdk/compare/v0.0.3...v0.1.0) (2022-12-15)
+
+
+### Features
+
+* Add client object ([#34](https://github.com/open-feature/ruby-sdk/issues/34)) ([92f8d0d](https://github.com/open-feature/ruby-sdk/commit/92f8d0d4bf693bf74d0f076621f3453f11d4ca65))
+* OpenFeature::SDK.configure ([#41](https://github.com/open-feature/ruby-sdk/issues/41)) ([7587799](https://github.com/open-feature/ruby-sdk/commit/75877997dcb49aeb38a4969734df87b2845e1e6a))
+* **spec:** Add API implementation ([#32](https://github.com/open-feature/ruby-sdk/issues/32)) ([d6b0922](https://github.com/open-feature/ruby-sdk/commit/d6b0922a54e9cb714c44dfe58ddab01356f6916b))
+
 ## [0.0.3](https://github.com/open-feature/ruby-sdk/compare/v0.0.2...v0.0.3) (2022-11-11)
 
 

data/CODEOWNERS

@@ -0,0 +1,6 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence
+#
+# Managed by Peribolos: https://github.com/open-feature/community/blob/main/config/open-feature/sdk-ruby/workgroup.yaml
+#
+* @open-feature/sdk-ruby-maintainers

data/Gemfile

@@ -4,3 +4,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in openfeature-sdk.gemspec
 gemspec
+
+gem "concurrent-ruby", require: "concurrent"

data/Gemfile.lock

@@ -1,34 +1,39 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.0.3)
+    openfeature-sdk (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    json (2.6.2)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    docile (1.4.0)
+    json (2.6.3)
+    markly (0.10.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    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.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (1.37.1)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -39,10 +44,19 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   arm64-darwin-21
@@ -55,10 +69,14 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  concurrent-ruby
+  markly
   openfeature-sdk!
   rake (~> 13.0)
   rspec (~> 3.12.0)
   rubocop (~> 1.37.1)
+  simplecov (~> 0.22.0)
+  simplecov-cobertura (~> 2.1.0)
 
 BUNDLED WITH
    2.3.25

data/README.md

@@ -14,9 +14,10 @@ We support multiple data types for flags (numbers, strings, booleans, objects) a
 
 | Ruby Version | OS                          |
 | -----------  | -----------                 |
-| Ruby 2.7.6   | Windows, MacOS, Linux       |
-| Ruby 3.0.4   | Windows, MacOS, Linux       |
-| Ruby 3.1.2   | Windows, MacOS, Linux       |
+| Ruby 2.7.8   | Windows, MacOS, Linux       |
+| Ruby 3.0.6   | Windows, MacOS, Linux       |
+| Ruby 3.1.4   | Windows, MacOS, Linux       |
+| Ruby 3.2.2   | Windows, MacOS, Linux       |
 
 
 ## Installation
@@ -50,20 +51,20 @@ end
 client = OpenFeature::SDK.build_client(name: "my-app")
 
 # fetching boolean value feature flag
-bool_value = client.fetch_boolean_value(flag_key: 'boolean_flag', default_value: false);
+bool_value = client.fetch_boolean_value(flag_key: 'boolean_flag', default_value: false)
 
 # fetching string value feature flag
-string_value = client.fetch_string_value(flag_key: 'string_flag', default_value: false);
+string_value = client.fetch_string_value(flag_key: 'string_flag', default_value: false)
 
 # fetching number value feature flag
-float_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1.0);
-integer_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1);
+float_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1.0)
+integer_value = client.fetch_number_value(flag_key: 'number_value', default_value: 1)
 
 # get an object value
-object = client.fetch_object_value('object_value', JSON.dump({ name: 'object'}));
+object = client.fetch_object_value(flag_key: 'object_value', default_value: JSON.dump({ name: 'object'}))
 ```
 
-For complete documentation, visit: https://docs.openfeature.dev/docs/category/concepts
+For complete documentation, visit: https://openfeature.dev/docs/category/concepts
 
 ## Contributing
 

data/Rakefile

@@ -7,6 +7,9 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.options = ["--parallel"]
+  task.options << "--color" if ENV["CI"] == "true"
+end
 
 task default: %i[spec rubocop]

data/lib/openfeature/sdk/api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "singleton"
+
+require_relative "configuration"
+require_relative "client"
+require_relative "metadata"
+require_relative "provider/no_op_provider"
+
+module OpenFeature
+  module SDK
+    # API Initialization and Configuration
+    #
+    # Represents the entry point to the API, including configuration of <tt>Provider</tt>,<tt>Hook</tt>,
+    # and building the <tt>Client</tt>
+    #
+    # To use the SDK, you can optionally configure a <tt>Provider</tt>, with <tt>Hook</tt>
+    #
+    #   OpenFeature::SDK::API.instance.configure do |config|
+    #     config.provider = NoOpProvider.new
+    #   end
+    #
+    # If no provider is specified, the <tt>NoOpProvider</tt> is set as the default <tt>Provider</tt>.
+    # Once the SDK has been configured, a client can be built
+    #
+    #   client = OpenFeature::SDK::API.instance.build_client(name: 'my-open-feature-client')
+    class API
+      include Singleton
+      extend Forwardable
+
+      def_delegator :@configuration, :provider
+      def_delegator :@configuration, :hooks
+      def_delegator :@configuration, :context
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure(&block)
+        return unless block_given?
+
+        block.call(configuration)
+      end
+
+      def build_client(name: nil, version: nil)
+        client_options = Metadata.new(name: name, version: version).freeze
+        provider = Provider::NoOpProvider.new if provider.nil?
+        Client.new(provider: provider, client_options: client_options, context: context)
+      end
+    end
+  end
+end

data/lib/openfeature/sdk/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OpenFeature
+  module SDK
+    # TODO: Write documentation
+    #
+    class Client
+      RESULT_TYPE = %i[boolean string number object].freeze
+      SUFFIXES = %i[value details].freeze
+
+      attr_reader :metadata
+
+      attr_accessor :hooks
+
+      def initialize(provider:, client_options: nil, context: nil)
+        @provider = provider
+        @metadata = client_options
+        @context = context
+        @hooks = []
+      end
+
+      RESULT_TYPE.each do |result_type|
+        SUFFIXES.each do |suffix|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            # def fetch_boolean_details(flag_key:, default_value:, evaluation_context: nil)
+            #   result = @provider.fetch_boolean_value(flag_key: flag_key, default_value: default_value, evaluation_context: evaluation_context)
+            # end
+            def fetch_#{result_type}_#{suffix}(flag_key:, default_value:, evaluation_context: nil)
+              result = @provider.fetch_#{result_type}_value(flag_key: flag_key, default_value: default_value, evaluation_context: evaluation_context)
+              #{"result.value" if suffix == :value}
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/openfeature/sdk/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "concurrent"
+
+require_relative "api"
+
+module OpenFeature
+  module SDK
+    # Represents the configuration object for the global API where <tt>Provider</tt>, <tt>Hook</tt>,
+    # and <tt>Context</tt> are configured.
+    # This class is not meant to be interacted with directly but instead through the <tt>OpenFeature::SDK.configure</tt>
+    # method
+    class Configuration
+      extend Forwardable
+
+      attr_accessor :context, :provider, :hooks
+
+      def_delegator :@provider, :metadata
+
+      def initialize
+        @hooks = []
+      end
+    end
+  end
+end

data/lib/openfeature/sdk/metadata.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenFeature
+  module SDK
+    # Metadata structure that defines general metadata relating to a <tt>Provider</tt> or <tt>Client</tt>
+    #
+    # Within the Metadata structure, the following attribute readers are available:
+    #
+    # * <tt>name</tt> - Defines the name of the structure
+    #
+    # * <tt>version</tt> - Allows you to specify version of the Metadata structure
+    #
+    # Usage:
+    #
+    #   metadata = Metadata.new(name: 'name-for-metadata', version: 'v1.1.3')
+    #   metadata.name # 'name-for-metadata'
+    #   metadata.version # version
+    #   metadata_two = Metadata.new(name: 'name-for-metadata')
+    #   metadata_two == metadata # true - equality based on values
+    class Metadata
+      attr_reader :name, :version
+
+      def initialize(name:, version: nil)
+        @name = name
+        @version = version
+      end
+
+      def ==(other)
+        raise ArgumentError("Expected comparison to be between Metadata object") unless other.is_a?(Metadata)
+
+        @name == other.name && @version == other.version
+      end
+    end
+  end
+end

data/lib/openfeature/sdk/provider/no_op_provider.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "../metadata"
+
+# rubocop:disable Lint/UnusedMethodArgument
+module OpenFeature
+  module SDK
+    module Provider
+      # Defines the default provider that is set if no provider is specified.
+      #
+      # To use <tt>NoOpProvider</tt>, it can be set during the configuration of the SDK
+      #
+      #   OpenFeature::SDK.configure do |config|
+      #     config.provider = NoOpProvider.new
+      #   end
+      #
+      # Within the <tt>NoOpProvider</tt>, the following methods exist
+      #
+      # * <tt>fetch_boolean_value</tt> - Retrieve feature flag boolean value
+      #
+      # * <tt>fetch_string_value</tt> - Retrieve feature flag string value
+      #
+      # * <tt>fetch_number_value</tt> - Retrieve feature flag number value
+      #
+      # * <tt>fetch_object_value</tt> - Retrieve feature flag object value
+      #
+      class NoOpProvider
+        REASON_NO_OP = "No-op"
+        NAME = "No-op Provider"
+
+        attr_reader :metadata
+
+        ResolutionDetails = Struct.new(:value, :reason, :variant, :error_code, :error_message)
+
+        def initialize
+          @metadata = Metadata.new(name: NAME).freeze
+        end
+
+        def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+          no_op(default_value)
+        end
+
+        def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+          no_op(default_value)
+        end
+
+        def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+          no_op(default_value)
+        end
+
+        def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+          no_op(default_value)
+        end
+
+        private
+
+        def no_op(default_value)
+          ResolutionDetails.new(value: default_value, reason: REASON_NO_OP)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnusedMethodArgument

data/lib/openfeature/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenFeature
   module SDK
-    VERSION = "0.0.3"
+    VERSION = "0.1.1"
   end
 end

data/lib/openfeature/sdk.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
 
 require_relative "sdk/version"
+require_relative "sdk/api"
 
 module OpenFeature
+  # TODO: Add documentation
+  #
   module SDK
-    class Error < StandardError; end
-    # Your code goes here...
+    class << self
+      def method_missing(method_name, *args, **kwargs, &block)
+        if API.instance.respond_to?(method_name)
+          API.instance.send(method_name, *args, **kwargs, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        API.instance.respond_to?(method_name, include_private) || super
+      end
+    end
   end
 end

data/renovate.json

@@ -1,6 +1,18 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base"
+    "config:base",
+    "helpers:pinGitHubActionDigests"
+  ],
+  "packageRules": [
+    {
+      "matchUpdateTypes": ["minor", "patch"],
+      "matchCurrentVersion": "!/^0/",
+      "automerge": true
+    },
+    {
+      "matchManagers": ["github-actions"],
+      "automerge": true
+    }
   ]
 }

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openfeature-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - OpenFeature Authors
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: markly
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.37.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: Ruby SDK for an the specifications for the open standard of feature flag
   management
 email:
@@ -64,7 +106,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".simplecov"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -72,6 +116,11 @@ files:
 - README.md
 - Rakefile
 - lib/openfeature/sdk.rb
+- lib/openfeature/sdk/api.rb
+- lib/openfeature/sdk/client.rb
+- lib/openfeature/sdk/configuration.rb
+- lib/openfeature/sdk/metadata.rb
+- lib/openfeature/sdk/provider/no_op_provider.rb
 - lib/openfeature/sdk/version.rb
 - release-please-config.json
 - renovate.json
@@ -93,14 +142,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: OpenFeature SDK for Ruby