promoted-ruby-client 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 526e2104c5f4658b67b971a1a2f19639ea383ddcee8556dd496c906c7aed8d86
-  data.tar.gz: f3e6afce46a2995b8497f8426d7fcccda89e9a0c533d270a55dd72598c6a0287
+  metadata.gz: e4cc088a08f160f3a238022f030e042df9a583fdbe22310b007027a9b908b406
+  data.tar.gz: 3b9434274cef7986cceea4876170b9061d873bfa533f0047adff546fd1f20d77
 SHA512:
-  metadata.gz: c3b5e39490f8ceac8c261cfd6a7b3c9264980b98306bf7ac520fcc4f4855600329f43fc1eee55a22f4c8968c1d44eaa1ae47fa1ed737d61fbce6b8e5064eabb8
-  data.tar.gz: 94fe93237603bc0be26b54a5a7ecbd39f45065d2e878610e240079a946ecde5697b39894a6c7b2fd2817b51fdc60462d5edc66c279be3038e79618e14c9e6deb
+  metadata.gz: b9b3a44c22c7bbbb632024b21aa6062253f2cd9e6f3cba73f015eccb1f4fa3a91bfc14cfdabee57a64510ae53a16fe2f01e30f645002b1dc40ea511f8854e54b
+  data.tar.gz: d20bb330c762ea83cf75246a256a20d250d1d3b0e2b1af7fa7ca8d2f5840671505a10584c2d8c3f30fa040daf7d10bbdcd5859454dd822c7898b711e300257eb

data/Gemfile.lock

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

data/README.md

@@ -63,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
@@ -94,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.21.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.22.gem`
 6. Update README with new version.

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

@@ -178,7 +178,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,6 +186,12 @@ 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
@@ -202,10 +207,10 @@ module Promoted
         
         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]
                         }
                     ]
                 )
@@ -133,7 +137,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 +150,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.21"
+      VERSION = "0.1.22"
     end
   end
 end

data/lib/promoted/ruby/client.rb

@@ -190,7 +190,7 @@ module Promoted
           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
@@ -274,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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-13 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.