vwo-sdk 1.3.0

data/lib/vwo/utils/function.rb

@@ -0,0 +1,39 @@
+# 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 helper math and random functions
+class VWO
+  module Utils
+    module Function
+      include VWO::Enums
+      include VWO::CONSTANTS
+
+      # @return[Float]
+      def get_random_number
+        rand
+      end
+
+      # @return[Integer]
+      def get_current_unix_timestamp
+        Time.now.to_i
+      end
+    end
+  end
+end

data/lib/vwo/utils/impression.rb

@@ -0,0 +1,98 @@
+# 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'
+require 'cgi'
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../constants'
+require_relative 'function'
+require_relative 'uuid'
+
+# Creates the impression from the arguments passed
+class VWO
+  module Utils
+    module Impression
+      include VWO::Enums
+      include VWO::CONSTANTS
+      include VWO::Utils::Function
+      include UUID
+
+      # Creates the impression from the arguments passed
+      #
+      # @param[Hash]                        :settings_file           Settings file object
+      # @param[String]                      :campaign_id            Campaign identifier
+      # @param[String]                      :variation_id           Variation identifier
+      # @param[String]                      :user_id                User identifier
+      # @param[String]                      :goal_id                Goal identifier, if building track impression
+      # @param[String|Float|Integer|nil)    :revenue                Number value, in any representation, if building track impression
+      #
+      # @return[nil|Hash]                                           None if campaign ID or variation ID is invalid,
+      #                                                             Else Properties(dict)
+      def create_impression(settings_file, campaign_id, variation_id, user_id, goal_id = nil, revenue = nil)
+        return unless valid_number?(campaign_id) && valid_string?(user_id)
+
+        is_track_user_api = true
+        is_track_user_api = false unless goal_id.nil?
+        account_id = settings_file['accountId']
+
+        impression = {
+          account_id: account_id,
+          experiment_id: campaign_id,
+          ap: PLATFORM,
+          uId: CGI.escape(user_id.encode('utf-8')),
+          combination: variation_id,
+          random: get_random_number,
+          sId: get_current_unix_timestamp,
+          u: generator_for(user_id, account_id)
+        }
+        # Version and SDK constants
+        sdk_version = Gem.loaded_specs['vwo_sdk'] ? Gem.loaded_specs['vwo_sdk'].version : VWO::SDK_VERSION
+        impression['sdk'] = 'ruby'
+        impression['sdk-v'] = sdk_version
+
+        url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL
+        logger = VWO::Logger.get_instance
+
+        if is_track_user_api
+          impression['ed'] = JSON.generate(p: 'server')
+          impression['url'] = "#{url}#{ENDPOINTS::TRACK_USER}"
+          logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_USER,
+              file: FileNameEnum::ImpressionUtil,
+              properties: JSON.generate(impression)
+            )
+          )
+        else
+          impression['url'] = url + ENDPOINTS::TRACK_GOAL
+          impression['goal_id'] = goal_id
+          impression['r'] = revenue if revenue
+          logger.log(
+            LogLevelEnum::DEBUG,
+            format(
+              LogMessageEnum::DebugMessages::IMPRESSION_FOR_TRACK_GOAL,
+              file: FileNameEnum::ImpressionUtil,
+              properties: JSON.generate(impression)
+            )
+          )
+        end
+        impression
+      end
+    end
+  end
+end

data/lib/vwo/utils/request.rb

@@ -0,0 +1,31 @@
+# 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 'net/http'
+
+class VWO
+  module Utils
+    class Request
+      def self.get(url, params)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        uri.query = URI.encode_www_form(params)
+        Net::HTTP.get_response(uri)
+      end
+    end
+  end
+end

data/lib/vwo/utils/uuid.rb

@@ -0,0 +1,93 @@
+# 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 'digest'
+require_relative '../logger'
+require_relative '../enums'
+require_relative '../constants'
+
+# Utility module for generating uuid
+class VWO
+  module Utils
+    module UUID
+      include VWO::Enums
+      include VWO::CONSTANTS
+
+      def self.parse(obj)
+        str = obj.to_s.sub(/\Aurn:uuid:/, '')
+        str.gsub!(/[^0-9A-Fa-f]/, '')
+        [str[0..31]].pack 'H*'
+      end
+
+      def self.uuid_v5(uuid_namespace, name)
+        uuid_namespace = parse(uuid_namespace)
+        hash_class = ::Digest::SHA1
+        version = 5
+
+        hash = hash_class.new
+        hash.update(uuid_namespace)
+        hash.update(name)
+
+        ary = hash.digest.unpack('NnnnnN')
+        ary[2] = (ary[2] & 0x0FFF) | (version << 12)
+        ary[3] = (ary[3] & 0x3FFF) | 0x8000
+        # rubocop:disable Lint/FormatString
+        '%08x-%04x-%04x-%04x-%04x%08x' % ary
+        # rubocop:enable Lint/FormatString
+      end
+
+      VWO_NAMESPACE = uuid_v5(URL_NAMESPACE, 'https://vwo.com')
+
+      # Generates desired UUID
+      #
+      # @param[Integer|String]      :user_id        User identifier
+      # @param[Integer|String]      :account_id     Account identifier
+      #
+      # @return[Integer]                            Desired UUID
+      #
+      def generator_for(user_id, account_id)
+        user_id = user_id.to_s
+        account_id = account_id.to_s
+        user_id_namespace = generate(VWO_NAMESPACE, account_id)
+        uuid_for_account_user_id = generate(user_id_namespace, user_id)
+
+        desired_uuid = uuid_for_account_user_id.delete('-').upcase
+
+        VWO::Logger.get_instance.log(
+          LogLevelEnum::DEBUG,
+          format(
+            LogMessageEnum::DebugMessages::UUID_FOR_USER,
+            file: FileNameEnum::UuidUtil,
+            user_id: user_id,
+            account_id: account_id,
+            desired_uuid: desired_uuid
+          )
+        )
+        desired_uuid
+      end
+
+      # Generated uuid from namespace and name, uses uuid5
+      #
+      # @param[String]        :namespace    Namespace
+      # @param[String)        :name         Name
+      #
+      # @return[String|nil]                UUID, nil if any of the arguments is empty
+      def generate(namespace, name)
+        VWO::Utils::UUID.uuid_v5(namespace, name) if name && namespace
+      end
+    end
+  end
+end

data/lib/vwo/utils/validations.rb

@@ -0,0 +1,56 @@
+# 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'
+require 'json-schema'
+require_relative '../schemas/settings_file'
+
+class VWO
+  module Utils
+    module Validations
+      # Validates the settings_file
+      # @param [Hash]:  JSON object received from VWO server
+      #                 must be JSON.
+      # @return [Boolean]
+      def valid_settings_file?(settings_file)
+        settings_file = JSON.parse(settings_file)
+        JSON::Validator.validate!(VWO::Schema::SETTINGS_FILE_SCHEMA, settings_file)
+      rescue StandardError
+        false
+      end
+
+      # @return [Boolean]
+      def valid_value?(val)
+        !val.nil?
+      end
+
+      # @return [Boolean]
+      def valid_number?(val)
+        val.is_a?(Numeric)
+      end
+
+      # @return [Boolean]
+      def valid_string?(val)
+        val.is_a?(String)
+      end
+
+      # @return [Boolean]
+      def valid_hash?(val)
+        val.is_a?(Hash)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: vwo-sdk
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- VWO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A Ruby SDK for VWO full-stack testing.
+email:
+- dev@wingify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vwo.rb
+- lib/vwo/constants.rb
+- lib/vwo/core/bucketer.rb
+- lib/vwo/core/variation_decider.rb
+- lib/vwo/enums.rb
+- lib/vwo/logger.rb
+- lib/vwo/schemas/settings_file.rb
+- lib/vwo/services/event_dispatcher.rb
+- lib/vwo/services/settings_file_manager.rb
+- lib/vwo/services/settings_file_processor.rb
+- lib/vwo/user_storage.rb
+- lib/vwo/utils/campaign.rb
+- lib/vwo/utils/function.rb
+- lib/vwo/utils/impression.rb
+- lib/vwo/utils/request.rb
+- lib/vwo/utils/uuid.rb
+- lib/vwo/utils/validations.rb
+homepage: https://vwo.com/fullstack/server-side-testing/
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for VWO full-stack testing
+test_files: []