spud_banners 0.0.1

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/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    = 'SpudBanners'
+  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/Readme.markdown

@@ -0,0 +1,128 @@
+# Spud Banners
+
+Spud Banners is an engine for creating and managing rotating banner sets, designed for use with [Spud][spud].
+
+## Installation/Usage
+
+1. In your Gemfile add the following
+
+		gem 'spud_banners'
+
+2. Run bundle install
+3. Copy in database migrations to your new rails project
+
+		bundle exec rake railties:install:migrations
+		rake db:migrate
+
+4. Run a rails server instance and point your browser to /spud/admin
+
+## Configuration
+
+Spud Banners accepts the following configuration options:
+
+	Spud::Photos.configure do |config|
+		config.paperclip_storage = :filesystem #use :s3 to use s3 storage (aws gem required)
+		config.s3_credentials = "#{Rails.root}/config/s3.yml"
+		config.storage_path = ":rails_root/public/system/spud_banners/:id/:style/:basename.:extension"
+		config.storage_url = "/system/spud_banners/:id/:style/:basename.:extension"
+	end
+
+## Creating a Banner Set
+
+Banner Sets are created in the Spud admin. When creating a Set, you have the following options:
+
+- **Name:** The unique identifier used to render this set
+- **Width:** Maximum width of uploaded banners
+- **Height:** Maximum height of uploaded banners
+- **Cropped:** Whether or not banners should be cropped to fit into the above Width/Height constraints
+
+## Managing Banners
+
+Once a Set has been created, you can begin adding banners to it. Banners contain optional `link_to`, `link_target`, `title`, and `alt` options. Banners are also sortable via drag-and-drop.
+
+## View Helpers
+
+A number of view helpers are provided for displaying banners in your templates. 
+
+`spud_banners_for_set(set_or_identifier)`
+
+Accepts the banner set name as a String or Symbol and returns an html template. Optionally takes a block argument for rendering custom html. 
+
+`spud_banner_tag(banner)`
+
+Accepts a banner model object and returns a banner image wrapped in a link tag. Link tag is omitted if the `link_to` property of the banner is blank.
+
+`spud_banner_image_tag(banner)`
+
+Accepts a banner model and returns only the image tag, no link. 
+
+## Examples
+
+Displaying banners using the standard helper.
+
+	<div id="banners">
+		<%= spud_banners_for_set(:promotions) %>
+	</div>
+
+Displaying banners using the helper, with a block for custom html.
+
+	<ul id="slides">
+		<% spud_banners_for_set(:promotions) do |banner| %>
+			<li class="custom_slide">
+				<%= spud_banner_tag(banner) %>
+			</li>
+		<% end %>
+	</ul>
+
+Displaying banners using the helper, with a block for even more custom html.
+
+	<ul id="slides">
+		<% spud_banners_for_set(:promotions) do |banner| %>
+			<li class="custom_slide">
+				<h3><%= link_to banner.link_to, banner.title, :target => banner.link_target %></h3>
+				<%= image_tag(banner.banner.url(:banner), :alt => banner.alt, :title => banner.title) %>
+			</li>
+		<% end %>
+	</ul>
+
+## Liquid
+
+Spud Banners comes with its own custom [Liquid][liquid] tag. For now the liquid tag only supports rendering the standard html as generated by the `spud_banners_for_set`. Will provide support more advanced options in the future. 
+
+Usage:
+
+	<%= raw Liquid::Template.parse("{% spud_banner_set Promotions %}").render %>
+
+## Slideshows
+
+Spud Banners does not provide a built-in slideshow animation library. Instead, we make it easy for you to integrate into any number of popular JavaScript slideshow plugins available on the web, or even to write your own from scratch. 
+
+Below is an example of integration with [SlidesJs][slidesjs], a jQuery plugin.
+
+	<style type="text/css" media="screen">
+		.spud_banner_set {
+			width: 600px;
+			height: 200px;
+		}
+		.spud_banner_set_banner {
+			width: 600px;
+			height: 200px;
+			display: block;
+		}
+	</style>
+	<div id="banners">
+		<%= spud_banners_for_set(:promotions) %>
+	</div>
+	<script src="/slides.jquery.js" type="text/javascript"></script>
+	<script>
+		$(document).ready(function(){
+			$("#banners").slides({
+				play: 5000,
+				container: 'spud_banner_set'
+			});
+		});
+	</script>
+
+[spud]:https://github.com/davydotcom/spud_core_admin
+[slidesjs]:http://www.slidesjs.com
+[liquid]:https://github.com/Shopify/liquid

