vwo-sdk 1.3.0

data/lib/vwo/schemas/settings_file.rb

@@ -0,0 +1,102 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+require 'json'
+
+class VWO
+  # Schema for verifying the settings_file provided by the customer
+  module Schema
+    SETTINGS_FILE_SCHEMA = {
+      type: 'object',
+      properties: {
+        version: {
+          type: %w[number string]
+        },
+        accountId: {
+          type: %w[number string]
+        },
+        campaigns: {
+          if: {
+            type: 'array'
+          },
+          then: {
+            minItems: 1,
+            items: {
+              '$ref' => '#/definitions/campaign_object_schema'
+            }
+          },
+          else: {
+            type: 'object',
+            maxProperties: 0
+          }
+        }
+      },
+      definitions: {
+        campaign_variation_schema: {
+          type: 'object',
+          properties: {
+            id: {
+              type: %w[number string]
+            },
+            name: {
+              type: ['string']
+            },
+            weight: {
+              type: %w[number string]
+            }
+          },
+          required: %w[id name weight]
+        },
+        campaign_object_schema: {
+          type: 'object',
+          properties: {
+            id: {
+              type: %w[number string]
+            },
+            key: {
+              type: ['string']
+            },
+            status: {
+              type: ['string']
+            },
+            percentTraffic: {
+              type: ['number']
+            },
+            variations: {
+              type: 'array',
+              items: {
+                '$ref' => '#/definitions/campaign_variation_schema'
+              }
+            },
+            minItems: 2
+          }
+        },
+        required: %w[
+          id
+          key
+          status
+          percentTraffic
+          variations
+        ]
+      },
+      required: %w[
+        version
+        accountId
+        campaigns
+      ]
+    }.freeze
+  end
+end

data/lib/vwo/services/event_dispatcher.rb

@@ -0,0 +1,82 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../utils/request'
+
+class VWO
+  module Services
+    class EventDispatcher
+      include VWO::Enums
+
+      EXCLUDE_KEYS = ['url'].freeze
+
+      # Initialize the dispatcher with logger and development mode
+      #
+      # @param [Boolean] :  To specify whether the request
+      #                     to our server should be made or not.
+      #
+      def initialize(is_development_mode = false)
+        @logger = VWO::Logger.get_instance
+        @is_development_mode = is_development_mode
+      end
+
+      # Dispatch the impression event having properties object only if dev-mode is OFF
+      #
+      # @param[Hash]        :properties       hash having impression properties
+      #                                       the request to be dispatched to the VWO server
+      # @return[Boolean]
+      #
+      def dispatch(impression)
+        return true if @is_development_mode
+
+        modified_event = impression.reject do |key, _value|
+          EXCLUDE_KEYS.include?(key)
+        end
+
+        resp = VWO::Utils::Request.get(impression['url'], modified_event)
+        if resp.code == '200'
+          @logger.log(
+            LogLevelEnum::INFO,
+            format(
+              LogMessageEnum::InfoMessages::IMPRESSION_SUCCESS,
+              file: FileNameEnum::EventDispatcher,
+              end_point: impression[:url],
+              campaign_id: impression[:experiment_id],
+              user_id: impression[:uId],
+              account_id: impression[:account_id],
+              variation_id: impression[:combination]
+            )
+          )
+          return true
+        else
+          @logger.log(
+            LogLevelEnum::ERROR,
+            format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: impression['url'])
+          )
+          return false
+        end
+      rescue StandardError
+        @logger.log(
+          LogLevelEnum::ERROR,
+          format(LogMessageEnum::ErrorMessages::IMPRESSION_FAILED, file: FileNameEnum::EventDispatcher, end_point: impression['url'])
+        )
+        false
+      end
+    end
+  end
+end

data/lib/vwo/services/settings_file_manager.rb

@@ -0,0 +1,84 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+require_relative '../utils/function'
+require_relative '../utils/request'
+require_relative '../utils/validations'
+require_relative '../constants'
+
+class VWO
+  module Services
+    class SettingsFileManager
+      include ::VWO::Utils::Validations
+      include ::VWO::Utils::Function
+
+      PROTOCOL = 'https'
+      HOSTNAME = ::VWO::CONSTANTS::ENDPOINTS::BASE_URL
+      PATH = ::VWO::CONSTANTS::ENDPOINTS::ACCOUNT_SETTINGS
+
+      def initialize(account_id, sdk_key)
+        @account_id = account_id
+        @sdk_key = sdk_key
+      end
+
+      # Get Settings file method to retrieve settings_file for customer from VWO server
+      # @param [string]:      Account ID of user
+      # @param [string]:      Unique sdk key for user,
+      #                       can be retrieved from VWO app
+      # @return[string]:      JSON - settings_file,
+      #                       as received from the server,
+      #                       nil if no settings_file is found or sdk_key is incorrect
+
+      def get_settings_file
+        is_valid_key = valid_number?(@account_id) || valid_string?(@account_id)
+
+        unless is_valid_key && valid_string?(@sdk_key)
+          STDERR.puts 'account_id and sdk_key are required for fetching account settings. Aborting!'
+          return '{}'
+        end
+
+        vwo_server_url = "#{PROTOCOL}://#{HOSTNAME}#{PATH}"
+
+        settings_file_response = ::VWO::Utils::Request.get(vwo_server_url, params)
+
+        if settings_file_response.code != '200'
+          message = <<-DOC
+            Request failed for fetching account settings.
+            Got Status Code: #{settings_file_response.code}
+            and message: #{settings_file_response.body}.
+          DOC
+          STDERR.puts message
+          return
+        end
+        settings_file_response.body
+      rescue StandardError => e
+        STDERR.puts "Error fetching Settings File #{e}"
+      end
+
+      private
+
+      def params
+        {
+          a: @account_id,
+          i: @sdk_key,
+          r: get_random_number,
+          platform: 'server',
+          'api-version' => 1
+        }
+      end
+    end
+  end
+end

