mail_spy 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+= Mailspy
+
+ESP agnostic sending and tracking platform for email campaigns
+
+== Requirements
+
+Mongodb > 1.8
+
+== Setup
+
+Add gem "mailspy" to your Gemfile
+ gem "mailspy"
+
+
+Create the mongoid configuration for the mongo db
+
+ rails g mailspy:initialize
+
+Fill out the generated mailspy_mongoid.yml with the mongodb configuration settings
+
+Then mount the engine in the routes.rb file
+  Rails.application.routes.draw do
+    mount MailSpy::Engine => "/mailspy"
+  end
+
+== Usage
+
+To start using the viral tool simply enable it by
+
+Adding the Virality module to Application Controller
+  class ApplicationController < ActionController::Base
+    include Virality
+    before_filter :track_virality
+
+  end
+
+This will give you access to the following methods in lib/virality.rb these
+methods are the complete client interface for the tool.
+
+You will want to get started by instrumenting you code with the record_* methods
+and using the message_for_conceit to populate your channel messages
+
+
+
+== packaging into a application
+
+If you don't have a private gem server you can package the gem into your
+application since its not open source...
+
+1) gem build viral.gemspec
+2) rvm 1.9.2@global gem install viral-0.7.3.gem
+3) gem unpack viral -v '0.7.3' --target vendor/gems/
+4) Add the gemspec file to the vendored unpacked gem.
+5) bundle install
+
+== Testing
+
+You will need to add your own database.yml to the dummy app, rake db:create, and
+rake db:migrate and rake db:test:prepare to get the dummy app setup.
+
+Then you can simply run rake from the plugins test directory
+
+
+
+== License
+This project is property of Ooga Labs and not open source software
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MailSpy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

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

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/mail_spy/tracking.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

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/assets/stylesheets/mail_spy/tracking.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/application_controller.rb

@@ -0,0 +1,4 @@
+module MailSpy
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/mail_spy/tracking_controller.rb

@@ -0,0 +1,53 @@
+module MailSpy
+  class TrackingController < ApplicationController
+
+    def link
+      email_id = params[:eid]
+      head :unprocessable_entity and return if email_id.blank?
+
+      email = MailSpy::Email.find(email_id)
+      email.actions.create!(
+        :action_type => MailSpy::Action::ACTION_TYPE_CLICK,
+        :details => {
+          :url => params[:url],
+          :link_number => params[:n]
+        }
+      )
+
+      redirect_to params[:url]
+    end
+
+    def bug
+      email_id = params[:eid]
+      head :unprocessable_entity and return if email_id.blank?
+
+      #Mark the email as opened
+      email = MailSpy::Email.find(email_id)
+      email.actions.create!(
+        :action_type => MailSpy::Action::ACTION_TYPE_OPEN
+      )
+
+      head 200
+    end
+
+    def action
+      email_id = params[:eid]
+      action_type = params[:action_type]
+      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)
+
+      head 200
+    end
+  end
+end

data/app/helpers/mail_spy/application_helper.rb

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

data/app/helpers/mail_spy/email_helper.rb

@@ -0,0 +1,40 @@
+module MailSpy
+  module EmailHelper
+
+    # Support for link clicks.
+    def track_link(*args, &block)
+      @_track_count ||= 0
+      if block_given?
+        options = args.first || {}
+        html_options = args.second
+        track_link(capture(&block), options, html_options)
+      else
+        @_track_count += 1
+        name = args[0]
+        options = args[1] || {}
+        html_options = args[2]
+
+        html_options = convert_options_to_data_attributes(options, html_options)
+        url = url_for(options)
+
+        href = html_options['href']
+        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)
+
+
+        href_attr = "href=\"#{ERB::Util.html_escape(url)}\"" unless href
+        "<a #{href_attr}#{tag_options}>#{ERB::Util.html_escape(name || url)}</a>".html_safe
+      end
+    end
+
+
+    # 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
+    end
+
+  end
+end

data/app/mailers/mail_spy/core_mailer.rb

@@ -0,0 +1,55 @@
+module MailSpy
+  class CoreMailer < ActionMailer::Base
+    helper "mail_spy/email"
+
+    def template(email)
+      # Slight hack to provide information to helpers
+      @_email_id = email.id
+      @template_values = email.template_values
+
+      # Set Headers
+      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 || ""
+
+      mail_message = mail(email_hash) do |format|
+        format.text { render :inline => text_erb }
+        format.html { render :inline => 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,
+          :user_name => esp.user_name,
+          :password => esp.password,
+          :port => esp.port,
+          :authentication => esp.authentication,
+          :enable_starttls_auto => esp.enable_starttls_auto,
+          :domain => esp.domain
+        })
+
+      mail_message
+    end
+
+
+    protected
+
+    def set_if_present(email_hash, email, hash_key, email_key=nil)
+      email_key = hash_key if email_key.nil?
+      value = email.send("#{email_key}")
+      email_hash[hash_key] = value if value.present?
+    end
+  end
+end

data/app/models/mail_spy/action.rb

@@ -0,0 +1,23 @@
+module MailSpy
+  class Action
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    ACTION_TYPE_OPEN = 'open'
+    ACTION_TYPE_CLICK = 'click'
+    ACTION_TYPE_BOUNCE = 'bounce'
+    ACTION_TYPE_UNSUBSCRIBE = 'unsubscribe'
+    ACTION_TYPE_SPAM = 'spam'
+
+    field :action_type, :type => String
+    field :count, :type => Integer, :default => 1
+    field :details, :type => Hash
+    embedded_in :email, :class_name => "MailSpy::Email"
+
+
+    def details
+      self.read_attribute(:details).try(:with_indifferent_access)
+    end
+
+  end
+end

data/app/models/mail_spy/campaign_report.rb

@@ -0,0 +1,6 @@
+module MailSpy
+  class CampaignReport
+    include Mongoid::Document
+    include Mongoid::Timestamps
+  end
+end

data/app/models/mail_spy/component_report.rb

@@ -0,0 +1,6 @@
+module MailSpy
+  class ComponentReport
+    include Mongoid::Document
+    include Mongoid::Timestamps
+  end
+end

data/app/models/mail_spy/email.rb

@@ -0,0 +1,93 @@
+module MailSpy
+  class Email
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    # Standard Email options
+    field :to
+    field :cc
+    field :bcc
+    field :from
+    field :subject
+    field :sender #Sets envelope from (aka sender header)
+    field :reply_to
+    field :headers
+    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'
+
+    # Support for tracking which esp ran the email
+    field :email_service_provider, :type => String
+
+    # References back to a user in another db
+    field :user_id, :type => Integer
+
+    # Structured campaign, stream and component settings
+    field :campaign, :type => String
+    field :stream, :type => String
+    field :component, :type => String
+
+    # Scheduling and completion
+    field :schedule_at, :type => DateTime
+    field :sent, :type => Boolean
+    index :schedule_at
+
+    # Record keeping of what happened
+    embeds_many :actions, :class_name => "MailSpy::Action"
+
+
+    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
+    end
+
+    def parsed_text_content
+      return MailSpy::CoreMailer.template(self).html_part.body.to_s
+    end
+
+
+    def self.generate_campaign_stats
+
+      map = <<-eof
+        function(){
+          emit(this.campaign, {count: 1});
+        }
+      eof
+
+      reduce = <<-eof
+        function(key, values){
+          var result = { count : 0 };
+
+          values.forEach(function(value){
+            result.count += value.count;
+          });
+          return result;
+        }
+      eof
+
+
+      results = collection.map_reduce(map, reduce, :out => "campaign_reports")
+    end
+
+  end
+end
+

data/app/models/mail_spy/email_template.rb

@@ -0,0 +1,17 @@
+module MailSpy
+  class EmailTemplate
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    field :name, :type => String
+    field :html_erb, :type => String
+    field :text_erb, :type => String
+    field :template_values_definition, :type => Hash
+
+    index :name, :unique => true
+
+    has_many :emails, :class_name => 'MailSpy::Email'
+
+    validates_presence_of :name
+
+  end
+end

data/app/models/mail_spy/stream_report.rb

@@ -0,0 +1,6 @@
+module MailSpy
+  class StreamReport
+    include Mongoid::Document
+    include Mongoid::Timestamps
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MailSpy</title>
+  <%= stylesheet_link_tag    "mail_spy/application", :media => "all" %>
+  <%= javascript_include_tag "mail_spy/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+MailSpy::Engine.routes.draw do
+
+  match "t", :controller => :tracking, :action => :link
+  match "b", :controller => :tracking, :action => :bug
+  match "a", :controller => :tracking, :action => :action
+
+end

data/lib/generators/mail_spy/initialize_generator.rb

@@ -0,0 +1,12 @@
+module MailSpy
+  class InitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Generator creates a sample initializer"
+
+    def create_config_files
+      copy_file "mail_spy.rb", "config/initializers/mail_spy.rb"
+    end
+
+  end
+end

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

@@ -0,0 +1,25 @@
+# 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 = ENV['SENDGRID_USERNAME']
+  esp.password = ENV['SENDGRID_PASSWORD']
+  esp.authentication = :plain
+  esp.enable_starttls_auto = true
+end

data/lib/mail_spy/engine.rb

@@ -0,0 +1,13 @@
+module MailSpy
+  class Engine < ::Rails::Engine
+    isolate_namespace MailSpy
+
+    # http://edgeapi.rubyonrails.org/classes/Rails/Engine.html
+    config.generators do |g|
+      g.orm :mongoid
+      g.template_engine :erb
+      g.test_framework :test_unit
+    end
+
+  end
+end

data/lib/mail_spy/manager.rb

@@ -0,0 +1,97 @@
+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
+    # Adds a instance of a email template to the queue to send
+    #
+    def add_instance(options)
+      options.to_options!
+
+      required_options = [
+        :template_name, :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 }
+
+      # 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
+
+      # 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 that
+      (required_options + to_options).each do |option|
+        unless MailSpy::Email.method_defined? "#{option}=".intern
+          raise "MailSpy::Email doesn't have #{option} as a setter '"
+        end
+      end
+
+
+      email = MailSpy::Email.create!(options)
+      email.email_template = template
+      email.save!
+      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)
+      raise "No Email service providers installed" unless MailSpy.esps.present?
+
+      offset = 0
+      sent = 0
+
+      # 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
+
+      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
+        end
+        offset += step
+      end
+
+      sent
+    end
+
+
+    # ------------------------------------------- TRACKING
+    #
+
+    def track_other_action
+
+    end
+
+  end
+end

data/lib/mail_spy/version.rb

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