smailer 0.1.0 → 0.2.0

data/README.md

@@ -16,6 +16,11 @@ Then run `bundle install` and you should be ready to go.
 
 TODO
 
+## TODO
+
+* Add a migration generator
+* Tests, tests, tests
+
 ## Contribution
 
 Patches are always welcome. In case you find any issues with this code, please use the project's [Issues](http://github.com/mitio/smailer/issues) page on Github to report them. Feel free to contribute! :)

data/lib/smailer.rb

@@ -1,5 +1,6 @@
 module Smailer
-  autoload :VERSION,      'smailer/version'
-  autoload :Models,       'smailer/models'
-  autoload :Tasks,        'smailer/tasks'
+  autoload :VERSION,        'smailer/version'
+  autoload :Models,         'smailer/models'
+  autoload :Tasks,          'smailer/tasks'
+  autoload :Compatibility,  'smailer/compatibility'
 end

data/lib/smailer/compatibility.rb

@@ -0,0 +1,11 @@
+module Smailer
+  module Compatibility
+    def self.rails_3?
+      Rails::VERSION::MAJOR == 3
+    end
+
+    def self.save_without_validation(object)
+      rails_3? ? object.save(:validate => false) : save(false)
+    end
+  end
+end

data/lib/smailer/models/finished_mail.rb

@@ -11,9 +11,12 @@ module Smailer
       validates_presence_of :mail_campaign_id, :from, :to, :retries, :status
       validates_numericality_of :mail_campaign_id, :retries, :status, :only_integer => true, :allow_nil => true
       validates_length_of :from, :to, :subject, :last_error, :maximum => 255
+      validates_uniqueness_of :key, :allow_nil => true
 
       delegate :mailing_list, :to => :mail_campaign, :allow_nil => true
 
+      before_save :update_mail_campaign_counts
+
       def status_text
         Statuses.constants.each do |constant_name|
           return constant_name if Statuses.const_get(constant_name) == status
@@ -21,10 +24,15 @@ module Smailer
         nil
       end
 
+      def opened!
+        self.opened = true
+        Compatibility.save_without_validation self if changed?
+      end
+
       def self.add(queued_mail, status = Statuses::SENT)
         finished = self.new
 
-        [:mail_campaign_id, :from, :to, :subject, :body_html, :body_text, :retries, :last_retry_at, :last_error].each do |field|
+        [:mail_campaign_id, :key, :from, :to, :subject, :body_html, :body_text, :retries, :last_retry_at, :last_error].each do |field|
           finished.send("#{field}=", queued_mail.send(field))
         end
 
@@ -34,8 +42,22 @@ module Smailer
         finished.save!
         queued_mail.destroy
 
+        if finished.mail_campaign
+          finished.mail_campaign.sent_mails_count += 1
+          Compatibility.save_without_validation finished.mail_campaign
+        end
+
         finished
       end
+
+      protected
+
+      def update_mail_campaign_counts
+        if opened_changed?
+          mail_campaign.opened_mails_count += opened_was ? -1 : 1
+          Compatibility.save_without_validation mail_campaign
+        end
+      end
     end
   end
 end

data/lib/smailer/models/mail_campaign.rb

@@ -41,6 +41,11 @@ module Smailer
         "Campaign ##{id} (#{mailing_list.name})"
       end
 
+      def hit_rate
+        return nil if sent_mails_count == 0
+        opened_mails_count.to_f / sent_mails_count
+      end
+
       def self.unsubscribe_methods
         methods = {}
         UnsubscribeMethods.constants.map do |method_name|

data/lib/smailer/models/queued_mail.rb

@@ -1,3 +1,5 @@
+require 'digest/md5'
+
 module Smailer
   module Models
     class QueuedMail < ActiveRecord::Base
@@ -5,6 +7,7 @@ module Smailer
 
       validates_presence_of :mail_campaign_id, :to
       validates_uniqueness_of :to, :scope => :mail_campaign_id
+      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
 
@@ -12,6 +15,9 @@ module Smailer
 
       delegate :from, :subject, :mailing_list, :to => :mail_campaign, :allow_nil => true
 
+      before_validation :initialize_message_key
+      before_save :initialize_message_key
+
       def body_html
         interpolate mail_campaign.body_html
       end
@@ -20,14 +26,25 @@ module Smailer
         interpolate mail_campaign.body_text
       end
 
+      def key
+        initialize_message_key
+        self[:key]
+      end
+
       protected
 
+      def initialize_message_key
+        self.key = Digest::MD5.hexdigest("#{mail_campaign_id}, #{to} and #{id} compose this key.")
+      end
+
       def interpolate(text)
         {
-          :email           => to,
-          :escaped_email   => lambda { ERB::Util.h(to) },
-          :email_key       => lambda { MailKey.get(to) },
-          :mailing_list_id => lambda { mailing_list.id },
+          :email            => to,
+          :escaped_email    => lambda { ERB::Util.h(to) },
+          :email_key        => lambda { MailKey.get(to) },
+          :mailing_list_id  => lambda { mailing_list.id },
+          :mail_campaign_id => mail_campaign_id,
+          :message_key      => key,
         }.each do |variable, interpolation|
           text.gsub! "%{#{variable}}" do
             interpolation.respond_to?(:call) ? interpolation.call : interpolation.to_s

data/lib/smailer/version.rb

@@ -1,3 +1,3 @@
 module Smailer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dimitar Dimitrov
@@ -46,6 +46,7 @@ files:
 - README.md
 - Rakefile
 - lib/smailer.rb
+- lib/smailer/compatibility.rb
 - lib/smailer/models.rb
 - lib/smailer/models/finished_mail.rb
 - lib/smailer/models/mail_campaign.rb