ad_man 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,87 @@
+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
+```
+
+Install the migrations, and rake the database:
+```console
+rake ad_man:install:migrations
+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 %>
+```
+
+One final change may be necessary in order to preview an image before saving, and that is to add this line to the admin view:
+```erb
+<%= javascript_include_tag "ad_man/advertisements.js" %>
+```
+
+## 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 %>
+```
+## Authors
+Written by [David Strand](http://www.github.com/wspyder) and [Tyler Hu](http://www.github.com/tylerhu)
+
+## Copyright & Licensing
+
+Copyright (c) 2012 [Kudelabs](http://kudelabs.com), [Kudelabs on Github](http://github.com/kudelabs)
+
+Released under MIT License. 

data/app/controllers/ad_man/advertisements_controller.rb

@@ -64,7 +64,7 @@ class AdMan::AdvertisementsController < ApplicationController
   def update
     @advertisement = AdMan::Advertisement.find(params[:id])
     @advertisement.keyword_id = params[:keyword_id]
-		@advertisement.priority = params[:priority]
+		# @advertisement.priority = params[:priority]
 
     respond_to do |format|
       if @advertisement.update_attributes(params[:advertisement])

data/app/helpers/ad_man/application_helper.rb

@@ -1,27 +1,28 @@
 module AdMan
   module ApplicationHelper
-      def link_to_ad(keyword = nil, size = "leaderboard")
-    		keyword ||= get_keyword_from_url
-				if keyword && !keyword.blank? 
-    		  keyword_id = Keyword.find_by_name(keyword).id
-    			ad = Advertisement.render_random_ad(keyword_id)
-       	  #grab size? leaderboard or banner
-				else 
-					ad = Advertisement.render_random_ad
-				end
-    		if !ad.nil?
-    			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'
-    		end
-    	end    
+		def link_to_ad(hash = {:keyword => nil, :size => "leaderboard", :display_on_all_pages => true})
+			keyword = hash[:keyword]
+			keyword ||= get_keyword_from_url
+			if !keyword.blank? && !Keyword.find_by_name(keyword).nil?
+    	  keyword_id = Keyword.find_by_name(keyword).id
+    		ad = Advertisement.render_random_ad(keyword_id)
+			elsif keyword.blank? && hash[:display_on_all_pages]
+				ad = Advertisement.render_random_ad
+			end
+			if !ad.nil?
+    		ad.display_count += 1
+    		ad.save
+				size = hash[:size]
+    		link_to image_tag(ad.ad_banner.url(size)), { :controller => 'advertisements', :action => 'click_through', :id => ad.id }, 
+    		:method => :post, :target => '_blank'
+    	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
+  	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

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

@@ -26,9 +26,16 @@
   </div><br />
   <div class="field">
 	<%= f.label :keyword %>
-	<%= select_tag :keyword_id,  options_for_select(AdMan::Keyword.available.collect { |keyword| [keyword.name, keyword.id]})%>
+	<% if @advertisement.keyword.nil? %>
+		<!-- for new advertisement page --> 
+		<%= select_tag :keyword_id,  options_for_select(AdMan::Keyword.available.collect { |keyword| [keyword.name, keyword.id]})%>
+	<% else %>
+		<!-- for edit advertisement page -->
+					 <%= select_tag :keyword_id,  options_for_select(AdMan::Keyword.available.collect { |keyword| [keyword.name, keyword.id]} | [[@advertisement.keyword.name, @advertisement.keyword_id]],
+																													 :selected => @advertisement.keyword_id) %>
+	<% end %>
 	<% if AdMan::Keyword.unavailable.count > 0%>
-	<p><b><%= AdMan::Keyword.unavailable.collect { |keyword| keyword.name } %></b> keyword has allready been used 5 times.</p>
+		<p>Warning: <b><%= AdMan::Keyword.unavailable.collect { |keyword| keyword.name } %></b> keyword has already been used <%= AdMan::Keyword::MAX_COUNT %> times.</p>
 	<% end %>
   </div><br />
 	<!--
@@ -43,9 +50,7 @@
 	</div><br />
 	<div class="field">
 		<%=f.label :end_date %><br />
-		<!--
-		<#% TODO : end date should be 30 days plus %> -->
-		<%= date_select("advertisement", "end_date") %> 
+		<%= date_select("advertisement", "end_date", :default => 1.month.from_now) %> 
 	</div><br />
 
 

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

@@ -2,4 +2,4 @@
 
 <%= render 'form' %>
 
-<%= link_to 'Back', keywords_path %>
+<%= link_to 'Back', advertisements_path %>

data/db/migrate/20120808085322_create_ad_man_advertisements.rb

@@ -3,7 +3,13 @@ class CreateAdManAdvertisements < ActiveRecord::Migration
     create_table :ad_man_advertisements do |t|
       t.string :title
       t.string :destination_url
-
+      t.has_attached_file :ad_banner
+      t.integer :display_count, :null => false, :default => 0
+      t.integer :priority, :null => false, :default => 1
+      t.date :start_date
+      t.date :end_date
+      t.integer :keyword_id
+      t.integer :click_count, :null => false, :default => 0
       t.timestamps
     end
   end

data/db/migrate/20120808091446_create_ad_man_keywords.rb

@@ -2,7 +2,6 @@ class CreateAdManKeywords < ActiveRecord::Migration
   def change
     create_table :ad_man_keywords do |t|
       t.string :name
-
       t.timestamps
     end
   end

data/lib/ad_man/version.rb

@@ -1,3 +1,3 @@
 module AdMan
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120808101547) do
+ActiveRecord::Schema.define(:version => 20120809065243) do
 
   create_table "ad_man_advertisements", :force => true do |t|
     t.string   "title"
@@ -27,6 +27,7 @@ ActiveRecord::Schema.define(:version => 20120808101547) do
     t.date     "start_date"
     t.date     "end_date"
     t.integer  "keyword_id"
+    t.integer  "click_count",            :default => 0, :null => false
   end
 
   create_table "ad_man_keywords", :force => true do |t|