RubyGems - mail_spy - Versions diffs - 0.0.2 - Mend

mail_spy 0.0.2

Files changed (83) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +68 -0
data/Rakefile +40 -0
data/app/assets/javascripts/mail_spy/application.js +15 -0
data/app/assets/javascripts/mail_spy/tracking.js +2 -0
data/app/assets/stylesheets/mail_spy/application.css +13 -0
data/app/assets/stylesheets/mail_spy/tracking.css +4 -0
data/app/controllers/mail_spy/application_controller.rb +4 -0
data/app/controllers/mail_spy/tracking_controller.rb +53 -0
data/app/helpers/mail_spy/application_helper.rb +4 -0
data/app/helpers/mail_spy/email_helper.rb +40 -0
data/app/mailers/mail_spy/core_mailer.rb +55 -0
data/app/models/mail_spy/action.rb +23 -0
data/app/models/mail_spy/campaign_report.rb +6 -0
data/app/models/mail_spy/component_report.rb +6 -0
data/app/models/mail_spy/email.rb +93 -0
data/app/models/mail_spy/email_template.rb +17 -0
data/app/models/mail_spy/stream_report.rb +6 -0
data/app/views/layouts/mail_spy/application.html.erb +14 -0
data/config/routes.rb +7 -0
data/lib/generators/mail_spy/initialize_generator.rb +12 -0
data/lib/generators/mail_spy/templates/mail_spy.rb +25 -0
data/lib/mail_spy/engine.rb +13 -0
data/lib/mail_spy/manager.rb +97 -0
data/lib/mail_spy/version.rb +3 -0
data/lib/mail_spy.rb +36 -0
data/lib/tasks/mail_spy_tasks.rake +40 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config/application.rb +56 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/mongoid.yml +20 -0
data/test/dummy/config/routes.rb +4 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/db/development.sqlite3 +0 -0
data/test/dummy/db/seeds.rb +16 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/log/development.log +212 -0
data/test/dummy/log/test.log +6841 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/fixtures/mail_spy/actions.yml +7 -0
data/test/fixtures/mail_spy/campaign_reports.yml +11 -0
data/test/fixtures/mail_spy/component_reports.yml +11 -0
data/test/fixtures/mail_spy/email_templates.yml +9 -0
data/test/fixtures/mail_spy/emails.yml +15 -0
data/test/fixtures/mail_spy/stream_reports.yml +11 -0
data/test/functional/mail_spy/core_mailer_test.rb +33 -0
data/test/functional/mail_spy/tracking_controller_test.rb +83 -0
data/test/integration/navigation_test.rb +10 -0
data/test/mail_spy_test.rb +7 -0
data/test/test_email_credentials.yml +9 -0
data/test/test_email_credentials.yml.sample +9 -0
data/test/test_helper.rb +107 -0
data/test/unit/helpers/mail_spy/tracking_helper_test.rb +6 -0
data/test/unit/mail_spy/action_test.rb +9 -0
data/test/unit/mail_spy/campaign_report_test.rb +9 -0
data/test/unit/mail_spy/component_report_test.rb +9 -0
data/test/unit/mail_spy/email_template_test.rb +9 -0
data/test/unit/mail_spy/email_test.rb +9 -0
data/test/unit/mail_spy/manager_test.rb +164 -0
data/test/unit/mail_spy/stream_report_test.rb +9 -0
metadata +343 -0

data/test/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED Viewed

File without changes

data/test/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/fixtures/mail_spy/actions.yml ADDED Viewed

@@ -0,0 +1,7 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+one:
+  action_type: MyString
+two:
+  action_type: MyString

data/test/fixtures/mail_spy/campaign_reports.yml ADDED Viewed

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/fixtures/mail_spy/component_reports.yml ADDED Viewed

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/fixtures/mail_spy/email_templates.yml ADDED Viewed

@@ -0,0 +1,9 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+one:
+  html_erb: MyText
+  options:
+two:
+  html_erb: MyText
+  options:

data/test/fixtures/mail_spy/emails.yml ADDED Viewed

@@ -0,0 +1,15 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+one:
+  email_address: MyString
+  user_id: 1
+  campaign: MyString
+  stream: MyString
+  component: MyString
+two:
+  email_address: MyString
+  user_id: 1
+  campaign: MyString
+  stream: MyString
+  component: MyString

data/test/fixtures/mail_spy/stream_reports.yml ADDED Viewed

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/functional/mail_spy/core_mailer_test.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'test_helper'
+module MailSpy
+  class CoreMailerTest < ActionMailer::TestCase
+    def teardown
+      MailSpy::EmailTemplate.delete_all
+      MailSpy::Email.delete_all
+    end
+    test "the truth" do
+      assert true
+    end
+    def test_template_email_helpers
+      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)
+      email = MailSpy::Email.first
+      mail = MailSpy::CoreMailer.template(email)
+      assert(mail.present?, "Mail should render without error")
+      assert(mail.html_part.body.present?, "Mail should have a html part")
+      assert(mail.text_part.body.present?, "Mail should have a text part")
+    end
+  end
+end

data/test/functional/mail_spy/tracking_controller_test.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require 'test_helper'
+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)
+      @email = MailSpy::Email.first
+    end
+    def teardown
+      MailSpy::EmailTemplate.delete_all
+      MailSpy::Email.delete_all
+    end
+    test "the truth" do
+      assert true
+    end
+    def test_link_tracking
+      params = {
+        :eid => @email.id,
+        :url =>"http://google.com",
+        :n => 0
+      }
+      get "link", params
+      assert_redirected_to params[:url]
+      email = @email.reload
+      details = email.actions.first.details
+      assert(email.actions.length == 1, "The email should only have on action at this point")
+      assert(email.actions.first.action_type == MailSpy::Action::ACTION_TYPE_CLICK,"Action type should be click")
+      assert(details[:url] == params[:url], "Url should be recorded")
+      assert(details[:link_number].to_i == params[:n].to_i, "link number should be recorded")
+      assert(email.actions.first.count == 1, "the action count should be 1")
+    end
+    def test_bug_tracking
+      params = {
+        :eid => @email.id,
+      }
+      get "bug", params
+      assert_response :success
+      email = @email.reload
+      assert(email.actions.length == 1, "The email should only have on action at this point")
+      assert(email.actions.first.action_type == MailSpy::Action::ACTION_TYPE_OPEN,"Action type should be open")
+      assert(email.actions.first.count == 1, "the action count should be 1")
+    end
+    def test_action_tracking
+      params = {
+        :eid => @email.id,
+        :action_type => "Conversion",
+        :count => 3
+      }
+      get "action", params
+      assert_response :success
+      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")
+    end
+  end
+end

data/test/integration/navigation_test.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'test_helper'
+class NavigationTest < ActionDispatch::IntegrationTest
+  fixtures :all
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/mail_spy_test.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'test_helper'
+class MailSpyTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, MailSpy
+  end
+end

data/test/test_email_credentials.yml ADDED Viewed

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

data/test/test_email_credentials.yml.sample ADDED Viewed

@@ -0,0 +1,9 @@
+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 ADDED Viewed

@@ -0,0 +1,107 @@
+require 'spork'
+require 'yaml'
+Spork.prefork do
+  # Loading more in this block will cause your tests to run faster. However,
+  # if you change any configuration or code from libraries loaded here, you'll
+  # need to restart spork for it take effect.
+  # Configure Rails Environment
+  ENV["RAILS_ENV"] = "test"
+  require "rails/mongoid"
+  Spork.trap_class_method(Rails::Mongoid, :load_models)
+  require File.expand_path("../dummy/config/environment.rb", __FILE__)
+  require "rails/test_help"
+  Rails.backtrace_cleaner.remove_silencers!
+  # Load support files
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+  #Turn output for tests
+  begin
+    require 'turn'
+  rescue LoadError
+  end
+end
+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__
+    credentials = YAML.load(File.open(path)).to_options
+    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 from a given template
+  def create_emails(template, num_emails=1)
+    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 => to,
+        :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
+  end
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  #fixtures :all
+  #TestNotifier.default_notifier = :growl
+end

data/test/unit/helpers/mail_spy/tracking_helper_test.rb ADDED Viewed

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

data/test/unit/mail_spy/action_test.rb ADDED Viewed

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

data/test/unit/mail_spy/campaign_report_test.rb ADDED Viewed

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

data/test/unit/mail_spy/component_report_test.rb ADDED Viewed

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

data/test/unit/mail_spy/email_template_test.rb ADDED Viewed

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

data/test/unit/mail_spy/email_test.rb ADDED Viewed

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

data/test/unit/mail_spy/manager_test.rb ADDED Viewed

@@ -0,0 +1,164 @@
+require 'test_helper'
+module MailSpy
+  class ManagerTest < ActiveSupport::TestCase
+    test "the truth" do
+      assert true
+    end
+    def setup
+      MailSpy::EmailTemplate.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 = {}
+      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")
+    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,
+          :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
+      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
+    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
+    #TODO need to document the testing methods for setting up the test_email
+    def test_send_outstanding_emails
+      initialize_mail_spy_test_esp
+      do_with_template do |template|
+        create_emails(template)
+      end
+      num_sent = MailSpy.send_outstanding_emails
+      assert(num_sent == 1, "We should have sent a email")
+    end
+  end
+end

data/test/unit/mail_spy/stream_report_test.rb ADDED Viewed

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