determinator 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d743c707c8d4b9e9e28c122aee5bd965ab3e097d
-  data.tar.gz: 540858ec639b34a39ceeef760ee51831f4c5a4a3
+  metadata.gz: 4ccc82084d2734ddf50ebb5900f73b9e985bd05f
+  data.tar.gz: 1b231a0fc9228692f357a2db213a170c046fb92e
 SHA512:
-  metadata.gz: 14391fb80975ee14cea5982fb345507794c5c07824f750bbc972b21dd847df5872ecbb054842fe8ceea42944c2aa7f2e696cb8d176dc904a03ff77ff150f2b45
-  data.tar.gz: 6819a9318fbce45ff3b096299d104872ad16b3cfb267277050ea3480423ba180f3881484b6b1fd5a2c7ab78d424e43fd8b3690057d7962405283dcde85f31027
+  metadata.gz: 968a15520388364e962099c8d762431c38a7ff21825263352f506ace9ee568f03564e2aa5428d9ede53c46a33a2d7c3e482da4339d9503ecaf890b7cdf18a850
+  data.tar.gz: fbe0fface76305e3348c76647f34272df03a0fde293db796d565db8fe3e615c7ebcfd743288d783e7c2892c3847afed85e849b35ca987cb10ada1d24121174d4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.12.0 (2018-01-23)
+
+Feature:
+- Adds the `Determinator.feature_details` method, which allows lookup of feature details as are currently available to Determinator. Whatever is returned here is what Determinator is acting upon. (#38)
+
+Bug Fix:
+- Upgrades a dependency of the example rails app which has a known vulnerability. (#39)
+
 # v0.11.1 (2017-10-27)
 
 Feature:

data/README.md

@@ -2,14 +2,26 @@
 
 A gem that works with _Florence_ to deterministically calculate whether an **actor** should have a feature flag turned on or off, or which variant they should see in an experiment.
 
-![Determinator](docs/img/determinator.jpg)
+![Arnold Schwarzenegger might say "Come with me if you want to experiment" if he played The Determinator instead of The Terminator.](docs/img/determinator.jpg)
 
-Useful documentation:
+---
+
+#### Useful documentation
 
 - [Terminology and Background](docs/background.md)
 - [Local development](docs/local_development.md)
 - [Example implemention in Rails](examples/determinator-rails)
 
+#### Getting help
+
+For Deliveroo Employees:
+
+- Many people contribute to Determinator and Florence. We hang out in [this Slack channel](slack://channel?team=T03EUNC3F&id=C7437816J)
+- [This JIRA board](https://deliveroo.atlassian.net/secure/RapidBoard.jspa?rapidView=156) covers pieces of work that are planned or in-flight
+- [This Workplace group](https://deliveroo.facebook.com/groups/1893254264328414/) holds more general discussions about the Florence ecosystem
+
+At the moment we can only promise support for Determinator within Deliveroo, but if you add [issues to this github repo](https://github.com/deliveroo/determinator/issues) we'll try and help if we can!
+
 ## Usage
 
 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.
@@ -67,6 +79,38 @@ Determinator.configure(
 )
 ```
 
+### Using Determinator in RSpec
+
+* Include those lines in `spec_helper.rb`.
+
+
+```
+require 'rspec/determinator'
+
+Determinator.configure(retrieval: nil)
+
+```
+
+* Tag your rspec test with `:determinator_support`, so `forced_determination` helper method will be available.
+
+
+```
+
+RSpec.describe "something", :determinator_support do
+
+  context "something" do
+    forced_determination(:my_feature_flag, true)
+    forced_determination(:my_experiment, "variant_a")
+
+    it "uses forced_determination" do
+      expect(Determinator.instance.feature_flag_on?(:my_feature_flag)).to eq(true)
+      expect(Determinator.instance.which_variant(:my_experiment)).to eq("variant_a")
+    end
+  end
+end
+
+```
+
 ### Retrieval Cache
 
 Determinator will function fully without a retrieval_cache set, although Determinator will produce 1 Redis query for every determination. By setting a `retrieval_cache` as an instance of `ActiveSupport::Cache::MemoryStore` (or equivalent) this can be reduced per application instance. This cache is not expired so *must* have a `expires_in` set, ideally to a short amount of time.

data/examples/determinator-rails/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ../..
   specs:
-    determinator (0.1.0)
-      routemaster-drain (~> 2.5)
+    determinator (0.11.1)
+      routemaster-drain (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -44,11 +44,14 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     arel (7.1.4)
     builder (3.2.3)
     byebug (9.0.6)
+    circuitbox (1.1.1)
+      activesupport
+      moneta
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
     dotenv (2.2.0)
@@ -56,16 +59,16 @@ GEM
       dotenv (= 2.2.0)
       railties (>= 3.2, < 5.1)
     erubis (2.7.0)
-    ethon (0.10.1)
+    ethon (0.11.0)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.11.0.1)
+    faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
     ffi (1.9.18)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
-    hashie (3.5.5)
+    hashie (3.5.7)
     i18n (0.8.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
@@ -75,13 +78,14 @@ GEM
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.1)
+    moneta (1.0.0)
     multipart-post (2.0.0)
     nio4r (2.0.0)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    public_suffix (2.0.5)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.1)
     puma (3.8.2)
     rack (2.0.1)
     rack-protection (1.5.3)
@@ -113,10 +117,11 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rake (12.0.0)
     redis (3.3.3)
-    redis-namespace (1.5.3)
-      redis (~> 3.0, >= 3.0.4)
-    routemaster-drain (2.5.0)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
+    routemaster-drain (3.4.0)
       addressable
+      circuitbox
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -139,7 +144,7 @@ GEM
       sprockets (>= 3.0.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    typhoeus (1.1.2)
+    typhoeus (1.3.0)
       ethon (>= 0.9.0)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -160,4 +165,4 @@ DEPENDENCIES
   sidekiq
 
 BUNDLED WITH
-   1.13.6
+   1.16.0

data/lib/determinator.rb

@@ -15,11 +15,20 @@ module Determinator
     @instance = Control.new(retrieval: retrieval)
   end
 
+  # @return [Determinator::Control] The currently active instance of determinator.
+  # @raises [RuntimeError] If no Determinator instance is set up (with `.configure`)
   def self.instance
     raise "No singleton Determinator instance defined" unless @instance
     @instance
   end
 
+  # Returns the feature with the given name as Determinator uses it. This is useful for
+  # debugging issues with the retrieval mechanism which delivers features to Determinator.
+  # @returns [Determinator::Feature,nil] The feature details Determinator would use for a determination right now.
+  def self.feature_details(name)
+    instance.retrieval.retrieve(name)
+  end
+
   def self.notice_error(error)
     return unless @error_logger
 

data/lib/determinator/retrieve/routemaster.rb

@@ -27,9 +27,11 @@ module Determinator
 
       end
 
-      def retrieve(feature_id)
-        cached_feature_lookup(feature_id) do
-          @actor_service.feature.show(feature_id)
+      # Retrieves and processes the feature that goes by the given name on this retrieval mechanism.
+      # @return [Determinator::Feature,nil] The details of the specified feature
+      def retrieve(name)
+        cached_feature_lookup(name) do
+          @actor_service.feature.show(name)
         end
       rescue ::Routemaster::Errors::ResourceNotFound
         # Don't be noisy

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: routemaster-drain
@@ -211,3 +211,4 @@ signing_key:
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.
 test_files: []
+has_rdoc: