hackle-ruby-sdk 1.0.0 → 2.0.0

data/lib/hackle/internal/workspace/workspace.rb

@@ -0,0 +1,353 @@
+# frozen_string_literal: true
+
+require 'hackle/internal/model/action'
+require 'hackle/internal/model/bucket'
+require 'hackle/internal/model/container'
+require 'hackle/internal/model/event_type'
+require 'hackle/internal/model/experiment'
+require 'hackle/internal/model/parameter_configuration'
+require 'hackle/internal/model/remote_config_parameter'
+require 'hackle/internal/model/segment'
+require 'hackle/internal/model/target'
+require 'hackle/internal/model/target_rule'
+require 'hackle/internal/model/targeting'
+require 'hackle/internal/model/value_type'
+require 'hackle/internal/model/variation'
+
+module Hackle
+  class Workspace
+    # @param experiments [Hash{Integer => Experiment}]
+    # @param feature_flags [Hash{Integer => Experiment}]
+    # @param buckets [Hash{Integer => Bucket}]
+    # @param event_types [Hash{String => EventType}]
+    # @param segments [Hash{String => Segment}]
+    # @param containers [Hash{Integer => Container}]
+    # @param parameter_configurations [Hash{Integer => ParameterConfiguration}]
+    # @param remote_config_parameters [Hash{String => RemoteConfigParameter}]
+    def initialize(
+      experiments:,
+      feature_flags:,
+      buckets:,
+      event_types:,
+      segments:,
+      containers:,
+      parameter_configurations:,
+      remote_config_parameters:
+    )
+      # @type [Hash{Integer => Experiment}]
+      @experiments = experiments
+
+      # @type [Hash{Integer => Experiment}]
+      @feature_flags = feature_flags
+
+      # @type [Hash{Integer => Bucket}]
+      @buckets = buckets
+
+      # @type [Hash{String => EventType}]
+      @event_types = event_types
+
+      # @type [Hash{String => Segment}]
+      @segments = segments
+
+      # @type [Hash{Integer => Container}]
+      @containers = containers
+
+      # @type [Hash{Integer => ParameterConfiguration}]
+      @parameter_configurations = parameter_configurations
+
+      # @type [Hash{String => RemoteConfigParameter}]
+      @remote_config_parameters = remote_config_parameters
+    end
+
+    # @param experiment_key [Integer]
+    # @return [Hackle::Experiment, nil]
+    def get_experiment_or_nil(experiment_key)
+      @experiments[experiment_key]
+    end
+
+    # @param feature_key [Integer]
+    # @return [Hackle::Experiment, nil]
+    def get_feature_flag_or_nil(feature_key)
+      @feature_flags[feature_key]
+    end
+
+    # @param event_type_key [String]
+    # @return [Hackle::EventType, nil]
+    def get_event_type_or_nil(event_type_key)
+      @event_types[event_type_key]
+    end
+
+    # @param bucket_id [Integer]
+    # @return [Hackle::Bucket, nil]
+    def get_bucket_or_nil(bucket_id)
+      @buckets[bucket_id]
+    end
+
+    # @param segment_key [String]
+    # @return [Hackle::Segment, nil]
+    def get_segment_or_nil(segment_key)
+      @segments[segment_key]
+    end
+
+    # @param container_id [Integer]
+    # @return [Hackle::Container, nil]
+    def get_container_or_nil(container_id)
+      @containers[container_id]
+    end
+
+    # @param parameter_configuration_id [Integer]
+    # @return [Hackle::ParameterConfiguration, nil]
+    def get_parameter_configuration_or_nil(parameter_configuration_id)
+      @parameter_configurations[parameter_configuration_id]
+    end
+
+    # @param parameter_key [String]
+    # @return [Hackle::RemoteConfigParameter, nil]
+    def get_remote_config_parameter_or_nil(parameter_key)
+      @remote_config_parameters[parameter_key]
+    end
+
+    class << self
+      # @param experiments [Array<Experiment>]
+      # @param feature_flags [Array<Experiment>]
+      # @param buckets [Array<Bucket>]
+      # @param event_types [Array<EventType>]
+      # @param segments [Array<Segment>]
+      # @param containers [Array<Container>]
+      # @param parameter_configurations [Array<ParameterConfiguration>]
+      # @param remote_config_parameters [Array<RemoteConfigParameter>]
+      # @return [Workspace]
+      def create(
+        experiments: [],
+        feature_flags: [],
+        buckets: [],
+        event_types: [],
+        segments: [],
+        containers: [],
+        parameter_configurations: [],
+        remote_config_parameters: []
+      )
+        Workspace.new(
+          experiments: experiments.each_with_object({}) { |item, hash| hash[item.key] = item },
+          feature_flags: feature_flags.each_with_object({}) { |item, hash| hash[item.key] = item },
+          buckets: buckets.each_with_object({}) { |item, hash| hash[item.id] = item },
+          event_types: event_types.each_with_object({}) { |item, hash| hash[item.key] = item },
+          segments: segments.each_with_object({}) { |item, hash| hash[item.key] = item },
+          containers: containers.each_with_object({}) { |item, hash| hash[item.id] = item },
+          parameter_configurations: parameter_configurations.each_with_object({}) { |item, hash| hash[item.id] = item },
+          remote_config_parameters: remote_config_parameters.each_with_object({}) { |item, hash| hash[item.key] = item }
+        )
+      end
+
+      # @param hash [Hash]
+      # @return [Hackle::Workspace]
+      def from_hash(hash)
+        Workspace.create(
+          experiments: hash[:experiments].map { |it| experiment(it, ExperimentType::AB_TEST) },
+          feature_flags: hash[:featureFlags].map { |it| experiment(it, ExperimentType::FEATURE_FLAG) },
+          buckets: hash[:buckets].map { |it| bucket(it) },
+          event_types: hash[:events].map { |it| event_type(it) },
+          segments: hash[:segments].map { |it| segment_or_nil(it) }.compact,
+          containers: hash[:containers].map { |it| container(it) },
+          parameter_configurations: hash[:parameterConfigurations].map { |it| parameter_configuration(it) },
+          remote_config_parameters: hash[:remoteConfigParameters].map { |it| remote_config_parameter_or_nil(it) }.compact
+        )
+      end
+
+      private
+
+      def experiment(hash, experiment_type)
+        status = ExperimentStatus.from_or_nil(hash[:execution][:status])
+        return nil if status.nil?
+
+        default_rule = action_or_nil(hash[:execution][:defaultRule])
+        return nil if default_rule.nil?
+
+        Experiment.new(
+          id: hash[:id],
+          key: hash[:key],
+          name: hash[:name],
+          type: experiment_type,
+          identifier_type: hash[:identifierType],
+          status: status,
+          version: hash[:version],
+          execution_version: hash[:execution][:version],
+          variations: hash[:variations].map { |it| variation(it) },
+          user_overrides: Hash[hash[:execution][:userOverrides].map { |it| [it[:userId], it[:variationId]] }],
+          segment_overrides: hash[:execution][:segmentOverrides].map { |it| target_rule_or_nil(it, TargetingType::IDENTIFIER) }.compact,
+          target_audiences: hash[:execution][:targetAudiences].map { |it| target_or_nil(it, TargetingType::PROPERTY) }.compact,
+          target_rules: hash[:execution][:targetRules].map { |it| target_rule_or_nil(it, TargetingType::PROPERTY) }.compact,
+          default_rule: default_rule,
+          container_id: hash[:containerId],
+          winner_variation_id: hash[:winnerVariationId]
+        )
+      end
+
+      def variation(hash)
+        Variation.new(
+          id: hash[:id],
+          key: hash[:key],
+          is_dropped: hash[:status] == 'DROPPED',
+          parameter_configuration_id: hash[:parameterConfigurationId]
+        )
+      end
+
+      def target_or_nil(hash, targeting_type)
+        conditions = hash[:conditions].map { |it| condition_or_nil(it, targeting_type) }.compact
+        return nil if conditions.empty?
+
+        Target.new(conditions: conditions)
+      end
+
+      def condition_or_nil(hash, targeting_type)
+        key = target_key_or_nil(hash[:key])
+        return nil if key.nil?
+        return nil unless targeting_type.supports?(key.type)
+
+        match = target_match_or_nil(hash[:match])
+        return nil if match.nil?
+
+        TargetCondition.new(
+          key: key,
+          match: match
+        )
+      end
+
+      def target_key_or_nil(hash)
+        type = TargetKeyType.from_or_nil(hash[:type])
+        return nil if type.nil?
+
+        TargetKey.new(
+          type: type,
+          name: hash[:name]
+        )
+      end
+
+      def target_match_or_nil(hash)
+        type = TargetMatchType.from_or_nil(hash[:type])
+        return nil if type.nil?
+
+        operator = TargetOperator.from_or_nil(hash[:operator])
+        return nil if operator.nil?
+
+        value_type = ValueType.from_or_nil(hash[:valueType])
+        return nil if value_type.nil?
+
+        TargetMatch.new(
+          type: type,
+          operator: operator,
+          value_type: value_type,
+          values: hash[:values]
+        )
+      end
+
+      def action_or_nil(hash)
+        type = ActionType.from_or_nil(hash[:type])
+        return nil if type.nil?
+
+        Action.new(
+          type: type,
+          variation_id: hash[:variationId],
+          bucket_id: hash[:bucketId]
+        )
+      end
+
+      def target_rule_or_nil(hash, targeting_type)
+        target = target_or_nil(hash[:target], targeting_type)
+        return nil if target.nil?
+
+        action = action_or_nil(hash[:action])
+        return nil if action.nil?
+
+        TargetRule.new(
+          target: target,
+          action: action
+        )
+      end
+
+      def bucket(hash)
+        Bucket.new(
+          id: hash[:id],
+          seed: hash[:seed],
+          slot_size: hash[:slotSize],
+          slots: hash[:slots].map { |it| slot(it) }
+        )
+      end
+
+      def slot(hash)
+        Slot.new(
+          start_inclusive: hash[:startInclusive],
+          end_exclusive: hash[:endExclusive],
+          variation_id: hash[:variationId]
+        )
+      end
+
+      def event_type(hash)
+        EventType.new(
+          id: hash[:id],
+          key: hash[:key]
+        )
+      end
+
+      def segment_or_nil(hash)
+        type = SegmentType.from_or_nil(hash[:type])
+        return nil if type.nil?
+
+        Segment.new(
+          id: hash[:id],
+          key: hash[:key],
+          type: type,
+          targets: hash[:targets].map { |it| target_or_nil(it, TargetingType::SEGMENT) }.compact
+        )
+      end
+
+      def container(hash)
+        Container.new(
+          id: hash[:id],
+          bucket_id: hash[:bucketId],
+          groups: hash[:groups].map { |it| ContainerGroup.new(id: it[:id], experiments: it[:experiments]) }
+        )
+      end
+
+      def parameter_configuration(hash)
+        ParameterConfiguration.new(
+          id: hash[:id],
+          parameters: Hash[hash[:parameters].map { |it| [it[:key], it[:value]] }]
+        )
+      end
+
+      def remote_config_parameter_or_nil(hash)
+        type = ValueType.from_or_nil(hash[:type])
+        return nil if type.nil?
+
+        RemoteConfigParameter.new(
+          id: hash[:id],
+          key: hash[:key],
+          type: type,
+          identifier_type: hash[:identifierType],
+          target_rules: hash[:targetRules].map { |it| remote_config_target_rule_or_nil(it) }.compact,
+          default_value: RemoteConfigValue.new(
+            id: hash[:defaultValue][:id],
+            raw_value: hash[:defaultValue][:value],
+          )
+        )
+      end
+
+      def remote_config_target_rule_or_nil(hash)
+        target = target_or_nil(hash[:target], TargetingType::PROPERTY)
+        return nil if target.nil?
+
+        RemoteConfigTargetRule.new(
+          key: hash[:key],
+          name: hash[:name],
+          target: target,
+          bucket_id: hash[:bucketId],
+          value: RemoteConfigValue.new(
+            id: hash[:value][:id],
+            raw_value: hash[:value][:value]
+          )
+        )
+      end
+    end
+  end
+end

data/lib/hackle/internal/workspace/workspace_fetcher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hackle
+  module WorkspaceFetcher
+    # @return [Workspace, nil]
+    def fetch
+    end
+
+    def start
+    end
+
+    def stop
+    end
+
+    def resume
+    end
+  end
+end

data/lib/hackle/remote_config.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Hackle
+  class RemoteConfig
+    # @param user [Hackle::User]
+    # @param user_resolver [Hackle::HackleUserResolver]
+    # @param core [Hackle::Core]
+    def initialize(user:, user_resolver:, core:)
+      # @type [Hackle::User]
+      @user = user
+
+      # @type [Hackle::HackleUserResolver]
+      @user_resolver = user_resolver
+
+      # @type [Hackle::Core]
+      @core = core
+    end
+
+    # @param key [String]
+    # @param default_value [Object, nil]
+    # @return [Object, nil]
+    def get(key, default_value = nil)
+      case default_value
+      when nil
+        decision(key, default_value, ValueType::NULL).value
+      when String
+        decision(key, default_value, ValueType::STRING).value
+      when Numeric
+        decision(key, default_value, ValueType::NUMBER).value
+      when TrueClass, FalseClass
+        decision(key, default_value, ValueType::BOOLEAN).value
+      else
+        decision(key, default_value, ValueType::UNKNOWN).value
+      end
+
+    end
+
+    private
+
+    # @param key [String]
+    # @param default_value [Object, nil]
+    # @param required_type [Hackle::ValueType]
+    # @return [Hackle::RemoteConfigDecision]
+    def decision(key, default_value, required_type)
+      hackle_user = @user_resolver.resolve_or_nil(@user)
+      return RemoteConfigDecision.new(default_value, DecisionReason::INVALID_INPUT) if hackle_user.nil?
+      return RemoteConfigDecision.new(default_value, DecisionReason::INVALID_INPUT) if key.nil?
+
+      @core.remote_config(key, hackle_user, required_type, default_value)
+    rescue => e
+      Log.get.error { "Unexpected error while deciding remote config parameter[#{key}]. Returning default value: #{e.inspect}" }
+      RemoteConfigDecision.new(default_value, DecisionReason::EXCEPTION)
+    end
+  end
+end

data/lib/hackle/user.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'hackle/internal/identifiers/identifier_builder'
+require 'hackle/internal/properties/properties_builder'
+
+module Hackle
+  class User
+    # @return [String, nil]
+    attr_reader :id
+
+    # @return [String, nil]
+    attr_reader :user_id
+
+    # @return [String, nil]
+    attr_reader :device_id
+
+    # @return [Hash{String => String}]
+    attr_reader :identifiers
+
+    # @return [Hash{String => Object}]
+    attr_reader :properties
+
+    # @param id [String, nil]
+    # @param user_id [String, nil]
+    # @param device_id [String, nil]
+    # @param identifiers [Hash{String => String}]
+    # @param properties [Hash{String => Object}]
+    def initialize(id:, user_id:, device_id:, identifiers:, properties:)
+      @id = id
+      @user_id = user_id
+      @device_id = device_id
+      @identifiers = identifiers
+      @properties = properties
+    end
+
+    def ==(other)
+      return false unless other.is_a?(User)
+
+      id == other.id &&
+        user_id == other.user_id &&
+        device_id == other.device_id &&
+        identifiers == other.identifiers &&
+        properties == other.properties
+    end
+
+    def to_s
+      "Hackle::User(id: #{id}, user_id: #{user_id}, device_id: #{device_id}, identifiers: #{identifiers}, properties: #{properties})"
+    end
+
+    # @return [User::Builder]
+    def self.builder
+      Builder.new
+    end
+
+    class Builder
+      def initialize
+        @identifiers = IdentifiersBuilder.new
+        @properties = PropertiesBuilder.new
+      end
+
+      # @param id [String, Numeric]
+      # @return [User::Builder]
+      def id(id)
+        @id = IdentifiersBuilder.sanitize_value_or_nil(id)
+        self
+      end
+
+      # @param user_id [String, Numeric]
+      # @return [User::Builder]
+      def user_id(user_id)
+        @user_id = IdentifiersBuilder.sanitize_value_or_nil(user_id)
+        self
+      end
+
+      # @param device_id [String, Numeric]
+      # @return [User::Builder]
+      def device_id(device_id)
+        @device_id = IdentifiersBuilder.sanitize_value_or_nil(device_id)
+        self
+      end
+
+      # @param identifier_type [String]
+      # @param identifier_value [String, nil]
+      # @return [User::Builder]
+      def identifier(identifier_type, identifier_value)
+        @identifiers.add(identifier_type, identifier_value)
+        self
+      end
+
+      # @param identifiers [Hash{String => String}]
+      # @return [User::Builder]
+      def identifiers(identifiers)
+        @identifiers.add_all(identifiers)
+        self
+      end
+
+      # @param key [String]
+      # @param value [Object, nil]
+      # @return [User::Builder]
+      def property(key, value)
+        @properties.add(key, value)
+        self
+      end
+
+      # @param properties [Hash{String => Object}]
+      # @return [User::Builder]
+      def properties(properties)
+        @properties.add_all(properties)
+        self
+      end
+
+      # @return [User]
+      def build
+        User.new(
+          id: @id,
+          user_id: @user_id,
+          device_id: @device_id,
+          identifiers: @identifiers.build,
+          properties: @properties.build
+        )
+      end
+    end
+  end
+end

data/lib/hackle/version.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
 module Hackle
-  VERSION = '1.0.0'
-  SDK_NAME = 'ruby-sdk'
-
-  class SdkInfo
-    attr_reader :key, :name, :version
-    def initialize(key:)
-      @key = key
-      @name = SDK_NAME
-      @version = VERSION
-    end
-  end
+  VERSION = '2.0.0'
 end

data/lib/hackle.rb

@@ -2,75 +2,10 @@
 
 require 'hackle/client'
 require 'hackle/config'
-require 'hackle/version'
+require 'hackle/decision'
+require 'hackle/user'
+require 'hackle/event'
+require 'hackle/remote_config'
 
 module Hackle
-
-  #
-  # Instantiates a Hackle client.
-  #
-  # @see Client#initialize
-  #
-  # @param sdk_key [String] The SDK key of your Hackle environment
-  # @param options Optional parameters of configuration options
-  #
-  # @return [Client] The Hackle client instance.
-  #
-  def self.client(sdk_key:, **options)
-    config = Config.new(options)
-    sdk_info = SdkInfo.new(key: sdk_key)
-
-    http_workspace_fetcher = HttpWorkspaceFetcher.new(config: config, sdk_info: sdk_info)
-    polling_workspace_fetcher = PollingWorkspaceFetcher.new(config: config, http_fetcher: http_workspace_fetcher)
-
-    event_dispatcher = EventDispatcher.new(config: config, sdk_info: sdk_info)
-    event_processor = EventProcessor.new(config: config, event_dispatcher: event_dispatcher)
-
-    polling_workspace_fetcher.start!
-    event_processor.start!
-
-    Client.new(
-      config: config,
-      workspace_fetcher: polling_workspace_fetcher,
-      event_processor: event_processor,
-      decider: Decider.new
-    )
-  end
-
-  #
-  # Instantiate a user to be used for the hackle sdk.
-  #
-  # The only required parameter is `id`, which must uniquely identify each user.
-  #
-  # @example
-  #  Hackle.user(id: 'ae2182e0')
-  #  Hackle.user(id: 'ae2182e0', app_version: '1.0.1', paying_customer: false)
-  #
-  # @param id [String] The identifier of the user. (e.g. device_id, account_id etc.)
-  # @param properties Additional properties of the user. (e.g. app_version, membership_grade, etc.)
-  #
-  # @return [User] The configured user object.
-  #
-  def self.user(id:, **properties)
-    User.new(id: id, properties: properties)
-  end
-
-  #
-  # Instantiate an event to be used for the hackle sdk.
-  #
-  # The only required parameter is `key`, which must uniquely identify each event.
-  #
-  # @example
-  #  Hackle.event(key: 'purchase')
-  #  Hackle.event(key: 'purchase', value: 42000.0, app_version: '1.0.1', payment_method: 'CARD' )
-  #
-  # @param key [String] The unique key of the events.
-  # @param value [Float] Optional numeric value of the events (e.g. purchase_amount, quantity, etc.)
-  # @param properties Additional properties of the events (e.g. app_version, os_type, etc.)
-  #
-  # @return [Event] The configured event object.
-  #
-  def self.event(key:, value: nil, **properties)
-    Event.new(key: key, value: value, properties: properties)
-  end
 end