featureflow 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rubocop.yml +5 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +53 -0
- data/LICENSE +201 -0
- data/README.md +2 -0
- data/Rakefile +6 -0
- data/featureflow.gemspec +38 -0
- data/lib/featureflow/client.rb +72 -0
- data/lib/featureflow/conditions.rb +36 -0
- data/lib/featureflow/context_builder.rb +34 -0
- data/lib/featureflow/evaluate.rb +49 -0
- data/lib/featureflow/evaluate_helpers.rb +36 -0
- data/lib/featureflow/events_client.rb +52 -0
- data/lib/featureflow/feature.rb +24 -0
- data/lib/featureflow/polling_client.rb +42 -0
- data/lib/featureflow/version.rb +3 -0
- data/lib/featureflow.rb +16 -0
- data/test.rb +18 -0
- metadata +132 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 588ff1000fc28617bc73e96020339f8d311a8bef
|
4
|
+
data.tar.gz: e54f4bfbe4cc09c55ca14d2e18344227c266a6fb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: db8eb2eb8031279d65daede41d0fe760f533bd69f5a0f4cee6febd9cf927ebedfdbdc392b6026463407ce9a92d49995ed0d5c6ba014d3734d84bfccaac5eefa3
|
7
|
+
data.tar.gz: e1f5fcd4cc2e8d062cd8d302200d10be587b173375309a0c49592ca5f303a96a9209365dbd296d604692a1ef2140f2cb48672e7881490d25a3fcca68fd29ef95
|
data/.rubocop.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
featureflow (0.3.0)
|
5
|
+
excon (~> 0.57.0)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
builder (3.2.3)
|
11
|
+
cucumber (2.4.0)
|
12
|
+
builder (>= 2.1.2)
|
13
|
+
cucumber-core (~> 1.5.0)
|
14
|
+
cucumber-wire (~> 0.0.1)
|
15
|
+
diff-lcs (>= 1.1.3)
|
16
|
+
gherkin (~> 4.0)
|
17
|
+
multi_json (>= 1.7.5, < 2.0)
|
18
|
+
multi_test (>= 0.1.2)
|
19
|
+
cucumber-core (1.5.0)
|
20
|
+
gherkin (~> 4.0)
|
21
|
+
cucumber-wire (0.0.1)
|
22
|
+
diff-lcs (1.3)
|
23
|
+
excon (0.57.0)
|
24
|
+
gherkin (4.1.3)
|
25
|
+
multi_json (1.12.1)
|
26
|
+
multi_test (0.1.2)
|
27
|
+
rake (10.5.0)
|
28
|
+
rspec (3.6.0)
|
29
|
+
rspec-core (~> 3.6.0)
|
30
|
+
rspec-expectations (~> 3.6.0)
|
31
|
+
rspec-mocks (~> 3.6.0)
|
32
|
+
rspec-core (3.6.0)
|
33
|
+
rspec-support (~> 3.6.0)
|
34
|
+
rspec-expectations (3.6.0)
|
35
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
36
|
+
rspec-support (~> 3.6.0)
|
37
|
+
rspec-mocks (3.6.0)
|
38
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
39
|
+
rspec-support (~> 3.6.0)
|
40
|
+
rspec-support (3.6.0)
|
41
|
+
|
42
|
+
PLATFORMS
|
43
|
+
ruby
|
44
|
+
|
45
|
+
DEPENDENCIES
|
46
|
+
bundler (~> 1.15)
|
47
|
+
cucumber (~> 2.4.0)
|
48
|
+
featureflow!
|
49
|
+
rake (~> 10.0)
|
50
|
+
rspec (~> 3.0)
|
51
|
+
|
52
|
+
BUNDLED WITH
|
53
|
+
1.15.1
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
data/Rakefile
ADDED
data/featureflow.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'featureflow/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "featureflow"
|
8
|
+
spec.version = Featureflow::VERSION
|
9
|
+
spec.authors = ["Henry Young"]
|
10
|
+
spec.email = ["henry@featureflow.io"]
|
11
|
+
|
12
|
+
spec.summary = "Ruby SDK for Featureflow"
|
13
|
+
spec.description = "Connects your server with Featureflow. Create features at https://featureflow.io."
|
14
|
+
spec.homepage = "https://github.com/featureflow/featureflow-ruby-sdk"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
# if spec.respond_to?(:metadata)
|
20
|
+
# spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
|
21
|
+
# else
|
22
|
+
# raise "RubyGems 2.0 or newer is required to protect against " \
|
23
|
+
# "public gem pushes."
|
24
|
+
# end
|
25
|
+
|
26
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
27
|
+
f.match(%r{^(test|spec|features)/})
|
28
|
+
end
|
29
|
+
spec.bindir = "exe"
|
30
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
31
|
+
spec.require_paths = ["lib"]
|
32
|
+
|
33
|
+
spec.add_development_dependency "bundler", "~> 1.15"
|
34
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
35
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
36
|
+
spec.add_development_dependency "cucumber", "~> 2.4.0"
|
37
|
+
spec.add_dependency "excon", "~> 0.57.0"
|
38
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
require 'logger'
|
2
|
+
require 'time'
|
3
|
+
require 'pp'
|
4
|
+
require 'featureflow/evaluate'
|
5
|
+
require 'featureflow/polling_client'
|
6
|
+
require 'featureflow/events_client'
|
7
|
+
|
8
|
+
module Featureflow
|
9
|
+
class Client
|
10
|
+
def initialize(api_key, config = {})
|
11
|
+
Featureflow.logger.info 'initializing client'
|
12
|
+
@features = {}
|
13
|
+
@config = {
|
14
|
+
api_key: api_key,
|
15
|
+
url: 'https://app.featureflow.io',
|
16
|
+
path: '/api/sdk/v1/features',
|
17
|
+
with_features: []
|
18
|
+
}.merge(config)
|
19
|
+
|
20
|
+
unless with_features_valid? @config[:with_features]
|
21
|
+
raise ArgumentError, 'config[:with_features] must be an array of Feature hashes. Use Featureflow::Feature.create(key, failover_variant)'
|
22
|
+
end
|
23
|
+
|
24
|
+
@failover_variants = {}
|
25
|
+
@config[:with_features].each do |feature|
|
26
|
+
Featureflow.logger.info "Registering feature with key #{feature[:key]}"
|
27
|
+
failover = feature[:failover_variant];
|
28
|
+
@failover_variants[feature[:key]] = failover if failover.is_a?(String) && !failover.empty?
|
29
|
+
end
|
30
|
+
|
31
|
+
@events_client = EventsClient.new @config[:url], @config[:api_key]
|
32
|
+
@events_client.register_features @config[:with_features]
|
33
|
+
|
34
|
+
PollingClient.new(@config[:url] + @config[:path],
|
35
|
+
@config[:api_key],
|
36
|
+
delay: 30,
|
37
|
+
timeout: 30) {|features| update_features(features)}
|
38
|
+
|
39
|
+
Featureflow.logger.info 'client initialized'
|
40
|
+
end
|
41
|
+
|
42
|
+
def feature(key)
|
43
|
+
@features[key]
|
44
|
+
end
|
45
|
+
|
46
|
+
def evaluate(key, context)
|
47
|
+
raise ArgumentError, 'key must be a string' unless key.is_a?(String)
|
48
|
+
raise ArgumentError, 'context is required (build with Featureflow::ContextBuilder)' unless context
|
49
|
+
|
50
|
+
context = context.dup
|
51
|
+
context[:values] = context[:values].merge('featureflow.key' => context[:key],
|
52
|
+
'featureflow.date' => Time.now.iso8601)
|
53
|
+
|
54
|
+
Evaluate.new key, feature(key), failover_variant(key), context, '1', @events_client
|
55
|
+
end
|
56
|
+
|
57
|
+
private def failover_variant(key)
|
58
|
+
@failover_variants[key]
|
59
|
+
end
|
60
|
+
|
61
|
+
private def update_features(features)
|
62
|
+
Featureflow.logger.info "updating features"
|
63
|
+
@features = features
|
64
|
+
end
|
65
|
+
|
66
|
+
private def with_features_valid?(features)
|
67
|
+
features.all? { |feature|
|
68
|
+
feature[:key].is_a?(String) && feature[:failover_variant].is_a?(String) && feature[:variants].is_a?(Array)
|
69
|
+
}
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
module Featureflow
|
2
|
+
class Conditions
|
3
|
+
def self.test(op, a, b)
|
4
|
+
case op
|
5
|
+
when 'equals'
|
6
|
+
a.eql? b[0]
|
7
|
+
when 'contains'
|
8
|
+
a.include? b[0]
|
9
|
+
when 'startsWith'
|
10
|
+
a.start_with? b[0]
|
11
|
+
when 'endsWith'
|
12
|
+
a.end_with? b[0]
|
13
|
+
when 'matches'
|
14
|
+
a.match? Regexp.new(b[0])
|
15
|
+
when 'in'
|
16
|
+
b.include? a
|
17
|
+
when 'notIn'
|
18
|
+
!b.include? a
|
19
|
+
when 'greaterThan'
|
20
|
+
a > b[0]
|
21
|
+
when 'greaterThanOrEqual'
|
22
|
+
a >= b[0]
|
23
|
+
when 'lessThan'
|
24
|
+
a < b[0]
|
25
|
+
when 'lessThanOrEqual'
|
26
|
+
a <= b[0]
|
27
|
+
when 'before'
|
28
|
+
a < b[0]
|
29
|
+
when 'after'
|
30
|
+
a > b[0]
|
31
|
+
else
|
32
|
+
false
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
module Featureflow
|
2
|
+
class ContextBuilder
|
3
|
+
def initialize(key)
|
4
|
+
raise ArgumentError, 'Parameter key must be a String' unless key.is_a?(String) && !key.empty?
|
5
|
+
@context_key = key
|
6
|
+
@values = {}
|
7
|
+
self
|
8
|
+
end
|
9
|
+
|
10
|
+
def with_values(hash)
|
11
|
+
raise ArgumentError, 'Parameter hash must be a Hash' unless hash.is_a?(Hash)
|
12
|
+
hash = hash.dup
|
13
|
+
hash.each do |k, v|
|
14
|
+
raise ArgumentError, "Value for #{k} must be a valid 'primitive' JSON datatype" unless valid_value?(v)
|
15
|
+
hash[k.to_s] = h.delete(k) unless k.is_a?(String)
|
16
|
+
end
|
17
|
+
@values = @values.merge(hash)
|
18
|
+
self
|
19
|
+
end
|
20
|
+
|
21
|
+
def build
|
22
|
+
{
|
23
|
+
key: @context_key,
|
24
|
+
values: @values
|
25
|
+
}
|
26
|
+
end
|
27
|
+
|
28
|
+
private def valid_value?(values)
|
29
|
+
Array(values).all? do |v|
|
30
|
+
[String, Numeric, TrueClass, FalseClass].any? { |type| v.is_a?(type) }
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
require_relative 'evaluate_helpers'
|
2
|
+
|
3
|
+
module Featureflow
|
4
|
+
class Evaluate
|
5
|
+
def initialize(feature_key, feature, failover_variant, context, salt, events_client = nil)
|
6
|
+
@evaluated_variant = calculate_variant feature_key, feature, failover_variant, context, salt
|
7
|
+
@events_client = events_client
|
8
|
+
@context = context
|
9
|
+
@key = feature_key
|
10
|
+
end
|
11
|
+
|
12
|
+
def is?(value)
|
13
|
+
@events_client.evaluate @key, @evaluated_variant, value, @context unless events_client.is_a?(NilClass)
|
14
|
+
@evaluated_variant == value
|
15
|
+
end
|
16
|
+
|
17
|
+
def on?
|
18
|
+
is? 'on'
|
19
|
+
end
|
20
|
+
alias is_on? on?
|
21
|
+
|
22
|
+
def off?
|
23
|
+
is? 'off'
|
24
|
+
end
|
25
|
+
alias is_off? off?
|
26
|
+
|
27
|
+
def value
|
28
|
+
@evaluated_variant
|
29
|
+
end
|
30
|
+
|
31
|
+
private def calculate_variant(feature_key, feature, failover_variant, context = {}, salt = '1')
|
32
|
+
unless feature
|
33
|
+
has_failover = failover_variant.is_a?(String)
|
34
|
+
failover_variant = 'off' unless has_failover
|
35
|
+
Featureflow.logger.info "Evaluating nil feature '#{feature_key}' using the "\
|
36
|
+
"#{has_failover ? 'provided' : 'default'} failover '#{failover_variant}'"
|
37
|
+
return failover_variant
|
38
|
+
end
|
39
|
+
|
40
|
+
return feature['offVariantKey'] unless feature['enabled']
|
41
|
+
feature['rules'].each do |rule|
|
42
|
+
next unless EvaluateHelpers.rule_matches rule, context
|
43
|
+
hash = EvaluateHelpers.calculate_hash salt, feature['key'], context['key']
|
44
|
+
variant_value = EvaluateHelpers.get_variant_value hash
|
45
|
+
return EvaluateHelpers.get_variant_split_key rule['variantSplits'], variant_value
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
require 'featureflow/conditions'
|
2
|
+
require 'digest/sha1'
|
3
|
+
|
4
|
+
module Featureflow
|
5
|
+
class EvaluateHelpers
|
6
|
+
def self.rule_matches(rule, context)
|
7
|
+
if rule['defaultRule']
|
8
|
+
true # the default rule will always match true
|
9
|
+
else
|
10
|
+
rule['audience']['conditions'].all? do |condition|
|
11
|
+
context_values = context[:values][condition['target']]
|
12
|
+
# convert to array to work with test
|
13
|
+
Array(context_values).any? do |value|
|
14
|
+
Conditions.test condition['operator'], value, condition['values']
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.get_variant_split_key(variant_splits, variant_value)
|
21
|
+
percent = 0
|
22
|
+
variant_splits.each do |variant_split|
|
23
|
+
percent += variant_split['split']
|
24
|
+
return variant_split['variantKey'] if percent >= variant_value
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.calculate_hash(salt = '1', feature = 'feature', key = 'anonymous')
|
29
|
+
(Digest::SHA1.hexdigest [salt, feature, key].join(':'))[0..14];
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.get_variant_value(hash)
|
33
|
+
Integer(hash, 16) % 100 + 1
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
require 'excon'
|
2
|
+
require 'json'
|
3
|
+
|
4
|
+
module Featureflow
|
5
|
+
class EventsClient
|
6
|
+
def initialize(url, api_key)
|
7
|
+
@url = url
|
8
|
+
@api_key = api_key
|
9
|
+
end
|
10
|
+
|
11
|
+
def register_features(with_features)
|
12
|
+
Thread.new do
|
13
|
+
features = []
|
14
|
+
features = with_features.each do | feature |
|
15
|
+
features.push(key: feature[:key],
|
16
|
+
variants: feature[:variants],
|
17
|
+
failoverVariant: feature[:failoverVariant])
|
18
|
+
end
|
19
|
+
send_event 'Register Features', :put, 'api/sdk/v1/register', features
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def evaluate(key, evaluated_variant, expected_variant, context)
|
24
|
+
Thread.new do
|
25
|
+
send_event 'Evaluate Variant', :post, 'api/sdk/v1/events', [{
|
26
|
+
featureKey: key,
|
27
|
+
evaluatedVariant: evaluated_variant,
|
28
|
+
expectedVaraint: expected_variant,
|
29
|
+
context: context
|
30
|
+
}]
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
private def send_event(event_name, method, path, body)
|
35
|
+
connection = Excon.new(@url)
|
36
|
+
response connection.request(method: method,
|
37
|
+
path: path,
|
38
|
+
headers: {
|
39
|
+
'Authorization' => "Bearer #{@api_key}",
|
40
|
+
'Content-Type' => 'application/json;charset=UTF-8'
|
41
|
+
},
|
42
|
+
omit_default_port: true,
|
43
|
+
body: JSON.generate(body))
|
44
|
+
if response.status >= 400
|
45
|
+
Featureflow.logger.error "unable to send event #{event_name} to #{@url+path}. Failed with response status #{response.status}"
|
46
|
+
Featureflow.logger.error response.to_s
|
47
|
+
end
|
48
|
+
rescue => e
|
49
|
+
Featureflow.logger.error e.inspect
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
module Featureflow
|
2
|
+
class Feature
|
3
|
+
def self.create(key, failover_variant)
|
4
|
+
raise ArgumentError, 'Parameter key must be a String' unless valid_key?(key)
|
5
|
+
raise ArgumentError, 'Parameter default_variant must be a String' unless valid_key?(failover_variant) || failover_variant.is_a?(NilClass)
|
6
|
+
{
|
7
|
+
key: key,
|
8
|
+
failover_variant: failover_variant,
|
9
|
+
variants: [{
|
10
|
+
key: 'on',
|
11
|
+
name: 'On'
|
12
|
+
},
|
13
|
+
{
|
14
|
+
key: 'off',
|
15
|
+
name: 'Off'
|
16
|
+
}]
|
17
|
+
}
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
def valid_key?(value)
|
23
|
+
value.is_a?(String) && !value.empty? && /^[a-z\-\_0-9]+$/.match?(value)
|
24
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
require 'excon'
|
2
|
+
require 'json'
|
3
|
+
|
4
|
+
module Featureflow
|
5
|
+
class PollingClient
|
6
|
+
DEFAULT_OPTIONS = {
|
7
|
+
delay: 30,
|
8
|
+
timeout: 30
|
9
|
+
}.freeze
|
10
|
+
def initialize(url, api_key, options = {}, &set_features)
|
11
|
+
@etag = ''
|
12
|
+
@url = url
|
13
|
+
@api_key = api_key
|
14
|
+
@options = DEFAULT_OPTIONS.merge(options)
|
15
|
+
@set_features = set_features
|
16
|
+
|
17
|
+
load_features
|
18
|
+
Thread.new do
|
19
|
+
loop do
|
20
|
+
sleep @options[:delay]
|
21
|
+
load_features
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
def load_features
|
27
|
+
response = Excon.get(@url, headers: {
|
28
|
+
'Authorization' => "Bearer #{@api_key}",
|
29
|
+
'If-None-Match' => @etag
|
30
|
+
}, omit_default_port: true, read_timeout: @options[:timeout])
|
31
|
+
if response.status == 200
|
32
|
+
@etag = response.headers['ETag']
|
33
|
+
@set_features.call(JSON.parse(response.body))
|
34
|
+
elsif response.status >= 400
|
35
|
+
Featureflow.logger.error "request for features failed with response status #{response.status}"
|
36
|
+
Featureflow.logger.error response.to_s
|
37
|
+
end
|
38
|
+
rescue => e
|
39
|
+
Featureflow.logger.error e.inspect
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
data/lib/featureflow.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'featureflow/version'
|
2
|
+
require 'featureflow/client'
|
3
|
+
require 'featureflow/context_builder'
|
4
|
+
require 'featureflow/feature'
|
5
|
+
|
6
|
+
module Featureflow
|
7
|
+
class << self
|
8
|
+
attr_writer :logger
|
9
|
+
|
10
|
+
def logger
|
11
|
+
@logger ||= Logger.new($stdout).tap do |log|
|
12
|
+
log.progname = self.name
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
data/test.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
$:.unshift(File.dirname(__FILE__) + "/lib/")
|
2
|
+
|
3
|
+
require 'featureflow'
|
4
|
+
with_features = [
|
5
|
+
Featureflow::Feature.create('default', 'variant')
|
6
|
+
]
|
7
|
+
api_key = 'srv-env-9b5fff890c724d119a334a64ed4d2eb2'
|
8
|
+
featureflow_client = Featureflow::Client.new(api_key, with_features: with_features)
|
9
|
+
context = Featureflow::ContextBuilder.new('user1').build
|
10
|
+
puts('test-integration is on? ' + featureflow_client.evaluate('test-integration', context).on?.to_s)
|
11
|
+
featureflow_client.evaluate('nooooo', context).on?
|
12
|
+
featureflow_client.evaluate('default', context).on?
|
13
|
+
|
14
|
+
#
|
15
|
+
# loop do
|
16
|
+
# puts('test-integration is on? ' + featureflow_client.evaluate('test-integration', context).on?.to_s)
|
17
|
+
# sleep 5
|
18
|
+
# end
|
metadata
ADDED
@@ -0,0 +1,132 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: featureflow
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.3.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Henry Young
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-06-22 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.15'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.15'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: cucumber
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 2.4.0
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 2.4.0
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: excon
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 0.57.0
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 0.57.0
|
83
|
+
description: Connects your server with Featureflow. Create features at https://featureflow.io.
|
84
|
+
email:
|
85
|
+
- henry@featureflow.io
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".rubocop.yml"
|
91
|
+
- Gemfile
|
92
|
+
- Gemfile.lock
|
93
|
+
- LICENSE
|
94
|
+
- README.md
|
95
|
+
- Rakefile
|
96
|
+
- featureflow.gemspec
|
97
|
+
- lib/featureflow.rb
|
98
|
+
- lib/featureflow/client.rb
|
99
|
+
- lib/featureflow/conditions.rb
|
100
|
+
- lib/featureflow/context_builder.rb
|
101
|
+
- lib/featureflow/evaluate.rb
|
102
|
+
- lib/featureflow/evaluate_helpers.rb
|
103
|
+
- lib/featureflow/events_client.rb
|
104
|
+
- lib/featureflow/feature.rb
|
105
|
+
- lib/featureflow/polling_client.rb
|
106
|
+
- lib/featureflow/version.rb
|
107
|
+
- test.rb
|
108
|
+
homepage: https://github.com/featureflow/featureflow-ruby-sdk
|
109
|
+
licenses:
|
110
|
+
- MIT
|
111
|
+
metadata: {}
|
112
|
+
post_install_message:
|
113
|
+
rdoc_options: []
|
114
|
+
require_paths:
|
115
|
+
- lib
|
116
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
117
|
+
requirements:
|
118
|
+
- - ">="
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '0'
|
121
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
122
|
+
requirements:
|
123
|
+
- - ">="
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '0'
|
126
|
+
requirements: []
|
127
|
+
rubyforge_project:
|
128
|
+
rubygems_version: 2.6.8
|
129
|
+
signing_key:
|
130
|
+
specification_version: 4
|
131
|
+
summary: Ruby SDK for Featureflow
|
132
|
+
test_files: []
|