hackle-ruby-sdk 1.0.0 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hackle-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Hackle
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +126,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement
@@ -122,46 +150,88 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description: Hackle SDK for Ruby
+description: Ruby SDK for Hackle A/B Tests, Feature Flags, Remote Configs, and Analytics.
 email:
 - platform@hackle.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- hackle-ruby-sdk.gemspec
 - lib/hackle-ruby-sdk.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/decision.rb
+- lib/hackle/event.rb
+- lib/hackle/internal/clock/clock.rb
+- lib/hackle/internal/concurrent/executors.rb
+- lib/hackle/internal/concurrent/schedule/scheduler.rb
+- lib/hackle/internal/concurrent/schedule/timer_scheduler.rb
+- lib/hackle/internal/config/parameter_config.rb
+- lib/hackle/internal/core/hackle_core.rb
+- lib/hackle/internal/evaluation/bucketer/bucketer.rb
+- lib/hackle/internal/evaluation/evaluator/contextual/contextual_evaluator.rb
+- lib/hackle/internal/evaluation/evaluator/delegating/delegating_evaluator.rb
+- lib/hackle/internal/evaluation/evaluator/evaluator.rb
+- lib/hackle/internal/evaluation/evaluator/experiment/experiment_evaluation_flow_factory.rb
+- lib/hackle/internal/evaluation/evaluator/experiment/experiment_evaluator.rb
+- lib/hackle/internal/evaluation/evaluator/experiment/experiment_flow_evaluator.rb
+- lib/hackle/internal/evaluation/evaluator/experiment/experiment_resolver.rb
+- lib/hackle/internal/evaluation/evaluator/remoteconfig/remote_config_determiner.rb
+- lib/hackle/internal/evaluation/evaluator/remoteconfig/remote_config_evaluator.rb
+- lib/hackle/internal/evaluation/flow/evaluation_flow.rb
+- lib/hackle/internal/evaluation/flow/flow_evaluator.rb
+- lib/hackle/internal/evaluation/match/condition/condition_matcher.rb
+- lib/hackle/internal/evaluation/match/condition/condition_matcher_factory.rb
+- lib/hackle/internal/evaluation/match/condition/experiment/experiment_condition_matcher.rb
+- lib/hackle/internal/evaluation/match/condition/experiment/experiment_evaluator_matcher.rb
+- lib/hackle/internal/evaluation/match/condition/segment/segment_condition_matcher.rb
+- lib/hackle/internal/evaluation/match/condition/user/user_condition_matcher.rb
+- lib/hackle/internal/evaluation/match/operator/operator_matcher.rb
+- lib/hackle/internal/evaluation/match/operator/operator_matcher_factory.rb
+- lib/hackle/internal/evaluation/match/target/target_matcher.rb
+- lib/hackle/internal/evaluation/match/value/value_matcher.rb
+- lib/hackle/internal/evaluation/match/value/value_matcher_factory.rb
+- lib/hackle/internal/evaluation/match/value/value_operator_matcher.rb
+- lib/hackle/internal/event/user_event.rb
+- lib/hackle/internal/event/user_event_dispatcher.rb
+- lib/hackle/internal/event/user_event_factory.rb
+- lib/hackle/internal/event/user_event_processor.rb
+- lib/hackle/internal/http/http.rb
+- lib/hackle/internal/http/http_client.rb
+- lib/hackle/internal/identifiers/identifier_builder.rb
+- lib/hackle/internal/logger/logger.rb
+- lib/hackle/internal/model/action.rb
+- lib/hackle/internal/model/bucket.rb
+- lib/hackle/internal/model/container.rb
+- lib/hackle/internal/model/decision_reason.rb
+- lib/hackle/internal/model/event_type.rb
+- lib/hackle/internal/model/experiment.rb
+- lib/hackle/internal/model/parameter_configuration.rb
+- lib/hackle/internal/model/remote_config_parameter.rb
+- lib/hackle/internal/model/sdk.rb
+- lib/hackle/internal/model/segment.rb
+- lib/hackle/internal/model/target.rb
+- lib/hackle/internal/model/target_rule.rb
+- lib/hackle/internal/model/targeting.rb
+- lib/hackle/internal/model/value_type.rb
+- lib/hackle/internal/model/variation.rb
+- lib/hackle/internal/model/version.rb
+- lib/hackle/internal/properties/properties_builder.rb
+- lib/hackle/internal/user/hackle_user.rb
+- lib/hackle/internal/user/hackle_user_resolver.rb
+- lib/hackle/internal/workspace/http_workspace_fetcher.rb
+- lib/hackle/internal/workspace/polling_workspace_fetcher.rb
+- lib/hackle/internal/workspace/workspace.rb
+- lib/hackle/internal/workspace/workspace_fetcher.rb
+- lib/hackle/remote_config.rb
+- lib/hackle/user.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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,8 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
-summary: Hackle SDK for Ruby
+summary: Hackle Ruby SDK
 test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---color
