outbox-rails 0.0.1 → 0.1.0

data/README.md

@@ -1,26 +1,70 @@
-# Outbox::Rails
+Outbox::Rails
+=============
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/outbox-rails.png)](http://badge.fury.io/rb/outbox-rails)
 
-## Installation
+Rails Railtie for sending email, SMS, and push notifications using the [Outbox](https://github.com/localmed/outbox) gem. Please view the [Outbox documentation](https://github.com/localmed/outbox) to understand the philosophy behind this interface and how to use it.
+
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
-    gem 'outbox-rails'
+``` ruby
+gem 'outbox-rails'
+```
 
 And then execute:
 
-    $ bundle
+``` bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install outbox-rails
+``` bash
+$ gem install outbox-rails
+```
+
+Usage
+-----
+
+Outbox::Notifier uses a very similar interface to ActionMailer.
+
+First, define a notifier in `app/notifiers`:
+
+``` ruby
+class AccountNotifier < Outbox::Notifier
+  default email: { from: 'noreply@myapp.com' },
+          sms: { from: '+15551234567' }
+
+  def welcome
+    # Compose message types using the Outbox::Message interface
+    email do
+      subject 'Welcome to our App!'
+    end
+
+    sms do
+      body 'Welcome to our App!'
+    end
+
+    # Render the body of the message. This is analogous to ActionMailer::Base#mail,
+    # but unlike in ActionMailer, #render_message is not required.
+    render_message
+  end
+end
+```
 
-## Usage
+Send a message using the `deliver` method:
 
-TODO: Write usage instructions here
+```ruby
+# Unlike ActionMailer, deliver takes a single argument that defines the recipients
+# for the message types you want to send.
+AccountNotifier.welcome.deliver email: 'user@gmail.com', sms: '+15557654321'
+```
 
-## Contributing
+Contributing
+------------
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/outbox/notifier.rb

@@ -0,0 +1,107 @@
+require 'action_mailer'
+
+module Outbox
+  class Notifier < ActionMailer::Base
+    abstract!
+
+    delegate :attachments, :headers, to: :email
+    alias_method :_render_email, :mail
+    undef :mail
+
+    class << self
+      alias :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
+        else
+          self.mailer_name = value
+        end
+      end
+      alias :notifier_name= :notifier_name
+
+      protected
+
+      def method_missing(method_name, *args) # :nodoc:
+        if respond_to?(method_name)
+          new(method_name, *args).message
+        else
+          super
+        end
+      end
+    end
+
+    def initialize(method_name = nil, *args) # :nodoc:
+      super()
+      # 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
+      process(method_name, *args) if method_name
+    end
+
+    # The composed Outbox::Message instance.
+    def message
+      render_message unless message_rendered?
+      @_message
+    end
+
+    # Returns true if the message has already been rendered.
+    def message_rendered?
+      @_message_rendered
+    end
+
+    # Renders the message body. This is analagous to ActionMailer's #mail
+    # method, but is not required - it will be called implicitly when the
+    # #message object is retrieved.
+    def render_message(options = {}, &block)
+      @_message_rendered = true
+
+      # 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
+      email = render_email(email_options, &block)
+
+      @_message.assign_message_type_values(options)
+      assign_body_from_email(email)
+      @_message
+    end
+
+    protected
+
+    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.
+    end
+
+    def render_email(options, &block)
+      outbox_message = @_message
+      @_message = outbox_message.email || Mail.new
+      email = _render_email(options, &block)
+      @_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, self)
+  end
+end

data/lib/outbox/rails.rb

@@ -1,7 +1,11 @@
+require 'outbox'
 require 'outbox/rails/version'
+require 'outbox/rails/railtie'
+require 'active_support/rails'
 
 module Outbox
+  autoload :Notifier, 'outbox/notifier'
+
   module Rails
-    # Your code goes here...
   end
 end

data/lib/outbox/rails/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+module Outbox
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.outbox = Outbox::Message
+
+      initializer 'outbox.logger' do
+        ActiveSupport.on_load(:outbox) { self.logger ||= ::Rails.logger }
+      end
+    end
+  end
+end

data/lib/outbox/rails/version.rb

@@ -1,5 +1,5 @@
 module Outbox
   module Rails
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/outbox-rails.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Outbox::Rails::VERSION
   spec.authors       = ['Pete Browne']
   spec.email         = ['pete.browne@localmed.com']
-  spec.description   = %q{Rails Engine for sending email, SMS, and push notifications.}
-  spec.summary       = %q{Rails Engine for sending email, SMS, and push notifications.}
-  spec.homepage      = 'https://github.com/localmed/outbox'
+  spec.description   = %q{Rails Railtie for sending email, SMS, and push notifications using the Outbox gem.}
+  spec.summary       = %q{Rails Railtie for sending email, SMS, and push notifications using the Outbox gem.}
+  spec.homepage      = 'https://github.com/localmed/outbox-rails'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -18,8 +18,13 @@ 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.0'
+  spec.add_runtime_dependency 'outbox', '~> 0.1.1'
+  spec.add_runtime_dependency 'rails', '~> 4.0.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'combustion'
 end

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

@@ -0,0 +1,18 @@
+class BaseNotifier < Outbox::Notifier
+  defaults email: { from: 'noreply@myapp.com' }
+
+  def welcome(hash = {})
+    render_message(hash)
+  end
+
+  def implicit_multipart(hash = {})
+    attachments['invoice.pdf'] = 'This is test File content' if hash.delete(:attachments)
+    render_message(hash)
+  end
+
+  def composed_message_with_implicit_render
+    email do
+      subject 'Composed Message'
+    end
+  end
+end

data/spec/internal/app/views/base_notifier/composed_message_with_implicit_render.erb

@@ -0,0 +1 @@
+Composed Message with Implicit Render

data/spec/internal/app/views/base_notifier/implicit_multipart.html.erb

@@ -0,0 +1 @@
+HTML Implicit Multipart

data/spec/internal/app/views/base_notifier/implicit_multipart.text.erb

@@ -0,0 +1 @@
+TEXT Implicit Multipart

data/spec/internal/app/views/base_notifier/welcome.erb

@@ -0,0 +1 @@
+Welcome

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/outbox/rails/notifier_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Outbox::Notifier do
+  describe 'calling actions' do
+    it 'does not raise error' do
+      expect{BaseNotifier.welcome}.not_to raise_error()
+    end
+
+    it 'returns an Outbox Message' do
+      message = BaseNotifier.welcome
+      expect(message).to be_an_instance_of(Outbox::Message)
+    end
+
+    it 'passes the args to the action' do
+      message = BaseNotifier.welcome email: { subject: 'Subject Line' }
+      expect(message.email.subject).to eq('Subject Line')
+    end
+  end
+
+  describe '.logger' do
+    it 'defaults to Rails.logger' do
+      expect(BaseNotifier.logger).to be(Rails.logger)
+    end
+  end
+
+  describe '.defaults' do
+    it 'sets the default values' do
+      message = BaseNotifier.welcome
+      expect(message.email.from).to eq(['noreply@myapp.com'])
+    end
+  end
+
+  describe '.notifier_name' do
+    it 'returns the underscored class name' do
+      expect(BaseNotifier.notifier_name).to eq('base_notifier')
+    end
+
+    it 'returns anonymous for anonymous classes' do
+      notifier = Class.new Outbox::Notifier
+      expect(notifier.notifier_name).to eq('anonymous')
+    end
+
+    it 'is configurable' do
+      notifier = Class.new Outbox::Notifier
+      notifier.notifier_name 'some_notifier'
+      expect(notifier.notifier_name).to eq('some_notifier')
+      notifier.notifier_name = 'another_notifier'
+      expect(notifier.notifier_name).to eq('another_notifier')
+    end
+  end
+
+  describe '#email' do
+    it 'composes an email using Outbox interface' do
+      message = BaseNotifier.composed_message_with_implicit_render
+      expect(message.email.from).to eq(['noreply@myapp.com'])
+      expect(message.email.subject).to eq('Composed Message')
+    end
+  end
+
+  describe '#message' do
+    it 'renders the template' do
+      message = BaseNotifier.welcome
+      expect(message.email.body.encoded.strip).to eq('Welcome')
+    end
+
+    it 'handles multipart templates' do
+      message = BaseNotifier.implicit_multipart
+      expect(message.email.parts.size).to eq(2)
+      part_1 = message.email.parts[0]
+      part_2 = message.email.parts[1]
+      expect(part_1.mime_type).to eq('text/plain')
+      expect(part_1.body.encoded.strip).to eq('TEXT Implicit Multipart')
+      expect(part_2.mime_type).to eq('text/html')
+      expect(part_2.body.encoded.strip).to eq('HTML Implicit Multipart')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
+require 'combustion'
+
+Combustion.initialize!
+
+require 'rspec-rails'
 require 'outbox/rails'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outbox-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: outbox
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +91,72 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails Engine for sending email, SMS, and push notifications.
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails Railtie for sending email, SMS, and push notifications using the
+  Outbox gem.
 email:
 - pete.browne@localmed.com
 executables: []
@@ -88,13 +169,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config.ru
 - lib/outbox-rails.rb
+- lib/outbox/notifier.rb
 - lib/outbox/rails.rb
+- lib/outbox/rails/railtie.rb
 - lib/outbox/rails/version.rb
 - outbox-rails.gemspec
+- spec/internal/app/notifiers/base_notifier.rb
+- spec/internal/app/views/base_notifier/composed_message_with_implicit_render.erb
+- spec/internal/app/views/base_notifier/implicit_multipart.html.erb
+- spec/internal/app/views/base_notifier/implicit_multipart.text.erb
+- spec/internal/app/views/base_notifier/welcome.erb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/outbox/rails/notifier_spec.rb
 - spec/outbox/rails_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/localmed/outbox
+homepage: https://github.com/localmed/outbox-rails
 licenses:
 - MIT
 post_install_message: 
@@ -109,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -487938589802225081
+      hash: -2287336915534194965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,13 +213,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -487938589802225081
+      hash: -2287336915534194965
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Rails Engine for sending email, SMS, and push notifications.
+summary: Rails Railtie for sending email, SMS, and push notifications using the Outbox
+  gem.
 test_files:
+- spec/internal/app/notifiers/base_notifier.rb
+- spec/internal/app/views/base_notifier/composed_message_with_implicit_render.erb
+- spec/internal/app/views/base_notifier/implicit_multipart.html.erb
+- spec/internal/app/views/base_notifier/implicit_multipart.text.erb
+- spec/internal/app/views/base_notifier/welcome.erb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/outbox/rails/notifier_spec.rb
 - spec/outbox/rails_spec.rb
 - spec/spec_helper.rb