featurehub-sdk 1.3.0 → 2.0.0

data/sig/feature_hub/featurehub.rbs

@@ -2,32 +2,79 @@ module FeatureHub
   module Sdk
     VERSION: String
 
+    type RolloutStrategyAttributeConditional = "EQUALS" | "ENDS_WITH" | "STARTS_WITH" | "GREATER" |
+      "GREATER_EQUALS" | "LESS" | "LESS_EQUALS" | "NOT_EQUALS" | "INCLUDES" | "EXCLUDES" | "REGEX"
+
+    type RolloutStrategyFieldType = "STRING" | "SEMANTIC_VERSION" | "NUMBER" | "DATE" | "DATETIME" |
+      "BOOLEAN" | "IP_ADDRESS"
+
+    type FeatureRolloutStrategyAttributeHash = {
+      "id" => String?,
+      "conditional" => RolloutStrategyAttributeConditional,
+      "fieldName" => String,
+      "values" => Array[(bool | String | Float)?],
+      "type" => RolloutStrategyFieldType
+    }
+
+    type FeatureRolloutStrategyHash = {
+      "id" => String,
+      "percentage" => Integer?,
+      "percentageAttributes" => Array[String]?,
+      "attributes" => Array[FeatureRolloutStrategyAttributeHash]?,
+      "value" => (bool | String | Float)?
+    }
+
+    type FeatureState = {
+      "id" => String,
+      "key" => String,
+      "l" => bool?,
+      "version" => Integer,
+      "type" => "STRING" | "BOOLEAN" | "NUMBER" | "JSON",
+      "value" => (bool | String | Float)?,
+      "v" => String?,
+      "fp" => Hash[String, String]?,
+      "environmentId" => String?,
+      "strategies" => Array[FeatureRolloutStrategyHash]?
+    }
+
+    type ContextAttributeScalar = String | bool | Float
+    type ContextAttributeValue = ContextAttributeScalar | Array[String] | Array[bool] | Array[Float]
+    type ContextAttributes = Hash[Symbol, Array[ContextAttributeScalar]]
+
     # See the writing guide of rbs: https://github.com/ruby/rbs#guides
     #
 
-    class FeatureState
+    module FeatureValueType
+      BOOLEAN: String
+      JSON: String
+      STRING: String
+      NUMBER: String
+    end
+
+    class FeatureStateHolder
       attr_reader key: Symbol
 
       def initialize: (key: String, repo: InternalFeatureRepository,
-          feature_state: Hash[untyped, untyped]?, parent_state: FeatureState?, ctx: ClientContext?) -> void
+          feature_state: FeatureState?, parent_state: FeatureStateHolder?, ctx: ClientContext?) -> void
 
       def locked?: -> bool
 
-      def exists?: (top_feature: FeatureState?) -> bool
+      def exists?: (top_feature: FeatureStateHolder?) -> bool
+      def present?: () -> bool
 
       def id: -> String?
 
       def feature_type: -> String?
 
-      def with_context: (ctx: ClientContext) -> FeatureState
+      def with_context: (ctx: ClientContext) -> FeatureStateHolder
 
-      def update_feature_state: (feature_state: Hash[untyped, untyped]) -> void
+      def update_feature_state: (feature_state: FeatureState) -> void
 
       # this is the feature state of the top level, it always walks up
-      def feature_state: () -> Hash[untyped, untyped]
+      def feature_state: () -> FeatureState
 
       # this is strictly the internal feature state, further down from the top level it will be nil
-      def internal_feature_state: () -> Hash[untyped, untyped]
+      def internal_feature_state: () -> FeatureState
 
       def value: () -> [bool? | String? | Float?]
 
@@ -49,11 +96,11 @@ module FeatureHub
 
       private
 
-      def top_feature_state: -> FeatureState
+      def top_feature_state: -> FeatureStateHolder
 
-      def _feature_state: -> Hash[untyped, untyped]
+      def _feature_state: -> FeatureState
 
-      def _set_feature_state: (feature_state: Hash[untyped, untyped]) -> void
+      def _set_feature_state: (feature_state: FeatureState) -> void
 
       def get_value: (feature_type: String?) -> [bool? | String? | Float?]
     end
@@ -72,12 +119,42 @@ module FeatureHub
     end
 
     class ValueInterceptor
-      def intercepted_value: (feature_key: Symbol) -> InterceptorValue?
+      def intercepted_value: (feature_key: Symbol, repository: FeatureHubRepository, feature_state: FeatureStateHolder?) -> [bool, (bool? | String? | Float?)]
+
+      def close: () -> void
+    end
+
+    class LocalYamlValueInterceptor < ValueInterceptor
+      def initialize: (?{ filename: String?, watch: bool?, watch_interval: Integer?, logger: untyped }? opts) -> void
     end
 
     class EnvironmentInterceptor < ValueInterceptor
     end
 
+    class RawUpdateFeatureListener
+      def delete_feature: (feature: FeatureState, source: String) -> void
+
+      def process_updates: (features: Array[FeatureState], source: String) -> void
+
+      def process_update: (feature: FeatureState, source: String) -> void
+
+      def close: () -> void
+
+      def config_changed: () -> void
+    end
+
+    class LocalYamlStore < RawUpdateFeatureListener
+      SOURCE: String
+
+      def initialize: (repository: FeatureHubRepository, ?filename: String?) -> void
+    end
+
+    class RedisSessionStore < RawUpdateFeatureListener
+      SOURCE: String
+
+      def initialize: (connection_string: String, repository: FeatureHubRepository, ?opts: { namespace: Integer?, prefix: String?, timeout: Integer?, password: String?, logger: untyped }?) -> void
+    end
+
     class PercentageCalculator
       def determine_client_percentage: (percentage_text: String, feature_id: String) -> int
     end
@@ -93,9 +170,10 @@ module FeatureHub
     end
 
     class InternalFeatureRepository
-      def feature: (key: String) -> FeatureState?
+      def feature: (key: String, ?attrs: Hash[untyped, ContextAttributeValue]?) -> FeatureStateHolder?
+      def value: (key: String, ?default_value: (bool? | String? | Float?), ?attrs: Hash[untyped, ContextAttributeValue]?) -> (bool? | String? | Float?)
 
-      def find_interceptor: (feature_value: String) -> InterceptorValue?
+      def find_interceptor: (feature_key: Symbol, feature_state: FeatureStateHolder?) -> [bool, (bool? | String? | Float?)]
 
       def ready?: -> bool
 
@@ -103,36 +181,41 @@ module FeatureHub
 
       def apply: (strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
 
-      def notify: (status: String, data: Hash[untyped, untyped]) -> void
+      def notify: (status: String, data: FeatureState, ?source: String) -> void
     end
 
     class FeatureHubRepository < InternalFeatureRepository
-      @features: Hash[String, FeatureState]
+      @features: Hash[String, FeatureStateHolder]
       @ready: bool
 
       def initialize: (apply_features: nil | ApplyFeatures) -> void
 
       def apply: (strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
 
-      def notify: (status: String, data: Hash[untyped, untyped]) -> void
+      def notify: (status: String, data: FeatureState, ?source: String) -> void
 
-      def feature: (key: String) -> FeatureState
+      def feature: (key: String, ?attrs: Hash[untyped, ContextAttributeValue]?) -> FeatureStateHolder
+      def value: (key: String, ?default_value: (bool? | String? | Float?), ?attrs: Hash[untyped, ContextAttributeValue]?) -> (bool? | String? | Float?)
 
       def register_interceptor: (interceptor: ValueInterceptor) -> void
 
-      def find_interceptor: (feature_value: String) -> InterceptorValue?
+      def register_raw_update_listener: (listener: RawUpdateFeatureListener) -> void
+
+      def find_interceptor: (feature_key: Symbol, feature_state: FeatureStateHolder?) -> [bool, (bool? | String? | Float?)]
+
+      def close: () -> void
 
       def ready?: -> bool
 
       def not_ready!: -> void
 
-      def extract_feature_state: -> Array[Hash[untyped, untyped]]
+      def extract_feature_state: -> Array[FeatureState]
     end
 
     class ClientContext
       attr_reader repo: InternalFeatureRepository
 
-      def initialize: (repository: InternalFeatureRepository) -> void
+      def initialize: (repository: InternalFeatureRepository, ?attrs: Hash[untyped, ContextAttributeValue]?) -> void
 
       def user_key: (value: String) -> ClientContext
 
@@ -140,23 +223,25 @@ module FeatureHub
 
       def version: (value: String) -> ClientContext
 
-      def country: (value: Symbol) -> ClientContext
+      def country: (value: String | Symbol) -> ClientContext
+
+      def platform: (value: String | Symbol) -> ClientContext
 
-      def platform: (value: Symbol) -> ClientContext
+      def device: (value: String | Symbol) -> ClientContext
 
-      def device: (value: Symbol) -> ClientContext
+      def attribute_value: (key: String | Symbol, values: ContextAttributeValue) -> ClientContext
 
-      def attribute_value: (key: String, values: Array[String]) -> ClientContext
+      def assign: (attrs: Hash[untyped, ContextAttributeValue]) -> ClientContext
 
       def clear: -> ClientContext
 
-      def get_attr: (key: String, default_val: String?) -> Array[String]
+      def get_attr: (key: String | Symbol, ?default_val: ContextAttributeScalar?) -> Array[ContextAttributeScalar]
 
       def default_percentage_key: -> String?
 
       def enabled: (key: String) -> bool?
 
-      def feature: (key: String) -> FeatureState
+      def feature: (key: String) -> FeatureStateHolder
 
       def set?: (key: String) -> bool?
 
@@ -164,7 +249,7 @@ module FeatureHub
 
       def string: (key: String) -> String?
 
-      def json: (key: String) -> Hash[untyped, untyped]?
+      def json: (key: String) -> FeatureState?
 
       def raw_json: (key: String) -> String?
 
@@ -182,7 +267,14 @@ module FeatureHub
     end
 
     class EdgeService
-      def initialize: (repository: InternalFeatureRepository, api_keys: Array[String], edge_url: String) -> void
+      @repository: InternalFeatureRepository?
+      @api_keys: Array[String]
+      @edge_url: String?
+      @logger: untyped
+
+      attr_reader repository: InternalFeatureRepository?
+
+      def initialize: (InternalFeatureRepository?, Array[String], String?, ?untyped) -> void
 
       def poll: -> void
 
@@ -221,6 +313,13 @@ module FeatureHub
       #
       def use_polling_edge_service: (interval: int?) -> void
 
+      def register_interceptor: (interceptor: ValueInterceptor) -> void
+
+      def register_raw_update_listener: (listener: RawUpdateFeatureListener) -> void
+
+      def feature: (key: String, ?attrs: Hash[untyped, ContextAttributeValue]?) -> FeatureStateHolder
+      def value: (key: String, ?default_value: (bool? | String? | Float?), ?attrs: Hash[untyped, ContextAttributeValue]?) -> (bool? | String? | Float?)
+
       def new_context: -> ClientContext
 
       def close: -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: featurehub-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Richard Vowles
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: FeatureHub Ruby SDK
 email:
 - richard@bluetrainsoftware.com
@@ -87,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/CLAUDE.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -183,6 +198,7 @@ files:
 - examples/rails_example/tmp/storage/.keep
 - examples/rails_example/vendor/.keep
 - examples/rails_example/vendor/javascript/.keep
+- examples/sinatra/.dockerignore
 - examples/sinatra/.gitignore
 - examples/sinatra/.ruby-version
 - examples/sinatra/Dockerfile
@@ -194,7 +210,9 @@ files:
 - examples/sinatra/conf/nginx.conf
 - examples/sinatra/conf/nsswitch.conf
 - examples/sinatra/config.ru
+- examples/sinatra/docker-compose.yaml
 - examples/sinatra/docker_start.sh
+- examples/sinatra/feature-flags.yaml
 - examples/sinatra/sinatra.iml
 - examples/sinatra/start.sh
 - examples/sinatra/thin.ru
@@ -204,15 +222,19 @@ files:
 - lib/feature_hub/sdk/context.rb
 - lib/feature_hub/sdk/feature_hub_config.rb
 - lib/feature_hub/sdk/feature_repository.rb
-- lib/feature_hub/sdk/feature_state.rb
+- lib/feature_hub/sdk/feature_state_holder.rb
 - lib/feature_hub/sdk/impl/apply_features.rb
 - lib/feature_hub/sdk/impl/murmur3_percentage.rb
 - lib/feature_hub/sdk/impl/rollout_holders.rb
 - lib/feature_hub/sdk/impl/strategy_wrappers.rb
 - lib/feature_hub/sdk/interceptors.rb
 - lib/feature_hub/sdk/internal_feature_repository.rb
+- lib/feature_hub/sdk/local_yaml_interceptor.rb
+- lib/feature_hub/sdk/local_yaml_store.rb
 - lib/feature_hub/sdk/percentage_calc.rb
 - lib/feature_hub/sdk/poll_edge_service.rb
+- lib/feature_hub/sdk/raw_update_feature_listener.rb
+- lib/feature_hub/sdk/redis_session_store.rb
 - lib/feature_hub/sdk/strategy_attributes.rb
 - lib/feature_hub/sdk/streaming_edge_service.rb
 - lib/feature_hub/sdk/version.rb
@@ -241,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: FeatureHub Ruby SDK
 test_files: []