smailer 0.7.8 → 0.8.0

data/generators/smailer/templates/migration.rb.erb

@@ -1,88 +1,105 @@
 class CreateSmailerTables < ActiveRecord::Migration
   def self.up
-    create_table "mailing_lists", :force => true do |t|
-      t.string   "name"
+    create_table "finished_mails", :force => :cascade do |t|
+      t.integer  "mail_campaign_id"
+      t.string   "from"
+      t.string   "to"
+      t.string   "subject"
+      t.text     "body_html"
+      t.integer  "retries"
+      t.datetime "last_retry_at"
+      t.string   "last_error"
+      t.datetime "sent_at"
+      t.integer  "status"
       t.datetime "created_at"
       t.datetime "updated_at"
+      t.text     "body_text"
+      t.boolean  "opened",           :default => false, :null => false
+      t.string   "key"
     end
 
-    create_table "mail_campaigns", :force => true do |t|
+    add_index "finished_mails", ["key"], :name => "index_finished_mails_on_key", :unique => true
+    add_index "finished_mails", ["mail_campaign_id", "status"], :name => "index_finished_mails_on_mail_campain_id_and_status"
+    add_index "finished_mails", ["to", "mail_campaign_id"], :name => "index_finished_mails_on_to_and_mail_campaign_id"
+
+    create_table "mail_attachments", :force => :cascade do |t|
+      t.string   "filename",                      :null => false
+      t.string   "path",             :limit => 2048
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.integer  "mail_template_id"
+    end
+
+    add_index "mail_attachments", ["mail_template_id"], :name => "index_mail_attachments_on_mail_template_id"
+
+    create_table "mail_campaigns", :force => :cascade do |t|
       t.integer  "mailing_list_id"
-      t.string   "from"
-      t.string   "subject"
-      t.text     "body_html"
       t.integer  "unsubscribe_methods"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.text     "body_text"
       t.integer  "sent_mails_count",    :default => 0, :null => false
       t.integer  "opened_mails_count",  :default => 0, :null => false
     end
+
     add_index "mail_campaigns", ["mailing_list_id"], :name => "index_mail_campaigns_on_mailing_list_id"
 
-    create_table "queued_mails", :force => true do |t|
+    create_table "mail_keys", :force => :cascade do |t|
+      t.string   "email"
+      t.string   "key"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index "mail_keys", ["email"], :name => "index_mail_keys_on_email", :unique => true
+    add_index "mail_keys", ["key"], :name => "index_mail_keys_on_key", :unique => true
+
+    create_table "mail_templates", :force => :cascade do |t|
       t.integer  "mail_campaign_id"
-      t.string   "to"
-      t.integer  "retries",          :default => 0, :null => false
-      t.datetime "last_retry_at"
-      t.string   "last_error"
-      t.boolean  "locked",           :default => false, :null => false
-      t.datetime "locked_at"
+      t.integer  "queued_mail_id"
+      t.string   "from"
+      t.string   "subject"
+      t.text     "body_html"
+      t.text     "body_text"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.string   "key"
     end
-    add_index "queued_mails", ["mail_campaign_id", "to"], :name => "index_queued_mails_on_mail_campain_id_and_to", :unique => true
-    add_index "queued_mails", ["retries", "locked"], :name => "index_queued_mails_on_retries_and_locked"
-    add_index "queued_mails", ["locked", "retries", "id"], :name => "index_queued_mails_on_locked_retries_and_id"
-    add_index "queued_mails", ["locked", "locked_at"], :name => "index_queued_mails_on_locked_and_locked_at"
 
-    create_table "mail_campaign_attachments", :force => true do |t|
-      t.integer "mail_campaign_id", :null => false
-      t.string "filename", :null => false
-      t.string "path", :limit => 2048
+    add_index "mail_templates", ["mail_campaign_id"], :name => "index_mail_templates_on_mail_campaign_id"
+    add_index "mail_templates", ["queued_mail_id"], :name => "index_mail_templates_on_queued_mail_id"
+
+    create_table "mailing_lists", :force => :cascade do |t|
+      t.string   "name"
       t.datetime "created_at"
       t.datetime "updated_at"
     end
-    add_index "mail_campaign_attachments", "mail_campaign_id"
 
-    create_table "finished_mails", :force => true do |t|
+    create_table "queued_mails", :force => :cascade do |t|
       t.integer  "mail_campaign_id"
-      t.string   "from"
       t.string   "to"
-      t.string   "subject"
-      t.text     "body_html"
-      t.integer  "retries"
+      t.integer  "retries",            :default => 0,     :null => false
       t.datetime "last_retry_at"
       t.string   "last_error"
-      t.datetime "sent_at"
-      t.integer  "status"
+      t.boolean  "locked",             :default => false, :null => false
+      t.datetime "locked_at"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.text     "body_text"
-      t.boolean  "opened",           :default => false, :null => false
       t.string   "key"
+      t.boolean  "require_uniqueness", :default => true
     end
-    add_index "finished_mails", ["key"], :name => "index_finished_mails_on_key", :unique => true
-    add_index "finished_mails", ["mail_campaign_id", "status"], :name => "index_finished_mails_on_mail_campain_id_and_status"
-    add_index "finished_mails", ["to", "mail_campaign_id"], :name => "index_finished_mails_on_to_and_mail_campaign_id"
 
-    create_table "mail_keys", :force => true do |t|
-      t.string   "email"
-      t.string   "key"
-      t.datetime "created_at"
-      t.datetime "updated_at"
-    end
-    add_index "mail_keys", ["email"], :name => "index_mail_keys_on_email", :unique => true
-    add_index "mail_keys", ["key"], :name => "index_mail_keys_on_key", :unique => true
+    add_index "queued_mails", ["locked", "locked_at"], :name => "index_queued_mails_on_locked_and_locked_at"
+    add_index "queued_mails", ["locked", "retries", "id"], :name => "index_queued_mails_on_locked_retries_and_id"
+    add_index "queued_mails", ["mail_campaign_id", "to", "require_uniqueness"], :name => "index_queued_mails_uniqueness_for_to", :unique => true
+    add_index "queued_mails", ["retries", "locked"], :name => "index_queued_mails_on_retries_and_locked"
 
-    create_table "smailer_properties", :force => true do |t|
+    create_table "smailer_properties", :force => :cascade do |t|
       t.string   "name"
       t.text     "value"
       t.datetime "created_at"
       t.datetime "updated_at"
       t.string   "notes"
     end
+
     add_index "smailer_properties", ["name"], :name => "index_smailer_properties_on_name", :unique => true
   end
 
@@ -91,8 +108,9 @@ class CreateSmailerTables < ActiveRecord::Migration
     drop_table :mail_keys
     drop_table :finished_mails
     drop_table :queued_mails
-    drop_table :mail_campaign_attachments
+    drop_table :mail_attachments
     drop_table :mail_campaigns
+    drop_table :mail_templates
     drop_table :mailing_lists
   end
-end
+end

data/lib/generators/smailer/templates/migration.rb.erb

@@ -1,88 +1,105 @@
 class CreateSmailerTables < ActiveRecord::Migration
   def self.up
-    create_table "mailing_lists", :force => true do |t|
-      t.string   "name"
+    create_table "finished_mails", :force => :cascade do |t|
+      t.integer  "mail_campaign_id"
+      t.string   "from"
+      t.string   "to"
+      t.string   "subject"
+      t.text     "body_html"
+      t.integer  "retries"
+      t.datetime "last_retry_at"
+      t.string   "last_error"
+      t.datetime "sent_at"
+      t.integer  "status"
       t.datetime "created_at"
       t.datetime "updated_at"
+      t.text     "body_text"
+      t.boolean  "opened",           :default => false, :null => false
+      t.string   "key"
     end
 
-    create_table "mail_campaigns", :force => true do |t|
+    add_index "finished_mails", ["key"], :name => "index_finished_mails_on_key", :unique => true
+    add_index "finished_mails", ["mail_campaign_id", "status"], :name => "index_finished_mails_on_mail_campain_id_and_status"
+    add_index "finished_mails", ["to", "mail_campaign_id"], :name => "index_finished_mails_on_to_and_mail_campaign_id"
+
+    create_table "mail_attachments", :force => :cascade do |t|
+      t.string   "filename",                      :null => false
+      t.string   "path",             :limit => 2048
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.integer  "mail_template_id"
+    end
+
+    add_index "mail_attachments", ["mail_template_id"], :name => "index_mail_attachments_on_mail_template_id"
+
+    create_table "mail_campaigns", :force => :cascade do |t|
       t.integer  "mailing_list_id"
