outbox 0.1.0 → 0.1.1

checksums.yaml

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

data/lib/outbox.rb

@@ -3,6 +3,7 @@ module Outbox
   require 'outbox/version'
 
   autoload 'Accessor', 'outbox/accessor'
+  autoload 'DefineInheritableMethod', 'outbox/define_inheritable_method'
   autoload 'Message', 'outbox/message'
   autoload 'MessageClients', 'outbox/message_clients'
   autoload 'MessageFields', 'outbox/message_fields'

data/lib/outbox/define_inheritable_method.rb

@@ -0,0 +1,25 @@
+module Outbox
+  module DefineInheritableMethod
+    # Similar to .define_method, but adds a dynamic module in the inheritance
+    # change to attach the method to. See:
+    #
+    # http://thepugautomatic.com/2013/07/dsom/
+    def define_inheritable_method(mod_name, *args, &block)
+      mod = get_inheritable_module(mod_name)
+      mod.module_eval do
+        define_method(*args, &block)
+      end
+    end
+
+    protected
+
+    def get_inheritable_module(mod_name)
+      if const_defined?(mod_name, _search_ancestors = false)
+        mod = const_get(mod_name)
+      else
+        mod = const_set(mod_name, Module.new)
+        include mod
+      end
+    end
+  end
+end

data/lib/outbox/message.rb

@@ -23,6 +23,15 @@ module Outbox
       end
     end
 
+    # Loops through each registered message type and sets the content body.
+    def body(value)
+      each_message_type do |message_type, message|
+        next if message.nil?
+        message.body = value
+      end
+    end
+    alias :body= :body
+
     # Delivers all of the messages to the given 'audience'. An 'audience' object
     # can be a hash or an object that responds to the current message types. Only
     # the message types specified in the 'audience' object will be sent to.
@@ -35,8 +44,7 @@ module Outbox
     def deliver(audience)
       audience = Outbox::Accessor.new(audience)
 
-      self.class.message_types.each_key do |message_type|
-        message = self.public_send(message_type)
+      each_message_type do |message_type, message|
         next if message.nil?
 
         recipient = audience[message_type]

data/lib/outbox/message_fields.rb

@@ -1,10 +1,13 @@
 module Outbox
   module MessageFields
     def self.included(base)
+      base.extend Outbox::DefineInheritableMethod
       base.extend ClassMethods
     end
 
     module ClassMethods
+      DYNAMIC_MODULE_NAME = :DynamicFields
+
       # Sets default values for defined fields.
       #
       #   Email.defaults from: 'bob@example.com'
@@ -123,7 +126,7 @@ module Outbox
       protected
 
       def define_field_reader(name)
-        define_method(name) do |value = nil|
+        define_inheritable_method(DYNAMIC_MODULE_NAME, name) do |value = nil|
           if value.nil?
             @fields[name]
           else
@@ -133,7 +136,7 @@ module Outbox
       end
 
       def define_field_writer(name)
-        define_method("#{name}=") do |value|
+        define_inheritable_method(DYNAMIC_MODULE_NAME, "#{name}=") do |value|
           @fields[name] = value
         end
       end

data/lib/outbox/message_types.rb

@@ -1,10 +1,13 @@
 module Outbox
   module MessageTypes
     def self.included(base)
+      base.extend Outbox::DefineInheritableMethod
       base.extend ClassMethods
     end
 
     module ClassMethods
+      DYNAMIC_MODULE_NAME = :DynamicMessageTypes
+
       # Registers a message type for sending & creates accessors.
       #
       #   Message.register_message_type :telepathy, TelepathyMessage
@@ -23,6 +26,7 @@ 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)
       end
 
       # Returns a hash of the registred message types, where the key is the name
@@ -35,28 +39,51 @@ module Outbox
 
       def define_message_type_reader(name, message_type)
         ivar_name = "@#{name}"
-        define_method(name) do |options = nil, &block|
-          if options || block
-            instance_variable_set(ivar_name, message_type.new(options, &block))
-          else
-            instance_variable_get(ivar_name)
+        define_inheritable_method(DYNAMIC_MODULE_NAME, name) do |fields = nil, &block|
+          instance = instance_variable_get(ivar_name)
+
+          if instance.nil? && (fields || block)
+            instance = message_type.new
+            instance_variable_set(ivar_name, instance)
+          end
+
+          if block
+            instance.instance_eval(&block)
+          elsif fields
+            instance.fields = fields
           end
