promoted-ruby-client 0.1.14 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8ef3e5279cc60965989f9c2d0ded6c588429def19e2a115a359e182e3ec212
-  data.tar.gz: 2d9484891a6c6f31a43a248a434384956e301fbf037414b9b8839a98342bfba7
+  metadata.gz: c49d0a2668c2ac163b2fb9bbfb13fcff75d6a4f558b8e62b633bc590d094c269
+  data.tar.gz: c0bc6218512f2883bd2fcbdfc60d4f5a9da05b93a9872bd60c1ce65bbd1d6ec9
 SHA512:
-  metadata.gz: a64e389cce099e52a723e477c392209c3342924013006151716eb6936a4b49f6fef73809107a73afc5ec39281b65646d71129e3fe18e84083869ca187480c000
-  data.tar.gz: f667e3e5d62fc089d48c7a4afd67798823d3cad86831d5d7c514db2b4ca734a9c6f09db6431f8d8ad5ccc465481a67b2b857b5287c7b3e7e93888511209d9c0c
+  metadata.gz: d92f40acf137305cbce1c2e66d3f9b40d9ed5d58f97fc84b0beb2a9ecc7a47671316c012c36279bdbed401f8d1f81001dcbf352f70507593c48d14cbd829e6b1
+  data.tar.gz: 0fddc62d1ea650b98653b8f05680d15e9245d0259c835408113c4b4dbab4baa16360735755656d7fec42466e2254bf3fd69e7187f3dbc44e97f1b435b94afbab

data/.github/workflows/push-pull-requests_check.yml

@@ -0,0 +1,16 @@
+name: Pull-Requests Check
+
+on: [push, pull_request]
+
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.1
+        bundler-cache: true
+
+    - name: Build and test with rspec
+      run: bundle exec rspec spec

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.14)
+    promoted-ruby-client (0.1.18)
       concurrent-ruby (~> 1)
-      faraday (~> 1.4, >= 1.4.3)
-      faraday-net_http (~> 1.0)
-      faraday_middleware (~> 1.0, >= 1.0.0)
+      faraday (>= 0.9.0)
+      faraday_middleware (>= 0.9.0)
       net-http-persistent (~> 4.0)
 
 GEM

data/README.md

@@ -17,6 +17,8 @@ More information at [http://www.promoted.ai](http://www.promoted.ai)
 
 ### [Faraday](https://github.com/lostisland/faraday)
 HTTP client for calling Promoted.
+### [Net::HTTP::Persistent](https://github.com/drbrain/net-http-persistent)
+Faraday binding (provides connection pool support)
 ### [Concurrent Ruby](https://github.com/ruby-concurrency/concurrent-ruby)
 Provides a thread pool for making shadow traffic requests to Delivery API in the background on a subset of calls to ```prepare_for_logging```
 ## Creating a Client
@@ -50,6 +52,7 @@ Name | Type | Description
 ```:default_request_headers``` | Hash | Additional headers to send on the request beyond ```x-api-key```. Defaults to {}
 ```:default_only_log``` | Boolean | If true, the ```deliver``` method will not direct traffic to Delivery API but rather return a request suitable for logging. Defaults to false.
 ```:should_apply_treatment_func``` | Proc | Called during delivery, accepts an experiment and returns a Boolean indicating whether the request should be considered part of the control group (false) or in the experiment (true). If nil, the default behavior of checking the experiement ```:arm``` is applied.
+```:warmup``` | Boolean | If true, the client will prime the `Net::HTTP::Persistent` connection pool on construction; this can make the first few calls to Promoted complete faster. Defaults to false.
 
 ## Data Types
 
@@ -216,12 +219,13 @@ metrics_request = {
 }
 
 # OPTIONAL: You can pass a custom function to "compact" insertions before metrics logging.
-# Note that the PromotedClient has a class method helper, copy_and_remove_properties, that does just this.
-to_compact_metrics_insertion_func = Proc.new do |insertion|
-  insertion.delete(:properties)
-  insertion
+# Note that the PromotedClient has a class method helper, remove_all_properties, that does
+# an implementation of this, returning nil to remove ALL properties.
+to_compact_metrics_properties_func = Proc.new do |properties|
+  properties[:struct].delete(:active)
+  properties
 end
-# metrics_request[:to_compact_metrics_insertion_func] = to_compact_metrics_insertion
+# metrics_request[:to_compact_metrics_properties_func] = to_compact_metrics_properties_func
 
 # Create a client
 client = Promoted::Ruby::Client::PromotedClient.new

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

data/lib/promoted/ruby/client.rb

@@ -30,12 +30,10 @@ module Promoted
         end
 
         ##            
-        # A common compact method implementation.
-        def self.copy_and_remove_properties
-          Proc.new do |insertion|
-            insertion = Hash[insertion]
-            insertion.delete(:properties)
-            insertion
+        # A common compact properties method implementation.
+        def self.remove_all_properties
+          Proc.new do |properties|
+            nil
           end
         end
 
@@ -73,7 +71,7 @@ module Promoted
           @delivery_timeout_millis = params[:delivery_timeout_millis] || DEFAULT_DELIVERY_TIMEOUT_MILLIS
           @metrics_timeout_millis  = params[:metrics_timeout_millis] || DEFAULT_METRICS_TIMEOUT_MILLIS
 
-          @http_client = FaradayHTTPClient.new
+          @http_client = FaradayHTTPClient.new(@logger)
           @validator = Promoted::Ruby::Client::Validator.new
 
           @async_shadow_traffic = true
@@ -97,6 +95,10 @@ module Promoted
           if params[:enabled] != nil
             @enabled = params[:enabled] || false
           end
+
+          if params[:warmup]
+            do_warmup
+          end
         end
         
         ##
@@ -109,9 +111,9 @@ module Promoted
         end
 
         ##
-        # Make a delivery request.
+        # 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_args(args)
+          args = Promoted::Ruby::Client::Util.translate_hash(args)
 
           # Respect the enabled state
           if !@enabled
@@ -124,7 +126,16 @@ module Promoted
           delivery_request_builder = RequestBuilder.new
           delivery_request_builder.set_request_params(args)
 
-          perform_common_checks!(args) if @perform_checks
+          # perform_checks raises errors.
+          if @perform_checks
+            perform_common_checks!(args)
+
+            if args[:insertion_page_type] == Promoted::Ruby::Client::INSERTION_PAGING_TYPE['PRE_PAGED'] then
+              err = DeliveryInsertionPageType.new
+              @logger.error(err) if @logger
+              raise err
+            end
+          end
 
           delivery_request_builder.ensure_client_timestamp
   
@@ -135,10 +146,15 @@ module Promoted
           only_log = delivery_request_builder.only_log != nil ? delivery_request_builder.only_log : @default_only_log
           deliver_err = false
 
-          if !@pager.validate_paging(delivery_request_builder.full_insertion, delivery_request_builder.request[:paging])
+          begin
+            @pager.validate_paging(delivery_request_builder.full_insertion, delivery_request_builder.request[:paging])
+          rescue InvalidPagingError => err
             # Invalid input, log and do SDK-side delivery.
-            @logger.warn("Invalid paging parameters") if @logger
-            only_log = true
+            @logger.warn(err) if @logger
+            return {
+              insertion: err.default_insertions_page
+              # No log request returned when no response insertions due to invalid paging
+            }
           end
 
           if !only_log
@@ -203,7 +219,7 @@ module Promoted
         # Generate a log request for a subsequent call to send_log_request
         # or for logging via alternative means.
         def prepare_for_logging args, headers={}
-          args = Promoted::Ruby::Client::Util.translate_args(args)
+          args = Promoted::Ruby::Client::Util.translate_hash(args)
 
           if !@enabled
             return {
@@ -248,6 +264,22 @@ module Promoted
 
         private
 
+        def do_warmup
+          if !@delivery_endpoint
+            # Warmup only supported when delivery is enabled.
+            return
+          end
+
+          warmup_url = @delivery_endpoint.reverse.sub("/deliver".reverse, "/healthz".reverse).reverse
+          @logger.info("Warming up at #{warmup_url}") if @logger
+          1.upto(20) do
+            resp = @http_client.get(warmup_url)
+            if resp != "ok"
+              @logger.warn("Got a failure warming up") if @logger
+            end
+          end
+        end
+
         def send_request payload, endpoint, timeout_millis, api_key, headers={}, send_async=false
           resp = nil
 
@@ -300,13 +332,22 @@ module Promoted
           delivery_request_builder = RequestBuilder.new
           delivery_request_builder.set_request_params args
 
-          delivery_request_params = delivery_request_builder.delivery_request_params(should_compact: false)
+          delivery_request_params = delivery_request_builder.delivery_request_params
           delivery_request_params[:client_info][:traffic_type] = Promoted::Ruby::Client::TRAFFIC_TYPE['SHADOW']
 
+          begin
+            @pager.validate_paging(delivery_request_builder.full_insertion, 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
+            return
+          end
+
           # Call Delivery API and log/ignore errors.
           start_time = Time.now
+          response = nil
           begin
-            send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, @async_shadow_traffic)
+            response = send_request(delivery_request_params, @delivery_endpoint, @delivery_timeout_millis, @delivery_api_key, headers, @async_shadow_traffic)
           rescue StandardError => err
             @logger.warn("Shadow traffic call failed with #{err}") if @logger
             return
@@ -314,7 +355,8 @@ module Promoted
           
           if !@async_shadow_traffic
             ellapsed_time = Time.now - start_time
-            @logger.info("Shadow traffic call completed in #{ellapsed_time.to_f * 1000} ms") if @logger
+            insertions = response ? response[:insertion] : []
+            @logger.info("Shadow traffic call completed in #{ellapsed_time.to_f * 1000} ms with #{insertions.length} insertions") if @logger
           end
         end
 

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

@@ -7,6 +7,12 @@ module Promoted
         end
       end
 
+      class DeliveryInsertionPageType < StandardError
+        def message
+          'Delivery insertions must be unpaged'
+        end
+      end
+
       class EndpointError < StandardError
         attr_reader :cause
         def initialize(cause)

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

@@ -1,15 +1,19 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'promoted/ruby/client/util'
 
 module Promoted
     module Ruby
       module Client
         class FaradayHTTPClient
  
-            def initialize
+            def initialize(logger = nil)
                 @conn = Faraday.new do |f|
                     f.request :json
                     f.request :retry, max: 3
+                    if logger
+                      f.response :logger, logger, { headers: false, bodies: true, log_level: :debug }
+                    end
                     f.use Faraday::Response::RaiseError # raises on 4xx and 5xx responses
                     f.adapter :net_http_persistent
                 end
@@ -25,11 +29,15 @@ module Promoted
         
                   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)
+                    Promoted::Ruby::Client::Util.translate_hash(JSON.parse(response.body))
                   else
                     response.body
                   end
             end
+
+            def get(endpoint)
+              @conn.get(endpoint).body
+            end
         end
       end
     end

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

@@ -1,18 +1,28 @@
 module Promoted
     module Ruby
       module Client
+        class InvalidPagingError < StandardError
+          attr_reader :default_insertions_page
+
+          def initialize(message, default_insertions_page)
+            super(message)
+            @default_insertions_page = default_insertions_page
+          end
+        end
+        
         class Pager
             def validate_paging (insertions, paging)
-              if paging && paging[:offset]
-                return paging[:offset] < insertions.length
+              if paging && paging[:offset] && paging[:offset] >= insertions.length
+                raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, offset #{paging[:offset]})", [])
               end
-              return true          
             end
 
             def apply_paging (insertions, insertion_page_type, paging = nil)
-              # This is invalid input, stop it before it goes to the server.
-              if !validate_paging(insertions, paging)
-                return []
+              begin
+                validate_paging(insertions, paging)
+              rescue InvalidPagingError => err
+                # This is invalid input, stop it before it goes to the server.
+                return err.default_insertions_page
               end
 
               if !paging
@@ -54,4 +64,4 @@ module Promoted
         end
       end
    end
-end
+end

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

@@ -3,8 +3,8 @@ module Promoted
     module Client
       class RequestBuilder
         attr_reader   :session_id, :only_log, :experiment, :client_info,
-                      :view_id, :insertion, :to_compact_delivery_insertion_func,
-                      :request_id, :full_insertion, :use_case, :request, :to_compact_metrics_insertion_func
+                      :view_id, :insertion, :to_compact_delivery_properties_func,
+                      :request_id, :full_insertion, :use_case, :request, :to_compact_metrics_properties_func
 
         attr_accessor :timing, :user_info, :platform_id
 
@@ -29,8 +29,8 @@ module Promoted
           @full_insertion          = args[:full_insertion]
           @user_info               = request[:user_info] || { :user_id => nil, :log_user_id => nil}
           @timing                  = request[:timing] || { :client_log_timestamp => Time.now.to_i }
-          @to_compact_metrics_insertion_func       = args[:to_compact_metrics_insertion_func]
-          @to_compact_delivery_insertion_func      = args[:to_compact_delivery_insertion_func]
+          @to_compact_metrics_properties_func       = args[:to_compact_metrics_properties_func]
+          @to_compact_delivery_properties_func      = args[:to_compact_delivery_properties_func]
 
           # If the user didn't create a client request id, we do it for them.
           request[:client_request_id] = request[:client_request_id] || @id_generator.newID
@@ -52,7 +52,7 @@ module Promoted
         end
 
         # Only used in delivery
-        def delivery_request_params(should_compact: true)
+        def delivery_request_params
           params = {
             user_info: user_info,
             timing: timing,
@@ -66,7 +66,7 @@ module Promoted
             paging: request[:paging],
             client_request_id: request[:client_request_id]
           }
-          params[:insertion] = should_compact ? compact_delivery_insertions : full_insertion
+          params[:insertion] = insertions_with_compact_props(@to_compact_delivery_properties_func)
 
           params.clean!
         end
@@ -80,7 +80,10 @@ module Promoted
           end
 
           props = @full_insertion.each_with_object({}) do |insertion, hash|
-            hash[insertion[:content_id]] = insertion[:properties]
+            if insertion.has_key?(:properties)
+              # Don't add nil properties to response insertions.
+              hash[insertion[:content_id]] = insertion[:properties]
+            end
           end
 
           filled_in_copy = []
@@ -99,10 +102,13 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            cohort_membership: @experiment,
             client_info: @client_info
           }
 
