tkh_mailing_list 0.10.8 → 0.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e7f2d1bcf1082d3e6cbb42d3d1e43beab37915
-  data.tar.gz: bc8e8b09e5c8a6db8476740a7fc31d62cc4de28d
+  metadata.gz: 1eecb38e812f46f5e40069794c1be970d36be891
+  data.tar.gz: bce8b79dd8ce25258d181204835affb5117bfee7
 SHA512:
-  metadata.gz: 197b80d185e0ef02fa998073c8c58cf88b7d16b84a6ee103e13c2ffe20169107edb3e9f4f11dfeb11dce7b8d1aa8ab480c824959d00a1230c4800ac154628150
-  data.tar.gz: 2252628d85d811eea547a4fc0a3437cc801f268a54e2de6311d27d1558e664bd4254dc72bec6f5ced9b62c1c93e20f3b24e2d7898ab8b3422b4d0ed22507eac9
+  metadata.gz: 96dee981407fd5ca0ed6098cb52b3118432f563ba3144f4ad6b7f5019a2d2353d81ada1ff2beb23ae726a16c8fb3ef2086a7d7bb811288bc0ea5728dd2ceb906
+  data.tar.gz: 4fc3bb44ff2c7b9de54c4c736f4f9adb6caf6e88d6627f490a15ffd8ba9b4022f3f748ccc57530a67000d8606188bae49e7c57d4a4b89ffa023aec2abf14fac9

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 
 
+## 0.10.9
+
+* Created an admin daily digest email. The rake task can be called from a cron job.
+
+
 ## 0.10.8
 
 * Removed html_safe method from flash messages in profiles update method. Message is rawified in tkh_toolbox gem.

data/app/controllers/contacts_controller.rb

@@ -0,0 +1,73 @@
+class ContactsController < ApplicationController
+
+  before_action :authenticate,            :except => 'create'
+  before_action :authenticate_with_admin, :except => 'create'
+
+  def index
+    @contacts = Contact.by_recent.paginate(:page => params[:page], :per_page => 35)
+    switch_to_admin_layout
+  end
+
+  def show
+    @contact = Contact.find(params[:id])
+    switch_to_admin_layout
+  end
+
+  def create
+    @contact = Contact.new(contact_params)
+    saved = @contact.save
+    # disabling this and replacing it with a daily digest
+    # this is to mitigate the pain associated with contact spams
+    # sent_email = send_message_to_admin(@contact)
+    # if saved && sent_email == 'success'
+    #   redirect_to root_path, notice: t("contacts.create.notice")
+    # elsif saved && sent_email == 'exception'
+    #   flash[:error] = t("contacts.create.warning")
+    #   redirect_to :back
+    # elsif saved && sent_email == 'invalid'
+    #   flash[:error] =  "#{t("contacts.create.warning")} #{t('contacts.create.invalid_email')}"
+    #   redirect_to :back
+    # else
+    #   flash[:error] = t('contacts.create.did_not_reach')
+    #   redirect_to :back
+    # end
+
+    if saved
+      redirect_to root_path, notice: t("contacts.create.notice")
+    else
+      redirect_to :back, alert: t('contacts.create.did_not_reach')
+    end
+  end
+
+  def valid_email?(string)
+    (!string.blank? && string =~ /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i) ? true : false
+  end
+  # helper_method :valid_email?
+
+  private
+
+  #  disabled to be replaced by daily digest to admins
+  # def send_message_to_admin(contact)
+  #   # check email validity
+  #   if valid_email?(contact.sender_email)
+  #     # Actually send the email to the student
+  #     begin
+  #       ContactMailer.message_from_contact_form(contact).deliver
+  #       return 'success'
+  #     rescue Exception => e
+  #       AdminMailer.rescued_exceptions(e, "Some exception occurred while trying to send to site admin a message from contact form").deliver
+  #       @exception = e
+  #       return 'exception'
+  #     end
+  #   else # for invalid or blank emails
+  #     return 'invalid'
+  #   end
+  # end
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def contact_params
+    params.require(:contact).permit(:sender_name, :sender_email, :body)
+  end
+
+
+end

data/app/mailers/administration_mailer.rb

