radiant-forms-extension 2.0.1 → 3.1.1

data/README.md

@@ -2,15 +2,23 @@
 
 This extension allows a developer to create forms which can take on multiple tasks
 
-The idea was taken from the mailer extension, everything mail specific is used in [radiant-forms_mail-extension](http://github.com/squaretalent/radiant-forms_mail-extension)
-  
 Using forms 'DRY's up the process of creating and reusing forms across a site (well I think so at least).
 
 ## Installation
-  
-    git clone git://github.com/squaretalent/radiant-forms-extension vendor/extensions/forms
+
+   **The New way:**
+    
+    gem install radiant-forms-extension
+    # add the following line to your config/environment.rb: config.gem 'radiant-forms-extension', :lib => false
+    rake radiant:extensions:forms:update
     rake radiant:extensions:forms:migrate
+
+   **The old way:**
+    
+    git clone git://github.com/squaretalent/radiant-forms-extension vendor/extensions/forms
     rake radiant:extensions:forms:update
+    rake radiant:extensions:forms:migrate
+    
   
 ## Usage
   
@@ -81,24 +89,74 @@ Using forms 'DRY's up the process of creating and reusing forms across a site (w
       </body>
     </html>
     
+### Email
+
+Delete the following line in config/environment.rb
+
+    config.frameworks -= [ :action_mailer ]
+    
+or just remove the :action_mailer references
+
+    config.frameworks -= []
+
+
+#### Config
+
+Define your mailing variables 
+
+_hardcoded_
+
+    mail:
+      from: email@email.com
+      to: email@email.com
+      reply_to: email@email.com      
+      subject: subject text
+      
+_variable_
+      
+    mail:
+      field:
+        from: person[email]
+        to: person[email]
+        subject: contact[subject]
+        reply_to: person[email]
+
+#### SMTP
+
+Of course you are probably using sendgrid to make sending emails easy, 
+but if you're using SMTP create the following to **/config/initializers/form_mail.rb**
+
+    ActionMailer::Base.delivery_method = :smtp
+    ActionMailer::Base.raise_delivery_errors = true
+    ActionMailer::Base.smtp_settings = {
+      :enable_starttls_auto =>  true,
+      :address              =>  "smtp.gmail.com",
+      :port                 =>  "587",
+      :domain               =>  "smtp.gmail.com",
+      :authentication       =>  :plain,
+      :user_name            =>  "username@gmail.com",
+      :password             =>  "password"
+    }
+
 ## Addons
 
 ### The Market
 
-* [radiant-forms_mail-extension](http://github.com/squaretalent/radiant-forms_mail-extension) - 
 A showcase of how to use addons, allows you to send emails directly from the page
 
-### Controller
-
-  Must be named **FormsBlahController** and a controller of the same name
+### Model
 
-    class FormsBlahController
-      include Forms::AddonMethods # Manages your controller initialization
+    class FormBlah
+      include Forms::Models::Extension # Sorts out initialization giving you
+      
+      # def initialize(form, page)
+      # @form = form
+      # @page = page
+      # 
+      # @data   = @page.data
+      # @config = @form.config[self.class.to_s.downcase.gsub('form', '').to_sym].symbolize_keys # @form.config[:blah]
 
       def create
-        # @form = Form which the data comes from
-        # @page = Page which submitted the form (data contains submitted information)
-
         # return = {
         #   :hash => 'these details will be returned to the result page namespaced under blah'  
         # }
@@ -115,4 +173,17 @@ A showcase of how to use addons, allows you to send emails directly from the pag
 ### Functionality
 
     I'm going to let you sort that out, you have the create action with input and output
-    from here you can decide how your form addon is going to behave.
+    from here you can decide how your form addon is going to behave.
+
+# Development
+
+    unless ENV["RAILS_ENV"] == "production"
+      config.gem 'rspec',             :version => '1.3.0'
+      config.gem 'rspec-rails',       :version => '1.3.2'
+      config.gem 'cucumber',          :verison => '0.8.5'
+      config.gem 'cucumber-rails',    :version => '0.3.2'
+      config.gem 'database_cleaner',  :version => '0.4.3'
+      config.gem 'ruby-debug',        :version => '0.10.3'
+      config.gem 'webrat',            :version => '0.7.1'
+      config.gem 'rr',                :version => '0.10.11'
+    end

data/VERSION

@@ -1 +1 @@
-2.0.1
+3.1.1

data/app/controllers/forms_controller.rb

@@ -3,32 +3,49 @@ class FormsController < ApplicationController
   no_login_required
   
   skip_before_filter :verify_authenticity_token
-  
-  # POST /forms/1
-  #----------------------------------------------------------------------------
-  def create
-    @page = Page.find(params[:page_id])
-    @form = Form.find(params[:form_id])
-    @page.data = params    
+
+  def update
+    @form = Form.find(params[:id])
+    
+    @page = Page.find(params[:page_id]) rescue Page.first
+    @page.data    = params 
+    @page.request = OpenStruct.new({
+      :session => session # Creating a pretend response object
+    })
     
-    response = current_response
-    response.result = params
+    # We need a response object
+    @response = find_or_create_response
+    # Put the submitted data into the response object
+    @response.result = Forms::Config.deep_symbolize_keys(params)
     
     begin
-      @form[:config] = YAML::load("--- !map:HashWithIndifferentAccess\n"+@form[:config]).symbolize_keys
+      # Grab the form configuration data
+      @form[:extensions] = Forms::Config.convert(@form.config)
     rescue
       raise "Form '#{@form.title}' has not been configured"
     end
     
-    @form[:config].each do |ext, config|
-      ext_controller  = ("Forms#{ext.to_s.capitalize}Controller".constantize).new(@form, @page)
-      response.result = response.result.merge({ "#{ext}_ext" => ext_controller.create })
+    @results =  {}
+    # Iterate through each configured extension
+    @form[:extensions].each do |ext, config|
+      # New Instance of the FormExtension class
+      extension = ("Form#{ext.to_s.pluralize.classify}".constantize).new(@form, @page) 
+      # .pluralize.classify means singulars like business and address are converted correctly
+      
+      # Result of the extension create method gets merged
+      result = extension.create
+      
+      @results.merge!({ ext.to_sym => result }) # merges this extensions results
+      session.merge!(result[:session]) if result[:session].present?
     end
+    # Those results are merged into the response object
+    @response.result = @response.result.merge!({ :results => @results})
     
-    if response.save  
-      redirect_to (@form.redirect_to.nil? ? @page.url : @form.redirect_to)
-    else
-      raise "Form '#{@form.name}' could not be submitted. Sorry"
+    begin
+      @response.save!
+      redirect_to @form.redirect_to.present? ? @form.redirect_to : @page.url
+    rescue
+      "Form '#{@form.title}' could not be submitted."
     end
   end
   

data/app/models/form.rb

@@ -1,5 +1,11 @@
 class Form < ActiveRecord::Base
   
-  validates_presence_of :title
+  default_scope           :order => 'forms.title ASC'
+  
+  validates_presence_of   :title
+  validates_uniqueness_of :title
+  
+  belongs_to :created_by, :class_name => 'User'
+  belongs_to :updated_by, :class_name => 'User'
   
 end

data/app/models/form_mail.rb

@@ -0,0 +1,118 @@
+class FormMail
+  include Forms::Models::Extension
+  
+  def create
+    @body   = @page.render_snippet(@form)
+    
+    begin
+      FormMailer.deliver_mail(
+        :recipients     => recipients,
+        :from           => from,
+        :reply_to       => reply_to,
+        :subject        => subject,
+        :body           => body,
+        :cc             => cc,
+        :headers        => headers,
+        :content_type   => content_type,
+        :charset        => charset
+      )
+      @sent = true
+    rescue Exception => exception
+      raise exception if RAILS_ENV['development']
+      @message = exception
+      @sent = false
+    end
+    
+    @result = {
+      :sent     => self.sent?,
+      :message  => self.message,
+      :subject  => self.subject,
+      :from     => self.from
+    }
+  end
+  
+  def from
+    from = nil
+    unless @config[:field].nil? or !@config[:field][:from].blank?
+      from = Forms::Tags::Responses.retrieve(@data, @config[:field][:from])
+    else
+      from = @config[:from]
+    end
+    from
+  end
+  
+  def recipients
+    to = nil
+    unless @config[:field].nil? or !@config[:field][:to].blank?
+      to = Forms::Tags::Responses.retrieve(@data, @config[:field][:to])
+    else
+      to = @config[:to]
+    end
+    to
+  end
+  
+  def reply_to
+    reply_to = nil
+    unless @config[:field].nil? or !@config[:field][:reply_to].blank?
+      reply_to = Forms::Tags::Responses.retrieve(@data, @config[:field][:reply_to])
+    else
+      reply_to = @config[:reply_to]
+    end
+    reply_to
+  end
+  
+  def sender
+    sender = nil
+    unless @config[:field].nil? or !@config[:field][:sender].blank?
+      sender = Forms::Tags::Responses.retrieve(@data, @config[:field][:sender])
+    else
+      sender = @config[:sender]
+    end
+    sender
+  end
+  
+  def subject
+    subject = nil
+    unless @config[:field].nil? or !@config[:field][:subject].blank?
+      subject = Forms::Tags::Responses.retrieve(@data, @config[:field][:subject])
+    else
+      subject = @config[:subject]
+    end
+    subject
+  end
+  
+  def body
+    @body || ''
+  end
+  
+  def cc
+    @config[:cc]
+  end
+  
+  def sent?
+    @sent || false
+  end
+  
+  def message
+    @message || nil
+  end
+  
+  def headers
+    headers = { 'Reply-To' => reply_to }
+    if sender
+      headers['Return-Path'] = sender
+      headers['Sender'] = sender
+    end
+    headers
+  end
+  
+  def content_type
+    content_type = @config[:content_type] || 'text/html'
+  end
+  
+  def charset
+    charset = @config[:charset] || 'utf-8'
+    charset = charset == '' ? nil : charset
+  end
+  
+end

data/app/models/form_mailer.rb

@@ -0,0 +1,16 @@
+class FormMailer < ActionMailer::Base
+  
+  def mail(options)
+    content_type  options[:content_type]
+    charset       options[:charset]
+    headers       options[:headers]
+    
+    recipients    options[:recipients]
+    from          options[:from]
+    cc            options[:cc]
+    bcc           options[:bcc]
+    subject       options[:subject]
+    body          options[:body]
+  end
+  
+end

data/app/models/response.rb

@@ -1,7 +1,12 @@
 class Response < ActiveRecord::Base
   
   def result
-    ActiveSupport::JSON.decode(self.result_json) unless self.result_json.nil?
+    result = {}
+    if self.result_json.present?
+      result = ActiveSupport::JSON.decode(self.result_json) 
+      result = Forms::Config.deep_symbolize_keys(result)
+    end
+    result
   end
   
   def result=(result)

data/config/routes.rb

@@ -4,6 +4,6 @@ ActionController::Routing::Routes.draw do |map|
     admin.resources :forms
   end
   
-  map.forms '/forms/:form_id', :controller => 'forms', :action => 'create', :conditions => { :method => :post }
+  map.resources :forms, :only => [ :update ]
   
 end

data/db/migrate/20100929150423_change_to_updated_by_id.rb

@@ -0,0 +1,15 @@
+class ChangeToUpdatedById < ActiveRecord::Migration
+  def self.up
+    add_column :forms,    :created_by_id,   :integer
+    add_column :forms,    :updated_by_id,   :integer
+    remove_column :forms, :created_by
+    remove_column :forms, :updated_by
+  end
+
+  def self.down
+    remove_column :forms, :created_by_id
+    remove_column :forms, :updated_by_id
+    add_column :forms,    :created_by,      :integer
+    add_column :forms,    :updated_by,      :integer
+  end
+end

data/forms_extension.rb

@@ -4,18 +4,22 @@ class FormsExtension < Radiant::Extension
   url         'http://github.com/squaretalent/radiant-forms-extension'
   
   extension_config do |config|
-    if RAILS_ENV == :test
-      config.gem 'rr',        :version => '0.10.11'
-    end
   end
   
   def activate
-    Radiant::AdminUI.send(:include, Forms::AdminUI) unless defined? admin.form
-    admin.form = Radiant::AdminUI.load_default_form_regions
+    # View Hooks
+    unless defined? admin.form
+      Radiant::AdminUI.send :include, Forms::Interface::Forms
+      
+      admin.form = Radiant::AdminUI.load_default_form_regions
+    end
+    
+    # Model Includes
+    Page.send :include, Forms::Tags::Core, Forms::Models::Page
     
-    Page.class_eval { include Forms::Tags, Forms::PageExtensions }
-    ApplicationController.send(:include, Forms::ApplicationControllerExtensions)
-    SiteController.send(:include, Forms::SiteControllerExtensions)
+    # Controller Includes
+    ApplicationController.send :include, Forms::Controllers::ApplicationController
+    SiteController.send :include, Forms::Controllers::SiteController
     
     tab 'Design' do
       add_item 'Forms', '/admin/forms', :after => 'Snippets'

data/lib/forms/config.rb

@@ -0,0 +1,30 @@
+module Forms
+  module Config
+    
+    class << self
+      def convert(yaml)
+        hash = hashify(yaml)
+        hash = deep_symbolize_keys(hash)
+        
+        hash
+      end
+      
+      def hashify(yaml)
+        YAML::load("--- !map:HashWithIndifferentAccess\n"+yaml)
+      end
+      
+      def deep_symbolize_keys(item)
+        case item
+        when Hash
+          item.inject({}) do |acc, (k, v)|
+            acc[(k.to_sym rescue k)] = deep_symbolize_keys(v)
+            acc
+          end
+        else
+          item
+        end
+      end
+    end
+    
+  end
+end

data/lib/forms/controllers/application_controller.rb

@@ -0,0 +1,39 @@
+module Forms
+  module Controllers
+    module ApplicationController
+      
+      def self.included(base)
+        base.class_eval do
+          def current_response
+            return @current_response if defined?(@current_response)
+            @current_response = find_response
+          end
+          
+          def find_response
+            response = nil
+            
+            if request.session[:form_response]
+              response = Response.find(request.session[:form_response])
+            end
+                        
+            response
+          end
+          
+          def find_or_create_response
+            response = nil
+            
+            if find_response
+              response = find_response
+            else
+              response = Response.create
+              request.session[:form_response] = response.id
+            end
+            
+            response
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/forms/controllers/site_controller.rb

@@ -0,0 +1,13 @@
+module Forms
+  module Controllers
+    module SiteController
+      
+      def self.included(base)
+        base.class_eval do
+          before_filter :current_response
+        end
+      end
+      
+    end
+  end
+end

data/lib/forms/interface/forms.rb

@@ -0,0 +1,25 @@
+module Forms
+  module Interface
+    module Forms
+
+     def self.included(base)
+       base.class_eval do
+          attr_accessor :form
+          alias_method :forms, :form
+          protected
+            def load_default_form_regions
+              returning OpenStruct.new do |form|
+                form.edit = Radiant::AdminUI::RegionSet.new do |edit|
+                  edit.main.concat %w{edit_header edit_form}
+                  edit.form.concat %w{edit_title edit_content}
+                  edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+                end
+                form.new = form.edit
+              end
+            end
+        end
+      end
+      
+    end    
+  end
+end

data/lib/forms/models/extension.rb

@@ -0,0 +1,25 @@
+module Forms
+  module Models
+    module Extension
+      def self.included(base)
+        base.class_eval do 
+          def initialize(form, page)
+            @form   = form
+            @page   = page
+            
+            @data   = Forms::Config.deep_symbolize_keys(@page.data)
+            
+            # Sets the config to be the current environment config: checkout:
+            @config = @form[:extensions][self.class.to_s.underscore.gsub('form_', '').to_sym]
+          end
+          
+          def current_user
+            return @current_user if @current_user.present? 
+            @current_user = UserActionObserver.current_user
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/forms/models/page.rb

@@ -0,0 +1,14 @@
+module Forms
+  module Models
+    module Page
+
+      def self.included(base)
+        base.class_eval do
+          attr_accessor :last_form
+          attr_accessor :data
+        end
+      end
+      
+    end
+  end
+end