outbox-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57294d890576209761af55f8add69fbe000ecb4a
-  data.tar.gz: 48ea5264966ae0e32d2a4d1748270e6784c70848
+  metadata.gz: 16b0ef1c8739ebb7a5111e9f21ae02cf5d7f6cb9
+  data.tar.gz: 35e6634f4ce96b930cfbd8707f1895a292824554
 SHA512:
-  metadata.gz: 417e24b5a13534a2ccdfdb3a446d6f65e90db9d0f6ee1aaa0ba8df0998811643318c2ed8793374df05355c8bb70ffa2640418e7cd1d8a6236d13338dc76f0fc8
-  data.tar.gz: b4bfb5c923352b9746101a22be60e2c91b87dc7078309c8ab97c8996547d90050eb7856ceef2653664d4eb211dc750bc7645005af0cb0e057a5b60ad036b9de3
+  metadata.gz: 0486bee46a316dd4e87de33b70319d7f32939e1bbdc61efd99e3bcb85364757a3a319c6c50ae791b128ec6a0bc43c7ab71d4e50dd8364653a202868197081d70
+  data.tar.gz: 5e2b1ceff8710a8d5ab5b6d5933226791c2bef7196f3eea3c8de1b0f2f9dfeffc39c81409639a517dac11f812bb0c43e6ebbb9867a2ec4d5e14ff350de5ced96

data/README.md

@@ -45,6 +45,9 @@ class AccountNotifier < Outbox::Notifier
     end
 
     sms do
+      from '<shortcode_id>'
+      # The "text" template will automatically be used for the body of the SMS.
+      # But you can explicitly override by calling the #body method.
       body 'Welcome to our App!'
     end
 
@@ -58,11 +61,49 @@ end
 Send a message using the `deliver` method:
 
 ```ruby
-# Unlike ActionMailer, deliver takes a single argument that defines the recipients
+# Unlike ActionMailer, deliver takes an argument that defines the recipients
 # for the message types you want to send.
 AccountNotifier.welcome.deliver email: 'user@gmail.com', sms: '+15557654321'
 ```
 
+Configuration
+-------------
+
+Configure Outbox using the `config.outbox` accessor during normal Rails
+configuration:
+
+``` ruby
+# config/application.rb
+module Blog
+  class Application < Rails::Application
+    # Configure defautl email fields
+    config.outbox.email_defaults = {
+      from: 'from@example.com'
+    }
+
+    # Setup default email settings.
+    config.outbox.default_email_client_settings = {
+      smtp_settings: {
+        address: 'smtp.gmail.com',
+        port: 587,
+        domain: 'example.com',
+        user_name: '<username>',
+        password: '<password>',
+        authentication: 'plain',
+        enable_starttls_auto: true
+      }
+    }
+  end
+end
+
+# config/environments/test.rb
+Blog::Application.configure do
+  # Always use test client during tests
+  config.outbox.use_test_client = true
+end
+
+```
+
 Contributing
 ------------
 

data/lib/outbox/notifier.rb

@@ -2,25 +2,28 @@ require 'action_mailer'
 
 module Outbox
   class Notifier < ActionMailer::Base
+    extend Outbox::DefineInheritableMethod
+    include Outbox::NotifierTypes
+
     abstract!
 
     alias_method :_render_email, :mail
     undef :mail
 
     class << self
-      alias :defaults :default
+      alias_method :defaults, :default
 
       # Returns the name of current notifier. This method is also being used
       # as a path for a view lookup. If this is an anonymous notifier,
       # this method will return +anonymous+ instead.
       def notifier_name(value = nil)
         if value.nil?
-          self.mailer_name
+          mailer_name
         else
           self.mailer_name = value
         end
       end
-      alias :notifier_name= :notifier_name
+      alias_method :notifier_name=, :notifier_name
 
       protected
 
@@ -38,7 +41,7 @@ module Outbox
       # Make sure we don't ever get a NullMail object.
       @_mail_was_called = true
       @_message_rendered = false
-      @_message = Outbox::Message.new self.class.default_params.dup
+      @_message = build_message
       process(method_name, *args) if method_name
     end
 
@@ -58,16 +61,22 @@ module Outbox
     # #message object is retrieved.
     def render_message(options = {}, &block)
       @_message_rendered = true
-      @_message.email ||= Outbox::Messages::Email.new
+      if @_message.email
+        email = @_message.email
+        skip_email = false
+      else
+        email = Outbox::Messages::Email.new
+        skip_email = true
+      end
 
       # Render an email using the #mail interface so we don't have
       # to rewrite the template logic. Even if we aren't sending an email
       # we can still use the rendered templates in other messages types.
-      email_options = options.extract! :content_type, :charset, :parts_order,
-                                       :body, :template_name, :template_path
-      email_options.merge!(options.delete(:email)) if options[:email]
-      email_options[:subject] ||= email.subject if email.subject
-      email = render_email(email_options, &block)
+      begin
+        render_email(email, options, &block)
+      rescue ActionView::MissingTemplate => error
+        raise error unless skip_email
+      end
 
       @_message.assign_message_type_values(options)
       assign_body_from_email(email)
@@ -92,32 +101,42 @@ module Outbox
 
     protected
 
+    def build_message
+      message = Outbox::Message.new(self.class.default_params.dup)
+      Outbox::Message.message_types.each_key do |message_type|
+        message.public_send(message_type, {})
+      end
+      message
+    end
+
     def assign_body_from_email(email)
-      # TODO: Implement this later once we have multiple message types. This
-      # will extract the rendered body from the mail (preferring text/plain)
-      # and assign it to the other message types.
+      text_part = email.parts.find { |p| p.mime_type == 'text/plain' }
+      if text_part
+        @_message.each_message_type do |message_type, message|
+          next if message.nil? || message_type == :email
+          message.body = text_part.body.raw_source
+        end
+      end
     end
 
-    def render_email(options, &block)
+    def render_email(email, options, &block)
+      email_options = options.extract!(
+        :content_type, :charset, :parts_order,
+        :body, :template_name, :template_path
+      )
+      email_options.merge!(options.delete(:email)) if options[:email]
+      # ActionMailer will use the default i18n subject
+      # unless we explicitly set it on this options hash.
+      email_options[:subject] ||= email.subject if email.subject
+
       outbox_message = @_message
-      @_message = outbox_message.email
-      email = _render_email(options, &block)
+      @_message = email
+      _render_email(email_options, &block)
+    ensure
       @_message = outbox_message
       email
     end
 
-    def method_missing(method, *args, &block)
-      if @_message.respond_to?(method)
-        @_message.public_send(method, *args, &block)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method, include_private = false)
-      super || @_message.respond_to?(method, include_private)
-    end
-
     ActiveSupport.run_load_hooks(:outbox_notifier, self)
   end
 end

data/lib/outbox/notifier_types.rb

@@ -0,0 +1,37 @@
+module Outbox
+  module NotifierTypes
+    extend ActiveSupport::Concern
+
+    included do
+      Outbox::Message.message_types.each_key do |message_type|
+        define_notifier_type_reader(message_type)
+        define_notifier_type_writer(message_type)
+        define_skip_notifier_type(message_type)
+      end
+    end
+
+    module ClassMethods
+      DYNAMIC_MODULE_NAME = :DynamicNotifierTypes
+
+      protected
+
+      def define_notifier_type_reader(name)
+        define_inheritable_method(DYNAMIC_MODULE_NAME, name) do |*args, &block|
+          @_message.public_send(name, *args, &block)
+        end
+      end
+
+      def define_notifier_type_writer(name)
+        define_inheritable_method(DYNAMIC_MODULE_NAME, "#{name}=") do |value|
+          @_message.public_send("#{name}=", value)
+        end
+      end
+
+      def define_skip_notifier_type(name)
+        define_inheritable_method(DYNAMIC_MODULE_NAME, "skip_#{name}!") do
+          @_message.public_send("#{name}=", nil)
+        end
+      end
+    end
+  end
+end

data/lib/outbox/rails.rb

@@ -5,6 +5,7 @@ require 'active_support/rails'
 
 module Outbox
   autoload :Notifier, 'outbox/notifier'
+  autoload :NotifierTypes, 'outbox/notifier_types'
 
   module Rails
   end

data/lib/outbox/rails/version.rb

@@ -1,5 +1,5 @@
 module Outbox
   module Rails
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/outbox-rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'outbox', '~> 0.1.2'
+  spec.add_runtime_dependency 'outbox', '~> 0.2.0'
   spec.add_runtime_dependency 'rails', '~> 4.0.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/spec/internal/app/notifiers/base_notifier.rb

@@ -4,7 +4,9 @@ class BaseNotifier < Outbox::Notifier
   end
 
   def implicit_multipart(hash = {})
-    attachments['invoice.pdf'] = 'This is test File content' if hash.delete(:attachments)
+    if hash.delete(:attachments)
+      attachments['invoice.pdf'] = 'This is test File content'
+    end
     render_message(hash)
   end
 
@@ -18,4 +20,12 @@ class BaseNotifier < Outbox::Notifier
     headers 'X-Custom-1' => 'foo'
     headers['X-Custom-2'] = 'bar'
   end
+
+  def explicit_sms_message(skip_email = false)
+    skip_email! if skip_email
+    sms do
+      from '1234'
+      body 'Explicit Message'
+    end
+  end
 end

data/spec/outbox/notifier_spec.rb

@@ -79,5 +79,23 @@ describe Outbox::Notifier do
       expect(message.email.header['X-Custom-1'].value).to eql('foo')
       expect(message.email.header['X-Custom-2'].value).to eql('bar')
     end
+
+    it 'handles implicit SMS templates' do
+      message = BaseNotifier.implicit_multipart
+      expect(message.sms.body.strip).to eq('TEXT Implicit Multipart')
+    end
+
+    it 'handles explicit SMS messages' do
+      message = BaseNotifier.explicit_sms_message(true)
+      expect(message.email).to be_nil
+      expect(message.sms.from).to eq('1234')
+      expect(message.sms.body).to eq('Explicit Message')
+    end
+
+    it 'raises template errors when sending emails' do
+      expect {
+        BaseNotifier.explicit_sms_message
+      }.to raise_error(ActionView::MissingTemplate)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'combustion'
 
 Combustion.initialize!(:all) do
-  config.outbox.default_email_client = :test
+  config.outbox.use_test_client = true
   config.outbox.default_email_client_settings = { option_1: true }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outbox-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pete Browne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: outbox
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +162,7 @@ files:
 - lib/generators/test_unit/notifier/templates/notifier_test.rb
 - lib/outbox-rails.rb
 - lib/outbox/notifier.rb
+- lib/outbox/notifier_types.rb
 - lib/outbox/rails.rb
 - lib/outbox/rails/railtie.rb
 - lib/outbox/rails/version.rb