+
+          instance
         end
       end
 
       def define_message_type_writer(name)
-        define_method("#{name}=") do |value|
+        define_inheritable_method(DYNAMIC_MODULE_NAME, "#{name}=") do |value|
           instance_variable_set("@#{name}", value)
         end
       end
-    end
 
-    protected
+      def define_default_message_type_client_accessor(name, message_type)
+        define_singleton_method "default_#{name}_client" do |*args|
+          message_type.default_client(*args)
+        end
+      end
+    end
 
+    # Assign the given hash where each key is a message type and
+    # the value is a hash of options for that message type.
     def assign_message_type_values(values)
       values.each do |key, value|
         self.public_send(key, value) if self.respond_to?(key)
       end
     end
+
+    # Loops through each registered message type and yields the instance
+    # of that type on this message.
+    def each_message_type
+      self.class.message_types.each_key do |message_type|
+        yield message_type, self.public_send(message_type)
+      end
+    end
   end
 end

data/lib/outbox/messages/base.rb

@@ -34,6 +34,12 @@ module Outbox
         self.to = audience if self.respond_to?(:to=)
       end
 
+      # Sets the 'body' for this message. All message types must implement
+      # this method.
+      def body=(body)
+        raise NotImplementedError, 'Subclasses must implement a body= method'
+      end
+
       # Validates the current message and delivers the message using the
       # defined client.
       def deliver(audience = nil)

data/lib/outbox/messages/email.rb

@@ -39,7 +39,9 @@ module Outbox
              :resent_message_id, :resent_sender, :resent_to, :return_path,
              :sender, :to, :comments, :subject, accessor: false
 
-      def initialize(fields = nil, &block)
+      undef :body=, :[], :[]=
+
+      def initialize(fields = nil, &block) # :nodoc:
         @message = ::Mail::Message.new
         super
       end
@@ -49,7 +51,7 @@ module Outbox
         @message
       end
 
-      def audience=(audience)
+      def audience=(audience) # :nodoc:
         case audience
         when String, Array
           self.to = audience
@@ -61,6 +63,8 @@ module Outbox
         end
       end
 
+      protected
+
       def method_missing(method, *args, &block)
         if @message.respond_to?(method)
           @message.public_send(method, *args, &block)
@@ -70,7 +74,7 @@ module Outbox
       end
 
       def respond_to_missing?(method, include_private = false)
-        @message.respond_to?(method, include_private) || super
+        super || @message.respond_to?(method, include_private)
       end
     end
   end

data/lib/outbox/version.rb

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

data/spec/outbox/clients/base_spec.rb

@@ -1,20 +1,20 @@
 require 'spec_helper'
 
 describe Outbox::Clients::Base do
-  class Client < Outbox::Clients::Base
+  class BaseClient < Outbox::Clients::Base
     defaults foo: 10
   end
 
   describe '.defaults' do
     it 'defines default settings' do
-      client = Client.new
+      client = BaseClient.new
       expect(client.settings[:foo]).to eq(10)
     end
   end
 
   describe '.new' do
     it 'initializes settings' do
-      client = Client.new foo: 1, bar: 2
+      client = BaseClient.new foo: 1, bar: 2
       expect(client.settings[:foo]).to eq(1)
       expect(client.settings[:bar]).to eq(2)
     end
@@ -22,7 +22,7 @@ describe Outbox::Clients::Base do
 
   describe '#deliver' do
     it 'raises an error' do
-      client = Client.new
+      client = BaseClient.new
       expect{client.deliver(Outbox::Messages::Base.new)}.to raise_error(NotImplementedError)
     end
   end

data/spec/outbox/message_spec.rb

@@ -4,11 +4,19 @@ describe Outbox::Message do
   class Telepathy < Outbox::Messages::Base
     default_client :test
     fields :to, :from, :thought
+
+    def body=(value)
+      self.thought = value
+    end
   end
 
   class MessageInABottle < Outbox::Messages::Base
     default_client :test
     fields :to, :bottle, :message
+
+    def body=(value)
+      self.message = value
+    end
   end
 
   before do
@@ -63,6 +71,68 @@ describe Outbox::Message do
     end
   end
 
