mail_spy 0.0.4 → 0.0.5

data/README.rdoc

@@ -20,6 +20,7 @@ Create the mongoid configuration for the mongo db
  rails g mail_spy:initializer
 
 Fill out the generated mailspy.rb with your esp settings (file has example)
+and AWS settings
 
 Then mount the engine in the routes.rb file
   Rails.application.routes.draw do
@@ -32,13 +33,7 @@ Mailspy is centered around email templates and instances of those templates
 (aka emails).
 
 To create a template:
-
-MailSpy.create_template(template_name, html_erb, text_erb, template_values_definition)
-
- * Template name must be unique to all templates
- * html, and text are the contents for a multipart email
- * template_values_definition is a array of keys that should be present in the
-   template values of each hash
+add a template to your s3 directory, campaign/stream/component.(text|html).erb
 
 
 To create a instance:

data/app/helpers/mail_spy/email_helper.rb

@@ -21,8 +21,15 @@ 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)
+        url = url_for(
+          :controller => "mail_spy/tracking",
+          :action => :link,
+          :url => url,
+          :only_path => false,
+          :host => MailSpy.tracker_host,
+          :n => @_track_count,
+          :eid => @_email_id
+        )
 
 
         href_attr = "href=\"#{ERB::Util.html_escape(url)}\"" unless href
@@ -33,7 +40,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/mailers/mail_spy/core_mailer.rb

@@ -6,20 +6,23 @@ module MailSpy
       # Slight hack to provide information to helpers
       @_email_id = email.id
       @template_values = email.template_values
+      email_hash = {}
+
+
+      # Evaluate the subject line as erb
+      if email.subject.present?
+        subject = ERB.new(email.subject).result(binding)
+        email_hash[:subject] =  subject
+      end
 
       # Set Headers
-      email_hash = {}
-      std_email_keys = [:to, :cc, :bcc, :from, :subject, :message_id, :sender, :reply_to]
+      std_email_keys = [:to, :cc, :bcc, :from, :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 }
+        format.text { render :inline => email.text_erb }
+        format.html { render :inline => email.html_erb }
       end
 
       # Email Service provider setup

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
@@ -15,9 +17,7 @@ module MailSpy
     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
@@ -43,18 +43,6 @@ module MailSpy
       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
@@ -64,6 +52,37 @@ module MailSpy
       return MailSpy::CoreMailer.template(self).html_part.body.to_s
     end
 
+    def html_erb
+      load_template("html.erb")
+    end
+
+    def text_erb
+      load_template("text.erb")
+    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?
+
+      # 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_campaign_stats
 

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

@@ -1,3 +1,19 @@
+# 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.
+#
+
+
+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"
+end
+
+
 # MailSpy allows you to add multiple email service providers simply
 # call this method and specify the following options
 #
@@ -16,7 +32,7 @@
 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']

data/lib/mail_spy/manager.rb

@@ -1,43 +1,28 @@
 module MailSpy
   module Manager
 
-    # ------------------------------------------- ADD_TEMPLATE
-    # Programmatically add email templates with a schema of search and
-    # replaceable text
-    #
-    def create_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 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 "create_email call missing #{ro}" unless options.include? ro }
 
+      # 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 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 create_template first" unless template
-
 
       # Make sure that
       (required_options + to_options).each do |option|
@@ -46,9 +31,7 @@ module MailSpy
         end
       end
 
-
       email = MailSpy::Email.create!(options)
-      email.email_template = template
       email.save!
       email
     end
@@ -75,7 +58,9 @@ module MailSpy
           where(:schedule_at.lte => DateTime.now, :sent => false).all
         break if mails.blank?
         mails.each do |email|
-          MailSpy::CoreMailer.template(email).deliver
+          mail = MailSpy::CoreMailer.template(email)
+          #TODO might be nice to flush mail out in debug mode
+          mail.deliver
           email.update_attribute(:sent, true)
           sent += 1
         end

data/lib/mail_spy/version.rb

@@ -1,3 +1,3 @@
 module MailSpy
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/mail_spy.rb

@@ -1,4 +1,5 @@
 require 'pp' #For debugging
+require 'aws-sdk'
 require "mongoid"
 require "mail_spy/engine"
 require "mail_spy/manager"
@@ -14,12 +15,17 @@ module MailSpy
   )
   @@esps = {}
 
-  #@@config = MailSpyConfig.new
+  MailSpyConfig = Struct.new(
+    :tracker_host, :aws_access_key_id,
+    :aws_secret_access_key, :aws_campaign_bucket
+
+  )
+  @@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)
@@ -32,5 +38,24 @@ 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
 
 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,38 @@
+# 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
+end

data/test/dummy/config/routes.rb

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

data/test/dummy/lib/tasks/emails.rake

@@ -0,0 +1,8 @@
+namespace :emails do
+
+  desc "Send helper test emails to test email"
+  task :send_helper_test => :environment do
+
+  end
+
+end

data/test/dummy/log/development.log

@@ -210,3 +210,15 @@ MONGODB dummy_development['mail_spy_emails'].find({}).limit(-1).sort([[:_id, :de
 MONGODB dummy_development['mail_spy_emails'].find({}).limit(-1).sort([[:_id, :desc]])
 MONGODB dummy_development['system.namespaces'].find({})
 MONGODB dummy_development['mail_spy_emails'].find({}).limit(-1).sort([[:_id, :desc]])
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)
+MONGODB [WARNING] Please note that logging negatively impacts client-side performance. You should set your logging level no lower than :info in production.
+MONGODB admin['$cmd'].find({:ismaster=>1}).limit(-1)