adzerk_decision_sdk 1.0.0.pre.beta.1

data/lib/adzerk_decision_sdk/models/user.rb

@@ -0,0 +1,208 @@
+=begin
+#Adzerk Decision API
+
+#Adzerk Decision API
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'date'
+
+module AdzerkDecisionSdk
+  # Object containing the UserKey used for [UserDB targeting](https://dev.adzerk.com/docs/userdb-1)
+  class User
+    # The UserKey used for UserDB Targeting
+    attr_accessor :key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key' => :'key'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AdzerkDecisionSdk::User` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AdzerkDecisionSdk::User`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      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
+      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?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          key == o.key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        AdzerkDecisionSdk.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/adzerk_decision_sdk/pixel_client.rb

@@ -0,0 +1,26 @@
+require 'uri'
+require 'typhoeus'
+
+module AdzerkDecisionSdk
+  class PixelClient
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    def fire(url, revenue_override: nil, additional_revenue: nil)
+      uri = URI(url)
+      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?
+      uri.query = URI.encode_www_form(query_params)
+      new_url = uri.to_s()
+
+      request = @api_client.build_request(:GET, '')
+      request.base_url = new_url
+      response = request.run()
+      location = response.response_code == 302 ? response.headers['location'] : nil
+
+      [response.response_code, location]
+    end
+  end
+end

data/lib/adzerk_decision_sdk/rate_type.rb

@@ -0,0 +1,8 @@
+module RateType
+  FLAT = 1
+  CPM = 2
+  CPC = 3
+  CPA_VIEW = 4
+  CPA_CLICK = 5
+  CPA_VIEW_AND_CLICK = 6
+end

data/lib/adzerk_decision_sdk/user_db_client.rb

@@ -0,0 +1,64 @@
+require 'adzerk_decision_sdk/api/userdb_api'
+
+module AdzerkDecisionSdk
+  class UserDbClient
+    def initialize(network_id, api_client)
+      @network_id = network_id
+      @api = UserdbApi.new(api_client)
+    end
+
+    def set_custom_properties(user_key, properties, network_id: nil)
+      @api.add_custom_properties(network_id || @network_id, user_key, { body: properties })
+    end
+
+    def add_interest(user_key, interest, network_id: nil)
+      @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)
+      @api.add_retargeting_segment(network_id || @network_id, advertiser_id, retargeting_segment_id, user_key)
+    end
+
+    def forget(user_key, network_id: nil)
+      @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 })
+    end
+
+    def ip_override(user_key, ip, network_id: nil)
+      @api.ip_override(network_id || @network_id, user_key, ip)
+    end
+
+    def match_user(user_key, partner_id, user_id, network_id: nil)
+      @api.match_user(network_id || @network_id, user_key, partner_id, user_id)
+    end
+
+    def opt_out(user_key, network_id: nil)
+      @api.opt_out(network_id || @network_id, user_key)
+    end
+
+    def read(user_key, network_id: nil)
+      bad_keys = [
+        :cookieMonster,
+        :dirtyCookies,
+        :isNew,
+        :adViewTimes,
+        :advertiserViewTimes,
+        :flightViewTimes,
+        :siteViewTimes,
+        :campaignViewTimes,
+        :pendingConversions,
+        :campaignConversions
+      ]
+
+      user_record = @api.read(network_id || @network_id, user_key)
+
+      user_record.delete_if do |key, _|
+        bad_keys.include?(key)
+      end
+    end
+  end
+end

data/lib/adzerk_decision_sdk/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Adzerk Decision API
+
+#Adzerk Decision API
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+module AdzerkDecisionSdk
+  VERSION = '1.0.0-beta.1'
+end

data/lib/adzerk_decision_sdk.rb

@@ -0,0 +1,58 @@
+=begin
+#Adzerk Decision API
+
+#Adzerk Decision API
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'adzerk_decision_sdk/client'
+require 'adzerk_decision_sdk/event_type'
+require 'adzerk_decision_sdk/rate_type'
+
+# Common files
+require 'adzerk_decision_sdk/api_client'
+require 'adzerk_decision_sdk/api_error'
+require 'adzerk_decision_sdk/version'
+require 'adzerk_decision_sdk/configuration'
+
+# Models
+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'
+
+# APIs
+require 'adzerk_decision_sdk/api/decision_api'
+require 'adzerk_decision_sdk/api/userdb_api'
+
+# require 'adzerk_decision_sdk/client_options'
+# require 'adzerk_decision_sdk/client'
+
+module AdzerkDecisionSdk
+  class << self
+    # Customize default settings for the SDK using block.
+    #   AdzerkDecisionSdk.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/placeholder_spec.rb

@@ -0,0 +1,9 @@
+require "adzerk_decision_sdk"
+
+RSpec.describe AdzerkDecisionSdk::Client do
+  describe "#decisions.get" do
+    it "never fails" do
+      expect(true).to eq(true)
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: adzerk_decision_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta.1
+platform: ruby
+authors:
+- Adzerk, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  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:
+    - - "~>"
+      - !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
+description: Ruby library for the Adzerk Decision API
+email:
+- engineering@adzerk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- adzerk_decision_sdk.gemspec
+- docs/Consent.md
+- docs/ConsentRequest.md
+- 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/Placement.md
+- docs/PricingData.md
+- docs/Request.md
+- docs/RequestConsent.md
+- docs/Response.md
+- docs/User.md
+- docs/UserdbApi.md
+- git_push.sh
+- lib/adzerk_decision_sdk.rb
+- lib/adzerk_decision_sdk/api/decision_api.rb
+- lib/adzerk_decision_sdk/api/userdb_api.rb
+- lib/adzerk_decision_sdk/api_client.rb
+- lib/adzerk_decision_sdk/api_error.rb
+- lib/adzerk_decision_sdk/client.rb
+- lib/adzerk_decision_sdk/configuration.rb
+- lib/adzerk_decision_sdk/decision_client.rb
+- lib/adzerk_decision_sdk/event_type.rb
+- 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/placement.rb
+- lib/adzerk_decision_sdk/models/pricing_data.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
+- spec/.gitkeep
+- spec/placeholder_spec.rb
+homepage: http://adzerk.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Adzerk Decision API
+test_files:
+- spec/placeholder_spec.rb