+  describe 'default message type client' do
+    after do
+      Telepathy.registered_client_aliases.delete(:foo)
+      Telepathy.default_client :test
+    end
+
+    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
+      expect(Telepathy.default_client).to be(client)
+    end
+  end
+
+  describe 'message type reader' do
+    context 'when uninitialized' do
+      it 'returns nil' do
+        expect(Outbox::Message.new.telepathy).to be_nil
+      end
+
+      context 'with a hash' do
+        it 'creates a new instance' do
+          message = Outbox::Message.new
+          message.telepathy thought: 'What?'
+          expect(message.telepathy.thought).to eq('What?')
+        end
+      end
+    end
+
+    context 'when initialized' do
+      before do
+        @message = Outbox::Message.new do
+          telepathy do
+            from 'Bob'
+            thought 'What?'
+          end
+        end
+      end
+
+      context 'with a hash' do
+        it 'applies the fields values' do
+          @message.telepathy thought: 'Hello world.'
+          expect(@message.telepathy.from).to eq('Bob')
+          expect(@message.telepathy.thought).to eq('Hello world.')
+        end
+      end
+
+      context 'with a block' do
+        it 'applies the fields values' do
+          @message.telepathy do
+            thought 'Hello world.'
+          end
+          expect(@message.telepathy.from).to eq('Bob')
+          expect(@message.telepathy.thought).to eq('Hello world.')
+        end
+      end
+    end
+  end
+
   describe '#deliver' do
     before do
       @message = Outbox::Message.new do
@@ -100,4 +170,18 @@ describe Outbox::Message do
       end
     end
   end
+
+  describe '#body' do
+    it 'assigns the value to all message types' do
+      message = Outbox::Message.new do
+        email {}
+        telepathy {}
+        bottle {}
+        body 'Simple Message'
+      end
+      expect(message.email.body.encoded).to eq('Simple Message')
+      expect(message.telepathy.thought).to eq('Simple Message')
+      expect(message.bottle.message).to eq('Simple Message')
+    end
+  end
 end

data/spec/outbox/messages/base_spec.rb

@@ -19,37 +19,19 @@ describe Outbox::Messages::Base do
   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
 
@@ -74,11 +56,11 @@ describe Outbox::Messages::Base do
     after { Message.default_client :test }
 
     it 'registers a client alias' do
-      Client = Class.new
-      Message.register_client_alias :foo, Client
+      client_class = Class.new
+      Message.register_client_alias :foo, client_class
       client = double :client
       options = { option_1: 1, option_2: 2 }
-      expect(Client).to receive(:new).with(options) { client}
+      expect(client_class).to receive(:new).with(options) { client}
       Message.default_client :foo, options
       expect(Message.default_client).to be(client)
     end
@@ -101,19 +83,11 @@ describe Outbox::Messages::Base do
     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
+      dynamic_methods = MessageWithoutFieldAccessors::DynamicFields.public_instance_methods
+      expect(dynamic_methods).not_to include(:to=)
+      expect(dynamic_methods).not_to include(:to)
+      expect(dynamic_methods).not_to include(:from)
+      expect(dynamic_methods).not_to include(:body=)
     end
   end
 
@@ -176,6 +150,14 @@ describe Outbox::Messages::Base do
     end
   end
 
+  describe '#body=' do
+    it 'raises an error' do
+      message_type = Class.new Outbox::Messages::Base
+      message = message_type.new
+      expect{message.body = 'Something'}.to raise_error(NotImplementedError)
+    end
+  end
+
   describe '#deliver' do
     context 'when valid' do
       it 'delivers the message using a client' do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: outbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Pete Browne
 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: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,49 +41,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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
   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'
 description: A generic interface for sending email, SMS, & push notifications.
@@ -109,6 +98,7 @@ files:
 - lib/outbox/clients/base.rb
 - lib/outbox/clients/mail_client.rb
 - lib/outbox/clients/test_client.rb
+- lib/outbox/define_inheritable_method.rb
 - lib/outbox/errors.rb
 - lib/outbox/message.rb
 - lib/outbox/message_clients.rb
@@ -130,33 +120,26 @@ files:
 homepage: https://github.com/localmed/outbox
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1152741713307649410
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1152741713307649410
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 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: