email_campaign 0.1.6 → 0.1.7

data/README.rdoc

@@ -1,6 +1,6 @@
 =email_campaign
 
-For mailings related to Rails apps, email_campaign is designed to be a more flexible, more integrated (yet well-abstracted) alternative to email campaign services like Campaign Monitor and MailChimp. Designed to use SendGrid for delivery, but this is easy changed.
+For mailings related to Rails apps, email_campaign is designed to be a more flexible, more integrated (yet well-abstracted) alternative to email campaign services like Campaign Monitor and MailChimp. Developed using {SendGrid}[http://sendgrid.com/] for delivery (via the ActionMailer::Base.smtp_settings), but feel free to use whatever you want.
 
 =Roadmap
 
@@ -108,6 +108,40 @@ Finally, create an initializer that sets base_url (since urls in emails need to
   # EmailCampaign::Handler as it would appear in url_for(:controller => '...')
   EmailCampaign::Config.controller_name = 'email'
 
+Okay, now how do we actually send this thing? You'll want to make a controller for this eventually, but for now let's use the console:
+
+  # create a campaign, making sure to specify the mailer class and method we created earlier
+  c = EmailCampaign::Campaign.find_or_create_by_name(:name => 'Campaign 2013a')
+  c.mailer = 'Campaign'
+  c.method = 'campaign2013a'
+  c.save
+  
+  # recipients can be any object that responds to #name, #email_address and #id (or optionally, #subscriber_id)
+  class TestRecipient
+    attr_accessor :name, :email_address, :subscriber_id
+    def initialize(name, email_address, subscriber_id)
+      @name = name ; @email_address = email_address ; @subscriber_id = subscriber_id
+    end
+  end
+    
+  rcpts = [ TestRecipient.new('Aaron Namba', 'aaron@mysite.com', 1) ]
+  
+  # this will create EmailCampaign::Recipient objects (c.recipients), which contain delivery status
+  # information (e.g. #delivered, #failed, #failure_reason, #opened, #clicked)
+  counts = c.add_recipients(rcpts, :force => true)
+  
+  if c.queue
+    # use dj to send in 5 minutes; deliver! also uses dj to queue up individual emails
+    c.delay(:run_at => 5.minutes.from_now).deliver!
+    puts "Emails queued for immediate delivery. #{counts[:processed]} processed, #{counts[:skipped]} skipped, #{counts[:valid]} valid, #{counts[:invalid]} invalid, #{counts[:duplicate]} duplicate, #{counts[:unsubscribed]} unsubscribed, #{counts[:total]} total in queue."
+  end
+
+Start dj if you haven't already:
+
+  script/delayed_job start
+
+
+
 =Getting Help
 
 Get paid support for EmailCampaign straight from the people who made it: {Bigger Bird Creative, Inc.}[https://www.biggerbird.com] Not required, of course. :-) Free support is up top (Issues).

data/lib/email_campaign/engine.rb

@@ -10,6 +10,9 @@ module EmailCampaign
       Rails.application.config.assets.precompile += %w( email_campaign/open-tracker.gif )
     end
     
+    require 'email_campaign/config'
+    require 'email_campaign/handler'
+    
     #
     # activate gems as needed
     #

data/lib/email_campaign/version.rb

@@ -1,3 +1,3 @@
 module EmailCampaign
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: email_campaign
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors: