promoted-ruby-client 4.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2581fc859bd3a30b8460858e6ab95ef4be27724f60ac02cff4e15c4579ea833
-  data.tar.gz: e87f89c047284f62cdd8d1975aae5c464e096f32c752352f5d83820b8e922ea4
+  metadata.gz: 75cb9761bd46c2497a74d1b104a9ae72e6014602978c76b39a7c0e8a59d1111b
+  data.tar.gz: 75b51adb56686b1d8e9df918185d411aba0c32612de929d5b5638f61c1ca9c6b
 SHA512:
-  metadata.gz: 98361d750d5bf3605b4acda0c974be206ae115fa973f8d4e57d723874d2fed40eb86b4f635ce22a502c5faf36e1e6ee12456f95b9d4fc8a5e763a0747393a20e
-  data.tar.gz: ebf6134571b25c908d9dba394286a31564517d0218d3d97975e5965a85d3607c91ff37f191cbb8d1dd2942bd9c47209cbb56315bd7ea3a4e92c92d5313220b36
+  metadata.gz: 716af4d67d23ad9476d0df49bb5c94763940b4e8cb1e819c02ee3b1382742ee9fe474073697d033e9366aa3286339a17f2b9b417c76f721821727eaaa59d76ef
+  data.tar.gz: 8e3871f4861bd47478c98c345336c8416609450e06f61fb604111ad3310cf84a8842f1acad0bc9f7fb2e33fe6b787fb7e7a2ce8d952599b4732e537c08d08820

data/Gemfile.lock

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

data/README.md

@@ -65,6 +65,7 @@ Field Name | Type | Optional? | Description
 ```:user_id``` | String | Yes | The platform user id, cleared from Promoted logs.
 ```:anon_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.
+```:ignore_usage``` | Boolean | Yes | If you want to ignore usage from this user, defaults to false.
 
 ---
 ### CohortMembership

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.1.gem`
+6. Run (using new output) `gem push promoted-ruby-client-5.1.0.gem`

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

@@ -18,6 +18,10 @@ module Promoted
                         {
                             :name => :is_internal_user,
                             :type => [TrueClass, FalseClass]
+                        },
+                        {
+                            :name => :ignore_usage,
+                            :type => [TrueClass, FalseClass]
                         }
                     ]
                 )
@@ -135,7 +139,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 +147,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.1"
+      VERSION = "5.1.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.1
+  version: 5.1.0
 platform: ruby
 authors:
 - scottmcmaster
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday