advert_selector 1.0.0

data/app/helpers/advert_selector/application_helper.rb

@@ -0,0 +1,155 @@
+module AdvertSelector
+  module ApplicationHelper
+
+    def advert_selector_initialize(available_placements = :all)
+      Rails.logger.tagged('AdvertSelector') do
+
+        Rails.logger.debug("AdvertSelection initialized")
+
+        @advert_selector_banners_selected = []
+
+        if params[:advert_selector_force]
+          $advert_selector_banners_load_time = nil # reload everything
+          if banner = Banner.find_by_id(params[:advert_selector_force])
+            advert_selector_banner_force(banner)
+          end
+        end
+
+        advert_selector_banners.each do |banner|
+          if available_placements == :all || available_placements.include?(banner.placement.name_sym)
+            advert_selector_banner_try(banner)
+          end
+        end
+
+        Rails.logger.debug("AdvertSelection finished")
+      end
+      ""
+    end
+
+    def advert_selector_force_test_infos
+      if @advert_selector_force_banner_infos
+        content_tag :div, :id => "advert_selector_info", :class => 'alert alert-info', :style => "position: fixed; bottom: 5px;" do
+          content_tag(:strong) { "AdvertSelectorInfos for HelperItems:<br/>".html_safe } +
+          content_tag(:ul) {
+            @advert_selector_force_banner_infos.to_a.collect{|k, v| content_tag(:li){"#{k} : #{h(v)}".html_safe} }.join("\n").html_safe
+          }
+        end
+      end
+
+    end
+
+
+    def advert_selector_banner_try(banner)
+
+      if banner.show_now_basics? &&
+          advert_selector_placement_free?(banner.placement) &&
+          advert_selector_placement_once_per_session_ok?(banner.placement) &&
+          advert_selector_banner_frequency_ok?(banner)
+
+        banner.helper_items.each do |hi|
+          if hi.content_for?
+            content_for hi.name_sym, hi.content.html_safe
+          else
+            return unless send("advert_selector_#{hi.name}", hi)
+          end
+        end
+
+        advert_selector_placement_once_per_session_shown(banner.placement)
+        advert_selector_banner_frequency_shown(banner)
+
+        banner.add_one_viewcount unless request.user_agent =~ /bot/i
+
+        @advert_selector_banners_selected.push(banner)
+
+        Rails.logger.info("Showing banner #{banner.name} in placement #{banner.placement.name}")
+      end
+
+    rescue => e
+      begin
+        str = "Error with banner #{banner.name} in placement #{banner.placement.name}.\n#{Time.now.iso8601} - #{request.url} - #{params.inspect}\n#{e.inspect}\n\n#{e.backtrace.first(10).join("\n")}"
+
+        AdvertSelector::ErrorsCache.add(str)
+        Rails.logger.error(str)
+      rescue => e
+        Rails.logger.error("ERROR INSIDE ERROR with #{banner.name} in placement #{banner.placement.name} : #{e.inspect}")
+      end
+    end
+
+    def advert_selector_banner_force(banner)
+      @advert_selector_force_banner_infos  = []
+      @advert_selector_force_banner_infos.push [:show_now_basics_times_not_used, banner.show_now_basics?(false)]
+      @advert_selector_force_banner_infos.push [:show_now_basics_with_times, banner.show_now_basics?]
+      @advert_selector_force_banner_infos.push [:placement_free, advert_selector_placement_free?(banner.placement)]
+      @advert_selector_force_banner_infos.push [:placement_once_per_session, advert_selector_placement_once_per_session_ok?(banner.placement)]
+      @advert_selector_force_banner_infos.push [:frequency, advert_selector_banner_frequency_ok?(banner)]
+      banner.helper_items.each do |hi|
+        @advert_selector_force_banner_infos.push [hi.name_sym,
+                                                           if hi.content_for?
+                                                             content_for hi.name_sym, hi.content.html_safe
+                                                             content_for(hi.name_sym).first(20)
+                                                           else
+                                                             send("advert_selector_#{hi.name}", hi)
+                                                           end]
+      end
+
+      @advert_selector_banners_selected.push(banner)
+      Rails.logger.info("ForceShowing banner #{banner.name} in placement #{banner.placement.name}")
+
+    end
+
+    def advert_selector_placement_free?(placement)
+      !placement.conflicting_with?(@advert_selector_banners_selected.collect{|b| b.placement.name_sym})
+    end
+
+    def advert_selector_placement_once_per_session_ok?(placement)
+      !(  placement.only_once_per_session? && session[:advert_selector_session_shown] &&
+          session[:advert_selector_session_shown].include?(placement.name) )
+    end
+    def advert_selector_placement_once_per_session_shown(placement)
+      if placement.only_once_per_session?
+        session[:advert_selector_session_shown] = [] if session[:advert_selector_session_shown].nil?
+        session[:advert_selector_session_shown].push(placement.name)
+      end
+    end
+
+    def advert_selector_banner_frequency_cookie(banner)
+      val, time = cookies["ad_#{banner.id}"].to_s.split(",")
+      [val.to_i, time]
+    end
+    def advert_selector_banner_frequency_ok?(banner)
+      !banner.has_frequency? || advert_selector_banner_frequency_cookie(banner).first < banner.frequency
+    end
+    def advert_selector_banner_frequency_shown(banner)
+      return true unless banner.has_frequency?
+
+      val, time = advert_selector_banner_frequency_cookie(banner)
+      time = time.blank? ? 1.week.from_now : Time.parse(time)
+      val += 1
+      cookies["ad_#{banner.id}"] = {:domain => :all, :expires => time, :value => [val, time.iso8601].join(",") }
+    end
+
+    ##########################################################
+
+    def advert_selector_request_params_include?(placement)
+      key, val = placement.content.to_s.split("=")
+      return params[key] == val
+    end
+
+
+    ##########################################################
+
+    $advert_selector_banners = []
+    $advert_selector_banners_load_time = nil
+    def advert_selector_banners
+      if $advert_selector_banners_load_time.nil? || $advert_selector_banners_load_time < 10.minutes.ago || Rails.env.development?
+        Rails.logger.info("AdvertSelection fetching banners and placements")
+        $advert_selector_banners_load_time = Time.now
+
+        $advert_selector_banners = Banner.find_current
+      end
+
+      $advert_selector_banners
+    end
+
+  end
+end

data/app/models/advert_selector/banner.rb

@@ -0,0 +1,107 @@
+module AdvertSelector
+  class Banner < ActiveRecord::Base
+    attr_accessible :comment, :confirmed, :start_time, :end_time,
+                    :frequency, :name, :placement_id, :target_view_count, :priority,
+                    :fast_mode, :helper_items_attributes
+
+    belongs_to :placement, :inverse_of => :banners
+
+    has_many :helper_items, :order => "position", :dependent => :destroy
+    accepts_nested_attributes_for :helper_items
+
+    scope :find_future, lambda {
+      order('priority desc').
+          where('end_time > ? OR end_time IS NULL', Time.now).
+          includes(:placement, :helper_items)
+    }
+    scope :find_current, lambda {
+      find_future.
+          where('start_time < ? OR start_time IS NULL', 1.hour.from_now).
+          where('target_view_count IS NULL OR target_view_count > running_view_count')
+    }
+
+    # todo validates
+    # validate placement
+
+    def name_sym
+      @name_sym ||= name.downcase.to_sym
+    end
+
+    def has_frequency?
+      !frequency.nil? && frequency > 0
+    end
+
+    def show_today_has_viewcounts?(current_view_count = nil)
+      return true if target_view_count.nil? || fast_mode?
+
+      current_view_count = running_view_count if current_view_count.nil?
+
+      return false if current_view_count >= target_view_count
+
+      @show_now_today_target ||=
+          if target_view_count.nil? || end_time.nil? || end_time < 24.hours.from_now
+            true
+          else
+            #view_count_remaining = target_view_count - current_view_count
+
+            total_days = ((end_time - start_time)/1.day).round
+            daily_view_count = target_view_count/total_days
+
+            days_ending_today = ((Time.now.end_of_day - start_time)/1.day).round
+            days_ending_today * daily_view_count
+          end
+
+      @show_now_today_target == true || current_view_count < @show_now_today_target
+    end
+
+    def show_now_basics?(use_time_limits = true)
+      confirmed? &&
+        (!use_time_limits || start_time.nil? || start_time < Time.now) &&
+        (!use_time_limits || end_time.nil? || Time.now < end_time) &&
+        show_today_has_viewcounts?
+    end
+
+    def reload
+      super
+      reset_cache
+    end
+
+    def cache_key
+      "AdvertSelectorBanner_#{id}"
+    end
+
+    def running_view_count
+      counter = Rails.cache.read(cache_key).to_i
+      counter = 0 if $advert_selector_avoid_cache
+      counter = self[:running_view_count] if counter < self[:running_view_count]
+      counter
+    end
+
+    def reset_cache
+      Rails.cache.write(cache_key, nil, :expires_in => 2.weeks)
+      @show_now_today_target = nil
+      @name_sym = nil
+    end
+
+    def add_one_viewcount
+      unless self.target_view_count.nil?
+
+        counter = running_view_count + 1
+        Rails.cache.write(cache_key, counter, :expires_in => 2.weeks)
+        self[:running_view_count] = counter
+
+        since_update = running_view_count_change.last - running_view_count_change.first
+        self.save if since_update >= 500 || counter >= target_view_count
+      end
+    end
+
+    after_save :after_save_destroy_empty_helpers
+    def after_save_destroy_empty_helpers
+      helper_items.each do |hi|
+        hi.destroy if hi.blank?
+      end
+    end
+
+  end
+
+end

data/app/models/advert_selector/helper_item.rb

@@ -0,0 +1,21 @@
+module AdvertSelector
+  class HelperItem < ActiveRecord::Base
+    attr_accessible :master_id, :master_type, :name, :position, :content_for, :content
+
+    #belongs_to :master, :polymorphic => true
+    #acts_as_list :scope => [:master_id, :master_type]
+
+    belongs_to :banner, :class_name => 'AdvertSelector::Banner'
+    acts_as_list :scope => :banner_id
+
+
+    def name_sym
+      @name_sym ||= name.downcase.to_sym
+    end
+
+    def blank?
+      name.blank?
+    end
+
+  end
+end

data/app/models/advert_selector/placement.rb

@@ -0,0 +1,58 @@
+module AdvertSelector
+  class Placement < ActiveRecord::Base
+    attr_accessible :conflicting_placements_array, :name, :comment, :request_delay, :only_once_per_session
+
+    has_many :banners, :inverse_of => :placement
+
+    scope :by_name, lambda {|name| where("LOWER(name) = ?", name.to_s.downcase)}
+
+    def name_sym
+      @name_sym ||= name.to_s.downcase.to_sym unless name.blank?
+    end
+
+
+    def conflicting_with?(placement_syms)
+      placement_syms = [placement_syms.name_sym] if placement_syms.is_a?(Placement)
+      placement_syms = placement_syms.collect{|plac| plac.name_sym} if placement_syms.first.is_a?(Placement)
+
+      !(placement_syms & conflicting_placements).empty?
+    end
+
+    def self.conflicting_placements(string)
+      string.to_s.split(/[ ,]/).collect{|name| name.strip}.reject{|name| name.blank?}.collect{|name| name.to_sym}.sort_by{|sym| sym.to_s}.uniq
+    end
+
+    def conflicting_placements
+      @conflicting_placements ||= ([self.name_sym] + Placement.conflicting_placements(conflicting_placements_array))
+    end
+
+    def conflicting_placements_array=(string)
+      string = string.join(",") if string.is_a?(Array)
+      arr = Placement.conflicting_placements( string )
+      arr.delete(name_sym)
+      self[:conflicting_placements_array] = arr.join(",")
+    end
+
+    after_save :after_save_update_conflicting_placements_info
+    def after_save_update_conflicting_placements_info
+      if conflicting_placements_array_changed?
+        saved_org = Placement.conflicting_placements(conflicting_placements_array_change.first)
+        saved_new = Placement.conflicting_placements(conflicting_placements_array_change.last)
+
+        (saved_org-saved_new).each do |name|
+          if placement = Placement.by_name(name).first
+            placement.conflicting_placements_array = placement.conflicting_placements.reject{|var| var == name_sym}
+            placement.save if placement.conflicting_placements_array_changed?
+          end
+        end
+        saved_new.each do |name|
+          if placement = Placement.where(:name => name).first
+            placement.conflicting_placements_array = placement.conflicting_placements.push(name_sym)
+            placement.save if placement.conflicting_placements_array_changed?
+          end
+        end
+      end
+    end
+
+  end
+end

