mallet 0.0.8 → 0.0.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mallet (0.0.7)
+    mallet (0.0.9)
       actionmailer (~> 3.0)
       activerecord (~> 3.0)
       activesupport
@@ -45,11 +45,11 @@ GEM
       rails (>= 3.0.0)
       thor (>= 0.14.6)
     database_cleaner (0.9.1)
-    delayed_job (3.0.5)
-      activesupport (~> 3.0)
-    delayed_job_active_record (0.4.3)
-      activerecord (>= 2.1.0, < 4)
-      delayed_job (~> 3.0)
+    delayed_job (4.0.0)
+      activesupport (>= 3.0, < 4.1)
+    delayed_job_active_record (4.0.0)
+      activerecord (>= 3.0, < 4.1)
+      delayed_job (>= 3.0, < 4.1)
     diff-lcs (1.2.1)
     erubis (2.7.0)
     hike (1.2.1)
@@ -115,7 +115,7 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.37)
-    workflow (1.0.0)
+    workflow (1.1.0)
 
 PLATFORMS
   ruby

data/lib/mallet.rb

@@ -12,10 +12,12 @@ module Mallet
     'mallet_'
   end
 
-  def self.mail(&block)
-    generator = MailGeneration.new 
-    generator.instance_eval(&block)
+  def self.mail(params = {})
+    generator = MailGeneration.new
+    generator.for(params[:for])
+    generator.definition(params[:definition])
     generator.persist!
+    Hooks.on_create(generator.mail)
     generator.mail
   end
 
@@ -23,3 +25,4 @@ end
 
 require "mallet/mail"
 require "mallet/mail_generation"
+require "mallet/hooks"

data/lib/mallet/hooks.rb

@@ -0,0 +1,27 @@
+module Mallet
+
+  class Hooks
+
+    def self.on_create(mallet_mail)
+
+    end
+
+    def self.on_deliver(mallet_mail)
+
+    end
+
+    def self.on_error(mallet_mail)
+
+    end
+
+    def self.on_success(mallet_mail)
+
+    end
+
+    def self.on_bounce(mallet_mail)
+
+    end
+
+  end
+
+end

data/lib/mallet/mail.rb

@@ -4,19 +4,12 @@ module Mallet
     include ::Workflow
 
     attr_accessible :workflow_state
-
-    #belongs_to :malletable, polymorphic: true
-
-    scope :pending, where(workflow_state: 'pending')
-    scope :sent, where(workflow_state: 'sent')
-    scope :failed, where(workflow_state: 'failed')
     scope :for, lambda {|malletable| where(malletable_type: malletable.class.name, malletable_id: malletable.id)}
 
     validates_presence_of :definition
     validates_presence_of :malletable
 
     before_save :validate
-    after_create :delayed_delivery
 
     workflow do
       state :pending do
@@ -25,7 +18,14 @@ module Mallet
       end
 
       state :failed
-      state :sent
+      
+      state :sent do
+        event :success, :transitions_to => :delivered
+        event :bounce, :transitions_to => :bounced
+      end
+
+      state :delivered
+      state :bounced
 
       after_transition do
         notify_observers "on_#{workflow_state}".to_sym
@@ -43,30 +43,35 @@ module Mallet
 
     def validate
       raise Exception unless DEFINITIONS.has_key?(definition)
-      raise Exception unless mailer_class.constantize.ancestors.include? ActionMailer::Base
-    end
-
-    def delayed_delivery
-      delay.deliver!
     end
 
     def deliver
       validate
-      mailer_class.constantize.send(mailer_method.to_sym, malletable).deliver
+      Hooks.on_deliver(self)
     end
 
-    def self.deliver_all!
-      pending.each(&:delayed_delivery)
+    def error
+      Hooks.on_error(self)
     end
 
-    protected
+    def bounce
+      Hooks.on_bounce(self)
+    end
+
+    def bounce
+      Hooks.on_bounce(self)
+    end
 
-    def mailer_class
-      DEFINITIONS[definition]['mailer']
+    def success
+      Hooks.on_success(self)
     end
 
-    def mailer_method
-      DEFINITIONS[definition]['method']
+    def delayed_delivery
+      delay.deliver!
+    end
+
+    def self.deliver_all!
+      pending.each(&:delayed_delivery)
     end
 
   end

data/lib/mallet/mail_generation.rb

@@ -8,7 +8,7 @@ module Mallet
       self.mail = Mail.new
     end
 
-    def to(malletable)
+    def for(malletable)
       mail.malletable_type = malletable.class.name
       mail.malletable_id = malletable.id
     end

data/lib/mallet/version.rb

@@ -1,3 +1,3 @@
 module Mallet
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/lib/mallet/mail_spec.rb

@@ -14,12 +14,7 @@ describe Mallet::Mail do
   context "on creation" do
 
     before(:each) do
-      job = @job
-
-      @mail = Mallet::mail do
-        to job
-        definition 'welcome'
-      end
+      @mail = Mallet::mail(for: @job, definition: 'welcome')
     end
 
     it "should default to a pending state" do
@@ -30,56 +25,53 @@ describe Mallet::Mail do
       @mail.malletable.should == @job
     end
 
-    it "should identify the mailer class" do
-      @mail.send(:mailer_class).should == "ActionMailer::Base"
+  end
+
+  context "on delivery" do
+
+    before(:each) do
+      @mail = Mallet::mail(for: @job, definition: 'welcome')
     end
 
-    it "should identify the mailer method" do
-      @mail.send(:mailer_method).should == "welcome"
+    it "should mark the mail as sent" do
+      @mail.deliver!
+      @mail.should be_sent
     end
 
-    it "should trigger sending the mail via delayed job" do
-      mock_mailer = mock(ActionMailer::Base)
-      ActionMailer::Base.should_receive(:welcome).with(@job).and_return(mock_mailer)
-      mock_mailer.should_receive(:deliver)
+  end
 
-      Delayed::Job.count.should == 2
-      Delayed::Job.last.invoke_job
-    end
+  context "hooks" do
 
-    it "should raise an exception if the mailer does not inherit from ActionMailer" do
-      Mallet::DEFINITIONS['bad_definition'] = {
-        'mailer' => 'ActionMailer::Base2',
-        'method' => 'welcome'
-      }
+    it "should call a hook on creation" do
+      Mallet::Hooks.should_receive(:on_create).once
 
-      @mail.definition = 'bad_definition'
-      expect { @mail.save! }.to raise_error
+      mail = Mallet::mail(for: @job, definition: 'welcome')
     end
 
-  end
-
-  context "on delivery" do
+    it "should call a hook when delivering" do
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      Mallet::Hooks.should_receive(:on_deliver).with(mail).once
+      mail.deliver!
+    end
 
-    before(:each) do
-      job = @job
-      
-      @mail = Mallet::mail do
-        to job
-        definition 'welcome'
-      end
-
-      @job = job
+    it "should call a hook on error" do
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      Mallet::Hooks.should_receive(:on_error).with(mail).once
+      mail.error!
     end
 
-    it "should mark the mail as sent" do
-      mock_mailer = mock(ActionMailer::Base)
-      ActionMailer::Base.should_receive(:welcome).with(@job).and_return(mock_mailer)
-      mock_mailer.should_receive(:deliver)
+    it "should call a hook when delivered successfully" do
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      mail.update_column(:workflow_state, 'sent')
+      Mallet::Hooks.should_receive(:on_success).with(mail).once
+      mail.success!
+    end
 
-      Delayed::Job.last.invoke_job
-      @mail.reload
-      @mail.should be_sent
+    it "should call a hook when bounced" do
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      mail.update_column(:workflow_state, 'sent')
+      Mallet::Hooks.should_receive(:on_bounce).with(mail).once
+      mail.bounce!
     end
 
   end
@@ -87,48 +79,21 @@ describe Mallet::Mail do
   context "filtering mails" do
 
     it "should filter by pending" do
-      job = @job
-
-      expect {
-        Mallet::mail do
-          to job
-          definition 'welcome'
-        end
-      }.to change{ Mallet::Mail.pending.count }.by(1)
+      expect { Mallet::mail(for: @job, definition: 'welcome') }.to change{ Mallet::Mail.with_pending_state.count }.by(1)
     end
 
     it "should filter by sent" do
-      job = @job
-
-      mail = Mallet::mail do
-        to job
-        definition 'welcome'
-      end
-
-      expect {mail.error!}.to change{ Mallet::Mail.failed.count }.by(1)
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      expect {mail.deliver!}.to change{ Mallet::Mail.with_sent_state.count }.by(1)
     end
 
     it "should filter by failed" do
-      job = @job
-
-      mail = Mallet::mail do
-        to job
-        definition 'welcome'
-      end
-
-      mail.should_receive(:deliver)
-      expect {mail.deliver!}.to change{ Mallet::Mail.sent.count }.by(1)
+      mail = Mallet::mail(for: @job, definition: 'welcome')
+      expect {mail.error!}.to change{ Mallet::Mail.with_failed_state.count }.by(1)
     end
 
     it "should filter by malletable item" do
-      job = @job
-
-      expect{
-        mail = Mallet::mail do
-          to job
-          definition 'welcome'
-        end
-      }.to change{ Mallet::Mail.for(job).count }.by(1)
+      expect{ Mallet::mail(for: @job, definition: 'welcome') }.to change{ Mallet::Mail.for(@job).count }.by(1)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mallet
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,6 +141,7 @@ files:
 - lib/generators/active_record/mallet_generator.rb
 - lib/generators/active_record/templates/migration.rb
 - lib/mallet.rb
+- lib/mallet/hooks.rb
 - lib/mallet/mail.rb
 - lib/mallet/mail_generation.rb
 - lib/mallet/version.rb