featurehub-sdk 1.0.0

data/lib/feature_hub/sdk/strategy_attributes.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+# these are bulk copied in from OpenAPI and left in original case
+module FeatureHub
+  module Sdk
+    # rubocop:disable Naming/ConstantName
+    # rubocop:disable Metrics/ModuleLength
+    module StrategyAttributeCountryName
+      Afghanistan = "afghanistan"
+      Albania = "albania"
+      Algeria = "algeria"
+      Andorra = "andorra"
+      Angola = "angola"
+      AntiguaAndBarbuda = "antigua_and_barbuda"
+      Argentina = "argentina"
+      Armenia = "armenia"
+      Australia = "australia"
+      Austria = "austria"
+      Azerbaijan = "azerbaijan"
+      TheBahamas = "the_bahamas"
+      Bahrain = "bahrain"
+      Bangladesh = "bangladesh"
+      Barbados = "barbados"
+      Belarus = "belarus"
+      Belgium = "belgium"
+      Belize = "belize"
+      Benin = "benin"
+      Bhutan = "bhutan"
+      Bolivia = "bolivia"
+      BosniaAndHerzegovina = "bosnia_and_herzegovina"
+      Botswana = "botswana"
+      Brazil = "brazil"
+      Brunei = "brunei"
+      Bulgaria = "bulgaria"
+      BurkinaFaso = "burkina_faso"
+      Burundi = "burundi"
+      CaboVerde = "cabo_verde"
+      Cambodia = "cambodia"
+      Cameroon = "cameroon"
+      Canada = "canada"
+      CentralAfricanRepublic = "central_african_republic"
+      Chad = "chad"
+      Chile = "chile"
+      China = "china"
+      Colombia = "colombia"
+      Comoros = "comoros"
+      CongoDemocraticRepublicOfThe = "congo_democratic_republic_of_the"
+      CongoRepublicOfThe = "congo_republic_of_the"
+      CostaRica = "costa_rica"
+      CoteDivoire = "cote_divoire"
+      Croatia = "croatia"
+      Cuba = "cuba"
+      Cyprus = "cyprus"
+      CzechRepublic = "czech_republic"
+      Denmark = "denmark"
+      Djibouti = "djibouti"
+      Dominica = "dominica"
+      DominicanRepublic = "dominican_republic"
+      EastTimor = "east_timor"
+      Ecuador = "ecuador"
+      Egypt = "egypt"
+      ElSalvador = "el_salvador"
+      EquatorialGuinea = "equatorial_guinea"
+      Eritrea = "eritrea"
+      Estonia = "estonia"
+      Eswatini = "eswatini"
+      Ethiopia = "ethiopia"
+      Fiji = "fiji"
+      Finland = "finland"
+      France = "france"
+      Gabon = "gabon"
+      TheGambia = "the_gambia"
+      Georgia = "georgia"
+      Germany = "germany"
+      Ghana = "ghana"
+      Greece = "greece"
+      Grenada = "grenada"
+      Guatemala = "guatemala"
+      Guinea = "guinea"
+      GuineaBissau = "guinea_bissau"
+      Guyana = "guyana"
+      Haiti = "haiti"
+      Honduras = "honduras"
+      Hungary = "hungary"
+      Iceland = "iceland"
+      India = "india"
+      Indonesia = "indonesia"
+      Iran = "iran"
+      Iraq = "iraq"
+      Ireland = "ireland"
+      Israel = "israel"
+      Italy = "italy"
+      Jamaica = "jamaica"
+      Japan = "japan"
+      Jordan = "jordan"
+      Kazakhstan = "kazakhstan"
+      Kenya = "kenya"
+      Kiribati = "kiribati"
+      KoreaNorth = "korea_north"
+      KoreaSouth = "korea_south"
+      Kosovo = "kosovo"
+      Kuwait = "kuwait"
+      Kyrgyzstan = "kyrgyzstan"
+      Laos = "laos"
+      Latvia = "latvia"
+      Lebanon = "lebanon"
+      Lesotho = "lesotho"
+      Liberia = "liberia"
+      Libya = "libya"
+      Liechtenstein = "liechtenstein"
+      Lithuania = "lithuania"
+      Luxembourg = "luxembourg"
+      Madagascar = "madagascar"
+      Malawi = "malawi"
+      Malaysia = "malaysia"
+      Maldives = "maldives"
+      Mali = "mali"
+      Malta = "malta"
+      MarshallIslands = "marshall_islands"
+      Mauritania = "mauritania"
+      Mauritius = "mauritius"
+      Mexico = "mexico"
+      MicronesiaFederatedStatesOf = "micronesia_federated_states_of"
+      Moldova = "moldova"
+      Monaco = "monaco"
+      Mongolia = "mongolia"
+      Montenegro = "montenegro"
+      Morocco = "morocco"
+      Mozambique = "mozambique"
+      Myanmar = "myanmar"
+      Namibia = "namibia"
+      Nauru = "nauru"
+      Nepal = "nepal"
+      Netherlands = "netherlands"
+      NewZealand = "new_zealand"
+      Nicaragua = "nicaragua"
+      Niger = "niger"
+      Nigeria = "nigeria"
+      NorthMacedonia = "north_macedonia"
+      Norway = "norway"
+      Oman = "oman"
+      Pakistan = "pakistan"
+      Palau = "palau"
+      Panama = "panama"
+      PapuaNewGuinea = "papua_new_guinea"
+      Paraguay = "paraguay"
+      Peru = "peru"
+      Philippines = "philippines"
+      Poland = "poland"
+      Portugal = "portugal"
+      Qatar = "qatar"
+      Romania = "romania"
+      Russia = "russia"
+      Rwanda = "rwanda"
+      SaintKittsAndNevis = "saint_kitts_and_nevis"
+      SaintLucia = "saint_lucia"
+      SaintVincentAndTheGrenadines = "saint_vincent_and_the_grenadines"
+      Samoa = "samoa"
+      SanMarino = "san_marino"
+      SaoTomeAndPrincipe = "sao_tome_and_principe"
+      SaudiArabia = "saudi_arabia"
+      Senegal = "senegal"
+      Serbia = "serbia"
+      Seychelles = "seychelles"
+      SierraLeone = "sierra_leone"
+      Singapore = "singapore"
+      Slovakia = "slovakia"
+      Slovenia = "slovenia"
+      SolomonIslands = "solomon_islands"
+      Somalia = "somalia"
+      SouthAfrica = "south_africa"
+      Spain = "spain"
+      SriLanka = "sri_lanka"
+      Sudan = "sudan"
+      SudanSouth = "sudan_south"
+      Suriname = "suriname"
+      Sweden = "sweden"
+      Switzerland = "switzerland"
+      Syria = "syria"
+      Taiwan = "taiwan"
+      Tajikistan = "tajikistan"
+      Tanzania = "tanzania"
+      Thailand = "thailand"
+      Togo = "togo"
+      Tonga = "tonga"
+      TrinidadAndTobago = "trinidad_and_tobago"
+      Tunisia = "tunisia"
+      Turkey = "turkey"
+      Turkmenistan = "turkmenistan"
+      Tuvalu = "tuvalu"
+      Uganda = "uganda"
+      Ukraine = "ukraine"
+      UnitedArabEmirates = "united_arab_emirates"
+      UnitedKingdom = "united_kingdom"
+      UnitedStates = "united_states"
+      Uruguay = "uruguay"
+      Uzbekistan = "uzbekistan"
+      Vanuatu = "vanuatu"
+      VaticanCity = "vatican_city"
+      Venezuela = "venezuela"
+      Vietnam = "vietnam"
+      Yemen = "yemen"
+      Zambia = "zambia"
+      Zimbabwe = "zimbabwe"
+    end
+
+    module StrategyAttributeDeviceName
+      Browser = "browser"
+      Mobile = "mobile"
+      Desktop = "desktop"
+      Server = "server"
+      Watch = "watch"
+      Embedded = "embedded"
+    end
+
+    module StrategyAttributePlatformName
+      Linux = "linux"
+      Windows = "windows"
+      Macos = "macos"
+      Android = "android"
+      Ios = "ios"
+    end
+
+    # rubocop:enable Metrics/ModuleLength
+    # rubocop:enable Naming/ConstantName
+  end
+end

