vwo-sdk 1.3.0 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/vwo.rb +610 -55
- data/lib/vwo/constants.rb +40 -12
- data/lib/vwo/core/bucketer.rb +7 -9
- data/lib/vwo/core/variation_decider.rb +68 -46
- data/lib/vwo/enums.rb +72 -9
- data/lib/vwo/logger.rb +9 -3
- data/lib/vwo/schemas/settings_file.rb +1 -3
- data/lib/vwo/services/event_dispatcher.rb +3 -5
- data/lib/vwo/services/operand_evaluator.rb +114 -0
- data/lib/vwo/services/segment_evaluator.rb +109 -0
- data/lib/vwo/services/settings_file_manager.rb +4 -6
- data/lib/vwo/services/settings_file_processor.rb +1 -3
- data/lib/vwo/user_storage.rb +1 -3
- data/lib/vwo/utils/campaign.rb +44 -22
- data/lib/vwo/utils/custom_dimensions.rb +49 -0
- data/lib/vwo/utils/feature.rb +56 -0
- data/lib/vwo/utils/function.rb +6 -3
- data/lib/vwo/utils/impression.rb +21 -3
- data/lib/vwo/utils/request.rb +1 -3
- data/lib/vwo/utils/segment.rb +116 -0
- data/lib/vwo/utils/uuid.rb +3 -5
- data/lib/vwo/utils/validations.rb +12 -4
- metadata +8 -4
@@ -0,0 +1,49 @@
|
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'json'
|
16
|
+
require_relative '../logger'
|
17
|
+
require_relative '../enums'
|
18
|
+
require_relative '../constants'
|
19
|
+
require_relative './impression'
|
20
|
+
|
21
|
+
# Utility module for helper math and random functions
|
22
|
+
class VWO
|
23
|
+
module Utils
|
24
|
+
module CustomDimensions
|
25
|
+
include VWO::CONSTANTS
|
26
|
+
include VWO::Enums
|
27
|
+
include VWO::Utils::Impression
|
28
|
+
|
29
|
+
def get_url_params(settings_file, tag_key, tag_value, user_id)
|
30
|
+
url = HTTPS_PROTOCOL + ENDPOINTS::BASE_URL + ENDPOINTS::PUSH
|
31
|
+
tag = { 'u' => {} }
|
32
|
+
tag['u'][tag_key] = tag_value
|
33
|
+
|
34
|
+
params = get_common_properties(user_id, settings_file)
|
35
|
+
params.merge!('url' => url, 'tags' => JSON.generate(tag))
|
36
|
+
|
37
|
+
VWO::Logger.get_instance.log(
|
38
|
+
LogLevelEnum::DEBUG,
|
39
|
+
format(
|
40
|
+
LogMessageEnum::DebugMessages::PARAMS_FOR_PUSH_CALL,
|
41
|
+
file: FileNameEnum::CustomDimensionsUtil,
|
42
|
+
properties: JSON.generate(params)
|
43
|
+
)
|
44
|
+
)
|
45
|
+
params
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require_relative '../logger'
|
16
|
+
require_relative '../enums'
|
17
|
+
require_relative '../constants'
|
18
|
+
|
19
|
+
# Utility module for helper math and random functions
|
20
|
+
class VWO
|
21
|
+
module Utils
|
22
|
+
module Feature
|
23
|
+
include VWO::CONSTANTS
|
24
|
+
include VWO::Enums
|
25
|
+
|
26
|
+
# Returns type casted value to given value type if possible.
|
27
|
+
# @param[Number|String|Boolean] :value Value to type cast
|
28
|
+
# @param[Type] :variable_type Type to which value needs to be casted
|
29
|
+
# @return[any] Type casted value if value can be type-casted
|
30
|
+
def get_type_casted_feature_value(value, variable_type)
|
31
|
+
# Check if type(value) is already equal to required variable_type
|
32
|
+
return value if RUBY_VARIABLE_TYPES[variable_type].include?(value.class)
|
33
|
+
|
34
|
+
return value.to_s if variable_type == VariableTypes::STRING
|
35
|
+
|
36
|
+
return value.to_i if variable_type == VariableTypes::INTEGER
|
37
|
+
|
38
|
+
return value.to_f if variable_type == VariableTypes::DOUBLE
|
39
|
+
|
40
|
+
return !value || value == 0 ? false : true if variable_type == VariableTypes.BOOLEAN
|
41
|
+
rescue StandardError => _e
|
42
|
+
VWO::Logger.get_instance.log(
|
43
|
+
LogLevelEnum::ERROR,
|
44
|
+
format(
|
45
|
+
LogMessageEnum::ErrorMessages::UNABLE_TO_TYPE_CAST,
|
46
|
+
file: FileNameEnum::FeatureUtil,
|
47
|
+
value: value,
|
48
|
+
variable_type: variable_type,
|
49
|
+
of_type: value.class.name
|
50
|
+
)
|
51
|
+
)
|
52
|
+
nil
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
data/lib/vwo/utils/function.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright 2019 Wingify Software Pvt. Ltd.
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -12,8 +12,6 @@
|
|
12
12
|
# See the License for the specific language governing permissions and
|
13
13
|
# limitations under the License.
|
14
14
|
|
15
|
-
# frozen_string_literal: true
|
16
|
-
|
17
15
|
require_relative '../logger'
|
18
16
|
require_relative '../enums'
|
19
17
|
require_relative '../constants'
|
@@ -34,6 +32,11 @@ class VWO
|
|
34
32
|
def get_current_unix_timestamp
|
35
33
|
Time.now.to_i
|
36
34
|
end
|
35
|
+
|
36
|
+
# @return[any, any]
|
37
|
+
def get_key_value(obj)
|
38
|
+
[obj.keys[0], obj.values[0]]
|
39
|
+
end
|
37
40
|
end
|
38
41
|
end
|
39
42
|
end
|
data/lib/vwo/utils/impression.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright 2019 Wingify Software Pvt. Ltd.
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -12,8 +12,6 @@
|
|
12
12
|
# See the License for the specific language governing permissions and
|
13
13
|
# limitations under the License.
|
14
14
|
|
15
|
-
# frozen_string_literal: true
|
16
|
-
|
17
15
|
require 'json'
|
18
16
|
require 'cgi'
|
19
17
|
require_relative '../logger'
|
@@ -93,6 +91,26 @@ class VWO
|
|
93
91
|
end
|
94
92
|
impression
|
95
93
|
end
|
94
|
+
|
95
|
+
# Returns commonly used params for making requests to our servers.
|
96
|
+
#
|
97
|
+
# @param[String] :user_id Unique identification of user
|
98
|
+
# @param[String] :settings_file Settings file containing campaign data for extracting account_id
|
99
|
+
# @return[Hash] Commonly used params for making call to our servers
|
100
|
+
#
|
101
|
+
def get_common_properties(user_id, settings_file)
|
102
|
+
account_id = settings_file['accountId']
|
103
|
+
{
|
104
|
+
'random' => get_random_number,
|
105
|
+
'sdk' => SDK_NAME,
|
106
|
+
'sdk-v' => SDK_VERSION,
|
107
|
+
'ap' => PLATFORM,
|
108
|
+
'sId' => get_current_unix_timestamp,
|
109
|
+
'u' => generator_for(user_id, account_id),
|
110
|
+
'account_id' => account_id,
|
111
|
+
'uId' => CGI.escape(user_id.encode('utf-8'))
|
112
|
+
}
|
113
|
+
end
|
96
114
|
end
|
97
115
|
end
|
98
116
|
end
|
data/lib/vwo/utils/request.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright 2019 Wingify Software Pvt. Ltd.
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -12,8 +12,6 @@
|
|
12
12
|
# See the License for the specific language governing permissions and
|
13
13
|
# limitations under the License.
|
14
14
|
|
15
|
-
# frozen_string_literal: true
|
16
|
-
|
17
15
|
require 'net/http'
|
18
16
|
|
19
17
|
class VWO
|
@@ -0,0 +1,116 @@
|
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require_relative '../enums'
|
16
|
+
|
17
|
+
# Utility module for helper math and random functions
|
18
|
+
class VWO
|
19
|
+
module Utils
|
20
|
+
module Segment
|
21
|
+
GROUPING_PATTERN = /^(.+?)\((.*)\)/
|
22
|
+
WILDCARD_PATTERN = /(^\*|^)(.+?)(\*$|$)/
|
23
|
+
include VWO::Enums
|
24
|
+
|
25
|
+
# Extracts true values represented in the args, and returns stringified value of it
|
26
|
+
#
|
27
|
+
# @param [String] :operator_value operand/dsl leaf value
|
28
|
+
# @param [String|Number] :custom_variables_value custom_variables value
|
29
|
+
# @return [[String, String]] tuple of str value of operator_value, custom_variables_value converted
|
30
|
+
# into their true types
|
31
|
+
def convert_to_true_types(operator_value, custom_variables_value)
|
32
|
+
# This is atomic, either both values will be processed or none
|
33
|
+
begin
|
34
|
+
true_type_operator_value = Kernel::Float(operator_value)
|
35
|
+
true_type_custom_variables_value = Kernel::Float(custom_variables_value)
|
36
|
+
rescue StandardError => _e
|
37
|
+
return operator_value, custom_variables_value
|
38
|
+
end
|
39
|
+
# Now both are float, So, convert them independently to int type if they are int rather than floats
|
40
|
+
true_type_operator_value = true_type_operator_value.to_i if true_type_operator_value == true_type_operator_value.floor
|
41
|
+
|
42
|
+
true_type_custom_variables_value = true_type_custom_variables_value.to_i if true_type_custom_variables_value == true_type_custom_variables_value.floor
|
43
|
+
|
44
|
+
# Convert them back to string and return
|
45
|
+
[true_type_operator_value.to_s, true_type_custom_variables_value.to_s]
|
46
|
+
end
|
47
|
+
|
48
|
+
# Extract the operand_type, ie. lower, wildcard, regex or equals
|
49
|
+
#
|
50
|
+
# @param[String] :operand string value from leaf_node of dsl
|
51
|
+
# @return [[String, String]] tuple of operand value and operand type
|
52
|
+
#
|
53
|
+
def separate_operand(operand)
|
54
|
+
groups = GROUPING_PATTERN.match(operand)
|
55
|
+
return groups[1..2] if groups
|
56
|
+
|
57
|
+
[OperandValueTypesName::EQUALS, operand]
|
58
|
+
end
|
59
|
+
|
60
|
+
# Processes the value from the custom_variables_variables
|
61
|
+
# @param[String|Number|Boolean|nil] :custom_variables_value the custom_variables_value provided inside custom_variables
|
62
|
+
#
|
63
|
+
# @return [String] stringified value of processed custom_variables_value
|
64
|
+
#
|
65
|
+
def process_custom_variables_value(custom_variables_value)
|
66
|
+
return '' if custom_variables_value.nil?
|
67
|
+
|
68
|
+
if custom_variables_value.is_a?(TrueClass) || custom_variables_value.is_a?(FalseClass)
|
69
|
+
custom_variables_value = custom_variables_value ? OperandValuesBooleanTypes::TRUE : OperandValuesBooleanTypes::FALSE
|
70
|
+
end
|
71
|
+
custom_variables_value.to_s
|
72
|
+
end
|
73
|
+
|
74
|
+
# Extracts operand_type and operand_value from the leaf_node/operand
|
75
|
+
# @param[String] :operand String value from the leaf_node
|
76
|
+
# @return[[String, String]] Tuple of defined operand_types and operand_value
|
77
|
+
#
|
78
|
+
def process_operand_value(operand)
|
79
|
+
# Separate the operand type and value inside the bracket
|
80
|
+
|
81
|
+
operand_type_name, operand_value = separate_operand(operand)
|
82
|
+
|
83
|
+
# Enum the operand type, here lower, regex, and equals will be identified
|
84
|
+
operand_type =
|
85
|
+
begin
|
86
|
+
VWO::Enums::OperandValueTypesName.const_get(operand_type_name.upcase)
|
87
|
+
rescue StandardError => _e
|
88
|
+
nil
|
89
|
+
end
|
90
|
+
|
91
|
+
# In case of wildcard, the operand type is further divided into contains, startswith and endswith
|
92
|
+
if operand_type_name == OperandValueTypesName::WILDCARD
|
93
|
+
starting_star, operand_value, ending_star = WILDCARD_PATTERN.match(operand_value)[1..3]
|
94
|
+
operand_type =
|
95
|
+
if starting_star.to_s.length > 0 && ending_star.to_s.length > 0
|
96
|
+
OperandValueTypes::CONTAINS
|
97
|
+
elsif starting_star.to_s.length > 0
|
98
|
+
OperandValueTypes::STARTS_WITH
|
99
|
+
elsif ending_star.to_s.length > 0
|
100
|
+
OperandValueTypes::ENDS_WITH
|
101
|
+
else
|
102
|
+
OperandValueTypes::EQUALS
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
# In case there is an abnormal patter, it would have passed all the above if cases, which means it
|
107
|
+
# should be equals, so set the whole operand as operand value and operand type as equals
|
108
|
+
if operand_type.nil?
|
109
|
+
operand_type = OperandValueTypes::EQUALS
|
110
|
+
operand_value = operand
|
111
|
+
end
|
112
|
+
[operand_type, operand_value]
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
data/lib/vwo/utils/uuid.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright 2019 Wingify Software Pvt. Ltd.
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -12,8 +12,6 @@
|
|
12
12
|
# See the License for the specific language governing permissions and
|
13
13
|
# limitations under the License.
|
14
14
|
|
15
|
-
# frozen_string_literal: true
|
16
|
-
|
17
15
|
require 'digest'
|
18
16
|
require_relative '../logger'
|
19
17
|
require_relative '../enums'
|
@@ -44,9 +42,9 @@ class VWO
|
|
44
42
|
ary = hash.digest.unpack('NnnnnN')
|
45
43
|
ary[2] = (ary[2] & 0x0FFF) | (version << 12)
|
46
44
|
ary[3] = (ary[3] & 0x3FFF) | 0x8000
|
47
|
-
# rubocop:disable Lint/FormatString
|
45
|
+
# rubocop:disable Lint/FormatStringToken,Style/FormatString
|
48
46
|
'%08x-%04x-%04x-%04x-%04x%08x' % ary
|
49
|
-
# rubocop:enable Lint/FormatString
|
47
|
+
# rubocop:enable Lint/FormatStringToken,Style/FormatString
|
50
48
|
end
|
51
49
|
|
52
50
|
VWO_NAMESPACE = uuid_v5(URL_NAMESPACE, 'https://vwo.com')
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright 2019 Wingify Software Pvt. Ltd.
|
1
|
+
# Copyright 2019-2020 Wingify Software Pvt. Ltd.
|
2
2
|
#
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
4
|
# you may not use this file except in compliance with the License.
|
@@ -12,8 +12,6 @@
|
|
12
12
|
# See the License for the specific language governing permissions and
|
13
13
|
# limitations under the License.
|
14
14
|
|
15
|
-
# frozen_string_literal: true
|
16
|
-
|
17
15
|
require 'json'
|
18
16
|
require 'json-schema'
|
19
17
|
require_relative '../schemas/settings_file'
|
@@ -34,7 +32,7 @@ class VWO
|
|
34
32
|
|
35
33
|
# @return [Boolean]
|
36
34
|
def valid_value?(val)
|
37
|
-
!val.nil?
|
35
|
+
!val.nil? && val != {} && val != []
|
38
36
|
end
|
39
37
|
|
40
38
|
# @return [Boolean]
|
@@ -51,6 +49,16 @@ class VWO
|
|
51
49
|
def valid_hash?(val)
|
52
50
|
val.is_a?(Hash)
|
53
51
|
end
|
52
|
+
|
53
|
+
# @return [Boolean]
|
54
|
+
def valid_boolean?(val)
|
55
|
+
val.is_a?(TrueClass) || val.is_a?(FalseClass)
|
56
|
+
end
|
57
|
+
|
58
|
+
# @return [Boolean]
|
59
|
+
def valid_basic_data_type?(val)
|
60
|
+
valid_number?(val) || valid_string?(val) || valid_boolean?(val)
|
61
|
+
end
|
54
62
|
end
|
55
63
|
end
|
56
64
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: vwo-sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- VWO
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-02-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: coveralls
|
@@ -81,13 +81,18 @@ files:
|
|
81
81
|
- lib/vwo/logger.rb
|
82
82
|
- lib/vwo/schemas/settings_file.rb
|
83
83
|
- lib/vwo/services/event_dispatcher.rb
|
84
|
+
- lib/vwo/services/operand_evaluator.rb
|
85
|
+
- lib/vwo/services/segment_evaluator.rb
|
84
86
|
- lib/vwo/services/settings_file_manager.rb
|
85
87
|
- lib/vwo/services/settings_file_processor.rb
|
86
88
|
- lib/vwo/user_storage.rb
|
87
89
|
- lib/vwo/utils/campaign.rb
|
90
|
+
- lib/vwo/utils/custom_dimensions.rb
|
91
|
+
- lib/vwo/utils/feature.rb
|
88
92
|
- lib/vwo/utils/function.rb
|
89
93
|
- lib/vwo/utils/impression.rb
|
90
94
|
- lib/vwo/utils/request.rb
|
95
|
+
- lib/vwo/utils/segment.rb
|
91
96
|
- lib/vwo/utils/uuid.rb
|
92
97
|
- lib/vwo/utils/validations.rb
|
93
98
|
homepage: https://vwo.com/fullstack/server-side-testing/
|
@@ -109,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
109
114
|
- !ruby/object:Gem::Version
|
110
115
|
version: '0'
|
111
116
|
requirements: []
|
112
|
-
|
113
|
-
rubygems_version: 2.5.2.3
|
117
|
+
rubygems_version: 3.0.6
|
114
118
|
signing_key:
|
115
119
|
specification_version: 4
|
116
120
|
summary: Ruby SDK for VWO full-stack testing
|