data/app/assets/javascripts/spud/admin/banners/application.js

@@ -0,0 +1,2 @@
+//= require spud/admin/banners/banners
+//= require spud/admin/banners/banner_sets

data/app/assets/javascripts/spud/admin/banners/banner_sets.js

@@ -0,0 +1,102 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+spud.admin.banner_sets = new function(){
+
+  var self = this;
+  var bannerSetEditId = false;
+
+  this.init = function(){
+    $('.spud_banner_sets_add_new').on('click', self.clickedAddNewBannerSet);
+    $('.spud_admin_banner_sets_list').on('click', '.spud_banner_sets_edit', self.clickedEditBannerSet);
+    $('.spud_admin_banner_sets_list').on('click', '.spud_banner_sets_delete', self.clickedDeleteBannerSet);
+    $('.modal-body').on('submit', '.spud_banner_set_form', self.submittedBannerSetForm);
+  };
+
+  self.clickedAddNewBannerSet = function(e){
+    e.preventDefault();
+    bannerSetEditId = false;
+    $.ajax({
+      url: $(this).attr('href'),
+      dataType: 'html',
+      success: function(html, textStatus, jqXHR){
+        displayModalDialogWithOptions({
+          title: 'New Banner Set',
+          html: html
+        });
+      }
+    });
+  };
+
+  self.clickedEditBannerSet = function(e){
+    e.preventDefault();
+    bannerSetEditId = parseInt($(this).parents('li').attr('data-id'), 10);
+    $.ajax({
+      url: $(this).attr('href'),
+      dataType: 'html',
+      success: function(html, textStatus, jqXHR){
+        displayModalDialogWithOptions({
+          title: 'Edit Banner Set',
+          html: html
+        });
+      }
+    });
+  };
+
+  self.clickedDeleteBannerSet = function(e){
+    e.preventDefault();
+    if(window.confirm('Are you sure?')){
+      var el = $(this);
+      $.ajax({
+        url: el.attr('href'),
+        type: 'post',
+        data: {'_method':'delete'},
+        complete: function(jqXHR, textStatus){
+          var parent = el.parents('li');
+          parent.fadeOut(200, function(){
+            parent.remove();
+          });
+          if(textStatus != 'success'){
+            console.warn('Something went wrong:', jqXHR);
+          }
+        }
+      });
+    }
+  };
+
+  self.submittedBannerSetForm = function(e){
+    e.preventDefault();
+    var form = $(this);
+    $.ajax({
+      url: form.attr('action'),
+      data: form.serialize(),
+      type: 'post',
+      dataType: 'html',
+      success: self.savedBannerSetSuccess,
+      error: self.savedBannerSetError
+    });
+  };
+
+  self.savedBannerSetSuccess = function(html){
+    if(bannerSetEditId){
+      var item = $('.spud_admin_banner_sets_list_item[data-id="'+bannerSetEditId+'"]');
+      item.replaceWith(html);
+    }
+    else{
+      $('.spud_admin_banner_sets_list').append(html);
+    }
+    hideModalDialog();
+  };
+
+  self.savedBannerSetError = function(jqXHR, textStatus, errorThrown){
+    if(jqXHR.status == 422){
+      var html = jqXHR.responseText;
+      $('.spud_banner_set_form').replaceWith(html);
+    }
+    else{
+      if(window.console){
+        console.error('Oh Snap:', arguments);
+      }
+    }
+  };
+}();

data/app/assets/javascripts/spud/admin/banners/banners.js

@@ -0,0 +1,161 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+spud.admin.banners = new function(){
+
+  var self = this;
+  var html5upload = false;
+  var bannerEditId = false;
+
+  this.init = function(){
+    if(typeof(FormData) != 'undefined'){
+      html5upload = true;
+    }
+    $('.spud_banner_add_new').on('click', self.clickedAddNewBanner);
+    $('.spud_banner_set_banners_container').on('click', '.spud_banner_set_banner_item_edit', self.clickedEditBanner);
+    $('.spud_banner_set_banners_container').on('click', '.spud_banner_set_banner_item_delete', self.clickedDeleteBanner);
+    $('.modal-body').on('submit', '.spud_banner_form', self.submittedBannerForm);
+
+    $('.spud_banner_set_banners_container').sortable({
+      stop: self.sortedBanners
+    });
+  };
+
+  self.clickedAddNewBanner = function(e){
+    e.preventDefault();
+    bannerEditId = false;
+    $.ajax({
+      url: $(this).attr('href'),
+      dataType: 'html',
+      success: function(html, textStatus, jqXHR){
+        displayModalDialogWithOptions({
+          title: 'Upload Banner',
+          html: html
+        });
+      }
+    });
+  };
+
+  self.clickedEditBanner = function(e){
+    e.preventDefault();
+    bannerEditId = parseInt($(this).parents('.spud_banner_set_banner_item').attr('data-id'), 10);
+    $.ajax({
+      url: $(this).attr('href'),
+      dataType: 'html',
+      success: function(html, textStatus, jqXHR){
+        displayModalDialogWithOptions({
+          title: 'Edit Banner',
+          html: html
+        });
+      }
+    });
+  };
+
+  self.clickedDeleteBanner = function(e){
+    e.preventDefault();
+    var el = $(this);
+    $.ajax({
+      url: el.attr('href'),
+      type: 'post',
+      data: {'_method':'delete'},
+      complete: function(jqXHR, textStatus){
+        var parent = el.parents('.spud_banner_set_banner_item');
+        parent.fadeOut(200, function(){
+          parent.remove();
+        });
+        if(textStatus != 'success'){
+          console.warn('Something went wrong:', jqXHR);
+        }
+      }
+    });
+  };
+
+  self.submittedBannerForm = function(e){
+    if(html5upload){
+      e.preventDefault();
+
+      var form = $(this);
+      var fd = new FormData();
+      fd.append('_method', form.find('[name=_method]').val());
+      fd.append('authenticity_token', form.find('[name=authenticity_token]').val());
+      fd.append('spud_banner[link_to]', form.find('#spud_banner_link_to').val());
+      fd.append('spud_banner[link_target]', form.find('#spud_banner_target').val());
+      fd.append('spud_banner[title]', form.find('#spud_banner_title').val());
+      fd.append('spud_banner[alt]', form.find('#spud_banner_alt').val());
+
+      var file = form.find('#spud_banner_banner')[0].files[0];
+      if(file){
+        fd.append('spud_banner[banner]', file);
+        $('.spud_banner_upload_progress').show();
+      }
+
+      var xhr = new XMLHttpRequest();
+      xhr.upload.addEventListener('progress', self.onFileUploadProgress);
+      xhr.addEventListener('load', self.onFileUploadComplete);
+      xhr.addEventListener('error', self.onFileUploadError);
+      xhr.addEventListener('abort', self.onFileUploadAbort);
+      xhr.open('POST', form.attr('action'));
+      xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+      xhr.send(fd);
+      return false;
+    }
+  };
+
+  self.onFileUploadProgress = function(e){
+    var percent = Math.round(e.loaded * 100 / e.total);
+    var progress = $('.spud_banner_upload_progress');
+    progress.find('.bar').css({width: percent + '%'});
+    if(percent == 100){
+      progress.addClass('progress-success');
+    }
+  };
+
+  self.onFileUploadComplete = function(e){
+    switch(this.status){
+      case 200:
+        self.onLegacyUploadComplete(e.target.response);
+        break;
+      case 422:
+        self.onLegacyUploadError(e.target.response);
+        break;
+      default:
+        window.alert("Whoops! Something has gone wrong.");
+    }
+  };
+
+  self.onFileUploadError = function(e){
+
+  };
+
+  self.onFileUploadAbort = function(e){
+
+  };
+
+  // Non-html5 upload
+  self.onLegacyUploadComplete = function(html){
+    if(bannerEditId){
+      var item = $('.spud_admin_banner_item[data-id="'+bannerEditId+'"]');
+      item.replaceWith(html);
+    }
+    else{
+      $('.spud_banner_set_banners_container').append(html);
+    }
+    hideModalDialog();
+  };
+
+  self.onLegacyUploadError = function(html){
+    $('.spud_banner_form').replaceWith(html);
+  };
+
+  self.sortedBanners = function(e, ui){
+    var ids = [];
+    $('.spud_banner_set_banner_item').each(function(){
+      ids.push($(this).attr('data-id'));
+    });
+    $.ajax({
+      url: '/spud/admin/banners/sort',
+      type: 'post',
+      data: {spud_banner_ids:ids, _method:'put'}
+    });
+  };
+}();

data/app/assets/stylesheets/spud/admin/banners/application.css

@@ -0,0 +1,4 @@
+/*
+*= require spud/admin/banners/banners
+*= require spud/admin/banners/banner_sets
+*/

data/app/assets/stylesheets/spud/admin/banners/banner_sets.css

@@ -0,0 +1,27 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.spud_admin_banner_sets_list{
+  margin: 0;
+  padding: 0;
+  border: 1px solid #eee;
+  min-height: 40px;
+}
+.spud_admin_banner_sets_list_item{
+  clear: both;
+  overflow: hidden;
+  padding: 10px;
+}
+.spud_admin_banner_sets_list_item:nth-child(2n) {
+  background: #F1F1F1;
+}
+.spud_admin_banner_sets_list_item:hover{
+  background: #FFEDDF;
+  -webkit-transition: background 0.1s ease-in;
+  -moz-transition: background 0.1s ease-in;
+}
+.spud_admin_banner_sets_list_item_actions{
+  float: right;
+}

data/app/assets/stylesheets/spud/admin/banners/banners.css

@@ -0,0 +1,36 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+/* Banner Management
+-------------------- */
+.spud_banner_set_banners_container{
+
+}
+.spud_banner_set_banner_item{
+  padding: 0 10px 10px 0;
+  position: relative;
+  display: inline-block;
+  cursor: move;
+  float: left;
+}
+.spud_banner_set_banner_item img{
+  display: inline-block;
+}
+.spud_banner_set_banner_item_actions{
+  position: absolute;
+  bottom: 10px;
+  right: 10px;
+  padding: 5px 10px;
+  background: rgba(0, 0, 0, 0.5);
+}
+.spud_banner_set_banner_item_actions a{
+  color: white;
+}
+
+/* Banner Form
+--------------- */
+.spud_banner_upload_progress{
+  display: none;
+}

data/app/controllers/spud/admin/banner_sets_controller.rb

@@ -0,0 +1,71 @@
+class Spud::Admin::BannerSetsController < Spud::Admin::ApplicationController
+
+  cache_sweeper :spud_banner_sweeper, :only => [:create, :update, :destroy]
+  before_filter :get_record, :only => [:show, :edit, :update, :destroy]
+  respond_to :html
+  belongs_to_spud_app :banner_sets
+  add_breadcrumb 'Banner Sets', :spud_admin_banner_sets_path
+  layout false
+
+  def index
+    @banner_sets = SpudBannerSet.all
+    respond_with @banner_sets, :layout => 'spud/admin/detail'
+  end
+
+  def show
+    respond_with @banner_set, :layout => 'spud/admin/detail'
+  end
+
+  def new
+    @banner_set = SpudBannerSet.new
+    respond_with @banner_set
+  end
+
+  def create
+    @banner_set = SpudBannerSet.new(params[:spud_banner_set])
+    if @banner_set.save
+      flash.now[:notice] = 'BannerSet created successfully' 
+      render 'create'
+    else
+      render 'new', :status => 422
+    end
+  end
+
+  def edit
+    respond_with @banner_set
+  end
+
+  def update
+    if @banner_set.update_attributes(params[:spud_banner_set])
+      flash.now[:notice] = 'BannerSet updated successfully'
+      @banner_set.reprocess_banners!
+      render 'create'
+    else
+      render 'edit', :status => 422
+    end
+  end
+
+  def destroy
+    if @banner_set.destroy
+      flash.now[:notice] = 'BannerSet deleted successfully' 
+      status = 200
+    else
+      status = 422
+    end
+    render :nothing => true, :status => status
+  end
+
+private
+
+  def get_record
+    begin
+      logger.debug "Looking for banner set with id: #{params[:id]}"
+      @banner_set = SpudBannerSet.find(params[:id])
+    rescue ActiveRecord::RecordNotFound => e
+      flash.now[:error] = "Could not find the requested BannerSet"
+      redirect_to spud_admin_banner_sets_path
+      return false
+    end
+  end
+
+end

data/app/controllers/spud/admin/banners_controller.rb

@@ -0,0 +1,104 @@
+class Spud::Admin::BannersController < Spud::Admin::ApplicationController
+
+  include RespondsToParent
+
+  cache_sweeper :spud_banner_sweeper, :only => [:create, :update, :destroy]
+  before_filter :get_set, :only => [:new, :create]
+  before_filter :get_record, :only => [:edit, :update, :destroy]
+  respond_to :html
+  layout false
+
+  def new
+    @banner = @banner_set.banners.new
+    respond_with @banner
+  end
+
+  def create
+    @banner = @banner_set.banners.build
+    @banner.attributes = params[:spud_banner]
+
+    last_banner = SpudBanner.select('sort_order').where(:spud_banner_set_id => @banner_set.id).order('sort_order desc').first
+    if last_banner
+     @banner.sort_order = last_banner.sort_order + 1
+    end
+
+    if request.xhr?
+      if @banner.save
+        flash.now[:notice] = 'SpudBanner created successfully' 
+        render 'show'
+      else
+        render 'new', :status => 422
+      end
+    else
+      @banner.save
+      respond_to_parent do
+        render 'legacy', :formats => [:js]
+      end
+    end
+  end
+
+  def edit
+    respond_with @banner
+  end
+
+  def update
+    if request.xhr?
+      if @banner.update_attributes(params[:spud_banner])
+        flash.now[:notice] = 'SpudBanner created successfully' 
+        render 'show'
+      else
+        render 'edit', :status => 422
+      end
+    else
+      @banner.update_attributes(params[:spud_banner])
+      respond_to_parent do
+        render 'legacy', :formats => [:js]
+      end
+    end
+  end
+
+  def destroy
+    if @banner.destroy
+      flash.now[:notice] = 'SpudBanner deleted successfully' 
+      status = 200
+    else
+      status = 422
+    end
+    render :nothing => true, :status => status
+  end
+
+  def sort
+    banner_ids = params[:spud_banner_ids]
+    banners = SpudBanner.where(:id => banner_ids).to_a
+    SpudBanner.transaction do
+      banner_ids.each_with_index do |id, index|
+        banner = banners.select{ |b| b.id == id.to_i }.first
+        banner.update_attribute(:sort_order, index)
+      end
+    end
+    render :nothing => true, :status => 200
+  end
+
+private
+
+  def get_set
+    begin
+      @banner_set = SpudBannerSet.find(params[:banner_set_id])
+    rescue ActiveRecord::RecordNotFound => e
+      flash.now[:error] = "Could not find the requested SpudBannerSet"
+      render :nothing => true, :status => 404
+      return false
+    end
+  end
+
+  def get_record
+    begin
+      @banner = SpudBanner.find(params[:id])
+    rescue ActiveRecord::RecordNotFound => e
+      flash.now[:error] = "Could not find the requested SpudBanner"
+      redirect_to spud_admin_banner_sets_path
+      return false
+    end
+  end
+
+end