hackle-ruby-sdk 0.0.1 → 1.0.0

data/lib/{hackle-ruby-sdk → hackle}/workspaces/polling_workspace_fetcher.rb

@@ -7,7 +7,7 @@ module Hackle
 
     DEFAULT_POLLING_INTERVAL = 10
 
-    def initialize(config, http_fetcher)
+    def initialize(config:, http_fetcher:)
       @logger = config.logger
       @http_fetcher = http_fetcher
       @current_workspace = Concurrent::AtomicReference.new
@@ -15,6 +15,7 @@ module Hackle
       @running = false
     end
 
+    # @return [Workspace, nil]
     def fetch
       @current_workspace.get
     end
@@ -30,6 +31,8 @@ module Hackle
     def stop!
       return unless @running
 
+      @logger.info { 'Shutting down Hackle workspace_fetcher' }
+
       @task.shutdown
       @running = false
     end

data/lib/hackle/workspaces/workspace.rb

@@ -0,0 +1,100 @@
+module Hackle
+  class Workspace
+
+    # @param experiments [Hash{Integer => Experiment}]
+    # @param event_types [Hash{String => EventType}]
+    def initialize(experiments:, event_types:)
+
+      # @type [Hash{Integer => Experiment}]
+      @experiments = experiments
+
+      # @type [Hash{String => EventType}]
+      @event_types = event_types
+    end
+
+    # @param experiment_key [Integer]
+    #
+    # @return [Experiment, nil]
+    def get_experiment(experiment_key:)
+      @experiments[experiment_key]
+    end
+
+    # @param event_type_key [String]
+    #
+    # @return [EventType]
+    def get_event_type(event_type_key:)
+      event_type = @event_types[event_type_key]
+
+      if event_type.nil?
+        EventType.undefined(key: event_type_key)
+      else
+        event_type
+      end
+    end
+
+    class << self
+      def create(data:)
+        buckets = Hash[data[:buckets].map { |b| [b[:id], bucket(b)] }]
+        running_experiments = Hash[data[:experiments].map { |re| [re[:key], running_experiment(re, buckets)] }]
+        completed_experiment = Hash[data[:completedExperiments].map { |ce| [ce[:experimentKey], completed_experiment(ce)] }]
+        event_types = Hash[data[:events].map { |e| [e[:key], event_type(e)] }]
+        experiments = running_experiments.merge(completed_experiment)
+        Workspace.new(
+          experiments: experiments,
+          event_types: event_types
+        )
+      end
+
+      private
+
+      def running_experiment(data, buckets)
+        Experiment::Running.new(
+          id: data[:id],
+          key: data[:key],
+          bucket: buckets[data[:bucketId]],
+          variations: Hash[data[:variations].map { |v| [v[:id], variation(v)] }],
+          overrides: Hash[data[:execution][:userOverrides].map { |u| [u[:userId], u[:variationId]] }]
+        )
+      end
+
+      def completed_experiment(data)
+        Experiment::Completed.new(
+          id: data[:experimentId],
+          key: data[:experimentKey],
+          winner_variation_key: data[:winnerVariationKey]
+        )
+      end
+
+      def variation(data)
+        Variation.new(
+          id: data[:id],
+          key: data[:key],
+          dropped: data[:status] == 'DROPPED'
+        )
+      end
+
+      def bucket(data)
+        Bucket.new(
+          seed: data[:seed],
+          slot_size: data[:slotSize],
+          slots: data[:slots].map { |s| slot(s) }
+        )
+      end
+
+      def slot(data)
+        Slot.new(
+          start_inclusive: data[:startInclusive],
+          end_exclusive: data[:endExclusive],
+          variation_id: data[:variationId]
+        )
+      end
+
+      def event_type(data)
+        EventType.new(
+          id: data[:id],
+          key: data[:key]
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hackle-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Hackle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,23 +137,26 @@ files:
 - Rakefile
 - hackle-ruby-sdk.gemspec
 - lib/hackle-ruby-sdk.rb
-- lib/hackle-ruby-sdk/client.rb
-- lib/hackle-ruby-sdk/config.rb
-- lib/hackle-ruby-sdk/decision/bucketer.rb
-- lib/hackle-ruby-sdk/decision/decider.rb
-- lib/hackle-ruby-sdk/events/event.rb
-- lib/hackle-ruby-sdk/events/event_dispatcher.rb
-- lib/hackle-ruby-sdk/events/event_processor.rb
-- lib/hackle-ruby-sdk/http/http.rb
-- lib/hackle-ruby-sdk/models/bucket.rb
-- lib/hackle-ruby-sdk/models/event_type.rb
-- lib/hackle-ruby-sdk/models/experiment.rb
-- lib/hackle-ruby-sdk/models/slot.rb
-- lib/hackle-ruby-sdk/models/variation.rb
-- lib/hackle-ruby-sdk/version.rb
-- lib/hackle-ruby-sdk/workspaces/http_workspace_fetcher.rb
-- lib/hackle-ruby-sdk/workspaces/polling_workspace_fetcher.rb
-- lib/hackle-ruby-sdk/workspaces/workspace.rb
+- lib/hackle.rb
+- lib/hackle/client.rb
+- lib/hackle/config.rb
+- lib/hackle/decision/bucketer.rb
+- lib/hackle/decision/decider.rb
+- lib/hackle/events/event_dispatcher.rb
+- lib/hackle/events/event_processor.rb
+- lib/hackle/events/user_event.rb
+- lib/hackle/http/http.rb
+- lib/hackle/models/bucket.rb
+- lib/hackle/models/event.rb
+- lib/hackle/models/event_type.rb
+- lib/hackle/models/experiment.rb
+- lib/hackle/models/slot.rb
+- lib/hackle/models/user.rb
+- lib/hackle/models/variation.rb
+- lib/hackle/version.rb
+- lib/hackle/workspaces/http_workspace_fetcher.rb
+- lib/hackle/workspaces/polling_workspace_fetcher.rb
+- lib/hackle/workspaces/workspace.rb
 homepage: https://github.com/hackle-io/hackle-ruby-sdk
 licenses:
 - Apache-2.0

data/lib/hackle-ruby-sdk/client.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module Hackle
-
-  #
-  # A client for Hackle API.
-  #
-  class Client
-    def initialize(config, workspace_fetcher, event_processor, decider)
-      @logger = config.logger
-      @workspace_fetcher = workspace_fetcher
-      @event_processor = event_processor
-      @decider = decider
-    end
-
-    #
-    # Decide the variation to expose to the user for experiment.
-    #
-    # This method return the control variation 'A' if:
-    # - The experiment key is invalid
-    # - The experiment has not started yet
-    # - The user is not allocated to the experiment
-    # - The decided variation has been dropped
-    #
-    # @param experiment_key [Integer] The unique key of the experiment.
-    # @param user_id [String] The identifier of your customer. (e.g. user_email, account_id, decide_id, etc.)
-    # @param default_variation [String] The default variation of the experiment.
-    #
-    # @return [String] The decided variation for the user, or default variation
-    #
-    def variation(experiment_key, user_id, default_variation = 'A')
-
-      return default_variation if experiment_key.nil?
-      return default_variation if user_id.nil?
-
-      workspace = @workspace_fetcher.fetch
-      return default_variation if workspace.nil?
-
-      experiment = workspace.get_experiment(experiment_key)
-      return default_variation if experiment.nil?
-
-      decision = @decider.decide(experiment, user_id)
-      case decision
-      when Decision::NotAllocated
-        default_variation
-      when Decision::ForcedAllocated
-        decision.variation_key
-      when Decision::NaturalAllocated
-        @event_processor.process(Event::Exposure.new(user_id, experiment, decision.variation))
-        decision.variation.key
-      else
-        default_variation
-      end
-    end
-
-    #
-    # Records the events performed by the user.
-    #
-    # @param event_key [String]  The unique key of the events.
-    # @param user_id [String] The identifier of user that performed the vent.
-    # @param value [Float] Additional numeric value of the events (e.g. purchase_amount, api_latency, etc.)
-    #
-    def track(event_key, user_id, value = nil)
-
-      return if event_key.nil?
-      return if user_id.nil?
-
-      workspace = @workspace_fetcher.fetch
-      return if workspace.nil?
-
-      event_type = workspace.get_event_type(event_key)
-      return if event_type.nil?
-
-      @event_processor.process(Event::Track.new(user_id, event_type, value))
-    end
-
-    #
-    # Shutdown the background task and release the resources used for the background task.
-    #
-    def close
-      @workspace_fetcher.stop!
-      @event_processor.stop!
-    end
-
-    #
-    # Instantiates a Hackle client.
-    #
-    # @param sdk_key [String] The SDK key of your Hackle environment
-    # @param config [Config] An optional client configuration
-    #
-    # @return [Client] The Hackle client instance.
-    #
-    def self.create(sdk_key, config = Config.new)
-      sdk_info = SdkInfo.new(sdk_key)
-
-      http_workspace_fetcher = HttpWorkspaceFetcher.new(config, sdk_info)
-      polling_workspace_fetcher = PollingWorkspaceFetcher.new(config, http_workspace_fetcher)
-
-      event_dispatcher = EventDispatcher.new(config, sdk_info)
-      event_processor = EventProcessor.new(config, event_dispatcher)
-
-      polling_workspace_fetcher.start!
-      event_processor.start!
-
-      Client.new(config, polling_workspace_fetcher, event_processor, Decider.new)
-    end
-  end
-end

data/lib/hackle-ruby-sdk/decision/bucketer.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'murmurhash3'
-
-module Hackle
-  class Bucketer
-    def bucketing(bucket, user_id)
-      slot_number = calculate_slot_number(bucket.seed, bucket.slot_size, user_id)
-      bucket.get_slot(slot_number)
-    end
-
-    def calculate_slot_number(seed, slot_size, user_id)
-      hash_value = hash(user_id, seed)
-      hash_value.abs % slot_size
-    end
-
-    def hash(data, seed)
-      unsigned_value = MurmurHash3::V32.str_hash(data, seed)
-      if (unsigned_value & 0x80000000).zero?
-        unsigned_value
-      else
-        -((unsigned_value ^ 0xFFFFFFFF) + 1)
-      end
-    end
-  end
-end

data/lib/hackle-ruby-sdk/decision/decider.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Hackle
-  class Decision
-    class NotAllocated < Decision
-    end
-
-    class ForcedAllocated < Decision
-      attr_reader :variation_key
-
-      def initialize(variation_key)
-        @variation_key = variation_key
-      end
-    end
-
-    class NaturalAllocated < Decision
-      attr_reader :variation
-
-      def initialize(variation)
-        @variation = variation
-      end
-    end
-  end
-
-  class Decider
-    def initialize
-      @bucketer = Bucketer.new
-    end
-
-    def decide(experiment, user_id)
-      case experiment
-      when Experiment::Completed
-        Decision::ForcedAllocated.new(experiment.winner_variation_key)
-      when Experiment::Running
-        decide_running(experiment, user_id)
-      end
-    end
-
-    def decide_running(experiment, user_id)
-
-      overridden_variation = experiment.get_overridden_variation(user_id)
-      return Decision::ForcedAllocated.new(overridden_variation.key) unless overridden_variation.nil?
-
-      allocated_slot = @bucketer.bucketing(experiment.bucket, user_id)
-      return Decision::NotAllocated.new if allocated_slot.nil?
-
-      allocated_variation = experiment.get_variation(allocated_slot.variation_id)
-      return Decision::NotAllocated.new if allocated_variation.nil?
-      return Decision::NotAllocated.new if allocated_variation.dropped
-
-      Decision::NaturalAllocated.new(allocated_variation)
-    end
-  end
-end

data/lib/hackle-ruby-sdk/events/event.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Hackle
-  class Event
-    attr_reader :timestamp, :user_id
-
-    class Exposure < Event
-      attr_reader :experiment, :variation
-
-      def initialize(user_id, experiment, variation)
-        @timestamp = Event.generate_timestamp
-        @user_id = user_id
-        @experiment = experiment
-        @variation = variation
-      end
-    end
-
-    class Track < Event
-      attr_reader :event_type, :value
-
-      def initialize(user_id, event_type, value = nil)
-        @timestamp = Event.generate_timestamp
-        @user_id = user_id
-        @event_type = event_type
-        @value = value
-      end
-    end
-
-    def self.generate_timestamp
-      (Time.now.to_f * 1000).to_i
-    end
-  end
-end

data/lib/hackle-ruby-sdk/models/bucket.rb

@@ -1,15 +0,0 @@
-module Hackle
-  class Bucket
-    attr_reader :seed, :slot_size
-
-    def initialize(seed, slot_size, slots)
-      @seed = seed
-      @slot_size = slot_size
-      @slots = slots
-    end
-
-    def get_slot(slot_number)
-      @slots.find { |slot| slot.contains?(slot_number) }
-    end
-  end
-end

data/lib/hackle-ruby-sdk/models/event_type.rb

@@ -1,10 +0,0 @@
-module Hackle
-  class EventType
-    attr_reader :id, :key
-
-    def initialize(id, key)
-      @id = id
-      @key = key
-    end
-  end
-end

data/lib/hackle-ruby-sdk/models/experiment.rb

@@ -1,39 +0,0 @@
-module Hackle
-  class Experiment
-    attr_reader :id, :key
-
-    def initialize(id, key)
-      @id = id
-      @key = key
-    end
-
-    class Running < Experiment
-      attr_reader :bucket
-
-      def initialize(id, key, bucket, variations, user_overrides)
-        super(id, key)
-        @bucket = bucket
-        @variations = variations
-        @user_overrides = user_overrides
-      end
-
-      def get_variation(variation_id)
-        @variations[variation_id]
-      end
-
-      def get_overridden_variation(user_id)
-        variation_id = @user_overrides[user_id]
-        get_variation(variation_id)
-      end
-    end
-
-    class Completed < Experiment
-      attr_reader :winner_variation_key
-
-      def initialize(id, key, winner_variation_key)
-        super(id, key)
-        @winner_variation_key = winner_variation_key
-      end
-    end
-  end
-end