Option to choose template to send email to members

Victor Costa
1 parent e083ea4a
Showing 20 changed files with 262 additions and 4 deletions Show diff stats
app/controllers/my_profile/email_templates_controller.rb
app/controllers/public/profile_controller.rb
app/models/email_template.rb
app/models/environment.rb
app/models/profile.rb
app/views/email_templates/_form.html.erb
app/views/email_templates/edit.html.erb
app/views/email_templates/index.html.erb
app/views/email_templates/new.html.erb
app/views/email_templates/show.html.erb
app/views/profile/send_mail.html.erb
app/views/profile_editor/index.html.erb
public/javascripts/application.js
public/javascripts/email_templates.js
public/proposal-app
public/stylesheets/application.css
public/stylesheets/email-templates.css
test/functional/email_templates_controller_test.rb
test/functional/profile_editor_controller_test.rb
test/unit/email_template_test.rb
@@ -0,0 +1,63 @@
+class EmailTemplatesController < MyProfileController
+
+  protect 'send_mail_to_members', :profile
+
+  def index
+    @email_templates = profile.email_templates
+  end
+
+  def show
+    @email_template = profile.email_templates.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @email_template }
+    end
+  end
+
+  def show_parsed
+    @email_template = profile.email_templates.find(params[:id])
+    template_params = {:profile => profile, :environment => environment}
+    render json: {:parsed_body => @email_template.parsed_body(template_params), :parsed_subject => @email_template.parsed_subject(template_params)}
+  end
+
+  def new
+    @email_template = profile.email_templates.build
+  end
+
+  def edit
+    @email_template = profile.email_templates.find(params[:id])
+  end
+
+  def create
+    @email_template = profile.email_templates.build(params[:email_template], :owner => profile)
+
+    if @email_template.save
+      session[:notice] = _('Email template was successfully created.')
+      redirect_to url_for(:action => :index)
+    else
+      render action: "new"
+    end
+  end
+
+  def update
+    @email_template = profile.email_templates.find(params[:id])
+
+    if @email_template.update_attributes(params[:email_template])
+      session[:notice] = _('Email template was successfully updated.')
+      redirect_to url_for(:action => :index)
+    else
+      render action: "edit"
+    end
+  end
+
+  def destroy
+    @email_template = profile.email_templates.find(params[:id])
+    @email_template.destroy
+
+    respond_to do |format|
+      format.html { redirect_to url_for(:action => :index)}
+      format.json { head :no_content }
+    end
+  end
+end
@@ -353,6 +353,7 @@ class ProfileController &lt; PublicController
   def send_mail
     @mailing = profile.mailings.build(params[:mailing])
+    @email_templates = profile.email_templates
     if request.post?
       @mailing.locale = locale
       @mailing.person = user
@@ -4,6 +4,8 @@ class EmailTemplate &lt; ActiveRecord::Base
   attr_accessible :template_type, :subject, :body, :owner, :name
+  validates_presence_of :name
+
   def parsed_body(params)
     @parsed_body ||= parse(body, params)
   end
@@ -982,6 +982,10 @@ class Environment &lt; ActiveRecord::Base
     self.licenses.any?
   end
+  def to_liquid
+    HashWithIndifferentAccess.new :name => name
+  end
+
   private
   def default_language_available
@@ -151,6 +151,8 @@ class Profile &lt; ActiveRecord::Base
   has_many :comments_received, :class_name => 'Comment', :through => :articles, :source => :comments
+  has_many :email_templates, :foreign_key => :owner_id
+
   # Although this should be a has_one relation, there are no non-silly names for
   # a foreign key on article to reference the template to which it is
   # welcome_page... =P
@@ -471,6 +473,10 @@ class Profile &lt; ActiveRecord::Base
     self.articles.find(:all, options)
   end
+  def to_liquid
+    HashWithIndifferentAccess.new :name => name, :identifier => identifier
+  end
+
   class << self
     # finds a profile by its identifier. This method is a shortcut to
@@ -0,0 +1,30 @@
+<%= form_for(@email_template, :url => {:controller => :email_templates, :action => @email_template.persisted? ? :update : :create, :id => @email_template.id}) do |f| %>
+
+  <%= error_messages_for :email_template if @email_template.errors.any? %>
+
+  <div class="template-fields">
+    <div class="header-fields">
+      <%= labelled_form_field(_('Template Name:'), f.text_field(:name)) %>
+      <%= labelled_form_field(_('Subject:'), f.text_field(:subject)) %>
+    </div>
+    <div class="available-params">
+      <div class="reference">
+        <a target="_blank" href="https://github.com/Shopify/liquid/wiki/Liquid-for-Designers"><%= _('Template language reference') %></a>
+      </div>
+      <div class="label">
+        <%= _('The following parameters may be used in subject and body:') %>
+      </div>
+      <div class="values">
+        {{profile.name}}, {{profile.identifier}}, {{environment.name}}
+      </div>
+    </div>
+    <%= render :file => 'shared/tiny_mce' %>
+    <%= labelled_form_field(_('Body:'), f.text_area(:body, :class => 'mceEditor')) %>
+  </div>
+
+  <div class="actions">
+    <%= submit_button(:save, _('Save')) %>
+    <%= button(:back, _('Back'), :controller => :email_templates) %>
+  </div>
+
+<% end %>
@@ -0,0 +1,3 @@
+<h1>Editing Email Template</h1>
+
+<%= render 'form' %>
@@ -0,0 +1,23 @@
+<h1><%= _('Email Templates') %></h1>
+
+<table>
+  <tr>
+    <th><%= _('Name') %></th>
+    <th></th>
+  </tr>
+
+<% @email_templates.each do |email_template| %>
+  <tr>
+    <td><%= email_template.name %></td>
+    <td>
+      <%= link_to 'Edit', url_for(:controller => :email_templates, :action => :edit, :id => email_template.id) %>
+      <%= link_to 'Destroy', url_for(:controller => :email_templates, :action => :destroy, :id => email_template.id), method: :delete, data: { confirm: 'Are you sure?' } %>
+    </td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= button(:new, _('New template'), :controller => :email_templates, :action => :new) %>
+<%= button(:back, _('Back to control panel'), :controller => :profile_editor) %>
@@ -0,0 +1,3 @@
+<h1>New Email Template</h1>
+
+<%= render 'form' %>
@@ -0,0 +1,5 @@
+<p id="notice"><%= notice %></p>
+
+
+<%= link_to 'Edit', url_for(:controller => :email_templates, :action => :edit, :id => @email_template.id) %> |
+<%= link_to 'Back', url_for(:controller => :email_templates) %>
@@ -4,6 +4,12 @@
 <%= error_messages_for :mailing %>
+<div class="template-selection">
+  <% if @email_templates.present? %>
+    <%= labelled_form_field(_('Select a template:'), select_tag(:template, options_from_collection_for_select(@email_templates, :id, :name), :include_blank => true, 'data-url' => url_for(:controller => 'email_templates', :action => 'show_parsed'))) %>
+  <% end %>
+</div>
+
 <%= form_for :mailing, :url => {:action => 'send_mail'}, :html => {:id => 'mailing-form'} do |f| %>
   <%= labelled_form_field(_('Subject:'), f.text_field(:subject)) %>
@@ -72,6 +72,8 @@
   <%= control_panel_button(_('Edit welcome page'), 'welcome-page', :action => 'welcome_page') if has_welcome_page %>
+  <%= control_panel_button(_('Email Templates'), 'email-templates', :controller => :email_templates) if profile.organization? %>
+
   <% @plugins.dispatch(:control_panel_buttons).each do |button| %>
     <%= control_panel_button(button[:title], button[:icon], button[:url], button[:html_options]) %>
   <% end %>
@@ -28,6 +28,7 @@
 *= require catalog.js
 *= require autogrow.js
 *= require require_login.js
+*= require email_templates.js
 */
 // scope for noosfero stuff
@@ -0,0 +1,10 @@
+jQuery(document).ready(function($) {
+  $('.template-selection select').change(function() {
+    if(!$(this).val()) return;
+
+    $.getJSON($(this).data('url'), {id: $(this).val()}, function(data) {
+      $('#mailing-form #mailing_subject').val(data.parsed_subject);
+      $('#mailing-form .mceEditor').val(data.parsed_body);
+    });
+  });
+});
@@ -0,0 +1 @@
+Subproject commit e7ad7849b3ef685639d4c5c0bef7b323255e2afa
@@ -14,6 +14,7 @@
  * views specifics
  *= require chat
  *= require search
+ *= require email-templates
  */
 /* browser fixes */
@@ -4658,6 +4659,9 @@ h1#agenda-title {
 .controller-profile_editor a.control-panel-design-editor {
   background-image: url(../images/control-panel/preferences-desktop-wallpaper.png)
 }
+.controller-profile_editor a.control-panel-email-templates {
+  background-image: url(../images/control-panel/email.png)
+}
 .controller-profile_editor .msie6 a.control-panel-design-editor {
   background-image: url(../images/control-panel/preferences-desktop-wallpaper.gif)
 }
@@ -0,0 +1,15 @@
+.template-fields .header-fields, .template-fields .available-params {
+  width: 48%;
+  display: inline-block;
+}
+.template-fields .available-params .values {
+  color: rgb(111, 111, 111);
+}
+.template-fields .available-params .reference {
+  text-align: right;
+}
+.template-fields .available-params .reference a {
+  color: rgb(32, 101, 229);
+  text-decoration: none;
+  font-size: 10px;
+}
@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class EmailTemplatesControllerTest < ActionController::TestCase
+
+  setup do
+    @profile = fast_create(Community)
+    @email_template = EmailTemplate.create!(:name => 'template', :owner => @profile)
+    @person = create_user_with_permission('templatemanager', 'send_mail_to_members', @profile)
+    login_as(@person.user.login)
+  end
+
+  attr_accessor :profile, :person
+
+  test "should get index" do
+    get :index, :profile => profile.identifier
+    assert_response :success
+    assert_not_nil assigns(:email_templates)
+  end
+
+  test "should get new" do
+    get :new, :profile => profile.identifier
+    assert_response :success
+  end
+
+  test "should create email_template" do
+    assert_difference('EmailTemplate.count') do
+      post :create, email_template: { :name => 'test' }, :profile => profile.identifier
+    end
+
+    assert_redirected_to url_for(:action => :index)
+  end
+
+  test "should show email_template" do
+    get :show, id: @email_template, :profile => profile.identifier
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, id: @email_template, :profile => profile.identifier
+    assert_response :success
+  end
+
+  test "should update email_template" do
+    put :update, id: @email_template, email_template: {  }, :profile => profile.identifier
+    assert_redirected_to url_for(:action => :index)
+  end
+
+  test "should destroy email_template" do
+    assert_difference('EmailTemplate.count', -1) do
+      delete :destroy, id: @email_template, :profile => profile.identifier
+    end
+
+    assert_redirected_to url_for(:action => :index)
+  end
+
+  test "should get parsed template" do
+    environment = Environment.default
+    @email_template.subject = '{{profile.name}} - {{profile.identifier}}'
+    @email_template.body = '{{profile.name}} - {{profile.identifier}} - {{environment.name}}'
+    @email_template.save!
+    get :show_parsed, id: @email_template, :profile => profile.identifier
+    assert_response :success
+    json_response = ActiveSupport::JSON.decode(@response.body)
+    assert_equal "#{profile.name} - #{profile.identifier}", json_response['parsed_subject']
+    assert_equal "#{profile.name} - #{profile.identifier} - #{environment.name}", json_response['parsed_body']
+  end
+
+end
@@ -626,6 +626,17 @@ class ProfileEditorControllerTest &lt; ActionController::TestCase
     assert_tag :tag => 'a', :attributes => { :href => '/myprofile/default_user/cms' }
   end
+  should 'display email template link for organizations in control panel' do
+    profile = fast_create(Organization)
+    get :index, :profile => profile.identifier
+    assert_tag :tag => 'a', :attributes => { :href => "/myprofile/#{profile.identifier}/email_templates" }
+  end
+
+  should 'not display email template link in control panel for person' do
+    get :index, :profile => profile.identifier
+    assert_no_tag :tag => 'a', :attributes => { :href => "/myprofile/#{profile.identifier}/email_templates" }
+  end
+
   should 'offer to create blog in control panel' do
     get :index, :profile => profile.identifier
     assert_tag :tag => 'a', :attributes => { :href => "/myprofile/default_user/cms/new?type=Blog" }
@@ -3,10 +3,10 @@ require_relative &quot;../test_helper&quot;
 class EmailTemplateTest < ActiveSupport::TestCase
   should 'filter templates by type' do
-    EmailTemplate.create!(:template_type => :type1, :subject => 'template1')
-    EmailTemplate.create!(:template_type => :type2, :subject => 'template2')
-    EmailTemplate.create!(:template_type => :type2, :subject => 'template3')
-    assert_equal ['template2', 'template3'], EmailTemplate.find_all_by_template_type(:type2).map(&:subject)
+    EmailTemplate.create!(:template_type => :type1, :name => 'template1')
+    EmailTemplate.create!(:template_type => :type2, :name => 'template2')
+    EmailTemplate.create!(:template_type => :type2, :name => 'template3')
+    assert_equal ['template2', 'template3'], EmailTemplate.find_all_by_template_type(:type2).map(&:name)
   end
   should 'parse body using params' do
@@ -0,0 +1,63 @@		@@ -0,0 +1,63 @@
	1	+class EmailTemplatesController < MyProfileController
	2	+
	3	+ protect 'send_mail_to_members', :profile
	4	+
	5	+ def index
	6	+ @email_templates = profile.email_templates
	7	+ end
	8	+
	9	+ def show
	10	+ @email_template = profile.email_templates.find(params[:id])
	11	+
	12	+ respond_to do \|format\|
	13	+ format.html # show.html.erb
	14	+ format.json { render json: @email_template }
	15	+ end
	16	+ end
	17	+
	18	+ def show_parsed
	19	+ @email_template = profile.email_templates.find(params[:id])
	20	+ template_params = {:profile => profile, :environment => environment}
	21	+ render json: {:parsed_body => @email_template.parsed_body(template_params), :parsed_subject => @email_template.parsed_subject(template_params)}
	22	+ end
	23	+
	24	+ def new
	25	+ @email_template = profile.email_templates.build
	26	+ end
	27	+
	28	+ def edit
	29	+ @email_template = profile.email_templates.find(params[:id])
	30	+ end
	31	+
	32	+ def create
	33	+ @email_template = profile.email_templates.build(params[:email_template], :owner => profile)
	34	+
	35	+ if @email_template.save
	36	+ session[:notice] = _('Email template was successfully created.')
	37	+ redirect_to url_for(:action => :index)
	38	+ else
	39	+ render action: "new"
	40	+ end
	41	+ end
	42	+
	43	+ def update
	44	+ @email_template = profile.email_templates.find(params[:id])
	45	+
	46	+ if @email_template.update_attributes(params[:email_template])
	47	+ session[:notice] = _('Email template was successfully updated.')
	48	+ redirect_to url_for(:action => :index)
	49	+ else
	50	+ render action: "edit"
	51	+ end
	52	+ end
	53	+
	54	+ def destroy
	55	+ @email_template = profile.email_templates.find(params[:id])
	56	+ @email_template.destroy
	57	+
	58	+ respond_to do \|format\|
	59	+ format.html { redirect_to url_for(:action => :index)}
	60	+ format.json { head :no_content }
	61	+ end
	62	+ end
	63	+end
	@@ -353,6 +353,7 @@ class ProfileController < PublicController		@@ -353,6 +353,7 @@ class ProfileController < PublicController
353		353
354	def send_mail	354	def send_mail
355	@mailing = profile.mailings.build(params[:mailing])	355	@mailing = profile.mailings.build(params[:mailing])
		356	+ @email_templates = profile.email_templates
356	if request.post?	357	if request.post?
357	@mailing.locale = locale	358	@mailing.locale = locale
358	@mailing.person = user	359	@mailing.person = user
	@@ -4,6 +4,8 @@ class EmailTemplate < ActiveRecord::Base		@@ -4,6 +4,8 @@ class EmailTemplate < ActiveRecord::Base
4		4
5	attr_accessible :template_type, :subject, :body, :owner, :name	5	attr_accessible :template_type, :subject, :body, :owner, :name
6		6
		7	+ validates_presence_of :name
		8	+
7	def parsed_body(params)	9	def parsed_body(params)
8	@parsed_body \|\|= parse(body, params)	10	@parsed_body \|\|= parse(body, params)
9	end	11	end
@@ -0,0 +1,30 @@		@@ -0,0 +1,30 @@
	1	+<%= form_for(@email_template, :url => {:controller => :email_templates, :action => @email_template.persisted? ? :update : :create, :id => @email_template.id}) do \|f\| %>
	2	+
	3	+ <%= error_messages_for :email_template if @email_template.errors.any? %>
	4	+
	5	+ <div class="template-fields">
	6	+ <div class="header-fields">
	7	+ <%= labelled_form_field(_('Template Name:'), f.text_field(:name)) %>
	8	+ <%= labelled_form_field(_('Subject:'), f.text_field(:subject)) %>
	9	+ </div>
	10	+ <div class="available-params">
	11	+ <div class="reference">
	12	+ <a target="_blank" href="https://github.com/Shopify/liquid/wiki/Liquid-for-Designers"><%= _('Template language reference') %></a>
	13	+ </div>
	14	+ <div class="label">
	15	+ <%= _('The following parameters may be used in subject and body:') %>
	16	+ </div>
	17	+ <div class="values">
	18	+ {{profile.name}}, {{profile.identifier}}, {{environment.name}}
	19	+ </div>
	20	+ </div>
	21	+ <%= render :file => 'shared/tiny_mce' %>
	22	+ <%= labelled_form_field(_('Body:'), f.text_area(:body, :class => 'mceEditor')) %>
	23	+ </div>
	24	+
	25	+ <div class="actions">
	26	+ <%= submit_button(:save, _('Save')) %>
	27	+ <%= button(:back, _('Back'), :controller => :email_templates) %>
	28	+ </div>
	29	+
	30	+<% end %>
