wheelhouse-forms 1.0 → 1.1

data/README.md

@@ -23,6 +23,7 @@ Other features include:
 
  - server-side and HTML5 form validation
  - CSV export of submissions
+ - optional spam filtering (via Akismet)
 
 
 Installation & Usage
@@ -37,3 +38,21 @@ Then run `bundle install`.
 **2. Create a new form from the New Page dropdown.**
 
 **3. To customize, copy the `form.html.haml` template from `app/templates` to your theme templates folder.**
+
+
+### Spam Filtering with Akismet
+
+Spam filtering support requires an Akismet API key. Sign up for one at <https://akismet.com/signup/>.
+
+**1. Add `rakismet` to your Gemfile:**
+
+    gem "rakismet"
+    
+Then run `bundle install`.
+
+**2. Add your Akismet API key and web site URL to `config/application.rb`.**
+
+    config.rakismet.key = "1234abcd1234"
+    config.rakismet.url = "http://www.example.com/"
+
+**3. Restart your Rails server. The forms plugin will automatically use Rakismet if it is configured.**

data/app/assets/javascripts/wheelhouse-forms/jquery.options.js

@@ -1,10 +1,18 @@
 $.fn.options = function() {
+  function addField(li) {
+    var next = li.clone().find('div').remove().end().insertAfter(li);
+    next.find('input').val('').width('auto').autoGrowInput().focus();
+  }
+  
   return $(this).each(function() {
     $(this).delegate("li input", "blur", function() {
       var li = $(this).parent();
+      var value = $(this).val();
       
-      if ($(this).val() == "" && !li.is(":last-child")) {
+      if (value == "" && !li.is(":last-child")) {
         li.remove();
+      } else if (value != "" && li.is(":last-child")) {
+        addField(li);
       }
     });
     
@@ -14,8 +22,7 @@ $.fn.options = function() {
         e.preventDefault();
         
         var li = $(this).parent();
-        var next = li.clone().find('div').remove().end().insertAfter(li);
-        next.find('input').val('').width('auto').autoGrowInput().focus();
+        addField(li);
       }
     });
     

data/app/assets/javascripts/wheelhouse-forms/submissions.js

@@ -0,0 +1,56 @@
+$(function() {
+
+function updateSubmission(url, spam, callback) {
+  $.ajax({
+    type: 'PUT',
+    url: url,
+    data: { spam: spam },    
+    dataType: 'json',
+    success: function() {
+      Wheelhouse.Flash.message("Submission updated.");
+      callback();
+    }
+  });
+  
+  Wheelhouse.Flash.loading("Updating submission.");
+}
+
+function clickHandler(spam) {
+  return function() {
+    var url = $(this).attr('href');
+    var row = $(this).closest('tr');
+    
+    updateSubmission(url, spam, function() {
+      row.remove();
+    });
+    
+    return false;
+  }
+}
+
+$('#submissions').on('click', 'a.mark-spam', clickHandler(true));
+$('#submissions').on('click', 'a.not-spam', clickHandler(false));
+
+$('button.mark-spam').click(function() {
+  var url = $(this).closest('form').attr('action');
+  
+  updateSubmission(url, true, function() {
+    $('button.mark-spam').hide();
+    $('button.not-spam').show();
+  });
+  
+  return false;
+});
+
+$('button.not-spam').click(function() {
+  var url = $(this).closest('form').attr('action');
+  
+  updateSubmission(url, false, function() {
+    $('button.not-spam').hide();
+    $('button.mark-spam').show();
+  });
+  
+  return false;
+});
+
+});

data/app/assets/stylesheets/wheelhouse-forms/admin.css.sass

@@ -225,9 +225,21 @@
   &.custom-field a
     background-image: image-url("wheelhouse-forms/custom.png")
 
-.sidebar li a.export-csv
-  background-image: image-url("wheelhouse-forms/csv.png")
-  padding-left: 40px
+.sidebar
+  a.spam-submissions
+    background-image: image-url("wheelhouse-forms/spam-small.png")
+    padding-left: 40px
+  
+  a.latest-submissions
+    background-image: image-url("wheelhouse-forms/submissions.png")
+    padding-left: 40px
+    
+  a.export-csv
+    background-image: image-url("wheelhouse-forms/csv.png")
+    padding-left: 40px
+  
+  button.mark-spam, button.not-spam
+    width: 222px
 
 .field
   li

data/app/controllers/forms/forms_controller.rb

@@ -2,6 +2,19 @@ class Forms::FormsController < Wheelhouse::ResourceController
   self.resource_class = Forms::Form
   manage_site_breadcrumb
   
+  helper Forms::SpamHelper
+  
+  def show
+    super do
+      @submissions = resource.submissions.not_spam.paginate(:page => params[:p])
+    end
+  end
+  
+  def spam
+    @form = resource
+    @submissions = resource.submissions.spam.paginate(:page => params[:p])
+  end
+  
   def version
     resource.revert_to(params[:version].to_i)
     render :edit

data/app/controllers/forms/submissions_controller.rb

@@ -7,7 +7,7 @@ class Forms::SubmissionsController < Wheelhouse::ResourceController
   manage_site_breadcrumb
   breadcrumb { [parent.label, parent] }
   
-  actions :show, :destroy
+  actions :show, :destroy, :update
   
   respond_to :csv
   
@@ -16,4 +16,9 @@ class Forms::SubmissionsController < Wheelhouse::ResourceController
       format.csv { render :text => Forms::CsvExporter.new(parent).to_csv }
     end
   end
+  
+  def update
+    resource.spam!(params[:spam])
+    respond_with(resource)
+  end
 end

data/app/handlers/forms/form_handler.rb

@@ -7,7 +7,7 @@ class Forms::FormHandler < Wheelhouse::ResourceHandler
   end
   
   post do
-    @form.submit(params[:submission])
+    @form.submit(params[:submission], request)
   end
 
 private

data/app/helpers/forms/mailer_helper.rb

@@ -7,7 +7,7 @@ module Forms::MailerHelper
       render_custom_field(field)
     when Forms::Fields::Checkboxes
       render_array(field, @submission.value_for(field) || ["None given"])
-    when Forms::Fields::ContentField
+    when Forms::Fields::ContentField, Forms::Fields::SubmitButton
       # Nothing
     else
       render_text_field(field, @submission.value_for(field))

data/app/helpers/forms/spam_helper.rb

@@ -0,0 +1,21 @@
+module Forms::SpamHelper
+  def spam_icon
+    icon("wheelhouse-forms/spam.png", :alt => "Mark as spam", :title => "Click to mark submission as spam")
+  end
+  
+  def not_spam_icon
+    icon("wheelhouse-forms/not-spam.png", :alt => "Mark as not spam", :title => "Click to mark submission as not spam")
+  end
+  
+  def toggle_spam_link(submission, path)
+    if submission.spam?
+      link_to not_spam_icon, path, :class => "not-spam"
+    else
+      link_to spam_icon, path, :class => "mark-spam"
+    end
+  end
+  
+  def listing_spam?
+    controller.action_name == "spam"
+  end
+end

data/app/helpers/forms/submissions_helper.rb

@@ -15,7 +15,7 @@ module Forms::SubmissionsHelper
         value = @submission.value_for(field)
         form.text_area field.label, :value => value || "", :readonly => true, :rows => 5
       end
-    when Forms::Fields::ContentField
+    when Forms::Fields::ContentField, Forms::Fields::SubmitButton
       # Nothing
     else
       labelled_field(field) do

data/app/models/forms/form.rb

@@ -18,7 +18,7 @@ class Forms::Form < Wheelhouse::Resource
   
   icon "wheelhouse-forms/form.png"
   
-  attr_accessor :view_context, :current_submission
+  attr_accessor :view_context, :current_submission, :success
   
   def to_s
     render(view_context)
@@ -28,15 +28,16 @@ class Forms::Form < Wheelhouse::Resource
     Forms::FormRenderer.new(self, current_submission, template).render
   end
   
-  def submit(params)
-    submission = submissions.build(:params => params)
+  def submit(params, request)
+    submission = submissions.build(:params => params, :ip_address => request.remote_ip)
+    Forms::Plugin.config.wheelhouse.forms.spam_filter.check(submission)
     
     if submission.save
-      deliver(submission)
-      @success = true
+      deliver(submission) unless submission.spam?
+      self.success = true
     else
       self.current_submission = submission
-      @success = false
+      self.success = false
     end
   end
   

data/app/models/forms/submission.rb

@@ -1,36 +1,18 @@
 class Forms::Submission < Wheelhouse::BasicResource
-  class Parameters < Hash
-    def to_mongo
-      result = []
-      each do |key, value|
-        result << [key, value]
-      end
-      result
-    end
-    
-    def self.cast(params)
-      case params
-      when Hash
-        self[params]
-      when Array
-        params.each_with_object({}) { |v, hash| hash[v[0]] = v[1] }
-      end
-    end
-    
-    def self.from_mongo(params)
-      cast(params)
-    end
-  end
-  
   include Wheelhouse::Resource::AdminPath
   
   property :params, Parameters
+  property :ip_address, String
+  property :spam, Boolean, :default => false, :protected => true
   timestamps!
   
   belongs_to :form, :class => "Forms::Form"
   
   default_scope order(:created_at.desc)
   
+  scope :spam, where(:spam => true)
+  scope :not_spam, where(:spam.ne => true)
+  
   validate do
     form.fields.flatten.each do |field|
       if field.required? && value_for(field).blank?
@@ -39,8 +21,13 @@ class Forms::Submission < Wheelhouse::BasicResource
     end
   end
   
+  def spam!(is_spam)
+    Forms::Plugin.config.wheelhouse.forms.spam_filter.train(self, is_spam)
+    update_attribute(:spam, is_spam)
+  end
+  
   def value_for(field)
-    params[field.label]
+    params[field.label] if field.respond_to?(:label)
   end
   
   def admin_path

data/app/models/forms/submission/parameters.rb

@@ -0,0 +1,24 @@
+class Forms::Submission
+  class Parameters < Hash
+    def to_mongo
+      result = []
+      each do |key, value|
+        result << [key, value]
+      end
+      result
+    end
+  
+    def self.cast(params)
+      case params
+      when Hash
+        self[params]
+      when Array
+        params.each_with_object({}) { |v, hash| hash[v[0]] = v[1] }
+      end
+    end
+  
+    def self.from_mongo(params)
+      cast(params)
+    end
+  end
+end

data/app/views/forms/forms/{_submissions.haml → _submissions.html.haml}

@@ -1,19 +1,16 @@
-- @submissions = resource.submissions.paginate(:page => params[:p])
-
-%h2 Latest Submissions
-
-= table_for Forms::Submission do |table|
+= table_for Forms::Submission, :id => "submissions" do |table|
   - table.rows(@submissions) do |row, submission|
     - row.resource = [@form, submission]
-  
+
     - if resource.first_content_field
       = row.column(resource.first_content_field.label) { submission.value_for(resource.first_content_field) }
-    
+
     = row.column(:submitted_at) { submission.created_at.in_time_zone.to_s(:long) }
-  
+
     = row.controls do |c|
+      = toggle_spam_link(submission, form_submission_path(@form, submission))
       = c.delete
-  
+
   - table.empty do
     No submissions have been posted.
 

data/app/views/forms/forms/designer.haml

@@ -53,4 +53,4 @@
   = stylesheet_link_tag "wheelhouse-forms/admin"
 
 - content_for(:javascript) do
-  = javascript_include_tag "wheelhouse-forms/admin"
+  = javascript_include_tag "wheelhouse-forms/designer"

data/app/views/forms/forms/edit.html.haml

@@ -1,5 +1,5 @@
 - title "Editing Form"
-- breadcrumb @form.label, form_path(@form)
+- breadcrumb @form.label, @form
 - breadcrumb "Editing Form"
 
 = render_form "designer"

data/app/views/forms/forms/form.haml

@@ -1,4 +1,6 @@
-- tab :submissions => "submissions"
+- tab :submissions do
+  %h2 #{listing_spam? ? "Spam" : "Latest"} Submissions
+  = render "submissions"
 
 - sidebar do
   .buttons
@@ -7,7 +9,12 @@
   %hr
 
   %ul
-    %li= link_to "Export results as CSV", form_submissions_path(@form, :format => :csv), :class => "export-csv"
+    - if listing_spam?
+      %li= link_to "View Latest Submissions", form_path(@form), :class => "latest-submissions"
+    - else
+      %li= link_to "View Spam Submissions", spam_form_path(@form), :class => "spam-submissions"
+      
+    %li= link_to "Export Results as CSV", form_submissions_path(@form, :format => :csv), :class => "export-csv"
   
   %hr
 
@@ -20,3 +27,7 @@
 
 - content_for(:head) do
   = stylesheet_link_tag "wheelhouse-forms/admin"
+
+- content_for(:javascript) do
+  = javascript_include_tag "wheelhouse-forms/submissions"
+  

data/app/views/forms/forms/spam.html.haml

@@ -0,0 +1,5 @@
+- title @form.label
+- breadcrumb @form.label, @form
+- breadcrumb "Spam Submissions"
+
+= render_form

data/app/views/forms/submissions/form.haml

@@ -7,10 +7,20 @@
 - sidebar do
   .buttons
     = button "Back to list", :url => @form
+    
+    = button "Mark submission as spam", :class => "secondary dark mark-spam", :icon => "wheelhouse-forms/spam-small.png", :style => @submission.spam? ? "display: none" : ""
+    = button "Submission is not spam", :class => "secondary not-spam", :icon => "wheelhouse-forms/not-spam-small.png", :style => !@submission.spam? ? "display: none" : ""
   
   %hr
   
   %p.owner Submitted: #{timestamp(@submission.created_at)}
+  - if @submission.ip_address?
+    %p.owner IP Address: #{@submission.ip_address}
+  
+  %hr
 
 - content_for(:head) do
   = stylesheet_link_tag "wheelhouse-forms/admin"
+
+- content_for(:javascript) do
+  = javascript_include_tag "wheelhouse-forms/submissions"

data/config/routes.rb

@@ -2,6 +2,10 @@ Forms::Plugin.routes.draw do
   extend Wheelhouse::RouteExtensions
   
   resources :forms do
+    member do
+      get :spam
+    end
+    
     resources :submissions
   end
 end

data/lib/forms/akismet_filter.rb

@@ -0,0 +1,36 @@
+module Forms
+  class AkismetFilter
+    include Rakismet::Model
+    
+    def self.check(submission)
+      filter = new(submission)
+      submission.spam = true if filter.spam?
+    end
+    
+    def self.train(submission, is_spam)
+      filter = new(submission)
+      is_spam ? filter.spam! : filter.ham!
+    end
+    
+    def initialize(submission)
+      @submission = submission
+    end
+    
+    def user_ip
+      @submission.ip_address
+    end
+    
+    def content
+      responses.join("\n")
+    end
+  
+  private
+    def responses
+      fields.map { |field| @submission.value_for(field) }
+    end
+    
+    def fields
+      @submission.form.fields.flatten
+    end
+  end
+end

data/lib/forms/null_filter.rb

@@ -0,0 +1,9 @@
+module Forms
+  class NullFilter
+    def self.check(submission)
+    end
+    
+    def self.train(submission, is_spam)
+    end
+  end
+end

data/lib/wheelhouse-forms.rb

@@ -1,12 +1,26 @@
 require "wheelhouse"
 
+begin
+  require "rakismet"
+rescue LoadError
+  # Rakismet not available
+end
+
 module Forms
+  extend ActiveSupport::Autoload
+  
+  autoload :AkismetFilter
+  autoload :NullFilter
+  
   class Plugin < Wheelhouse::Plugin
     config.wheelhouse.forms = ActiveSupport::OrderedOptions.new
     
     # Disable custom fields by default
     config.wheelhouse.forms.custom_fields = false
     
+    # Set default spam filter
+    config.wheelhouse.forms.spam_filter = defined?(Rakismet) ? AkismetFilter : NullFilter
+    
     isolate_namespace Forms
     
     resource { Form }
@@ -16,7 +30,7 @@ module Forms
     end
     
     initializer :precompile_assets do |app|
-      app.config.assets.precompile += %w(wheelhouse-forms/admin.*)
+      app.config.assets.precompile += %w(wheelhouse-forms/admin.* wheelhouse-forms/designer.js wheelhouse-forms/submissions.js)
     end
     
     def self.load_yaml(file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wheelhouse-forms
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wheelhouse
@@ -42,21 +42,28 @@ files:
 - app/assets/images/wheelhouse-forms/drag.png
 - app/assets/images/wheelhouse-forms/field-set.png
 - app/assets/images/wheelhouse-forms/form.png
+- app/assets/images/wheelhouse-forms/not-spam-small.png
+- app/assets/images/wheelhouse-forms/not-spam.png
 - app/assets/images/wheelhouse-forms/radio-buttons.png
 - app/assets/images/wheelhouse-forms/select.png
+- app/assets/images/wheelhouse-forms/spam-small.png
+- app/assets/images/wheelhouse-forms/spam.png
 - app/assets/images/wheelhouse-forms/states.png
+- app/assets/images/wheelhouse-forms/submissions.png
 - app/assets/images/wheelhouse-forms/submit-button.png
 - app/assets/images/wheelhouse-forms/text-area.png
 - app/assets/images/wheelhouse-forms/text-field.png
-- app/assets/javascripts/wheelhouse-forms/admin.js
+- app/assets/javascripts/wheelhouse-forms/designer.js
 - app/assets/javascripts/wheelhouse-forms/jquery.autogrow.js
 - app/assets/javascripts/wheelhouse-forms/jquery.options.js
+- app/assets/javascripts/wheelhouse-forms/submissions.js
 - app/assets/stylesheets/wheelhouse-forms/admin.css.sass
 - app/controllers/forms/forms_controller.rb
 - app/controllers/forms/submissions_controller.rb
 - app/handlers/forms/form_handler.rb
 - app/helpers/forms/forms_helper.rb
 - app/helpers/forms/mailer_helper.rb
+- app/helpers/forms/spam_helper.rb
 - app/helpers/forms/submissions_helper.rb
 - app/mailers/forms/mailer.rb
 - app/models/forms/field_collection.rb
@@ -75,6 +82,7 @@ files:
 - app/models/forms/fields/text_area.rb
 - app/models/forms/fields/text_field.rb
 - app/models/forms/form.rb
+- app/models/forms/submission/parameters.rb
 - app/models/forms/submission.rb
 - app/renderers/forms/checkbox_renderer.rb
 - app/renderers/forms/checkboxes_renderer.rb
@@ -102,7 +110,7 @@ files:
 - app/views/forms/forms/_radio_buttons.haml
 - app/views/forms/forms/_select_field.haml
 - app/views/forms/forms/_states_dropdown.haml
-- app/views/forms/forms/_submissions.haml
+- app/views/forms/forms/_submissions.html.haml
 - app/views/forms/forms/_submit_button.haml
 - app/views/forms/forms/_text_area.haml
 - app/views/forms/forms/_text_field.haml
@@ -111,13 +119,16 @@ files:
 - app/views/forms/forms/form.haml
 - app/views/forms/forms/new.html.haml
 - app/views/forms/forms/show.html.haml
+- app/views/forms/forms/spam.html.haml
 - app/views/forms/submissions/form.haml
 - app/views/forms/submissions/show.html.haml
 - config/countries.yml
 - config/locales/en.yml
 - config/routes.rb
 - config/states.yml
+- lib/forms/akismet_filter.rb
 - lib/forms/csv_exporter.rb
+- lib/forms/null_filter.rb
 - lib/wheelhouse-forms.rb
 - README.md
 - LICENSE
@@ -146,4 +157,3 @@ signing_key:
 specification_version: 3
 summary: Wheelhouse CMS Forms Plugin
 test_files: []
-has_rdoc: