promoted-ruby-client 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2c2ac1232cfaf7a98ca948a7949a420a6ab311c4b54d92ea8098e8b830e931b
-  data.tar.gz: 9ae8796dc993ecc11e01f1980a2200a7ee10dedb8287504a2bafcebec2f50105
+  metadata.gz: c2cabc9fa3074e1eed3fd795eaa180a0e47ee18b8eceacb8c3516a347670a5d7
+  data.tar.gz: 8c32e19fe9227fe327ec3995e384477e087ed7d5b4ed48bb5dd0b6a78fdf7ac2
 SHA512:
-  metadata.gz: d3df3068c668514c3666435fc1a4b25216223258fd305ba69e4cebf333f5026ff008f868a4bd7f3a15e748bd9b00ddb6dfbb9e0c0de7c72a9ed06ad4a175ddbe
-  data.tar.gz: 7adb59ff3806736008764d32a51176e1a064547259c8f4d7c9d800b4737e688d00b25593c07e5b2ecffc05daad1795830d17efb3f66284d6fc8f02b5045dd1f8
+  metadata.gz: daa95d7fa296498252bd833106fddd6f08c21c1ce3fcc3aa8afa2e79d30d04e914bdc978cafa13d436b5364d91d9467f568d210d86d5d948a0500be3de7b2c8a
+  data.tar.gz: 757d9829c35ab58512093f0940f1f5d02aef11b23f94523a09878eeb82b717f047e83936b867aa60f34fa8ce9da2aca45d1be8ecf8bb9cad6b4c8de5b047b723

data/Gemfile.lock

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

data/README.md

@@ -219,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.16.gem`
+5. Run (using new output) `gem push promoted-ruby-client-0.1.17.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
 
@@ -115,7 +113,7 @@ 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_args(args)
+          args = Promoted::Ruby::Client::Util.translate_hash(args)
 
           # Respect the enabled state
           if !@enabled
@@ -221,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 {
@@ -334,7 +332,7 @@ 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']
 
           # Call Delivery API and log/ignore errors.

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

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'promoted/ruby/client/util'
 
 module Promoted
     module Ruby
@@ -28,7 +29,7 @@ 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

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 = []
@@ -113,18 +116,33 @@ 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
+          compact_insertion[:properties] = compact_func.call(insertion[:properties])
+          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
 
@@ -135,7 +153,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
@@ -155,7 +173,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.16"
+      VERSION = "0.1.17"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday