promoted-ruby-client 0.1.20 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340cf31fbc7680c1b9abb8df8dd1226e4a13fed103e21815afb82fb43b85f481
-  data.tar.gz: d5448efcb375ac090847ac6c37fcda3b57babf0dca6043d82967e8ecdb42ae52
+  metadata.gz: 99f637dce3d3f85f13e8937bf586e6e9f5a11891b262e84a6e66d57a44bc6b09
+  data.tar.gz: 0c517b9e7b0049c6ae873c90db9536eae6b153367114cc50af887f36efcf79f2
 SHA512:
-  metadata.gz: df18a2f73308fd9771b55a8762592a4041059b5d5fe72e0de07fa9566eb8627647eef75276a401c6f9da7d03bfc7158deb94bfd6b5824d22635a22b7d11848f0
-  data.tar.gz: 7ed68c19270dcd13b8ed2347138aa845dd767d19bc257312e1a001f0e858879e75186142b9719b31e9c132d95fc7d48049baaf3e57b442f39f2b969cf2c835b8
+  metadata.gz: 640878d97d82424619a60ebf451db0f1501d15e625adfc2c53f3a47511e2661cb4d61bc8788d5b42f93c11f778411bc3bad59d5bab3fd787270a9b015f9968c3
+  data.tar.gz: e4a99864846f7d542e773d84897f9ce3ff9db842115d0ebd835f604a7763bebfa7c875656377e22f57442637f71a7d0663b098379e2603c5b6852f9696e626ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.20)
+    promoted-ruby-client (0.1.24)
       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.
@@ -62,6 +63,7 @@ Field Name | Type | Optional? | Description
 ---------- | ---- | --------- | -----------
 ```:user_id``` | String | Yes | The platform user id, cleared from Promoted logs.
 ```:log_user_id``` | String | Yes | A different user id (presumably a UUID) disconnected from the platform user id, good for working with unauthenticated users or implementing right-to-be-forgotten.
+```:is_internal_user``` | Boolean | Yes | If this user is a test user or not, defaults to false.
 
 ---
 ### CohortMembership
@@ -93,6 +95,8 @@ Field Name | Type | Optional? | Description
 ```:insertion_id``` | String | Yes | Generated by the SDK (*do not set*)
 ```:request_id``` | String | Yes | Generated by the SDK when needed (*do not set*)
 ```:content_id``` | String | No | Identifier for the content to be shown, must be set.
+```:retrieval_rank``` | Number | Yes | Optional original ranking of this content item.
+```:retrieval_score``` | Number | Yes | Optional original quality score of this content item.
 ```:properties``` | Properties | Yes | Any additional custom properties to associate. For v1 integrations, it is fine not to fill in all the properties.
 ---
 ### Size

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.24.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,
@@ -100,12 +100,12 @@ module Promoted
           filled_in_copy
         end
 
-        def log_request_params(include_insertions: true, include_request: true)
+        def log_request_params(include_delivery_log:, exec_server:)
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info,
-            device: @device
+            client_info: merge_client_info_defaults,
+            device: @device,
           }
 
           if @experiment
@@ -113,14 +113,20 @@ module Promoted
           end
 
           # Log request allows for multiple requests but here we only send one.
-          if include_request
+          if include_delivery_log
             request[:request_id] = request[:request_id] || @id_generator.newID
-            params[:request] = [request]
-          end
 
-          if include_insertions
-            params[:insertion] = compact_metrics_properties if include_insertions
-            add_missing_ids_on_insertions! request, params[:insertion]
+            params[:delivery_log] = [{
+              execution: {
+                execution_server: exec_server
+              },
+              request: request,
+              response: {
+                insertion: insertions_with_compact_metrics_properties
+              }
+            }]
+
+            add_missing_ids_on_insertions! request, params[:delivery_log][0][:response][:insertion]
           end
           
           params.clean!
@@ -161,7 +167,7 @@ module Promoted
         end
 
         # TODO: This looks overly complicated.
-        def compact_metrics_properties
+        def insertions_with_compact_metrics_properties
           @insertion            = [] # insertion should be set according to the compact insertion
           paging                = request[:paging] || {}
           size                  = paging[:size] ? paging[:size].to_i : 0
@@ -178,7 +184,6 @@ module Promoted
             insertion_obj                = Hash[insertion_obj]
             insertion_obj[:user_info]    = user_info
             insertion_obj[:timing]       = timing
-            insertion_obj[:insertion_id] = @id_generator.newID
             insertion_obj[:request_id]   = request_id
             insertion_obj[:position]     = offset + index
             insertion_obj                = compact_one_insertion(insertion_obj, @to_compact_metrics_properties_func)
@@ -187,18 +192,31 @@ module Promoted
           @insertion
         end
 
+        def add_missing_insertion_ids! insertions
+          insertions.each do |insertion|
+            insertion[:insertion_id] = @id_generator.newID if not insertion[:insertion_id]
+          end
+        end
+
         def client_request_id
           request[:client_request_id]
         end
 
         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]
             insertion[:session_id] = request[:session_id] if request[:session_id]
             insertion[:request_id] = request[:request_id] if request[:request_id]
           end
+          add_missing_insertion_ids! insertions
         end
 
         # A list of the response Insertions.  This client expects lists to be truncated

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

@@ -14,6 +14,10 @@ module Promoted
                         {
                             :name => :log_user_id,
                             :type => String
+                        },
+                        {
+                            :name => :is_internal_user,
+                            :type => [TrueClass, FalseClass]
                         }
                     ]
                 )
@@ -55,6 +59,14 @@ module Promoted
                         {
                             :name => :delivery_score,
                             :type => Integer
+                        },
+                        {
+                            :name => :retrieval_rank,
+                            :type => Integer
+                        },
+                        {
+                            :name => :retrieval_score,
+                            :type => Float
                         }
                     ]
                 )
@@ -133,7 +145,6 @@ module Promoted
                 req[:full_insertion].each do |insertion_hash|
                   raise ValidationError.new("Insertion.requestId should not be set") if insertion_hash[:request_id]
                   raise ValidationError.new("'Insertion.insertionId should not be set") if insertion_hash[:insertion_id]
-                  raise ValidationError.new("Insertion.deliveryScore should not be set") if insertion_hash[:delivery_score]
                 end
             end
             
@@ -147,7 +158,11 @@ module Promoted
 
                     # If a field is provided as non-nil, it should be of the correct type.
                     if field[:type] && obj.has_key?(field[:name]) && obj[field[:name]] != nil then
-                        raise ValidationError.new(field[:name].to_s + " should be a " + field[:type].to_s) if !obj[field[:name]].is_a?(field[:type])
+                        if field[:type].is_a?(Array) then
+                            raise ValidationError.new(field[:name].to_s + " should be one of " + field[:type].to_s) if !field[:type].include?(obj[field[:name]].class)
+                        else
+                            raise ValidationError.new(field[:name].to_s + " should be a " + field[:type].to_s) if !obj[field[:name]].is_a?(field[:type])
+                        end
                     end
                 }
             end

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

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.20"
+      VERSION = "0.1.24"
     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,20 +177,25 @@ 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
           if !insertions_from_delivery then
             request_to_log = delivery_request_builder.request
-            response_insertions = @pager.apply_paging(delivery_request_builder.full_insertion, Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'], delivery_request_builder.request[:paging])
+            response_insertions = build_sdk_response_insertions(delivery_request_builder)
           end
 
           log_req = nil
+          exec_server = (insertions_from_delivery ? Promoted::Ruby::Client::EXECUTION_SERVER['API'] : Promoted::Ruby::Client::EXECUTION_SERVER['SDK'])
+          
           # We only return a log request if there's a request or cohort to log.
           if request_to_log || cohort_membership_to_log
             log_request_builder = RequestBuilder.new
@@ -204,14 +214,14 @@ module Promoted
             # On a successful delivery request, we don't log the insertions
             # or the request since they are logged on the server-side.
             log_req = log_request_builder.log_request_params(
-              include_insertions: !insertions_from_delivery, 
-              include_request: !insertions_from_delivery)
+              include_delivery_log: !insertions_from_delivery, 
+              exec_server: exec_server)
           end
 
           client_response = {
             insertion: response_insertions,
             log_request: log_req,
-            execution_server: insertions_from_delivery ? Promoted::Ruby::Client::EXECUTION_SERVER['API'] : Promoted::Ruby::Client::EXECUTION_SERVER['SDK'],
+            execution_server: exec_server,
             client_request_id: delivery_request_builder.client_request_id
           }
           return client_response
@@ -250,7 +260,9 @@ module Promoted
             deliver_shadow_traffic args, headers
           end
 
-          log_request_builder.log_request_params
+          log_request_builder.log_request_params(
+            include_delivery_log: true, 
+            exec_server: Promoted::Ruby::Client::EXECUTION_SERVER['SDK'])
         end
 
         ##
@@ -266,6 +278,14 @@ module Promoted
 
         private
 
+        ##
+        # Creates response insertions for SDK-side delivery, when we don't get response insertions from Delivery API.
+        def build_sdk_response_insertions delivery_request_builder
+          response_insertions = @pager.apply_paging(delivery_request_builder.full_insertion, Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'], delivery_request_builder.request[:paging])
+          delivery_request_builder.add_missing_insertion_ids! response_insertions
+          return response_insertions
+        end
+        
         def do_warmup
           if !@delivery_endpoint
             # Warmup only supported when delivery is enabled.

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.24
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby Client to contact Promoted APIs.