bcms_feedback_form 1.0.0

data/README

@@ -0,0 +1,2 @@
+== bcms_feedback_form - A Feedback Form module for the BrowserCMS content management system.
+

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/feedback_forms_controller.rb

@@ -0,0 +1,2 @@
+class Cms::FeedbackFormsController < Cms::ContentBlockController
+end

data/app/controllers/feedback_forms_controller.rb

@@ -0,0 +1,26 @@
+class FeedbackFormsController < ApplicationController
+  def submit
+    feedback_form = FeedbackForm.find(params[:id])
+    if feedback_form.use_recaptcha == true
+      if verify_recaptcha
+        Feedback.deliver_feedback(feedback_form, params)
+      else
+        raise
+      end
+    else
+      Feedback.deliver_feedback(feedback_form, params)
+    end
+    if request.xhr?
+      render :text => ((feedback_form.thank_you.blank?) ? 'Thanks!' : feedback_form.thank_you), :layout => false and return
+    else
+      redirect_to((params[:_redirect_to].blank?) ? '/' : params[:_redirect_to]) and return
+    end
+  rescue
+    if request.xhr?
+      render :text => 'There seems to have been an error. Please try again', :layout => false and return
+    else
+      redirect_to((params[:_redirect_to].blank?) ? '/' : params[:_redirect_to]) and return
+    end
+  end
+
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/helpers/feedback_forms_helper.rb

@@ -0,0 +1,2 @@
+module FeedbackFormsHelper
+end

data/app/models/feedback.rb

@@ -0,0 +1,10 @@
+class Feedback < ActionMailer::Base
+
+  def feedback(feedback_form,params)
+    recipients feedback_form.send_to.split(',')
+    from       (feedback_form.from.blank?) ? params[:from] : feedback_form.from
+    subject    (feedback_form.subject.blank?) ? 'Feedback form submission' : feedback_form.subject
+    body       :feedback_form => feedback_form, :cgi_params => params, :fields => params[:feedback_form].keys
+  end
+
+end

data/app/models/feedback_form.rb

@@ -0,0 +1,9 @@
+class FeedbackForm < ActiveRecord::Base
+  acts_as_content_block
+  validates_length_of :send_to, :maximum => 500
+  validates_length_of :subject, :maximum => 200, :allow_blank => true
+  validates_length_of :from, :maximum => 100, :allow_blank => true
+  validates_length_of :form, :maximum => 10000, :allow_blank => true
+  validates_length_of :description, :thank_you, :maximum => 5000, :allow_blank => true
+  validates_format_of :from, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i, :allow_blank => true
+end

data/app/views/cms/feedback_forms/_form.html.erb

@@ -0,0 +1,18 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_text_field :send_to, :instructions => 'A single email address or a comma-separated list of email addresses.' %>
+<%= f.cms_text_field :from, :instructions => 'A single email address that the form is sent "from". We\'ll try to parse the from out of the params if you don\'t specify it here - name the field "from".' %>
+
+<div class="fields checkbox_group">
+  <label>Use ReCaptcha</label>
+  <div class="checkboxes">
+    <div class="checkbox_fields">
+      <%= f.check_box :use_recaptcha %> <%= f.label :use_recaptcha, 'Use Recaptcha to protect this form from spammers. HIGHLY recommended.' %>
+    </div>
+  </div>
+  <br clear="all" />
+</div>
+
+<%= f.cms_text_field :subject, :instructions => 'The subject line of the outgoing email.' %>
+<%= f.cms_text_editor :description, :label => 'Description: The html / text that appears above the rendered form on the website.' %>
+<%= f.cms_text_editor :thank_you, :label => 'Thank you: The html / text that appears after a successful form submission' %>
+<%= f.cms_text_area :form, :label => 'Form: (OPTIONAL). You can define a form here manually and it will be wrapped in the correct form tag. All form elements you want sent through the mailer should live in the "feedback_form[]" parameter namespace, so they\'d have names like "feedback_form[message]"' %>

data/app/views/cms/feedback_forms/render.html.erb

@@ -0,0 +1,24 @@
+<div class="feedback-form">
+  <%= @content_block.description %>
+  <div id="feedback-form-<%= @content_block.id %>">
+    <% form_remote_tag(:url => url_for(:controller => '/feedback_forms', :action => :submit, :id => @content_block.id), :update => "feedback-form-#{@content_block.id}" ) do -%>
+      <% unless @content_block.form.blank? %>
+        <%= @content_block.form %>
+      <% else %>
+        <p><strong>Name:</strong> <%= text_field_tag 'feedback_form[name]' %></p>
+        <p><strong>Email:</strong> <%= text_field_tag 'feedback_form[from]' %></p>
+        <p><strong>About:</strong> <%= text_field_tag 'feedback_form[about]' %></p>
+        <p>
+        <strong>Message:</strong><br/>
+        <%= text_area_tag 'feedback_form[message]', '', :size => '60x4' %>
+        </p>
+      <% end %>
+      <% if @content_block.use_recaptcha %>
+        <p><strong>Please enter the text below:</strong></p>
+        <%= recaptcha_tags %>
+      <% end %>
+      <%= hidden_field_tag '_redirect_to', url_for() %>
+      <%= submit_tag 'Submit form' %>
+    <% end %>
+  </div>
+</div>

