mail_spy 0.0.2 → 0.1.1

data/app/assets/javascripts/mail_spy/reports.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/mail_spy/sendgrid.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/mail_spy/application.css

@@ -9,5 +9,66 @@
  * compiled file, but it's generally better to create a new file per style scope.
  *
  *= require_self
- *= require_tree .
+ *= require_tree
 */
+
+/*************************************** Reset Styles */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	font-size: 100%;
+	font: inherit;
+	vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+	display: block;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}
+
+/*************************************** End Reset */
+/*************************************** New Global Styles */
+
+body{
+  font-family: 'Spinnaker', sans-serif;
+  color:#fff;
+  background-image: url(background_tile.gif);
+}
+h1{
+  font-size:24px;
+}
+.Deemph{
+  font-size:.72em;
+}

data/app/assets/stylesheets/mail_spy/reports.css.scss

@@ -0,0 +1,128 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+$colorHighlight:#80ff7a;
+$colorMedlight:#214d30;
+$colorSemiLowlight:#c3c3c3;
+$colorLowlight:#3e4041;
+$colorHighlightBad:#62222a;
+$colorMedlightBad:#663137;
+
+
+
+._active{
+  color:$colorHighlight;
+}
+
+/****************************  Sprites for mailspy_sprite.png */
+.MsSprite{
+  background-image:url(mailspy_sprite.png);
+  background-repeat:no-repeat;
+  display:inline-block;
+  *display:inline; zoom:1;
+  vertical-align:middle;
+  text-indent:-9999px;
+  
+  &.Logo{
+    background-position:0 0;
+    width:180px;
+    height:50px;
+  }
+
+  &.Nav{
+    width: 27px;
+    height: 34px;
+    background-position-x:-50px;
+
+    &.Campaign{
+      background-position-y:-100px;
+    }
+    &.History{
+      background-position-y:-150px;
+    }
+    &.Template{
+      background-position-y:-200px;
+    }
+    &.Menu{
+      background-position-y:-250px;
+    }
+
+    &._active{
+      background-position-x:0;
+    }
+    &:hover{
+      background-position-x:-100px;
+    }
+  }
+
+  &.People{
+    background-position: -200px 0px;
+    height:60px;
+    width:80px;
+  }
+  &.Mail{
+    background-position: -200px -100px;
+    height:60px;
+    width:80px;
+  }
+  &.Pointer{
+    background-position: -200px -200px;
+    height:60px;
+    width:80px;
+  }
+  &.Money{
+    background-position: -200px -300px;
+    height:60px;
+    width:80px;
+  }
+}
+
+/****************************  End mailspy_sprite.png*/
+/****************************  Report Components */
+.KpiContainer{
+  margin:1em;
+}
+.Kpi{
+  display:inline-block;
+  *display:inline; zoom:1;
+  width:200px;
+  text-align:center;
+
+  .Icon{
+    display:block;
+    margin:8px auto;
+  }
+  kpi{
+    color:$colorMedlight;
+    font-size:1.2em;
+    margin:.2em;
+  }
+  figure{
+    color:$colorHighlight;
+    font-size:1.8em;
+    margin:.2em;
+  }
+}
+
+.CampaignContainer{
+  background-color:rgba(0,0,0,.4);
+  padding:.2em 1em 1em 1em;
+  margin:2em 0;
+}
+
+.FunnelContainer{
+  padding:.2em 1em 1em 1em;
+  margin:2em 0;
+  thead{
+    td{
+      color:$colorLowlight;
+      text-align:left;
+    }
+  }
+  td{
+    padding:.5em 2em;
+    color:$colorHighlight;
+    text-align:left;
+  }
+}

data/app/assets/stylesheets/mail_spy/sendgrid.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/mail_spy/reports_controller.rb

@@ -0,0 +1,29 @@
+module MailSpy
+  class ReportsController < ApplicationController
+
+  def campaigns
+
+  end
+
+  def emails
+    
+  end
+
+  def email
+    @email = MailSpy.create_email({
+            :campaign => "2012-valentines",
+            :stream => "a-yikes",
+            :component => "a",
+            :schedule_at => Date.today()+1, # Should never be used
+            :subject => "Just a test",
+            :template_values => {},
+            :from => "EMAIL PREVIEW",
+            :reply_to => "NOREPLY",
+            :to => "nowhere"
+    })
+    @email[:cache_bust] = true
+    render :text=>@email.parsed_html_content, :html_safe => true
+  end
+
+  end
+end

