mail_spy 0.0.2 → 0.1.1

data/test/fixtures/mail_spy/process_logs.yml

@@ -0,0 +1,15 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+one:
+  start: 2012-02-06 23:54:22
+  end: 2012-02-06 23:54:22
+  seconds_elapsed: 1
+  running: false
+  success: false
+
+two:
+  start: 2012-02-06 23:54:22
+  end: 2012-02-06 23:54:22
+  seconds_elapsed: 1
+  running: false
+  success: false

data/test/functional/mail_spy/core_mailer_test.rb

@@ -1,10 +1,9 @@
 require 'test_helper'
 
 module MailSpy
-  class CoreMailerTest < ActionMailer::TestCase
+  class CoreMailerTest < ActiveSupport::TestCase #ActionMailer::TestCase
 
     def teardown
-      MailSpy::EmailTemplate.delete_all
       MailSpy::Email.delete_all
     end
 
@@ -12,17 +11,25 @@ module MailSpy
       assert true
     end
 
-    def test_template_email_helpers
-      initialize_mail_spy_test_esp
+    def test_subject_evaluation
+      emails = create_emails(:campaign => "tests", :stream => "a-stream", :component => "a-helper_test")
+
 
-      html_erb = "A link : <%= track_link 'My home', 'www.google.com' %> <br> A Bug <%= tracking_bug %>"
-      text_erb = "A link : <%= track_link 'My home', 'www.google.com' %> <br> A Bug <%= tracking_bug %>"
-      template_values_definition = {}
+      email = emails.first
+      email.template_values = {:user_name => "bob"}
+      email.subject = "hi <%= @template_values[:user_name] %>"
+
+      mail = MailSpy::CoreMailer.template(emails.first)
+      assert(mail.subject == "hi bob", "subject lines should be interpreted")
+    end
+
+
+    def test_template_email_helpers
+      create_emails(:campaign => "tests", :stream => "a-stream", :component => "a-helper_test")
 
-      template = MailSpy.add_template("a test template", html_erb, text_erb, template_values_definition)
-      create_emails(template)
       email = MailSpy::Email.first
       mail = MailSpy::CoreMailer.template(email)
+      mail.deliver
 
       assert(mail.present?, "Mail should render without error")
       assert(mail.html_part.body.present?, "Mail should have a html part")

data/test/functional/mail_spy/reports_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module MailSpy
+  class ReportsControllerTest < ActionController::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/functional/mail_spy/sendgrid_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module MailSpy
+  class SendgridControllerTest < ActionController::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/functional/mail_spy/tracking_controller_test.rb

@@ -4,19 +4,12 @@ module MailSpy
   class TrackingControllerTest < ActionController::TestCase
 
     def setup
-      initialize_mail_spy_test_esp
-
-      html_erb = "A link : <%= track_link 'My home', 'www.google.com' %> <br> A Bug <%= tracking_bug %>"
-      text_erb = "A link : <%= track_link 'My home', 'www.google.com' %> <br> A Bug <%= tracking_bug %>"
-      template_values_definition = {}
-
-      template = MailSpy.add_template("a test template", html_erb, text_erb, template_values_definition)
-      create_emails(template)
+      MailSpy::Email.delete_all
+      create_emails(:campaign => "tests", :stream => "a-stream", :component => "a-helper_test")
       @email = MailSpy::Email.first
     end
 
     def teardown
-      MailSpy::EmailTemplate.delete_all
       MailSpy::Email.delete_all
     end
 
@@ -33,7 +26,19 @@ module MailSpy
 
       get "link", params
 
-      assert_redirected_to params[:url]
+      #Load up the generated GA tokens
+      ga_hash = {}
+      email = MailSpy::Email.first
+      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?
+
+      #Parse tokens into uri
+      uri =  URI.parse(params[:url])
+      uri.query = [uri.query, ga_hash.to_param].compact.join('&')
+      assert_redirected_to uri.to_s
 
       email = @email.reload
       details = email.actions.first.details
