smailer 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+*.tmproj
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in smailer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,25 @@
+# Simple newsletter mailer for Rails
+
+## Intro
+
+This project is a simple mailer for newsletters, which implements simple queue processing, basic campaign management and has some unsubscribe support.
+
+It is intended to be used within a Rails project.
+
+## Install
+
+For Rails 3 projects, update your Gemfile and add:
+	gem 'smailer'
+Then run `bundle install` and you should be ready to go.
+
+## Usage and documentation
+
+TODO
+
+## 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! :)
+
+## License
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/smailer.rb

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

data/lib/smailer/models.rb

@@ -0,0 +1,10 @@
+module Smailer
+  module Models
+    autoload :MailingList,    'smailer/models/mailing_list'
+    autoload :MailCampaign,   'smailer/models/mail_campaign'
+    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

data/lib/smailer/models/finished_mail.rb

@@ -0,0 +1,41 @@
+module Smailer
+  module Models
+    class FinishedMail < ActiveRecord::Base
+      class Statuses
+        FAILED = 0
+        SENT   = 1
+      end
+
+      belongs_to :mail_campaign
+
+      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
+
+      delegate :mailing_list, :to => :mail_campaign, :allow_nil => true
+
+      def status_text
+        Statuses.constants.each do |constant_name|
+          return constant_name if Statuses.const_get(constant_name) == status
+        end
+        nil
+      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|
+          finished.send("#{field}=", queued_mail.send(field))
+        end
+
+        finished.status = status
+        finished.sent_at = Time.now if status == Statuses::SENT
+
+        finished.save!
+        queued_mail.destroy
+
+        finished
+      end
+    end
+  end
+end

data/lib/smailer/models/mail_campaign.rb

@@ -0,0 +1,54 @@
+module Smailer
+  module Models
+    class MailCampaign < ActiveRecord::Base
+      class UnsubscribeMethods
+        URL     = 1
+        REPLY   = 2
+        BOUNCED = 4
+      end
+
+      belongs_to :mailing_list
+      has_many :queued_mails, :dependent => :destroy
+      has_many :finished_mails
+
+      validates_presence_of :mailing_list_id, :from
+      validates_numericality_of :mailing_list_id, :unsubscribe_methods, :only_integer => true, :allow_nil => true
+      validates_length_of :from, :subject, :maximum => 255, :allow_nil => true
+
+      attr_accessible :mailing_list_id, :from, :subject, :body_html, :body_text 
+
+      def add_unsubscribe_method(method)
+        self.unsubscribe_methods = (self.unsubscribe_methods || 0) | method
+      end
+
+      def remove_unsubscribe_method(method)
+        if has_unsubscribe_method?(method)
+          self.unsubscribe_methods = (self.unsubscribe_methods || 0) ^ method
+        end
+      end
+
+      def has_unsubscribe_method?(method)
+        (unsubscribe_methods || 0) & method === method
+      end
+
+      def active_unsubscribe_methods
+        self.class.unsubscribe_methods.reject do |method, method_name|
+          not has_unsubscribe_method?(method)
+        end
+      end
+
+      def name
+        "Campaign ##{id} (#{mailing_list.name})"
+      end
+
+      def self.unsubscribe_methods
+        methods = {}
+        UnsubscribeMethods.constants.map do |method_name|
+          methods[UnsubscribeMethods.const_get(method_name)] = method_name
+        end
+
+        methods
+      end
+    end
+  end
+end

data/lib/smailer/models/mail_key.rb

@@ -0,0 +1,42 @@
+require 'digest/md5'
+
+module Smailer
+  module Models
+    class MailKey < ActiveRecord::Base
+      validates_presence_of :email, :key
+      validates_uniqueness_of :email
+      validates_uniqueness_of :key
+      validates_length_of :email, :key, :maximum => 255
+
+      attr_accessible :email, :key
+
+      before_validation :set_key
+      before_save :set_key
+
+      def self.generate(email)
+        Digest::MD5.hexdigest("The #{email} and our great secret, which lies in Mt. Asgard!")
+      end
+
+      def self.get(email)
+        email  = extract_email(email)
+        key    = generate(email)
+        stored = where(:key => key).first
+
+        create :email => email, :key => key unless stored
+
+        key
+      end
+
+      def self.extract_email(email)
+        email = $1.strip if email =~ /<(.+@.+)>\s*$/
+        email
+      end
+
+      protected
+
+      def set_key
+        self.key = self.class.generate(email)
+      end
+    end
+  end
+end

data/lib/smailer/models/mailing_list.rb

@@ -0,0 +1,13 @@
+module Smailer
+  module Models
+    class MailingList < ActiveRecord::Base
+      has_many :mail_campaigns
+
+      validates_presence_of :name
+      validates_uniqueness_of :name
+      validates_length_of :name, :maximum => 255
+
+      attr_accessible :name
+    end
+  end
+end

data/lib/smailer/models/property.rb

