determinator 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4466edc3643125ca6b84591b4db51083d215c5c6ea8201694e99d16e403eab24
-  data.tar.gz: 326d45e3f0ac249e5a358ee3911c1da4da01db81c14ab1b3c827a8fd5d0f4ef9
+  metadata.gz: acc3109dbf66955d32841b5fe5a56077e0e3b6f60bc0dfa39cb4318c2bb98ea8
+  data.tar.gz: f190ea639d1e0215045340be697d9493fd09bbe65c91072029b31f2ab3fcf20a
 SHA512:
-  metadata.gz: c83ad23860f0d5565618e3cfbf1f9975763f3f64c0db49668fa2259aae06c972689e000538a734571906edbf766c8d1d46e58ad2d7c657461c76759768f37bfa
-  data.tar.gz: 777556d4606d6a10514b5f7c6311e498117845f9bf5bc3bd1be7f8c47cee837fb17243348d11ee0f2fff3931493e97e65cb06608dcbc9b435916aabad07e69f1
+  metadata.gz: c2fcd6ce6e7327d1d710ae0f1d2661da23d2b2407a919796c9a963aea1431889704641d7696842acb6076aab0be10176502056baf9c10ef5467ad41c937a8d5d
+  data.tar.gz: 1d2632f3df8056ca79870722efad6790ba8685ab618bc87b17cb33df4bfc773b82999f0b0af1644e3989ca9f6c19f229b35fe49a6890060e9fda5b3c8d4d68da

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.5.2
+
+Feature:
+- Add structured_bucket to Feature
+- Add `#retrieve` method to the Control
+- Add optional `feature` argument to `feature_flag_on?` and `which_variant`, to reuse an existing feature
+
 # 2.5.1
 
 Feature:

data/lib/determinator/control.rb

@@ -30,10 +30,11 @@ module Determinator
     # @param :id [#to_s] The id of the actor being determinated for
     # @param :guid [#to_s] The Anonymous id of the actor being determinated for
     # @param :properties [Hash<Symbol,String>] The properties of this actor which will be used for including this actor or not
+    # @param :feature [Feature] The feature to use instead of retrieving one
     # @raise [ArgumentError] When the arguments given to this method aren't ever going to produce a useful response
     # @return [true,false] Whether the feature is on (true) or off (false) for this actor
-    def feature_flag_on?(name, id: nil, guid: nil, properties: {})
-      determinate_and_notice(name, id: id, guid: guid, properties: properties) do |feature|
+    def feature_flag_on?(name, id: nil, guid: nil, properties: {}, feature: nil)
+      determinate_and_notice(name, id: id, guid: guid, properties: properties, feature: feature) do |feature|
         feature.feature_flag?
       end
     end
@@ -44,10 +45,11 @@ module Determinator
     # @param :id [#to_s] The id of the actor being determinated for
     # @param :guid [#to_s] The Anonymous id of the actor being determinated for
     # @param :properties [Hash<Symbol,String>] The properties of this actor which will be used for including this actor or not
+    # @param :feature [Feature] The feature to use instead of retrieving one
     # @raise [ArgumentError] When the arguments given to this method aren't ever going to produce a useful response
     # @return [false,String] Returns false, if the actor is not in this experiment, or otherwise the variant name.
-    def which_variant(name, id: nil, guid: nil, properties: {})
-      determinate_and_notice(name, id: id, guid: guid, properties: properties) do |feature|
+    def which_variant(name, id: nil, guid: nil, properties: {}, feature: nil)
+      determinate_and_notice(name, id: id, guid: guid, properties: properties, feature: feature) do |feature|
         feature.experiment?
       end
     end
@@ -58,6 +60,14 @@ module Determinator
       end
     end
 
+    # Uses the retrieval (and a cache if set on the Determinator config) to fetch a feature definition.
+    #
+    # @param name [#to_s] The name of the experiment being checked
+    # @return [Feature, MissingResponse] Returns the Feature object, or MissingResponse if the feature is not found.
+    def retrieve(name)
+      Determinator.with_retrieval_cache(name) { retrieval.retrieve(name) }
+    end
+
     def inspect
       '#<Determinator::Control>'
     end
@@ -66,8 +76,8 @@ module Determinator
 
     Indicators = Struct.new(:rollout, :variant)
 
-    def determinate_and_notice(name, id:, guid:, properties:)
-      feature = Determinator.with_retrieval_cache(name) { retrieval.retrieve(name) }
+    def determinate_and_notice(name, id:, guid:, properties:, feature: nil)
+      feature ||= retrieve(name)
 
       if feature.nil? || feature.is_a?(ErrorResponse) || feature.is_a?(MissingResponse)
         Determinator.notice_missing_feature(name)

data/lib/determinator/feature.rb

@@ -3,9 +3,9 @@ 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, :fixed_determinations, :active, :winning_variant
+    attr_reader :name, :identifier, :bucket_type, :structured_bucket, :variants, :target_groups, :fixed_determinations, :active, :winning_variant
 
-    def initialize(name:, identifier:, bucket_type:, target_groups:, fixed_determinations: [], variants: {}, overrides: {}, active: false, winning_variant: nil)
+    def initialize(name:, identifier:, bucket_type:, target_groups:, structured_bucket: nil, fixed_determinations: [], variants: {}, overrides: {}, active: false, winning_variant: nil)
       @name = name.to_s
       @identifier = identifier.to_s
       @variants = variants
@@ -14,6 +14,7 @@ module Determinator
       @winning_variant = parse_outcome(winning_variant, allow_exclusion: false)
       @active = active
       @bucket_type = bucket_type.to_sym
+      @structured_bucket = structured_bucket
 
       # To prevent confusion between actor id data types
       @overrides = overrides.each_with_object({}) do |(identifier, outcome), hash|
@@ -36,6 +37,11 @@ module Determinator
       variants.empty?
     end
 
+    # @return [true,false] Is this feature using structured identification?
+    def structured?
+      !!structured_bucket && !structured_bucket.empty?
+    end
+
     # Is this feature overridden for the given actor id?
     #
     # @return [true,false] Whether this feature is overridden for this actor

data/lib/determinator/serializers/json.rb

@@ -15,6 +15,7 @@ module Determinator
             name:                 obj['name'],
             identifier:           obj['identifier'],
             bucket_type:          obj['bucket_type'],
+            structured_bucket:    obj['structured_bucket'],
             active:               (obj['active'] === true),
             target_groups:        obj['target_groups'],
             fixed_determinations: obj['fixed_determinations'].to_a,

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.5.1'
+  VERSION = '2.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - JP Hastings-Spital
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - jp@deliveroo.co.uk
 executables: []
@@ -234,7 +234,7 @@ homepage: https://github.com/deliveroo/determinator
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -249,8 +249,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.
 test_files: []