determinator 0.5.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cede155eec48f968445c5fb515ce6296ab6aeb59
-  data.tar.gz: 46ea00ad101e8a61e63c98fd915e527ca04de4e2
+  metadata.gz: 032d0d611e857b800335e89ac9072d019a882068
+  data.tar.gz: 78c11ba6dc7f2b4ac655ce640de7eb1b9952969b
 SHA512:
-  metadata.gz: 60b2758568e6e9f954a24564c08a77db426ba3e0de5e40ad8b19bd828b54c72132cbea878ae3c6e1219dc806014d0ca6074599283713b17bc9414ea9db9c88bc
-  data.tar.gz: d89902fdc6d802469954eb226550d66b8fbeb1cb30fb8ff8ac9ffa43e1a69699733574c689224788b7eee2507bbd810cf5357868304399b469d7f9a0cad7d4f8
+  metadata.gz: fae0cba5e7b20502e07c0e063fa1508644831e581c20622166316d265b4ecd2dcd28e5dfd542a4c8dd8754080792772fdc399baeab516d811d5848bce7c98b73
+  data.tar.gz: a30b9e35eef5a9fa3963620c14d21f5b77836117ad2f8b2553c85517c32bdb4a78cb03d5b6c3f213978a8c3dcab4058a0493492341ac5dc8d0bf35b3f2042c99

data/README.md

@@ -4,29 +4,48 @@ A gem that works with [Florence](https://github.com/deliveroo/actor-tracking) to
 
 ![Determinator](docs/img/determinator.jpg)
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Once [set up](#installation), determinator can be used to determine whether a **feature flag** or **experiment** is on or off for the current user and, for experiments, which **variant** they should see.
 
 ```ruby
-gem 'determinator'
+# Feature flags
+if determinator.feature_flag_on?(:my_feature_name)
+  # Show the feature
+end
+
+# Experiments
+case determinator.which_variant(:my_experiment_name)
+when 'control'
+  # Do nothing different
+when 'sloths'
+  # Show some sloth pictures
+when 'velociraptors'
+  # RUN!
+end
 ```
 
-And then execute:
+Feature flags and Experiments can be configured to have string based constraints. When the strings required for the experiment do not match, the user will _never_ see the flag or the experiment, when they match, then the rollout specified by the feature will be applied.
 
-    $ bundle
+Constraints must be strings, what matches and doesn't is configurable after-the-fact within Florence.
 
-Or install it yourself as:
-
-    $ gem install determinator
+```ruby
+# Constraints
+variant = determinator.which_variant(
+  :my_experiment_name,
+  constraints: {
+    country_of_first_order: current_user.orders.first.country.tld,
+  }
+)
+```
 
-## Usage
+## Installation
 
 Check the example Rails app in `examples` for more information on how to make use of this gem.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/determinator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/deliveroo/determinator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/examples/determinator-rails/README.md

@@ -18,7 +18,7 @@ Bear in mind that, because routemaster depends on background workers to populate
 
 ### `app/controllers/index_controller.rb`
 
-An example of how Determinator can be used for feature flags.
+An example of how Determinator can be used for feature flags and experiments.
 
 ### `app/controllers/application_controller.rb`
 

data/examples/determinator-rails/app/controllers/index_controller.rb

@@ -1,9 +1,17 @@
 class IndexController < ApplicationController
   def show
-    if determinator.feature_flag_on?(:colloquial_welcome)
-      render json: { welcome: 'hi world' }
-    else
-      render json: { welcome: 'hello world' }
+    is_colloquial = determinator.feature_flag_on?(:colloquial_welcome)
+    emoji = determinator.which_variant(:welcome_emoji)
+
+    if emoji
+      # TODO: Track that this user saw a variant of this experiment
     end
+
+    message = [
+      is_colloquial ? "hi world" : "hello world",
+      emoji
+    ].compact.join(" ")
+
+    render json: { welcome: message }
   end
 end

data/lib/determinator/control.rb

@@ -50,6 +50,8 @@ module Determinator
       # Overrides take precedence
       return feature.override_value_for(id) if feature.overridden_for?(id)
 
+      return false unless feature.active?
+
       target_group = choose_target_group(feature, constraints)
       # Given constraints have excluded this actor from this experiment
       return false unless target_group

data/lib/determinator/feature.rb

@@ -3,15 +3,16 @@ module Determinator
   #
   # @attr_reader [nil,Hash<String,Integer>] variants The variants for this experiment, with the name of the variant as the key and the weight as the value. Will be nil for non-experiments.
   class Feature
-    attr_reader :name, :identifier, :bucket_type, :variants, :target_groups
+    attr_reader :name, :identifier, :bucket_type, :variants, :target_groups, :active
 
     BUCKET_TYPES = %i(id guid fallback)
 
-    def initialize(name:, identifier:, bucket_type:, target_groups:, variants: {}, overrides: {})
+    def initialize(name:, identifier:, bucket_type:, target_groups:, variants: {}, overrides: {}, active: false)
       @name = name.to_s
       @identifier = identifier.to_s
       @variants = variants
       @target_groups = target_groups
+      @active = active
 
       @bucket_type = bucket_type.to_sym
       raise ArgumentError, "Unknown bucket type: #{bucket_type}" unless BUCKET_TYPES.include?(@bucket_type)
@@ -20,6 +21,10 @@ module Determinator
       @overrides = Hash[overrides.map { |k, v| [k.to_s, v] }]
     end
 
+    def active?
+      !!active
+    end
+
     # @return [true,false] Is this feature an experiment?
     def experiment?
       variants.any?

data/lib/determinator/retrieve/routemaster.rb

@@ -43,10 +43,11 @@ module Determinator
           name:          obj.body.name,
           identifier:    obj.body.identifier,
           bucket_type:   obj.body.bucket_type,
+          active:        obj.body.active,
           target_groups: obj.body.target_groups.map { |tg|
             TargetGroup.new(
               rollout: tg.rollout,
-              constraints: tg.constraints.to_h
+              constraints: tg.constraints.first.to_h
             )
           },
           variants:      obj.body.variants.to_h,

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = "0.5.0"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: routemaster-drain