@@ -0,0 +1,54 @@
+module Smailer
+  module Models
+    class Property < ActiveRecord::Base
+      set_table_name 'smailer_properties'
+
+      validates_presence_of :name
+      validates_uniqueness_of :name
+
+      attr_accessible :name, :value, :notes
+
+      @@cache_created_at = Time.now
+
+      def self.clear_cache_if_needed!
+        if Time.now - @@cache_created_at > 1.minute
+          remove_class_variable :@@properties rescue nil
+          @@cache_created_at = Time.now
+        end
+      end
+
+      def self.setup_cache!
+        self.clear_cache_if_needed!
+        @@properties ||= {} unless defined?(@@properties)
+      end
+
+      def self.get(name)
+        self.setup_cache!
+        name = name.to_s
+
+        unless @@properties.has_key?(name)
+          property = find_by_name name
+          @@properties[name] = property ? property.value : nil
+        end
+
+        @@properties[name]
+      end
+
+      def self.get_all(name)
+        self.setup_cache!
+        name, cache_key = name.to_s, "#{name}[]"
+
+        unless @@properties.has_key?(cache_key)
+          properties = all(:conditions => ['name LIKE ?', "#{name}%"]).map { |p| [p.name, p.value] }
+          @@properties[cache_key] = Hash[ properties ]
+        end
+
+        @@properties[cache_key]
+      end
+
+      def self.get_boolean(name)
+        self.get(name).to_s.strip =~ /^(true|t|yes|y|on|1)$/i ? true : false
+      end
+    end
+  end
+end

data/lib/smailer/models/queued_mail.rb

@@ -0,0 +1,41 @@
+module Smailer
+  module Models
+    class QueuedMail < ActiveRecord::Base
+      belongs_to :mail_campaign
+
+      validates_presence_of :mail_campaign_id, :to
+      validates_uniqueness_of :to, :scope => :mail_campaign_id
+      validates_numericality_of :mail_campaign_id, :retries, :only_integer => true, :allow_nil => true
+      validates_length_of :to, :last_error, :maximum => 255
+
+      attr_accessible :mail_campaign_id, :to
+
+      delegate :from, :subject, :mailing_list, :to => :mail_campaign, :allow_nil => true
+
+      def body_html
+        interpolate mail_campaign.body_html
+      end
+
+      def body_text
+        interpolate mail_campaign.body_text
+      end
+
+      protected
+
+      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 },
+        }.each do |variable, interpolation|
+          text.gsub! "%{#{variable}}" do
+            interpolation.respond_to?(:call) ? interpolation.call : interpolation.to_s
+          end
+        end
+
+        text
+      end
+    end
+  end
+end

data/lib/smailer/tasks.rb

@@ -0,0 +1,5 @@
+module Smailer
+  module Tasks
+    autoload :Send, 'smailer/tasks/send'
+  end
+end

data/lib/smailer/tasks/send.rb

@@ -0,0 +1,59 @@
+require 'mail'
+
+module Smailer
+  module Tasks
+    class Send
+      def self.execute
+        Mail.defaults do
+          delivery_method Rails.configuration.action_mailer.delivery_method
+        end
+
+        batch_size   = Smailer::Models::Property.get('queue.batch_size').to_i
+        max_retries  = Smailer::Models::Property.get('queue.max_retries').to_i
+        max_lifetime = Smailer::Models::Property.get('queue.max_lifetime').to_i
+
+        results = []
+        Smailer::Models::QueuedMail.order(:retries.asc, :id.asc).limit(batch_size).each do |queue_item|
+          # try to send the email
+          mail = Mail.new do
+            from    queue_item.from
+            to      queue_item.to
+            subject queue_item.subject
+
+            text_part { body queue_item.body_text }
+            html_part { body queue_item.body_html; content_type 'text/html; charset=UTF-8' }
+          end
+          mail.raise_delivery_errors = true
+
+          queue_item.last_retry_at = Time.now
+          queue_item.retries += 1
+
+          begin
+            # commense delivery
+            mail.deliver
+          rescue Exception => e
+            # failed, we have.
+            queue_item.last_error = "#{e.class.name}: #{e.message}"
+            queue_item.save
+
+            # check if the message hasn't expired;
+            retries_exceeded = max_retries  > 0 && queue_item.retries >= max_retries
+            too_old = max_lifetime > 0 && (Time.now - queue_item.created_at) >= max_lifetime
+
+            if retries_exceeded || too_old
+              # the message has expired; move to finished_mails
+              Smailer::Models::FinishedMail.add(queue_item, Smailer::Models::FinishedMail::Statuses::FAILED)
+            end
+            results.push [queue_item, :failed]
+          else
+            # great job, message sent
+            Smailer::Models::FinishedMail.add(queue_item, Smailer::Models::FinishedMail::Statuses::SENT)
+            results.push [queue_item, :sent]
+          end
+        end
+
+        results
+      end
+    end
+  end
+end

data/lib/smailer/version.rb

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

data/smailer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/smailer/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "smailer"
+  s.version     = Smailer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Dimitar Dimitrov']
+  s.email       = ['wireman@gmail.com']
+  s.homepage    = "http://github.com/mitio/smailer"
+  s.summary     = "A simple newsletter mailer for Rails."
+  s.description = "A simple mailer for newsletters with basic campaign management, queue and unsubscribe support. To be used within Rails."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "smailer"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: smailer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dimitar Dimitrov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-02 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+description: A simple mailer for newsletters with basic campaign management, queue and unsubscribe support. To be used within Rails.
+email: 
+- wireman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/smailer.rb
+- lib/smailer/models.rb
+- lib/smailer/models/finished_mail.rb
+- lib/smailer/models/mail_campaign.rb
+- lib/smailer/models/mail_key.rb
+- lib/smailer/models/mailing_list.rb
+- lib/smailer/models/property.rb
+- lib/smailer/models/queued_mail.rb
+- lib/smailer/tasks.rb
+- lib/smailer/tasks/send.rb
+- lib/smailer/version.rb
+- smailer.gemspec
+has_rdoc: true
+homepage: http://github.com/mitio/smailer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: smailer
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple newsletter mailer for Rails.
+test_files: []
+