promoted-ruby-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f6d46482500c45c759f6b2965ae13a76aea2b3b0d18c069e31055fe985146f
-  data.tar.gz: 7527ed13e8306bc4f9b53fd1add1a12c478c261be30b0b0dc50d16e146f88f10
+  metadata.gz: '06709e6306f4f601ce1f67c7a75926ab585fd47af125995491909c2ddcef85e8'
+  data.tar.gz: c6e3a18424e31abf4a35000e03335251c709bcde886e20b5a4d4a5f660414382
 SHA512:
-  metadata.gz: fa5105d3d057f9e949dca0fa46a47c5d701e8dabec37f1d64619969827a580994245a6a83b5fbce399be06201f29d8758c2829e1d76b066bee8a4e8ea62fc892
-  data.tar.gz: c6d29aeb9721ad09de063c21afd529495ff8c7eb3422886010124e85fc654fe711efeeb35d5b1a873f4f0ca4d56c064a119069f698f080a203daf797309ad8a9
+  metadata.gz: 4d323360ed9e65a00fa9da40f3645288ea93f68c1f4e7a29c1779b3f21ba5430bfd278534669839f7e35e7ddc370a70d4d3b5b7152a8ce4b9b17097ed297d924
+  data.tar.gz: fc75f38fbd9d8c14f8c8930b2459b4eed3e912c57360bbf383478fbad4c614abef09a76bfa9fd818173367e168b24a730e13143c56a02c3191cd1f862c33e0e6

data/Gemfile

@@ -9,7 +9,6 @@ gem 'faraday', '~> 1.4.1'
 gem 'faraday_middleware'
 gem 'faraday-net_http'
 gem 'concurrent-ruby', require: 'concurrent'
-gem 'byebug'
 
 group :development do
     gem 'ruby-debug-ide', group: :development

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.1)
+    promoted-ruby-client (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -9,7 +9,6 @@ GEM
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.1.1)
-    byebug (11.1.3)
     concurrent-ruby (1.1.9)
     debase (0.2.5.beta2)
       debase-ruby_core_source (>= 0.10.12)
@@ -111,7 +110,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17)
-  byebug
   concurrent-ruby
   debase (>= 0.2.5.beta2)
   faraday (~> 1.4.1)
@@ -126,4 +124,4 @@ DEPENDENCIES
   solargraph
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -35,7 +35,7 @@ The `prepare_for_logging` call assumes the client has already handled pagination
 ## Example to run the client
 
 Install our Ruby client.
-`promoted-ruby-client (0.1.1)`
+`promoted-ruby-client (0.1.2)`
 
 Or
 

data/dev.md

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

data/lib/promoted/ruby/client.rb

@@ -18,12 +18,23 @@ module Promoted
         attr_reader :perform_checks, :default_only_log, :delivery_timeout_millis, :metrics_timeout_millis, :should_apply_treatment_func,
                     :default_request_headers
         
+        # A common compact method implementation.
+        def self.copy_and_remove_properties
+          Proc.new do |insertion|
+            insertion = Hash[insertion]
+            insertion.delete(:properties)
+            insertion
+          end
+        end
+
         def initialize (params={})
           @perform_checks = true
           if params[:perform_checks] != nil
             @perform_checks = params[:perform_checks]
           end
 
+          @logger = params[:logger] # Example:  Logger.new(STDERR, :progname => "promotedai")
+
           @default_request_headers = params[:default_request_headers] || {}
           @default_request_headers['x-api-key'] = params[:api_key] || ''
 
@@ -47,6 +58,7 @@ module Promoted
 
           @http_client = FaradayHTTPClient.new
           @pool = Concurrent::CachedThreadPool.new
+          @validator = Promoted::Ruby::Client::Validator.new
         end
         
         def close
@@ -62,7 +74,11 @@ module Promoted
               @http_client.send(endpoint, timeout_millis, payload, use_headers)
             end
           else
-            @http_client.send(endpoint, timeout_millis, payload, use_headers)
+            begin
+              @http_client.send(endpoint, timeout_millis, payload, use_headers)
+            rescue Faraday::Error => err
+              raise EndpointError.new(err)
+            end
           end
         end
 
@@ -72,9 +88,7 @@ module Promoted
           delivery_request_builder = RequestBuilder.new
           delivery_request_builder.set_request_params(args)
 
-          if perform_checks?
-            Promoted::Ruby::Client::Settings.check_that_log_ids_not_set!(args)
-          end
+          perform_common_checks!(args) if @perform_checks
 
           pre_delivery_fillin_fields delivery_request_builder
   
@@ -85,16 +99,24 @@ module Promoted
           only_log = delivery_request_builder.only_log != nil ? delivery_request_builder.only_log : @default_only_log
           if !only_log
             cohort_membership_to_log = delivery_request_builder.new_cohort_membership_to_log
-          end
+
+            if should_apply_treatment(cohort_membership_to_log)
+              delivery_request_params = delivery_request_builder.delivery_request_params
   
-          if should_apply_treatment(cohort_membership_to_log)
-            delivery_request_params = delivery_request_builder.delivery_request_params
-
-            # Call Delivery API
-            response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, headers)
-            
-            response_insertions = delivery_request_builder.fill_details_from_response(response[:insertion])
-            insertions_from_promoted = true;
+              # Call Delivery API
+              begin
+                response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, headers)
+              rescue  StandardError => err
+                # Currently we don't propagate errors to the SDK caller, but rather default to returning
+                # the request insertions.
+                @logger.error("Error calling delivery: " + err.message) if @logger
+              end
+              
+              if response != nil && response[:insertion] != nil
+                response_insertions = delivery_request_builder.fill_details_from_response(response[:insertion])
+                insertions_from_promoted = true;
+              end
+            end
           end
   
           request_to_log = nil
@@ -141,21 +163,49 @@ module Promoted
           return client_response
         end
 
-        def add_missing_ids_on_insertions! request, insertions
-          insertions.each do |insertion|
-            insertion[:insertion_id] = SecureRandom.uuid 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]
+        def prepare_for_logging args, headers={}
+          args = Promoted::Ruby::Client::Util.translate_args(args)
+
+          log_request_builder = RequestBuilder.new
+
+          # Note: This method expects as JSON (string keys) but internally, RequestBuilder
+          # transforms and works with symbol keys.
+          log_request_builder.set_request_params(args)
+          if @perform_checks
+            perform_common_checks! args
+
+            if @shadow_traffic_delivery_percent > 0 && args[:insertion_page_type] != Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'] then
+              raise ShadowTrafficInsertionPageType
+            end
+          end
+          
+          pre_delivery_fillin_fields log_request_builder
+
+          if should_send_as_shadow_traffic?
+            deliver_shadow_traffic args, headers
           end
-        end
 
-        def perform_checks?
-          @perform_checks
+          log_request_builder.log_request_params
         end
 
         # Sends a log request (previously created by a call to prepare_for_logging) to the metrics endpoint.
         def send_log_request log_request_params, headers={}
-          send_request(log_request_params, @metrics_endpoint, @metrics_timeout_millis, headers)
+          begin
+            send_request(log_request_params, @metrics_endpoint, @metrics_timeout_millis, headers)
+          rescue  StandardError => err
+            # Currently we don't propagate errors to the SDK caller.
+            @logger.error("Error from metrics: " + err.message) if @logger
+          end
+        end
+
+        private
+
+        def add_missing_ids_on_insertions! request, insertions
+          insertions.each do |insertion|
+            insertion[:insertion_id] = SecureRandom.uuid 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
         end
 
         def should_send_as_shadow_traffic?
@@ -176,29 +226,14 @@ module Promoted
           send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, headers, true)
         end
 
-        def prepare_for_logging args, headers={}
-          args = Promoted::Ruby::Client::Util.translate_args(args)
-
-          log_request_builder = RequestBuilder.new
-
-          # Note: This method expects as JSON (string keys) but internally, RequestBuilder
-          # transforms and works with symbol keys.
-          log_request_builder.set_request_params(args)
-          if perform_checks?
-            Promoted::Ruby::Client::Settings.check_that_log_ids_not_set!(args)
-
-            if @shadow_traffic_delivery_percent > 0 && args[:insertion_page_type] != Promoted::Ruby::Client::INSERTION_PAGING_TYPE['UNPAGED'] then
-              raise ShadowTrafficInsertionPageType
-            end
-          end
-          
-          pre_delivery_fillin_fields log_request_builder
-
-          if should_send_as_shadow_traffic?
-            deliver_shadow_traffic args, headers
+        def perform_common_checks!(req)
+          begin
+            @validator.check_that_log_ids_not_set!(req)
+            @validator.validate_metrics_request!(req)
+          rescue StandardError => err
+            @logger.error(err) if @logger
+            raise
           end
-
-          log_request_builder.log_request_params
         end
 
         def should_apply_treatment(cohort_membership)
@@ -217,15 +252,6 @@ module Promoted
             log_request_builder.timing[:client_log_timestamp] = Time.now.to_i
           end
         end
