outbox 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b94d8233a2c331495060c6d33e8e94b2d3d0cae
-  data.tar.gz: eb43a9e7d7b3ced480238c6b47ac0ca6eb5af721
+  metadata.gz: 7b0251b3437146e36c621521831de3f1b1f66754
+  data.tar.gz: edf0111ebfff3b8cf1d7a6716ac3fb72c59f934a
 SHA512:
-  metadata.gz: 14d61db45eff14c42092302401dd1317bfeffb13fa500f3ad86f7d387b3a766049b36dcf69e525e63f3c9f6605c34d8e2d87cfe217bd67f7da40d712cd19b9a1
-  data.tar.gz: 5fcf9d9938dbece72b956402b0644a08b7c7bb7dd2ec51d36b16c49d3aa7cc1e1d677b246b18b81fe02b12e7311181adbc42de07110849e2af03b1a3dffb21ce
+  metadata.gz: 0fab54a11397b3fdd99407adcd41f16f10f624eba332686cf3c8c0fb3924605b5590f226da3fe2a51602a1aaad1ab8a48a5d1bb5cf2b7b9b664e0f9966fed1ed
+  data.tar.gz: b3228876ee7f25bd9dfe9d53983fb691c7ad907c628ba227d0a58b621a4482f013cf1c50efc9578dea886ac81e3cf6ea04da91179fbb37cf0a2a60b7a00dbae2

data/lib/outbox/clients/mail_client.rb

@@ -21,7 +21,7 @@ module Outbox
       #   }
       #   client.delivery_method_settings #=> { location: '/usr/bin/sendmail' }
       def delivery_method_settings
-        settings[:delivery_method_settings] || settings[:"#{delivery_method}_settings"]
+        settings[:delivery_method_settings] || settings[:"#{delivery_method}_settings"] || {}
       end
 
       def deliver(email)

data/lib/outbox/message.rb

@@ -4,6 +4,14 @@ module Outbox
 
     register_message_type :email, Outbox::Messages::Email
 
+    # Use the Outbox::Clients::TestClient for all message types. This is
+    # useful for testing or working an a development environment.
+    def self.use_test_client
+      message_types.each_value do |message_type|
+        message_type.default_client(:test)
+      end
+    end
+
     # Make a new message. Every message can be created using a hash,
     # block, or direct assignment.
     #

data/lib/outbox/message_clients.rb

@@ -13,13 +13,26 @@ module Outbox
       #
       #   Email.default_client :test, option: 'foo'
       #   Email.default_client #=> #<Outbox::Clients::TestClient>
-      def default_client(client = nil, options = nil)
-        if client.nil?
-          @default_client
-        else
-          @default_client = get_client(client, options)
+      def default_client(client = nil, settings = nil)
+        @default_client = get_client(client, settings) if client
+        @default_client
+      end
+
+      # Sets the default client.
+      def default_client=(client)
+        @default_client = get_client(client)
+      end
+
+      # Configure the default client.
+      def default_client_settings(settings = nil)
+        if default_client.nil?
+          raise ArgumentError, 'default_client must be set before setting default_client_settings'
         end
+
+        default_client.settings.merge!(settings) if settings
+        default_client.settings
       end
+      alias :default_client_settings= :default_client_settings
 
       # Registers a client class with an alias.
       #

data/lib/outbox/message_fields.rb

@@ -15,13 +15,10 @@ module Outbox
       #   message.from #=> 'bob@example.com'
       def defaults(defaults = nil)
         @defaults ||= {}
-
-        if defaults.nil?
-          @defaults
-        else
-          @defaults.merge!(defaults)
-        end
+        @defaults.merge!(defaults) if defaults
+        @defaults
       end
+      alias :defaults= :defaults
 
       # Returns the defined fields for this message type.
       #

data/lib/outbox/message_types.rb

@@ -26,7 +26,9 @@ module Outbox
         message_types[name.to_sym] = message_type
         define_message_type_reader(name, message_type)
         define_message_type_writer(name)
-        define_default_message_type_client_accessor(name, message_type)
+        define_default_message_type_client_accessors(name, message_type)
+        define_default_message_type_client_settings_accessors(name, message_type)
+        define_message_type_defaults_accessors(name, message_type)
       end
 
       # Returns a hash of the registred message types, where the key is the name
@@ -63,10 +65,34 @@ module Outbox
         end
       end
 
-      def define_default_message_type_client_accessor(name, message_type)
+      def define_default_message_type_client_accessors(name, message_type)
         define_singleton_method "default_#{name}_client" do |*args|
           message_type.default_client(*args)
         end
+
+        define_singleton_method "default_#{name}_client=" do |client|
+          message_type.default_client = client
+        end
+      end
+
+      def define_default_message_type_client_settings_accessors(name, message_type)
+        define_singleton_method "default_#{name}_client_settings" do |*args|
+          message_type.default_client_settings(*args)
+        end
+
+        define_singleton_method "default_#{name}_client_settings=" do |settings|
+          message_type.default_client_settings = settings
+        end
+      end
+
+      def define_message_type_defaults_accessors(name, message_type)
+        define_singleton_method "#{name}_defaults" do |*args|
+          message_type.defaults(*args)
+        end
+
+        define_singleton_method "#{name}_defaults=" do |defaults|
+          message_type.defaults = defaults
+        end
       end
     end
 

data/lib/outbox/version.rb

@@ -1,3 +1,3 @@
 module Outbox
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/outbox/message_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe Outbox::Message do
+  class MockTelepathyClient < Outbox::Clients::TestClient
+  end
+
   class Telepathy < Outbox::Messages::Base
+    register_client_alias :mock, MockTelepathyClient
     default_client :test
     fields :to, :from, :thought
 
@@ -27,6 +31,22 @@ describe Outbox::Message do
 
   after do
     Outbox::Message.instance_variable_set :@message_types, @original_message_types
+    Telepathy.instance_variable_set :@defaults, {}
+    Telepathy.default_client :test
+  end
+
+  describe '.use_test_client' do
+    after do
+      Outbox::Message.default_email_client :mail
+    end
+
+    it 'sets the default client to TestClient for all message types' do
+      Telepathy.default_client :mock
+      Outbox::Message.use_test_client
+      expect(Telepathy.default_client).to be_a(Outbox::Clients::TestClient)
+      expect(MessageInABottle.default_client).to be_a(Outbox::Clients::TestClient)
+      expect(Outbox::Messages::Email.default_client).to be_a(Outbox::Clients::TestClient)
+    end
   end
 
   describe '.message_types' do
@@ -71,20 +91,53 @@ describe Outbox::Message do
     end
   end
 
-  describe 'default message type client' do
-    after do
-      Telepathy.registered_client_aliases.delete(:foo)
-      Telepathy.default_client :test
+  describe '.default_[message_type]_client' do
+    it 'sets the default client for that message type' do
+      Outbox::Message.default_telepathy_client :mock, option_1: 1
+      client = Outbox::Message.default_telepathy_client
+      expect(Telepathy.default_client).to be(client)
+      expect(client).to be_a(MockTelepathyClient)
+      expect(client.settings[:option_1]).to eq(1)
     end
+  end
 
+  describe '.default_[message_type]_client=' do
     it 'sets the default client for that message type' do
-      client_class = Class.new
-      Telepathy.register_client_alias :foo, client_class
-      client = double :client
-      options = { option_1: 1, option_2: 2 }
-      expect(client_class).to receive(:new).with(options) { client}
-      Outbox::Message.default_telepathy_client :foo, options
+      Outbox::Message.default_telepathy_client = :mock
+      client = Outbox::Message.default_telepathy_client
       expect(Telepathy.default_client).to be(client)
+      expect(client).to be_a(MockTelepathyClient)
+    end
+  end
+
+  describe '.default_[message_type]_client_settings' do
+    it 'sets the default client for that message type' do
+      Outbox::Message.default_telepathy_client_settings option_1: 1
+      client = Outbox::Message.default_telepathy_client
+      expect(client.settings[:option_1]).to eq(1)
+    end
+  end
+
+  describe '.default_[message_type]_client_settings=' do
+    it 'sets the default client for that message type' do
+      Outbox::Message.default_telepathy_client_settings = { option_1: 1 }
+      client = Outbox::Message.default_telepathy_client
+      expect(client.settings[:option_1]).to eq(1)
+    end
+  end
+
+  describe '.[message_type]_defaults' do
+    it 'sets the defaults for that message type' do
+      Outbox::Message.telepathy_defaults from: 'Me'
+      expect(Telepathy.new.from).to eq('Me')
+    end
+  end
+
+  describe '.[message_type]_defaults=' do
+    it 'sets the defaults for that message type' do
+      Outbox::Message.telepathy_defaults = { from: 'Me' }
+      expect(Outbox::Message.telepathy_defaults).to eq(Telepathy.defaults)
+      expect(Telepathy.new.from).to eq('Me')
     end
   end
 

data/spec/outbox/messages/base_spec.rb

@@ -40,9 +40,11 @@ describe Outbox::Messages::Base do
     field :body, writer: false
   end
 
-  describe '.default_client' do
-    after { Message.default_client :test }
+  after do
+    Message.default_client :test
+  end
 
+  describe '.default_client' do
     it 'sets the default client' do
       client = double :client
       allow(client).to receive(:dup) { client }
@@ -52,9 +54,42 @@ describe Outbox::Messages::Base do
     end
   end
 
-  describe '.register_client' do
-    after { Message.default_client :test }
+  describe '.default_client=' do
+    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 '.default_client_settings' do
+    it 'sets the default client settings' do
+      Message.default_client_settings option_1: true
+      message = Message.new
+      expect(message.client.settings[:option_1]).to eq(true)
+    end
+
+    context 'without a default client' do
+      it 'sets the default client settings once set' do
+        Message.instance_variable_set :@default_client, nil
+        expect {
+          Message.default_client_settings option_1: true
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '.default_client_settings=' do
+    it 'sets the default client settings' do
+      Message.default_client_settings = { option_1: true }
+      message = Message.new
+      expect(message.client.settings[:option_1]).to eq(true)
+    end
+  end
+
+  describe '.register_client' do
     it 'registers a client alias' do
       client_class = Class.new
       Message.register_client_alias :foo, client_class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outbox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Pete Browne