ad_man 0.0.5 → 0.0.6

data/README.md

@@ -0,0 +1,103 @@
+Ad_man
+======
+
+Ad_man is an advertising manager mountable engine.  It allows the user to upload and manage advertising banners, and provides an easy to use helper for inserting the banners on your website.  Also counts the number of times an ad has shown, and the number of times an advertisement has been clicked on.  The user must set a keyword for each ad.
+
+Currently supports two image sizes for advertising: Leaderboard 728 x 90 and Banner 468 x 60. 
+TODO: Will implement 9 different sizes as mentioned by google's adwords requirements.
+
+Requires Paperclip 3.1, and requires ImageMagick be running on the server.
+
+## Getting started
+
+Ad_man works with Rails 3.2 onwards. You can add it to your Gemfile with:
+
+```ruby
+gem 'ad_man'
+```
+
+After you install Ad_man and add it to your Gemfile, you need to run the generator:
+
+```console
+rails generate ad_man:install
+```
+
+This will install the migrations and a few controller files, then just rake the database:
+```console
+rake db:migrate
+```
+
+See where Ad_man is located by running: 
+```console
+rake routes
+```
+
+In our case, we needed to move the line generated by the install in the routes file to our admin space.  Then add any before_filters to the controllers that were generated.
+
+Make sure to change references to the application using the main_app helper:
+```erb
+<%= link_to "Home", main_app.root_path %>
+<%= link_to "Advertising", main_app.ad_man_path %>
+```
+
+## Changing default values
+
+If you need to change the default values set by ad_man, you will need to create an ad_man.rb initializer in your config/initializers folder.  
+
+```ruby
+# AdMan Default Values
+AdMan.leaderboard_size = "728x90"
+AdMan.banner_size = "468x60"
+AdMan.max_image_size = 50 # 50Kb maximum image size
+
+# These are configurable dimensions (currently leaderboard default)
+AdMan.image_dimensions_width = 728
+AdMan.image_dimensions_height = 90
+
+# Configurable content type for advertising
+AdMan.content_type = ["image/jpg", "image/bmp", "image/png", "image/gif", "image/jpeg"]
+
+# Configurable max advertising for keyword
+AdMan.max_count = 6
+```
+
+## Putting an advertisement in the view
+
+To put your advertisement in the view just add:
+```erb
+<%= link_to_ad %>
+```
+Currently there are three parameters that can control which ads get shown on your page.  :keyword, :size, and :display_on_all_pages.  
+```erb
+<%= link_to_ad :keyword => "Your Keyword", :size => "leaderboard", :display_on_all_pages => false %>
+```
+
+## Ad_man and Javascript
+Ad_man supports inserting an advertisement using jQuery.  It also uses jQuery in the backend when creating new ads.  To use this functionality, include this line in the view:
+```erb
+<%= javascript_include_tag "ad_man/advertisements.js" %>
+```
+
+You can pass the keyword name through the showAd(); function.  
+```erb
+<script>
+// showAd(keyword);
+showAd('<%= @keyword %>');  // inserts a value from ruby in erb
+</script>
+```
+Then ad a `<DIV>` element with the id 'advertisement' where you want the advertisement to show.  
+```erb
+<div id="advertisement"></div>
+```
+
+## Authors
+Written by [David Strand](http://www.github.com/wspyder) and [Tyler Hu](http://www.github.com/tylerhu)
+
+## Contributors
+[Matenia Rossides](http://www.github.com/matenia)
+
+## Copyright & Licensing
+
+Copyright (c) 2012 [Kudelabs](http://kudelabs.com)
+
+Released under MIT License. 

data/app/assets/javascripts/ad_man/advertisements.js

@@ -44,3 +44,11 @@ function showFormError(msg, form) {
   form.find('div.errors').remove();
   form.prepend(errorDiv);
 }
+
+function showAd(key) {
+		$.ajax({
+			url: "/ad_man/advertisements/get_ad/" + key, 
+			dataType: "script", 
+			success: function(data){}
+		});
+}

data/app/controllers/ad_man/advertisements_controller.rb

@@ -1,6 +1,8 @@
 class AdMan::AdvertisementsController < ApplicationController
   # GET /advertisements
-  # GET /advertisements.json
+  # GET /advertisements.json  
+  include AdMan::ApplicationHelper
+  
   def index
     @advertisements = AdMan::Advertisement.all
 		
@@ -96,4 +98,10 @@ class AdMan::AdvertisementsController < ApplicationController
     @advertisement.save
     redirect_to @advertisement.destination_url
   end
+  
+  def get_ad()
+    keyword = params[:id]
+    @ad = js_link_to_ad(keyword)
+  end
+  
 end

data/app/helpers/ad_man/application_helper.rb

@@ -1,27 +1,40 @@
 module AdMan
   module ApplicationHelper
-      def link_to_ad(keyword = nil, size = "leaderboard")
+    def link_to_ad(keyword = nil, size = "leaderboard")
+      ad = ad_select(keyword, size)
+      link_to image_tag(ad.ad_banner.url(size)), { :controller => 'ad_man/advertisements', :action => 'click_through', :id => ad.id },
+      :target => '_blank', :method => :post
+    end
+    
+    def js_link_to_ad(keyword)
+      ad_select(keyword, size= "leaderboard")
+    end
+    
+    protected
+      #grab the keyword form request url
+      def get_keyword_from_url
+        if request.env["REQUEST_PATH"]
+          req_url = request.env["REQUEST_PATH"].split("/")
+          keyword_names = Keyword.all.map{ |keyword| keyword.name }
+          keyword = req_url & keyword_names
+        end
+      end
+    
+	  
+  	  def ad_select(keyword, size)
     		keyword ||= get_keyword_from_url
-				if !keyword.blank? && !Keyword.find_by_name(keyword).nil?
+  			if keyword && !keyword.blank? && !Keyword.find_by_name(keyword).nil?
     		  keyword_id = Keyword.find_by_name(keyword).id
     			ad = Advertisement.render_random_ad(keyword_id)
        	  #grab size? leaderboard or banner
-     	  elsif keyword.blank?
+     	  elsif keyword.nil? || keyword.blank?
      	    ad = Advertisement.render_random_ad
-				end
+  			end
     		if !ad.nil?
-    			ad.display_count += 1
+    			ad.display_count += 1 
     			ad.save
-    			link_to image_tag(ad.ad_banner.url(size)), { :controller => 'advertisements', :action => 'click_through', :id => ad.id }, 
-    			:method => :post, :target => '_blank'
+    			ad
     		end
-    	end    
-
-    	#grab the keyword form request url
-  		def get_keyword_from_url
-  		 req_url = request.env["REQUEST_PATH"].split("/")
-    	 keyword_names = Keyword.all.map{ |keyword| keyword.name }
-    	 keyword = req_url & keyword_names
-	     end
-  end
+    	end
+	end
 end

data/app/models/ad_man/advertisement.rb

@@ -1,57 +1,60 @@
 module AdMan
   class Advertisement < ActiveRecord::Base
-    attr_accessible :destination_url, :title, :ad_banner, :display_count, :priority, :start_date, :end_date, :click_count
+    attr_accessible :destination_url, :title, :ad_banner, :display_count,
+      :priority, :start_date, :end_date, :click_count, :keyword_id
     validates_with AttachmentPresenceValidator, :attributes => :ad_banner
     belongs_to :keyword
-    has_attached_file :ad_banner, :styles => { :leaderboard => (AdMan.leaderboard_size)?(AdMan.leaderboard_size):'728X90', 
-																							:banner => (AdMan.banner_size)?(AdMan.banner_size):'468X60' }
-  	validates_attachment :ad_banner, :presence => true, 
-  		:content_type => { :content_type => (AdMan.content_type)?(AdMan.content_type):
-				["image/jpg","image/bmp","image/png", "image/gif", "image/jpeg"] 	},
-  		:size => { :in => 0..((AdMan.max_image_size)?(AdMan.max_image_size):50).kilobytes } 
-  	validates_presence_of :destination_url, :title, :keyword_id, :priority
-		validates_uniqueness_of :title
-  	validate :image_dimensions, :on => :create
-		after_initialize :init_priority
+    has_attached_file :ad_banner, :styles => {
+      :leaderboard => (AdMan.leaderboard_size)?(AdMan.leaderboard_size):'728X90', 
+      :banner => (AdMan.banner_size)?(AdMan.banner_size):'468X60'
+    }
+    validates_attachment :ad_banner, :presence => true, 
+      :content_type => {
+        :content_type => (AdMan.content_type)?(AdMan.content_type): ["image/jpg","image/bmp","image/png", "image/gif", "image/jpeg"]
+      },
+      :size => { :in => 0..((AdMan.max_image_size)?(AdMan.max_image_size):50).kilobytes }
+    validates_presence_of :destination_url, :title, :keyword_id, :priority
+    validates_uniqueness_of :title
+    validate :image_dimensions, :on => :create
+    after_initialize :init_priority
 
-  	def Advertisement.render_random_ad(keyword_id = nil)
-#  		ads = Advertisement.find_all_by_keyword_id(keyword_id)
-			if keyword_id.nil?
-				ads = Advertisement.where("start_date <= ? AND end_date >= ?", Date.today, Date.today)
-		  else 
-				ads = Advertisement.where("keyword_id = ? AND start_date <= ? AND end_date >= ? ", keyword_id, Date.today, Date.today)
-			end
-			if !ads.blank?
-				total_times = 1.0
-				total_priority = 0.0
-				ads.each { |advertisement| 
-					total_times += advertisement.display_count
-					total_priority += advertisement.priority
-				}
-				ad = ads[rand(ads.size)]
-				while((ad.display_count / total_times) > (ad.priority / total_priority))
-					ad = ads[rand(ads.size)]
-				end
-				ad
-			end
-	  end
+    def Advertisement.render_random_ad(keyword_id = nil)
+      #		ads = Advertisement.find_all_by_keyword_id(keyword_id)
+      if keyword_id.nil?
+        ads = Advertisement.where("start_date <= ? AND end_date >= ?", Date.today, Date.today)
+      else 
+        ads = Advertisement.where("keyword_id = ? AND start_date <= ? AND end_date >= ? ", keyword_id, Date.today, Date.today)
+      end
+      if ads.present? 
+        total_times = 1.0
+        total_priority = 0.0
+        ads.each { |advertisement| 
+          total_times += advertisement.display_count
+          total_priority += advertisement.priority
+        }
+        ad = ads[rand(ads.size)]
+        while((ad.display_count / total_times) > (ad.priority / total_priority))
+          ad = ads[rand(ads.size)]
+        end
+        ad
+      end
+    end
 
-  	private
+    private
     def image_dimensions
       temp_file = ad_banner.queued_for_write[:leaderboard] #get the file
       dimensions = Paperclip::Geometry.from_file(temp_file)        
-			max_width = (AdMan.image_dimensions_width)?(AdMan.image_dimensions_width):728
-			max_height = (AdMan.image_dimensions_height)?(AdMan.image_dimensions_height):90
+      max_width = (AdMan.image_dimensions_width)?(AdMan.image_dimensions_width):728
+      max_height = (AdMan.image_dimensions_height)?(AdMan.image_dimensions_height):90
       if (dimensions.width > max_width) || (dimensions.height > max_height)
-         errors.add("banner_dimmensions",
-										"must be image size: #{max_width}X#{max_height}.")
+        errors.add("banner_dimmensions",
+                   "must be image size: #{max_width}X#{max_height}.")
       end
     end
 
-		def init_priority
-			self.priority ||= 1
-		end
-	
+    def init_priority
+      self.priority ||= 1
+    end
   end
 end
 

data/app/views/ad_man/advertisements/get_ad.js.erb

@@ -0,0 +1,2 @@
+$('div#advertisement').html('<%= link_to image_tag(@ad.ad_banner.url), 
+	click_through_path(@ad.id),  :target => "_blank", :method => :post %>');

data/app/views/ad_man/advertisements/show.html.erb

@@ -34,6 +34,6 @@
 <div style="display:inline-block;">
 	<%= link_to 'Edit', edit_advertisement_path(@advertisement), :method => :get %>
 	<%= link_to "Destroy", @advertisement, :method => :delete,
-				:confirm => "Deleting Advertisement, this cannot be undone.  Please confirm.", :style => "color:#b94a48"%>
+    :data => { :confirm => "Deleting Advertisement, this cannot be undone. Please confirm."}, :style => "color:#b94a48"%>
 	<%= link_to 'Back', advertisements_path, :method => :get %>
-</div>
+</div>

data/app/views/ad_man/keywords/show.html.erb

@@ -34,6 +34,6 @@
 <div style="display:inline-block;">
 	<%= link_to 'Edit Keyword', edit_keyword_path(@keyword), :method => :get %>
 	<%= link_to "Destroy", @keyword, :method => :delete,
-				:confirm => "Deleting Keyword, this cannot be undone.  WARNING: This will delete all advertisements connected with this keyword.  Please confirm.", :style => "color:#b94a48"%>
+    :data => {:confirm => "Deleting Keyword, this cannot be undone.  WARNING: This will delete all advertisements connected with this keyword.  Please confirm."}, :style => "color:#b94a48"%>
 	<%= link_to 'Back', advertisements_path, :method => :get %>
 </div>

data/config/routes.rb

@@ -1,7 +1,12 @@
 AdMan::Engine.routes.draw do
   resources :keywords
-  resources :advertisements
+  resources :advertisements do
+    collection do
+      match 'click_through/:id' => "advertisements#click_through", :as => :click_through
+			match '/advertisements/get_ad/:id' => 'advertisements#get_ad'
+    end
+  end
 
   root :to => "advertisements#index"
-  match 'advertisements/click_through' => 'advertisements#click_through'
+
 end

data/lib/ad_man/version.rb

@@ -1,3 +1,3 @@
 module AdMan
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/ad_man.rb

@@ -1,9 +1,9 @@
 require "ad_man/engine"
 
 module AdMan
-	mattr_accessor :leaderboard_size, :banner_size
-	mattr_accessor :image_dimensions_width, :image_dimensions_height
-	mattr_accessor :max_image_size
-	mattr_accessor :content_type
-	mattr_accessor :max_count
+  mattr_accessor :leaderboard_size, :banner_size
+  mattr_accessor :image_dimensions_width, :image_dimensions_height
+  mattr_accessor :max_image_size
+  mattr_accessor :content_type
+  mattr_accessor :max_count
 end

data/lib/generators/ad_man/install_generator.rb

@@ -1,20 +1,18 @@
 module AdMan
-	class InstallGenerator < Rails::Generators::Base
-		def create_extended_controller_file
-			create_file "app/controllers/ad_man/advertisements_controller.rb",
-				%Q[require AdMan::Engine.config.root + 'app' + 'controllers' + 'ad_man' + 'advertisements_controller'
-					AdMan::AdvertisementsController.class_eval do 
-					end]
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)  
+    def create_extended_controller_file
+      template "advertisements_controller.rb","app/controllers/ad_man/advertisements_controller.rb"
+      template "keywords_controller.rb","app/controllers/ad_man/keywords_controller.rb"
+    end
 
-			create_file "app/controllers/ad_man/keywords_controller.rb",
-				%Q[require AdMan::Engine.config.root + 'app' + 'controllers' + 'ad_man' + 'keywords_controller'
-					AdMan::KeywordsController.class_eval do
-					end]
-		end
-		
-		def add_routes
-			route("mount AdMan::Engine, :at => '/ad_man'")
-		end
-	end
+    def add_routes
+      route("mount AdMan::Engine, :at => '/ad_man'")
+    end
+
+    def install_migrations
+      rake "ad_man:install:migrations"
+    end
+  end
 end
 

data/lib/generators/ad_man/templates/advertisements_controller.rb

@@ -0,0 +1,4 @@
+require File.join(AdMan::Engine.config.root,'app','controllers','ad_man','advertisements_controller')
+AdMan::AdvertisementsController.class_eval do
+  # overrides go here
+end

data/lib/generators/ad_man/templates/keywords_controller.rb

@@ -0,0 +1,4 @@
+require File.join(AdMan::Engine.config.root,'app','controllers','ad_man','keywords_controller')
+AdMan::KeywordsController.class_eval do
+  # overrides go here
+end

data/test/dummy/db/schema.rb

@@ -11,22 +11,26 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120808101547) do
+<<<<<<< HEAD
+ActiveRecord::Schema.define(:version => 0) do
+=======
+ActiveRecord::Schema.define(:version => 20120812095547) do
 
   create_table "ad_man_advertisements", :force => true do |t|
     t.string   "title"
     t.string   "destination_url"
-    t.datetime "created_at",                            :null => false
-    t.datetime "updated_at",                            :null => false
     t.string   "ad_banner_file_name"
     t.string   "ad_banner_content_type"
     t.integer  "ad_banner_file_size"
     t.datetime "ad_banner_updated_at"
     t.integer  "display_count",          :default => 0, :null => false
-    t.integer  "priority"
+    t.integer  "priority",               :default => 1, :null => false
     t.date     "start_date"
     t.date     "end_date"
     t.integer  "keyword_id"
+    t.integer  "click_count",            :default => 0, :null => false
+    t.datetime "created_at",                            :null => false
+    t.datetime "updated_at",                            :null => false
   end
 
   create_table "ad_man_keywords", :force => true do |t|
@@ -34,5 +38,6 @@ ActiveRecord::Schema.define(:version => 20120808101547) do
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end
+>>>>>>> ebccd78bf25a122cf7949094b969681a8bd1a867
 
 end