data/app/controllers/mail_spy/sendgrid_controller.rb

@@ -0,0 +1,26 @@
+module MailSpy
+  class SendgridController < ApplicationController
+
+    #Parses a notification from the sendgrid system
+    def notification
+      #Must be passed in via SendGrids SMTP API Headers
+      email_id = params['eid']
+      return head 400 if email_id.blank? || params[:event].blank?
+
+      #Send grid event name
+      event_action = "sendgrid-#{params[:event]}"
+
+      case params[:event]
+        when 'bounce', 'dropped'
+          MailSpy.track_action(email_id, event_action, {:reason => params[:reason]})
+        when 'click'
+          MailSpy.track_action(email_id, event_action, {:url => params[:url]})
+        when 'deferred', 'delivered', 'processed', 'open', 'spamreport', 'unsubscribe'
+          MailSpy.track_action(email_id, event_action)
+      end
+
+      head :ok
+    end
+
+  end
+end

data/app/controllers/mail_spy/tracking_controller.rb

@@ -14,7 +14,22 @@ module MailSpy
         }
       )
 
-      redirect_to params[:url]
+
+      # Add in the GA tokens if present
+
+      ga_hash = {}
+      ga_hash[:utm_source] = email.utm_source if email.utm_source.present?
+      ga_hash[:utm_medium] = email.utm_medium if email.utm_medium.present?
+      ga_hash[:utm_campaign] = email.utm_campaign if email.utm_campaign.present?
+      ga_hash[:utm_term] = email.utm_term if email.utm_term.present?
+      ga_hash[:utm_content] = email.utm_content if email.utm_content.present?
+
+      #TODO this is not fool proof, it breaks on bad urls (like missing http://)
+      #TODO this also breaks when a param is already present it isn;t smart
+      uri =  URI.parse(params[:url])
+      uri.query = [uri.query, ga_hash.to_param].compact.join('&')
+
+      redirect_to uri.to_s
     end
 
     def bug
@@ -33,20 +48,13 @@ module MailSpy
     def action
       email_id = params[:eid]
       action_type = params[:action_type]
-      details = params[:details]
+      count = params[:count] || 1
+      details = params[:details] || {}
 
       head :unprocessable_entity and return if email_id.blank? || action_type.blank?
       head :unprocessable_entity and return if details.present? && !details.kind_of?(Hash)
 
-      hash ={}
-      hash[:action_type] = action_type
-      hash[:count] = params[:count] if !params[:count].nil?
-      hash[:details] = details if details.present? && details.kind_of?(Hash)
-
-      # Save it up
-      email = MailSpy::Email.find(email_id)
-      email.actions.create!(hash)
-
+      MailSpy.track_action(email_id, action_type, details, count)
       head 200
     end
   end

data/app/helpers/mail_spy/email_helper.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module MailSpy
   module EmailHelper
 
@@ -21,9 +23,18 @@ module MailSpy
         tag_options = tag_options(html_options)
 
         # Inject our tracking url, and pass in the redirect_url
-        url = url_for(:controller => "mail_spy/tracking", :action => :link, :url => url,
-                      :n => @_track_count, :eid => @_email_id)
 
+        hash = {
+          :controller => "mail_spy/tracking",
+          :action => :link,
+          :url => url,
+          :only_path => false,
+          :host => MailSpy.tracker_host,
+          :n => @_track_count,
+          :eid => @_email.id
+        }
+
+        url = url_for(hash)
 
         href_attr = "href=\"#{ERB::Util.html_escape(url)}\"" unless href
         "<a #{href_attr}#{tag_options}>#{ERB::Util.html_escape(name || url)}</a>".html_safe
@@ -33,7 +44,14 @@ module MailSpy
 
     # Support for open tracking, client support, etc
     def tracking_bug
-       "<img src='#{url_for(:controller => "mail_spy/tracking", :action => :bug, :eid => @_email_id)}' />".html_safe
+      url = url_for(
+        :controller => "mail_spy/tracking",
+        :action => :bug,
+        :eid => @_email.id,
+        :only_path => false,
+        :host => MailSpy.tracker_host
+      )
+      "<img src='#{url}' style='display:none' width='1' height='1' border='0' />".html_safe
     end
 
   end

data/app/helpers/mail_spy/reports_helper.rb

@@ -0,0 +1,4 @@
+module MailSpy
+  module ReportsHelper
+  end
+end

data/app/helpers/mail_spy/sendgrid_helper.rb

@@ -0,0 +1,4 @@
+module MailSpy
+  module SendgridHelper
+  end
+end

data/app/mailers/mail_spy/core_mailer.rb

@@ -4,31 +4,28 @@ module MailSpy
 
     def template(email)
       # Slight hack to provide information to helpers
-      @_email_id = email.id
+      @_email = email
       @template_values = email.template_values
-
-      # Set Headers
+      esp = MailSpy.esps[email.email_service_provider]
       email_hash = {}
-      std_email_keys = [:to, :cc, :bcc, :from, :subject, :message_id, :sender, :reply_to]
-      std_email_keys.each { |key| set_if_present(email_hash,email, key) }
-      headers.merge!(email.headers) if email.headers.present?
 
-      # Content of the email
-      html_erb = email.email_template.html_erb || ""
-      text_erb = email.email_template.html_erb || ""
+      # Evaluate the subject line as erb
+      if email.subject.present?
+        subject = ERB.new(email.subject).result(binding)
+        email_hash[:subject] = subject
+      end
+
+      # Set Headers
+      std_email_keys = [:to, :cc, :bcc, :from, :message_id, :sender, :reply_to]
+      std_email_keys.each { |key| set_if_present(email_hash, email, key) }
+      email.headers.each {|key, value| headers[key] = value} if email.headers.present?
 
+      # Create the mail message
       mail_message = mail(email_hash) do |format|
-        format.text { render :inline => text_erb }
-        format.html { render :inline => html_erb }
+        format.text { render :inline => email.text_erb }
+        format.html { render :inline => email.html_erb }
       end
 