+          if @experiment
+            params[:cohort_membership] = [@experiment]
+          end
+
           # Log request allows for multiple requests but here we only send one.
           if include_request
             request[:request_id] = request[:request_id] || @id_generator.newID
@@ -110,18 +116,38 @@ module Promoted
           end
 
           if include_insertions
-            params[:insertion] = compact_metrics_insertions if include_insertions
+            params[:insertion] = compact_metrics_properties if include_insertions
             add_missing_ids_on_insertions! request, params[:insertion]
           end
           
           params.clean!
         end
 
-        def compact_delivery_insertions
-          if !@to_compact_delivery_insertion_func
+        def compact_one_insertion(insertion, compact_func)
+          return insertion if (!compact_func || !insertion[:properties])
+
+          # Only need a copy if there are properties to compact.
+          compact_insertion = insertion.dup
+
+          # Let the custom function work with a deep copy of the properties.
+          # There's really no way to work with a shallow copy and still be able
+          # to restore the correct insertion properties after a call to delivery.
+          new_props =  Marshal.load(Marshal.dump(insertion[:properties]))
+          compact_insertion[:properties] = compact_func.call(new_props)
+          compact_insertion.clean!
+          return compact_insertion
+        end
+
+        def insertions_with_compact_props(compact_func)
+          if !compact_func
+            # Nothing to do, avoid copying the whole array.
             full_insertion
           else
-            full_insertion.map {|insertion| @to_compact_delivery_insertion_func.call(insertion) }
+            compact_insertions = Array.new(full_insertion.length)
+            full_insertion.each_with_index {|insertion, index|
+              compact_insertions[index] = compact_one_insertion(insertion, compact_func)
+            }
+            compact_insertions
           end
         end
 
@@ -132,7 +158,7 @@ module Promoted
         end
 
         # TODO: This looks overly complicated.
-        def compact_metrics_insertions
+        def compact_metrics_properties
           @insertion            = [] # insertion should be set according to the compact insertion
           paging                = request[:paging] || {}
           size                  = paging[:size] ? paging[:size].to_i : 0
@@ -152,7 +178,7 @@ module Promoted
             insertion_obj[:insertion_id] = @id_generator.newID
             insertion_obj[:request_id]   = request_id
             insertion_obj[:position]     = offset + index
-            insertion_obj                = @to_compact_metrics_insertion_func.call(insertion_obj) if @to_compact_metrics_insertion_func
+            insertion_obj                = compact_one_insertion(insertion_obj, @to_compact_metrics_properties_func)
             @insertion << insertion_obj.clean!
           end
           @insertion

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

@@ -2,16 +2,39 @@ module Promoted
     module Ruby
       module Client
         module Util