@@ -0,0 +1,3 @@		@@ -0,0 +1,3 @@
	1	+<h1>Editing Email Template</h1>
	2	+
	3	+<%= render 'form' %>
@@ -0,0 +1,23 @@		@@ -0,0 +1,23 @@
	1	+<h1><%= _('Email Templates') %></h1>
	2	+
	3	+<table>
	4	+ <tr>
	5	+ <th><%= _('Name') %></th>
	6	+ <th></th>
	7	+ </tr>
	8	+
	9	+<% @email_templates.each do \|email_template\| %>
	10	+ <tr>
	11	+ <td><%= email_template.name %></td>
	12	+ <td>
	13	+ <%= link_to 'Edit', url_for(:controller => :email_templates, :action => :edit, :id => email_template.id) %>
	14	+ <%= link_to 'Destroy', url_for(:controller => :email_templates, :action => :destroy, :id => email_template.id), method: :delete, data: { confirm: 'Are you sure?' } %>
	15	+ </td>
	16	+ </tr>
	17	+<% end %>
	18	+</table>
	19	+
	20	+<br />
	21	+
	22	+<%= button(:new, _('New template'), :controller => :email_templates, :action => :new) %>
	23	+<%= button(:back, _('Back to control panel'), :controller => :profile_editor) %>
@@ -0,0 +1,3 @@		@@ -0,0 +1,3 @@
	1	+<h1>New Email Template</h1>
	2	+
	3	+<%= render 'form' %>
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+<p id="notice"><%= notice %></p>
	2	+
	3	+
	4	+<%= link_to 'Edit', url_for(:controller => :email_templates, :action => :edit, :id => @email_template.id) %> \|
	5	+<%= link_to 'Back', url_for(:controller => :email_templates) %>
	@@ -4,6 +4,12 @@		@@ -4,6 +4,12 @@
4		4
5	<%= error_messages_for :mailing %>	5	<%= error_messages_for :mailing %>
6		6
		7	+<div class="template-selection">
		8	+ <% if @email_templates.present? %>
		9	+ <%= labelled_form_field(_('Select a template:'), select_tag(:template, options_from_collection_for_select(@email_templates, :id, :name), :include_blank => true, 'data-url' => url_for(:controller => 'email_templates', :action => 'show_parsed'))) %>
		10	+ <% end %>
		11	+</div>
		12	+
7	<%= form_for :mailing, :url => {:action => 'send_mail'}, :html => {:id => 'mailing-form'} do \|f\| %>	13	<%= form_for :mailing, :url => {:action => 'send_mail'}, :html => {:id => 'mailing-form'} do \|f\| %>
8		14
9	<%= labelled_form_field(_('Subject:'), f.text_field(:subject)) %>	15	<%= labelled_form_field(_('Subject:'), f.text_field(:subject)) %>
	@@ -72,6 +72,8 @@		@@ -72,6 +72,8 @@
72		72
73	<%= control_panel_button(_('Edit welcome page'), 'welcome-page', :action => 'welcome_page') if has_welcome_page %>	73	<%= control_panel_button(_('Edit welcome page'), 'welcome-page', :action => 'welcome_page') if has_welcome_page %>
74		74
		75	+ <%= control_panel_button(_('Email Templates'), 'email-templates', :controller => :email_templates) if profile.organization? %>
		76	+
75	<% @plugins.dispatch(:control_panel_buttons).each do \|button\| %>	77	<% @plugins.dispatch(:control_panel_buttons).each do \|button\| %>
76	<%= control_panel_button(button[:title], button[:icon], button[:url], button[:html_options]) %>	78	<%= control_panel_button(button[:title], button[:icon], button[:url], button[:html_options]) %>
77	<% end %>	79	<% end %>