Add new settings keys/logic for ticket behavior

scott · scott · commit ab059e0e3ff4 · 2019-01-23T09:07:21.000-07:00
- global bcc on all customer emails
- default channel from admin ticket form
- include ticket history in customer emails
- include ticket body (or just link) in customer emails
- default helpcenter form to private or public forum posts
diff --git a/app/assets/javascripts/app.js b/app/assets/javascripts/app.js
@@ -459,6 +459,9 @@ Helpy.didthisHelp = function(yesno){
 Helpy.showGroup = function() {
   if ($('#topic_private_true').is(':checked')) {
     $('#topic_team_list').parent().removeClass('hidden');
+    $("#topic_forum_id").parent().hide();
+    $('#new_topic').append("<input type='hidden' id='new_topic_forum_id' name='topic[forum_id]' value='1'/>");
+    $('#topic_team_list').removeClass('hidden');
   } else if ($('#topic_private_false').is(':checked')) {
     $('#topic_team_list').parent().addClass('hidden');
   } else {
diff --git a/app/controllers/admin/topics_controller.rb b/app/controllers/admin/topics_controller.rb
@@ -66,7 +66,7 @@ def show
   def new
     fetch_counts
 
-    @topic = Topic.new
+    @topic = Topic.new(channel: AppSettings['settings.default_channel'])
     @user = params[:user_id].present? ? User.find(params[:user_id]) : User.new
   end
 
diff --git a/app/controllers/topics_controller.rb b/app/controllers/topics_controller.rb
@@ -166,7 +166,7 @@ def associate_with_doc
   private
 
   def initialize_new_ticket_form_vars
-    @topic = Topic.new #unless @topic
+    @topic = Topic.new(private: AppSettings['settings.default_private']) #unless @topic
     @user = @topic.build_user unless user_signed_in?
     @topic.posts.build #unless @topic.posts
     get_all_teams
diff --git a/app/helpers/email_helper.rb b/app/helpers/email_helper.rb
@@ -15,4 +15,19 @@ def body_tokens(text, topic)
     text = text.gsub('%customer_email_address', topic.user.email)
     return text
   end
+
+  # include the ticket history in email
+  def include_history?
+    AppSettings['settings.include_ticket_history'] == "1"
+  end
+
+  # include the ticket body or just a link?
+  def include_body?
+    AppSettings['settings.include_ticket_body'] == "1"
+  end
+
+  def link_to_topic
+    t('response_added', default: 'A response has been added to your ticket. Click here to see it: %{ticket_link}', 
+      ticket_link: ticket_url(@topic, host: AppSettings['settings.site_url']))
+  end
 end
diff --git a/app/mailers/post_mailer.rb b/app/mailers/post_mailer.rb
@@ -31,7 +31,7 @@ def new_post(post_id)
     mail(
       to: email_with_name,
       cc: @post.cc,
-      bcc: @post.bcc,
+      bcc: @post.bccs,
       from: @topic.from_email_address,
       subject: "[#{AppSettings['settings.site_name']}] ##{@topic.id}-#{@topic.name}"
       )
diff --git a/app/models/post.rb b/app/models/post.rb
@@ -151,6 +151,17 @@ def text_formatted_body
     "#{ActionView::Base.full_sanitizer.sanitize(ApplicationController.helpers.body_tokens(body, topic))}".html_safe
   end
 
+  def bccs
+    bccs = []
+    unless bcc.nil?
+      bccs += bcc&.split(',').collect{|b| b.strip}
+    end
+    unless AppSettings['settings.global_bcc'].nil? || AppSettings['settings.global_bcc'].blank?
+      bccs += AppSettings['settings.global_bcc']&.split(',').collect{|b| b.strip}
+    end
+    return bccs
+  end
+
   private
 
     def truncate_body
diff --git a/app/views/post_mailer/new_post.html.erb b/app/views/post_mailer/new_post.html.erb
@@ -13,16 +13,16 @@
   <%= @header.html_safe %>
   <p style="color: #666;">
     <small>
-    <%= t('above_this_line', default: "Make sure your reply appears above this line") %><br/>
+    <%= t('above_this_line', default: "Make sure your reply appears above this line") if include_body? %><br/>
     </small>
   </p>
 
   <p>
-    <%= @post.html_formatted_body %>
+    <%= include_body? ? @post.html_formatted_body : link_to_topic %>
     <%= simple_format(@post.user.signature) if @post.user.signature.present? %>
   </p>
   <%= render :partial => 'posts/thumbnail', locals: { :model_name => @post } %>
-  <%= render partial: 'mailer_shared/post', collection: @posts %>
+  <%= render partial: 'mailer_shared/post', collection: @posts if include_history? %>
   <br/>
   <%= footer_tokens(@footer).html_safe %>
   </body>
diff --git a/app/views/post_mailer/new_post.text.erb b/app/views/post_mailer/new_post.text.erb
@@ -1,12 +1,14 @@
 <%= strip_tags(@header) %>
 
+<% if include_body? %>
 <%= t('above_this_line', default: "Make sure your reply appears above this line") %>
 =================================================================
 <%= t('message_id', default: 'Message ID') %>:<%= @topic.id %>
+<% end %>
 
 <%= t('message_response', default: 'The following message has been posted in response to your question:') %>
 
-<%= @post.text_formatted_body %>
+<%= @post.text_formatted_body if include_body? %>
 <%= strip_tags(@post.user.signature) if @post.user.signature.present? %>
 
 <%= t('view_online', default: 'View this online:') %> <%= ticket_url(@topic, host: AppSettings['settings.site_url']) %>
diff --git a/app/views/topics/new.html.erb b/app/views/topics/new.html.erb
@@ -21,8 +21,8 @@
         <% end %>
       <% end %>
 
-      <% if (user_signed_in? && !@widget) || (!user_signed_in? && recaptcha_enabled? && !@widget) %>
-        <% if forums? and tickets? %>
+      <% if (user_signed_in?) || (!user_signed_in? && recaptcha_enabled?) %>
+        <% if forums? && tickets? %>
           <label class="control-label" for="doc_active"> <%= t(:should_message_be_private) %> </label>
           <%= f.collection_radio_buttons :private, [[true, t(:only_support_can_respond)] ,[false, t(:responses_can_come_from_everyone)]], :first, :last, item_wrapper_class: 'radio', item_label_class: 'radio-label', collection_wrapper_tag: :div %>
           <%= f.input(:forum_id, collection: @forums, :label => t(:forum_name), locale: I18n.locale, prompt: nil) %>
diff --git a/config/initializers/default_settings.rb b/config/initializers/default_settings.rb
@@ -23,6 +23,11 @@
 AppSettings.defaults["settings.knowledgebase"] = Settings.knowledgebase
 AppSettings.defaults["settings.teams"] = Settings.teams
 AppSettings.defaults["settings.welcome_email"] = Settings.welcome_email
+AppSettings.defaults['settings.global_bcc'] = []
+AppSettings.defaults['settings.default_channel'] = 'email'
+AppSettings.defaults['settings.include_ticket_history'] = '1'
+AppSettings.defaults['settings.include_ticket_body'] = '1'
+AppSettings.defaults['settings.default_private'] = '0'
 
 # Webhook Integrations
 
diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -345,6 +345,8 @@ en:
   above_this_line: "Make sure your reply appears above this line"
   message_id: "Message ID"
   message_response: "The following message has been posted in response to your question:"
+  ticket_added: "You have received a new ticket. Click here to see it: %{ticket_link}"
+  response_added: "A response has been added to your ticket. Click here to see it: %{ticket_link}"
   view_online: "View this online:"
 
   # Admin notifications
diff --git a/test/controllers/admin/topics_controller_test.rb b/test/controllers/admin/topics_controller_test.rb
@@ -222,6 +222,14 @@ class Admin::TopicsControllerTest < ActionController::TestCase
       assert_response :success
     end
 
+    test "an #{admin} should be able to open a new discussion with a set channel" do
+      AppSettings['settings.default_channel'] = 'phone'
+      sign_in users(admin.to_sym)
+      xhr :get, :new
+      assert_equal 'phone', assigns(:topic).channel
+      assert_response :success
+    end
+
     test "an #{admin} should be able to create a new private discussion for a new user with an email" do
       sign_in users(admin.to_sym)
       assert_difference "Topic.count", 1 do
diff --git a/test/controllers/topics_controller_test.rb b/test/controllers/topics_controller_test.rb
@@ -60,6 +60,13 @@ class TopicsControllerTest < ActionController::TestCase
     assert_response :success, 'Did not get the new topic page'
   end
 
+  test 'the new topic should be set to private if enabled' do
+    AppSettings['settings.default_private'] = '1'
+    get :new, locale: :en
+    assert_equal true, assigns(:topic).private
+    assert_response :success, 'Did not get the new topic page'
+  end
+
   test 'a browsing user should be able to create a new public topic without signing in' do
     get :new, locale: :en
     assert_response :success
diff --git a/test/mailers/post_mailer_test.rb b/test/mailers/post_mailer_test.rb
@@ -52,7 +52,6 @@ class PostMailerTest < ActionMailer::TestCase
     end
   end
 
-
   test 'Post with CC or BCC should actually send to mailer' do
     topic = Topic.first
     post = topic.posts.create(body: "a response", cc: "cc@test.com", bcc: "bcc@test.com", kind: 'reply', user_id: '1')
@@ -93,4 +92,35 @@ class PostMailerTest < ActionMailer::TestCase
       email.deliver_now
     end
   end
+
+  test 'Should not include history if disabled' do
+    AppSettings['settings.include_ticket_history'] = '0'
+
+    topic = Topic.first
+    post = topic.posts.create(body: "first question", cc: "cc@test.com", bcc: "bcc@test.com", kind: 'reply', user_id: '1')
+    post = topic.posts.create(body: "this is the body", cc: "cc@test.com", bcc: "bcc@test.com", kind: 'reply', user_id: '1')
+    email = PostMailer.new_post(post.id)
+
+    assert_emails 1 do
+      email.deliver_now
+      assert_equal true, email.html_part.body.to_s.include?("this is the body")
+      assert_equal false, email.html_part.body.to_s.include?("first question")
+    end
+  end
+
+  test 'Should not include body if disabled' do
+    AppSettings['settings.include_ticket_body'] = '0'
+
+    topic = Topic.first
+    post = topic.posts.create(body: "first question", cc: "cc@test.com", bcc: "bcc@test.com", kind: 'reply', user_id: '1')
+    post = topic.posts.create(body: "this is the body", cc: "cc@test.com", bcc: "bcc@test.com", kind: 'reply', user_id: '1')
+    email = PostMailer.new_post(post.id)
+
+    assert_emails 1 do
+      email.deliver_now
+      assert_equal false, email.html_part.body.to_s.include?("this is the body")
+    end
+  end
+
+
 end
diff --git a/test/models/post_test.rb b/test/models/post_test.rb
@@ -180,6 +180,33 @@ def setup
     end
   end
 
+  test "#bccs should include one of each global and bcc" do
+    AppSettings['settings.global_bcc'] = 'bcc@test.com'
+    create_ticket_thread('userone@test.com')
+    assert_equal ['userone@test.com', 'bcc@test.com'], @post.bccs
+    AppSettings['settings.global_bcc'] = nil
+  end
+
+  test "#bccs should include both global and post bccs" do
+    AppSettings['settings.global_bcc'] = 'bcc@test.com, bcc2@test.com'
+    @topic = create :topic, forum_id: 1, user_id: 2, name: "A test topic", private: true
+    create_ticket_thread('userone@test.com, usertwo@test.com')
+    assert_equal ['userone@test.com', 'usertwo@test.com', 'bcc@test.com', 'bcc2@test.com'], @post.bccs
+    AppSettings['settings.global_bcc'] = nil
+  end
+
+  test "#bccs should only include post bccs" do
+    create_ticket_thread('userone@test.com, usertwo@test.com')
+    assert_equal ['userone@test.com', 'usertwo@test.com'], @post.bccs
+  end
+
+  test "#bccs should only include global bcc" do
+    AppSettings['settings.global_bcc'] = 'bcc@test.com, bcc2@test.com'
+    create_ticket_thread
+    assert_equal ['bcc@test.com', 'bcc2@test.com'], @post.bccs
+    AppSettings['settings.global_bcc'] = nil
+  end
+
   # test "Should truncate body length if greater than 10,000" do
   #   body   = "0" * 10001
   #   @user  = User.first
@@ -189,4 +216,18 @@ def setup
   #   assert_equal @post.body.size, 10_000
   # end
 
+  def create_ticket_thread(bcc='')
+    @topic = create :topic, forum_id: 1, user_id: 2, name: "A test topic", private: true
+    @topic.posts.create!(
+      user_id: 2,
+      body: "This is the first message from the customer",
+      kind: "first"
+    )
+    @post = @topic.posts.create!(
+      user_id: 1,
+      body: "This is the first reply from admin",
+      kind: "reply",
+      bcc: bcc
+    )
+  end
 end

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ def new_post(post_id)`
`31`	`31`	`mail(`
`32`	`32`	`to: email_with_name,`
`33`	`33`	`cc: @post.cc,`
`34`		`- bcc: @post.bcc,`
	`34`	`+ bcc: @post.bccs,`
`35`	`35`	`from: @topic.from_email_address,`
`36`	`36`	`subject: "[#{AppSettings['settings.site_name']}] ##{@topic.id}-#{@topic.name}"`
`37`	`37`	`)`