From 20e670ddb403ff5b6f3b50665f7f3e0e84410e44 Mon Sep 17 00:00:00 2001
From: Chris Beer <cabeer@stanford.edu>
Date: Wed, 28 Feb 2018 17:01:43 -0800
Subject: [PATCH] Steal the feedback form from PURL

---
 app/assets/javascripts/feedback_form.js       | 136 ++++++++++++++++++
 app/assets/stylesheets/feedback-form.scss     |  16 +++
 app/controllers/feedback_forms_controller.rb  |  32 +++++
 app/helpers/application_helper.rb             |   4 +
 app/mailers/feedback_mailer.rb                |  26 ++++
 app/views/feedback_forms/new.html.erb         |   1 +
 .../feedback_mailer/submit_feedback.text.erb  |  10 ++
 app/views/layouts/application.html.erb        |   8 ++
 .../shared/feedback_forms/_form.html.erb      |  41 ++++++
 .../feedback_forms/_reporting_from.html.erb   |   2 +
 config/routes.rb                              |  45 +-----
 config/settings.yml                           |   1 +
 12 files changed, 279 insertions(+), 43 deletions(-)
 create mode 100644 app/assets/javascripts/feedback_form.js
 create mode 100644 app/assets/stylesheets/feedback-form.scss
 create mode 100644 app/controllers/feedback_forms_controller.rb
 create mode 100644 app/mailers/feedback_mailer.rb
 create mode 100644 app/views/feedback_forms/new.html.erb
 create mode 100644 app/views/feedback_mailer/submit_feedback.text.erb
 create mode 100644 app/views/shared/feedback_forms/_form.html.erb
 create mode 100644 app/views/shared/feedback_forms/_reporting_from.html.erb

diff --git a/app/assets/javascripts/feedback_form.js b/app/assets/javascripts/feedback_form.js
new file mode 100644
index 0000000..030e5bf
--- /dev/null
+++ b/app/assets/javascripts/feedback_form.js
@@ -0,0 +1,136 @@
+$(document).on("turbolinks:load", function(){
+
+  //Instantiates plugin for feedback form
+
+  $("#feedback-form").feedbackForm();
+})
+
+
+;(function ( $, window, document, undefined ) {
+  /*
+    jQuery plugin that handles some of the feedback form functionality
+
+      Usage: $(selector).feedbackForm();
+
+    No available options
+
+    This plugin :
+      - changes feedback form link to button
+      - submits an ajax request for the feedback form
+      - displays alert on response from feedback form
+  */
+
+    var pluginName = "feedbackForm";
+
+    function Plugin( element, options ) {
+        this.element = element;
+        var $el, $form;
+
+        this.options = $.extend( {}, options) ;
+        this._name = pluginName;
+        this.init();
+    }
+
+    function submitListener(){
+      // Serialize and submit form if not on action url
+      $form.each(function(i, form){
+        if (location !== form.action){
+          $('#user_agent').val(navigator.userAgent);
+          $('#viewport').val('width:' + window.innerWidth + ' height:' + innerHeight);
+          $(form).on('submit', function(){
+            var valuesToSubmit = $(this).serialize();
+            $.ajax({
+              url: form.action,
+              data: valuesToSubmit,
+              type: 'post'
+            }).success(function(response){
+              if (isSuccess(response)){
+                $($el).collapse('hide');
+                $($form)[0].reset();
+              }
+              renderFlashMessages(response);
+            });
+            return false;
+          });
+
+        }
+      });
+    }
+
+    function isSuccess(response){
+      switch(response[0][0]){
+      case 'success':
+        return true;
+      default:
+        return false;
+      }
+    }
+
+    function renderFlashMessages(response){
+      $.each(response, function(i,val){
+        var flashHtml = "<div class='alert alert-" + val[0] + "'><button type='button' class='close' data-dismiss='alert' aria-hidden='true'>&times;</button>" + val[1] + "</div>";
+
+        // Show the flash message
+        $('div.flash_messages').html(flashHtml);
+      });
+    }
+
+    function replaceLink(form, link) {
+      var attrs = {};
+      $.each(link[0].attributes, function(idx, attr) {
+          attrs[attr.nodeName] = attr.value;
+      });
+      attrs.class = 'cancel-link btn btn-link';
+
+      // Replace the cancel link with a button
+      link.replaceWith(function() {
+        return $('<button />', attrs).append($(this).contents());
+      });
+
+      // Cancel link should not submit form
+      form.find('button.cancel-link').on('click', function(e){
+        e.preventDefault();
+      });
+    }
+
+    Plugin.prototype = {
+
+        init: function() {
+          $el = $(this.element);
+          $form = $($el).find('form');
+          $cancelLink = $($el).find(".cancel-link");
+
+          // Replace "Cancel" link with link styled button
+          replaceLink($el, $cancelLink);
+
+          //Add listener for form submit
+          submitListener($el,$form);
+
+          // Preventing link from triggering navigation
+          $('*[data-target="#' + this.element.id +'"]').on('click', function(e){
+            e.preventDefault();
+          });
+
+          //Updates reporting from fields for current location
+          $('span.reporting-from-field').html(location.href);
+          $('input.reporting-from-field').val(location.href);
+
+          // Listen for form open and then add focus to message
+          $('#feedback-form').on('shown.bs.collapse', function () {
+            $("textarea#message").focus();
+          });
+        }
+    };
+
+    // A really lightweight plugin wrapper around the constructor,
+    // preventing against multiple instantiations
+    $.fn[pluginName] = function ( options ) {
+        return this.each(function () {
+            if (!$.data(this, "plugin_" + pluginName)) {
+                $.data(this, "plugin_" + pluginName,
+                new Plugin( this, options ));
+            }
+        });
+    };
+
+})( jQuery, window, document );
diff --git a/app/assets/stylesheets/feedback-form.scss b/app/assets/stylesheets/feedback-form.scss
new file mode 100644
index 0000000..8f359ff
--- /dev/null
+++ b/app/assets/stylesheets/feedback-form.scss
@@ -0,0 +1,16 @@
+.cancel-link .btn .btn-link {
+  margin-left:12px;
+  border-bottom: none;
+}
+
+#feedback-form{
+  border-bottom: 3px solid $sul-toolbar-border;
+}
+
+.feedback-alert {
+  color: rgb(204, 0, 0);
+  font-size: 1.2em;
+  padding: 10px;
+  border: 1px solid rgb(204, 0, 0);
+  margin: 10px 0pt;
+}
diff --git a/app/controllers/feedback_forms_controller.rb b/app/controllers/feedback_forms_controller.rb
new file mode 100644
index 0000000..d1292a9
--- /dev/null
+++ b/app/controllers/feedback_forms_controller.rb
@@ -0,0 +1,32 @@
+class FeedbackFormsController < ApplicationController
+  def new; end
+
+  def create
+    if validate
+      FeedbackMailer.submit_feedback(params, request.remote_ip).deliver_now
+      flash[:success] = 'Thank you! Your feedback has been sent.'
+    end
+
+    respond_to do |format|
+      format.json do
+        render json: flash
+      end
+      format.html do
+        redirect_to params[:url]
+      end
+    end
+  end
+
+  protected
+
+  def validate
+    errors = []
+    errors << 'A message is required' if params[:message].blank?
+
+    if params[:email_address].present?
+      errors << 'You have filled in a field that makes you appear as a spammer.  Please follow the directions for the individual form fields.'
+    end
+    flash[:error] = errors.join('<br/>') unless errors.empty?
+    flash[:error].nil?
+  end
+end
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
index 5fa507b..b4bd90c 100644
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@@ -19,4 +19,8 @@ def current_term
   def future_terms(*args)
     Terms.future_terms(*args)
   end
+
+  def show_feedback_form?
+    Settings.email.feedback.present?
+  end
 end
diff --git a/app/mailers/feedback_mailer.rb b/app/mailers/feedback_mailer.rb
new file mode 100644
index 0000000..5e2e6a7
--- /dev/null
+++ b/app/mailers/feedback_mailer.rb
@@ -0,0 +1,26 @@
+class FeedbackMailer < ActionMailer::Base
+  def submit_feedback(params, ip)
+    @name = if params[:name].present?
+              params[:name]
+            else
+              'No name given'
+            end
+
+    @email = if params[:to].present?
+               params[:to]
+             else
+               'No email given'
+             end
+
+    @message = params[:message]
+    @url = params[:url]
+    @ip = ip
+    @user_agent = params[:user_agent]
+    @viewport = params[:viewport]
+
+    mail(to: Settings.feedback.email_to,
+         subject: 'Feedback from PURL',
+         from: 'feedback@purl.stanford.edu',
+         reply_to: Settings.feedback.email_to)
+  end
+end
diff --git a/app/views/feedback_forms/new.html.erb b/app/views/feedback_forms/new.html.erb
new file mode 100644
index 0000000..4ac636c
--- /dev/null
+++ b/app/views/feedback_forms/new.html.erb
@@ -0,0 +1 @@
+<%= render 'shared/feedback_forms/form' %>
diff --git a/app/views/feedback_mailer/submit_feedback.text.erb b/app/views/feedback_mailer/submit_feedback.text.erb
new file mode 100644
index 0000000..d041c44
--- /dev/null
+++ b/app/views/feedback_mailer/submit_feedback.text.erb
@@ -0,0 +1,10 @@
+Name: <%= @name %>
+Email: <%= @email %>
+Comment:
+<%= @message.html_safe unless @message.nil? %>
+
+Message sent from: <%= @url %>
+Host: <%= Settings.HOSTNAME %>
+IP: <%= @ip %>
+User agent: <%= @user_agent %>
+Viewport: <%= @viewport %>
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
index 28a65cd..4494296 100644
--- a/app/views/layouts/application.html.erb
+++ b/app/views/layouts/application.html.erb
@@ -14,9 +14,17 @@
       <header id="header">
         <%= link_to(image_tag("sul.png"), "http://library.stanford.edu", :class=>"img-link") %>
         <span id="links">
+          <%= link_to feedback_path, class: 'first', data: {toggle:"collapse", target:"#feedback-form"} do %>
+            Feedback
+          <% end if show_feedback_form? %>
           <%= current_user %> <span>(close browser to logout)</span>
         </span>
       </header>
+      <% if show_feedback_form? %>
+        <div id="feedback-form" class="feedback-form-container collapse">
+          <%= render "shared/feedback_forms/form" %>
+        </div>
+      <% end %>
       <%= yield %>
     </div>
   </div>
diff --git a/app/views/shared/feedback_forms/_form.html.erb b/app/views/shared/feedback_forms/_form.html.erb
new file mode 100644
index 0000000..739f3b2
--- /dev/null
+++ b/app/views/shared/feedback_forms/_form.html.erb
@@ -0,0 +1,41 @@
+<div class="container">
+  <%= form_tag feedback_form_path, method: :post, class:"form-horizontal feedback-form", role:"form" do %>
+    <div class="col-sm-6 col-sm-offset-2">
+      <div class="col-sm-offset-3">
+        <%= render "shared/feedback_forms/reporting_from" %>
+      </div>
+    </div>
+    <span style="display:none;visibility:hidden;">
+      <%= label_tag(:email_address, 'Ignore this text box. It is used to detect spammers. If you enter anything into this text box, your message will not be sent.') %><br/>
+      <%= email_field_tag :email_address %><br/>
+      <%= text_field_tag :user_agent %>
+      <%= text_field_tag :viewport %>
+    </span>
+    <div class="col-sm-6 col-sm-offset-2">
+      <div class="form-group">
+        <%= label_tag(:message, 'Message', class:"col-sm-3 control-label") %>
+        <div class="col-sm-9">
+          <%= text_area_tag :message, "", rows:"5", class:"form-control" %>
+        </div>
+      </div>
+      <div class="form-group">
+        <%= label_tag(:name, 'Your name', class:"col-sm-3 control-label") %>
+        <div class="col-sm-9">
+          <%= text_field_tag :name, "", class:"form-control" %>
+        </div>
+      </div>
+      <div class="form-group">
+        <%= label_tag(:to, 'Your email', class:"col-sm-3 control-label") %>
+        <div class="col-sm-9">
+          <%= email_field_tag :to, "", class:"form-control" %>
+        </div>
+      </div>
+      <div class="form-group">
+        <div class="col-sm-offset-3 col-sm-9">
+          <button type="submit" class="btn btn-primary">Send</button>
+          <%= link_to "Cancel", :back, class:"cancel-link", data: {toggle:"collapse", target:"#feedback-form"} %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+</div>
diff --git a/app/views/shared/feedback_forms/_reporting_from.html.erb b/app/views/shared/feedback_forms/_reporting_from.html.erb
new file mode 100644
index 0000000..dc9c2e0
--- /dev/null
+++ b/app/views/shared/feedback_forms/_reporting_from.html.erb
@@ -0,0 +1,2 @@
+Reporting from: <span class="reporting-from-field"><%= request.referer %></span>
+<%= hidden_field_tag :url, request.referer, class:"reporting-from-field" %>
diff --git a/config/routes.rb b/config/routes.rb
index 07281d2..5c25f8c 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -21,47 +21,6 @@
   
   resources :reserves
   
-  
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => 'welcome#index'
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  # match ':controller(/:action(/:id))(.:format)'
+  resource :feedback_form, path: 'feedback', only: [:new, :create]
+  get 'feedback' => 'feedback_forms#new'
 end
diff --git a/config/settings.yml b/config/settings.yml
index 747dc2a..913de93 100644
--- a/config/settings.yml
+++ b/config/settings.yml
@@ -5,6 +5,7 @@ email:
   from: "no-reply@reserves.stanford.edu"
   reports: "searchworks-reports@lists.stanford.edu"
   allforms: "course-reserves-allforms@lists.stanford.edu"
+  feedback:
 
 email_mapping:
   "ART-RESV": "artlibrary@stanford.edu"