promoted-ruby-client 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4d336aef96b116acbe2e611279e9ccefe5efce88063d5c530fb669b32383d10
-  data.tar.gz: 6df512d099b5a5b9414b2672847585db2118825b87c178b923da26ba2cb610e8
+  metadata.gz: 3b71559ca253efcd620dbbc41ccd95dc17f479a4d9efe3241565038edee43acb
+  data.tar.gz: cfb8da8803830124ea5c6147d83150c05d14068518b0d45285528096925a62a3
 SHA512:
-  metadata.gz: 7375f08d88303d6de8eefaf3a4b7e2b80333f15e8b709781c4884aee54d84c9d64b6bdc834c4a5c53f1f426a04a5aed9752cc7ceba78d6015f100d7ee6096e0c
-  data.tar.gz: 2cdff05db0a989331ca56e0f18716f53e635ea7d000d685275693b21445a313763e2001827b201ec2863173eb52f54744b50177f824ae7a0d44a85f975105e5e
+  metadata.gz: 20717e1151bb52bb1917456ee22a8e73382b7e8ca0fb33d1aad73f2150e3533837b5ce0c20464a65d1988398be27218af2884eb16227a1a8660a47c600f4d220
+  data.tar.gz: 8d4dff6877a2d28dca45c17116292ef6a2c78e2f6e78b4a255b52c1f3c1aab5fb7daaa62d80655f2e6c90527eff44840f27fe85aef04ac85938710f7ef9a738d

data/Gemfile.lock

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

data/dev.md

@@ -11,4 +11,4 @@ bundle exec rspec
 3. Modify `promoted-ruby-client.gemspec`'s push block.
 4. Run `gem build promoted-ruby-client.gemspec` to generate `gem`.
 5. Run `bundle exec rspec`.  This updates `Gemfile.lock`.
-6. Run (using new output) `gem push promoted-ruby-client-4.0.0.gem`
+6. Run (using new output) `gem push promoted-ruby-client-5.0.0.gem`

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

@@ -13,24 +13,28 @@ module Promoted
         class Pager
             def validate_paging(insertions, retrieval_insertion_offset, paging)
               if paging && paging[:offset]
-                offset = [0, paging[:offset]].max
-                if offset >= insertions.length
-                  raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, offset #{offset})", [])
-                end
-                if offset < retrieval_insertion_offset
-                  raise InvalidPagingError.new("Invalid page offset (retrieval_insertion_offset #{retrieval_insertion_offset}, offset #{offset})", [])
-                end
+                offset, retrieval_insertion_offset, index = _sanitize_offsets(retrieval_insertion_offset, paging)
+                _validate_paging(insertions, retrieval_insertion_offset, offset, index)
               end
             end
 
-            def apply_paging(insertions, retrieval_insertion_offset, paging = nil)
-              begin
-                validate_paging(insertions, retrieval_insertion_offset, paging)
-              rescue InvalidPagingError => err
-                # This is invalid input, stop it before it goes to the server.
-                return err.default_insertions_page
+            def _sanitize_offsets(retrieval_insertion_offset, paging)
+              offset = [0, paging[:offset]].max
+              retrieval_insertion_offset = [0, retrieval_insertion_offset].max
+              index = [0, offset - retrieval_insertion_offset].max
+              return [offset, retrieval_insertion_offset, index]
+            end
+
+            def _validate_paging(insertions, retrieval_insertion_offset, offset, index)
+              if offset < retrieval_insertion_offset
+                raise InvalidPagingError.new("Invalid page offset (retrieval_insertion_offset #{retrieval_insertion_offset}, offset #{offset})", [])
+              end
+              if index >= insertions.length
+                raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, index #{index})", [])
               end
+            end
 
+            def apply_paging(insertions, retrieval_insertion_offset, paging = nil)
               if !paging
                 paging = {
                   :offset => 0,
@@ -38,9 +42,14 @@ module Promoted
                 }
               end
 
-              offset = [0, paging[:offset]].max
-              retrieval_insertion_offset = [0, retrieval_insertion_offset].max
-              index = [0, offset - retrieval_insertion_offset].max
+              offset, retrieval_insertion_offset, index = _sanitize_offsets(retrieval_insertion_offset, paging)
+
+              begin
+                _validate_paging(insertions, retrieval_insertion_offset, offset, index)
+              rescue InvalidPagingError => err
+                # This is invalid input, stop it before it goes to the server.
+                return err.default_insertions_page
+              end
 
               size = paging[:size]
               if size <= 0

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

@@ -135,7 +135,7 @@ module Promoted
             end
 
             # TODO - delete?
-            def validate_metrics_request!(metrics_req)
+            def validate_delivery_args!(metrics_req)
                 validate_fields!(
                     metrics_req,
                     "metrics request",
@@ -143,6 +143,10 @@ module Promoted
                         {
                             :name => :request,
                             :required => true
+                        },
+                        {
+                            :name => :retrieval_insertion_offset,
+                            :type => Integer
                         }
                     ]
                 )

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

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "4.0.0"
+      VERSION = "5.0.0"
       SERVER_VERSION = "rb." + VERSION
     end
   end

data/lib/promoted/ruby/client.rb

@@ -54,7 +54,6 @@ module Promoted
 
           @sampler = Sampler.new
           @pager   = Pager.new
-          @retrieval_insertion_offset = params[:retrieval_insertion_offset] || 0
 
           # HTTP Client creation
           @delivery_endpoint = params[:delivery_endpoint] || DEFAULT_DELIVERY_ENDPOINT
@@ -116,11 +115,12 @@ module Promoted
         # Make a delivery request. If @perform_checks is set, input validation will occur and possibly raise errors.
         def deliver args, headers={}
           args = Promoted::Ruby::Client::Util.translate_hash(args)
+          retrieval_insertion_offset = args[:retrieval_insertion_offset] || 0
 
           # Respect the enabled state
           if !@enabled
             return {
-              insertion: @pager.apply_paging(args[:request][:insertion], @retrieval_insertion_offset, args[:request][:paging])
+              insertion: @pager.apply_paging(args[:request][:insertion], retrieval_insertion_offset, args[:request][:paging])
               # No log request returned when disabled
             }
           end
@@ -152,7 +152,7 @@ module Promoted
           end
 
           begin
-            @pager.validate_paging(delivery_request_builder.insertion, @retrieval_insertion_offset, delivery_request_builder.request[:paging])
+            @pager.validate_paging(delivery_request_builder.insertion, retrieval_insertion_offset, delivery_request_builder.request[:paging])
           rescue InvalidPagingError => err
             # Invalid input, log and do SDK-side delivery.
             @logger.warn(err) if @logger
@@ -194,7 +194,7 @@ module Promoted
           end
 
           if !insertions_from_delivery then
-            response_insertions = build_sdk_response_insertions(delivery_request_builder)
+            response_insertions = build_sdk_response_insertions(delivery_request_builder, retrieval_insertion_offset)
           end
 
           log_req = nil
@@ -239,8 +239,8 @@ module Promoted
 
         ##
         # 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.insertion, @retrieval_insertion_offset, delivery_request_builder.request[:paging])
+        def build_sdk_response_insertions delivery_request_builder, retrieval_insertion_offset
+          response_insertions = @pager.apply_paging(delivery_request_builder.insertion, retrieval_insertion_offset, delivery_request_builder.request[:paging])
           delivery_request_builder.add_missing_insertion_ids! response_insertions
           return response_insertions
         end
@@ -317,7 +317,7 @@ module Promoted
           delivery_request_params[:client_info][:traffic_type] = Promoted::Ruby::Client::TRAFFIC_TYPE['SHADOW']
 
           begin
-            @pager.validate_paging(delivery_request_builder.insertion, @retrieval_insertion_offset, delivery_request_builder.request[:paging])
+            @pager.validate_paging(delivery_request_builder.insertion, args[:retrieval_insertion_offset], delivery_request_builder.request[:paging])
           rescue InvalidPagingError => err
             # Invalid input, log and skip.
             @logger.warn("Shadow traffic call failed with invalid paging #{err}") if @logger
@@ -344,11 +344,11 @@ module Promoted
           end
         end
 
-        def perform_common_checks!(req)
+        def perform_common_checks!(delivery_args)
           begin
-            @validator.check_that_log_ids_not_set!(req)
-            @validator.validate_metrics_request!(req)
-            @validator.check_that_content_ids_are_set!(req)
+            @validator.check_that_log_ids_not_set!(delivery_args)
+            @validator.validate_delivery_args!(delivery_args)
+            @validator.check_that_content_ids_are_set!(delivery_args)
           rescue StandardError => err
             @logger.error(err) if @logger
             raise

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - scottmcmaster
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday