outbox 0.0.1 → 0.1.0

data/spec/outbox/messages/base_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+
+describe Outbox::Messages::Base do
+  class Message < Outbox::Messages::Base
+    default_client :test
+    fields :to, 'from'
+    field :foo
+  end
+
+  class MessageWithRequiredField < Outbox::Messages::Base
+    default_client :test
+    field :foo, required: true
+  end
+
+  class MessageWithRequiredFields < Outbox::Messages::Base
+    default_client :test
+    required_fields :to, :from
+    fields :foo
+  end
+
+  class MessageWithoutFieldAccessors < Outbox::Messages::Base
+    attr_reader :to_reader_called, :to_writer_called,
+                :from_reader_called, :from_writer_called,
+                :body_reader_called, :body_writer_called
+
+    def to(value = nil)
+      @to_reader_called = true
+      value ? @to = value : @to
+    end
+
+    def to=(value)
+      @to_writer_called = true
+      @to = value
+    end
+
+    def from(value = nil)
+      @from_reader_called = true
+      value ? @fields[:from] = value : @fields[:from]
+    end
+
+    def from=(value)
+      @from_writer_called = true
+      @fields[:from] = value
+    end
+
+    def body
+      @body_reader_called = true
+      @fields[:body]
+    end
+
+    def body=(value)
+      @body_writer_called = true
+      @fields[:body] = value
+    end
+
+    field :to, accessor: false
+    field :from, reader: false
+    field :body, writer: false
+  end
+
+  describe '.default_client' do
+    after { Message.default_client :test }
+
+    it 'sets the default client' do
+      client = double :client
+      allow(client).to receive(:dup) { client }
+      Message.default_client(client)
+      message = Message.new
+      expect(message.client).to be(client)
+    end
+  end
+
+  describe '.register_client' do
+    after { Message.default_client :test }
+
+    it 'registers a client alias' do
+      Client = Class.new
+      Message.register_client_alias :foo, Client
+      client = double :client
+      options = { option_1: 1, option_2: 2 }
+      expect(Client).to receive(:new).with(options) { client}
+      Message.default_client :foo, options
+      expect(Message.default_client).to be(client)
+    end
+  end
+
+  describe '.field' do
+    it 'creates accessors for defined fields' do
+      message = Message.new
+      message.foo = :foo
+      expect(message.foo).to eq(:foo)
+      message.foo :bar
+      expect(message.foo).to eq(:bar)
+    end
+
+    it 'allows hash accessors for defined fields' do
+      message = Message.new
+      message['foo'] = :foo
+      expect(message[:foo]).to eq(:foo)
+      expect(message.foo).to eq(:foo)
+    end
+
+    it 'does not create accessors if specified' do
+      message = MessageWithoutFieldAccessors.new
+      message.to = 'Bob'
+      message.from = 'John'
+      message.body = 'Hi'
+      expect(message.to).to eq('Bob')
+      expect(message.from).to eq('John')
+      expect(message.body).to eq('Hi')
+      expect(message.to_reader_called).to be_true
+      expect(message.to_writer_called).to be_true
+      expect(message.from_reader_called).to be_true
+      expect(message.from_writer_called).to be_false
+      expect(message.body_reader_called).to be_false
+      expect(message.body_writer_called).to be_true
+    end
+  end
+
+  describe '.defaults' do
+    it 'sets the fields defaults' do
+      Message.defaults from: 'John'
+      message = Message.new
+      expect(message.from).to eql('John')
+    end
+
+    context 'without field accessors' do
+      after { MessageWithoutFieldAccessors.instance_variable_set :@defaults, nil }
+
+      it 'still sets the defaults' do
+        MessageWithoutFieldAccessors.defaults to: 'Bob'
+        message = MessageWithoutFieldAccessors.new
+        expect(message.to).to eq('Bob')
+      end
+    end
+  end
+
+  describe '.new' do
+    it 'initializes with a hash' do
+      message = Message.new to: 'Bob', oops: 'John'
+      expect(message.to).to eq('Bob')
+      expect(message).to_not respond_to(:oops)
+    end
+
+    it 'initializes with a block' do
+      message = Message.new do
+        to 'Bob'
+        from 'John'
+      end
+      expect(message.to).to eq('Bob')
+      expect(message.from).to eq('John')
+    end
+  end
+
+  describe '#fields' do
+    it 'returns a hash of the fields' do
+      message = Message.new
+      message.to = 'Bob'
+      message.from = 'John'
+      expect(message.fields).to eq(to: 'Bob', from: 'John', body: nil, foo: nil)
+    end
+
+    context 'without field accessors' do
+      it 'returns a hash of the fields' do
+        message = MessageWithoutFieldAccessors.new to: 'Bob', from: 'John'
+        expect(message.fields).to eq(to: 'Bob', from: 'John', body: nil)
+      end
+    end
+  end
+
+  describe '#audience=' do
+    it 'sets the to field by default' do
+      message = Message.new
+      message.audience = 'Bob'
+      expect(message.to).to eq('Bob')
+    end
+  end
+
+  describe '#deliver' do
+    context 'when valid' do
+      it 'delivers the message using a client' do
+        client = double :client
+        message = Message.new
+        message.client(client)
+        expect(client).to receive(:deliver).with(message)
+        message.deliver
+      end
+    end
+
+    context 'with an audience' do
+      it 'delivers to that audience' do
+        message = Message.new
+        message.deliver 'Bob'
+        expect(message.to).to eq('Bob')
+      end
+    end
+
+    context 'with a required field' do
+      it 'raises an error' do
+        message = MessageWithRequiredField.new
+        expect{message.deliver}.to raise_error(Outbox::MissingRequiredFieldError)
+      end
+    end
+
+    context 'with required fields' do
+      it 'raises an error' do
+        message = MessageWithRequiredFields.new to: 'Bob'
+        expect{message.deliver}.to raise_error(Outbox::MissingRequiredFieldError)
+      end
+    end
+  end
+end

