promoted-ruby-client 0.1.16 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2c2ac1232cfaf7a98ca948a7949a420a6ab311c4b54d92ea8098e8b830e931b
-  data.tar.gz: 9ae8796dc993ecc11e01f1980a2200a7ee10dedb8287504a2bafcebec2f50105
+  metadata.gz: 340cf31fbc7680c1b9abb8df8dd1226e4a13fed103e21815afb82fb43b85f481
+  data.tar.gz: d5448efcb375ac090847ac6c37fcda3b57babf0dca6043d82967e8ecdb42ae52
 SHA512:
-  metadata.gz: d3df3068c668514c3666435fc1a4b25216223258fd305ba69e4cebf333f5026ff008f868a4bd7f3a15e748bd9b00ddb6dfbb9e0c0de7c72a9ed06ad4a175ddbe
-  data.tar.gz: 7adb59ff3806736008764d32a51176e1a064547259c8f4d7c9d800b4737e688d00b25593c07e5b2ecffc05daad1795830d17efb3f66284d6fc8f02b5045dd1f8
+  metadata.gz: df18a2f73308fd9771b55a8762592a4041059b5d5fe72e0de07fa9566eb8627647eef75276a401c6f9da7d03bfc7158deb94bfd6b5824d22635a22b7d11848f0
+  data.tar.gz: 7ed68c19270dcd13b8ed2347138aa845dd767d19bc257312e1a001f0e858879e75186142b9719b31e9c132d95fc7d48049baaf3e57b442f39f2b969cf2c835b8

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promoted-ruby-client (0.1.16)
+    promoted-ruby-client (0.1.20)
       concurrent-ruby (~> 1)
       faraday (>= 0.9.0)
       faraday_middleware (>= 0.9.0)

data/README.md

@@ -94,7 +94,73 @@ Field Name | Type | Optional? | Description
 ```:request_id``` | String | Yes | Generated by the SDK when needed (*do not set*)
 ```:content_id``` | String | No | Identifier for the content to be shown, must be set.
 ```:properties``` | Properties | Yes | Any additional custom properties to associate. For v1 integrations, it is fine not to fill in all the properties.
+---
+### Size
+User's screen dimensions.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:width``` | Integer | No | Screen width
+```:height``` | Integer | No | Screen height
+---
 
+### Screen
+State of the screen including scaling.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:size``` | Size | Yes | Screen size
+```:scale``` | Float | Yes | Current screen scaling factor
+---
+
+### ClientHints
+Alternative to user-agent strings. See https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/org.ietf/http_client_hints/jsonschema/1-0-0
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:is_mobile``` | Boolean | Yes | Mobile flag
+```:brand``` | Array of ClientBrandHint | Yes |
+```:architecture``` | String | Yes |
+```:model``` | String | Yes |
+```:platform``` | String | Yes |
+```:platform_version``` | String | Yes |
+```:ua_full_version``` | String | Yes |
+
+---
+### ClientBrandHint
+See https://raw.githubusercontent.com/snowplow/iglu-central/master/schemas/org.ietf/http_client_hints/jsonschema/1-0-0
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:brand``` | String | Yes | Mobile flag
+```:version``` | String | Yes |
+
+---
+### Location
+Information about the user's location.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:latitude``` | Float | No | Location latitude
+```:longitude``` | Float | No | Location longitude
+```:accuracy_in_meters``` | Integer | Yes | Location accuracy if available
+---
+
+### Browser
+Information about the user's browser.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:user_agent``` | String | Yes | Browser user agent string
+```:viewport_size``` | Size | Yes | Size of the browser viewport
+```:client_hints``` | ClientHints | Yes | HTTP client hints structure
+---
+### Device
+Information about the user's device.
+Field Name | Type | Optional? | Description
+---------- | ---- | --------- | -----------
+```:device_type``` | one of (`UNKNOWN_DEVICE_TYPE`, `DESKTOP`, `MOBILE`, `TABLET`) | Yes | Type of device
+```:brand``` | String | Yes | "Apple, "google", Samsung", etc.
+```:manufacturer``` | String | Yes | "Apple", "HTC", Motorola", "HUAWEI", etc.
+```:identifier``` | String | Yes | Android: android.os.Build.MODEL; iOS: iPhoneXX,YY, etc.
+```:screen``` | Screen | Yes | Screen dimensions
+```:ip_address``` | String | Yes | Originating IP address
+```:location``` | Location | Yes | Location information
+```:browser``` | Browser | Yes | Browser information
 ---
 ### Paging
 #### TODO
@@ -108,6 +174,7 @@ Field Name | Type | Optional? | Description
 ```:use_case``` | String | Yes | One of the use case values, i.e. 'FEED' (see [constants.rb](https://github.com/promotedai/promoted-ruby-client/blob/main/lib/promoted/ruby/client/constants.rb)).
 ```:properties``` | Properties | Yes | Any additional custom properties to associate.
 ```:paging``` | Paging | Yes | Paging parameters (see TODO)
+```:device``` | Device | Yes | Device information (as available)
 ---
 ### MetricsRequest
 Input to ```prepare_for_logging```
@@ -142,6 +209,8 @@ 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).
 ```: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.
 ---
 
 ### PromotedClient
@@ -219,12 +288,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.20.gem`
 6. Update README with new version.

data/lib/promoted/ruby/client.rb

@@ -30,18 +30,16 @@ 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
 
         ##
         # Create and configure a new Promoted client.
-        def initialize (params={})
+        def initialize(params={})
           @perform_checks = true
           if params[:perform_checks] != nil
             @perform_checks = params[:perform_checks]
@@ -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
@@ -177,7 +175,7 @@ module Promoted
               
               insertions_from_delivery = (response != nil && !deliver_err);
               response_insertions = delivery_request_builder.fill_details_from_response(
-                response ? response[:insertion] : [])
+                response && response[:insertion] || [])
             end
           end
   