data/lib/feature_hub/sdk/streaming_edge_service.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "ld-eventsource"
+require "json"
+
+module FeatureHub
+  module Sdk
+    # provides a streaming service
+    class StreamingEdgeService < FeatureHub::Sdk::EdgeService
+      attr_reader :repository, :sse_client, :url, :closed
+
+      def initialize(repository, api_keys, edge_url, logger = nil)
+        super(repository, api_keys, edge_url)
+
+        @url = "#{edge_url}features/#{api_keys[0]}"
+        @repository = repository
+        @sse_client = nil
+        @closed = true
+        @logger = logger || FeatureHub::Sdk.default_logger
+      end
+
+      def poll
+        start_streaming unless @sse_client
+      end
+
+      def active
+        !@closed && !@sse_client.nil?
+      end
+
+      def close
+        @closed = true
+        return if @sse_client.nil?
+
+        @sse_client.close
+        @sse_client = nil
+      end
+
+      private
+
+      def start_streaming
+        @closed = false
+        @logger.info("streaming from #{@url}")
+        @sse_client = SSE::Client.new(@url) do |client|
+          client.on_event do |event|
+            @repository.notify(event.type, JSON.parse(event.data))
+          end
+          client.on_error do |error|
+            if error.is_a?(SSE::Errors::HTTPStatusError) && (error.status == 404)
+              @repository.notify("failure", nil)
+              close
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/feature_hub/sdk/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FeatureHub
+  # already documented elsewhere
+  module Sdk
+    VERSION = "1.0.0"
+
+    def default_logger
+      log = ::Logger.new($stdout)
+      log.level = ::Logger::WARN
+      log.progname = "featurehub-sdk"
+      log
+    end
+
+    module_function :default_logger
+  end
+end

