promoted-ruby-client 0.1.19 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b8a39c8af4d21ae9987db29f0041e57d54de87da119b799e89091069a0bfbc2
-  data.tar.gz: 7b3932706882a896f330b0bd0a3d05671111e80b97fac4403e355ae30e537750
+  metadata.gz: 280c1b17bece86732743246173338746e1ab9d414b9515bc9fc77c8c598ae319
+  data.tar.gz: 1fed11fd16de69732e6f61d1d1e33b31c812151413a34d881b8dd7aace712daa
 SHA512:
-  metadata.gz: 3146dc2f31afa84fa2b332b1cdb5ca145e7aa51140ae14503a8ca8a4aebc96bb59c4313ee10884b85ba819c930f40f9dd88e7d88454a39a9748b42f3e7d827e5
-  data.tar.gz: 903cb0dca7f83acfa605db3be223833ffebe78d0e530b1e98599ed2b8b15e2b5babffb1e40704789bab45f42f3d8372a46e2263733428da2e9fea90860003cb0
+  metadata.gz: 997ca8c047a62a08b2f5e008184719c3e3f1f1dac45cfbccf41c4f451b8fad3f9a8aab7737e148a6281b4a9600e8c2ff6b8bfe9a269aba417ab7bf21f735fcd3
+  data.tar.gz: 274d3ce469128a6fa7da5fc127b65e9a3e1cc2327b322af5719182f06a37ada713806458c754d2efed6d6a21ad7ab945890541d5e3d1247844b66fa6b3a77a16

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.19)
+    promoted-ruby-client (0.1.23)
       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
@@ -103,6 +107,14 @@ Field Name | Type | Optional? | Description
 ```:height``` | Integer | No | Screen height
 ---
 
+### Screen
+State of the screen including scaling.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:size``` | Size | Yes | Screen size
+```:scale``` | Float | Yes | Current screen scaling factor
+---
+
 ### ClientHints
 Alternative to user-agent strings. See https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/org.ietf/http_client_hints/jsonschema/1-0-0
 Field Name | Type | Optional? | Description
@@ -131,7 +143,6 @@ Field Name | Type | Optional? | Description
 ```:latitude``` | Float | No | Location latitude
 ```:longitude``` | Float | No | Location longitude
 ```:accuracy_in_meters``` | Integer | Yes | Location accuracy if available
-```:client_hints``` | ClientHints | Yes | HTTP client hints structure
 ---
 
 ### Browser
@@ -140,7 +151,7 @@ Field Name | Type | Optional? | Description
 ---------- | ---- | --------- | -----------
 ```:user_agent``` | String | Yes | Browser user agent string
 ```:viewport_size``` | Size | Yes | Size of the browser viewport
-```:
+```:client_hints``` | ClientHints | Yes | HTTP client hints structure
 ---
 ### Device
 Information about the user's device.

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.19.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.23.gem`
 6. Update README with new version.

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

@@ -11,13 +11,13 @@ module Promoted
         end
         
         class Pager
-            def validate_paging (insertions, paging)
+            def validate_paging(insertions, paging)
               if paging && paging[:offset] && paging[:offset] >= insertions.length
                 raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, offset #{paging[:offset]})", [])
               end
             end
 
-            def apply_paging (insertions, insertion_page_type, paging = nil)
+            def apply_paging(insertions, insertion_page_type, paging = nil)
               begin
                 validate_paging(insertions, paging)
               rescue InvalidPagingError => err
@@ -47,7 +47,7 @@ module Promoted
                 size = insertions.length
               end
 
-              final_insertion_size = [size, insertions.length].min
+              final_insertion_size = [size, insertions.length - index].min
               insertion_page = Array.new(final_insertion_size)
               0.upto(final_insertion_size - 1) {|i|
                 insertion = insertions[index]
@@ -63,5 +63,5 @@ module Promoted
             end
         end
       end
-   end
+    end
 end

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,
@@ -78,7 +78,7 @@ module Promoted
         # to the responses.
         def fill_details_from_response response_insertions
           if !response_insertions then
-            response_insertions = full_insertion
+            response_insertions = []
           end
 
           props = @full_insertion.each_with_object({}) do |insertion, hash|
@@ -104,8 +104,13 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info,
-            device: @device
+            client_info: merge_client_info_defaults,
+            device: @device,
+            delivery_log: [{
+              execution: {
+                execution_server: Promoted::Ruby::Client::EXECUTION_SERVER['SDK']
+              }
+            }]
           }
 
           if @experiment
@@ -115,12 +120,16 @@ module Promoted
           # Log request allows for multiple requests but here we only send one.
           if include_request
             request[:request_id] = request[:request_id] || @id_generator.newID
-            params[:request] = [request]
+            # Set request on delivery log.
+            params[:delivery_log][0][:request] = request
           end
 
           if include_insertions
-            params[:insertion] = compact_metrics_properties if include_insertions
-            add_missing_ids_on_insertions! request, params[:insertion]
+            # Add a response containing compacted insertions to delivery log.
+            params[:delivery_log][0][:response] = {
+              insertion: compact_metrics_properties
+            }
+            add_missing_ids_on_insertions! request, params[:delivery_log][0][:response][:insertion]
           end
           
           params.clean!
@@ -178,7 +187,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 +195,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.19"
+      VERSION = "0.1.23"
     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
         
@@ -39,7 +40,7 @@ module Promoted
 
         ##
         # Create and configure a new Promoted client.
-        def initialize (params={})
+        def initialize(params={})
           @perform_checks = true
           if params[:perform_checks] != nil
             @perform_checks = params[:perform_checks]
@@ -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,17 +177,20 @@ 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
@@ -266,6 +274,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.
@@ -318,7 +334,7 @@ module Promoted
 
             ellapsed_time = Time.now - start_time
             @logger.debug("Sync send_request completed in #{ellapsed_time.to_f * 1000} ms") if @logger
-        end
+          end
 
           return resp
         end
@@ -357,7 +373,7 @@ module Promoted
           
           if !@async_shadow_traffic
             ellapsed_time = Time.now - start_time
-            insertions = response ? response[:insertion] : []
+            insertions = response && response[:insertion] || []
             @logger.info("Shadow traffic call completed in #{ellapsed_time.to_f * 1000} ms with #{insertions.length} insertions") if @logger
           end
         end

data/promoted-ruby-client.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/promotedai/promoted-ruby-client'
   spec.license       = 'MIT'
 
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/promotedai/promoted-ruby-client"
   spec.metadata["changelog_uri"] = "https://github.com/promotedai/promoted-ruby-client/blob/master/CHANGELOG.md"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.23
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,6 +150,7 @@ homepage: https://github.com/promotedai/promoted-ruby-client
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/promotedai/promoted-ruby-client
   source_code_uri: https://github.com/promotedai/promoted-ruby-client
   changelog_uri: https://github.com/promotedai/promoted-ruby-client/blob/master/CHANGELOG.md
@@ -168,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.