@@ -212,7 +210,9 @@ module Promoted
 
           client_response = {
             insertion: response_insertions,
-            log_request: log_req
+            log_request: log_req,
+            execution_server: insertions_from_delivery ? Promoted::Ruby::Client::EXECUTION_SERVER['API'] : Promoted::Ruby::Client::EXECUTION_SERVER['SDK'],
+            client_request_id: delivery_request_builder.client_request_id
           }
           return client_response
         end
@@ -221,7 +221,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 {
@@ -318,7 +318,7 @@ module Promoted
 
             ellapsed_time = Time.now - start_time
             @logger.debug("Sync send_request completed in #{ellapsed_time.to_f * 1000} ms") if @logger
-        end
+          end
 
           return resp
         end
@@ -334,9 +334,17 @@ 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
@@ -349,7 +357,7 @@ module Promoted
           
           if !@async_shadow_traffic
             ellapsed_time = Time.now - start_time
-            insertions = response ? response[:insertion] : []
+            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/constants.rb

@@ -32,6 +32,13 @@ module Promoted
       CLIENT_TYPE = {'UNKNOWN_REQUEST_CLIENT' => 'UNKNOWN_REQUEST_CLIENT',
                      'PLATFORM_SERVER' => 'PLATFORM_SERVER',
                      'PLATFORM_CLIENT' => 'PLATFORM_CLIENT'}
+
+      EXECUTION_SERVER = {'API' => 'API', 'SDK' => 'SDK'}
+
+      DEVICE_TYPE = {'UNKNOWN_DEVICE_TYPE' => 'UNKNOWN_DEVICE_TYPE',
+                     'DESKTOP' => 'DESKTOP',
+                     'MOBILE' => 'MOBILE',
+                     'TABLET' => 'TABLET'}
     end
   end
 end

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/pager.rb

@@ -11,13 +11,13 @@ module Promoted
         end
         
         class Pager
-            def validate_paging (insertions, paging)
+            def validate_paging(insertions, paging)
               if paging && paging[:offset] && paging[:offset] >= insertions.length
                 raise InvalidPagingError.new("Invalid page offset (insertion size #{insertions.length}, offset #{paging[:offset]})", [])
               end
             end
 
-            def apply_paging (insertions, insertion_page_type, paging = nil)
+            def apply_paging(insertions, insertion_page_type, paging = nil)
               begin
                 validate_paging(insertions, paging)
               rescue InvalidPagingError => err
@@ -47,7 +47,7 @@ module Promoted
                 size = insertions.length
               end
 
-              final_insertion_size = [size, insertions.length].min
+              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]
@@ -63,5 +63,5 @@ module Promoted
             end
         end
       end
-   end
+    end
 end

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

@@ -2,9 +2,9 @@ module Promoted
   module Ruby
     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
+        attr_reader   :session_id, :only_log, :experiment, :client_info, :device,
+                      :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
 
@@ -24,13 +24,14 @@ module Promoted
           @session_id              = request[:session_id]
           @platform_id             = request[:platform_id]
           @client_info             = request[:client_info] || {}
+          @device                  = request[:device] || {}
           @view_id                 = request[:view_id]
           @use_case                = Promoted::Ruby::Client::USE_CASES[request[:use_case]] || Promoted::Ruby::Client::USE_CASES['UNKNOWN_USE_CASE']
           @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,11 +53,12 @@ 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,
             client_info: @client_info.merge({ :client_type => Promoted::Ruby::Client::CLIENT_TYPE['PLATFORM_SERVER'] }),
+            device: @device,
             platform_id: @platform_id,
             view_id: @view_id,
             session_id: @session_id,
@@ -64,9 +66,9 @@ module Promoted
             search_query: request[:search_query],
             properties: request[:properties],
             paging: request[:paging],
-            client_request_id: request[:client_request_id]
+            client_request_id: 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
@@ -76,11 +78,14 @@ module Promoted
         # to the responses.
         def fill_details_from_response response_insertions
           if !response_insertions then
-            response_insertions = full_insertion
+            response_insertions = []
           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,7 +104,8 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info
+            client_info: @client_info,
+            device: @device
           }
 
           if @experiment
@@ -113,18 +119,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
 
@@ -135,7 +161,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,12 +181,16 @@ 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
         end
 
+        def client_request_id
+          request[:client_request_id]
+        end
+
         private
 
         def add_missing_ids_on_insertions! request, insertions

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.20"
     end
   end
 end

data/promoted-ruby-client.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/promotedai/promoted-ruby-client'
   spec.license       = 'MIT'
 
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   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: 0.1.16
+  version: 0.1.20
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,6 +123,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/push-pull-requests_check.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -149,6 +150,7 @@ homepage: https://github.com/promotedai/promoted-ruby-client
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org/
   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