adzerk_decision_sdk 1.0.0.pre.beta.1

data/lib/adzerk_decision_sdk/configuration.rb

@@ -0,0 +1,262 @@
+=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
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'e-23.adzerk.net'
+      @base_path = ''
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'ApiKeyAuth' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-Adzerk-ApiKey',
+            value: api_key_with_prefix('X-Adzerk-ApiKey')
+          },
+      }
+    end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "{protocol}://e-{networkId}.adzerk.net",
+          description: "No description provided",
+          variables: {
+            protocol: {
+                description: "No description provided",
+                default_value: "https",
+                enum_values: [
+                  "http",
+                  "https"
+                ]
+              },
+            networkId: {
+                description: "Your Adzerk Network Id",
+                default_value: "23",
+              }
+            }
+        }
+      ]
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {})
+      servers = server_settings
+
+      # check array index out of bound
+      if (index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (server[:variables][name][:enum_values].include? variables[name])
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+  end
+end

data/lib/adzerk_decision_sdk/decision_client.rb

@@ -0,0 +1,73 @@
+require 'adzerk_decision_sdk/api/decision_api'
+
+module AdzerkDecisionSdk
+  class DecisionClient
+    def initialize(network_id, site_id, api_client, logger)
+      @network_id = network_id
+      @site_id = site_id
+      @api = DecisionApi.new(api_client)
+      @logger = logger
+    end
+
+    def get(request, opts = {})
+      opts ||= {}
+      header_params = opts[:header_params] || {}
+      opts[:body] ||= request.respond_to?('to_hash') ? request.to_hash() : request
+
+      @logger.info("Processing request: #{opts[:body]}")
+
+      opts[:body][:enableBotFiltering] = false if not opts[:body].has_key?(:enableBotFiltering)
+
+      if !opts[:body].has_key?(:placements) or !opts[:body][:placements] or !opts[:body][:placements].length() == 0
+        fail ArgumentError, "Each request requires at least one placement"
+      end
+
+      opts[:body][:placements].each_with_index do |placement, idx|
+        if !placement.has_key?(:adTypes) or !placements[:adTypes] or placement[:adTypes].length() == 0
+          fail ArgumentError, "Each placement needs at least one ad type"
+        end
+        placement[:networkId] = @network_id if not placement.has_key?(:networkId)
+        placement[:siteId] = @site_id if not placement.has_key?(:siteId)
+        placement[:divName] = "div#{idx}" if not placement.has_key?(:divName)
+      end
+
+      header_params['User-Agent'] = opts[:user_agent] if opts.has_key?(:user_agent)
+
+      if opts.has_key?(:include_explanation) and opts[:include_explanation] == true
+        header_params['X-Adzerk-Explain'] = opts[:api_key]
+        @logger.info("--------------------------------------------------------------")
+        @logger.info("              !!! WARNING - WARNING - WARNING !!!             ")
+        @logger.info("")
+        @logger.info("You have opted to include explainer details with this request!")
+        @logger.info("This will cause performance degradation and should not be done")
+        @logger.info("in production environments.")
+        @logger.info("--------------------------------------------------------------")
+      end
+
+      opts[:header_params] = header_params
+
+      @logger.info("Processed request: #{opts[:body]}")
+      @logger.info("Requesting with headers: #{opts[:header_params]}")
+
+      response = @api.get_decisions(opts)
+
+      parsed_response = parse_response(response)
+      @logger.info("Recieved response: #{parsed_response}")
+
+      return parsed_response
+    end
+
+    private
+
+    def parse_response(response)
+      response.decisions.keys.each do |k|
+        response.decisions[k] = response.decisions[k].is_a?(Array) ?  response.decisions[k] : [response.decisions[k]]
+        response.decisions[k].each_with_index do |d, i|
+          response.decisions[k][i] = AdzerkDecisionSdk::Decision.build_from_hash(d)
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/adzerk_decision_sdk/event_type.rb

@@ -0,0 +1,61 @@
+module EventType
+  VIEW_CONVERSION = 1
+  CLICK_CONVERSION = 2
+  SERVER_TO_SERVER_CONVERSION = 3
+  UPVOTE = 10
+  DOWNVOTE = 11
+  DOWNVOTE_UNINTERESTING = 12
+  DOWNVOTE_MISLEADING = 13
+  DOWNVOTE_OFFENSIVE = 14
+  DOWNVOTE_REPETITIVE = 15
+  DOWNVOTE_OTHER = 16
+  CLOSE_AD = 17
+  LIKE = 20
+  SHARE = 21
+  COMMENT = 22
+  COMMENT_REPLY = 101
+  COMMENT_UPVOTE = 102
+  COMMENT_DOWNVOTE = 103
+  VISIBLE = 30
+  HOVER = 31
+  EXPAND_DIV = 32
+  VIEWABLE_IMPRESSION = 40
+  SHARE_ON_FACEBOOK = 50
+  SHARE_ON_TWITTER = 51
+  SHARE_ON_PINTEREST = 52
+  SHARE_ON_REDDIT = 53
+  SHARE_ON_EMAIL = 54
+  VIDEO_START = 70
+  VIDEO_FIRST_QUARTILE = 71
+  VIDEO_MID_POINT = 72
+  VIDEO_THIRD_QUARTILE = 73
+  VIDEO_COMPLETE = 74
+  VIDEO_MUTE = 75
+  VIDEO_UNMUTE = 76
+  VIDEO_PAUSE = 77
+  VIDEO_REWIND = 78
+  VIDEO_RESUME = 79
+  VIDEO_FULL_SCREEN = 80
+  VIDEO_EXIT_FULL_SCREEN = 81
+  VIDEO_EXPAND = 82
+  VIDEO_COLLAPSE = 83
+  VIDEO_ACCEPT_INVITATION_LINEAR = 84
+  VIDEO_CLOSE_LINEAR = 85
+  VIDEO_SKIP = 86
+  VIDEO_PROGRESS = 87
+  VIDEO_ZERO_SECONDS_VIEWED = 400
+  VIDEO_ONE_SECONDS_VIEWED = 401
+  VIDEO_TWO_SECONDS_VIEWED = 402
+  VIDEO_THREE_SECONDS_VIEWED = 403
+  VIDEO_FOUR_SECONDS_VIEWED = 404
+  VIDEO_FIVE_SECONDS_VIEWED = 405
+  VIDEO_SIX_SECONDS_VIEWED = 406
+  VIDEO_SEVEN_SECONDS_VIEWED = 407
+  VIDEO_EIGHT_SECONDS_VIEWED = 408
+  VIDEO_NINE_SECONDS_VIEWED = 409
+  VIDEO_TEN_SECONDS_VIEWED = 410
+  VIDEO_FIFTEEN_SECONDS_VIEWED = 415
+  VIDEO_TWENTY_SECONDS_VIEWED = 420
+  VIDEO_TWENTY_FIVE_SECONDS_VIEWED = 425
+  VIDEO_THIRTY_SECONDS_VIEWED = 430
+end

data/lib/adzerk_decision_sdk/models/consent_request.rb

@@ -0,0 +1,215 @@
+=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
+  class ConsentRequest
+    attr_accessor :user_key
+
+    attr_accessor :consent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_key' => :'userKey',
+        :'consent' => :'consent'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_key' => :'String',
+        :'consent' => :'Object'
+      }
+    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::ConsentRequest` 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::ConsentRequest`. 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?(:'user_key')
+        self.user_key = attributes[:'user_key']
+      end
+
+      if attributes.key?(:'consent')
+        self.consent = attributes[:'consent']
+      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 &&
+          user_key == o.user_key &&
+          consent == o.consent
+    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
+      [user_key, consent].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