rox-rollout 0.1.3

data/lib/rox/core/client/device_properties.rb

@@ -0,0 +1,45 @@
+require 'rox/core/consts/property_type'
+require 'rox/core/consts/build'
+
+module Rox
+  module Core
+    class DeviceProperties
+      def initialize(sdk_settings, rox_options)
+        @sdk_settings = sdk_settings
+        @rox_options = rox_options
+      end
+
+      def all_properties
+        {
+          PropertyType::PACKAGE_NAME.name => @rox_options.version,
+          PropertyType::VERSION_NAME.name => @rox_options.version,
+          PropertyType::LIB_VERSION.name => lib_version,
+          PropertyType::ROLLOUT_BUILD.name => '50',
+          PropertyType::API_VERSION.name => Build::API_VERSION,
+          PropertyType::APP_VERSION.name => @rox_options.version,
+          PropertyType::APP_RELEASE.name => @rox_options.version,
+          PropertyType::DISTINCT_ID.name => distinct_id,
+          PropertyType::APP_KEY.name => @sdk_settings.api_key,
+          PropertyType::PLATFORM.name => Build::PLATFORM,
+        }
+      end
+
+      def rollout_environment
+        env = ENV['ROLLOUT_MODE']
+        %w[QA LOCAL].include?(env) ? env : 'PRODUCTION'
+      end
+
+      def lib_version
+        '1.0.0'
+      end
+
+      def rollout_key
+        all_properties[PropertyType::APP_KEY.name]
+      end
+
+      def distinct_id
+        'stam'
+      end
+    end
+  end
+end

data/lib/rox/core/client/internal_flags.rb

@@ -0,0 +1,20 @@
+require 'rox/core/entities/flag'
+
+module Rox
+  module Core
+    class InternalFlags
+      def initialize(experiment_repository, parser)
+        @experiment_repository = experiment_repository
+        @parser = parser
+      end
+
+      def enabled?(flag_name)
+        internal_experiment = @experiment_repository.experiment_by_flag(flag_name)
+        return false if internal_experiment.nil?
+
+        value = @parser.evaluate_expression(internal_experiment.condition, nil).string_value
+        value == Flag::FLAG_TRUE_VALUE
+      end
+    end
+  end
+end

data/lib/rox/core/client/sdk_settings.rb

@@ -0,0 +1,5 @@
+module Rox
+  module Core
+    SdkSettings = Struct.new(:api_key, :dev_mode_secret)
+  end
+end

data/lib/rox/core/configuration/configuration.rb

@@ -0,0 +1,5 @@
+module Rox
+  module Core
+    Configuration = Struct.new(:experiments, :target_groups, :signature_date)
+  end
+end

data/lib/rox/core/configuration/configuration_fetched_args.rb

@@ -0,0 +1,23 @@
+require 'rox/core/configuration/fetcher_error'
+require 'rox/core/configuration/fetcher_status'
+
+module Rox
+  module Core
+    class ConfigurationFetchedArgs
+      attr_accessor :fetcher_status, :creation_date, :has_changes, :error_details
+
+      def initialize(fetcher_status, creation_date, has_changes)
+        @fetcher_status = fetcher_status
+        @creation_date = creation_date
+        @has_changes = has_changes
+        @error_details = FetcherError::NO_ERROR
+      end
+
+      def self.error(error_details)
+        args = ConfigurationFetchedArgs.new(FetcherStatus::ERROR_FETCHED_FAILED, nil, false )
+        args.error_details = error_details
+        args
+      end
+    end
+  end
+end

data/lib/rox/core/configuration/configuration_fetched_invoker.rb

@@ -0,0 +1,37 @@
+require 'rox/core/configuration/configuration_fetched_args'
+
+module Rox
+  module Core
+    class ConfigurationFetchedInvoker
+      def initialize
+        @fetched_handlers = []
+        @mutex = Mutex.new
+      end
+
+      def invoke(fetcher_status, creation_date, has_changes)
+        raise_fetched_event(Rox::Core::ConfigurationFetchedArgs.new(fetcher_status, creation_date, has_changes))
+      end
+
+      def invoke_error(error_details)
+        raise_fetched_event(Rox::Core::ConfigurationFetchedArgs.error(error_details))
+      end
+
+      def register_fetched_handler(&block)
+        @mutex.synchronize do
+          @fetched_handlers << block
+        end
+      end
+
+      def raise_fetched_event(args)
+        handlers = []
+        @mutex.synchronize do
+          handlers = @fetched_handlers.clone
+        end
+
+        handlers.each do |handler|
+          handler.call(args)
+        end
+      end
+    end
+  end
+end

data/lib/rox/core/configuration/configuration_parser.rb

@@ -0,0 +1,85 @@
+require 'date'
+require 'json'
+require 'rox/core/configuration/configuration'
+require 'rox/core/configuration/fetcher_error'
+require 'rox/core/configuration/models/experiment_model'
+require 'rox/core/configuration/models/target_group_model'
+require 'rox/core/network/configuration_source'
+require 'rox/core/logging/logging'
+
+module Rox
+  module Core
+    class ConfigurationParser
+      def initialize(signature_verifier, error_reporter, configuration_fetched_invoker)
+        @signature_verifier = signature_verifier
+        @error_reporter = error_reporter
+        @configuration_fetched_invoker = configuration_fetched_invoker
+      end
+
+      def parse(fetch_result, sdk_settings)
+        begin
+          if fetch_result.nil? || fetch_result.data.nil? || fetch_result.data.empty?
+            @configuration_fetched_invoker.invoke_error(FetcherError::EMPTY_JSON)
+            @error_reporter.report('Failed to parse JSON configuration - Null Or Empty', ArgumentError.new('data'))
+            return nil
+          end
+
+          begin
+            json_obj = JSON.parse(fetch_result.data)
+          rescue StandardError => ex
+            @configuration_fetched_invoker.invoke_error(FetcherError::CORRUPTED_JSON)
+            @error_reporter.report('Failed to parse JSON configuration', ex)
+            return nil
+          end
+
+          if fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'], json_obj['signature_v0'])
+            @configuration_fetched_invoker.invoke_error(FetcherError::SIGNATURE_VERIFICATION_ERROR)
+            @error_reporter.report('Failed to validate signature', StandardError.new("Data : #{json_obj['data']} Signature : #{json_obj['signature_v0']}"))
+            return nil
+          end
+
+          signature_date = DateTime.rfc3339(json_obj['signed_date']).to_time
+          internal_data_string = json_obj['data']
+          internal_data_object = JSON.parse(internal_data_string)
+
+          if fetch_result.source != ConfigurationSource::ROXY && internal_data_object['application'] != sdk_settings.api_key
+            @configuration_fetched_invoker.invoke_error(FetcherError::MISMATCH_APP_KEY)
+            @error_reporter.report('Failed to parse JSON configuration - ', StandardError.new("Internal Data: #{internal_data_object['application']} SdkSettings: #{sdk_settings.api_key}"))
+            return nil
+          end
+
+          experiments = parse_experiments(internal_data_object)
+          target_groups = parse_target_groups(internal_data_object)
+
+          Configuration.new(experiments, target_groups, signature_date)
+        rescue StandardError => ex
+          Logging.logger.error('Failed to parse configurations', ex)
+          @configuration_fetched_invoker.invoke_error(FetcherError::UNKNOWN)
+          return nil
+        end
+      end
+
+      def parse_experiments(data)
+        data['experiments'].map { |e| parse_experiment(e)}
+      end
+
+      def parse_experiment(data)
+        condition = data['deploymentConfiguration']['condition']
+        is_archived = data['archived']
+        name = data['name']
+        id = data['_id']
+        labels = data['labels'] || []
+        flags = data['featureFlags'].map {|f| f['name']}
+        ExperimentModel.new(id, name, condition, is_archived, flags, labels)
+      end
+
+      def parse_target_groups(data)
+        data['targetGroups'].map { |g| parse_target_group(g)}
+      end
+
+      def parse_target_group(data)
+        TargetGroupModel.new(data['_id'], data['condition'])
+      end
+    end
+  end
+end

data/lib/rox/core/configuration/fetcher_error.rb

@@ -0,0 +1,13 @@
+module Rox
+  module Core
+    module FetcherError
+      CORRUPTED_JSON = 'CorruptedJson'.freeze
+      EMPTY_JSON = 'EmptyJson'.freeze
+      SIGNATURE_VERIFICATION_ERROR = 'SignatureVerificationError'.freeze
+      NETWORK_ERROR = 'NetworkError'.freeze
+      MISMATCH_APP_KEY = 'MismatchAppKey'.freeze
+      UNKNOWN = 'Unknown'.freeze
+      NO_ERROR = 'NoError'.freeze
+    end
+  end
+end

data/lib/rox/core/configuration/fetcher_status.rb

@@ -0,0 +1,10 @@
+module Rox
+  module Core
+    class FetcherStatus
+      APPLIED_FROM_EMBEDDED = 'AppliedFromEmbedded'.freeze
+      APPLIED_FROM_LOCAL_STORAGE = 'AppliedFromLocalStorage'.freeze
+      APPLIED_FROM_NETWORK = 'AppliedFromNetwork'.freeze
+      ERROR_FETCHED_FAILED = 'ErrorFetchedFailed'.freeze
+    end
+  end
+end

data/lib/rox/core/configuration/models/experiment_model.rb

@@ -0,0 +1,5 @@
+module Rox
+  module Core
+    ExperimentModel = Struct.new(:id, :name, :condition, :is_archived, :flags, :labels)
+  end
+end

data/lib/rox/core/configuration/models/target_group_model.rb

@@ -0,0 +1,5 @@
+module Rox
+  module Core
+    TargetGroupModel = Struct.new(:id, :condition)
+  end
+end

data/lib/rox/core/consts/build.rb

@@ -0,0 +1,8 @@
+module Rox
+  module Core
+    module Build
+      PLATFORM = 'Ruby'
+      API_VERSION = '1.7.0'
+    end
+  end
+end

data/lib/rox/core/consts/environment.rb

@@ -0,0 +1,42 @@
+module Rox
+  module Core
+    module Environment
+      def self.roxy_internal_path
+        'device/request_configuration'
+      end
+
+      def self.cdn_path
+        case ENV['ROLLOUT_MODE']
+        when 'QA'
+          'https://s3.amazonaws.com/qa-rox-conf.rollout.io/v1/qa'
+        when 'LOCAL'
+          'https://s3.amazonaws.com/qa-rox-conf.rollout.io/v1/development'
+        else
+          'https://s3.amazonaws.com/rox-conf.rollout.io/v1/production'
+        end
+      end
+
+      def self.api_path
+        case ENV['ROLLOUT_MODE']
+        when 'QA'
+          'https://qax.rollout.io/device/request_configuration'
+        when 'LOCAL'
+          'http://127.0.0.1:8557/device/request_configuration'
+        else
+          'https://x-api.rollout.io/device/request_configuration'
+        end
+      end
+
+      def self.analytics_path
+        case ENV['ROLLOUT_MODE']
+        when 'QA'
+          'https://qaanalytic.rollout.io'
+        when 'LOCAL'
+          'http://127.0.0.1:8787'
+        else
+          'https://analytic.rollout.io'
+        end
+      end
+    end
+  end
+end

data/lib/rox/core/consts/property_type.rb

@@ -0,0 +1,29 @@
+module Rox
+  module Core
+    class PropertyType
+      attr_accessor :value, :name
+
+      def initialize(value, name)
+        @value = value
+        @name = name
+      end
+
+      CACHE_MISS_URL = PropertyType.new(1, 'cache_miss_url')
+      PACKAGE_NAME = PropertyType.new(2, "package_name")
+      VERSION_NAME = PropertyType.new(3, "version_name")
+      LIB_VERSION = PropertyType.new(4, "lib_version")
+      ROLLOUT_BUILD = PropertyType.new(5, "rollout_build")
+      API_VERSION = PropertyType.new(6, "api_version")
+      BUID = PropertyType.new(7, "buid")
+      BUID_GENERATORS_LIST = PropertyType.new(8, "buid_generators_list")
+      APP_VERSION = PropertyType.new(9, "app_version")
+      APP_RELEASE = PropertyType.new(10, "app_release")
+      DISTINCT_ID = PropertyType.new(11, "distinct_id")
+      APP_KEY = PropertyType.new(12, "app_key")
+      FEATURE_FLAGS = PropertyType.new(13, "feature_flags")
+      REMOTE_VARIABLES = PropertyType.new(14, "remote_variables")
+      CUSTOM_PROPERTIES = PropertyType.new(15, "custom_properties")
+      PLATFORM = PropertyType.new(16, "platform")
+    end
+  end
+end

data/lib/rox/core/context/merged_context.rb

@@ -0,0 +1,16 @@
+module Rox
+  module Core
+    class MergedContext
+      def initialize(global_context, local_context)
+        @global_context = global_context
+        @local_context = local_context
+      end
+
+      def [](key)
+        return @local_context[key] unless @local_context.nil? || @local_context[key].nil?
+        return @global_context[key] unless @global_context.nil?
+        nil
+      end
+    end
+  end
+end

data/lib/rox/core/core.rb

@@ -0,0 +1,131 @@
+require 'rox/core/repositories/flag_repository'
+require 'rox/core/repositories/custom_property_repository'
+require 'rox/core/repositories/target_group_repository'
+require 'rox/core/repositories/experiment_repository'
+require 'rox/core/roxx/parser'
+require 'rox/core/repositories/roxx/experiments_extensions'
+require 'rox/core/repositories/roxx/properties_extensions'
+require 'rox/core/configuration/configuration_fetched_invoker'
+require 'rox/core/configuration/configuration_parser'
+require 'rox/core/network/request_configuration_builder'
+require 'rox/core/network/request'
+require 'rox/core/network/configuration_fetcher'
+require 'rox/core/network/configuration_fetcher_roxy'
+require 'rox/core/register/registerer'
+require 'rox/core/client/internal_flags'
+require 'rox/core/client/buid'
+require 'rox/core/entities/flag_setter'
+require 'rox/core/impression/impression_invoker'
+require 'rox/core/reporting/error_reporter'
+require 'rox/core/security/signature_verifier'
+require 'rox/core/utils/periodic_task'
+
+module Rox
+  module Core
+    class Core
+      def initialize
+        @flag_repository = FlagRepository.new
+        @custom_property_repository = CustomPropertyRepository.new
+        @target_group_repository = TargetGroupRepository.new
+        @experiment_repository = ExperimentRepository.new
+        @parser = Parser.new
+
+        experiments_extensions = ExperimentsExtensions.new(@parser, @target_group_repository, @flag_repository, @experiment_repository)
+        properties_extensions = PropertiesExtensions.new(@parser, @custom_property_repository)
+        experiments_extensions.extend
+        properties_extensions.extend
+
+        @configuration_fetched_invoker = ConfigurationFetchedInvoker.new
+        @registerer = Registerer.new(@flag_repository)
+
+        @sdk_settings = nil
+        @impression_invoker = nil
+        @flag_setter = nil
+        @error_reporter = nil
+        @configuration_fetcher = nil
+        @last_configurations = nil
+      end
+
+      def setup(sdk_settings, device_properties, rox_options)
+        @sdk_settings = sdk_settings
+
+        roxy_path = rox_options.nil? || rox_options.roxy_url.nil? ? nil : rox_options.roxy_url
+
+        # TODO: Analytics.Analytics.Initialize(deviceProperties.RolloutKey, deviceProperties)
+        internal_flags = InternalFlags.new(@experiment_repository, @parser)
+
+        # TODO: impressionInvoker = new ImpressionInvoker(internalFlags, customPropertyRepository, deviceProperties, Analytics.Analytics.Client, roxyPath != null);
+        @impression_invoker = ImpressionInvoker.new(internal_flags, @custom_property_repository, device_properties, nil, !roxy_path.nil?)
+        @flag_setter = FlagSetter.new(@flag_repository, @parser, @experiment_repository, @impression_invoker)
+        buid = BUID.new(sdk_settings, device_properties, @flag_repository, @custom_property_repository)
+
+        request_config_builder = RequestConfigurationBuilder.new(sdk_settings, buid, device_properties, roxy_path)
+
+        client_request = Request.new
+        err_reporter_request = Request.new
+
+        @error_reporter = ErrorReporter.new(err_reporter_request, device_properties, buid)
+
+        if roxy_path.nil?
+          @configuration_fetcher = ConfigurationFetcher.new(request_config_builder, client_request, @configuration_fetched_invoker)
+        else
+          @configuration_fetcher = ConfigurationFetcherRoxy.new(request_config_builder, client_request, @configuration_fetched_invoker)
+        end
+
+        if !rox_options.nil? && !rox_options.configuration_fetched_handler.nil?
+          @configuration_fetched_invoker.register_fetched_handler(&rox_options.configuration_fetched_handler)
+        end
+
+        Thread.new do
+          Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
+          fetch
+
+          if !rox_options.nil? && !rox_options.impression_handler.nil?
+            @impression_invoker.register_impression_handler(&rox_options.impression_handler)
+          end
+
+          if !rox_options.nil? && !rox_options.fetch_interval.nil?
+            PeriodicTask.run(rox_options.fetch_interval) { fetch }
+          end
+        end
+      end
+
+      def fetch
+        return if @configuration_fetcher.nil?
+
+        configuration_parser = ConfigurationParser.new(SignatureVerifier.new, @error_reporter, @configuration_fetched_invoker)
+        result = @configuration_fetcher.fetch
+        return if result.nil?
+
+        configuration = configuration_parser.parse(result, @sdk_settings)
+        return if configuration.nil?
+
+        @experiment_repository.experiments = configuration.experiments
+        @target_group_repository.target_groups = configuration.target_groups
+        @flag_setter.set_experiments
+
+        has_changes = @last_configurations.nil? || @last_configurations.data != result.data
+        @last_configurations = result
+        @configuration_fetched_invoker.invoke(FetcherStatus::APPLIED_FROM_NETWORK, configuration.signature_date, has_changes)
+      end
+
+      def register(ns, rox_container)
+        @registerer.register_instance(rox_container, ns)
+      end
+
+      def context=(context)
+        @flag_repository.all_flags.each do |flag|
+          flag.context = context
+        end
+      end
+
+      def add_custom_property(property)
+        @custom_property_repository.add_custom_property(property)
+      end
+
+      def add_custom_property_if_not_exists(property)
+        @custom_property_repository.add_custom_property_if_not_exists(property)
+      end
+    end
+  end
+end