email_campaign 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+ruby_string="ruby-1.9.3-p392"
+gemset_name="email_campaign"
+
+alias rails='bundle exec rails'
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+  # Load or create the specified environment
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
+    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
+  else
+    rvm --create  "${ruby_string}@${gemset_name}"
+  fi
+else
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
+fi

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in imagine_cms.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Aaron Namba <aaron@biggerbird.com>
+
+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,36 @@
+=email_campaign
+
+For mailings related to Rails apps, email_campaign is designed to be a more flexible, more integrated (yet well-abstracted) alternative to email campaign services like Campaign Monitor and MailChimp. Designed to use SendGrid for delivery, but this is easy changed.
+
+Does its best to prevent clients from sending too frequently and ruining your sender reputation, but no guarantees.
+
+=Roadmap
+
+0.x: Basic campaign authoring and delivery, using template created by developer as a standard Rails mailer layout.
+1.0: Robust enough for production use, will be able to deal with 90% of common failure modes on its own.
+1.2: Delivery stats and graphs.
+
+=Current Status
+
+Still pre-1.0. If you have some time, write some code or tests, exercise existing functionality on non-critical apps, submit bug reports... otherwise stay away for now.
+
+=Getting Help
+
+Get paid support for EmailCampaign straight from the people who made it: {Bigger Bird Creative, Inc.}[https://www.biggerbird.com] Not required, of course. :-) Free support is up top (Issues).
+
+=Customizing & Contributing
+
+Pull requests always appreciated (recommend getting in touch first). If companies or individuals are willing to sponsor major features on the roadmap (or features that meet their own needs) development can proceed more quickly.
+
+=Dependencies
+
+Developed and tested with MRI ruby 1.9.3.
+
+Dependencies:
+* mail (email)
+
+=License & Copyright
+
+Distributed under MIT license. Copyright (c) 2013 Aaron Namba <aaron@biggerbird.com>
+
+{<img src="https://travis-ci.org/anamba/email_campaign.png" />}[https://travis-ci.org/anamba/email_campaign]

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    = 'EmailCampaign'
+  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/controllers/email_campaigns_controller.rb

@@ -0,0 +1,49 @@
+class EmailCampaignsController < ApplicationController
+  include EmailCampaignsAuthenticator
+  before_filter :check_permissions
+  
+  # define authenticate in your initializer (in main app)
+  
+  def check_permissions
+    render :action => 'permission_denied' unless authenticate
+  end
+  
+  def index
+    # @drafts = EmailCampaign.where(:queued => false)
+    # @queued = EmailCampaign.where(:queued => true, :delivered => false)
+    # @sent = EmailCampaign.where(:delivered => true).order('delivery_finished_at desc')
+  end
+  
+  def new
+    
+  end
+  
+  def create
+    
+  end
+  
+  def show
+    
+  end
+  
+  def edit
+    
+  end
+  
+  def update
+    
+  end
+  
+  def destroy
+    
+  end
+  
+  def deliver
+    
+  end
+  
+  def status
+    
+  end
+  
+end

data/app/models/email_campaign.rb

@@ -0,0 +1,25 @@
+class EmailCampaign < ActiveRecord::Base
+  attr_accessible :name, :mailer, :method, :params_yaml, :deliver_at
+                  :finalized, :queued, :delivered
+  
+  has_many :recipients, :class_name => 'EmailCampaignRecipient'
+  
+  # new_recipients should be an Array of objects that respond to #email, #name, and #subscriber_id
+  # (falls back to #id if #subscriber_id doesn't exist; either way, this id should be unique)
+  def queue(new_recipients, limit = nil)
+    count = 0
+    while rcpt = new_recipients.shift do
+      next unless recipients.where(:subscriber_id => rcpt.subscriber_id).count == 0
+      
+      rcpt.name.strip!
+      rcpt.email_address.strip!
+      
+      r = recipients.create(:name => rcpt.name, :email_address => rcpt.email_address,
+                            :subscriber_class_name => rcpt.class.name, :subscriber_id => rcpt.subscriber_id || rcpt.id)
+      
+      r.queue if count < limit
+      count += 1
+    end
+  end
+  
+end

data/app/models/email_campaign_recipient.rb

@@ -0,0 +1,102 @@
+class EmailCampaignRecipient < ActiveRecord::Base
+  attr_accessible :name, :email_address,
+                  :ready, :duplicate, :invalid_email, :unsubscribed,
+                  :subscriber_class_name, :subscriber_id
+  
+  belongs_to :email_campaign
+  
+  before_save :check_name, :check_for_duplicates, :check_email_address, :check_for_unsubscribe
+  
+  def check_name
+    self.name = nil if name.blank?
+  end
+  
+  def check_for_duplicates
+    if self.class.where(:campaign_id => campaign_id, :email_address => rcpt.email_address).count > 0
+      self.ready = false
+      self.duplicate = true
+    else
+      self.duplicate = false
+    end
+  end
+  
+  def check_email_address
+    if valid_email_address?(rcpt.email_address)
+      self.invalid_email = false
+    else
+      self.ready = false
+      self.invalid_email = true
+    end
+  end
+  
+  def check_for_unsubscribe
+    if self.class.where(:email_address => rcpt.email_address, :unsubscribed => true).count > 0
+      self.unsubscribed = true
+      self.ready = false
+    else
+      self.unsubscribed = false
+    end
+  end
+  
+  def queue
+    if !duplicate && !invalid_email && !unsubscribed
+      update_attributes(:ready => true)
+    else
+      false
+    end
+  end
+  
+  def deliver
+    # if we want to allow retries in the future we can change this bit
+    if attempted && attempts > 0
+      puts "Already attempted, not going to try again."
+      return false
+    end
+    
+    if failed
+      puts "Already failed (reason: #{failure_reason}), not going to try again."
+      return false
+    end
+    
+    unless update_column(:attempted, true) && increment(:attempts)
+      print "Could not update 'attempted' flag, will not proceed for fear of sending multiple copies"
+      return false
+    end
+    
+    if email_address !~ /^[\w\d]+([\w\d\!\#\$\%\&\*\+\-\/\=\?\^\`\{\|\}\~\.]*[\w\d]+)*@([-\w\d]+\.)+[\w]{2,}$/
+      print "Invalid email address: #{email_address}"
+      self.failed = true
+      self.failure_reason = "Invalid email address"
+      save
+      return false
+    end
+    
+    # TODO: wrap this with begin;rescue;end and set failed/failure_reason in case of exception
+    Mailer.email_campaign(self).deliver
+    
+    true
+  end
+  
+  def to_s
+    name.blank? ? email_address : "#{name} <#{email_address}>"
+  end
+  
+  def valid_email_address?(value)
+    begin
+      m = Mail::Address.new(value)
+      # We must check that value contains a domain and that value is an email address
+      r = m.domain && m.address == value
+      t = m.__send__(:tree)
+      # We need to dig into treetop
+      # A valid domain must have dot_atom_text elements size > 1
+      # user@localhost is excluded
+      # treetop must respond to domain
+      # We exclude valid email values like <user@localhost.com>
+      # Hence we use m.__send__(tree).domain
+      r &&= (t.domain.dot_atom_text.elements.size > 1)
+    rescue Exception => e
+      false
+    end
+  end
+  
+end

data/app/views/email_campaigns/index.html.erb

@@ -0,0 +1,36 @@
+<h1>Email Campaigns</h1>
+
+<%= flash_message %>
+
+<h2>Drafts</h2>
+<%- if @drafts.empty? -%>
+  No drafts.
+<%- else -%>
+<ul>
+  <%- @drafts.each do |e| -%>
+  <li><%= link_to e.name, e %></li>
+  <%- end -%>
+</ul>
+<%- end -%>
+
+<h2>Queued for Sending</h2>
+<%- if @queued.empty? -%>
+  Nothing queued.
+<%- else -%>
+<ul>
+  <%- @queued.each do |e| -%>
+  <li><%= link_to e.name, e %></li>
+  <%- end -%>
+</ul>
+<%- end -%>
+
+<h3>Recently Sent</h3>
+<%- if @sent.empty? -%>
+  Nothing sent recently.
+<%- else -%>
+<ul>
+  <%- @sent.each do |e| -%>
+  <li><%= link_to e.name, e %></li>
+  <%- end -%>
+</ul>
+<%- end -%>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  
+  resources :email_campaigns do
+    member do
+      post :deliver
+      get :status
+    end
+  end
+  
+end

data/db/migrate/20130111224331_create_email_campaigns.rb

@@ -0,0 +1,23 @@
+class CreateEmailCampaigns < ActiveRecord::Migration
+  
+  def change
+    create_table :email_campaigns do |t|
+      t.string :name
+      
+      t.string :mailer
+      t.string :method
+      t.text :params_yaml
+      
+      t.datetime :deliver_at
+      
+      t.boolean :finalized, :default => false, :null => false
+      t.boolean :queued, :default => false, :null => false
+      t.boolean :delivered, :default => false, :null => false
+      t.datetime :delivery_started_at
+      t.datetime :delivery_finished_at
+      
+      t.timestamps
+    end
+  end
+  
+end

data/db/migrate/20130111225431_create_email_campaign_recipients.rb

@@ -0,0 +1,46 @@
+class CreateEmailCampaignRecipients < ActiveRecord::Migration
+  
+  def change
+    create_table :email_campaign_recipients do |t|
+      t.integer :email_campaign_id, :null => false
+      
+      t.string :email_address
+      t.string :name
+      
+      t.string :subscriber_class_name
+      t.string :subscriber_id
+      
+      t.string :status
+      
+      t.boolean :ready, :default => false, :null => false
+      
+      t.boolean :duplicate, :default => false, :null => false
+      t.boolean :invalid_email, :default => false, :null => false
+      t.boolean :unsubscribed, :default => false, :null => false
+      
+      t.boolean :attempted, :default => false, :null => false
+      t.integer :attempts, :default => 0, :null => false
+      t.datetime :attempted_at
+      
+      t.boolean :failed, :default => false, :null => false
+      t.datetime :failed_at
+      t.string :failure_reason
+      
+      t.boolean :delivered, :default => false, :null => false
+      t.datetime :delivered_at
+      
+      t.boolean :opened, :default => false, :null => false
+      t.datetime :opened_at
+      t.integer :opens, :default => 0, :null => false
+      
+      t.boolean :clicked, :default => false, :null => false
+      t.datetime :clicked_at
+      t.integer :clicks, :default => 0, :null => false
+      
+      t.timestamps
+    end
+    add_index :email_campaign_recipients, :email_address
+    add_index :email_campaign_recipients, :subscriber_id
+  end
+  
+end

data/email_campaign.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "email_campaign/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "email_campaign"
+  s.version     = EmailCampaign::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Aaron Namba"
+  s.email       = "aaron@biggerbird.com"
+  s.homepage    = "https://github.com/anamba/email_campaign"
+  s.summary     = %q{Email campaign delivery for Rails apps}
+  s.description = %q{See README for details.}
+
+  s.required_ruby_version     = '>= 1.9.3'
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.license = 'MIT'
+  
+  # s.rubyforge_project = "email_campaign"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "actionmailer",        "~> 3.2.12"
+  s.add_dependency "mail",                "~> 2.4.4"
+  s.add_dependency "net-dns",             "~> 0.7.1"
+  
+  s.add_development_dependency "sqlite3"
+end

data/lib/email_campaign/engine.rb

@@ -0,0 +1,18 @@
+module EmailCampaign
+  
+  class Engine < Rails::Engine
+    engine_name 'email_campaign'
+    
+    config.app_root = root
+    middleware.use ::ActionDispatch::Static, "#{root}/public"
+    
+    # initializer "email_campaign.assets.precompile" do |config|
+    #   Rails.application.config.assets.precompile += %w( codepress/** dojo/** management.css reset.css )
+    # end
+    
+    #
+    # activate gems as needed
+    #
+    
+  end
+end

data/lib/email_campaign/version.rb

@@ -0,0 +1,3 @@
+module EmailCampaign
+  VERSION = "0.1.0"
+end

data/lib/email_campaign.rb

@@ -0,0 +1,16 @@
+require "active_support/dependencies"
+
+module EmailCampaign
+  # Our host application root path
+  # We set this when the engine is initialized
+  mattr_accessor :app_root
+  
+  # Yield self on setup for nice config blocks
+  def self.setup
+    yield self
+  end
+  
+end
+
+# Require our engine
+require "email_campaign/engine"

data/script/rails

@@ -0,0 +1,8 @@
+#!/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.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/imagine_cms/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'