data/spec/outbox/messages/email_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Outbox::Messages::Email do
+  it 'sets common email fields' do
+    email = Outbox::Messages::Email.new do
+      to 'bob@gmail.com'
+      from 'john@gmail.com'
+      subject 'Simple email subject'
+      body 'Hello world.'
+    end
+    expect(email.to).to eq(['bob@gmail.com'])
+    expect(email.from).to eq(['john@gmail.com'])
+    expect(email.subject).to eq('Simple email subject')
+    expect(email.body).to eq('Hello world.')
+  end
+
+  it 'sets a multipart body' do
+    email = Outbox::Messages::Email.new do
+      text_part do
+        body 'Hello world.'
+      end
+      html_part do
+        body '<h1>Hello world.</h1>'
+      end
+    end
+    expect(email.parts.length).to eq(2)
+  end
+
+  describe '.registered_client_aliases' do
+    it 'includes TestClient' do
+      expect(Outbox::Messages::Email.registered_client_aliases[:test]).to eq(Outbox::Clients::TestClient)
+    end
+
+    it 'includes MailClient' do
+      expect(Outbox::Messages::Email.registered_client_aliases[:mail]).to eq(Outbox::Clients::MailClient)
+    end
+  end
+
+  describe '.default_client' do
+    it 'defaults to MailClient' do
+      expect(Outbox::Messages::Email.default_client).to be_an_instance_of(Outbox::Clients::MailClient)
+    end
+  end
+
+  describe '#audience=' do
+    context 'with a string' do
+      it 'sets the To: field' do
+        email = Outbox::Messages::Email.new
+        email.audience = 'bob@gmail.com'
+        expect(email.to).to eq(['bob@gmail.com'])
+      end
+    end
+
+    context 'with an array' do
+      it 'sets the To: field' do
+        email = Outbox::Messages::Email.new
+        email.audience = ['bob@gmail.com', 'john@gmail.com']
+        expect(email.to).to eq(['bob@gmail.com', 'john@gmail.com'])
+      end
+    end
+
+    context 'with a hash' do
+      it 'sets multiple fields' do
+        email = Outbox::Messages::Email.new
+        email.audience = {
+          :to => 'bob@gmail.com',
+          :cc => 'john@gmail.com',
+          'bcc' => 'sally@gmail.com',
+          :from => 'someone@gmail.com'
+        }
+        expect(email.to).to eq(['bob@gmail.com'])
+        expect(email.cc).to eq(['john@gmail.com'])
+        expect(email.bcc).to eq(['sally@gmail.com'])
+        expect(email.from).to be_nil
+      end
+    end
+
+    context 'with an object' do
+      it 'sets multiple fields' do
+        email = Outbox::Messages::Email.new
+        email.audience = OpenStruct.new to: 'bob@gmail.com', cc: 'john@gmail.com'
+        expect(email.to).to eq(['bob@gmail.com'])
+        expect(email.cc).to eq(['john@gmail.com'])
+      end
+    end
+  end
+
+  describe '#validate_fields' do
+    before do
+      @valid_email = Outbox::Messages::Email.new do
+        to 'bob@gmail.com'
+        from 'john@gmail.com'
+        body 'Hello world.'
+      end
+    end
+
+    it 'does not raise an error with a valid email' do
+      expect{@valid_email.validate_fields}.not_to raise_error()
+    end
+
+    it 'raises an error without a recipient' do
+      @valid_email.to = nil
+      expect{@valid_email.validate_fields}.to raise_error(Outbox::MissingRequiredFieldError)
+    end
+
+    it 'does not raise an error with a Cc: field' do
+      @valid_email.to = nil
+      @valid_email.cc = 'bob@gmail.com'
+      expect{@valid_email.validate_fields}.not_to raise_error()
+    end
+
+    it 'does not raise an error with a Bcc: field' do
+      @valid_email.to = nil
+      @valid_email.bcc = 'bob@gmail.com'
+      expect{@valid_email.validate_fields}.not_to raise_error()
+    end
+
+    it 'raises an error without a receiver' do
+      @valid_email.from = nil
+      expect{@valid_email.validate_fields}.to raise_error(Outbox::MissingRequiredFieldError)
+    end
+
+    it 'does not raise an error with a Return-path: field' do
+      @valid_email.from = nil
+      @valid_email.return_path = 'bob@gmail.com'
+      expect{@valid_email.validate_fields}.not_to raise_error()
+    end
+
+    it 'does not raise an error with a Sender: field' do
+      @valid_email.from = nil
+      @valid_email.sender = 'bob@gmail.com'
+      expect{@valid_email.validate_fields}.not_to raise_error()
+    end
+  end
+end