@@ -0,0 +1,16 @@
+class AdministrationMailer < ActionMailer::Base
+
+  default :from => "#{Setting.first.try(:company_name)} <#{Setting.first.try(:contact_email)}>"
+
+  def daily_digest( admin_user, yesterdays_contact_messages )
+    @recipient = admin_user
+    @contact_messages = yesterdays_contact_messages
+    # FIXME - only the email addresses show up. not the names :-(
+    recipient = "#{@recipient.name} <#{@recipient.email}>"
+    reply_to = "#{Setting.first.try(:company_name)} <#{Setting.first.try(:contact_email)}>"
+    mail  to: recipient,
+          reply_to: reply_to,
+          subject: "#{t('admin.mailer.daily_digest.subject')}- #{l Time.zone.now.to_date}"
+  end
+
+end

data/app/mailers/contact_mailer.rb

@@ -0,0 +1,23 @@
+class ContactMailer < ActionMailer::Base
+
+  # This feature has been suspended. It's meant to be replaced by an admin daily digest.
+
+  # default :from => "info@yoga.lu"
+
+  # Subject can be set in your I18n file at config/locales/en.yml
+  # with the following lookup:
+  #
+  #   en.user_mailer.password_reset.subject
+  #
+  def message_from_contact_form(contact)
+    @contact = contact
+    # FIXME - only the email addresses show up. not the names :-(
+    # TODO - what do to if contact_email is not set?
+    recipient = "#{Setting.first.try(:company_name)} <#{Setting.first.try(:contact_email)}>"
+    reply_to = "#{@contact.sender_name} <#{@contact.sender_email}>"
+    mail  to: recipient,
+          from: "#{Setting.first.site_name} <deploy@mailcenter.tenthousandhours.eu>",
+          reply_to: reply_to,
+          subject: "Message from #{@contact.sender_name} via #{Setting.first.try(:site_name)} web site"
+  end
+end

data/app/models/administration.rb

@@ -0,0 +1,28 @@
+class Administration < ActiveRecord::Base
+
+  def self.send_daily_digest
+    digest_is_needed = false
+    @yesterdays_contact_messages = Contact.yesterdays.chronologically
+    digest_is_needed = true if @yesterdays_contact_messages.count > 0
+    if digest_is_needed
+      User.administrators.each do |administrator|
+        send_message_to_admin(administrator)
+      end
+    end
+  end
+
+  private
+
+  def self.send_message_to_admin(recipient)
+    # Actually send the email to the administrator
+    begin
+      AdministrationMailer.daily_digest( recipient, @yesterdays_contact_messages ).deliver_now
+      return 'success'
+    rescue Exception => e
+      AdminMailer.rescued_exceptions(e, "Some exception occurred while trying to send to site admin a message from contact form").deliver
+      @exception = e
+      return 'exception'
+    end
+  end
+
+end

data/app/models/contact.rb

@@ -0,0 +1,12 @@
+class Contact < ActiveRecord::Base
+
+  validates_presence_of :sender_name
+  validates_presence_of :sender_email
+  # validates :sender_email, :presence => true, :format => { :with => /\A([\A@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, :on => :create }
+  validates_presence_of :body
+
+  scope :yesterdays, lambda { where('created_at >= ? AND created_at <= ?', 1.day.ago.beginning_of_day, 1.day.ago.end_of_day ) }
+  scope :chronologically, -> { order('created_at') }
+  scope :by_recent, -> { order('created_at desc') }
+
+end

data/app/views/administration_mailer/daily_digest.text.erb

@@ -0,0 +1,13 @@
+Hi <%= @recipient.friendly_name %>,
+
+This a summary of what happened yesterday on the <%= Setting.first.try(:site_name) %> website.
+
+List of messages from the contact form:
+
+<% @contact_messages.each do |message| %>
+<%= "- from #{message.sender_name} (#{message.sender_email}): #{truncate message.body}" %>
+<% end %>
+
+You can see and manage these messages at: <%= contacts_url %>
+
+You are receiving this email because you are an administrator of the <%= Setting.first.try(:site_name) %> website.

data/app/views/contact_mailer/message_from_contact_form.text.erb

@@ -0,0 +1,12 @@
+<%= t('contacts.mailer.intro') %>
+
+- <%= t('contacts.mailer.sender_name') %> <%= @contact.sender_name %>
+- <%= t('contacts.mailer.sender_email') %> <%= @contact.sender_email %>
+
+<%= t('contacts.mailer.message') %>
+
+-----------------------------------
+
+<%= @contact.body %>
+
+-----------------------------------

data/app/views/contacts/_form.html.erb

