email_campaign 0.1.2 → 0.1.3

data/app/helpers/email_campaign/email_helper.rb

@@ -0,0 +1,21 @@
+module EmailCampaign
+  module EmailHelper
+    
+    def email_asset_url(filename)
+      AppBaseURL + url_for(:controller => 'email', :action => 'asset', :method => @method, :filename => filename, :k => @identifier)
+    end
+    
+    def email_link_url(url)
+      AppBaseURL + url_for(:controller => 'email', :action => 'link', :url => url, :k => @identifier)
+    end
+    
+    def email_unsubscribe_url
+      AppBaseURL + url_for(:controller => 'email', :action => 'unsubscribe', :k => @identifier)
+    end
+    
+    def email_web_version_url
+      AppBaseURL + url_for(:controller => 'email', :action => 'web_version', :method => @method, :k => @identifier)
+    end
+    
+  end
+end

data/app/models/email_campaign/campaign.rb

@@ -1,5 +1,5 @@
 class EmailCampaign::Campaign < ActiveRecord::Base
-  set_table_name "email_campaigns"
+  self.table_name = 'email_campaigns'
   
   attr_accessible :name, :mailer, :method, :params_yaml, :deliver_at,
                   :finalized, :queued, :delivered,
@@ -9,22 +9,42 @@ class EmailCampaign::Campaign < ActiveRecord::Base
   
   # 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, id should be unique within campaign)
-  def add_recipients(new_recipients, limit = nil)
+  def add_recipients(new_recipients)
     new_recipients = [ new_recipients ] unless new_recipients.is_a?(Array)
     
-    count = 0
+    processed = 0
+    skipped = 0
+    valid = 0
+    invalid = 0
+    duplicate = 0
+    unsubscribed = 0
+    
     new_recipients.each do |rcpt|
       subscriber_id = rcpt.subscriber_id || rcpt.id
-      # next if subscriber_id && recipients.where(:subscriber_id => subscriber_id).count > 0
+      
+      if subscriber_id && recipients.where(:subscriber_id => subscriber_id).count > 0
+        skipped += 1
+        next
+      end
       
       r = recipients.create(:name => rcpt.name.strip, :email_address => rcpt.email_address.strip,
                             :subscriber_class_name => rcpt.class.name, :subscriber_id => subscriber_id)
       
-      r.queue unless limit && count >= limit
-      count += 1
+      processed += 1
+      case
+        when r.unsubscribed then unsubscribed += 1
+        when r.duplicate then duplicate += 1
+        when r.invalid_email then invalid += 1
+        else valid += 1
+      end
+      
+      r.queue
     end
     
-    recipients.where(:ready => true).count
+    { :processed => processed, :skipped => skipped,
+      :valid => valid, :invalid => invalid,
+      :duplicate => duplicate, :unsubscribed => unsubscribed,
+      :total => recipients.where(:ready => true).count }
   end
   
   def queue(deliver_at = Time.now.utc)
@@ -45,21 +65,11 @@ class EmailCampaign::Campaign < ActiveRecord::Base
       process_delivery
     end
     
-    # update_attributes(:delivered => true, :delivered_at => Time.now.utc)
-    update_attributes(:delivered => true, :delivery_finished_at => Time.now.utc)
+    update_attributes(:queued => false, :delivered => true, :delivery_finished_at => Time.now.utc)
   end
   
   def process_delivery
-    sent = []
-    error = []
-    recipients.where(:ready => true).each do |r|
-      # begin
-        mailer.constantize.send(method.to_sym, r).deliver
-        sent << r
-      # rescue Exception => e
-        # error << [ r, e ]
-      # end
-    end
+    recipients.where(:ready => true).each(&:deliver)
   end
   
 end

data/app/models/email_campaign/recipient.rb

@@ -1,13 +1,40 @@
 class EmailCampaign::Recipient < ActiveRecord::Base
-  set_table_name "email_campaign_recipients"
+  self.table_name = 'email_campaign_recipients'
   
   attr_accessible :name, :email_address,
+                  :subscriber_class_name, :subscriber_id,
                   :ready, :duplicate, :invalid_email, :unsubscribed,
-                  :subscriber_class_name, :subscriber_id
+                  :failed, :failed_at, :failure_reason,
+                  :delivered, :delivered_at
   
   belongs_to :campaign, :class_name => 'EmailCampaign::Campaign', :foreign_key => 'email_campaign_id'
   
-  before_save :check_name, :check_for_duplicates, :check_email_address, :check_for_unsubscribe
+  validates_presence_of :email_address, :subscriber_id
+  
+  before_create :generate_identifier, :check_for_duplicates, :check_for_unsubscribe
+  before_save :check_name, :check_email_address
+  
+  def generate_identifier(regenerate = false)
+    return identifier if identifier && !regenerate
+    
+    attempts = 0
+    new_identifier = nil
+    
+    # 28^8 = 378 billion possibilities
+    validchars = 'ABCDEFGHJKLMNPQRTUVWXY346789'
+    
+    while new_identifier.nil? && attempts < 10
+      # generate a 8 character identifier
+      new_identifier = ''
+      8.times { new_identifier << validchars[rand(validchars.length)] }
+      
+      new_identifier = nil if self.class.count > 0 && self.class.where(:identifier => new_identifier).first
+      
+      attempts += 1
+    end
+    
+    self.identifier = new_identifier
+  end
   
   def check_name
     self.name = nil if name.blank?
@@ -16,7 +43,7 @@ class EmailCampaign::Recipient < ActiveRecord::Base
   end
   
   def check_for_duplicates
-    if self.campaign.recipients.where(:email_address => email_address).where('id != ?', id).count > 0
+    if campaign.recipients.where(:email_address => email_address).count > 0
       self.ready = false
       self.duplicate = true
     else
@@ -41,52 +68,125 @@ class EmailCampaign::Recipient < ActiveRecord::Base
     if self.class.where(:email_address => email_address, :unsubscribed => true).count > 0
       self.unsubscribed = true
       self.ready = false
-    else
-      self.unsubscribed = false
     end
     
     true
   end
   
   def queue
-    if !duplicate && !invalid_email && !unsubscribed
+    if !duplicate && !invalid_email && !unsubscribed && !failed
       update_attributes(:ready => true)
     else
       false
     end
   end
   
+  # resets failed and delivered flags... use sparingly
+  def requeue
+    queue && update_attributes(:failed => false, :failed_at => nil, :failure_reason => nil,
+                               :delivered => false, :delivered_at => nil)
+  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."
+    if !ready
+      puts "Not in ready state"
       return false
     end
     
+    if delivered
+      puts "Already delivered."
+      return true  # not sure yet whether returning true is a good idea, but seems harmless enough
+    end
+    
     if failed
       puts "Already failed (reason: #{failure_reason}), not going to try again."
+      update_attributes(:ready => false)
       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"
+      puts "Could not update 'attempted' flag, will not proceed for fear of sending multiple copies"
+      update_attributes(:ready => false, :failed => true, :failed_at => Time.now.utc, :failure_reason => "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
+    if !valid_email_address?(email_address)
+      puts "Invalid email address: #{email_address}"
+      update_attributes(:ready => false, :failed => true, :failed_at => Time.now.utc, :failure_reason => "Invalid email address")
       return false
     end
     
-    # TODO: wrap this with begin;rescue;end and set failed/failure_reason in case of exception
-    Mailer.email_campaign(self).deliver
+    begin
+      campaign.mailer.constantize.send(campaign.method.to_sym, self).deliver
+      update_attributes(:ready => false, :delivered => true, :delivered_at => Time.now.utc)
+    rescue Exception => e
+      puts e.message
+      update_attributes(:ready => false, :failed => true, :failed_at => Time.now.utc, :failure_reason => "#{e.class.name}: #{e.message}")
+      return false
+    end
     
     true
   end
   
+  def self.record_open(identifier, params = {})
+    r = find_by_identifier(identifier)
+    r.record_open(params) if r
+  end
+  
+  def record_open(params = {})
+    self.class.transaction do
+      self.opened = true
+      self.opened_at ||= Time.now.utc
+      self.opens += 1
+      save
+    end
+  end
+  
+  def self.record_click(identifier, params = {})
+    r = find_by_identifier(identifier)
+    r.record_click(params) if r
+  end
+  
+  def record_click(params = nil)
+    self.class.transaction do
+      self.opened = true
+      self.opened_at ||= Time.now.utc
+      self.opens ||= 1
+      self.clicked = true
+      self.clicked_at ||= Time.now.utc
+      self.clicks += 1
+    end
+  end
+  
+  def self.unsubscribe(identifier, params = {})
+    r = find_by_identifier(identifier)
+    r.unsubscribe(params) if r
+  end
+  
+  def unsubscribe(params = nil)
+    self.class.transaction do
+      self.class.where(:email_address => email_address, :unsubscribed => false).each do |r|
+        r.update_attributes(:unsubscribed => true, :ready => false)
+      end
+    end
+    save
+  end
+  
+  def self.resubscribe(identifier, params = {})
+    r = find_by_identifier(identifier)
+    r.resubscribe(params) if r
+  end
+  
+  def resubscribe(params = nil)
+    self.class.transaction do
+      self.class.where(:email_address => email_address, :unsubscribed => true).each do |r|
+        r.update_attributes(:unsubscribed, false)
+      end
+    end
+  end
+  
+  
+  
   def to_s
     name.blank? ? email_address : "#{name} <#{email_address}>"
   end

data/db/migrate/201302281520_add_recipient_identifier.rb

@@ -0,0 +1,8 @@
+class AddRecipientIdentifier < ActiveRecord::Migration
+  
+  def change
+    add_column :email_campaign_recipients, :identifier, :string, :limit => 35
+    add_index :email_campaign_recipients, :identifier
+  end
+  
+end

data/lib/email_campaign/version.rb

@@ -1,3 +1,3 @@
 module EmailCampaign
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_campaign
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -108,12 +108,14 @@ files:
 - app/assets/stylesheets/application.css
 - app/controllers/email_campaigns_controller.rb
 - app/helpers/.gitkeep
+- app/helpers/email_campaign/email_helper.rb
 - app/models/email_campaign/campaign.rb
 - app/models/email_campaign/recipient.rb
 - app/views/email_campaigns/index.html.erb
 - config/routes.rb
 - db/migrate/20130111224331_create_email_campaigns.rb
 - db/migrate/20130111225431_create_email_campaign_recipients.rb
+- db/migrate/201302281520_add_recipient_identifier.rb
 - email_campaign.gemspec
 - lib/email_campaign.rb
 - lib/email_campaign/engine.rb