Class: AdzerkDecisionSdk::DecisionClient

Inherits:
Object
  • Object
show all
Defined in:
lib/adzerk_decision_sdk/decision_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(network_id, site_id, api_client, logger) ⇒ DecisionClient

Returns a new instance of DecisionClient.



6
7
8
9
10
11
12
 
# File 'lib/adzerk_decision_sdk/decision_client.rb', line 6

def initialize(network_id, site_id, api_client, logger)
  @network_id = network_id
  @site_id = site_id
  @api = DecisionApi.new(api_client)
  @logger = logger
  @deprecated_placement_fields = [[:ecpm_partition, 'ecpm_partitions']]
end

Instance Method Details

#get(request, opts = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/adzerk_decision_sdk/decision_client.rb', line 14

def get(request, opts = {})
  opts ||= {}
  header_params = opts[:header_params] || {}
  opts[:debug_body] ||= request.respond_to?('to_hash') ? request.to_hash() : request

  @logger.info("Processing request: #{opts[:debug_body]}")

  opts[:debug_body][:enableBotFiltering] = false if not opts[:debug_body].has_key?(:enableBotFiltering)

  if !opts[:debug_body].has_key?(:placements) or !opts[:debug_body][:placements] or opts[:debug_body][:placements].length() == 0
    fail ArgumentError, "Each request requires at least one placement"
  end

  opts[:debug_body][:placements].each_with_index do |placement, idx|
    if !placement.has_key?(:adTypes) or !placement[:adTypes] or placement[:adTypes].length() == 0
      fail ArgumentError, "Each placement needs at least one ad type"
    end

    @deprecated_placement_fields.each do |pair|
      deprecated_field, replacement = pair
      if placement.has_key?(deprecated_field) and !placement[deprecated_field].nil?
        @logger.warn("DEPRECATION WARNING: #{deprecated_field} has been deprecated. Please use #{replacement} instead.")
      end
    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
    if opts[:desired_ads]
      header_object = {
        api_key: opts[:api_key],
        desired_ads: opts[:desired_ads]
      }
      header_params['X-Adzerk-Explain'] = header_object.to_json
    end

    if opts[:desired_ad_map]
      header_object = {
        api_key: opts[:api_key],
        desired_ad_map: opts[:desired_ad_map]
      }
      header_params['X-Adzerk-Explain'] = header_object.to_json
    end

    header_params['X-Adzerk-Explain'] = opts[:api_key]
    @logger.warn("--------------------------------------------------------------")
    @logger.warn("              !!! WARNING - WARNING - WARNING !!!             ")
    @logger.warn("")
    @logger.warn("You have opted to include explainer details with this request!")
    @logger.warn("This will cause performance degradation and should not be done")
    @logger.warn("in production environments.")
    @logger.warn("--------------------------------------------------------------")
  end

  opts[:header_params] = header_params

  @logger.info("Processed request: #{opts[:debug_body]}")
  @logger.info("Requesting with headers: #{opts[:header_params]}")

  response = @api.get_decisions(opts)
  @logger.info("Received response: #{response}")

  parsed_response = parse_response(response)
  @logger.info("Parsed response: #{parsed_response}")

  return parsed_response
end