advert_selector 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# AdvertSelector
+
+Rails adserver tool for selecting a smaller subset of banners from all
+possible banners with differing banner placement combinations. Gem
+includes admin tools for handling banners in live
+environment. Includes basic targeting, viewcount, frequency etc
+setups.
+
+Good for deciding e.g. what height of header banner you will have
+during the initial requests without extra javascript calls to
+adserver. This helps to avoid problems of browser not knowing what
+size of banner there is and enables browser to render the whole page
+faster.
+
+[<img src="https://secure.travis-ci.org/holli/advert_selector.png" />](http://travis-ci.org/holli/advert_selector)
+
+## Features
+
+- selecting small subset of (advert) banners from multiple banners
+  - banners can be also be any kind of widgets
+- defining banners
+  - setting filters to banners in a rails friendly way
+- defining placements
+  - setting conflicting placements
+  - setting filters for placements
+- admin tools
+  - editing everything
+  - testing banners before setting it to live env
+  - showing information in banner testing
+  - showing error log if there is a problem in banner filters
+
+## Install
+
+```
+in /gemfile
+  gem 'advert_selector'
+
+# Run following
+# bundle
+# bundle exec rake railties:install:migrations
+# rake db:migrate
+
+in top of views/layouts/your_layout
+  <% advert_selector_initialize(:all) %>
+  and if you want testing info then at the bottom
+  <%= advert_selector_force_test_infos %>
+
+set to somewhere in your layout e.g.
+  <%= content_for :banner_header %>
+
+in config/routes
+  mount AdvertSelector::Engine => "/advert_selector"
+
+test the admin tool in url
+  http://localhost:3000/advert_selector/
+
+```
+
+## Configuration
+
+
+```
+set extra_configuration in /config/initializers/advert_selector.rb
+
+
+AdvertSelector.default_banner_test_url = "http://yourdomain.com/?"
+self.default_time_zone = 'Helsinki'
+
+class AdminAccessToGemTools
+  def self.admin_access(controller)
+    if !controller.session[:admin_logged].blank? || Rails.env.development?
+      return true
+    else
+      return false
+    end
+  end
+end
+AdvertSelector.admin_access_class = AdminAccessToGemTools
+
+
+```
+
+
+## Trageting / Content / HelperItem
+
+All contents and targetings are done through HelperItem-model.
+
+### For targeting define custom helpers alongside your normal viewhelpers. Start by name advert_selector. E.g
+
+```
+module AdvertSelectorHelper
+  def advert_selector_targeting_gender?(helper_item)
+    params[:gender] == helper_item.content
+  end
+end
+
+And in banner define HelperItem with name 'targeting_age?' and content 'male'. After that the banner would be shown only with
+requests that has param[:gender]='male'.
+
+```
+
+### For displaying banner content
+
+HelperItems that are tagged with content_for are used with content_for method in rails. E.g. HelperItem.name = :banner_header
+and then in your views you display results by <%= content_for :banner_header %>
+
+## Inside
+
+Banners are read to ruby processes memory once every 10 minutes from sql database. 
+Gem uses Rails.cache to cache viewcount of banners. Viewcount is updated to db once in a while. 
+
+Remember that this is not the real viewcount that more advanced banner handling systems have. Bots e.g. will increase the viewcount number
+
+
+## Some links you might also consider
+
+- http://www.openx.com/
+- http://www.google.com/dfp/info/sb/index.html
+
+## Requirements
+
+Gem has been tested with ruby 1.8.7, 1.9.2 and Rails 3.2.
+
+[<img src="https://secure.travis-ci.org/holli/advert_selector.png" />](http://travis-ci.org/holli/advert_selector)
+
+## Support
+
+Submit suggestions or feature requests as a GitHub Issue or Pull Request. Remember to update tests. Tests are quite extensive.
+
+## Licence
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AdvertSelector'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/advert_selector/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//  = require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/advert_selector/application.css

@@ -0,0 +1,29 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */
+
+
+
+body {
+    padding-top: 60px;
+    padding-bottom: 40px;
+}
+.sidebar-nav {
+    padding: 9px 0;
+}
+
+.form-horizontal .control-group { margin-bottom: 10px; }
+
+label, input, button, select, textarea { font-size: 12px !important; }
+
+

data/app/controllers/advert_selector/application_controller.rb

@@ -0,0 +1,26 @@
+module AdvertSelector
+  class ApplicationController < ActionController::Base
+
+    before_filter :admin_access_only
+    before_filter :set_time_zone
+    before_filter :set_locale
+
+    def admin_access_only
+      if AdvertSelector.admin_access_class.send(:admin_access, self)
+        return true
+      else
+        render :text => "Forbidden, only for admins", :status => 403
+        return false
+      end
+    end
+
+    def set_time_zone
+      Time.zone = AdvertSelector.default_time_zone
+    end
+
+    def set_locale
+      I18n.locale = :en
+    end
+
+  end
+end

data/app/controllers/advert_selector/banners_controller.rb

@@ -0,0 +1,122 @@
+require_dependency "advert_selector/application_controller"
+
+module AdvertSelector
+  class BannersController < ApplicationController
+    # GET /banners
+    # GET /banners.json
+    def index
+      @banners = Banner.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render :json => @banners }
+      end
+    end
+  
+    # GET /banners/1
+    # GET /banners/1.json
+    def show
+      redirect_to edit_banner_url(params[:id])
+
+      #@banner = Banner.find(params[:id])
+      #
+      #respond_to do |format|
+      #  format.html # show.html.erb
+      #  format.json { render :json => @banner }
+      #end
+    end
+  
+    # GET /banners/new
+    # GET /banners/new.json
+    def new
+      if params[:duplicate_id] && banner_dup = Banner.find_by_id(params[:duplicate_id])
+        @banner = banner_dup.dup
+        @banner.name += " (copy)"
+        @banner.confirmed = false
+
+        banner_dup.helper_items.each do |hi|
+          @banner.helper_items << hi.dup
+        end
+
+      else
+        @banner = Banner.new
+        @banner.start_time = Time.now.at_midnight
+        @banner.end_time = 1.week.from_now.end_of_day
+      end
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render :json => @banner }
+      end
+    end
+  
+    # GET /banners/1/edit
+    def edit
+      @banner = Banner.find(params[:id])
+    end
+  
+    # POST /banners
+    # POST /banners.json
+    def create
+      @banner = Banner.new(params[:banner])
+  
+      respond_to do |format|
+        if @banner.save
+          format.html { redirect_to @banner, :notice => 'Banner was successfully created.' }
+          format.json { render :json => @banner, :status => :created, :location => @banner }
+        else
+          format.html { render :action => "new" }
+          format.json { render :json => @banner.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /banners/1
+    # PUT /banners/1.json
+    def update
+      @banner = Banner.find(params[:id])
+  
+      respond_to do |format|
+        if @banner.update_attributes(params[:banner])
+          format.html { redirect_to @banner, :notice => 'Banner was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render :action => "edit" }
+          format.json { render :json => @banner.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+
+
+    def update_running_view_count
+      @banner = Banner.find(params[:id])
+      if !(@count = params['banner']["running_view_count"]).blank?
+        @count = @count.to_i
+        Banner.where(:id => @banner.id).update_all(:running_view_count => @count)
+        50.times do
+          # We are trying to make sure that no other process will overwrite this value
+          Rails.cache.write(@banner.cache_key, @count, :expires_in => 2.weeks)
+          sleep(0.02)
+        end
+        Banner.where(:id => @banner.id).update_all(:running_view_count => @count)
+        #@banner[:running_view_count] = @count
+        #@banner.save
+      end
+
+      redirect_to @banner
+    end
+
+    # DELETE /banners/1
+    # DELETE /banners/1.json
+    def destroy
+      @banner = Banner.find(params[:id])
+      @banner.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to banners_url }
+        format.json { head :no_content }
+      end
+    end
+
+  end
+end

data/app/controllers/advert_selector/main_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "advert_selector/application_controller"
+
+module AdvertSelector
+  class MainController < ApplicationController
+    def index
+    end
+
+    def clear_errors_log
+      AdvertSelector::ErrorsCache.clear
+      redirect_to :action => :index
+    end
+  end
+end

data/app/controllers/advert_selector/placements_controller.rb

@@ -0,0 +1,89 @@
+require_dependency "advert_selector/application_controller"
+
+module AdvertSelector
+  class PlacementsController < ApplicationController
+    # GET /placements
+    # GET /placements.json
+    def index
+      @placements = Placement.all
+  
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render :json => @placements }
+      end
+    end
+  
+    # GET /placements/1
+    # GET /placements/1.json
+    def show
+      redirect_to edit_placement_url(params[:id])
+
+      #@placement = Placement.find(params[:id])
+      #
+      #respond_to do |format|
+      #  format.html # show.html.erb
+      #  format.json { render :json => @placement }
+      #end
+    end
+  
+    # GET /placements/new
+    # GET /placements/new.json
+    def new
+      @placement = Placement.new
+  
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render :json => @placement }
+      end
+    end
+  
+    # GET /placements/1/edit
+    def edit
+      @placement = Placement.find(params[:id])
+    end
+  
+    # POST /placements
+    # POST /placements.json
+    def create
+      @placement = Placement.new(params[:placement])
+  
+      respond_to do |format|
+        if @placement.save
+          format.html { redirect_to @placement, :notice => 'Placement was successfully created.' }
+          format.json { render :json => @placement, :status => :created, :location => @placement }
+        else
+          format.html { render :action => "new" }
+          format.json { render :json => @placement.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  
+    # PUT /placements/1
+    # PUT /placements/1.json
+    def update
+      @placement = Placement.find(params[:id])
+  
+      respond_to do |format|
+        if @placement.update_attributes(params[:placement])
+          format.html { redirect_to @placement, :notice => 'Placement was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render :action => "edit" }
+          format.json { render :json => @placement.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  
+    # DELETE /placements/1
+    # DELETE /placements/1.json
+    def destroy
+      @placement = Placement.find(params[:id])
+      @placement.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to placements_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end