---order random

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in hackle-ruby-sdk.gemspec
-gemspec

data/README.md

@@ -1,33 +0,0 @@
-# Hackle::Ruby::Sdk
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hackle`.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'hackle-ruby-sdk'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hackle-ruby-sdk
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hackle-ruby-sdk.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/hackle-ruby-sdk.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hackle/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'hackle-ruby-sdk'
-  spec.version       = Hackle::VERSION
-  spec.authors       = ['Hackle']
-  spec.email         = ['platform@hackle.io']
-  spec.summary       = 'Hackle SDK for Ruby'
-  spec.description   = 'Hackle SDK for Ruby'
-  spec.homepage      = 'https://github.com/hackle-io/hackle-ruby-sdk'
-  spec.license       = 'Apache-2.0'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.73.0'
-
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'json', '>= 1.8'
-  spec.add_runtime_dependency 'murmurhash3', '~> 0.1'
-end

data/lib/hackle/decision/decider.rb

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

data/lib/hackle/events/event_dispatcher.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Hackle
-  class EventDispatcher
-
-    DEFAULT_DISPATCH_WORKER_SIZE = 2
-    DEFAULT_DISPATCH_QUEUE_CAPACITY = 50
-
-    def initialize(config:, sdk_info:)
-      @logger = config.logger
-      @client = HTTP.client(base_uri: config.event_uri)
-      @headers = HTTP.sdk_headers(sdk_info: sdk_info)
-      @dispatcher_executor = Concurrent::ThreadPoolExecutor.new(
-        min_threads: DEFAULT_DISPATCH_WORKER_SIZE,
-        max_threads: DEFAULT_DISPATCH_WORKER_SIZE,
-        max_queue: DEFAULT_DISPATCH_QUEUE_CAPACITY
-      )
-    end
-
-    def dispatch(events:)
-      payload = create_payload(events: events)
-      begin
-        @dispatcher_executor.post { dispatch_payload(payload: payload) }
-      rescue Concurrent::RejectedExecutionError
-        @logger.warn { 'Dispatcher executor queue is full. Event dispatch rejected' }
-      end
-    end
-
-    def shutdown
-      @dispatcher_executor.shutdown
-      unless @dispatcher_executor.wait_for_termination(10)
-        @logger.warn { 'Failed to dispatch previously submitted events' }
-      end
-    end
-
-    private
-
-    def dispatch_payload(payload:)
-      request = Net::HTTP::Post.new('/api/v1/events', @headers)
-      request.content_type = 'application/json'
-      request.body = payload.to_json
-
-      response = @client.request(request)
-
-      status_code = response.code.to_i
-      HTTP.check_successful(status_code: status_code)
-    rescue => e
-      @logger.error { "Failed to dispatch events: #{e.inspect}" }
-    end
-
-    def create_payload(events:)
-      exposure_events = []
-      track_events = []
-      events.each do |event|
-        case event
-        when UserEvent::Exposure
-          exposure_events << create_exposure_event(event)
-        when UserEvent::Track
-          track_events << create_track_event(event)
-        end
-      end
-      {
-        exposureEvents: exposure_events,
-        trackEvents: track_events
-      }
-    end
-
-    #
-    # @param exposure [UserEvent::Exposure]
-    #
-    def create_exposure_event(exposure)
-      {
-        timestamp: exposure.timestamp,
-        userId: exposure.user.id,
-        experimentId: exposure.experiment.id,
-        experimentKey: exposure.experiment.key,
-        variationId: exposure.variation.id,
-        variationKey: exposure.variation.key
-      }
-    end
-
-    #
-    # @param track [UserEvent::Track]
-    #
-    def create_track_event(track)
-      {
-        timestamp: track.timestamp,
-        userId: track.user.id,
-        eventTypeId: track.event_type.id,
-        eventTypeKey: track.event_type.key,
-        value: track.event.value,
-        properties: track.event.properties
-      }
-    end
-  end
-end

data/lib/hackle/events/event_processor.rb

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-module Hackle
-
-  class EventProcessor
-
-    DEFAULT_FLUSH_INTERVAL = 10
-
-    # @param config [Config]
-    # @param event_dispatcher [EventDispatcher]
-    def initialize(config:, event_dispatcher:)
-      @logger = config.logger
-      @event_dispatcher = event_dispatcher
-      @message_processor = MessageProcessor.new(config: config, event_dispatcher: event_dispatcher)
-      @flush_task = Concurrent::TimerTask.new(execution_interval: DEFAULT_FLUSH_INTERVAL) { flush }
-      @consume_task = nil
-      @running = false
-    end
-
-    def start!
-      return if @running
-
-      @consume_task = Thread.new { @message_processor.consuming_loop }
-      @flush_task.execute
-      @running = true
-    end
-
-    def stop!
-      return unless @running
-
-      @logger.info { 'Shutting down Hackle event_processor' }
-
-      @message_processor.produce(message: Message::Shutdown.new, non_block: false)
-      @consume_task.join(10)
-      @flush_task.shutdown
-      @event_dispatcher.shutdown
-
-      @running = false
-    end
-
-    # @param event [UserEvent]
-    def process(event:)
-      @message_processor.produce(message: Message::Event.new(event))
-    end
-
-    def flush
-      @message_processor.produce(message: Message::Flush.new)
-    end
-
-    class Message
-      class Event < Message
-
-        # @return [UserEvent]
-        attr_reader :event
-
-        # @param event [UserEvent]
-        def initialize(event)
-          @event = event
-        end
-      end
-
-      class Flush < Message
-      end
-
-      class Shutdown < Message
-      end
-    end
-
-    class MessageProcessor
-
-      DEFAULT_MESSAGE_QUEUE_CAPACITY = 1000
-      DEFAULT_MAX_EVENT_DISPATCH_SIZE = 500
-
-      def initialize(config:, event_dispatcher:)
-        @logger = config.logger
-        @event_dispatcher = event_dispatcher
-        @message_queue = SizedQueue.new(DEFAULT_MESSAGE_QUEUE_CAPACITY)
-        @random = Random.new
-        @consumed_events = []
-      end
-
-      # @param message [Message]
-      # @param non_block [boolean]
-      def produce(message:, non_block: true)
-        @message_queue.push(message, non_block)
-      rescue ThreadError
-        if @random.rand(1..100) == 1 # log only 1% of the time
-          @logger.warn { 'Events are produced faster than can be consumed. Some events will be dropped.' }
-        end
-      end
-
-      def consuming_loop
-        loop do
-          message = @message_queue.pop
-          case message
-          when Message::Event
-            consume_event(event: message.event)
-          when Message::Flush
-            dispatch_events
-          when Message::Shutdown
-            break
-          end
-        end
-      rescue => e
-        @logger.warn { "Uncaught exception in events message processor: #{e.inspect}" }
-      ensure
-        dispatch_events
-      end
-
-      private
-
-      # @param event [UserEvent]
-      def consume_event(event:)
-        @consumed_events << event
-        dispatch_events if @consumed_events.length >= DEFAULT_MAX_EVENT_DISPATCH_SIZE
-      end
-
-      def dispatch_events
-        return if @consumed_events.empty?
-
-        @event_dispatcher.dispatch(events: @consumed_events)
-        @consumed_events = []
-      end
-    end
-  end
-end