-
-        # A common compact method implementation.
-        def self.copy_and_remove_properties
-          Proc.new do |insertion|
-            insertion = Hash[insertion]
-            insertion.delete(:properties)
-            insertion
-          end
-        end
       end
     end
   end
@@ -234,7 +260,6 @@ end
 # dependent /libs
 require "promoted/ruby/client/request_builder"
 require "promoted/ruby/client/sampler"
-require "promoted/ruby/client/settings"
 require "promoted/ruby/client/util"
-require 'byebug'
+require "promoted/ruby/client/validator"
 require 'securerandom'

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

@@ -1,40 +1,21 @@
 module Promoted
   module Ruby
     module Client
-      class RequestError < StandardError
-        def message
-          'Request.requestId should not be set'
-        end
-      end
-
-      class RequestInsertionError < StandardError
-        def message
-          'Do not set Request.insertion.  Set full_insertion.'
-        end
-      end
-
-      class InsertionRequestIdError < StandardError
-        def message
-          'Insertion.requestId should not be set'
-        end
-      end
-
-      class InsertionIdError < StandardError
+      class ShadowTrafficInsertionPageType < StandardError
         def message
-          'Insertion.insertionId should not be set'
+          'Insertions must be unpaged when shadow traffic is on'
         end
       end
 
-      class InsertionContentId < StandardError
-        def message
-          'Insertion.contentId should be set'
+      class EndpointError < StandardError
+        attr_reader :cause
+        def initialize(cause)
+          @cause = cause
+          super('Error calling Promoted.ai endpoint')
         end
       end
 
-      class ShadowTrafficInsertionPageType < StandardError
-        def message
-          'Insertions must be unpaged when shadow traffic is on'
-        end
+      class ValidationError < StandardError
       end
     end
   end

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

@@ -11,6 +11,7 @@ module Promoted
                     f.request :json
                     f.request :retry, max: 3
                     f.adapter :net_http
+                    f.use Faraday::Response::RaiseError # raises on 4xx and 5xx responses
                 end
             end
 
@@ -22,8 +23,12 @@ module Promoted
                     req.body                    = request.to_json
                   end
         
-                  # TODO: Check response code, rescue on ParserError, etc.
-                  JSON.parse(response.body, :symbolize_names => true)
+                  norm_headers = response.headers.transform_keys(&:downcase)
+                  if norm_headers["content-type"] != nil && norm_headers["content-type"].start_with?("application/json")
+                    JSON.parse(response.body, :symbolize_names => true)
+                  else
+                    response.body
+                  end
             end
         end
       end

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

@@ -14,6 +14,7 @@ module Promoted
         def set_request_params args = {}
           @request                 = args[:request] || {}
           @experiment              = args[:experiment]
+          @only_log                = args[:only_log]
           @session_id              = request[:session_id]
           @platform_id             = request[:platform_id]
           @client_info             = request[:client_info] || {}
@@ -23,7 +24,6 @@ module Promoted
           @request_id              = SecureRandom.uuid
           @user_info               = request[:user_info] || { :user_id => nil, :log_user_id => nil}
           @timing                  = request[:timing] || { :client_log_timestamp => Time.now.to_i }
-          @only_log                = request[:only_log]
           @to_compact_metrics_insertion_func       = args[:to_compact_metrics_insertion_func]
           @to_compact_delivery_insertion_func      = args[:to_compact_delivery_insertion_func]
         end
@@ -77,35 +77,6 @@ module Promoted
           filled_in_copy
         end
 
-        def validate_request_params
-          # TODO
-        end
-
-        def to_compact_metrics_insertion_func
-          @to_compact_metrics_insertion_func
-        end
-
-        def to_compact_delivery_insertion_func
-          @to_compact_delivery_insertion_func
-        end
-
-        # A list of the response Insertions.  This client expects lists to be truncated
-        # already to request.paging.size.  If not truncated, this client will truncate
-        # the list.
-        def insertion
-          @insertion
-        end
-
-        # A way to turn off logging.  Defaults to true.
-        def enabled?
-          @enabled
-        end
-
-        # Default values to use on DeliveryRequests.
-        def default_request_values
-          @default_request_values
-        end
-
         def log_request_params(include_insertions: true, include_request: true)
           params = {
             user_info: user_info,
@@ -154,6 +125,14 @@ module Promoted
           @insertion
         end
 
+        private
+
+        # A list of the response Insertions.  This client expects lists to be truncated
+        # already to request.paging.size.  If not truncated, this client will truncate
+        # the list.
+        def insertion
+          @insertion
+        end
       end
     end
   end

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

@@ -0,0 +1,158 @@
+module Promoted
+    module Ruby
+      module Client
+        class Validator
+            def validate_user_info!(ui)
+                validate_fields!(
+                    ui,
+                    "user info",
+                    [
+                        {
+                            :name => :user_id,
+                            :type => String
+                        },
+                        {
+                            :name => :log_user_id,
+                            :type => String
+                        }
+                    ]
+                )
+            end
+
+            def validate_insertion!(ins)
+                validate_fields!(
+                    ins,
+                    "insertion",
+                    [
+                        {
+                            :name => :platform_id,
+                            :type => Integer
+                        },
+                        {
+                            :name => :insertion_id,
+                            :type => String
+                        },
+                        {
+                            :name => :request_id,
+                            :type => String
+                        },
+                        {
+                            :name => :view_id,
+                            :type => String
+                        },
+                        {
+                            :name => :session_id,
+                            :type => String
+                        },
+                        {
+                            :name => :content_id,
+                            :type => String
+                        },
+                        {
+                            :name => :position,
+                            :type => Integer
+                        },
+                        {
+                            :name => :delivery_score,
+                            :type => Integer
+                        }
+                    ]
+                )
+
+                if ins[:user_info] then
+                    self.validate_user_info! ins[:user_info]
+                end
+            end
+
+            def validate_request!(req)
+                validate_fields!(
+                    req,
+                    "request",
+                    [
+                        {
+                            :name => :platform_id,
+                            :type => Integer
+                        },
+                        {
+                            :name => :request_id,
+                            :type => String
+                        },
+                        {
+                            :name => :view_id,
+                            :type => String
+                        },
+                        {
+                            :name => :session_id,
+                            :type => String
+                        },
+                        {
+                            :name => :insertion,
+                            :type => Array
+                        }
+                    ]
+                )
+
+                if req[:insertion] then
+                    req[:insertion].each {|ins|
+                        validate_insertion! ins
+                    }
+                end
+
+                if req[:user_info] then
+                    validate_user_info! req[:user_info]
+                end
+            end
+
+            def validate_metrics_request!(metrics_req)
+                validate_fields!(
+                    metrics_req,
+                    "metrics request",
+                    [
+                        {
+                            :name => :request,
+                            :required => true
+                        },
+                        {
+                            :name => :full_insertion,
+                            :required => true,
+                            :type => Array
+                        }
+                    ]
+                )
+
+                validate_request!(metrics_req[:request])
+                metrics_req[:full_insertion].each {|ins|
+                    validate_insertion! ins
+                }
+            end
+
+            def check_that_log_ids_not_set! req
+                raise ValidationError.new("Request.requestId should not be set") if req.dig(:request, :request_id)
+                raise ValidationError.new("Do not set Request.insertion.  Set full_insertion.") if req[:insertion]
+      
+                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
+            
+            private
+
+            def validate_fields!(obj, obj_name, fields)
+                fields.each {|field|
+                    if field[:required] then
+                        raise ValidationError.new(field[:name].to_s + " is required on " + obj_name) if !obj.has_key?(field[:name])
+                    end
+
+                    if field[:type] && obj.has_key?(field[:name]) then
+                        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
+      end
+   end
+ end
+  
+require "promoted/ruby/client/errors"

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

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,8 +77,8 @@ files:
 - lib/promoted/ruby/client/faraday_http_client.rb
 - lib/promoted/ruby/client/request_builder.rb
 - lib/promoted/ruby/client/sampler.rb
-- lib/promoted/ruby/client/settings.rb
 - lib/promoted/ruby/client/util.rb
+- lib/promoted/ruby/client/validator.rb
 - lib/promoted/ruby/client/version.rb
 - promoted-ruby-client.gemspec
 homepage: https://github.com/promotedai/promoted-ruby-client

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

@@ -1,21 +0,0 @@
-module Promoted
-  module Ruby
-    module Client
-      class Settings
-
-        def self.check_that_log_ids_not_set! options_hash
-          raise RequestError if options_hash.dig(:request, :request_id)
-          raise RequestInsertionError if options_hash[:insertion]
-
-          options_hash[:full_insertion].each do |insertion_hash|
-            raise InsertionRequestIdError if insertion_hash[:request_id]
-            raise InsertionIdError if insertion_hash[:insertion_id]
-          end
-          true
-        end
-      end
-    end
-  end
-end
-
-require "promoted/ruby/client/errors"