-      t.string   "from"
-      t.string   "subject"
-      t.text     "body_html"
       t.integer  "unsubscribe_methods"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.text     "body_text"
       t.integer  "sent_mails_count",    :default => 0, :null => false
       t.integer  "opened_mails_count",  :default => 0, :null => false
     end
+
     add_index "mail_campaigns", ["mailing_list_id"], :name => "index_mail_campaigns_on_mailing_list_id"
 
-    create_table "queued_mails", :force => true do |t|
+    create_table "mail_keys", :force => :cascade do |t|
+      t.string   "email"
+      t.string   "key"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index "mail_keys", ["email"], :name => "index_mail_keys_on_email", :unique => true
+    add_index "mail_keys", ["key"], :name => "index_mail_keys_on_key", :unique => true
+
+    create_table "mail_templates", :force => :cascade do |t|
       t.integer  "mail_campaign_id"
-      t.string   "to"
-      t.integer  "retries",          :default => 0, :null => false
-      t.datetime "last_retry_at"
-      t.string   "last_error"
-      t.boolean  "locked",           :default => false, :null => false
-      t.datetime "locked_at"
+      t.integer  "queued_mail_id"
+      t.string   "from"
+      t.string   "subject"
+      t.text     "body_html"
+      t.text     "body_text"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.string   "key"
     end
-    add_index "queued_mails", ["mail_campaign_id", "to"], :name => "index_queued_mails_on_mail_campain_id_and_to", :unique => true
-    add_index "queued_mails", ["retries", "locked"], :name => "index_queued_mails_on_retries_and_locked"
-    add_index "queued_mails", ["locked", "retries", "id"], :name => "index_queued_mails_on_locked_retries_and_id"
-    add_index "queued_mails", ["locked", "locked_at"], :name => "index_queued_mails_on_locked_and_locked_at"
 
-    create_table "mail_campaign_attachments", :force => true do |t|
-      t.integer "mail_campaign_id", :null => false
-      t.string "filename", :null => false
-      t.string "path", :limit => 2048
+    add_index "mail_templates", ["mail_campaign_id"], :name => "index_mail_templates_on_mail_campaign_id"
+    add_index "mail_templates", ["queued_mail_id"], :name => "index_mail_templates_on_queued_mail_id"
+
+    create_table "mailing_lists", :force => :cascade do |t|
+      t.string   "name"
       t.datetime "created_at"
       t.datetime "updated_at"
     end
-    add_index "mail_campaign_attachments", "mail_campaign_id"
 
-    create_table "finished_mails", :force => true do |t|
+    create_table "queued_mails", :force => :cascade do |t|
       t.integer  "mail_campaign_id"
-      t.string   "from"
       t.string   "to"
-      t.string   "subject"
-      t.text     "body_html"
-      t.integer  "retries"
+      t.integer  "retries",            :default => 0,     :null => false
       t.datetime "last_retry_at"
       t.string   "last_error"
-      t.datetime "sent_at"
-      t.integer  "status"
+      t.boolean  "locked",             :default => false, :null => false
+      t.datetime "locked_at"
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.text     "body_text"
-      t.boolean  "opened",           :default => false, :null => false
       t.string   "key"
+      t.boolean  "require_uniqueness", :default => true
     end
-    add_index "finished_mails", ["key"], :name => "index_finished_mails_on_key", :unique => true
-    add_index "finished_mails", ["mail_campaign_id", "status"], :name => "index_finished_mails_on_mail_campain_id_and_status"
-    add_index "finished_mails", ["to", "mail_campaign_id"], :name => "index_finished_mails_on_to_and_mail_campaign_id"
 
