Class: Neuron::Client::Ad

Inherits:
Object show all
Includes:
AdCalculations, Base
Defined in:
lib/neuron-client/model/ad.rb

Constant Summary collapse

ACTIVE_TTL =

seconds

60
PRESSURE_TTL =

seconds

60
REDIRECT = 
'Redirect'
VIDEO_AD = 
'VideoAd'
VAST_NETWORK = 
'VastNetwork'
ACUDEO_NETWORK = 
'AcudeoNetwork'
RESPONSE_TYPES = 
[REDIRECT, VIDEO_AD, VAST_NETWORK, ACUDEO_NETWORK]
SOCIAL_TYPES = 
%w(facebook googleplus twitter youtube)
TIME_ZONES = 
ActiveSupport::TimeZone.all.collect{|tz| tz.name }
FREQUENCY_CAP_WINDOWS = 
%w(Day Hour)
VAST_TRACKER_TYPES = 
%w(impression clickTracking firstQuartile midpoint thirdQuartile complete)
ATTRIBUTES = 
[
  # Basics
  :id, # integer
  :approved, # "Yes" or "No"
  :daily_cap, # nil, or integer > 1
  :day_partitions, # nil, or 168 characters of "T" and "F", Sunday first
  :end_datetime, # nil, or a datetime, in UTC
  :frequency_cap, # nil, or {"limit" => 1..10, "window" => in Ad::FREQUENCY_CAP_WINDOWS}
  :geo_target_netacuity_ids, # hash, where keys are in GeoTarget::TYPES, and values are arrays of integer IDs (from NetAcuity)
  :ideal_impressions_per_hour, # nil, or number > 0
  :name, # nil, or string with 255 chars or less
  :overall_cap, # nil, or integer >= 1
  :pixel_ids, # array of integers
  :response_type, # a string, in Ad::RESPONSE_TYPES
  :start_datetime, # a datetime, in UTC
  :time_zone, # a string, in Ad::TIME_ZONES.
  :zone_links, # a hash, with zone_ids as keys, and {"priority" => integer, "weight" => number} hashes as values.

  # Timestamps
  :created_at, :updated_at, # string, datetime in UTC

  # Counts
  :today_impressed, # nil, or integer >= 0
  :total_impressed, # nil, or integer >= 0

  # "Redirect" advertisements must have:
  :redirect_url, # a URI string

  # "VideoAd" advertisements must have:
  :video_flv_url, # a URI string (no macros)
  :clickthru_url, # a URI string, perhaps with macros
  :companion_ad_html, # nil, or a string (raw html, perhaps with macros)
  :social_urls, # a hash, where keys are in Ad::SOCIAL_TYPES and values are URI strings
  :vast_tracker_urls, # a hash, where keys are in Ad::VAST_TRACKER_TYPES and values are arrays of URI strings

  # "VastNetwork" advertisements must have:
  :vast_url, # a URI string, perhaps with macros

  # "AcudeoNetwork" advertisements must have:
  :acudeo_program_id, # a slug
]
STATISTIC_TYPES = 
%w(selections undeliveries impressions redirects clicks)

Instance Method Summary collapse

Methods included from AdCalculations

#calculate_active?, #calculate_pressure

Methods included from Base

#apply_attributes!, #destroy, #id=, included, #initialize, #new_record?, #save, #to_hash, #update_attributes, #valid?

Methods included from Base::ClassAndInstanceMethods

#all, #api=, #create, #create!, #find, #validate=

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
127
128
129
130
131
132
 
# File 'lib/neuron-client/model/ad.rb', line 124

def active?
  if connected_to_membase?
    connection.fetch("Ad:#{id}:active", ACTIVE_TTL) do
      calculate_active?(Time.now, total_impressed, today_impressed)
    end
  else
    calculate_active?(Time.now, total_impressed, today_impressed)
  end
end

#attributes ⇒ Object 



65
66
67
 
# File 'lib/neuron-client/model/ad.rb', line 65

def attributes
  ATTRIBUTES
end

#pressure ⇒ Object 



134
135
136
137
138
139
140
141
142
 
# File 'lib/neuron-client/model/ad.rb', line 134

def pressure
  if connected_to_membase?
    connection.fetch("Ad:#{id}:pressure", PRESSURE_TTL) do
      calculate_pressure(Time.now, total_impressed, today_impressed)
    end
  else
    calculate_pressure(Time.now, total_impressed, today_impressed)
  end
end

#recent(statistic, parameters = {}) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/neuron-client/model/ad.rb', line 71

def recent(statistic, parameters={})
  connected_to_admin!
  by = (parameters[:by] || parameters['by']).to_s
  minutes = parameters[:minutes] || parameters['minutes']
  group_by = parameters[:group_by] || parameters['group_by']
  parameters = {}
  parameters['by'] = by unless by.blank?
  parameters['minutes'] = minutes.to_i if minutes.to_i > 0
  parameters['group_by'] = group_by.to_s unless group_by.blank?
  if validate?
    unless STATISTIC_TYPES.include?(statistic.to_s)
      raise "Unsupported statistic: #{statistic}"
    end
    unless by.blank? || by == 'zone'
      raise "Unsupported by: #{by}"
    end
    unless minutes.blank? || minutes.to_i > 0
      raise "Unsupported minutes: #{minutes}"
    end
    unless group_by.blank? || group_by == 'hour'
      raise "Unsupported group_by: #{group_by}"
    end
  end

  connection.get("ads/#{id}/recent/#{statistic}", parameters)
end

#today_impressed ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/neuron-client/model/ad.rb', line 113

def today_impressed
  if connected_to_membase?
    now_adjusted_for_ad_time_zone = Time.now.in_time_zone(self.time_zone)
    formatted_date = now_adjusted_for_ad_time_zone.strftime('%Y%m%d') # format to YYYYMMDD
    key = "count_delivery_#{formatted_date}_ad_#{id}"
    connection.get(key,1).to_f
  else
    @today_impressed || 0
  end
end

#total_impressed ⇒ Object 



104
105
106
107
108
109
110
111
 
# File 'lib/neuron-client/model/ad.rb', line 104

def total_impressed
  if connected_to_membase?
    key = "count_delivery_ad_#{id}"
    connection.get(key,1).to_f
  else
    @total_impressed || 0
  end
end

#unlink(zone_id) ⇒ Object 



98
99
100
101
102
 
# File 'lib/neuron-client/model/ad.rb', line 98

def unlink(zone_id)
  connected_to_admin!
  validate_uuid!(zone_id)
  connection.delete("ads/#{id}/zones/#{zone_id}")
end