@@ -0,0 +1,9 @@
+<%= simple_form_for Contact.new do |f| %>
+	<%= f.error_notification %>
+
+		<%= f.input :sender_name, label: t('activerecord.attributes.contacts.sender_name') %>
+		<%= f.input :sender_email, label: t('activerecord.attributes.contacts.sender_email') %>
+		<%= f.input :body, label: t('activerecord.attributes.contacts.body'), :input_html => { :rows => 10 } %>
+
+    <%= f.button :submit, t('contacts.send_message'), :class => 'btn btn-primary' %>
+<% end %>

data/app/views/contacts/_tab_admin_menu.html.erb

@@ -0,0 +1,4 @@
+<ul class="nav nav-tabs" id="admin-menu-tab">
+	<%= content_tag :li, link_to(t('list'), contacts_path), ({ class: 'active' } if controller.action_name.to_s == 'index' ) %>
+	<%= content_tag :li, link_to(t('view'), contacts_path), ({ class: 'active' }) if controller.action_name.to_s == 'show' %>
+</ul>

data/app/views/contacts/index.html.erb

@@ -0,0 +1,30 @@
+<h1><%= t 'activerecord.models.contacts' %></h1>
+<%= render 'tab_admin_menu' %>
+
+<table class='table table-striped'>
+	<thead>
+  <tr>
+	    <th><%= t 'activerecord.attributes.contacts.sender_name' %></th>
+	    <th><%= t 'activerecord.attributes.contacts.sender_email' %></th>
+			<th><%= t 'activerecord.attributes.contacts.body' %></th>
+			<th><%= t 'contacts.sent' %></th>
+	    <th><%= t('actions') %></th>
+	  </tr>
+	</thead>
+
+	<tbody>
+		<% @contacts.each do |contact| %>
+		  <tr>
+		    <td><%= contact.sender_name %></td>
+				<td><%= link_to contact.sender_email, "mailto:#{contact.sender_email}" %></td>
+		    <td><%= truncate contact.body, length: 85, separator: ' ...' %></td>
+				<td><%= l contact.created_at, :format => :tkh_default %></td>
+		    <td><%= link_to "<span class=\"glyphicon glyphicon-eye-open\"></span>&nbsp;#{t('view')}".html_safe, contact, class: 'btn btn-xs btn-default' %></td>
+		  </tr>
+		<% end %>
+	</tbody>
+</table>
+
+<%= will_paginate @contacts %>
+
+<%= render 'shared/admin_sidebar' %>

data/app/views/contacts/show.html.erb

@@ -0,0 +1,18 @@
+<h1><%= t('activerecord.models.contacts') %></h1>
+
+<%= render 'tab_admin_menu' %>
+
+<h2><%= "#{t('contacts.sent')}#{t('colon')} #{ l(@contact.created_at, :format => :tkh_default) }" %></h2>
+
+<p>
+	<%= "#{t('activerecord.attributes.contacts.sender_name').capitalize}#{t('colon')} #{@contact.sender_name}" %><br />
+	<%= "#{t('activerecord.attributes.contacts.sender_email')}#{t('colon')} #{link_to(@contact.sender_email, "mailto:#{@contact.sender_email}")}".capitalize.html_safe %>
+</p>
+<h3><%= t('activerecord.attributes.contacts.body').capitalize %></h3>
+<p><%= sanitize @contact.body.gsub(/\r\n?/, "<br>"), :tags => %w(br), :attributes => %w() %></p>
+
+<hr>
+
+<p><%= link_to t('list'), contacts_path, class: 'btn' %></p>
+
+<%= render 'shared/admin_sidebar' %>

data/config/routes.rb

@@ -1,6 +1,8 @@
 Rails.application.routes.draw do
   scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
 
+    resources :contacts
+
     # Mailing list records for admin
     resources :details # deprecated. Should disappear soon.
 

data/lib/generators/tkh_mailing_list/create_or_update_locales/templates/de.yml

@@ -1,5 +1,15 @@
 de:
 
+  activerecord:
+    models:
+      contact: 'Kontakt'
+      contacts: 'Kontakte'
+    attributes:
+      contacts:
+        sender_name: "Absender-Name"
+        sender_email: 'Absender-Email'
+        body: 'Nachricht'
+
   details:
     create:
       notice: 'This user has been created.'
@@ -21,3 +31,23 @@ de:
     destroy:
       notice: 'This user has been deleted.'
       warning: 'A problem occurred while deleting this user.'
+
+  contacts:
+    messages_from_forms: 'Nachrichten vom Kontaktformular'
+    send_message: 'Nachricht senden'
+    sent: 'Gesendet am'
+    create:
+      did_not_reach: 'Etwas ist schief gegangen. Deine Nachricht hat den gewünschten Adressaten nicht erreicht.'
+      invalid_email: 'Deine Emai-Adresse scheint ungültig zu sein!'
+      notice: 'Die Nachricht wurde gesendet.'
+      warning: 'Beim Versenden der Nachricht gab es ein Problem.'
+    mailer:
+      intro: 'Hier ist die Nachricht vom Kontaktformular der Webseite:'
+      sender_name: "Absendername:"
+      sender_email: "Absender-Email:"
+      message: 'Nachricht'
+
+  admin:
+    mailer:
+      daily_digest:
+        subject: "Admin Daily Digest"

data/lib/generators/tkh_mailing_list/create_or_update_locales/templates/en.yml

@@ -1,5 +1,15 @@
 en:
 
+  activerecord:
+    models:
+      contact: 'contact'
+      contacts: 'contacts'
+    attributes:
+      contacts:
+        sender_name: "sender name"
+        sender_email: 'sender email'
+        body: 'message'
+
   details:
     create:
       notice: 'This user has been created.'
@@ -22,3 +32,24 @@ en:
     destroy:
       notice: 'This user has been deleted.'
       warning: 'A problem occurred while deleting this user.'
+
+
+  contacts:
+    messages_from_forms: 'messages from contact form'
+    send_message: 'send message'
+    sent: 'Sent at'
+    create:
+      did_not_reach: 'Something went wrong. Your message did not reach the intended recipient.'
+      invalid_email: 'Your email address does not seem to be valid!'
+      notice: 'Thank you. We have received your message.'
+      warning: 'There was a problem sending your message.'
+    mailer:
+      intro: 'Here is the message sent via the contact form on the web site:'
+      sender_name: "Sender's name:"
+      sender_email: "Sender's email:"
+      message: 'Message:'
+
+  admin:
+    mailer:
+      daily_digest:
+        subject: "Admin Daily Digest"

data/lib/generators/tkh_mailing_list/create_or_update_locales/templates/es.yml

@@ -1,5 +1,15 @@
 es:
 
+  activerecord:
+    models:
+      contact: 'contact'
+      contacts: 'contacts'
+    attributes:
+      contacts:
+        sender_name: "nombre del remitente"
+        sender_email: 'correo electrónico del remitente'
+        body: 'mensaje'
+
   details:
     create:
       notice: 'This user has been created.'
@@ -21,3 +31,23 @@ es:
     destroy:
       notice: 'This user has been deleted.'
       warning: 'A problem occurred while deleting this user.'
+
+  contacts:
+    messages_from_forms: 'mensajes del formulario de contacto'
+    send_message: 'enviar el mensaje'
+    sent: 'Enviado a las'
+    create:
+      did_not_reach: 'Something went wrong. Your message did not reach the intended recipient.'
+      invalid_email: 'Your email address does not seem to be valid!'
+      notice: 'Tu mensaje ha sido enviado.'
+      warning: 'Hubo un problema al enviar su mensaje.'
+    mailer:
+      intro: 'Here is the message sent via the contact form on the web site:'
+      sender_name: "Sender's name:"
+      sender_email: "Sender's email:"
+      message: 'Message:'
+
+  admin:
+    mailer:
+      daily_digest:
+        subject: "Admin Daily Digest"

data/lib/generators/tkh_mailing_list/create_or_update_locales/templates/fr.yml

@@ -1,5 +1,16 @@
 fr:
 
+  activerecord:
+    models:
+      contact: 'contact'
+      contacts: 'les contacts'
+    attributes:
+      contacts:
+        sender_name: "votre nom"
+        sender_email: "votre adresse email"
+        body: 'contenu du message'
+
+
   details:
     create:
       notice: 'Un nouvel utilisateur a été ajouté à la base de données.'
@@ -21,3 +32,23 @@ fr:
     destroy:
       notice: "Cet utilisateur n'est plus dans la base de données."
       warning: "Il y a eu un problème qui n'a pas permis d'éléliminer cet utilisateur"
