field_test 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5935d4b9a0cca9bd7d08fb1e0acaf5ab6e0e7f8c8c44b71efae5a3667a0d37a6
-  data.tar.gz: e839006d04adfe1e06d27c2b32b8ea601ada47106b05537bf6a11168c8b0864a
+  metadata.gz: 2a60826c451cf3807f5e111f2b4a619f4c07db0011ff27e7f2ceb0dd03bd1807
+  data.tar.gz: 1150b7a05035bf91193dcdaca20a7075b1350d50ef037afebe6a1866baea5fb9
 SHA512:
-  metadata.gz: 0ab03821f1b5a95f8cf2681820ab4d13c10bde98889e2d5995cd05f7426f815d207bfcdd894db0da90acb1e1743adf6f7256c75d5f62572e27f7183a0992a722
-  data.tar.gz: 84009fba31741d3c737f0623b580512bed5dadd455c35691fbe0388899dcf706a8d5ed1740f3d94cb877058e19740aa5321a5b51ef7595c31cea483b85dfd1bc
+  metadata.gz: 9a2644d12172b876b33ddc7faec2c4490623fed35aa7ae1848f0486a9ff176a80c2bdc2db66ec9196b93034f8566dbfc11c2027f524177a946427b6c4b10d71b
+  data.tar.gz: 1dc282f0f054e7a95bdc4dfccd1361c11f28b53d70a2b5083ba73e40d3af13230246ad85e38990f74e7dab01a48fb5be9fefc5b2e6e1d8dff8cf066bb1dc525a

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 0.3.1 [unreleased]
+## 0.3.2 (2020-04-16)
+
+- Added support for excluding IP addresses
+
+## 0.3.1 (2019-07-01)
 
 - Added `closed` and `keep_variant`
 - Added `field_test_upgrade_memberships` method
@@ -9,7 +13,7 @@ Security
 
 - Fixed arbitrary variants via query parameters - see [#17](https://github.com/ankane/field_test/issues/17)
 
-## 0.3.0
+## 0.3.0 (2019-06-02)
 
 - Added support for native apps
 - Added `cookies` option
@@ -23,36 +27,36 @@ Breaking changes
 - Split out participant id and type
 - Changed participant logic for emails
 
-## 0.2.4
+## 0.2.4 (2019-01-03)
 
 - Fixed `PG::AmbiguousColumn` error
 
-## 0.2.3
+## 0.2.3 (2018-01-28)
 
 - Fixed participant reporting for multiple goals
 
-## 0.2.2
+## 0.2.2 (2017-05-01)
 
 - Added support for Rails 5.1
 
-## 0.2.1
+## 0.2.1 (2016-12-18)
 
 - Added support for multiple goals
 
-## 0.2.0
+## 0.2.0 (2016-12-17)
 
 - Better web UI
 - Removed `cookie:` prefix for unknown participants
 
-## 0.1.2
+## 0.1.2 (2016-12-17)
 
 - Exclude bots
 - Mailer improvements
 
-## 0.1.1
+## 0.1.1 (2016-12-15)
 
 - Added basic web UI
 
-## 0.1.0
+## 0.1.0 (2016-12-14)
 
 - First release

data/README.md

@@ -151,6 +151,15 @@ You can also manually pass a participant with:
 field_test(:button_color, participant: company)
 ```
 
+## Jobs
+
+To get variants in jobs, models, and other contexts, use:
+
+```ruby
+experiment = FieldTest::Experiment.find(:button_color)
+button_color = experiment.variant(user)
+```
+
 ## Config
 
 By default, bots are returned the first variant and excluded from metrics. Change this with:
@@ -160,6 +169,15 @@ exclude:
   bots: false
 ```
 
+Exclude certain IP addresses with:
+
+```yml
+exclude:
+  ips:
+    - 127.0.0.1
+    - 10.0.0.0/8
+```
+
 Keep track of when experiments started and ended. Use any format `Time.parse` accepts. Variants assigned outside this window are not included in metrics.
 
 ```yml
@@ -281,7 +299,7 @@ ENV["FIELD_TEST_USERNAME"] = "moonrise"
 ENV["FIELD_TEST_PASSWORD"] = "kingdom"
 ```
 
-## Reference
+## Updating Variants
 
 Assign a specific variant to a user with:
 
@@ -292,6 +310,8 @@ experiment.variant(participant, variant: "green")
 
 You can also change a user’s variant from the dashboard.
 
+## Associations
+
 To associate models with field test memberships, use:
 
 ```ruby
@@ -341,7 +361,7 @@ rails generate migration upgrade_field_test_participants
 with:
 
 ```ruby
-class UpgradeFieldTestParticipants < ActiveRecord::Migration[5.2]
+class UpgradeFieldTestParticipants < ActiveRecord::Migration[6.0]
   def change
     add_column :field_test_memberships, :participant_type, :string
     add_column :field_test_memberships, :participant_id, :string
@@ -392,3 +412,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/field_test/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/field_test.git
+cd field_test
+bundle install
+bundle exec rake test
+```

data/lib/field_test.rb

@@ -30,6 +30,10 @@ module FieldTest
     @config ||= YAML.load(ERB.new(File.read(config_path)).result)
   end
 
+  def self.excluded_ips
+    @excluded_ips ||= Array(config["exclude"] && config["exclude"]["ips"]).map { |ip| IPAddr.new(ip) }
+  end
+
   def self.exclude_bots?
     config["exclude"] && config["exclude"]["bots"]
   end

data/lib/field_test/helpers.rb

@@ -16,6 +16,8 @@ module FieldTest
           options[:exclude] = Browser.new(request.user_agent).bot?
         end
 
+        options[:exclude] ||= FieldTest.excluded_ips.any? { |ip| ip.include?(request.remote_ip) }
+
         options[:ip] = request.remote_ip
         options[:user_agent] = request.user_agent
       end

data/lib/field_test/version.rb

@@ -1,3 +1,3 @@
 module FieldTest
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_test
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -56,14 +56,14 @@ dependencies:
   name: browser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A/B testing for Rails