adzerk_decision_sdk 1.0.0.pre.beta.1 → 1.0.0.pre.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb53d3459cdf483d870b18c2618046e331e7c36ca40f2e3205892be67f3cd22
-  data.tar.gz: 5f915af0222e96de0adfdedebb06f29836afdb4fa4f9417d5182f8f9aa679ad3
+  metadata.gz: fce29c00b972834e2083e8c1b2a76fb8a89c9a79d7ff19ec830b119f2556f658
+  data.tar.gz: 946df902d9a95dd4861d0d3c1d71b8e9a3a4456230806bbe6ac201c5e5cbbfa9
 SHA512:
-  metadata.gz: 82d3aff0c40659a1fcbde114ac394170e0ed0e6406884cb3cda09ed966a5e5c7cf32482913ad57be0a7a6d3e4922217b22d5155143093d06606effc2d7691509
-  data.tar.gz: a080a10d094e60e3dcb94b434c04ba52ca85c5d5b6930c76a688fc012067a26c02b08dfc53ac1bb447b500285bdf05747d29622513f5cb3300b79564ddfc3b27
+  metadata.gz: 55685179100bc74b81339c9c220700094b70f42f8635793708d37ba6241482fbd28ad855cd147e59dc3c261bf84caf98d05ab38354ffc9ae7438152d0ea3e4db
+  data.tar.gz: 324b1ffb753da43fabbfba416be61895def6ad26f0c96452bd7d3c0947c5d48feba923a5a0c3ac7d1f202355ae98e2387aca1295b6dfa47452e0ca249edf5606

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adzerk_decision_sdk (1.0.0)
+    adzerk_decision_sdk (1.0.0.pre.beta.5)
       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/README.md

@@ -6,6 +6,8 @@ Ruby Software Development Kit for Adzerk Decision & UserDB APIs
 
 Requires [Ruby 2.5](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Table_of_versions) or higher.
 
+[RubyGem Package](https://rubygems.org/gems/adzerk_decision_sdk)
+
 ```shell
 gem install adzerk_decision_sdk
 ```
@@ -13,7 +15,7 @@ gem install adzerk_decision_sdk
 Or add to your `Gemfile`:
 
 ```ruby
-gem 'adzerk_decision_sdk', '~> 1.0.0'
+gem 'adzerk_decision_sdk', '~> 1.0.0-pre.beta.2'
 ```
 
 ## Examples
@@ -43,6 +45,20 @@ request = {
 pp client.decisions.get(request)
 ```
 
+### Recording Impression & Clicks
+
+Use with the fetch ad example above.
+
+```ruby
+# Impression pixel; fire when user sees the ad
+client.pixels.fire(decision.impression_url)
+
+# Click pixel; fire when user clicks on the ad
+# status: HTTP status code
+# location: click target URL
+status, location = client.pixels.fire(decision.click_url)
+```
+
 ### UserDB: Reading User Record
 
 ```ruby
@@ -59,7 +75,7 @@ pp client.user_db.read("abc")
 require "adzerk_decision_sdk"
 
 # Demo network ID; find your own via the Adzerk UI!
-client = AdzerkDecisionSdk::Client.new(network_id: 23, api_key: "YOUR_API_KEY")
+client = AdzerkDecisionSdk::Client.new(network_id: 23)
 
 props = {
   favoriteColor: "blue",
@@ -70,6 +86,16 @@ props = {
 client.user_db.set_custom_properties("abc", props)
 ```
 
+### UserDB: Forgetting User Record
+
+```ruby
+require "adzerk_decision_sdk"
+
+# Demo network ID and API key; find your own via the Adzerk UI!
+client = AdzerkDecisionSdk::Client.new(network_id: 23, api_key: "YOUR_API_KEY")
+client.user_db.forget("abc")
+```
+
 <!-- ### Logging Example
 
 TBD: ....... -->

data/adzerk_decision_sdk.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/docs/Content.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **type** | **String** |  | [optional] 
 **template** | **String** |  | [optional] 
 **custom_template** | **String** |  | [optional] 
-**data** | [**DecisionData**](DecisionData.md) |  | [optional] 
+**data** | [**Object**](.md) |  | [optional] 
 **body** | **String** |  | [optional] 
 
 ## Code Sample

data/docs/Decision.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **contents** | [**Array<Content>**](Content.md) |  | [optional] 
 **impression_url** | **String** |  | [optional] 
 **events** | [**Array<Event>**](Event.md) |  | [optional] 
+**matched_points** | [**Array<MatchedPoint>**](MatchedPoint.md) |  | [optional] 
 **pricing** | [**PricingData**](PricingData.md) |  | [optional] 
 
 ## Code Sample
@@ -29,6 +30,7 @@ instance = AdzerkDecisionSdk::Decision.new(ad_id: null,
                                  contents: null,
                                  impression_url: null,
                                  events: null,
+                                 matched_points: null,
                                  pricing: null)
 ```
 

data/docs/DecisionRequest.md

@@ -18,6 +18,10 @@ Name | Type | Description | Notes
 **enable_user_dbip** | **Boolean** | If true, override the IP address of the request with the IP address supplied on the UserKey. If no IP address is found on the UserKey, this will fall back to the IP address on the request. Requires UserDB | [optional] 
 **consent** | [**Object**](.md) | Object that sets the data consent preferences. Other consent settings are available in the GDPR settings documentation. | [optional] 
 **device_id** | **String** | RTB requests only - sets an Identifier for Advertisers (IFA or IDFA) | [optional] 
+**parallel** | **Boolean** |  | [optional] 
+**intended_latitude** | **String** |  | [optional] 
+**intended_longitude** | **String** |  | [optional] 
+**include_matched_points** | **Boolean** |  | [optional] 
 
 ## Code Sample
 
@@ -37,7 +41,11 @@ instance = AdzerkDecisionSdk::DecisionRequest.new(placements: null,
                                  enable_bot_filtering: null,
                                  enable_user_dbip: null,
                                  consent: null,
-                                 device_id: null)
+                                 device_id: null,
+                                 parallel: null,
+                                 intended_latitude: null,
+                                 intended_longitude: null,
+                                 include_matched_points: null)
 ```
 
 

data/docs/MatchedPoint.md

@@ -0,0 +1,19 @@
+# AdzerkDecisionSdk::MatchedPoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lat** | **String** |  | [optional] 
+**lon** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::MatchedPoint.new(lat: null,
+                                 lon: null)
+```
+
+

data/docs/Placement.md

@@ -20,6 +20,10 @@ 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] 
+**ecpm_partitions** | **Array<String>** | (BETA) The names of the eCPM Partitions that should be used to source eCPM data for auctions | [optional] 
+**event_multiplier** | **Integer** |  | [optional] 
+**skip_selection** | **Boolean** |  | [optional] 
+**ad_query** | [**Object**](.md) |  | [optional] 
 
 ## Code Sample
 
@@ -41,7 +45,11 @@ instance = AdzerkDecisionSdk::Placement.new(div_name: null,
                                  content_keys: null,
                                  count: null,
                                  proportionality: null,
-                                 ecpm_partition: null)
+                                 ecpm_partition: null,
+                                 ecpm_partitions: null,
+                                 event_multiplier: null,
+                                 skip_selection: null,
+                                 ad_query: null)
 ```
 
 

data/docs/RequestLocation.md

@@ -0,0 +1,19 @@
+# AdzerkDecisionSdk::RequestLocation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**latitude** | **String** |  | [optional] 
+**longitude** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::RequestLocation.new(latitude: null,
+                                 longitude: 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.rb

@@ -24,13 +24,13 @@ require 'adzerk_decision_sdk/configuration'
 require 'adzerk_decision_sdk/models/consent_request'
 require 'adzerk_decision_sdk/models/content'
 require 'adzerk_decision_sdk/models/decision'
-require 'adzerk_decision_sdk/models/decision_data'
 require 'adzerk_decision_sdk/models/event'
 require 'adzerk_decision_sdk/models/placement'
 require 'adzerk_decision_sdk/models/pricing_data'
 require 'adzerk_decision_sdk/models/decision_request'
 require 'adzerk_decision_sdk/models/decision_response'
 require 'adzerk_decision_sdk/models/user'
+require 'adzerk_decision_sdk/models/matched_point'
 
 # APIs
 require 'adzerk_decision_sdk/api/decision_api'

data/lib/adzerk_decision_sdk/api/decision_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/lib/adzerk_decision_sdk/api/userdb_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -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/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -269,11 +269,13 @@ module AdzerkDecisionSdk
         tempfile.write(chunk)
       end
       request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
       end
     end