-            def self.translate_args(args)
+            def self.translate_array(arr)
+              sym_arr = Array.new(arr.length)
+              arr.each_with_index do |v, i|
+                new_v = v
+                case v
+                when Hash
+                  new_v = translate_hash(v)
+                when Array
+                  new_v = translate_array(v)
+                end
+                sym_arr[i] = new_v
+              end
+              sym_arr
+            end
+
+            def self.translate_hash(args)
               sym_hash = {}
               args.each do |k, v|
-                sym_hash[k.to_s.to_underscore.to_sym] = v.is_a?(Hash) ? translate_args(v) : v
+                new_key = k.to_s.to_underscore.to_sym
+                case v
+                when Hash
+                  sym_hash[new_key] = translate_hash(v)
+                when Array
+                  sym_hash[new_key] = translate_array(v)
+                else
+                  sym_hash[new_key] = v
+                end
               end
               sym_hash
               rescue => e
                 raise 'Unable to parse args. Please pass correct arguments. Must be JSON'
               end      
-        end
+            end
       end
   end
 end

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

@@ -1,7 +1,7 @@
 module Promoted
   module Ruby
     module Client
-      VERSION = "0.1.14"
+      VERSION = "0.1.18"
     end
   end
 end

data/promoted-ruby-client.gemspec

@@ -28,9 +28,8 @@ Gem::Specification.new do |spec|
   spec.executables      = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths    = ["lib"]
 
-  spec.add_runtime_dependency 'faraday', '>= 0.9'
-  spec.add_runtime_dependency 'faraday_middleware', '>= 0.9'
-  spec.add_runtime_dependency 'faraday-net_http', '~> 0.9'
+  spec.add_runtime_dependency 'faraday', '>= 0.9.0'
+  spec.add_runtime_dependency 'faraday_middleware', '>= 0.9.0'
   spec.add_runtime_dependency 'net-http-persistent', '~> 4.0'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.18
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,42 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: faraday-net_http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +123,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/push-pull-requests_check.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -181,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
 summary: A Ruby Client to contact Promoted APIs.