data/lib/vwo/services/settings_file_processor.rb

@@ -0,0 +1,54 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../utils/campaign'
+
+class VWO
+  module Services
+    class SettingsFileProcessor
+      include VWO::Enums
+      include VWO::Utils::Campaign
+
+      # Method to initialize settings_file and logger
+      #
+      # @params
+      #  settings_file (Hash): Hash object of setting
+      #  representing the settings_file.
+
+      def initialize(settings_file)
+        @settings_file = JSON.parse(settings_file)
+        @logger = VWO::Logger.get_instance
+      end
+
+      # Processes the settings_file, assigns variation allocation range
+      def process_settings_file
+        (@settings_file['campaigns'] || []).each do |campaign|
+          set_variation_allocation(campaign)
+        end
+        @logger.log(
+          LogLevelEnum::DEBUG,
+          format(LogMessageEnum::DebugMessages::SETTINGS_FILE_PROCESSED, file: FileNameEnum::SettingsFileProcessor)
+        )
+      end
+
+      def get_settings_file
+        @settings_file
+      end
+    end
+  end
+end

data/lib/vwo/user_storage.rb

@@ -0,0 +1,36 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+class VWO
+  # UserStorage Class is used to store user-variation mapping.
+  # Override this class to implement your own functionality.
+  # SDK will ensure to use this while bucketing a user into a variation.
+
+  class UserStorage
+    # To retrieve the stored variation for the user_id.
+    #
+    # @param[String]        :user_id            ID for user that needs to be retrieved.
+    # @param[String]        :_campaign_key      Unique campaign key
+    # @return[Hash]         :user_data          User's data.
+    #
+    def get(_user_id, _campaign_key); end
+
+    # To store the the user variation-mapping
+    # @param[Hash]    :user_data
+    #
+    def set(_user_data); end
+  end
+end

data/lib/vwo/utils/campaign.rb

@@ -0,0 +1,125 @@
+# Copyright 2019 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# frozen_string_literal: true
+
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../constants'
+
+# Utility module for processing VWO campaigns
+class VWO
+  module Utils
+    module Campaign
+      include VWO::Enums
+      include VWO::CONSTANTS
+
+      # Finds and Returns campaign from given campaign_key.
+      #
+      # @param[Hash]      :settings_file      Settings file
+      # @param[String]    :campaign_key      Campaign identifier key
+      # @return[Hash]     :campaign object
+
+      def get_campaign(settings_file, campaign_key)
+        (settings_file['campaigns'] || []).find do |campaign|
+          campaign['key'] == campaign_key
+        end
+      end
+
+      # Sets variation allocation range in the provided campaign
+      #
+      # @param [Hash]: Campaign object
+
+      def set_variation_allocation(campaign)
+        current_allocation = 0
+        campaign['variations'].each do |variation|
+          step_factor = get_variation_bucketing_range(variation['weight'])
+          if step_factor > 0
+            start_range = current_allocation + 1
+            end_range = current_allocation + step_factor
+            variation['start_variation_allocation'] = start_range
+            variation['end_variation_allocation'] = end_range
+            current_allocation += step_factor
+          else
+            variation['start_variation_allocation'] = -1
+            variation['end_variation_allocation'] = -1
+          end
+
+          VWO::Logger.get_instance.log(
+            LogLevelEnum::INFO,
+            format(
+              LogMessageEnum::InfoMessages::VARIATION_RANGE_ALLOCATION,
+              file: FileNameEnum::CampaignUtil,
+              campaign_key: campaign['key'],
+              variation_name: variation['name'],
+              variation_weight: variation['weight'],
+              start: variation['start_variation_allocation'],
+              end: variation['end_variation_allocation']
+            )
+          )
+        end
+      end
+
+      # Returns goal from given campaign_key and gaol_identifier.
+      # @param[Hash]              :settings_file        Settings file
+      # @param[String]            :campaign_key        Campaign identifier key
+      # @param[String]            :goal_identifier      Goal identifier
+      #
+      # @return[Hash]                                  Goal corresponding to Goal_identifier in respective campaign
+
+      def get_campaign_goal(settings_file, campaign_key, goal_identifier)
+        return unless settings_file && campaign_key && goal_identifier
+
+        campaign = get_campaign(settings_file, campaign_key)
+        return unless campaign
+
+        campaign['goals'].find do |goal|
+          goal['identifier'] == goal_identifier
+        end
+      end
+
+      private
+
+      # Returns the bucket size of variation.
+      # @param (Number): weight of variation
+      # @return (Integer): Bucket start range of Variation
+
+      def get_variation_bucketing_range(weight)
+        return 0 if weight.nil? || weight == 0
+
+        start_range = (weight * 100).ceil.to_i
+        [start_range, MAX_TRAFFIC_VALUE].min
+      end
+
+      # Returns variation from given campaign_key and variation_name.
+      #
+      # @param[Hash]            :settings_file  Settings file
+      # @param[Hash]            :campaign_key Campaign identifier key
+      # @param[String]          :variation_name Variation identifier
+      #
+      # @return[Hash]           Variation corresponding to variation_name in respective campaign
+
+      def get_campaign_variation(settings_file, campaign_key, variation_name)
+        return unless settings_file && campaign_key && variation_name
+
+        campaign = get_campaign(settings_file, campaign_key)
+        return unless campaign
+
+        campaign['variations'].find do |variation|
+          variation['name'] == variation_name
+        end
+      end
+    end
+  end
+end