smailer 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0ad9b68b1053871829e187454142b621a48935f
-  data.tar.gz: 5179717f9a0447996510e2f1dff7081b8d601245
+  metadata.gz: c72c27e350a0cd53f23e5b4e961f4addceea0fff
+  data.tar.gz: 6c4fe79f61f4e3ec824d1b6f33d6b9177a9e7ba0
 SHA512:
-  metadata.gz: 8ec561c47706b8b7271a2b73b4428db6cf3156bca66e93846329a6a0ffa83185fec6f961d7016800cdc6bfdc446fd9f3af17d609c92f14956f61626b869ba3ae
-  data.tar.gz: 2abf5eb90fa6042aba5412fe4631568ed27a907d126a358b4ce76f18467dd812281ff70cbe54e99ac23201b62da1517be0d3d937a9f5e52a7d167f1e5eff5ce5
+  metadata.gz: 78a7371b1ec129605f13b0998ad7dc8a41ee462ab077213becdbd88d6bf43e03eda6dd5fdf6ca571e8891a7fc1c5685c0b6393f781b41ef859aee875784dd286
+  data.tar.gz: 9a9fcd6397f2735e5fd8eb8c5fdb5a7056831c994c69b9b52ec2d06f8162c0a2fe55b777a9c923ba921e98e6e2fb3b5770c6c606e24239f24655f53dba18e137

data/README.md

@@ -54,7 +54,7 @@ Here is an example how you could proceed with creating and issuing a newsletter:
 
 	# locate the mailing list we'll be sending to
 	list = Smailer::Models::MailingList.first
-	
+
 	# create a corresponding mail campaign
 	campaign_params = {
 		:from      => 'noreply@example.org',
@@ -66,7 +66,10 @@ Here is an example how you could proceed with creating and issuing a newsletter:
 	campaign = Smailer::Models::MailCampaign.new campaign_params
 	campaign.add_unsubscribe_method :all
 	campaign.save!
-	
+
+	# Add attachments
+	campaign.add_attachment 'attachment.pdf', 'url_or_file_path_to_attachment'
+
 	# enqueue mails to be sent out
 	subscribers = %w[
 		subscriber@domain.com
@@ -77,10 +80,15 @@ Here is an example how you could proceed with creating and issuing a newsletter:
 	  campaign.queued_mails.create! :to => subscriber
 	end
 
+### Attachments
+
+You can have zero or more attachments to any mail campaign. As demonstrated in the example above, you add them to the campain using the `MailCampaign#add_attachment(file_name, url_or_path)` method.
+
+Any attached files will be referenced at the moment of sending and must be reachable and readable by the send task. Currently, `open-uri` is used to fetch the content of the path or URI. The maximum length of the path/URI field is 2048 symbols.
 
 ### Managing unsubscriptions
 
-Among the few unsubscription methods supported, probably the most widely used one is unsubscription via a unsubscribe link in the email. 
+Among the few unsubscription methods supported, probably the most widely used one is unsubscription via a unsubscribe link in the email.
 
 In order to help you with implementing it, Smailer provides you with some interpolations you can use in the email's body:
 
@@ -145,7 +153,7 @@ Suppose you manage your site's newsletter subscriptions via a `Subscription` mod
 	    :subscribed_checker => subscribed_checker,
 	  }) do |unsubscribe_details|
 	    subscription = Subscription.confirmed.subscribed.where(:email => unsubscribe_details[:recipient]).first
-	
+
 	    if subscription
 	      subscription.subscribed = false
 	      subscription.unsubscribe_reason = 'Automatic, due to bounces'

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

@@ -37,6 +37,15 @@ class CreateSmailerTables < ActiveRecord::Migration
     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
+      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|
       t.integer  "mail_campaign_id"
       t.string   "from"
@@ -79,23 +88,11 @@ class CreateSmailerTables < ActiveRecord::Migration
 
   def self.down
     drop_table :smailer_properties
-
-    remove_index :mail_keys, :name => "index_mail_keys_on_email"
-    remove_index :mail_keys, :name => "index_mail_keys_on_email"
     drop_table :mail_keys
-
-    remove_index :finished_mails, :name => "index_finished_mails_on_key"
-    remove_index :finished_mails, :name => "index_finished_mails_on_mail_campain_id_and_status"
-    remove_index :finished_mails, :name => "index_finished_mails_on_to_and_mail_campaign_id"
     drop_table :finished_mails
-
-    remove_index :queued_mails, :name => "index_queued_mails_on_mail_campain_id_and_to"
-    remove_index :queued_mails, :name => "index_queued_mails_on_retries"
     drop_table :queued_mails
-
-    remove_index :mail_campaigns, :name => "index_mail_campaigns_on_mailing_list_id"
+    drop_table :mail_campaign_attachments
     drop_table :mail_campaigns
-
     drop_table :mailing_lists
   end
 end

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

@@ -37,6 +37,15 @@ class CreateSmailerTables < ActiveRecord::Migration
     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
+      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|
       t.integer  "mail_campaign_id"
       t.string   "from"
@@ -79,23 +88,11 @@ class CreateSmailerTables < ActiveRecord::Migration
 
   def self.down
     drop_table :smailer_properties
-
-    remove_index :mail_keys, :name => "index_mail_keys_on_email"
-    remove_index :mail_keys, :name => "index_mail_keys_on_email"
     drop_table :mail_keys
-
-    remove_index :finished_mails, :name => "index_finished_mails_on_key"
-    remove_index :finished_mails, :name => "index_finished_mails_on_mail_campain_id_and_status"
-    remove_index :finished_mails, :name => "index_finished_mails_on_to_and_mail_campaign_id"
     drop_table :finished_mails
-
-    remove_index :queued_mails, :name => "index_queued_mails_on_mail_campain_id_and_to"
-    remove_index :queued_mails, :name => "index_queued_mails_on_retries"
     drop_table :queued_mails
-
-    remove_index :mail_campaigns, :name => "index_mail_campaigns_on_mailing_list_id"
+    drop_table :mail_campaign_attachments
     drop_table :mail_campaigns
-
     drop_table :mailing_lists
   end
 end

data/lib/smailer/models.rb

@@ -2,6 +2,7 @@ module Smailer
   module Models
     autoload :MailingList,    'smailer/models/mailing_list'
     autoload :MailCampaign,   'smailer/models/mail_campaign'
+    autoload :MailCampaignAttachment, 'smailer/models/mail_campaign_attachment'
     autoload :MailKey,        'smailer/models/mail_key'
     autoload :QueuedMail,     'smailer/models/queued_mail'
     autoload :FinishedMail,   'smailer/models/finished_mail'

data/lib/smailer/models/mail_campaign.rb

@@ -10,6 +10,8 @@ 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'
 
       validates_presence_of :mailing_list_id, :from
       validates_numericality_of :mailing_list_id, :unsubscribe_methods, :only_integer => true, :allow_nil => true
@@ -48,6 +50,10 @@ module Smailer
         opened_mails_count.to_f / sent_mails_count
       end
 
+      def add_attachment(filename, path)
+        self.attachments.create!(:filename => filename, :path => path)
+      end
+
       def self.unsubscribe_methods
         methods = {}
         UnsubscribeMethods.constants.map do |method_name|

data/lib/smailer/models/mail_campaign_attachment.rb

@@ -0,0 +1,19 @@
+require 'open-uri'
+
+module Smailer
+  module Models
+    class MailCampaignAttachment < ActiveRecord::Base
+
+      belongs_to :mail_campaign
+      validates_presence_of :mail_campaign_id
+      validates_numericality_of :mail_campaign_id
+      validates_presence_of :path
+      validates_presence_of :filename
+
+      def body
+        open(self.path).read
+      end
+
+    end
+  end
+end

data/lib/smailer/tasks/send.rb

@@ -53,12 +53,21 @@ module Smailer
           Smailer::Models::QueuedMail.update_all(lock_update, lock_condition)
         end
 
+        # map of attachment ID to contents - so we don't keep opening files
+        # or URLs
+        cached_attachments = {}
+
         items_to_process.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
+            queue_item.mail_campaign.attachments.each do |attachment|
+              cached_attachments[attachment.id] ||= attachment.body
+              add_file :filename => attachment.filename,
+                       :content => cached_attachments[attachment.id]
+            end
 
             text_part { body queue_item.body_text }
             html_part { body queue_item.body_html; content_type 'text/html; charset=UTF-8' }

data/lib/smailer/version.rb

@@ -1,7 +1,7 @@
 module Smailer
   MAJOR = 0
-  MINOR = 6
-  PATCH = 3
+  MINOR = 7
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smailer
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Dimitar Dimitrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/smailer/models.rb
 - lib/smailer/models/finished_mail.rb
 - lib/smailer/models/mail_campaign.rb
+- lib/smailer/models/mail_campaign_attachment.rb
 - lib/smailer/models/mail_key.rb
 - lib/smailer/models/mailing_list.rb
 - lib/smailer/models/property.rb