-      # Email Service provider setup
-      # TODO Only support smtp at the moment
-      raise "No Email service providers installed" unless MailSpy.esps.present?
-      esp = MailSpy.esps[email.email_service_provider]
-      esp_key = MailSpy.esps.keys[rand(MailSpy.esps.keys.count)]
-      esp = MailSpy.esps[esp_key] if esp.blank?
-
       mail_message.delivery_method.settings.merge!(
         {
           :address => esp.address,

data/app/models/mail_spy/email.rb

@@ -3,6 +3,8 @@ module MailSpy
     include Mongoid::Document
     include Mongoid::Timestamps
 
+    @@template_cache = {}
+
     # Standard Email options
     field :to
     field :cc
@@ -11,16 +13,15 @@ module MailSpy
     field :subject
     field :sender #Sets envelope from (aka sender header)
     field :reply_to
-    field :headers
+    field :headers, :type => Hash, :default => {}
     field :message_id #Sets the unique id for each email
 
     # Email content
-    field :template_name, :type => String
-    field :template_values, :type => Hash
-    belongs_to :email_template, :class_name => 'MailSpy::EmailTemplate'
+    field :template_values, :type => Hash, :default => {}
 
     # Support for tracking which esp ran the email
     field :email_service_provider, :type => String
+    validates_presence_of :email_service_provider
 
     # References back to a user in another db
     field :user_id, :type => Integer
@@ -32,39 +33,146 @@ module MailSpy
 
     # Scheduling and completion
     field :schedule_at, :type => DateTime
-    field :sent, :type => Boolean
+    field :sent, :type => Boolean, :default => false
     index :schedule_at
+    index :sent
+
+    # Error reporting
+    field :failed, :type => Boolean, :default => false
+    field :error_message, :type => String
+    field :error_backtrace, :type => Array
+    index :failed
 
     # Record keeping of what happened
     embeds_many :actions, :class_name => "MailSpy::Action"
 
+    # Google Analytics tracking
+    field :utm_source, :type => String
+    field :utm_medium, :type => String
+    field :utm_campaign, :type => String
+    field :utm_term, :type => String
+    field :utm_content, :type => String
+
 
     def template_values
       self.read_attribute(:template_values).try(:with_indifferent_access)
     end
 
-
-    def email_parts
-      template = self.email_template
-      html_erb = template.html_erb
-      text_erb = template.text_erb
-      mail = MailSpy::DummyMailer.template(html_erb, text_erb, self.template_values)
-      return {
-        :html => mail.html_part.body.to_s,
-        :text => mail.text_part.body.to_s
-      }
-    end
-
     # Great for debugging emails
     def parsed_html_content
-      return MailSpy::CoreMailer.template(self).text_part.body.to_s
+      return MailSpy::CoreMailer.template(self).html_part.body.to_s
     end
 
     def parsed_text_content
-      return MailSpy::CoreMailer.template(self).html_part.body.to_s
+      return MailSpy::CoreMailer.template(self).text_part.body.to_s
+    end
+
+    def html_erb
+        load_template("html.erb")
+    end
+
+    def text_erb
+      load_template("text.erb")
+    end
+
+    def self.deliver_batch(current_time, start_id, offset, total, step=200, num_threads=100)
+      wq = WorkQueue.new(num_threads, step*2)
+      processed = 0
+      while true
+        emails = self.where(
+          :schedule_at.lte => current_time,
+          :sent => false,
+          :failed => false,
+          :_id.gt => start_id
+        ).limit(step).offset(offset)
+
+        break if total >= processed || emails.blank?
+        emails.each do |email|
+          wq.enqueue_b do
+            email.deliver
+          end
+        end
+        processed += emails.count
+      end
+      wq.join
+      processed
+    end
+
+    def deliver
+      begin
+        MailSpy::CoreMailer.template(self).deliver
+        self.update_attribute(:sent, true)
+      rescue Exception => e
+        self.failed = true
+        self.error_message = e.try(:message)
+        self.error_backtrace = e.try(:backtrace)
+        self.save!
+      end
+    end
+
+
+    protected
+
+    # Loads a template file from s3 using
+    def load_template(suffix)
+      raise "No aws_campaign_bucket_set" if MailSpy.aws_campaign_bucket.strip.blank?
+
+      # Check the cache using our convention
+      path = "#{self.campaign}/#{self.stream}/#{self.component}.#{suffix}"
+      return @@template_cache[path] if @@template_cache[path].present? && !self[:cache_bust]
+
+      # Load the object from s3
+      s3 = AWS::S3.new(:access_key_id => MailSpy.aws_access_key_id,
+                       :secret_access_key => MailSpy.aws_secret_access_key)
+      campaign_bucket = s3.buckets[MailSpy.aws_campaign_bucket]
+      campaign_bucket = buckets.create(MailSpy.aws_campaign_bucket) unless campaign_bucket.exists?
+      object = campaign_bucket.objects[path]
+      raise "no object found at path:  #{path}" unless object.exists?
+
+      # Read and return
+      @@template_cache[path] = (object.read || "")
+      return @@template_cache[path]
     end
 
 
+    def self.generate_subject_reports
+      map = <<-eof
+        function(){
+          var action_counts = {};
+          for(var i=0, len = this.actions.length; i < len; i++){
+            var action = this.actions[i];
+            action_counts[action.action_type] = action_counts[action.action_type] || 0;
+            action_counts[action.action_type]++;
+          }
+
+          emit({
+                campaign:this.campaign,
+                stream:this.stream,
+                component:this.component,
+                subject:this.subject
+              }, action_counts);
+        }
+      eof
+
+      reduce = <<-eof
+        function(key, values){
+          var result = {};
+
+          values.forEach(function(hash){
+            for(var key in hash){
+              result[key] = result[key] || 0
+              result[key] += hash[key]
+            }
+          });
+
+          return result;
+        }
+      eof
+
+      results = collection.map_reduce(map, reduce, :out => "test_reports")
+
+    end
+
     def self.generate_campaign_stats
 
       map = <<-eof

data/app/models/mail_spy/process_log.rb

@@ -0,0 +1,25 @@
+module MailSpy
+  class ProcessLog
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :start, :type => Time
+    field :end, :type => Time
+    field :seconds_elapsed, :type => Integer
+    field :success, :type => Boolean, :default => false
+    field :running, :type => Boolean, :default => false
+
+
+    def self.currently_processing?
+      self.where(:running => true).first.present?
+    end
+
+    # Deletes logs after a given date if no date is given we default
+    # to logs that are older that 3 months.
+    def self.delete_stale_logs(date=nil)
+      date = Time.now.advance(:months => -3) if date.nil?
+      self.where("created_at < #{date}").delete_all
+    end
+
+  end
+end

data/app/views/layouts/mail_spy/application.html.erb

@@ -2,8 +2,11 @@
 <html>
 <head>
   <title>MailSpy</title>
+  <link rel="icon" href="/assets/mail_spy/spy.ico" type="image/x-icon">
+  <link rel="shortcut icon" href="/assets/mail_spy/spy.ico" type="image/x-icon">
   <%= stylesheet_link_tag    "mail_spy/application", :media => "all" %>
   <%= javascript_include_tag "mail_spy/application" %>
+  <link href='http://fonts.googleapis.com/css?family=Spinnaker' rel='stylesheet' type='text/css'>
   <%= csrf_meta_tags %>
 </head>
 <body>