@@ -74,7 +79,7 @@ module MailSpy
       email = @email.reload
       assert(email.actions.length == 1, "The email should only have on action at this point")
       assert(email.actions.first.action_type == params[:action_type],"Action type should be conversion")
-      assert(email.actions.first.count == params[:count], "the action count should be 1")
+      assert(email.actions.first.count == params[:count], "the action count should be 3")
 
     end
 

data/test/test_email_credentials.yml

@@ -2,8 +2,8 @@ name: sendgrid
 address: smtp.sendgrid.net
 port: 587
 domain: herokuapp.com
-user_name: app2546146@heroku.com
-password: g4eiapwq
+user_name: app2602840@heroku.com
+password: qb6qnim0
 authentication: plain
 enable_starttls_auto: 1
 test_email_address: trcarden@gmail.com

data/test/test_email_credentials.yml.sample

@@ -1,9 +1 @@
-name: sendgrid
-address: smtp.sendgrid.net
-port: 587
-domain: herokuapp.com
-user_name: username
-password: pass
-authentication: plain
-enable_starttls_auto: 1
 test_email_address: test@test.com

data/test/test_helper.rb

@@ -33,23 +33,6 @@ class ActiveSupport::TestCase
   # Add more helper methods to be used by all tests here...
 
 
-
-  # Adds the ESP settings for a test email
-  def initialize_mail_spy_test_esp
-    path = File.expand_path ".././test_email_credentials.yml", __FILE__
-    credentials = YAML.load(File.open(path)).to_options
-    MailSpy.add_email_service_provider do |esp|
-      esp.name = credentials[:name]
-      esp.address = credentials[:address]
-      esp.port = credentials[:port]
-      esp.domain = credentials[:domain]
-      esp.user_name = credentials[:user_name]
-      esp.password = credentials[:password]
-      esp.authentication = credentials[:authentication]
-      esp.enable_starttls_auto = (credentials[:enable_starttls_auto].to_i == 1)
-    end
-  end
-
   # Gets the test email address from the setup file
   def email_address_for_test
     path = File.expand_path ".././test_email_credentials.yml", __FILE__
@@ -57,36 +40,26 @@ class ActiveSupport::TestCase
     credentials[:test_email_address]
   end
 
-  # Provides a template to operate on
-  def do_with_template(&block)
-    template_name = "test"
-    html_erb = "Hello World"
-    text_erb = "Hello World"
-    template_values_definition = {}
-
-    template = MailSpy.add_template(template_name, html_erb, text_erb, template_values_definition)
-    block.call(template)
-  end
+  # Creates a test email
+  def create_emails( options={}, num_emails=1)
+    options.to_options!
 
-  # Creates a test email from a given template
-  def create_emails(template, num_emails=1)
+    emails = []
     num_emails.times do
-      to = email_address_for_test
-      from = "test@test.com"
-      reply_to = "testGuy"
-      subject = "test subject"
-      template_name = template.name
-      campaign = "test campaign"
-      stream = "test stream"
-      component = "test component"
-      schedule_at = DateTime.now
-
-      MailSpy.add_instance(
+      to = options[:to] || email_address_for_test
+      from = options[:from]|| "test@test.com"
+      reply_to = options[:reply_to] || "testGuy"
+      subject = options[:subject] || "test subject"
+      campaign = options[:campaign] || "test campaign"
+      stream = options[:stream] || "test stream"
+      component = options[:component] || "test component"
+      schedule_at = options[:schedule_at] || DateTime.now
+
+      emails << MailSpy.create_email(
         :to => to,
         :from => from,
         :reply_to => reply_to,
         :subject => subject,
-        :template_name => template_name,
         :template_values => {},
         :campaign => campaign,
         :stream => stream,
@@ -94,6 +67,7 @@ class ActiveSupport::TestCase
         :schedule_at => schedule_at
       )
     end
+    return emails
   end
 
 

data/test/unit/helpers/mail_spy/reports_helper_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module MailSpy
+  class ReportsHelperTest < ActionView::TestCase
+  end
+end

data/test/unit/helpers/mail_spy/sendgrid_helper_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module MailSpy
+  class SendgridHelperTest < ActionView::TestCase
+  end
+end

data/test/unit/mail_spy/manager_test.rb

@@ -6,159 +6,138 @@ module MailSpy
       assert true
     end
 
+
     def setup
-      MailSpy::EmailTemplate.delete_all
+      MailSpy::ProcessLog.delete_all
       MailSpy::Email.delete_all
     end
 
-    # ------------------------------------------- ADD_TEMPLATE
-    def test_add_template
-      template_name = "test"
-      html_erb = "Hello World"
-      text_erb = "Hello World"
-      template_values_definition = {}
+    def teardown
+      MailSpy::ProcessLog.delete_all
+    end
 
-      template = MailSpy.add_template(template_name, html_erb, text_erb, template_values_definition)
 
-      assert(template.html_erb == html_erb, "values should be written")
-      assert(template.text_erb == text_erb, "values should be written")
-      assert(template.template_values_definition == template_values_definition, "values should be written")
-      assert(template.name == template_name, "values should be written")
+    # ------------------------------------------- CREATE EMAIL
+    def test_create_email
+      to = "test@test.com"
+      from = "test@test.com"
+      reply_to = "testGuy"
+      subject = "test subject"
+      campaign = "tests"
+      stream = "a-stream"
+      component = "a-helper_test"
+      schedule_at = DateTime.now
+
+      email = MailSpy.create_email(
+        :to => to,
+        :from => from,
+        :reply_to => reply_to,
+        :subject => subject,
+        :template_values => {},
+        :campaign => campaign,
+        :stream => stream,
+        :component => component,
+        :schedule_at => schedule_at
+      )
+
+      assert(email.to == to, "email subject must be set")
+      assert(email.subject == subject, "email subject must be set")
+      assert(email.campaign == campaign, "email campaign must be set")
+      assert(email.stream == stream, "email stream must be set")
+      assert(email.component == component, "email component must be set")
+      assert(email.schedule_at.to_i == schedule_at.to_i, "email schedule_at must be set")
     end
 
-    # ------------------------------------------- ADD_INSTANCE
-    def test_add_instance
-      do_with_template do |template|
-        to = "test@test.com"
-        from = "test@test.com"
-        reply_to = "testGuy"
-        subject = "test subject"
-        template_name = template.name
-        campaign = "test campaign"
-        stream = "test stream"
-        component = "test component"
-        schedule_at = DateTime.now
-
-        email = MailSpy.add_instance(
-          :to => to,
+    def test_missing_sender
+      from = "test@test.com"
+      reply_to = "testGuy"
+      subject = "test subject"
+      campaign = "tests"
+      stream = "a-stream"
+      component = "a-helper_test"
+      schedule_at = DateTime.now
+
+      assert_raise RuntimeError do
+        MailSpy.create_email(
           :from => from,
           :reply_to => reply_to,
           :subject => subject,
-          :template_name => template_name,
           :template_values => {},
           :campaign => campaign,
           :stream => stream,
           :component => component,
           :schedule_at => schedule_at
         )
-
-        assert(email.to == to, "email subject must be set")
-        assert(email.subject == subject, "email subject must be set")
-        assert(email.template_name == template_name, "email template_name must be set")
-        assert(email.campaign == campaign, "email campaign must be set")
-        assert(email.stream == stream, "email stream must be set")
-        assert(email.component == component, "email component must be set")
-        assert(email.schedule_at.to_i == schedule_at.to_i, "email schedule_at must be set")
       end
     end
 
-    def test_missing_sender
-      do_with_template do |template|
-        from = "test@test.com"
-        reply_to = "testGuy"
-        subject = "test subject"
-        template_name = template.name
-        campaign = "test campaign"
-        stream = "test stream"
-        component = "test component"
-        schedule_at = DateTime.now
-
-        assert_raise RuntimeError do
-          MailSpy.add_instance(
-            :from => from,
-            :reply_to => reply_to,
-            :subject => subject,
-            :template_name => template_name,
-            :template_values => {},
-            :campaign => campaign,
-            :stream => stream,
-            :component => component,
-            :schedule_at => schedule_at
-          )
-        end
+    def test_missing_required_field
+
+      to = "test@test.com"
+      from = "test@test.com"
+      reply_to = "testGuy"
+      campaign = "tests"
+      stream = "a-stream"
+      component = "a-helper_test"
+      schedule_at = DateTime.now
+
+      assert_raise RuntimeError do
+        MailSpy.create_email(
+          :to => to,
+          :from => from,
+          :reply_to => reply_to,
+          :template_values => {},
+          :campaign => campaign,
+          :stream => stream,
+          :component => component,
+          :schedule_at => schedule_at
+        )
       end
     end
 
-    def test_missing_required_field
 
-      do_with_template do |template|
-        to = "test@test.com"
-        from = "test@test.com"
-        reply_to = "testGuy"
-        template_name = template.name
-        campaign = "test campaign"
-        stream = "test stream"
-        component = "test component"
-        schedule_at = DateTime.now
-
-        assert_raise RuntimeError do
-          MailSpy.add_instance(
-            :to => to,
-            :from => from,
-            :reply_to => reply_to,
-            :template_name => template_name,
-            :template_values => {},
-            :campaign => campaign,
-            :stream => stream,
-            :component => component,
-            :schedule_at => schedule_at
-          )
-        end
-      end
 
+  def test_referencing_missing_template
+    to = "test@test.com"
+    from = "test@test.com"
+    reply_to = "testGuy"
+    subject = "test subject"
+    campaign = "NO SUCH CAMPAIGN"
+    stream = "NO SUCH STREAM"
+    component = "NO SUCH COMPONENT"
+    schedule_at = DateTime.now
+
+    assert_raise RuntimeError do
+      MailSpy.create_email(
+        :to => to,
+        :subject => subject,
+        :from => from,
+        :reply_to => reply_to,
+        :template_values => {},
+        :campaign => campaign,
+        :stream => stream,
+        :component => component,
+        :schedule_at => schedule_at
+      )
     end
+  end
 
-    def test_referencing_missing_template
-      do_with_template do |template|
-        to = "test@test.com"
-        from = "test@test.com"
-        reply_to = "testGuy"
-        subject = "test subject"
-        campaign = "test campaign"
-        stream = "test stream"
-        component = "test component"
-        schedule_at = DateTime.now
-
-        assert_raise RuntimeError do
-          MailSpy.add_instance(
-            :to => to,
-            :subject => subject,
-            :from => from,
-            :reply_to => reply_to,
-            :template_name => "NOT HERE",
-            :template_values => {},
-            :campaign => campaign,
-            :stream => stream,
-            :component => component,
-            :schedule_at => schedule_at
-          )
-        end
-      end
-    end
+  # ------------------------------------------- SEND_OUTSTANDING_EMAILS
 
-    # ------------------------------------------- SEND_OUTSTANDING_EMAILS
 
-    #TODO need to document the testing methods for setting up the test_email
-    def test_send_outstanding_emails
-      initialize_mail_spy_test_esp
+  def test_send_outstanding_emails
+    create_emails(:campaign => "tests", :stream => "a-stream", :component => "a-helper_test")
 
-      do_with_template do |template|
-        create_emails(template)
-      end
+    num_sent = MailSpy.send_outstanding_emails
+    process_log = MailSpy::ProcessLog.first
+    assert(num_sent == 1, "We should have sent a email")
+
+    assert(process_log.success, "process should have been successful")
+    assert(!process_log.running, "process should have finished")
+  end
+
+  #TODO need to document the testing methods for setting up the test_email
 
-      num_sent = MailSpy.send_outstanding_emails
-      assert(num_sent == 1, "We should have sent a email")
-    end
 
   end
 end

data/test/unit/mail_spy/{email_template_test.rb → process_log_test.rb}

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 module MailSpy
-  class EmailTemplateTest < ActiveSupport::TestCase
+  class ProcessLogTest < ActiveSupport::TestCase
     # test "the truth" do
     #   assert true
     # end