data/lib/featurehub-sdk.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "feature_hub/sdk/impl/rollout_holders"
+require_relative "feature_hub/sdk/impl/apply_features"
+require_relative "feature_hub/sdk/percentage_calc"
+require_relative "feature_hub/sdk/impl/murmur3_percentage"
+require_relative "feature_hub/sdk/version"
+require_relative "feature_hub/sdk/context"
+require_relative "feature_hub/sdk/feature_hub_config"
+require_relative "feature_hub/sdk/internal_feature_repository"
+require_relative "feature_hub/sdk/feature_repository"
+require_relative "feature_hub/sdk/feature_state"
+require_relative "feature_hub/sdk/interceptors"
+require_relative "feature_hub/sdk/strategy_attributes"
+require_relative "feature_hub/sdk/impl/strategy_wrappers"
+require_relative "feature_hub/sdk/poll_edge_service"
+require_relative "feature_hub/sdk/streaming_edge_service"
+
+# the FeatureHub SDK namespace
+module FeatureHub
+  # the main SDK
+
+  module Sdk
+    # classes inside here are intended to be internal details, do not rely on them
+    module Impl
+    end
+
+    class Error < StandardError; end
+  end
+end

data/sig/feature_hub/featurehub.rbs

@@ -0,0 +1,256 @@
+module FeatureHub
+  module Sdk
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    #
+
+    class FeatureState
+      attr_reader key: Symbol
+
+      def initialize: (key: String, repo: InternalFeatureRepository,
+          feature_state: Hash[untyped, untyped]?, parent_state: FeatureState?, ctx: ClientContext?) -> void
+
+      def locked?: -> bool
+      def exists?: (top_feature: FeatureState?) -> bool
+      def id: -> String?
+      def feature_type: -> String?
+
+      def with_context: (ctx: ClientContext) -> FeatureState
+
+      def update_feature_state: (feature_state: Hash[untyped, untyped]) -> void
+      # this is the feature state of the top level, it always walks up
+      def feature_state: () -> Hash[untyped, untyped]
+
+      # 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 value: () -> [bool? | String? | Float?]
+
+      def version: () -> int
+
+      def string: () -> String?
+
+      def number: () -> Float
+
+      def raw_json: () -> String?
+
+      def boolean: () -> bool?
+
+      def flag: () -> bool?
+
+      def enabled?: () -> bool
+
+      def set?: () -> bool?
+
+      private
+
+      def top_feature_state: -> FeatureState
+
+      def _feature_state: -> Hash[untyped, untyped]
+
+      def _set_feature_state: (feature_state: Hash[untyped, untyped]) -> void
+
+      def get_value: (feature_type: String?) -> [bool? | String? | Float?]
+    end
+
+    class Applied
+      attr_reader matched: bool
+      attr_reader value: [bool? | String? | Float?]
+
+      def initialize:(matched: bool, value: [bool? | String? | Float?]) -> void
+    end
+
+    class InterceptorValue
+      def initialize: (val: [bool? | String? | Float? ]) -> void
+      def cast:(feature_type: String?) -> [bool? | String? | Float? ]
+    end
+
+    class ValueInterceptor
+      def intercepted_value: (feature_key: Symbol) -> InterceptorValue?
+    end
+
+    class EnvironmentInterceptor <  ValueInterceptor
+    end
+
+    class PercentageCalculator
+      def determine_client_percentage: (percentage_text: String, feature_id: String) -> int
+    end
+
+    class ApplyFeatures
+      def initialize: (percent_calculator: PercentageCalculator?, matcher_repository: MatcherRepository?) -> void
+      def apply: (strategies: Array[RolloutStrategy], key: String, feature_value_id: String, context: ClientContext) -> Applied
+      def match_attribute: (context: ClientContext, rs: RolloutStrategyAttribute) -> bool
+      def self.determine_percentage_key: (context: ClientContext, rsi: RolloutStrategy) -> String?
+    end
+
+    class InternalFeatureRepository
+      def feature: (key: String) -> FeatureState?
+      def find_interceptor: (feature_value: String) -> InterceptorValue?
+      def ready?: -> bool
+      def not_ready!: -> void
+      def apply: (strategies: Array[RolloutStrategy], key: String, feature_id: String, context: ClientContext) -> Applied
+      def notify: (status: String, data: Hash[untyped, untyped]) -> void
+    end
+
+    class FeatureHubRepository < InternalFeatureRepository
+      @features: Hash[String, FeatureState]
+      @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 feature: (key: String) -> FeatureState
+      def register_interceptor: (interceptor: ValueInterceptor) -> void
+
+      def find_interceptor: (feature_value: String) -> InterceptorValue?
+      def ready?: -> bool
+      def not_ready!: -> void
+
+      def extract_feature_state: -> Array[Hash[untyped, untyped]]
+    end
+
+    class ClientContext
+      attr_reader repo: InternalFeatureRepository
+
+      def initialize: (repository: InternalFeatureRepository) -> void
+      def user_key: (value: String) -> ClientContext
+      def session_key: (value: String) -> ClientContext
+      def version: (value: String) -> ClientContext
+      def country: (value: Symbol ) -> ClientContext
+      def platform: (value: Symbol ) -> ClientContext
+      def device: (value: Symbol ) -> ClientContext
+      def attribute_value: (key: String, values: Array[String] ) -> ClientContext
+      def clear: -> ClientContext
+      def get_attr: (key: String, default_val: String?) -> String?
+      def default_percentage_key: -> String?
+      def enabled: (key: String) -> bool?
+
+      def feature: (key: String) -> FeatureState
+      def set?: (key: String) -> bool?
+      def number: (key: String) -> Float?
+      def string: (key: String) -> String?
+      def json: (key: String) -> Hash[untyped, untyped]?
+      def raw_json: (key: String) -> String?
+      def flag: (key: String) -> bool?
+      def boolean: (key: String) -> bool?
+      def exists?: (key: String) -> bool
+
+      def build: -> ClientContext
+      def build_sync: -> ClientContext
+      def close: -> ClientContext
+    end
+
+    class EdgeService
+      def initialize: (repository: InternalFeatureRepository, api_keys: Array[String], edge_url: String) -> void
+      def poll: -> void
+      def context_change: (new_header: String?) -> void
+      def close: -> void
+    end
+
+    class ServerEvalFeatureContext < ClientContext
+      @edge: EdgeService
+
+      def initialize: (repository: InternalFeatureRepository, edge: EdgeService) -> void
+    end
+
+    class ClientEvalFeatureContext < ClientContext
+      @edge: EdgeService
+
+      def initialize: (repository: InternalFeatureRepository, edge: EdgeService) -> void
+    end
+
+    class FeatureHubConfig
+      attr_reader edge_url: String
+      attr_reader api_keys: Array[String]
+      attr_reader client_evaluated: bool
+
+      def initialize: (edge_url: String, api_keys: Array[String], repository: InternalFeatureRepository) -> void
+
+      def repository: (repository: InternalFeatureRepository?) -> InternalFeatureRepository
+
+      def init: -> void
+
+      def get_or_create_edge_service: -> EdgeService
+
+      # can't figure this out
+      # def edge_service_provider:
+      #
+      def use_polling_edge_service: (interval: int?) -> void
+
+      def new_context: -> ClientContext
+
+      def close: -> void
+    end
+
+    class PollingEdgeService
+
+    end
+
+    class RolloutStrategyCondition
+      def equals?: -> bool
+      def ends_with?: -> bool
+      def starts_with?: -> bool
+      def greater?: -> bool
+      def greater_equals?: -> bool
+      def less?: -> bool
+      def less_equals?: -> bool
+      def not_equals?: -> bool
+      def includes?: -> bool
+      def excludes?: -> bool
+      def regex?: -> bool
+    end
+
+    class RolloutStrategyAttribute
+      attr_reader id: String
+      attr_reader conditional: RolloutStrategyCondition
+      attr_reader field_name: String
+      attr_reader values: Array[[bool? | String? | Float?]]
+      attr_reader field_type: String
+
+      def float_values: -> Array[Float]
+      def str_values: -> Array[String]
+    end
+
+    class RolloutStrategy
+      attr_reader attributes: Array[RolloutStrategyAttribute]
+      attr_reader id: String
+      attr_reader name: String?
+      attr_reader percentage: int
+      attr_reader percentage_attributes: Array[String]
+      attr_reader value: [bool? | String? | Float?]
+
+      def percentage_attributes?: -> bool
+      def attributes?: -> bool
+    end
+
+    class StrategyMatcher
+      def match: (supplied_value: String, attr: RolloutStrategyAttribute ) -> bool
+    end
+
+    class BooleanMatcher < StrategyMatcher
+      def match: (supplied_value: String, attr: RolloutStrategyAttribute ) -> bool
+    end
+
+    class StringMatcher < StrategyMatcher
+    end
+
+    class NumberMatcher < StrategyMatcher
+    end
+
+    class SemanticVersionMatcher < StrategyMatcher
+    end
+
+    class IPNetworkMatcher < StrategyMatcher
+    end
+
+    class MatcherRepository
+      def find_matcher: (attr: RolloutStrategyAttribute) -> StrategyMatcher
+    end
+
+    class MatcherRegistry < MatcherRepository
+    end
+end
+
+end
+end