adzerk_decision_sdk 1.0.0.pre.beta.3 → 1.0.0.pre.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad73c68c0252fbd2ccbbd837f77aa25c67b52d64cd595586f9e3040ad9199082
-  data.tar.gz: 5059026a68d95ed6b749a56573a5e0d8bce32dafb9a6cdcbf5bcaa87a053a991
+  metadata.gz: 7d830e7e6e25ec7ae418affc0b46b52890aeb194c09eec309f4cf96eea8c1117
+  data.tar.gz: d3ab9c88d2bb6bcda4a10bfa0868144de86392b038dab1896d07ad9cdb5e258f
 SHA512:
-  metadata.gz: 5e435954e9d9c91c2d47ebc040da9227bc00db16eb50f6cdca0b870cf2fb8876d156fbd2e8c5340db1fdea8da1091189681bbbf867cc434b99af02b66801095e
-  data.tar.gz: 8102a548ce7a4c1a785f00afb27366a7c20debdd4daba20bcc63481e1c9a7ac19cc308719a8ec8b0e80b674524c441bb1b668f006b9f94741f0fa9c44c76d32f
+  metadata.gz: d7bc469e35b4578389cc518337b495d54df6650bd1c5e97ec00bf333668623da24fb05325a6d15a59bf47dc134cbc1941ac023f117f97668f018ae332340bf40
+  data.tar.gz: cb2e7afe0f9ec11cba6eed0389e2ea81e99b5686e927d297ba15024931c62e69ba6a27736cb8d1f1b8b87cd613a7046f80144f1f611fe145a92c48517a4d1271

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adzerk_decision_sdk (1.0.0)
+    adzerk_decision_sdk (1.0.0.pre.beta.3)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -14,9 +14,9 @@ GEM
     diff-lcs (1.3)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     method_source (0.9.2)
     parallel (1.19.1)
     parser (2.7.0.2)
@@ -29,7 +29,7 @@ GEM
       pry (~> 0.10)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (12.0.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -52,7 +52,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.1)
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)
 
@@ -62,7 +62,7 @@ PLATFORMS
 DEPENDENCIES
   adzerk_decision_sdk!
   pry-byebug
-  rake (~> 12.0.0)
+  rake (~> 13.0.1)
   rspec (~> 3.6, >= 3.6.0)
   rubocop (~> 0.66.0)
 

data/docs/Placement.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional] 
 **proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional] 
 **ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional] 
+**event_multiplier** | **Integer** |  | [optional] 
 
 ## Code Sample
 
@@ -41,7 +42,8 @@ instance = AdzerkDecisionSdk::Placement.new(div_name: null,
                                  content_keys: null,
                                  count: null,
                                  proportionality: null,
-                                 ecpm_partition: null)
+                                 ecpm_partition: null,
+                                 event_multiplier: null)
 ```
 
 

data/docs/UserdbApi.md

@@ -13,7 +13,6 @@ Method | HTTP request | Description
 [**match_user**](UserdbApi.md#match_user) | **GET** /udb/{networkId}/sync/i.gif | 
 [**opt_out**](UserdbApi.md#opt_out) | **GET** /udb/{networkId}/optout/i.gif | 
 [**read**](UserdbApi.md#read) | **GET** /udb/{networkId}/read | 
-[**set_user_cookie**](UserdbApi.md#set_user_cookie) | **GET** /udb/{networkId}/set/i.gif | 
 
 
 
@@ -486,51 +485,3 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## set_user_cookie
-
-> File set_user_cookie(network_id, user_key)
-
-
-
-Set User Cookie
-
-### Example
-
-```ruby
-# load the gem
-require 'adzerk_decision_sdk'
-
-api_instance = AdzerkDecisionSdk::UserdbApi.new
-network_id = 56 # Integer | Your Network Id
-user_key = 'user_key_example' # String | UserDB Id for the user
-
-begin
-  result = api_instance.set_user_cookie(network_id, user_key)
-  p result
-rescue AdzerkDecisionSdk::ApiError => e
-  puts "Exception when calling UserdbApi->set_user_cookie: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **network_id** | **Integer**| Your Network Id | 
- **user_key** | **String**| UserDB Id for the user | 
-
-### Return type
-
-**File**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: image/gif
-

data/lib/adzerk_decision_sdk/api/userdb_api.rb

@@ -660,72 +660,5 @@ module AdzerkDecisionSdk
       end
       return data, status_code, headers
     end
-
-    # Set User Cookie
-    # @param network_id [Integer] Your Network Id
-    # @param user_key [String] UserDB Id for the user
-    # @param [Hash] opts the optional parameters
-    # @return [File]
-    def set_user_cookie(network_id, user_key, opts = {})
-      data, _status_code, _headers = set_user_cookie_with_http_info(network_id, user_key, opts)
-      data
-    end
-
-    # Set User Cookie
-    # @param network_id [Integer] Your Network Id
-    # @param user_key [String] UserDB Id for the user
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
-    def set_user_cookie_with_http_info(network_id, user_key, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UserdbApi.set_user_cookie ...'
-      end
-      # verify the required parameter 'network_id' is set
-      if @api_client.config.client_side_validation && network_id.nil?
-        fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.set_user_cookie"
-      end
-      # verify the required parameter 'user_key' is set
-      if @api_client.config.client_side_validation && user_key.nil?
-        fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.set_user_cookie"
-      end
-      # resource path
-      local_var_path = '/udb/{networkId}/set/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'userKey'] = user_key
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] 
-
-      # return_type
-      return_type = opts[:return_type] || 'File' 
-
-      # auth_names
-      auth_names = opts[:auth_names] || []
-
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UserdbApi#set_user_cookie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/adzerk_decision_sdk/client.rb

@@ -36,8 +36,8 @@ module AdzerkDecisionSdk
       api_client.default_headers['X-Adzerk-Sdk-Version'] = "adzerk-decision-sdk-ruby:#{version}"
 
       @decisions = DecisionClient.new(network_id, site_id, api_client, configuration.logger)
-      @user_db = UserDbClient.new(network_id, api_client)
-      @pixels = PixelClient.new(api_client)
+      @user_db = UserDbClient.new(network_id, api_client, configuration.logger)
+      @pixels = PixelClient.new(api_client, configuration.logger)
     end
   end
 end

data/lib/adzerk_decision_sdk/models/placement.rb

@@ -62,6 +62,8 @@ module AdzerkDecisionSdk
     # (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions
     attr_accessor :ecpm_partition
 
+    attr_accessor :event_multiplier
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -80,7 +82,8 @@ module AdzerkDecisionSdk
         :'content_keys' => :'contentKeys',
         :'count' => :'count',
         :'proportionality' => :'proportionality',
-        :'ecpm_partition' => :'ecpmPartition'
+        :'ecpm_partition' => :'ecpmPartition',
+        :'event_multiplier' => :'eventMultiplier'
       }
     end
 
@@ -102,7 +105,8 @@ module AdzerkDecisionSdk
         :'content_keys' => :'Hash<String, Integer>',
         :'count' => :'Integer',
         :'proportionality' => :'Boolean',
-        :'ecpm_partition' => :'String'
+        :'ecpm_partition' => :'String',
+        :'event_multiplier' => :'Integer'
       }
     end
 
@@ -120,7 +124,8 @@ module AdzerkDecisionSdk
         :'content_keys',
         :'count',
         :'proportionality',
-        :'ecpm_partition'
+        :'ecpm_partition',
+        :'event_multiplier'
       ])
     end
 
@@ -210,21 +215,49 @@ module AdzerkDecisionSdk
       if attributes.key?(:'ecpm_partition')
         self.ecpm_partition = attributes[:'ecpm_partition']
       end
+
+      if attributes.key?(:'event_multiplier')
+        self.event_multiplier = attributes[:'event_multiplier']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@event_multiplier.nil? && @event_multiplier > 100000000
+        invalid_properties.push('invalid value for "event_multiplier", must be smaller than or equal to 100000000.')
+      end
+
+      if !@event_multiplier.nil? && @event_multiplier < -100000000
+        invalid_properties.push('invalid value for "event_multiplier", must be greater than or equal to -100000000.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@event_multiplier.nil? && @event_multiplier > 100000000
+      return false if !@event_multiplier.nil? && @event_multiplier < -100000000
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] event_multiplier Value to be assigned
+    def event_multiplier=(event_multiplier)
+      if !event_multiplier.nil? && event_multiplier > 100000000
+        fail ArgumentError, 'invalid value for "event_multiplier", must be smaller than or equal to 100000000.'
+      end
+
+      if !event_multiplier.nil? && event_multiplier < -100000000
+        fail ArgumentError, 'invalid value for "event_multiplier", must be greater than or equal to -100000000.'
+      end
+
+      @event_multiplier = event_multiplier
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -245,7 +278,8 @@ module AdzerkDecisionSdk
           content_keys == o.content_keys &&
           count == o.count &&
           proportionality == o.proportionality &&
-          ecpm_partition == o.ecpm_partition
+          ecpm_partition == o.ecpm_partition &&
+          event_multiplier == o.event_multiplier
     end
 
     # @see the `==` method
@@ -257,7 +291,7 @@ module AdzerkDecisionSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [div_name, network_id, site_id, ad_types, zone_ids, campaign_id, flight_id, ad_id, click_url, properties, event_ids, overrides, content_keys, count, proportionality, ecpm_partition].hash
+      [div_name, network_id, site_id, ad_types, zone_ids, campaign_id, flight_id, ad_id, click_url, properties, event_ids, overrides, content_keys, count, proportionality, ecpm_partition, event_multiplier].hash
     end
 
     # Builds the object from hash

data/lib/adzerk_decision_sdk/pixel_client.rb

@@ -3,23 +3,29 @@ require 'typhoeus'
 
 module AdzerkDecisionSdk
   class PixelClient
-    def initialize(api_client)
+    def initialize(api_client, logger)
       @api_client = api_client
+      @logger = logger
     end
 
-    def fire(url, revenue_override: nil, additional_revenue: nil)
+    def fire(url, revenue_override: nil, additional_revenue: nil, event_multiplier: nil)
       uri = URI(url)
+      @logger.info("Firing Pixel at base url of: #{uri.to_s}")
+
       query_params = URI.decode_www_form(uri.query)
       query_params << ["override", revenue_override] if not revenue_override.nil?
       query_params << ["additional", additional_revenue] if not additional_revenue.nil?
+      query_params << ["eventMultiplier", event_multiplier] if not event_multiplier.nil?
       uri.query = URI.encode_www_form(query_params)
       new_url = uri.to_s()
 
+      @logger.info("After url building with overrides, requesting: #{new_url}")
       request = @api_client.build_request(:GET, '')
       request.base_url = new_url
       response = request.run()
       location = response.response_code == 302 ? response.headers['location'] : nil
 
+      @logger.info("Received response from pixel url: #{response.response_code} with location: #{location}")
       [response.response_code, location]
     end
   end

data/lib/adzerk_decision_sdk/user_db_client.rb

@@ -2,41 +2,50 @@ require 'adzerk_decision_sdk/api/userdb_api'
 
 module AdzerkDecisionSdk
   class UserDbClient
-    def initialize(network_id, api_client)
+    def initialize(network_id, api_client, logger)
       @network_id = network_id
       @api = UserdbApi.new(api_client)
+      @logger = logger
     end
 
     def set_custom_properties(user_key, properties, network_id: nil)
+      @logger.info("Setting custom properties for #{user_key} on #{network_id || @network_id} to: #{properties}")
       @api.add_custom_properties(network_id || @network_id, user_key, { body: properties })
     end
 
     def add_interest(user_key, interest, network_id: nil)
+      @logger.info("Adding interest #{interest} for #{user_key} on #{network_id || @network_id}")
       @api.add_interests(network_id || @network_id, user_key, interest)
     end
 
     def add_retargeting_segment(user_key, advertiser_id, retargeting_segment_id, network_id: nil)
+      @logger.info("Adding #{advertiser_id}.#{retargeting_segment_id} rt segment for #{user_key} on #{network_id || @network_id}")
       @api.add_retargeting_segment(network_id || @network_id, advertiser_id, retargeting_segment_id, user_key)
     end
 
     def forget(user_key, network_id: nil)
+      @logger.info("Forgetting #{user_key} on #{network_id || @network_id}")
       @api.forget(network_id || @network_id, user_key)
     end
 
     def gdpr_consent(gdpr_consent, network_id: nil)
       body = gdpr_consent.respond_to?('to_hash') ? gdpr_consent.to_hash() : gdpr_consent
+      @logger.info("Setting GDPR consent on #{network_id || @network_id} with: #{body}")
       @api.gdpr_consent(network_id || @network_id, { body: body })
     end
 
     def ip_override(user_key, ip, network_id: nil)
+      @logger.info("Overriding IP for #{user_key} on #{network_id || @network_id} to #{ip}")
       @api.ip_override(network_id || @network_id, user_key, ip)
     end
 
     def match_user(user_key, partner_id, user_id, network_id: nil)
+      @logger.info("Matching user #{user_key} on #{network_id || @network_id} to #{partner_id}.#{user_id}")
       @api.match_user(network_id || @network_id, user_key, partner_id, user_id)
     end
 
     def opt_out(user_key, network_id: nil)
+      @logger.info("Opting out for #{user_key} on #{network_id || @network_id}")
       @api.opt_out(network_id || @network_id, user_key)
     end
 
@@ -54,11 +63,16 @@ module AdzerkDecisionSdk
         :campaignConversions
       ]
 
+      @logger.info("Requesting record for #{user_key} on #{network_id || @network_id}")
       user_record = @api.read(network_id || @network_id, user_key)
 
-      user_record.delete_if do |key, _|
+      @logger.info("Received unfiltered response of: #{user_record}")
+      clean_record = user_record.delete_if do |key, _|
         bad_keys.include?(key)
       end
+
+      @logger.info("Returning filtered response of: #{clean_record}")
+      clean_record
     end
   end
 end

data/lib/adzerk_decision_sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module AdzerkDecisionSdk
-  VERSION = '1.0.0-beta.3'
+  VERSION = '1.0.0-beta.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adzerk_decision_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.3
+  version: 1.0.0.pre.beta.4
 platform: ruby
 authors:
 - Adzerk, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -123,9 +123,7 @@ files:
 - lib/adzerk_decision_sdk/rate_type.rb
 - lib/adzerk_decision_sdk/user_db_client.rb
 - lib/adzerk_decision_sdk/version.rb
-- pkg/adzerk_decision_sdk-1.0.0.gem
-- pkg/adzerk_decision_sdk-1.0.0.pre.beta.1.gem
-- pkg/adzerk_decision_sdk-1.0.0.pre.beta.2.gem
+- pkg/adzerk_decision_sdk-1.0.0.pre.beta.3.gem
 - spec/.gitkeep
 - spec/placeholder_spec.rb
 homepage: http://adzerk.com