outbox 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b0251b3437146e36c621521831de3f1b1f66754
-  data.tar.gz: edf0111ebfff3b8cf1d7a6716ac3fb72c59f934a
+  metadata.gz: f4d0674db8e9a1b5e9ff4177d0ceb2ad37b10ae5
+  data.tar.gz: aed0fd01ee8e3022b381e9e5cdc6de527fc1a120
 SHA512:
-  metadata.gz: 0fab54a11397b3fdd99407adcd41f16f10f624eba332686cf3c8c0fb3924605b5590f226da3fe2a51602a1aaad1ab8a48a5d1bb5cf2b7b9b664e0f9966fed1ed
-  data.tar.gz: b3228876ee7f25bd9dfe9d53983fb691c7ad907c628ba227d0a58b621a4482f013cf1c50efc9578dea886ac81e3cf6ea04da91179fbb37cf0a2a60b7a00dbae2
+  metadata.gz: ad5f555dbe59e569c0f8a77c12d37d2847f21706f056b929fbc3b1a44a9cc22ecaf25064a5d58b02f9065072cf9e88b333756c851629563303515ced2113d4d9
+  data.tar.gz: 6cc7e36744f7b5a5f71ebc8f6cdbf826ff8f1e0323aafa5927534e9c7f6b3485a46720d9606c0fbd7fc8fe5f831a59954107eb03b06ea8df7ed9699b396b7ab0

data/README.md

@@ -34,13 +34,15 @@ This gem is still in early development with plans to support email, SMS, and pus
 
 ### Email
 
-| Service                                   | Alias   | Client     |
-|-------------------------------------------|---------|------------|
-| [Mail gem](https://github.com/mikel/mail) | `:mail` | MailClient |
+| Service                                   | Alias   | Client                        | Gem      |
+|-------------------------------------------|---------|-------------------------------|----------|
+| [Mail gem](https://github.com/mikel/mail) | `:mail` | `Outbox::Clients::MailClient` | Included |
 
 ### SMS
 
-TODO…
+| Service                                         | Alias     | Client                   | Gem                                                        |
+|-------------------------------------------------|-----------|--------------------------|------------------------------------------------------------|
+| [Twilio](https://github.com/twilio/twilio-ruby) | `:twilio` | `Outbox::Twilio::Client` | [outbox-twilio](https://github.com/localmed/outbox-twilio) |
 
 ### Push
 
@@ -67,7 +69,7 @@ message = Outbox::Message.new do
   end
 
   ios_push do
-    badget '+1'
+    badge '+1'
     sound 'default'
   end
 
@@ -75,7 +77,11 @@ message = Outbox::Message.new do
 end
 
 # This will deliver the message to User's given contact points.
-message.deliver email: 'user@gmail.com', sms: '+15551234567', ios_push: 'FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660'
+message.deliver(
+  email: 'user@gmail.com',
+  sms: '+15551234567',
+  ios_push: 'FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660'
+)
 ```
 
 ### Making an email
@@ -108,7 +114,55 @@ email.deliver
 Configuration
 -------------
 
-TODO...
+Configuration can be done in two ways:
+
+### 1. Configure clients as you need them
+
+``` ruby
+mail_client = Outbox::Clients::MailClient.new(
+  delivery_method: :smtp,
+  smtp_settings: {}
+)
+sms_client = Outbox::Twilio::Client.new(
+  account_sid: 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+  auth_token: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+)
+message = Outbox::Message.new do
+  email do
+    client(mail_client)
+    # content...
+  end
+
+  sms do
+    client(sms_client)
+    # content...
+  end
+end
+```
+
+### 2. Configure a default client for each message type
+
+``` ruby
+Outbox::Messages::Email.default_client(
+  :mail,
+  delivery_method: :smtp,
+  smtp_settings: {}
+)
+Outbox::Messages::SMS.default_client(
+  :twilio,
+  account_sid: 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+  auth_token: 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+)
+message = Outbox::Message.new do
+  email do
+    # content...
+  end
+
+  sms do
+    # content...
+  end
+end
+```
 
 Contributing
 ------------

data/lib/outbox.rb

@@ -18,5 +18,6 @@ module Outbox
   module Messages
     autoload 'Base', 'outbox/messages/base'
     autoload 'Email', 'outbox/messages/email'
+    autoload 'SMS', 'outbox/messages/sms'
   end
 end

data/lib/outbox/clients/mail_client.rb

@@ -11,17 +11,23 @@ module Outbox
       # Returns the configured delivery method settings. This will also check
       # the Rails-style #{delivery_method}_settings key as well.
       #
-      #   client = Outbox::Clients::MailClient.new delivery_method: :sendmail, delivery_method_settings: {
-      #     location: '/usr/bin/sendmail'
-      #   }
+      #   client = Outbox::Clients::MailClient.new(
+      #     delivery_method: :sendmail,
+      #     delivery_method_settings: { location: '/usr/bin/sendmail' }
+      #   )
       #   client.delivery_method_settings #=> { location: '/usr/bin/sendmail' }
       #
-      #   client = Outbox::Clients::MailClient.new delivery_method: :sendmail, sendmail_settings: {
-      #     location: '/usr/bin/sendmail'
-      #   }
+      #   client = Outbox::Clients::MailClient.new(
+      #     delivery_method: :sendmail,
+      #     sendmail_settings: { location: '/usr/bin/sendmail' }
+      #   )
       #   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/define_inheritable_method.rb

@@ -14,11 +14,10 @@ module Outbox
     protected
 
     def get_inheritable_module(mod_name)
-      if const_defined?(mod_name, _search_ancestors = false)
-        mod = const_get(mod_name)
+      if const_defined?(mod_name, false)
+        const_get(mod_name)
       else
-        mod = const_set(mod_name, Module.new)
-        include mod
+        include const_set(mod_name, Module.new)
       end
     end
   end

data/lib/outbox/message.rb

@@ -3,6 +3,7 @@ module Outbox
     include MessageTypes
 
     register_message_type :email, Outbox::Messages::Email
+    register_message_type :sms, Outbox::Messages::SMS
 
     # Use the Outbox::Clients::TestClient for all message types. This is
     # useful for testing or working an a development environment.
@@ -26,23 +27,24 @@ module Outbox
     def initialize(message_type_values = nil, &block)
       if block_given?
         instance_eval(&block)
-      else
-        assign_message_type_values(message_type_values) unless message_type_values.nil?
+      elsif message_type_values
+        assign_message_type_values(message_type_values)
       end
     end
 
     # Loops through each registered message type and sets the content body.
     def body(value)
-      each_message_type do |message_type, message|
+      each_message_type do |_, message|
         next if message.nil?
         message.body = value
       end
     end
-    alias :body= :body
+    alias_method :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.
+    # 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.
     #
     #   message.deliver email: 'hello@example.com', sms: '+15555555555'
     #   audience = OpenStruct.new

data/lib/outbox/message_clients.rb

@@ -32,7 +32,7 @@ module Outbox
         default_client.settings.merge!(settings) if settings
         default_client.settings
       end
-      alias :default_client_settings= :default_client_settings
+      alias_method :default_client_settings=, :default_client_settings
 
       # Registers a client class with an alias.
       #

data/lib/outbox/message_fields.rb

@@ -18,7 +18,7 @@ module Outbox
         @defaults.merge!(defaults) if defaults
         @defaults
       end
-      alias :defaults= :defaults
+      alias_method :defaults=, :defaults
 
       # Returns the defined fields for this message type.
       #
@@ -118,7 +118,7 @@ module Outbox
           fields(*names)
         end
       end
-      alias :required_field :required_fields
+      alias_method :required_field, :required_fields
 
       protected
 
@@ -176,7 +176,7 @@ module Outbox
       if new_fields.nil?
         fields = {}
         self.class.fields.each do |field|
-          fields[field] = self.public_send(field)
+          fields[field] = public_send(field)
         end
         fields
       else
@@ -191,7 +191,7 @@ module Outbox
     #   message.fields #=> { to: 'Bob', from: 'Sally' }
     def fields=(new_fields)
       new_fields.each do |field, value|
-        self.public_send(field, value) if self.respond_to?(field)
+        public_send(field, value) if respond_to?(field)
       end
     end
 
@@ -199,9 +199,9 @@ module Outbox
     # validation issues.
     def validate_fields
       self.class.required_fields.each do |field|
-        value = self.public_send(field)
+        value = public_send(field)
         if value.nil? || value.respond_to?(:empty?) && value.empty?
-          raise Outbox::MissingRequiredFieldError.new("Missing required field: #{field}")
+          raise Outbox::MissingRequiredFieldError, "Missing required field: #{field}"
         end
       end
     end

data/lib/outbox/message_types.rb

@@ -31,8 +31,8 @@ module Outbox
         define_message_type_defaults_accessors(name, message_type)
       end
 
-      # Returns a hash of the registred message types, where the key is the name
-      # of the message type and the value is the message type class.
+      # Returns a hash of the registred message types, where the key is the
+      # name of the message type and the value is the message type class.
       def message_types
         @message_types ||= {}
       end
@@ -100,7 +100,7 @@ module Outbox
     # 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)
+        public_send(key, value) if respond_to?(key)
       end
     end
 
@@ -108,7 +108,7 @@ module Outbox
     # 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)
+        yield message_type, public_send(message_type)
       end
     end
   end

data/lib/outbox/messages/base.rb

@@ -7,7 +7,10 @@ module Outbox
       # Make a new message. Every message type can be created using a hash,
       # block, or direct assignment.
       #
-      #   message = Email.new to: 'someone@example.com', from: 'company@example.com'
+      #   message = Email.new(
+      #     to: 'someone@example.com',
+      #     from: 'company@example.com'
+      #   )
       #   message = Email.new do
       #     to 'someone@example.com'
       #     from 'company@example.com'
@@ -17,7 +20,11 @@ module Outbox
       #   message.from = 'company@example.com'
       def initialize(fields = nil, &block)
         @fields = {}
-        @client = self.class.default_client and self.class.default_client.dup
+        if self.class.default_client
+          @client = self.class.default_client.dup
+        else
+          @client = nil
+        end
 
         self.fields = self.class.defaults
 

data/lib/outbox/messages/sms.rb

@@ -0,0 +1,29 @@
+module Outbox
+  module Messages
+    # SMS tend to support very different types of parameters, so only
+    # the most common ones will be directly applied to the SMS message class.
+    # All of the other ones can be set using the arbitrary field access with
+    # [] and []=.
+    #
+    #   sms = Outbox::Messages::SMS.new do
+    #     to '+14155551212'
+    #     from 'Company Name'
+    #     body 'Hellow world'
+    #   end
+    #   sms.client :twilio, api_key: '...'
+    #   sms.deliver
+    class SMS < Base
+      required_fields :to, :from, :body
+
+      def audience=(audience) # :nodoc:
+        case audience
+        when String
+          self.to = audience
+        else
+          audience = Outbox::Accessor.new(audience)
+          self.to = audience[:to]
+        end
+      end
+    end
+  end
+end

data/lib/outbox/version.rb

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

data/spec/outbox/messages/sms_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Outbox::Messages::SMS do
+  it 'sets common sms fields' do
+    sms = Outbox::Messages::SMS.new do
+      to '+14155551212'
+      from 'Company Name'
+      body 'Hello world.'
+    end
+    expect(sms.to).to eq('+14155551212')
+    expect(sms.from).to eq('Company Name')
+    expect(sms.body).to eq('Hello world.')
+  end
+
+  describe '#audience=' do
+    context 'with a string' do
+      it 'sets the To: field' do
+        email = Outbox::Messages::SMS.new
+        email.audience = '+14155551212'
+        expect(email.to).to eq('+14155551212')
+      end
+    end
+
+    context 'with a hash' do
+      it 'sets multiple fields' do
+        email = Outbox::Messages::SMS.new
+        email.audience = { to: '+14155551212' }
+        expect(email.to).to eq('+14155551212')
+      end
+    end
+
+    context 'with an object' do
+      it 'sets multiple fields' do
+        email = Outbox::Messages::SMS.new
+        email.audience = OpenStruct.new to: '+14155551212'
+        expect(email.to).to eq('+14155551212')
+      end
+    end
+  end
+
+  describe '#validate_fields' do
+    before do
+      @valid_sms = Outbox::Messages::SMS.new do
+        to '+14155551212'
+        from 'john@gmail.com'
+        body 'Hello world.'
+      end
+    end
+
+    it 'requires a To: field' do
+      @valid_sms.to = nil
+      expect {
+        @valid_sms.validate_fields
+      }.to raise_error(Outbox::MissingRequiredFieldError)
+    end
+
+    it 'requires a From: field' do
+      @valid_sms.from = nil
+      expect {
+        @valid_sms.validate_fields
+      }.to raise_error(Outbox::MissingRequiredFieldError)
+    end
+
+    it 'requires a Body: field' do
+      @valid_sms.body = nil
+      expect {
+        @valid_sms.validate_fields
+      }.to raise_error(Outbox::MissingRequiredFieldError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outbox
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Pete Browne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -106,6 +106,7 @@ files:
 - lib/outbox/message_types.rb
 - lib/outbox/messages/base.rb
 - lib/outbox/messages/email.rb
+- lib/outbox/messages/sms.rb
 - lib/outbox/version.rb
 - outbox.gemspec
 - spec/outbox/accessor_spec.rb
@@ -115,6 +116,7 @@ files:
 - spec/outbox/message_spec.rb
 - spec/outbox/messages/base_spec.rb
 - spec/outbox/messages/email_spec.rb
+- spec/outbox/messages/sms_spec.rb
 - spec/outbox_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/localmed/outbox
@@ -137,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Outbox is a generic interface for sending notifications using a variety of
@@ -150,5 +152,6 @@ test_files:
 - spec/outbox/message_spec.rb
 - spec/outbox/messages/base_spec.rb
 - spec/outbox/messages/email_spec.rb
+- spec/outbox/messages/sms_spec.rb
 - spec/outbox_spec.rb
 - spec/spec_helper.rb