mail_spy 0.0.2 → 0.1.1

data/app/views/mail_spy/reports/campaigns.html.erb

@@ -0,0 +1,138 @@
+<% @campaigns = [{
+                    :name=>"Valentine's Day",
+                    :first_sent => Date.today()-14,
+                    :last_sent => Date.today(),
+                    :kpis=>{
+                          "Population"=> {
+                              :icon=>"People",
+                              :figure=>1000000
+                          },
+                          "Emails Sent"=>{
+                              :icon=>"Mail",
+                              :figure=>66478
+                          },
+                          "Click-Throughs"=>{
+                              :icon=>"Pointer",
+                              :figure=>1549
+                          },
+                          "Total Purchases"=>{
+                              :icon=>"Money",
+                              :figure=>1214
+                          }
+                    },
+                    :purchase_funnel=>{
+                          "delivered"=>66478,
+                          "opened"=>7643,
+                          "clicked"=>1549,
+                          "purchased"=>5
+                    }
+                  
+                 },{
+                  :name=>"Mother's Day",
+                  :last_sent => Date.today(),
+                  :sent=>1221,
+                  :kpis=>{},
+                  :purchase_funnel=>{}
+                 }] %>
+
+<script type="text/javascript">
+$(function(){
+
+  getValue = function(_o){
+    try{
+      if(typeof(_o) === 'number' ||
+         typeof(parseInt(_o,10) === 'number')){
+        return _o;
+      } else if (_o.r && _o.c){
+
+      }
+    } catch(e){
+      console.log("Can't evaluate:");
+      console.log(_o);
+      console.log(e);
+    }
+  };
+
+  $.each($("[data-operator]"),function(i,e){
+    var lhs, rhs,
+        result = "NA",
+        op = $(this).attr("data-operator"),
+        ops = $(this).attr("data-operands");
+
+    try{
+        ops = ops.split("|");
+        lhs = $.parseJSON(ops[0]);
+        rhs = $.parseJSON(ops[1]);
+        console.log(lhs + " : " + rhs);
+
+        //Switch operators
+        if(op == "+"){
+          result = getValue(lhs) + getValue(rhs);
+        } else if(op == "%"){
+          result = (lhs + "/" + rhs);
+        }
+    } catch(e) {
+        console.log(e);
+    }
+    
+    $(this).html(result);
+  });
+
+
+  $.each($("[data-graph]"),function(i,e){
+    $(this).html($(this).attr("data-value"));
+  });
+
+});
+</script>
+
+<%# ------------------------------------- Start actual view %>
+
+<div class="MsSprite Logo">Mail Spy</div>
+
+<h1 class="_active">
+  <div class="MsSprite Nav Campaign _active"></div> All Campaigns
+</h1>
+
+<div class="CampaignReport">
+  <%# For each campaign %>
+  <% @campaigns.each do |c| %>
+    <div class="CampaignContainer">
+      <h1 ><%= c[:name] %></h1>
+      
+      <div class="KpiContainer">
+        <% c[:kpis].each do |kpi, kpi_data|%>
+          <div class="Kpi">
+            <div class="MsSprite <%= kpi_data[:icon] %> Icon"></div>
+            <kpi><%= kpi %></kpi>
+            <figure><%= kpi_data[:figure] %></figure>
+          </div>
+        <% end %>
+      </div>
+      <div class="FunnelContainer">
+        <h2>
+          Purchase Funnel
+        </h2>
+        <table>
+          <thead>
+            <tr>
+              <td>Action</td>
+              <td>Raw</td>
+              <td>%</td>
+              <td></td>
+            </tr>
+          </thead>
+        <% c[:purchase_funnel].each do |step, step_data|%>
+          <tr>
+            <td><%= step %></td>
+            <td><%=step_data%></funnelCell>
+            <td data-operator="%" data-operands='{"r":-0,"c":-1}|{"r":-1,"c":-1}'></td>
+            <td data-operator="+" data-operands='6|9'></td>
+            <td data-graph="bar" data-value="<%=step_data%>"></td>
+          </tr>
+        <% end %>
+        </table>
+      </div>
+    </div>
+  <% end %>
+</div>

data/config/routes.rb

@@ -4,4 +4,10 @@ MailSpy::Engine.routes.draw do
   match "b", :controller => :tracking, :action => :bug
   match "a", :controller => :tracking, :action => :action
 
+  match "reports", :controller => :reports, :action => :campaigns
+  match "email", :controller => :reports, :action => :email
+
+  # Sendgrid notification api
+  post "sendgrid/notification", :controller => :sendgrid, :action => :notification
+
 end

data/lib/generators/mail_spy/templates/mail_spy.rb

@@ -1,3 +1,22 @@
+# MailSpy configuration
+# tracking_host: The hostname and port (if necessary) of the server MailSpy
+#                will make requests to for tracking.
+#
+# aws credentials: We use aws to store the templates for the emails.
+#
+# If you have delayed job and want to use it to clear the outstanding emails
+# toggle it on here
+
+
+MailSpy.configure do |config|
+  config.tracker_host = "myapp.herokuapp.com"
+  config.aws_access_key_id = "YOUR ACCESS KEY"
+  config.aws_secret_access_key = "YOUR SECRET ACCESS KEY"
+  config.aws_campaign_bucket = "campaigns-yourco-com"
+  config.using_delayed_job = true
+end
+
+
 # MailSpy allows you to add multiple email service providers simply
 # call this method and specify the following options
 #
@@ -12,14 +31,19 @@
 #  :password,
 #  :domain,
 #  :enable_starttls_auto
+#  :options (esp specific options)
 
 MailSpy.add_email_service_provider do |esp|
   esp.name = "sendgrid"
   esp.address = "smtp.sendgrid.net"
-  esp.port = "587",
+  esp.port = "587"
   esp.domain = "herokuapp.com"
   esp.user_name = ENV['SENDGRID_USERNAME']
   esp.password = ENV['SENDGRID_PASSWORD']
   esp.authentication = :plain
   esp.enable_starttls_auto = true
+  esp.options = {
+    :enable_sendgrid_event_tracking => true,
+    :enable_auto_google_analytics => true
+  }
 end

data/lib/mail_spy/manager.rb

@@ -1,96 +1,142 @@
 module MailSpy
   module Manager
 
-    # ------------------------------------------- ADD_TEMPLATE
-    # Programmatically add email templates with a schema of search and
-    # replaceable text
-    #
-    def add_template(name, html_erb, text_erb, template_values_definition)
-      MailSpy::EmailTemplate.create!(
-        {
-          :name => name,
-          :html_erb => html_erb,
-          :text_erb => text_erb,
-          :template_values_definition => template_values_definition
-        })
-    end
-
-    # ------------------------------------------- ADD INSTANCE
+    # ------------------------------------------- CREATE EMAIL
     # Adds a instance of a email template to the queue to send
     #
-    def add_instance(options)
+    def create_email(options)
       options.to_options!
 
       required_options = [
-        :template_name, :campaign, :stream, :component, :schedule_at, :subject,
+        :campaign, :stream, :component, :schedule_at, :subject,
         :template_values, :from, :reply_to]
       to_options = [:to, :cc, :bcc]
 
       # Ensure that we have the required options
-      required_options.each { |ro| raise "add_instance call missing #{ro}" unless options.include? ro }
+      required_options.each { |ro| raise "create_email call missing #{ro}" unless options.include? ro }
 
-      # Make sure we have someone to send to
-      has_sender = options.keys.select { |option| to_options.include? option.intern }.present?
-      raise "Email instance has no sender (to,cc,bcc were all blank)" unless has_sender
+      # Ensure that the campaign, stream and component are not blank
+      # These keys are used to define the s3 paths for the templates
+      [:campaign, :stream, :component].each { |key| raise "##{key} can't be blank" if options[key].blank? }
 
-      # Make sure we have a template
-      options[:template_name]
-      template = MailSpy::EmailTemplate.first(conditions: {name: options[:template_name]})
-      raise "No template: #{options[:template_name]} found, try add_template first" unless template
+      # Make sure we have someone to send to and its not blank
+      has_sender = to_options.select { |option| options[option].present? }.present?
+      raise "Email instance has no sender (to,cc,bcc were all blank)" unless has_sender
 
 
-      # Make sure that
-      (required_options + to_options).each do |option|
+      # Make sure that all options passed map to a accessor so we don't errantly
+      # think we are passing something correctly and really its getting silently
+      # ignored
+      options.keys.each do |option|
         unless MailSpy::Email.method_defined? "#{option}=".intern
           raise "MailSpy::Email doesn't have #{option} as a setter '"
         end
       end
 
+      # Ensure that a esp (forced or random) exists for the email
+      forced_esp = options[:email_service_provider]
+      if forced_esp.present?
+        raise "No esp configured with name: #{forced_esp}" if MailSpy.esps[forced_esp].blank?
+      else
+        raise "No esps configured" if MailSpy.esps.blank?
+        esp_key = MailSpy.esps.keys[rand(MailSpy.esps.keys.count)]
+        options[:email_service_provider] = esp_key
+      end
+
+      # Google Analytics aupport for automatic population of utm_tokens
+      esp = MailSpy.esps[options[:email_service_provider]]
+      if esp.options[:enable_auto_google_analytics].present?
+        options[:utm_source] ||= 'mailspy'
+        options[:utm_medium] ||= 'email'
+        options[:utm_campaign] ||= options[:campaign]
+        options[:utm_term] ||= options[:stream]
+        options[:utm_content] ||= options[:component]
+      end
+
+      #Create the email
+      email = MailSpy::Email.new(options)
+
+      # Ensure we have the template for the email on s3
+      raise "Missing html template" unless email.html_erb.present?
+      raise "Missing text template" unless email.text_erb.present?
 
-      email = MailSpy::Email.create!(options)
-      email.email_template = template
       email.save!
+
+      # Enable sendgrid specific enhancements
+      # Must happen after the email has been saved for the id
+      # TODO test this works
+      if esp.options[:enable_sendgrid_event_tracking].present?
+        header = MailSpy::Sendgrid::SmtpApiHeader.new
+        header.setUniqueArgs({:eid => email.id.to_s})
+        email.headers = {'X-SMTPAPI' => header.asJSON}.merge(email.headers)
+        email.save!
+      end
+
       email
     end
 
     # ------------------------------------------- SEND OUTSTANDING EMAILS
     # Batches through all the emails that were scheduled and have come due
-    # sends them out (step many at a time)
-    def send_outstanding_emails(step=100)
+    # sends them out (step many at a time). Don't thread this method, instead
+    # use the parameters to control concurrency
+    def send_outstanding_emails(step=200, num_threads=100, num_workers=1)
+      success = false
       raise "No Email service providers installed" unless MailSpy.esps.present?
 
-      offset = 0
-      sent = 0
+      return if MailSpy::ProcessLog.currently_processing?
+      current_time = DateTime.now
+      current_process = MailSpy::ProcessLog.create!(
+        {
+          :start => current_time,
+          :running => true,
+        })
 
-      # Helper function for setting present values
-      def set_if_present(email, pony_hash, pony_key, email_key=nil)
-        email_key = pony_key if email_key.nil?
-        value = email.send("#{email_key}")
-        pony_hash[pony_key] = value if value.present?
-      end
+      count = MailSpy::Email.where(:schedule_at.lte => current_time, :sent => false, :failed => false).count
+      first = MailSpy::Email.where(:schedule_at.lte => current_time, :sent => false, :failed => false).first
+      division = (count / num_workers).to_i
 
-      while (true)
-        mails = MailSpy::Email.
-          limit(step).offset(offset).
-          where(:schedule_at.lte => DateTime.now, :sent => false).all
-        break if mails.blank?
-        mails.each do |email|
-          MailSpy::CoreMailer.template(email).deliver
-          email.update_attribute(:sent, true)
-          sent += 1
+      num_workers.times do |i|
+        if MailSpy.using_delayed_job
+          Email.delay.deliver_batch(current_time, first._id, (i - 1) * division, division, step, num_threads)
+        else
+          Email.deliver_batch(current_time, first._id, (i - 1) * division, division, step, num_threads)
         end
-        offset += step
       end
 
-      sent
+      success = true
+      return count
+    ensure
+      if current_process
+        end_time = Time.now
+        current_process.end = end_time
+        current_process.seconds_elapsed = end_time.to_i - current_process.start.to_i
+        current_process.running = false
+        current_process.success = success
+        current_process.save!
+      end
     end
 
 
     # ------------------------------------------- TRACKING
-    #
-
-    def track_other_action
-
+    # MailSpy will automatically track opens and clicks if the tracking bugs
+    # and track_link helpers are used. This action allows tracking of
+    # arbitrary actions. Please be careful to standardize on action names
+    # email_id: The id from the MailSpy::Email record
+    # action_type: String denoting the action that occured
+    # details: Hash of any details of that action (again strive for standards)
+    # count: how many of this action occurred (defaults to 1)
+    def track_action(email_id, action_type, details={}, count=1)
+      raise "track_action missing email_id" if email_id.blank?
+      raise "track_Action missing action_type" if action_type.blank?
+
+      hash ={}
+      hash[:action_type] = action_type
+      hash[:count] = count
+      hash[:details] = details if details.present? && details.kind_of?(Hash)
+
+      # Save it up
+      email = MailSpy::Email.find(email_id)
+      email.actions.create!(hash)
     end
 
   end

data/lib/mail_spy/sendgrid/smtp_api_header.rb

@@ -0,0 +1,68 @@
+# Version 1.0
+# Last Updated 6/22/2009
+# Header support for send grids smtp api
+#
+#
+require 'json'
+
+module MailSpy
+  module Sendgrid
+    class SmtpApiHeader
+
+      def initialize()
+        @data = {}
+      end
+
+      def addTo(to)
+        @data['to'] ||= []
+        @data['to'] += to.kind_of?(Array) ? to : [to]
+      end
+
+      def addSubVal(var, val)
+        if not @data['sub']
+          @data['sub'] = {}
+        end
+        if val.instance_of?(Array)
+          @data['sub'][var] = val
+        else
+          @data['sub'][var] = [val]
+        end
+      end
+
+      def setUniqueArgs(val)
+        if val.instance_of?(Hash)
+          @data['unique_args'] = val
+        end
+      end
+
+      def setCategory(cat)
+        @data['category'] = cat
+      end
+
+      def addFilterSetting(fltr, setting, val)
+        if not @data['filters']
+          @data['filters'] = {}
+        end
+        if not @data['filters'][fltr]
+          @data['filters'][fltr] = {}
+        end
+        if not @data['filters'][fltr]['settings']
+          @data['filters'][fltr]['settings'] = {}
+        end
+        @data['filters'][fltr]['settings'][setting] = val
+      end
+
+      def asJSON()
+        json = JSON.generate @data
+        return json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
+      end
+
+      def as_string()
+        json = asJSON()
+        str = 'X-SMTPAPI: %s' % json.gsub(/(.{1,72})( +|$\n?)|(.{1,72})/, "\\1\\3\n")
+        return str
+      end
+
+    end
+  end
+end

data/lib/mail_spy/version.rb

@@ -1,3 +1,3 @@
 module MailSpy
-  VERSION = "0.0.2"
+  VERSION = "0.1.1"
 end

data/lib/mail_spy.rb

@@ -1,7 +1,11 @@
 require 'pp' #For debugging
+require 'aws-sdk'
+require 'mail_spy/sendgrid/smtp_api_header'
+require 'work_queue'
 require "mongoid"
 require "mail_spy/engine"
 require "mail_spy/manager"
+require "zurb-foundation"
 module MailSpy
 
   extend MailSpy::Manager
@@ -10,21 +14,28 @@ module MailSpy
   # Allows the client to configure and add esps to MailSpy
   MailSpyESP = Struct.new(
     :address, :port, :authentication, :user_name, :password, :domain,
-    :enable_starttls_auto, :name
+    :enable_starttls_auto, :name, :options
   )
   @@esps = {}
 
-  #@@config = MailSpyConfig.new
+  MailSpyConfig = Struct.new(
+    :tracker_host, :aws_access_key_id,
+    :aws_secret_access_key, :aws_campaign_bucket, :using_delayed_job
+
+  )
+  @@config = MailSpyConfig.new
 
   # Allows the initializer to set the configuration
-  #def self.configure(&block)
-  #  block.call(@@config)
-  #end
+  def self.configure(&block)
+    block.call(@@config)
+  end
 
   #TODO eventually have this be a view with a interface
   def self.add_email_service_provider(&block)
     esp = MailSpyESP.new
+    esp.options = {} # Important! provides default options list for internals
     block.call(esp)
+    esp.options.to_options!
     @@esps[esp.name] = esp
   end
 
@@ -32,5 +43,28 @@ module MailSpy
     @@esps
   end
 
+  def self.tracker_host
+    @@config.tracker_host
+  end
+
+  def self.template_directory
+    @@config.template_directory
+  end
+
+  def self.aws_access_key_id
+    @@config.aws_access_key_id
+  end
+
+  def self.aws_secret_access_key
+    @@config.aws_secret_access_key
+  end
+
+  def self.aws_campaign_bucket
+    @@config.aws_campaign_bucket
+  end
+
+  def self.using_delayed_job
+    @@config.using_delayed_job
+  end
 
 end

data/test/dummy/app/views/email_templates/helper_test.html.erb

@@ -0,0 +1,15 @@
+<p>
+  You should be able to click on the link and have the server record the even
+  and forward you to the correct place.
+
+  A link : <%= track_link 'My home', 'www.google.com' %>
+</p>
+
+<br>
+
+<p>
+  You should be able to show images in the email client and have the server
+  track the open
+  A Bug is in the parenthesis (<%= tracking_bug %>)
+</p>
+

data/test/dummy/app/views/email_templates/helper_test.text.erb

@@ -0,0 +1,11 @@
+You should be able to click on the link and have the server record the even
+and forward you to the correct place.
+
+A link : <%= track_link 'My home', 'www.google.com' %>
+---------------------------
+
+You should be able to show images in the email client and have the server
+track the open
+A Bug is in the parenthesis (<%= tracking_bug %>)
+
+

data/test/dummy/config/environments/development.rb

@@ -14,7 +14,7 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.raise_delivery_errors = true
 
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log

data/test/dummy/config/environments/production.rb

@@ -5,7 +5,7 @@ Dummy::Application.configure do
   config.cache_classes = true
 
   # Full error reports are disabled and caching is turned on
-  config.consider_all_requests_local       = false
+  config.consider_all_requests_local = false
   config.action_controller.perform_caching = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this)
@@ -64,4 +64,8 @@ Dummy::Application.configure do
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Raise errors on mailer failure
+  config.action_mailer.raise_delivery_errors = true
+
 end

data/test/dummy/config/environments/test.rb

@@ -27,11 +27,14 @@ Dummy::Application.configure do
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
+  config.action_mailer.delivery_method = :smtp
 
   # Raise exception on mass assignment protection for Active Record models
   config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Raise errors on mailer failure
+  config.action_mailer.raise_delivery_errors = true
 end

data/test/dummy/config/initializers/mail_spy.rb

@@ -0,0 +1,42 @@
+# MailSpy configuration
+# tracking_host: The hostname and port (if necessary) of the server MailSpy
+#                will make requests to for tracking.
+
+
+MailSpy.configure do |config|
+  config.tracker_host = "localhost:5000"
+  config.aws_access_key_id = "AKIAIF6DRMAH3BR47AZQ"
+  config.aws_secret_access_key = "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"
+  config.aws_campaign_bucket = "daviacalendar-mailspy"
+end
+
+
+# MailSpy allows you to add multiple email service providers simply
+# call this method and specify the following options
+#
+#  :name (must be unique for all esps you add)
+#  :via (stmp or sendmail)
+#
+#  SMTP OPTIONS
+#  :address,
+#  :port,
+#  :authentication,
+#  :user_name,
+#  :password,
+#  :domain,
+#  :enable_starttls_auto
+
+MailSpy.add_email_service_provider do |esp|
+  esp.name = "sendgrid"
+  esp.address = "smtp.sendgrid.net"
+  esp.port = "587"
+  esp.domain = "herokuapp.com"
+  esp.user_name = "app2602840@heroku.com"
+  esp.password = "qb6qnim0"
+  esp.authentication = :plain
+  esp.enable_starttls_auto = true
+  esp.options = {
+    :enable_sendgrid_event_tracking => true,
+    :enable_auto_google_analytics => true
+  }
+end

data/test/dummy/config/routes.rb

@@ -1,4 +1,3 @@
 Rails.application.routes.draw do
-
-  mount MailSpy::Engine => "/mail_spy"
+  mount MailSpy::Engine => "/mail"
 end

data/test/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end