ad_man 0.0.10 → 0.0.11

data/README.md

@@ -1,6 +1,9 @@
 Ad_man
 ======
 
+[![Build Status](https://secure.travis-ci.org/matenia/ad_man.png)](http://travis-ci.org/matenia/ad_man)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/matenia/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. 
@@ -48,6 +51,14 @@ If you need to change the default values set by ad_man, you will need to create
 # AdMan Default Values
 AdMan.leaderboard_size = "728x90"
 AdMan.banner_size = "468x60"
+AdMan.mobile_leaderboard_size = "320X50"
+AdMan.square_size = "250X250"
+AdMan.small_square_size = "200X200"
+AdMan.large_rectangle_size = "336X280"
+AdMan.inline_rectangle_size = "300X250"
+AdMan.skyscraper_size = "120X600"
+AdMan.wide_skyscraper_size = "160X600"
+
 AdMan.max_image_size = 50 # 50Kb maximum image size
 
 # These are configurable dimensions (currently leaderboard default)

data/app/controllers/ad_man/advertisements_controller.rb

@@ -6,9 +6,9 @@ class AdMan::AdvertisementsController < ApplicationController
   def index
     @advertisements = AdMan::Advertisement.all
 		
-		# depends on the "will_paginate" gem
-		#@advertisements = AdMan::Advertisement.paginate :page => params[:page], :order => 'created_at desc', 
-		#	:per_page => 5
+    # depends on the "will_paginate" gem
+    #@advertisements = AdMan::Advertisement.paginate :page => params[:page], :order => 'created_at desc', 
+    #	:per_page => 5
     @keywords = AdMan::Keyword.all
     
     respond_to do |format|
@@ -48,8 +48,8 @@ class AdMan::AdvertisementsController < ApplicationController
   # POST /advertisements.json
   def create
     @advertisement = AdMan::Advertisement.new(params[:advertisement])
-    @advertisement.keyword_id = params[:keyword_id]
-	#	@advertisement.priority = params[:priority]
+    #@advertisement.keyword_id = params[:keyword_id]
+    #@advertisement.priority = params[:priority]
     respond_to do |format|
       if @advertisement.save
         format.html { redirect_to @advertisement, notice: 'Advertisement was successfully created.' }
@@ -65,8 +65,8 @@ class AdMan::AdvertisementsController < ApplicationController
   # PUT /advertisements/1.json
   def update
     @advertisement = AdMan::Advertisement.find(params[:id])
-    @advertisement.keyword_id = params[:keyword_id]
-		# @advertisement.priority = params[:priority]
+    #@advertisement.keyword_id = params[:keyword_id]
+    #@advertisement.priority = params[:priority]
 
     respond_to do |format|
       if @advertisement.update_attributes(params[:advertisement])

data/app/controllers/ad_man/keywords_controller.rb

@@ -1,40 +1,26 @@
 class AdMan::KeywordsController < ApplicationController
-  
-  # GET /keywords
-  # GET /keywords.json
+  respond_to :html, :json 
+
   def index
     @keywords = AdMan::Keyword.all
-    respond_to do |format|
-      format.html
-      format.json { render json: @advertisements }
-    end
+    respond_with @keywords
   end
   
-  # GET /keywords/1
-  # GET /keywords/1.json
   def show
     @keyword = AdMan::Keyword.find(params[:id])
     @advertisements = AdMan::Advertisement.find_all_by_keyword_id(params[:id])
     @keywords = AdMan::Keyword.all
   end
   
-  # GET /keywords/new
-  # GET /keywords/new.json
   def new
     @keyword = AdMan::Keyword.new
-    respond_to do |format|
-      format.html
-      format.json { render json: @keyword }
-    end
+    respond_with(@keyword)
   end
   
-   # GET /keywords/1/edit
   def edit
     @keyword = AdMan::Keyword.find(params[:id])
   end
   
-  # POST /keywords
-  # POST /keywords.json
   def create 
     @keyword = AdMan::Keyword.new(params[:keyword])
     respond_to do |format|
@@ -48,8 +34,6 @@ class AdMan::KeywordsController < ApplicationController
     end        
   end
   
-  # PUT /keywords/1
-  # PUT /keywords/1.json
   def update 
     @keyword = AdMan::Keyword.find(params[:id])
     respond_to do |format|
@@ -63,8 +47,6 @@ class AdMan::KeywordsController < ApplicationController
     end
   end
   
-  # DELETE /keywords/1
-  # DELETE /keywords/1.json
   def destroy 
     @keyword = AdMan::Keyword.find(params[:id])
     @keyword.destroy

data/app/helpers/ad_man/application_helper.rb

@@ -1,45 +1,45 @@
 module AdMan
   module ApplicationHelper
-    def link_to_ad(keyword = nil, size = "leaderboard")
-#   def link_to_ad(hash = {:keyword => nil, :size => "leaderboard"})
-#     keyword = hash[:keyword]
-#     size = hash[:size]
+    def link_to_ad(opts = {})
+      opts.slice!(:size,:keyword)
+      keyword = opts[:keyword]
+      size = opts[:size] || "leaderboard"
       ad = ad_select(keyword)
       if ad 
-      	link_to image_tag(ad.ad_banner.url(size)), ad_man.click_through_advertisements_path(ad.id), :target => '_blank', :method => :post
+        link_to image_tag(ad.ad_banner.url(size)), ad_man.click_through_advertisements_path(ad.id), :target => '_blank', :method => :post
       end
     end
-    
+
     def js_link_to_ad(keyword)
       ad_select(keyword)
     end
-    
+
     protected
-      #grab the keyword form request url
+
+    #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_names = Keyword.all.map(&:name)
         keyword = req_url & keyword_names
       end
     end
-    
-	  
-    def ad_select(keyword)
+
+    def ad_select(keyword=nil)
       keyword ||= get_keyword_from_url
-      if keyword && !keyword.blank? && Keyword.find_by_name(keyword)
-    	keyword_id = Keyword.find_by_name(keyword).id
-    	ad = Advertisement.render_random_ad(keyword_id)
-       	#grab size? leaderboard or banner
-      elsif keyword.nil? || keyword.blank? || keyword == 'all'
-     	ad = Advertisement.render_random_ad
+      ad = if keyword.present? && Keyword.find_by_name(keyword)
+        keyword_id = Keyword.find_by_name(keyword).id
+        Advertisement.render_random_ad(keyword_id)
+        #grab size? leaderboard or banner
+      elsif keyword.blank? || keyword == 'all'
+        Advertisement.render_random_ad
       end
       if ad
-    	ad.display_count += 1 
-    	ad.save
-    	ad
+        ad.display_count += 1 
+        ad.save
+        ad
       end
     end
-				
+
   end
 end

data/app/models/ad_man/advertisement.rb

@@ -5,26 +5,28 @@ module AdMan
     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'
+      :leaderboard => AdMan.leaderboard_size,
+      :banner => AdMan.banner_size,
+      :mobile_leaderboard => AdMan.mobile_leaderboard_size,
+      :square => AdMan.square_size,
+      :small_square => AdMan.small_square_size,
+      :large_rectangle => AdMan.large_rectangle_size,
+      :inline_rectangle => AdMan.inline_rectangle_size,
+      :skyscraper => AdMan.skyscraper_size,
+      :wide_skyscraper => AdMan.wide_skyscraper_size
     }
     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"]
+        :content_type => AdMan.content_type
       },