data/spec/outbox_spec.rb

@@ -4,8 +4,4 @@ describe Outbox do
   it 'should have a version number' do
     expect(Outbox::VERSION).to_not be_nil
   end
-
-  it 'should do something useful' do
-    expect(true).to be_true
-  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,11 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'ostruct'
+require 'mail'
 require 'outbox'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Outbox::Clients::TestClient.deliveries.clear
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +91,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A Rails engine and generic interface for sending email, SMS, & push notifications.
+description: A generic interface for sending email, SMS, & push notifications.
 email:
 - pete.browne@localmed.com
 executables: []
@@ -89,8 +105,26 @@ files:
 - README.md
 - Rakefile
 - lib/outbox.rb
+- lib/outbox/accessor.rb
+- lib/outbox/clients/base.rb
+- lib/outbox/clients/mail_client.rb
+- lib/outbox/clients/test_client.rb
+- lib/outbox/errors.rb
+- lib/outbox/message.rb
+- lib/outbox/message_clients.rb
+- lib/outbox/message_fields.rb
+- lib/outbox/message_types.rb
+- lib/outbox/messages/base.rb
+- lib/outbox/messages/email.rb
 - lib/outbox/version.rb
 - outbox.gemspec
+- spec/outbox/accessor_spec.rb
+- spec/outbox/clients/base_spec.rb
+- spec/outbox/clients/mail_client_spec.rb
+- spec/outbox/clients/test_client_spec.rb
+- spec/outbox/message_spec.rb
+- spec/outbox/messages/base_spec.rb
+- spec/outbox/messages/email_spec.rb
 - spec/outbox_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/localmed/outbox
@@ -108,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1226627478344272925
+      hash: -1152741713307649410
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,15 +151,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1226627478344272925
+      hash: -1152741713307649410
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Outbox is a Rails engine and generic interface for sending notifications
-  using a variety of delivery methods, with built-in support for the most popular
-  SaaS solutions.
+summary: Outbox is a generic interface for sending notifications using a variety of
+  protocols, with built-in support for the most popular SaaS solutions.
 test_files:
+- spec/outbox/accessor_spec.rb
+- spec/outbox/clients/base_spec.rb
+- spec/outbox/clients/mail_client_spec.rb
+- spec/outbox/clients/test_client_spec.rb
+- spec/outbox/message_spec.rb
+- spec/outbox/messages/base_spec.rb
+- spec/outbox/messages/email_spec.rb
 - spec/outbox_spec.rb
 - spec/spec_helper.rb