data/app/views/advert_selector/banners/_form.html.erb

@@ -0,0 +1,42 @@
+<%= simple_form_for(@banner, :html => {:class => 'form-horizontal'}) do |f| %>
+  <%= f.error_notification %>
+
+  <div class="row">
+    <div class="span5">
+
+      <%= f.input :name %>
+
+      <%= f.input :start_time, :as => 'string', :input_html => {:value => (@banner.start_time ? @banner.start_time.iso8601 : '')} %>
+      <%= f.input :end_time, :as => 'string', :input_html => {:value => (@banner.end_time ? @banner.end_time.iso8601 : '')} %>
+      <%= f.input :priority %>
+      <%= f.input :target_view_count %>
+      <%= f.input :fast_mode %>
+      <%= f.input :frequency %>
+      <%= f.input :comment, :input_html => {:rows => 5}  %>
+      <%= f.input :confirmed, :label_html => {:style => ((@banner.new_record? || @banner.confirmed?) ? '' : 'color: red; font-weight: bold')} %>
+      <%= f.association :placement %>
+
+    </div>
+
+    <div class="span4">
+      <% @banner.helper_items.build
+         @banner.helper_items.build if @banner.helper_items.size < 2
+      %>
+      <%= f.fields_for :helper_items do |f_hi| %>
+        <fieldset style="margin-bottom: 20px; border-bottom: 1px solid lightgray;">
+        <%= f_hi.input :name, :label => 'HelperItem Name' %>
+        <%= f_hi.input :content_for %>
+        <%= f_hi.input :position %>
+        <%= f_hi.input :content, :input_html => {:rows => (f_hi.object.content_for? ? 5 : 1) } %>
+        </fieldset>
+      <% end %>
+    </div>
+
+  </div>
+
+  <div class="form-actions">
+    <%= f.button :submit %>
+  </div>
+
+
+<% end %>

data/app/views/advert_selector/banners/edit.html.erb

@@ -0,0 +1,29 @@
+<h1>Banner <%= @banner.name %> <small> - <%= link_to('Duplicate banner', new_banner_url(:duplicate_id => @banner.id)) %></small></h1>
+
+<% unless @banner.target_view_count.nil? %>
+  <strong>Current view count:</strong> <%= @banner.running_view_count %> / <%= @banner.target_view_count %>
+  &nbsp;&nbsp;|&nbsp;&nbsp;
+<% end %>
+
+<br/>
+
+Test banner in url :
+
+<input type="text" name="test_url" id="test_url" style="width: 500px;" value="<%= AdvertSelector.default_banner_test_url + "advert_selector_force=#{@banner.id}" %>">
+<button class="btn btn-info" type="button" onclick="window.open(document.getElementById('test_url').value)">Test</button>
+
+<hr/>
+
+<%= render 'form' %>
+
+
+<hr/>
+
+<%= simple_form_for(@banner, :url => update_running_view_count_banner_url(@banner), :html => {:class => 'form-inline'}) do |f| %>
+
+  <strong>Running view count:</strong>
+  <input class="numeric integer optional" id="banner_running_view_count" name="banner[running_view_count]" step="1" value="<%= @banner.running_view_count %>" type="number">
+
+  <%= f.button :submit, 'Change running view count' %>
+
+<% end %>

data/app/views/advert_selector/banners/index.html.erb

@@ -0,0 +1,38 @@
+<h1>Listing banners</h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Start time</th>
+    <th>End time</th>
+    <th>Target view count</th>
+    <th>Frequency</th>
+    <th>Delay requests</th>
+    <th>Comment</th>
+    <th>Confirmed</th>
+    <th>Placement</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @banners.each do |banner| %>
+  <tr>
+    <td><%= banner.name %></td>
+    <td><%= banner.start_time %></td>
+    <td><%= banner.end_time %></td>
+    <td><%= banner.target_view_count %></td>
+    <td><%= banner.frequency %></td>
+    <td><%= banner.comment %></td>
+    <td><%= banner.confirmed %></td>
+    <td><%= banner.placement_id %></td>
+    <td><%= link_to 'Show', banner %></td>
+    <td><%= link_to 'Edit', edit_banner_path(banner) %></td>
+    <td><%= link_to 'Destroy', banner, :method => :delete, :data => { :confirm => 'Are you sure?' } %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Banner', new_banner_path %>