-      :size => { :in => 0..((AdMan.max_image_size)?(AdMan.max_image_size):50).kilobytes }
+      :size => { :in => 0..(AdMan.max_image_size).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
+    def self.render_random_ad(keyword_id = nil)
+      ads = fetch_ads(keyword_id)
       if ads.present? 
         total_times = 1.0
         total_priority = 0.0
@@ -41,11 +43,20 @@ module AdMan
     end
 
     private
+
+    def self.fetch_ads(keyword_id=nil)
+      if keyword_id.blank?
+        where("start_date <= ? AND end_date >= ?", Date.today, Date.today)
+      else 
+        where("keyword_id = ? AND start_date <= ? AND end_date >= ? ", keyword_id, Date.today, Date.today)
+      end
+    end
+
     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
+      max_height = AdMan.image_dimensions_height
       if (dimensions.width > max_width) || (dimensions.height > max_height)
         errors.add("banner_dimmensions",
                    "must be image size: #{max_width}X#{max_height}.")

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

@@ -11,11 +11,11 @@
     </div>
   <% end %>
 
-	<div class="field">
-		<%= f.label :ad_banner, "Acceptable sizes: 728x90 or 468x60" %><br />
-		<%= f.file_field :ad_banner %>	
-		<div class="preview"></div>
-	</div><br />
+  <div class="field">
+    <%= f.label :ad_banner, "Acceptable sizes: 728x90 or 468x60" %><br />
+    <%= f.file_field :ad_banner %>	
+    <div class="preview"></div>
+  </div><br />
   <div class="field">
     <%= f.label :title %><br />
     <%= f.text_field :title %>
@@ -25,33 +25,33 @@
     <%= f.url_field :destination_url %>
   </div><br />
   <div class="field">
-	<%= f.label :keyword %>
-	<% 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>Warning: <b><%= AdMan::Keyword.unavailable.collect { |keyword| keyword.name } %></b> keyword has already been used <%= AdMan::Keyword::MAX_COUNT %> times.</p>
-	<% end %>
+    <%= f.label :keyword %>
+    <% if @advertisement.keyword %>
+    <!-- for edit advertisement page -->
+      <%= f.collection_select :keyword_id, AdMan::Keyword.available | [@advertisement.keyword], :id, :name, :include_blank => true %>
+    <% else %>
+    <!-- for new advertisement page -->
+      <%= f.collection_select :keyword_id, AdMan::Keyword.available, :id, :name, :include_blank => true %>
+    <% end %>
+    <% if AdMan::Keyword.unavailable.count > 0 %>
+      <p>Warning: <b><%= AdMan::Keyword.unavailable.map(&:name) %></b> keyword has already been used <%= AdMan::Keyword::MAX_COUNT %> times.</p>
+    <% end %>
+  </div>
+  <br />
+  <!--
+    <div class="field">
+      <#%= f.label :priority %>
+      <#%= select_tag :priority, options_for_select(1..10) %>
+   </div><br />
+   -->
+  <div class="field">
+    <%= f.label :start_date %><br />
+    <%= f.date_select :start_date %>
   </div><br />
-	<!--
   <div class="field">
-		<#%= f.label :priority %>
-		<#%= select_tag :priority, options_for_select(1..10) %>
-	</div><br />
-	-->
-	<div class="field">
-		<%= f.label :start_date %><br />
-		<%= date_select("advertisement", "start_date") %>
-	</div><br />
-	<div class="field">
-		<%=f.label :end_date %><br />
-		<%= date_select("advertisement", "end_date", :default => 1.month.from_now) %> 
-	</div><br />
+    <%= f.label :end_date %><br />
+    <%= f.date_select :end_date, :default => 1.month.from_now %> 
+  </div><br />
 
 
   <div class="actions">

data/lib/ad_man/engine.rb

@@ -3,12 +3,16 @@ require 'paperclip'
 module AdMan
   class Engine < ::Rails::Engine
     isolate_namespace AdMan
-    
-		#expose helper methods to the consumer application 
-		initializer 'ad_man.action_controller' do |app|
-			ActiveSupport.on_load :action_controller do 
-				helper AdMan::ApplicationHelper
-			end
+
+    #expose helper methods to the consumer application 
+    initializer 'ad_man.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do 
+        helper AdMan::ApplicationHelper
+      end
+    end
+
+    initializer 'ad_man.assets.precompile' do |app|
+      app.config.assets.precompile += %w(advertisements.js)
     end
   end
 end

data/lib/ad_man/version.rb

@@ -1,3 +1,3 @@
 module AdMan
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/ad_man.rb

@@ -1,9 +1,36 @@
 require "ad_man/engine"
 
 module AdMan
-  mattr_accessor :leaderboard_size, :banner_size
+  # advert size names
+  mattr_accessor :leaderboard_size,
+    :banner_size,
+    :mobile_leaderboard_size,
+    :square_size,
+    :small_square_size,
+    :large_rectangle_size,
+    :inline_rectangle_size,
+    :skyscraper_size,
+    :wide_skyscraper_size
+
   mattr_accessor :image_dimensions_width, :image_dimensions_height
   mattr_accessor :max_image_size
   mattr_accessor :content_type
   mattr_accessor :max_count
+
+  # initialize default sizes
+  self.leaderboard_size = "728X90"
+  self.banner_size = '468X60'
+  self.mobile_leaderboard_size = '320X50'
+  self.square_size = '250X250'
+  self.small_square_size = '200X200'
+  self.large_rectangle_size = '336X280'
+  self.inline_rectangle_size = '300X250'
+  self.skyscraper_size = '120X600'
+  self.wide_skyscraper_size = '160X600'
+
+  # other attributes
+  self.max_image_size = 50
+  self.content_type = ["image/jpg","image/bmp","image/png", "image/gif", "image/jpeg"]
+  self.image_dimensions_height = 90
+  self.image_dimensions_width = 728
 end

data/lib/generators/ad_man/install_generator.rb

@@ -7,7 +7,7 @@ module AdMan
     end
 
     def add_routes
-      route("mount AdMan::Engine => "/ad_man")
+      route("mount AdMan::Engine => /ad_man")
     end
 
     def install_migrations

data/test/ad_man_test.rb

@@ -4,4 +4,16 @@ class AdManTest < ActiveSupport::TestCase
   test "truth" do
     assert_kind_of Module, AdMan
   end
+  
+  test "default configs" do
+    assert_equal "728X90", AdMan.leaderboard_size.upcase
+    assert_equal "468X60", AdMan.banner_size.upcase
+    assert_equal "320X50", AdMan.mobile_leaderboard_size.upcase
+    assert_equal "250X250", AdMan.square_size.upcase
+    assert_equal "200X200", AdMan.small_square_size.upcase
+    assert_equal "336X280", AdMan.large_rectangle_size.upcase
+    assert_equal "300X250", AdMan.inline_rectangle_size.upcase
+    assert_equal "120X600", AdMan.skyscraper_size.upcase
+    assert_equal "160X600", AdMan.wide_skyscraper_size.upcase
+  end
 end

data/test/dummy/app/views/layouts/application.html.erb

@@ -9,8 +9,8 @@
 	<script>
 	// showAd(keyword)
 	<% if AdMan::Keyword.first %>
-		AdMan.showAd('<%= AdMan::Keyword.first.name %>', 'banner', 'advertisement1'); //
-		AdMan.showAd('<%= AdMan::Keyword.last.name %>', 'leaderboard', 'advertisement2');
+		AdMan.showAd('advertisement1', '<%= AdMan::Keyword.first.name %>', 'banner'); //
+		AdMan.showAd('advertisement2', '<%= AdMan::Keyword.last.name %>', 'leaderboard');
 	<% end %>
 	</script>