+
+  contacts:
+    messages_from_forms: 'messages du formulaire de contact'
+    send_message: 'envoyez le message'
+    sent: 'Envoyé le'
+    create:
+      did_not_reach: "Il y a eu un problem. Le message n'a pas été acheminé a sa destination."
+      invalid_email: 'Votre adresse courriel ne semble pas bonne !'
+      notice: 'Merci. Nous avons bien reçu votre message.'
+      warning: "Il y'a eu un probleme en envoyant votre message."
+    mailer:
+      intro: 'Voici le message envoyé par un visiteur avec le formulaire de contact sur le site web :'
+      sender_name: "Nom de l'auteur :"
+      sender_email: "Adresse courriel de l'auteur :"
+      message: 'Message :'
+
+  admin:
+    mailer:
+      daily_digest:
+        subject: "Résumé d'activité"

data/lib/generators/tkh_mailing_list/create_or_update_migrations/create_or_update_migrations_generator.rb

@@ -19,6 +19,7 @@ module TkhMailingList
         puts 'creating teacher and profile migrations'
         migration_template "add_teacher_status_to_users.rb", "db/migrate/add_teacher_status_to_users.rb"
         migration_template "add_profile_fields_to_users.rb", "db/migrate/add_profile_fields_to_users.rb"
+        migration_template "create_contacts.rb", "db/migrate/create_contacts.rb"
       end
 
     end

data/lib/generators/tkh_mailing_list/create_or_update_migrations/templates/create_contacts.rb

@@ -0,0 +1,19 @@
+class CreateContacts < ActiveRecord::Migration
+  
+  def self.up
+    create_table :contacts do |t|
+      t.string :sender_name
+      t.string :sender_email
+      t.text :body
+      
+      t.timestamps
+    end
+    add_index :contacts, :updated_at
+  end
+  
+  def self.down
+    drop_table :contacts
+    remove_index :contacts, :updated_at
+  end
+  
+end

data/lib/tasks/tkh_mailing_list_tasks.rake

@@ -10,4 +10,9 @@ namespace :tkh_mailing_list do
     system 'rails g tkh_mailing_list:create_or_update_migrations -s'
     system 'rails g tkh_mailing_list:create_or_update_locales -f'
   end
+
+  desc "Send to the administrators a email digest of important activities."
+  task :daily_admin_digest do
+    Administration.send_daily_digest
+  end
 end

data/lib/tkh_mailing_list/version.rb

@@ -1,3 +1,3 @@
 module TkhMailingList
-  VERSION = "0.10.8"
+  VERSION = "0.10.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tkh_mailing_list
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.10.9
 platform: ruby
 authors:
 - Swami Atma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,25 @@ files:
 - app/assets/javascripts/jquery.jcrop.min.js
 - app/assets/javascripts/profiles.js.coffee
 - app/assets/stylesheets/jquery.jcrop.min.css.scss
+- app/controllers/contacts_controller.rb
 - app/controllers/details_controller.rb
 - app/controllers/members_controller.rb
 - app/controllers/profiles_controller.rb
 - app/helpers/members_helper.rb
+- app/mailers/administration_mailer.rb
+- app/mailers/contact_mailer.rb
+- app/models/administration.rb
+- app/models/contact.rb
 - app/models/detail.rb
 - app/models/member.rb
 - app/models/profile.rb
 - app/uploaders/portrait_uploader.rb
+- app/views/administration_mailer/daily_digest.text.erb
+- app/views/contact_mailer/message_from_contact_form.text.erb
+- app/views/contacts/_form.html.erb
+- app/views/contacts/_tab_admin_menu.html.erb
+- app/views/contacts/index.html.erb
+- app/views/contacts/show.html.erb
 - app/views/details/_form.html.erb
 - app/views/details/_tab_admin_menu.html.erb
 - app/views/details/edit.html.erb
@@ -94,6 +105,7 @@ files:
 - lib/generators/tkh_mailing_list/create_or_update_migrations/create_or_update_migrations_generator.rb
 - lib/generators/tkh_mailing_list/create_or_update_migrations/templates/add_profile_fields_to_users.rb
 - lib/generators/tkh_mailing_list/create_or_update_migrations/templates/add_teacher_status_to_users.rb
+- lib/generators/tkh_mailing_list/create_or_update_migrations/templates/create_contacts.rb
 - lib/tasks/tkh_mailing_list_tasks.rake
 - lib/tkh_mailing_list.rb
 - lib/tkh_mailing_list/version.rb