tkh_mailing_list 0.11.3 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef53330b934a0733e06b8093b36dba90c46d7ff7
-  data.tar.gz: ddcd7052a086932aff05fcdebcf7651f70a60bbf
+  metadata.gz: 1a5c287dae7e5a27792104c192cfaf5f893bd742
+  data.tar.gz: e3b0ff2b3661e22329b04f033b80f34715d264cf
 SHA512:
-  metadata.gz: 86120c651d4089f0a9d0eb9192915d3769b9518b523c3a169f32fdf7a633a96e25a86a9098d9b9291e0e1b7a21245662f74c943be3f8c888879a55b10b23d980
-  data.tar.gz: 472534e3ed7f315b7c330fe18d7472b30d09cd5b27a0fb2423a12521ce7f653e2c5568a5156a7a8e565ee16c09682fcd714cbe242179bd2122b5cbc00a5307fe
+  metadata.gz: 8560d4a060fd027ed48ff898448acc14cdb1a10d26ebcf6b308439b68af4ccd07ca2c1f822a1f77dd1694fc472d56d044d9932959c06863b9d8b8d5a669e247c
+  data.tar.gz: a555fdd7856ca06fa3cb63e20b639ff644dad84dd26af325d1755a3cfde401eb9ca5675ac6af04952978cd52b85f13c652070ec302e33044ca697a92b54f1f21

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 
 
+## 0.12
+
+* Implemented the newsletter signup routine outside the login process.
+* Added yesterday's activity feed items to the admin daily digest.
+* Added glyphicons to the members index view and paginate to only 30 records
+
+
 ## 0.11.3
 
 * Fixed the spam detection hidden honeypot measure. It was never working :-(

data/app/controllers/members_controller.rb

@@ -6,7 +6,7 @@ class MembersController < ApplicationController
   before_action :set_member, only: [ :show, :edit, :update, :destroy ]
 
   def index
-    @members = Member.by_recent.paginate(:page => params[:page], :per_page => 50)
+    @members = Member.by_recent.paginate(:page => params[:page], :per_page => 30)
     switch_to_admin_layout
   end
 

data/app/controllers/signups_controller.rb

@@ -0,0 +1,38 @@
+class SignupsController < ApplicationController
+
+  def email_verification
+    unless params[:user][:email].blank?
+      @user = User.find_or_initialize_by(email: params[:user][:email])
+      set_email_validation_token
+      @user.allow_newsletter = true
+      @user.allow_daily_digests = true
+      @user.save ? @validation_ready=true : @validation_ready=false
+      SignupMailer.verification_email(@user).deliver
+      Activity.create doer_id: @user.id, message: "signed up for the newsletter. Email: #{@user.email}"
+    else
+     redirect_to root_path, alert: 'Your email cannot be blank. Please enter your email address and try again'
+    end
+  end
+
+  def email_confirmation
+    @user = User.where(email_validation_token: params[:token]).first
+    if @user && @user.email_validation_token_sent_at >= Time.zone.now - 1.hour
+      @user.email_validated = true
+      @user.save
+      @email_confirmed = true
+    elsif @user && @user.email_validation_token_sent_at <= Time.zone.now - 1.hour
+      redirect_to root_url, alert: "Your verification token was created over an hour ago. Please restart the process."
+    else
+      @email_confirmed = false
+    end
+  end
+
+  private
+
+  def set_email_validation_token
+    @user.generate_token(:email_validation_token)
+    @user.email_validation_token_sent_at = Time.zone.now
+    @user.save
+  end
+
+end

data/app/mailers/administration_mailer.rb

@@ -3,10 +3,12 @@ class AdministrationMailer < ActionMailer::Base
 
   default :from => "#{Setting.first.try(:company_name)} <#{Setting.first.try(:contact_email)}>"
 
-  def daily_digest( admin_user, yesterdays_contact_messages, pending_comments )
+  # this job is called by the Administration model in this gem
+  def daily_digest( admin_user, yesterdays_contact_messages, pending_comments, yesterdays_activities )
     @recipient = admin_user
     @contact_messages = yesterdays_contact_messages
     @pending_comments = pending_comments
+    @yesterdays_activities = yesterdays_activities
     # 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)}>"

data/app/mailers/signup_mailer.rb

@@ -0,0 +1,8 @@
+class SignupMailer < ActionMailer::Base
+  default from: "#{Setting.first.try(:site_name)} <#{Setting.first.contact_email}>"
+
+  def verification_email(user)
+    @user = user
+    mail to: @user.email, subject: "Email address validation"
+  end
+end

data/app/models/administration.rb

@@ -1,10 +1,12 @@
 class Administration < ActiveRecord::Base
 
+  # this method is triggered by a rake task in this gem
   def self.send_daily_digest
     digest_is_needed = false
     @yesterdays_contact_messages = Contact.yesterdays.chronologically
     @pending_comments = Comment.pending.by_created
-    digest_is_needed = true if @yesterdays_contact_messages.count > 0 || @pending_comments.count > 0
+    @yesterdays_activities = Activity.yesterdays.chronologically
+    digest_is_needed = true if @yesterdays_contact_messages.count > 0 || @pending_comments.count > 0 || @yesterdays_activities.count > 0
     if digest_is_needed
       User.administrators.each do |administrator|
         send_message_to_admin(administrator)
@@ -17,7 +19,7 @@ class Administration < ActiveRecord::Base
   def self.send_message_to_admin(recipient)
     # Actually send the email to the administrator
     begin
-      AdministrationMailer.daily_digest( recipient, @yesterdays_contact_messages, @pending_comments ).deliver_now
+      AdministrationMailer.daily_digest( recipient, @yesterdays_contact_messages, @pending_comments, @yesterdays_activities ).deliver_now
       return 'success'
     rescue Exception => e
       AdminMailer.rescued_exceptions(e, "Some exception occurred while trying to send to site admin the daily digest.").deliver

data/app/models/contact.rb

@@ -5,6 +5,7 @@ class Contact < ActiveRecord::Base
   # validates :sender_email, :presence => true, :format => { :with => /\A([\A@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, :on => :create }
   validates_presence_of :body
 
+  # tkh_mailing_list sends daily digest with yesterday's contacts
   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') }

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

@@ -22,4 +22,20 @@
   <p>You can see and manage these messages at: <%= link_to 'contact messages', contacts_url %>.</p>
 <% end %>
 
+<% unless @yesterdays_activities.blank?  %>
+  <h2>Activity feed:</h2>
+  <ul>
+    <% @yesterdays_activities.each do |activity| %>
+      <li>
+        <% unless activity.doer.blank? %>
+          <%= "#{ link_to activity.doer.spiritual_name, member_url(id: activity.doer.id) } #{activity.message}".html_safe %>
+        <% else # user has been deleted %>
+          <%= "now deleted user #{activity.message}".html_safe %>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+  <p>You can view <%= link_to 'the whole activity feed', activities_url %>.</p>
+<% end %>
+
 <p>You are receiving this email because you are an administrator of the <%= Setting.first.try(:site_name) %> website.</p>

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

@@ -19,5 +19,17 @@ List of messages from the contact form:
 
 You can see and manage these messages at: <%= contacts_url %>
 <% end %>
+<% unless @yesterdays_activities.blank?  %>
+Activity feed:
 
+<% @yesterdays_activities.each do |activity| %>
+    <% unless activity.doer.blank? %>
+<%= "- #{ link_to activity.doer.spiritual_name, member_url(id: activity.doer.id) } #{activity.message}".html_safe %>
+    <% else # user has been deleted %>
+<%= "- now deleted user #{activity.message}".html_safe %>
+    <% end %>
+<% end %>
+
+You can view the activity feed at: <%= activities_url %>
+<% end %>
 You are receiving this email because you are an administrator of the <%= Setting.first.try(:site_name) %> website.

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

@@ -24,7 +24,7 @@
             <span class="glyphicon glyphicon-ok"></span> <%= link_to t('authentication.disable_admin'), remove_admin_user_path(member), class: 'btn btn-xs btn-primary', method: :post %>
           <% end -%>
         </td>
-        <td><%= link_to t('edit'), edit_member_path(member), :class => 'btn btn-xs btn-default' %><%= link_to t('delete'), member, method: :delete, data: { confirm: t('are_you_sure') }, class: 'btn btn-xs btn-danger' %></td>
+        <td><%= link_to "<span class='glyphicon glyphicon-pencil'></span> ".html_safe + t('edit'), edit_member_path(member), :class => 'btn btn-xs btn-default' %><%= link_to "<span class='glyphicon glyphicon-trash'></span> ".html_safe + t('delete'), member, method: :delete, data: { confirm: t('are_you_sure') }, class: 'btn btn-xs btn-danger' %></td>
       </tr>
     <% end %>
   </tbody>
@@ -32,6 +32,6 @@
 
 <%= will_paginate @members, inner_window: 2 %>
 
-<p><%= link_to 'Add a New Member', new_member_path, class: 'btn btn-default' %></p>
+<p><%= link_to "<span class='glyphicon glyphicon-plus'></span> Add a New Member".html_safe, new_member_path, class: 'btn btn-default' %></p>
 
 <%= render 'shared/admin_sidebar' %>

data/app/views/signup_mailer/verification_email.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <h1>We need to verify your email address</h1>
+
+    <p>You have just requested our email newsletter. Before we add you to the list we need to verify your email address.</p>
+    <p>To protect your privacy, we need you to confirm you are the owner of the <%= @user.email %> address.
+    </p>
+
+    <p>
+      Please visit <%= link_to 'this activation link', email_confirmation_url(token: @user.email_validation_token) %>
+    </p>
+    <p>Thanks for your interest and we look forward to send you the next issue.</p>
+  </body>
+</html>

data/app/views/signup_mailer/verification_email.text.erb

@@ -0,0 +1,9 @@
+Hello,
+
+You have just requested our email newsletter. Before we add you to the list we need to verify your email address.
+
+To protect your privacy, we need you to confirm you are the owner of the <%= @user.email %> address.
+
+Please visit this activation link: <%= email_confirmation_url(token: @user.email_validation_token) %>
+
+Thanks for your interest and we look forward to send you the next issue.

data/app/views/signups/email_confirmation.html.erb

@@ -0,0 +1,30 @@
+<% content_for :meta_title, 'Email Confirmation' %>
+<% content_for :meta_description, "Step 3 of the email verification process to subscribing to our email newsletter." %>
+
+<% if @email_confirmed %>
+
+  <h2>Step 3 of 3 - Email Confirmation</h2>
+
+  <div class="panel panel-success">
+
+    <div class="progress progress-striped">
+      <div class="progress-bar progress-bar-success" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%">
+        100% completed
+      </div>
+    </div>
+
+    <div class="panel-body">
+      <p>Congratulations! Your email address has been verified and confirmed.</p>
+      <p>We will send you the next newsletter issue.</p>
+  </div>
+
+<% else %>
+
+  <div class="panel panel-danger">
+
+    <div class="panel-body">
+      <p>There was a problem sending you the verification email. Please try again.</p>
+    </div>
+  </div>
+
+<% end %>

data/app/views/signups/email_verification.html.erb

@@ -0,0 +1,32 @@
+<% content_for :meta_title, 'Email Verification' %>
+<% content_for :meta_description, "Step 2 of the email verification process to subscribe to our email newsletter." %>
+
+<h2>Step 2 - Email Verification</h2>
+
+<% if @validation_ready %>
+
+  <div class="panel panel-primary">
+
+    <div class="progress progress-striped">
+      <div class="progress-bar progress-bar-primary" role="progressbar" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100" style="width: 50%">
+        50% to completion
+      </div>
+    </div>
+
+    <div class="panel-body">
+      <p>We just sent a verification email to <%= @user.email %>. Please click on the activation link. <br /><br />
+        You have 1 hour!!!<br />
+        You can now go to your email <strong>inbox</strong> or <strong>spam folder</strong>.</p>
+    </div>
+  </div>
+
+<% else %>
+
+  <div class="panel panel-danger">
+
+    <div class="panel-body">
+      <p>There was a problem sending you the verification email. Please try again.</p>
+    </div>
+  </div>
+
+<% end %>

data/config/routes.rb

@@ -1,11 +1,14 @@
 Rails.application.routes.draw do
+
   scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
 
+    # special routes for the signup to basic newsletter
+    post '/email_verification' => 'signups#email_verification'
+    get '/email_confirmation' => 'signups#email_confirmation'
+    # contact forms
     resources :contacts
-
     # Mailing list records for admin
     resources :details # deprecated. Should disappear soon.
-
     # for public viewing and admin editing
     resources :members
     # for user to edit and view privately
@@ -13,4 +16,5 @@ Rails.application.routes.draw do
     get 'profile_history' => 'profiles#history'
 
   end
+
 end

data/lib/tasks/tkh_mailing_list_tasks.rake

@@ -11,6 +11,7 @@ namespace :tkh_mailing_list do
     system 'rails g tkh_mailing_list:create_or_update_locales -f'
   end
 
+  # this task is invoked my crontab once a day
   desc "Send to the administrators a email digest of important activities."
   task :daily_admin_digest => :environment do
     Administration.send_daily_digest

data/lib/tkh_mailing_list/version.rb

@@ -1,3 +1,3 @@
 module TkhMailingList
-  VERSION = "0.11.3"
+  VERSION = "0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tkh_mailing_list
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: '0.12'
 platform: ruby
 authors:
 - Swami Atma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,9 +75,11 @@ files:
 - app/controllers/details_controller.rb
 - app/controllers/members_controller.rb
 - app/controllers/profiles_controller.rb
+- app/controllers/signups_controller.rb
 - app/helpers/members_helper.rb
 - app/mailers/administration_mailer.rb
 - app/mailers/contact_mailer.rb
+- app/mailers/signup_mailer.rb
 - app/models/administration.rb
 - app/models/contact.rb
 - app/models/detail.rb
@@ -112,6 +114,10 @@ files:
 - app/views/profiles/edit.html.erb
 - app/views/profiles/history.html.erb
 - app/views/profiles/show.html.erb
+- app/views/signup_mailer/verification_email.html.erb
+- app/views/signup_mailer/verification_email.text.erb
+- app/views/signups/email_confirmation.html.erb
+- app/views/signups/email_verification.html.erb
 - config/routes.rb
 - lib/generators/tkh_mailing_list/create_or_update_locales/create_or_update_locales_generator.rb
 - lib/generators/tkh_mailing_list/create_or_update_locales/templates/de.yml