adzerk_decision_sdk 1.0.0.pre.beta.3 → 1.0.0.pre.beta.8

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)
-      @api.add_custom_properties(network_id || @network_id, user_key, { body: properties })
+      @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, { debug_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
-      @api.gdpr_consent(network_id || @network_id, { body: body })
+      @logger.info("Setting GDPR consent on #{network_id || @network_id} with: #{body}")
+      @api.gdpr_consent(network_id || @network_id, { debug_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.8'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+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.8
 platform: ruby
 authors:
 - Adzerk, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -31,45 +31,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: Ruby library for the Adzerk Decision API
 email:
 - engineering@adzerk.com
@@ -87,15 +67,16 @@ files:
 - docs/Content.md
 - docs/Decision.md
 - docs/DecisionApi.md
-- docs/DecisionData.md
 - docs/DecisionRequest.md
 - docs/DecisionResponse.md
 - docs/Event.md
 - docs/GdprConsent.md
+- docs/MatchedPoint.md
 - docs/Placement.md
 - docs/PricingData.md
 - docs/Request.md
 - docs/RequestConsent.md
+- docs/RequestLocation.md
 - docs/Response.md
 - docs/User.md
 - docs/UserdbApi.md
@@ -112,22 +93,21 @@ files:
 - lib/adzerk_decision_sdk/models/consent_request.rb
 - lib/adzerk_decision_sdk/models/content.rb
 - lib/adzerk_decision_sdk/models/decision.rb
-- lib/adzerk_decision_sdk/models/decision_data.rb
 - lib/adzerk_decision_sdk/models/decision_request.rb
 - lib/adzerk_decision_sdk/models/decision_response.rb
 - lib/adzerk_decision_sdk/models/event.rb
+- lib/adzerk_decision_sdk/models/matched_point.rb
 - lib/adzerk_decision_sdk/models/placement.rb
 - lib/adzerk_decision_sdk/models/pricing_data.rb
+- lib/adzerk_decision_sdk/models/request_location.rb
 - lib/adzerk_decision_sdk/models/user.rb
 - lib/adzerk_decision_sdk/pixel_client.rb
 - 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
 - spec/.gitkeep
 - spec/placeholder_spec.rb
+- spec/spec_helper.rb
 homepage: http://adzerk.com
 licenses:
 - Apache-2.0
@@ -140,16 +120,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Adzerk Decision API
 test_files:
 - spec/placeholder_spec.rb
+- spec/spec_helper.rb

data/docs/DecisionData.md

@@ -1,27 +0,0 @@
-# AdzerkDecisionSdk::DecisionData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**image_url** | **String** |  | [optional] 
-**file_name** | **String** |  | [optional] 
-**title** | **String** |  | [optional] 
-**width** | **Integer** |  | [optional] 
-**height** | **Integer** |  | [optional] 
-**custom_data** | [**Object**](.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'AdzerkDecisionSdk'
-
-instance = AdzerkDecisionSdk::DecisionData.new(image_url: null,
-                                 file_name: null,
-                                 title: null,
-                                 width: null,
-                                 height: null,
-                                 custom_data: null)
-```
-
-