data/app/views/feedback/feedback.text.html.erb

@@ -0,0 +1,12 @@
+<h2>Feedback form submission</h2>
+
+<table border="0" cellpadding="3">
+<% @fields.each do |field| -%>
+  <tr>
+    <th><strong><%=h field.titleize %></strong></th>
+    <td><%=h @cgi_params[:feedback_form][field] %></td>
+  </tr>
+<% end -%>
+</table>
+
+<p>at: <%= Time.now.to_s %></p>

data/app/views/feedback/feedback.text.plain.erb

@@ -0,0 +1,7 @@
+Feedback form submission:
+
+<% @fields.each do |field| -%>
+<%= field.titleize %> => <%= @cgi_params[:feedback_form][field] %>
+<% end -%>
+
+at: <%= Time.now.to_s %>

data/app/views/feedback_forms/submit.html.erb

@@ -0,0 +1,2 @@
+<h1>FeedbackForms#submit</h1>
+<p>Find me in app/views/feedback_forms/submit.html.erb</p>

data/config/initializers/recaptcha.rb

@@ -0,0 +1,2 @@
+ENV['RECAPTCHA_PUBLIC_KEY'] = 'YOUR PUBLIC KEY HERE'
+ENV['RECAPTCHA_PRIVATE_KEY'] = 'YOUR PRIVATE KEY HERE'

data/db/migrate/20100312161745_create_feedback_forms.rb

@@ -0,0 +1,22 @@
+class CreateFeedbackForms < ActiveRecord::Migration
+  def self.up
+    create_content_table :feedback_forms do |t|
+      t.string :send_to, :limit => 500
+      t.string :subject, :limit => 200
+      t.string :from, :limit => 100
+      t.string :form, :limit => 10000
+      t.string :description, :limit => 5000
+      t.string :thank_you, :limit => 5000
+      t.boolean :use_recaptcha, :default => true
+    end
+    ContentType.create!(:name => "FeedbackForm", :group_name => "FeedbackForm")
+  end
+
+  def self.down
+    ContentType.delete_all(['name = ?', 'FeedbackForm'])
+    CategoryType.all(:conditions => ['name = ?', 'Feedback Form']).each(&:destroy)
+    #If you aren't creating a versioned table, be sure to comment this out.
+    drop_table :feedback_form_versions
+    drop_table :feedback_forms
+  end
+end

data/lib/bcms_feedback_form.rb

@@ -0,0 +1 @@
+require 'bcms_feedback_form/routes'

data/lib/bcms_feedback_form/routes.rb

@@ -0,0 +1,8 @@
+module Cms::Routes
+  def routes_for_bcms_feedback_form
+    self.connect 'feedback_forms/:action/:id.:format', :controller => 'feedback_forms'
+    namespace(:cms) do |cms|
+      cms.content_blocks :feedback_forms
+    end  
+  end
+end

data/public/bcms/feedback_form/README

@@ -0,0 +1 @@
+Use this directory to add public files that should copied from the gem into the project.

data/rails/init.rb

@@ -0,0 +1,4 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "public/bcms/feedback_form/**/*"

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_feedback_form
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Daniel Collis-Puro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-12 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: djcp+github@cyber.law.harvard.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/helpers/application_helper.rb
+- app/helpers/feedback_forms_helper.rb
+- app/views/feedback_forms/submit.html.erb
+- app/views/feedback/feedback.text.plain.erb
+- app/views/feedback/feedback.text.html.erb
+- app/views/cms/feedback_forms/render.html.erb
+- app/views/cms/feedback_forms/_form.html.erb
+- app/controllers/feedback_forms_controller.rb
+- app/controllers/application_controller.rb
+- app/controllers/cms/feedback_forms_controller.rb
+- app/models/feedback.rb
+- app/models/feedback_form.rb
+- db/migrate/20100312161745_create_feedback_forms.rb
+- lib/bcms_feedback_form.rb
+- lib/bcms_feedback_form/routes.rb
+- rails/init.rb
+- config/initializers/recaptcha.rb
+- public/bcms/feedback_form/README
+- README
+has_rdoc: true
+homepage: http://github.com/djcp/bcms_feedback_form
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bcms_feedback_form
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Feedback Form Module for BrowserCMS
+test_files: []
+