-    create_table "mail_keys", :force => true do |t|
-      t.string   "email"
-      t.string   "key"
-      t.datetime "created_at"
-      t.datetime "updated_at"
-    end
-    add_index "mail_keys", ["email"], :name => "index_mail_keys_on_email", :unique => true
-    add_index "mail_keys", ["key"], :name => "index_mail_keys_on_key", :unique => true
+    add_index "queued_mails", ["locked", "locked_at"], :name => "index_queued_mails_on_locked_and_locked_at"
+    add_index "queued_mails", ["locked", "retries", "id"], :name => "index_queued_mails_on_locked_retries_and_id"
+    add_index "queued_mails", ["mail_campaign_id", "to", "require_uniqueness"], :name => "index_queued_mails_uniqueness_for_to", :unique => true
+    add_index "queued_mails", ["retries", "locked"], :name => "index_queued_mails_on_retries_and_locked"
 
-    create_table "smailer_properties", :force => true do |t|
+    create_table "smailer_properties", :force => :cascade do |t|
       t.string   "name"
       t.text     "value"
       t.datetime "created_at"
       t.datetime "updated_at"
       t.string   "notes"
     end
+
     add_index "smailer_properties", ["name"], :name => "index_smailer_properties_on_name", :unique => true
   end
 
@@ -91,8 +108,9 @@ class CreateSmailerTables < ActiveRecord::Migration
     drop_table :mail_keys
     drop_table :finished_mails
     drop_table :queued_mails
-    drop_table :mail_campaign_attachments
+    drop_table :mail_attachments
     drop_table :mail_campaigns
+    drop_table :mail_templates
     drop_table :mailing_lists
   end
-end
+end

data/lib/smailer/models.rb

@@ -1,11 +1,12 @@
 module Smailer
   module Models
     autoload :MailingList,    'smailer/models/mailing_list'
+    autoload :MailTemplate,   'smailer/models/mail_template'
     autoload :MailCampaign,   'smailer/models/mail_campaign'
-    autoload :MailCampaignAttachment, 'smailer/models/mail_campaign_attachment'
+    autoload :MailAttachment, 'smailer/models/mail_attachment'
     autoload :MailKey,        'smailer/models/mail_key'
     autoload :QueuedMail,     'smailer/models/queued_mail'
     autoload :FinishedMail,   'smailer/models/finished_mail'
     autoload :Property,       'smailer/models/property'
   end
-end
+end

data/lib/smailer/models/{mail_campaign_attachment.rb → mail_attachment.rb}

@@ -2,18 +2,16 @@ require 'open-uri'
 
 module Smailer
   module Models
-    class MailCampaignAttachment < ActiveRecord::Base
+    class MailAttachment < ActiveRecord::Base
+      belongs_to :mail_template, :inverse_of => :attachments
 
-      belongs_to :mail_campaign
-      validates_presence_of :mail_campaign_id
-      validates_numericality_of :mail_campaign_id
       validates_presence_of :path
       validates_presence_of :filename
+      validates_presence_of :mail_template
 
       def body
         open(self.path).read
       end
-
     end
   end
 end

data/lib/smailer/models/mail_campaign.rb

@@ -10,8 +10,11 @@ module Smailer
       belongs_to :mailing_list
       has_many :queued_mails, :dependent => :destroy
       has_many :finished_mails, :dependent => :destroy
-      has_many :attachments,
-               :class_name => '::Smailer::Models::MailCampaignAttachment'
+
+      has_one :mail_template, :dependent => :destroy, :autosave => true, :inverse_of => :mail_campaign
+
+      delegate :from,  :subject,  :body_html,  :body_text,  :to => :my_mail_template, :allow_nil => true
+      delegate :from=, :subject=, :body_html=, :body_text=, :to => :my_mail_template
 
       validates_presence_of :mailing_list_id, :from
       validates_numericality_of :mailing_list_id, :unsubscribe_methods, :only_integer => true, :allow_nil => true
@@ -54,8 +57,12 @@ module Smailer
         opened_mails_count.to_f / sent_mails_count
       end
 
+      def attachments
+        my_mail_template.attachments
+      end
+
       def add_attachment(filename, path)
-        self.attachments.create!(:filename => filename, :path => path)
+        my_mail_template.attachments.build(:filename => filename, :path => path)
       end
 
       def self.unsubscribe_methods
@@ -69,6 +76,10 @@ module Smailer
 
       private
 
+      def my_mail_template
+        mail_template || build_mail_template
+      end
+
       def unsubscribe_methods_list_from(method_specification)
         if method_specification == :all
           self.class.unsubscribe_methods.keys
@@ -78,4 +89,4 @@ module Smailer
       end
     end
   end
-end
+end

data/lib/smailer/models/mail_template.rb

@@ -0,0 +1,13 @@
+module Smailer
+  module Models
+    class MailTemplate < ActiveRecord::Base
+      belongs_to :mail_campaign, :inverse_of => :mail_template
+      belongs_to :queued_mail, :inverse_of => :mail_template
+
+      has_many :attachments, :class_name => '::Smailer::Models::MailAttachment', :autosave => true, :inverse_of => :mail_template
+
+      validates_presence_of :from
+      validates_length_of :from, :subject, :maximum => 255, :allow_nil => true
+    end
+  end
+end

data/lib/smailer/models/queued_mail.rb

@@ -1,31 +1,39 @@
 require 'digest/md5'
+require 'securerandom'
 
 module Smailer
   module Models
     class QueuedMail < ActiveRecord::Base
       belongs_to :mail_campaign
 
+      has_one :mail_template, :dependent => :destroy, :autosave => true, :inverse_of => :queued_mail
+      has_many :attachments, :through => :mail_template
+
       validates_presence_of :mail_campaign_id, :to
-      validates_uniqueness_of :to, :scope => :mail_campaign_id
+      validates_uniqueness_of :to, :scope => :mail_campaign_id, :if => proc { |queued_mail| queued_mail.require_uniqueness }
       validates_uniqueness_of :key
       validates_numericality_of :mail_campaign_id, :retries, :only_integer => true, :allow_nil => true
       validates_length_of :to, :last_error, :maximum => 255, :allow_nil => true
 
       unless Smailer::Compatibility.rails_4?
-        attr_accessible :mail_campaign_id, :to
+        attr_accessible :mail_campaign_id, :to, :from, :subject, :body_html, :body_text, :require_uniqueness
       end
 
-      delegate :from, :subject, :mailing_list, :to => :mail_campaign, :allow_nil => true
-
       before_validation :initialize_message_key
       before_save :initialize_message_key
 
+      before_save :nullify_false_require_uniqueness
+
+      delegate :mailing_list, :to => :mail_campaign, :allow_nil => true
+      delegate :from, :subject, :to => :active_mail_template, :allow_nil => true
+      delegate :from=, :subject=, :body_html=, :body_text, :to => :my_mail_template
+
       def body_html
-        interpolate mail_campaign.body_html
+        interpolate active_mail_template.body_html
       end
 
       def body_text
-        interpolate mail_campaign.body_text
+        interpolate active_mail_template.body_text
       end
 
       def key
@@ -33,10 +41,39 @@ module Smailer
         self[:key]
       end
 
+      def attachments
+        active_mail_template.attachments
+      end
+
+      def add_attachment(filename, path)
+        my_mail_template.attachments.build(:filename => filename, :path => path)
+      end
+
       protected
 
+      def active_mail_template
+        mail_template || mail_campaign.try(:mail_template)
+      end
+
+      def my_mail_template
+        return mail_template if mail_template.present?
+
+        build_mail_template.tap do |template|
+          if mail_campaign.present?
+            campaign_template = mail_campaign.mail_template
+
+            template.from      = campaign_template.from
+            template.subject   = campaign_template.subject
+            template.body_html = campaign_template.body_html
+            template.body_text = campaign_template.body_text
+
+            template.attachments = campaign_template.attachments.map(&:dup)
+          end
+        end
+      end
+
       def initialize_message_key
-        self.key = Digest::MD5.hexdigest("#{mail_campaign_id}, #{to} and #{id} compose this key.")
+        self.key = Digest::MD5.hexdigest("#{mail_campaign_id}, #{to}, #{SecureRandom.hex(15)} and #{id} compose this key.")
       end
 
       def interpolate(text)
@@ -57,6 +94,13 @@ module Smailer
 
         text
       end
+
+      # Prevents the unique index in the database from firing
+      def nullify_false_require_uniqueness
+        unless self.require_uniqueness
+          self.require_uniqueness = nil
+        end
+      end
     end
   end
 end