promoted-ruby-client 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340cf31fbc7680c1b9abb8df8dd1226e4a13fed103e21815afb82fb43b85f481
-  data.tar.gz: d5448efcb375ac090847ac6c37fcda3b57babf0dca6043d82967e8ecdb42ae52
+  metadata.gz: 526e2104c5f4658b67b971a1a2f19639ea383ddcee8556dd496c906c7aed8d86
+  data.tar.gz: f3e6afce46a2995b8497f8426d7fcccda89e9a0c533d270a55dd72598c6a0287
 SHA512:
-  metadata.gz: df18a2f73308fd9771b55a8762592a4041059b5d5fe72e0de07fa9566eb8627647eef75276a401c6f9da7d03bfc7158deb94bfd6b5824d22635a22b7d11848f0
-  data.tar.gz: 7ed68c19270dcd13b8ed2347138aa845dd767d19bc257312e1a001f0e858879e75186142b9719b31e9c132d95fc7d48049baaf3e57b442f39f2b969cf2c835b8
+  metadata.gz: c3b5e39490f8ceac8c261cfd6a7b3c9264980b98306bf7ac520fcc4f4855600329f43fc1eee55a22f4c8968c1d44eaa1ae47fa1ed737d61fbce6b8e5064eabb8
+  data.tar.gz: 94fe93237603bc0be26b54a5a7ecbd39f45065d2e878610e240079a946ecde5697b39894a6c7b2fd2817b51fdc60462d5edc66c279be3038e79618e14c9e6deb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.20)
+    promoted-ruby-client (0.1.21)
       concurrent-ruby (~> 1)
       faraday (>= 0.9.0)
       faraday_middleware (>= 0.9.0)

data/README.md

@@ -49,6 +49,7 @@ Name | Type | Description
 ```:perform_checks``` | Boolean | Whether or not to perform detailed input validation, defaults to true but may be disabled for performance
 ```:logger``` | Ruby Logger-compatible logger | Defaults to nil (no logging). Example: ```Logger.new(STDERR, :progname => 'promotedai')```
 ```:shadow_traffic_delivery_percent``` | Number between 0 and 1 | % of ```prepare_for_logging``` traffic that gets directed to Delivery API as "shadow traffic". Defaults to 0 (no shadow traffic).
+```:send_shadow_traffic_for_control``` | Boolean | If true, the ```deliver``` method will send shadow traffic for users in the CONTROL arm of an experiment. Defaults to true.
 ```:default_request_headers``` | Hash | Additional headers to send on the request beyond ```x-api-key```. Defaults to {}
 ```:default_only_log``` | Boolean | If true, the ```deliver``` method will not direct traffic to Delivery API but rather return a request suitable for logging. Defaults to false.
 ```:should_apply_treatment_func``` | Proc | Called during delivery, accepts an experiment and returns a Boolean indicating whether the request should be considered part of the control group (false) or in the experiment (true). If nil, the default behavior of checking the experiement ```:arm``` is applied.

data/dev.md

@@ -4,5 +4,5 @@
 2. Get credentials for deployment from 1password.
 3. Modify `promoted-ruby-client.gemspec`'s push block.
 4. Run `gem build promoted-ruby-client.gemspec` to generate `gem`.
-5. Run (using new output) `gem push promoted-ruby-client-0.1.20.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.21.gem`
 6. Update README with new version.

data/lib/promoted/ruby/client/request_builder.rb

@@ -57,7 +57,7 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info.merge({ :client_type => Promoted::Ruby::Client::CLIENT_TYPE['PLATFORM_SERVER'] }),
+            client_info: merge_client_info_defaults,
             device: @device,
             platform_id: @platform_id,
             view_id: @view_id,
@@ -104,7 +104,7 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info,
+            client_info: merge_client_info_defaults,
             device: @device
           }
 
@@ -193,6 +193,13 @@ module Promoted
 
         private
 
+        def merge_client_info_defaults
+          return @client_info.merge({
+            :client_type => Promoted::Ruby::Client::CLIENT_TYPE['PLATFORM_SERVER'],
+            :traffic_type => Promoted::Ruby::Client::TRAFFIC_TYPE['PRODUCTION']
+          })
+        end
+        
         def add_missing_ids_on_insertions! request, insertions
           insertions.each do |insertion|
             insertion[:insertion_id] = @id_generator.newID if not insertion[:insertion_id]

data/lib/promoted/ruby/client/version.rb

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.20"
+      VERSION = "0.1.21"
     end
   end
 end

data/lib/promoted/ruby/client.rb

@@ -19,7 +19,8 @@ module Promoted
         class Error < StandardError; end
 
         attr_reader :perform_checks, :default_only_log, :delivery_timeout_millis, :metrics_timeout_millis, :should_apply_treatment_func,
-                    :default_request_headers, :http_client, :logger, :shadow_traffic_delivery_percent, :async_shadow_traffic
+                    :default_request_headers, :http_client, :logger, :shadow_traffic_delivery_percent, :async_shadow_traffic,
+                    :send_shadow_traffic_for_control
                     
         attr_accessor :request_logging_on, :enabled
         
@@ -79,6 +80,11 @@ module Promoted
             @async_shadow_traffic = params[:async_shadow_traffic] || false
           end
 
+          @send_shadow_traffic_for_control = true
+          if params[:send_shadow_traffic_for_control] != nil
+            @send_shadow_traffic_for_control = params[:send_shadow_traffic_for_control] || false
+          end
+
           @pool = nil
           if @async_shadow_traffic
             # Thread pool to process delivery of shadow traffic. Will silently drop excess requests beyond the queue
@@ -161,9 +167,8 @@ module Promoted
             cohort_membership_to_log = delivery_request_builder.new_cohort_membership_to_log
 
             if should_apply_treatment(cohort_membership_to_log)
-              delivery_request_params = delivery_request_builder.delivery_request_params
-  
-              # Call Delivery API
+              # Call Delivery API to get insertions to use
+              delivery_request_params = delivery_request_builder.delivery_request_params  
               begin
                 response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers)
               rescue  StandardError => err
@@ -172,11 +177,14 @@ module Promoted
                 deliver_err = true
                 @logger.error("Error calling delivery: " + err.message) if @logger
               end
-              
-              insertions_from_delivery = (response != nil && !deliver_err);
-              response_insertions = delivery_request_builder.fill_details_from_response(
-                response && response[:insertion] || [])
+            elsif @send_shadow_traffic_for_control
+              # Call Delivery API to send shadow traffic. This will create the request params with traffic type set.
+              deliver_shadow_traffic args, headers
             end
+
+            insertions_from_delivery = (response != nil && !deliver_err);
+            response_insertions = delivery_request_builder.fill_details_from_response(
+              response && response[:insertion] || [])
           end
   
           request_to_log = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday