promoted-ruby-client 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c49d0a2668c2ac163b2fb9bbfb13fcff75d6a4f558b8e62b633bc590d094c269
-  data.tar.gz: c0bc6218512f2883bd2fcbdfc60d4f5a9da05b93a9872bd60c1ce65bbd1d6ec9
+  metadata.gz: 6b8a39c8af4d21ae9987db29f0041e57d54de87da119b799e89091069a0bfbc2
+  data.tar.gz: 7b3932706882a896f330b0bd0a3d05671111e80b97fac4403e355ae30e537750
 SHA512:
-  metadata.gz: d92f40acf137305cbce1c2e66d3f9b40d9ed5d58f97fc84b0beb2a9ecc7a47671316c012c36279bdbed401f8d1f81001dcbf352f70507593c48d14cbd829e6b1
-  data.tar.gz: 0fddc62d1ea650b98653b8f05680d15e9245d0259c835408113c4b4dbab4baa16360735755656d7fec42466e2254bf3fd69e7187f3dbc44e97f1b435b94afbab
+  metadata.gz: 3146dc2f31afa84fa2b332b1cdb5ca145e7aa51140ae14503a8ca8a4aebc96bb59c4313ee10884b85ba819c930f40f9dd88e7d88454a39a9748b42f3e7d827e5
+  data.tar.gz: 903cb0dca7f83acfa605db3be223833ffebe78d0e530b1e98599ed2b8b15e2b5babffb1e40704789bab45f42f3d8372a46e2263733428da2e9fea90860003cb0

data/Gemfile.lock

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

data/README.md

@@ -94,7 +94,66 @@ 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
+---
+
+### 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
+```:client_hints``` | ClientHints | Yes | HTTP client hints structure
+---
+
+### 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
+```:
+---
+### 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 +167,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 +202,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

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

data/lib/promoted/ruby/client.rb

@@ -210,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

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

@@ -2,7 +2,7 @@ module Promoted
   module Ruby
     module Client
       class RequestBuilder
-        attr_reader   :session_id, :only_log, :experiment, :client_info,
+        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
 
@@ -24,6 +24,7 @@ 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]
@@ -57,6 +58,7 @@ module Promoted
             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,7 +66,7 @@ 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] = insertions_with_compact_props(@to_compact_delivery_properties_func)
 
@@ -102,7 +104,8 @@ module Promoted
           params = {
             user_info: user_info,
             timing: timing,
-            client_info: @client_info
+            client_info: @client_info,
+            device: @device
           }
 
           if @experiment
@@ -184,6 +187,10 @@ module Promoted
           @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promoted-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - scottmcmaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday