promoted-ruby-client 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f9ec2c51749dd3819e71b93784a0eea77f4f11b0117ad21c44ae976a2b1d96
-  data.tar.gz: a507c5f00b3e3cfc8116c67f2413f51e6a9b45827f991ad44953c36b5c44b453
+  metadata.gz: e743a5f01479b23e4e68d12262e93549d58a11540c0cf448fe4316c277422373
+  data.tar.gz: 65b9c38eab75a844783f3595c05bd1ea6f1f668596f46be2ecd3e370b61a551f
 SHA512:
-  metadata.gz: 580f2c7e11d8cc30e1c2d23f2c0b57f311597af695d0179a4d32149d1e4e3723d122e8f2783ce4e1e9b0d09374779a029091106c10612920b7d0c5e942b35ebe
-  data.tar.gz: 3a75185fe166e28b551eb82fd7cbcb51cf92c1fb8fdf7a1266bbb46715fd8d190ef9df75da5ab438991dde5352c4802abd8d3ee68abf27400aa58ca40037cb8e
+  metadata.gz: 68c1e692e7e5af9a3deb344fde3cbc0049e8aa6f775d524bc0a6196646e9736cbfdb269fedf4ae83a07ad24cdab94c7140e555709bf046d72530e2f151c252e1
+  data.tar.gz: d0ef6502f473fb279a5a1379234c88f1263d7448d66e7d56cc65794d9d6692826f86e8d4934a69f80aececdf8752c993c96044f9b4146bc02d8721ae2d9dc626

data/Gemfile.lock

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

data/README.md

@@ -205,7 +205,7 @@ Field Name | Type | Optional? | Description
 Output of ```deliver```, includes the insertions as well as a suitable ```LogRequest``` for forwarding to Metrics API.
 Field Name | Type | Optional? | Description
 ---------- | ---- | --------- | -----------
-```:insertion``` | [] of Insertion | No | The insertions, which are from Delivery API (when ```deliver``` was called, i.e. we weren't either only-log or part of an experiment) or the input insertions (when the other conditions don't hold).
+```:insertion``` | [] of Insertion | No | The paged insertions, which are from Delivery API (when ```deliver``` was called, i.e. we weren't either only-log or part of an experiment) or the input insertions (when the other conditions don't hold).
 ```:log_request``` | LogRequest | Yes | A message suitable for logging to Metrics API via ```send_log_request```. If the call to ```deliver``` was made (i.e. the request was not part of the CONTROL arm of an experiment or marked to only log), ```:log_request``` will not be set, as you can assume logging was performed on the server-side by Promoted.
 ```:client_request_id``` | String | Yes | Client-generated request id sent to Delivery API and may be useful for logging and debugging.
 ```:execution_server``` | one of 'API' or 'SDK' | Yes | Indicates if response insertions on a delivery request came from the API or the SDK.

data/dev.md

@@ -1,8 +1,14 @@
+# Run tests
+
+```
+bundle exec rspec
+```
+
 # Deploy
 
 1. Update version number.
 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-1.0.0.gem`
+5. Run (using new output) `gem push promoted-ruby-client-2.0.0.gem`
 6. Update README with new version.

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

@@ -0,0 +1,61 @@
+module Promoted
+  module Ruby
+    module Client
+      class LogRequestBuilder
+        attr_reader :request, :response_insertions, :experiment
+        attr_accessor :request, :response_insertions, :experiment
+
+        def initialize args = {}
+          if args[:id_generator]
+            @id_generator = args[:id_generator]
+          else
+            @id_generator = IdGenerator.new
+          end
+        end
+
+        def log_request(include_delivery_log:, exec_server:)
+          log_req = {
+            platform_id: @request[:platform_id],
+            user_info: @request[:user_info],
+            # For now, we'll just use the request timestamp.
+            timing: @request[:timing],
+            client_info: @request[:client_info],
+            device: @request[:device],
+          }
+
+          if @experiment
+            log_req[:cohort_membership] = [@experiment]
+          end
+
+          # Log request allows for multiple requests but here we only send one.
+          if include_delivery_log
+            request[:request_id] = request[:request_id] || @id_generator.newID
+            # Remove redundant fields from `request` since they're already on the LogRequest.
+            stripped_request = @request.clone
+            stripped_request.delete(:platform_id)
+            stripped_request.delete(:user_info)
+            stripped_request.delete(:timing)
+            stripped_request.delete(:device)
+            stripped_request.delete(:client_info)
+
+            log_req[:delivery_log] = [{
+              execution: {
+                execution_server: exec_server,
+                server_version: Promoted::Ruby::Client::SERVER_VERSION
+              },
+              request: stripped_request,
+              response: {
+                insertion: @response_insertions
+              }
+            }]
+          end
+          log_req.clean!
+        end
+      end
+    end
+  end
+end
+
+require "promoted/ruby/client/constants"
+require "promoted/ruby/client/extensions"
+require "promoted/ruby/client/id_generator"

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

@@ -50,11 +50,14 @@ module Promoted
               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]
-                if insertion[:position] == nil
-                  insertion[:position] = offset
-                end
-                insertion_page[i] = insertion
+                request_insertion = insertions[index]
+                # Pager returns response insertions.  Create a copy and fill in some of the fields.
+                response_insertion = Hash[]
+                response_insertion[:content_id] = request_insertion[:content_id]
+                response_insertion[:insertion_id] = request_insertion[:insertion_id]
+                # TODO - implement retrieval_start.
+                response_insertion[:position] = offset
+                insertion_page[i] = response_insertion
                 index = index + 1
                 offset = offset + 1
               }

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

@@ -49,7 +49,6 @@ module Promoted
           return @experiment
         end
 
-        # Only used in delivery
         def delivery_request_params
           params = {
             user_info: user_info,
@@ -70,93 +69,12 @@ module Promoted
           params.clean!
         end
 
-        # Only used in delivery
-        # Maps the response insertions to the full insertions and re-insert the properties bag
-        # to the responses.
-        def fill_details_from_response response_insertions
-          if !response_insertions then
-            response_insertions = []
-          end
-
-          props = @insertion.each_with_object({}) do |insertion, hash|
-            if insertion.has_key?(:properties)
-              # Don't add nil properties to response insertions.
-              hash[insertion[:content_id]] = insertion[:properties]
-            end
-          end
-
-          filled_in_copy = []
-          response_insertions.each do |resp_insertion|
-            copied_insertion = resp_insertion.clone
-            if copied_insertion.has_key?(:content_id) && props.has_key?(copied_insertion[:content_id])
-              copied_insertion[:properties] = props[resp_insertion[:content_id]]
-            end
-            filled_in_copy << copied_insertion
-          end
-
-          filled_in_copy
-        end
-
-        def log_request_params(include_delivery_log:, exec_server:)
-          params = {
-            user_info: user_info,
-            timing: timing,
-            client_info: merge_client_info_defaults,
-            device: @device,
-          }
-
-          if @experiment
-            params[:cohort_membership] = [@experiment]
-          end
-
-          # Log request allows for multiple requests but here we only send one.
-          if include_delivery_log
-            request[:request_id] = request[:request_id] || @id_generator.newID
-
-            params[:delivery_log] = [{
-              execution: {
-                execution_server: exec_server,
-                server_version: Promoted::Ruby::Client::SERVER_VERSION
-              },
-              request: request,
-              response: {
-                insertion: response_insertion
-              }
-            }]
-
-            add_missing_insertion_ids! params[:delivery_log][0][:response][:insertion]            
-          end
-          
-          params.clean!
-        end
-
         def ensure_client_timestamp
           if timing[:client_log_timestamp].nil?
             timing[:client_log_timestamp] = (Time.now.to_f * 1000).to_i
           end
         end
 
-        def response_insertion
-          @response_insertions  = []
-          paging                = request[:paging] || {}
-          size                  = paging[:size] ? paging[:size].to_i : 0
-          if size <= 0
-            size = insertion.length()
-          end
-          offset                = paging[:offset] ? paging[:offset].to_i : 0
-
-          insertion.each_with_index do |insertion_obj, index|
-            # TODO - this does not look performant.
-            break if @response_insertions.length() >= size
-            response_insertion = Hash[]
-            response_insertion[:content_id]   = insertion_obj[:content_id]
-            response_insertion[:position]     = offset + index
-            response_insertion[:insertion_id] = insertion_obj[:insertion_id]
-            @response_insertions << response_insertion.clean!
-          end
-          @response_insertions
-        end
-
         def add_missing_insertion_ids! insertions
           insertions.each do |insertion|
             insertion[:insertion_id] = @id_generator.newID if not insertion[:insertion_id]

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

@@ -31,10 +31,10 @@ module Promoted
                 end
               end
               sym_hash
-              rescue => e
+              rescue
                 raise 'Unable to parse args. Please pass correct arguments. Must be JSON'
-              end      
             end
+        end
       end
-  end
+    end
 end

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

@@ -116,6 +116,24 @@ module Promoted
                 end
             end
 
+            def validate_response!(res)
+                validate_fields!(
+                    res,
+                    "response",
+                    [
+                        {
+                            :name => :request_id,
+                            :required => true,
+                            :type => String
+                        }
+                    ]
+                )
+
+                if !res.key?(:insertion) then
+                    res[:insertion] = []
+                end
+            end
+
             # TODO - delete?
             def validate_metrics_request!(metrics_req)
                 validate_fields!(

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

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

data/lib/promoted/ruby/client.rb

@@ -135,10 +135,10 @@ module Promoted
           if @perform_checks
             perform_common_checks!(args)
             if !only_log && args[:insertion_page_type] == Promoted::Ruby::Client::INSERTION_PAGING_TYPE['PRE_PAGED'] then
-                err = DeliveryInsertionPageType.new
-                @logger.error(err) if @logger
-                raise err
-              end
+              err = DeliveryInsertionPageType.new
+              @logger.error(err) if @logger
+              raise err
+            end
 
             if should_send_shadow_traffic && args[:insertion_page_type] != Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'] then
               should_send_shadow_traffic = false
@@ -179,6 +179,7 @@ module Promoted
               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)
+                @validator.validate_response!(response)
               rescue  StandardError => err
                 # Currently we don't propagate errors to the SDK caller, but rather default to returning
                 # the request insertions.
@@ -191,8 +192,7 @@ module Promoted
             end
 
             insertions_from_delivery = (response != nil && !deliver_err);
-            response_insertions = delivery_request_builder.fill_details_from_response(
-              response && response[:insertion] || [])
+            response_insertions = response && response[:insertion] || []
           end
 
           should_send_shadow_traffic &&= should_send_as_shadow_traffic?
@@ -201,33 +201,24 @@ module Promoted
               deliver_shadow_traffic args, headers
           end
 
-          request_to_log = nil
           if !insertions_from_delivery then
-            request_to_log = delivery_request_builder.request
             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
-            log_request = {
-              :insertion => response_insertions,
-              :experiment => cohort_membership_to_log,
-              :request => request_to_log
-            }
-            log_request_builder.set_request_params(log_request)
 
-            # We can't count on these being set already since request_to_log may be nil.
-            log_request_builder.platform_id = delivery_request_builder.platform_id
-            log_request_builder.timing      = delivery_request_builder.timing
-            log_request_builder.user_info   = delivery_request_builder.user_info
+          # We only return a log request if there's a request or cohort to log.
+          if !insertions_from_delivery || cohort_membership_to_log
+            log_request_builder = LogRequestBuilder.new
+            # TODO - make this more efficient.
+            log_request_builder.request = delivery_request_builder.delivery_request_params
+            log_request_builder.response_insertions = response_insertions
+            log_request_builder.experiment = cohort_membership_to_log
 
             # 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(
+            log_req = log_request_builder.log_request(
               include_delivery_log: !insertions_from_delivery, 
               exec_server: exec_server)
           end
@@ -346,6 +337,7 @@ module Promoted
           response = nil
           begin
             response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, @async_shadow_traffic)
+            @validator.validate_response!(response)
           rescue StandardError => err
             @logger.warn("Shadow traffic call failed with #{err}") if @logger
             return
@@ -384,6 +376,7 @@ module Promoted
 end
 
 # dependent /libs
+require "promoted/ruby/client/log_request_builder"
 require "promoted/ruby/client/request_builder"
 require "promoted/ruby/client/pager"
 require "promoted/ruby/client/sampler"

data/promoted-ruby-client.gemspec

@@ -14,7 +14,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/promotedai/promoted-ruby-client'
   spec.license       = 'MIT'
 
-  # spec.metadata["allowed_push_host"] = "http://rubygems.org/gems/promoted-ruby-client"
+  # Uncomment if you want to push to a custom host
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
   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: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - scottmcmaster
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ files:
 - lib/promoted/ruby/client/extensions.rb
 - lib/promoted/ruby/client/faraday_http_client.rb
 - lib/promoted/ruby/client/id_generator.rb
+- lib/promoted/ruby/client/log_request_builder.rb
 - lib/promoted/ruby/client/pager.rb
 - lib/promoted/ruby/client/request_builder.rb
 - lib/promoted/ruby/client/sampler.rb
@@ -153,7 +154,7 @@ metadata:
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.9
+signing_key:
 specification_version: 4
 summary: A Ruby Client to contact Promoted APIs.
 test_files: []