optimizely-sdk 0.0.12

data/lib/optimizely/helpers/group.rb

@@ -0,0 +1,14 @@
+module Optimizely
+  module Helpers
+    module Group
+      ORDERED_POLICY = 'ordered'
+      RANDOM_POLICY = 'random'
+
+      module_function
+
+      def random_policy?(group)
+        group['policy'] == RANDOM_POLICY
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/validator.rb

@@ -0,0 +1,60 @@
+require_relative 'constants'
+require 'json-schema'
+
+module Optimizely
+  module Helpers
+    module Validator
+      module_function
+
+      def attributes_valid?(attributes)
+        # Determines if provided attributes are valid.
+        #
+        # attributes - User attributes to be validated.
+        #
+        # Returns boolean depending on validity of attributes.
+
+        attributes.is_a?(Hash)
+      end
+
+      def datafile_valid?(datafile)
+        # Determines if a given datafile is valid.
+        #
+        # datafile - String JSON representing the project.
+        #
+        # Returns boolean depending on validity of datafile.
+
+        JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA, datafile)
+      end
+
+      def error_handler_valid?(error_handler)
+        # Determines if a given error handler is valid.
+        #
+        # error_handler - error_handler to be validated.
+        #
+        # Returns boolean depending on whether error_handler has a handle_error method.
+
+        error_handler.respond_to?(:handle_error)
+      end
+
+      def event_dispatcher_valid?(event_dispatcher)
+        # Determines if a given event dispatcher is valid.
+        #
+        # event_dispatcher - event_dispatcher to be validated.
+        #
+        # Returns boolean depending on whether event_dispatcher has a dispatch_event method.
+
+        event_dispatcher.respond_to?(:dispatch_event)
+      end
+
+      def logger_valid?(logger)
+        # Determines if a given logger is valid.
+        #
+        # logger - logger to be validated.
+        #
+        # Returns boolean depending on whether logger has a log method.
+
+        logger.respond_to?(:log)
+      end
+    end
+  end
+end

data/lib/optimizely/logger.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+module Optimizely
+  class BaseLogger
+    # Class encapsulating logging functionality. Override with your own logger providing log method.
+
+    def log(_level, _message)
+    end
+  end
+
+  class NoOpLogger < BaseLogger
+    # Class providing log method which logs nothing.
+
+    def log(_level, _message)
+    end
+  end
+
+  class SimpleLogger < BaseLogger
+    # Simple wrapper around Logger.
+
+    def initialize(min_level = Logger::INFO)
+      @logger = Logger.new(STDOUT)
+      @logger.level = min_level
+    end
+
+    def log(level, message)
+      @logger.add(level, message)
+    end
+  end
+end

data/lib/optimizely/params.rb

@@ -0,0 +1,14 @@
+module Optimizely
+  class Params
+    ACCOUNT_ID = 'd'
+    PROJECT_ID = 'a'
+    EXPERIMENT_PREFIX = 'x'
+    GOAL_ID = 'g'
+    GOAL_NAME = 'n'
+    SEGMENT_PREFIX = 's'
+    END_USER_ID = 'u'
+    EVENT_VALUE = 'v'
+    SOURCE = 'src'
+    TIME = 'time'
+  end
+end

data/lib/optimizely/project_config.rb

@@ -0,0 +1,255 @@
+require 'json'
+
+module Optimizely
+  class ProjectConfig
+    # Representation of the Optimizely project config.
+
+    PROJECT_CONFIG_LINK_TEMPLATE = 'https://cdn.optimizely.com/json/%{project_id}.json'
+    REVENUE_GOAL_KEY = 'Total Revenue'
+    REQUEST_TIMEOUT = 10
+    RUNNING_EXPERIMENT_STATUS = ['Running']
+
+    # Gets project config attributes.
+    attr_reader :error_handler
+    attr_accessor :logger
+
+    attr_reader :account_id
+    attr_reader :project_id
+    attr_reader :attributes
+    attr_reader :events
+    attr_reader :experiments
+    attr_reader :groups
+    attr_reader :revision
+    attr_reader :audiences
+
+    attr_reader :attribute_key_map
+    attr_reader :audience_id_map
+    attr_reader :event_key_map
+    attr_reader :experiment_id_map
+    attr_reader :experiment_key_map
+    attr_reader :group_key_map
+    attr_reader :audience_id_map
+    attr_reader :variation_id_map
+    attr_reader :variation_key_map
+
+    def initialize(datafile, logger, error_handler)
+      # ProjectConfig init method to fetch and set project config data
+      #
+      # datafile - JSON string representing the project
+
+      config = JSON.load(datafile)
+
+      @error_handler = error_handler
+      @logger = logger
+      @account_id = config['accountId']
+      @project_id = config['projectId']
+      @attributes = config['dimensions']
+      @events = config['events']
+      @experiments = config['experiments']
+      @revision = config['revision']
+      @audiences = config['audiences']
+      @groups = config.fetch('groups', [])
+
+      # Utility maps for quick lookup
+      @attribute_key_map = generate_key_map(@attributes, 'key')
+      @event_key_map = generate_key_map(@events, 'key')
+      @group_key_map = generate_key_map(@groups, 'id')
+      @group_key_map.each do |key, group|
+        exps = group.fetch('experiments')
+        exps.each do |exp|
+          @experiments.push(exp.merge('groupId' => key))
+        end
+      end
+      @experiment_key_map = generate_key_map(@experiments, 'key')
+      @experiment_id_map = generate_key_map(@experiments, 'id')
+      @audience_id_map = generate_key_map(@audiences, 'id')
+      @variation_id_map = {}
+      @variation_key_map = {}
+      @experiment_key_map.each do |key, exp|
+        variations = exp.fetch('variations')
+        @variation_id_map[key] = generate_key_map(variations, 'id')
+        @variation_key_map[key] = generate_key_map(variations, 'key')
+      end
+    end
+
+    def experiment_running?(experiment_key)
+      # Determine if experiment coresponding to given key is running
+      #
+      # experiment_key - String key representing the experiment
+      #
+      # Returns true if experiment is running
+      experiment = @experiment_key_map[experiment_key]
+      return RUNNING_EXPERIMENT_STATUS.include?(experiment['status']) if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_experiment_id(experiment_key)
+      # Retrieves experiment ID for a given key
+      #
+      # experiment_key - String key representing the experiment
+      #
+      # Returns String ID
+
+      experiment = @experiment_key_map[experiment_key]
+      return experiment['id'] if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_goal_keys
+      # Retrieves all goals in the project except 'Total Revenue'
+      #
+      # Returns array of all goal keys except 'Total Revenue'
+
+      goal_keys = @event_key_map.keys
+      goal_keys.delete(REVENUE_GOAL_KEY) if goal_keys.include?(REVENUE_GOAL_KEY)
+      goal_keys
+    end
+
+    def get_revenue_goal_id
+      # Get ID of the revenue goal for the project
+      #
+      # Returns revenue goal ID
+
+      revenue_goal = @event_key_map[REVENUE_GOAL_KEY]
+      return revenue_goal['id'] if revenue_goal
+      nil
+    end
+
+    def get_experiment_ids_for_goal(goal_key)
+      # Get experiment IDs for the provided goal key.
+      #
+      # goal_key - Goal key for which experiment IDs are to be retrieved.
+      #
+      # Returns array of all experiment IDs for the goal.
+
+      goal = @event_key_map[goal_key]
+      return goal['experimentIds'] if goal
+      @logger.log Logger::ERROR, "Event '#{goal_key}' is not in datafile."
+      @error_handler.handle_error InvalidGoalError
+      []
+    end
+
+    def get_traffic_allocation(experiment_key)
+      # Retrieves traffic allocation for a given experiment Key
+      #
+      # experiment_key - String Key representing the experiment
+      #
+      # Returns traffic allocation for the experiment or nil
+
+      experiment = @experiment_key_map[experiment_key]
+      return experiment['trafficAllocation'] if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_audience_ids_for_experiment(experiment_key)
+      # Get audience IDs for the experiment
+      #
+      # experiment_key - Experiment key for which audience IDs are to be determined
+      #
+      # Returns audience IDs corresponding to the experiment.
+
+      experiment = @experiment_key_map[experiment_key]
+      return experiment['audienceIds'] if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_audience_conditions_from_id(audience_id)
+      # Get audience conditions for the provided audience ID
+      #
+      # audience_id - ID of the audience
+      #
+      # Returns conditions for the audience
+
+      audience = @audience_id_map[audience_id]
+      return audience['conditions'] if audience
+      @logger.log Logger::ERROR, "Audience '#{audience_id}' is not in datafile."
+      @error_handler.handle_error InvalidAudienceError
+      nil
+    end
+
+    def get_variation_key_from_id(experiment_key, variation_id)
+      # Get variation key given experiment key and variation ID
+      #
+      # experiment_key - Key representing parent experiment of variation
+      # variation_id - ID of the variation
+      #
+      # Returns key of the variation
+
+      variation_id_map = @variation_id_map[experiment_key]
+      if variation_id_map
+        variation = variation_id_map[variation_id]
+        return variation['key'] if variation
+        @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
+        @error_handler.handle_error InvalidVariationError
+        return nil
+      end
+
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_variation_id_from_key(experiment_key, variation_key)
+      # Get variation ID given experiment key and variation key
+      #
+      # experiment_key - Key representing parent experiment of variation
+      # variation_key - Key of the variation
+      #
+      # Returns ID of the variation
+
+      variation_key_map = @variation_key_map[experiment_key]
+      if variation_key_map
+        variation = variation_key_map[variation_key]
+        return variation['id'] if variation
+        @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
+        @error_handler.handle_error InvalidVariationError
+        return nil
+      end
+
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+      nil
+    end
+
+    def get_forced_variations(experiment_key)
+      # Retrieves forced variations for a given experiment Key
+      #
+      # experiment_key - String Key representing the experiment
+      #
+      # Returns forced variations for the experiment or nil
+
+      experiment = @experiment_key_map[experiment_key]
+      return experiment['forcedVariations'] if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+    end
+
+    def get_experiment_group_id(experiment_key)
+      experiment = @experiment_key_map[experiment_key]
+      return experiment['groupId'] if experiment
+      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
+    end
+
+    private
+
+    def generate_key_map(array, key)
+      # Helper method to generate map from key to hash in array of hashes
+      #
+      # array - Array consisting of hash
+      # key - Key in each hash which will be key in the map
+      #
+      # Returns map mapping key to hash
+
+      Hash[array.map { |obj| [obj[key], obj] }]
+    end
+  end
+end

data/lib/optimizely/version.rb

@@ -0,0 +1,3 @@
+module Optimizely
+  VERSION = '0.0.12'
+end

data/lib/start.rb

@@ -0,0 +1,6 @@
+require "./optimizely.rb"
+require 'json'
+require 'httparty'
+# conf = '{"projectId": "53020", "events": [{"key": "Total Revenue", "id": "5641834680287232", "experimentIds": ["53033"]}], "experiments": [], "dimensions": [], "audiences": [], "revision": "5", "groups": [{"policy": "random", "id": "53025", "experiments": [{"variations": [{"key": "BLAH_1", "id": "53027"}, {"key": "BLAH_2", "id": "53028"}], "trafficAllocation": [{"endOfRange": 5000, "entityId": "53027"}, {"endOfRange": 10000, "entityId": "53028"}], "forcedVariations": {}, "audienceIds": [], "percentageIncluded": 3000, "status": "Running", "key": "exp_1", "id": "53026"}, {"variations": [{"key": "BLAH_1", "id": "53034"}, {"key": "BLAH_2", "id": "53035"}], "trafficAllocation": [{"endOfRange": 3000, "entityId": "53034"}, {"endOfRange": 10000, "entityId": "53035"}], "forcedVariations": {}, "audienceIds": [], "percentageIncluded": 4000, "status": "Running", "key": "exp_2", "id": "53033"}], "trafficAllocation": [{"endOfRange": 3000, "entityId": "53026"}, {"endOfRange": 7000, "entityId": "53033"}]}], "accountId": "23001", "version": "1"}'
+conf = HTTParty.get('https://cdn.optimizely.com/json/6377970066.json').body
+@optly = Optimizely::Project.new(conf, nil, Optimizely::SimpleLogger.new)

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: optimizely-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Andrew Delikat
+- Haley Bash
+- Optimizely
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.1
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: A Ruby SDK for Optimizely's server-side testing product. For more information,
+  please visit http://developers.optimizely.com/server.
+email:
+- server-side-testing@optimizely.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/optimizely.rb
+- lib/optimizely/audience.rb
+- lib/optimizely/bucketer.rb
+- lib/optimizely/condition.rb
+- lib/optimizely/error_handler.rb
+- lib/optimizely/event_builder.rb
+- lib/optimizely/event_dispatcher.rb
+- lib/optimizely/exceptions.rb
+- lib/optimizely/helpers/constants.rb
+- lib/optimizely/helpers/group.rb
+- lib/optimizely/helpers/validator.rb
+- lib/optimizely/logger.rb
+- lib/optimizely/params.rb
+- lib/optimizely/project_config.rb
+- lib/optimizely/version.rb
+- lib/start.rb
+homepage: http://developers.optimizely.com/server
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Optimizely's testing framework
+test_files: []