tms_client 0.3.0 → 0.4.0

data/README.md

@@ -51,7 +51,7 @@ message.href             # "/messages/sms/87"
 message.get              # <TMS::SmsMessage href=/messages/sms/87 attributes={...}>
 ```
 
-### Sending an Email
+### Sending an Email Message
 
 ```ruby
 message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a>', 

data/lib/tms_client/resource/email_message.rb

@@ -3,14 +3,16 @@ module TMS #:nodoc:
   # objects.  Certain metrics are available after the email is sent, including
   # the collection of recipients who clicked or opened the email. 
   #
-  # @attr from_name [String]             The name of the person or entity sending the email.  
-  # @attr from_email [String]            The email adderess of the person or entity sending the email.  Must be configured in TMS beforehand.  Defaults to the account default from address. 
-  # @attr subject   [String]             The subject of the email
-  # @attr body      [String]             The body of the email
-  # @attr open_tracking_enabled [Boolean] Whether to track opens on this message. Optional, defaults to true.
-  # @attr click_tracking_enabled [Boolean] Whether to track clicks on links in this message. Optional, defaults to true.
-  # @attr macros [Hash]                A dictionary of key/value pairs to use in the subject and body as default macros. 
-  #                              The message-level macros are used when a recipient has no value for a given macro key.
+  # @attr from_name  [String]              The name of the person or entity sending the email.  
+  # @attr from_email [String]              Optional - the email address of the person or entity sending the email.  Must be configured in TMS beforehand.  Defaults to the account default from address. 
+  # @attr reply_to   [String]              Optional - the email address used for the Reply-To header of this email. Defaults to the account default reply_to_email address (which itself defaults to the default from address if not specified).
+  # @attr errors_to  [String]              Optional - the email address used for the Errors-To header of this email. Defaults to the account default bounce_email address (which itself defaults to the default from address if not specified).
+  # @attr subject    [String]              The subject of the email.
+  # @attr body       [String]              The body of the email.
+  # @attr open_tracking_enabled  [Boolean] Optional - Whether to track opens on this message. Defaults to true.
+  # @attr click_tracking_enabled [Boolean] Optional - Whether to track clicks on links in this message. Defaults to true.
+  # @attr macros     [Hash]                Optional - A dictionary of key/value pairs to use in the subject and body as default macros. 
+  # The message-level macros are used when a recipient has no value for a given macro key.
   # 
   # @example Sending a message
   #    email_message = client.email_messages.build(:subject => "Great news!", 
@@ -41,8 +43,17 @@ module TMS #:nodoc:
   class EmailMessage
     include InstanceResource
 
-    # @!parse attr_accessor :body, :from_name, :from_email, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
-    writeable_attributes :body, :from_name, :from_email, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    # @!parse attr_accessor :body, :from_name, :from_email, :reply_to, :errors_to, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    writeable_attributes :body,
+                         :click_tracking_enabled,
+                         :errors_to,
+                         :from_email,
+                         :from_name,
+                         :macros,
+                         :open_tracking_enabled,
+                         :reply_to,
+                         :subject
+
 
     # @!parse attr_reader :created_at, :status
     readonly_attributes :created_at, :status

data/lib/tms_client/version.rb

@@ -1,3 +1,3 @@
 module TMS #:nodoc:
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/email_message_spec.rb

@@ -6,29 +6,44 @@ describe TMS::EmailMessage do
       double('client')
     end
     before do
-      @message = TMS::EmailMessage.new(client, nil, {:body => '12345678', 
-                                                     :subject => 'blah', 
-                                                     :created_at => 'BAAAAAD',
-                                                     :from_email => 'eric@evotest.govdelivery.com'})
+      @message = TMS::EmailMessage.new(client, nil, {
+        :body       => '12345678', 
+        :subject    => 'blah', 
+        :created_at => 'BAAAAAD',
+        :from_email => 'eric@evotest.govdelivery.com',
+        :errors_to  => 'errors@evotest.govdelivery.com',
+        :reply_to   => 'replyto@evotest.govdelivery.com'})
     end
     it 'should not render readonly attrs in json hash' do
       @message.to_json[:body].should == '12345678'
       @message.to_json[:created_at].should == nil
     end
     it 'should initialize with attrs and collections' do
-      @message.body.should == '12345678'
-      @message.subject.should == 'blah'
-      @message.from_email.should == 'eric@evotest.govdelivery.com'
+      @message.body.should             == '12345678'
+      @message.subject.should          == 'blah'
+      @message.from_email.should       == 'eric@evotest.govdelivery.com'
+      @message.reply_to.should         == 'replyto@evotest.govdelivery.com'
+      @message.errors_to.should        == 'errors@evotest.govdelivery.com'
       @message.recipients.class.should == TMS::EmailRecipients
     end
     it 'should post successfully' do
-      response = {:body => 'processed', :subject => 'blah', :from_email => 'eric@evotest.govdelivery.com', 
-                  :recipients => [{:email => 'billy@evotest.govdelivery.com'}], :created_at => 'time'}
+      response = {
+          :body       => 'processed', 
+          :subject    => 'blah', 
+          :from_email => 'eric@evotest.govdelivery.com', 
+          :errors_to  => 'errors@evotest.govdelivery.com',
+          :reply_to   => 'replyto@evotest.govdelivery.com',
+          :recipients => [{:email => 'billy@evotest.govdelivery.com'}], 
+          :created_at => 'time'
+      }
       @message.client.should_receive('post').with(@message).and_return(double('response', :status => 201, :body => response))
       @message.post
-      @message.body.should == 'processed'
-      @message.created_at.should == 'time'
-      @message.recipients.class.should == TMS::EmailRecipients
+      @message.body.should                              == 'processed'
+      @message.created_at.should                        == 'time'
+      @message.from_email.should                        == 'eric@evotest.govdelivery.com'
+      @message.reply_to.should                          == 'replyto@evotest.govdelivery.com'
+      @message.errors_to.should                         == 'errors@evotest.govdelivery.com'
+      @message.recipients.class.should                  == TMS::EmailRecipients
       @message.recipients.collection.first.class.should == TMS::EmailRecipient
     end
     it 'should handle errors' do
@@ -50,14 +65,19 @@ describe TMS::EmailMessage do
     end
     it 'should GET cleanly' do
       response = {:body => 'processed', 
-                  :subject => 'hey',
+                  :subject    => 'hey',
                   :from_email => 'eric@evotest.govdelivery.com',
-                  :recipients => [{:email => 'billy@evotest.govdelivery.com'}], :created_at => 'time'}
+                  :errors_to  => 'errors@evotest.govdelivery.com',
+                  :reply_to   => 'replyto@evotest.govdelivery.com',
+                  :recipients => [{:email => 'billy@evotest.govdelivery.com'}], 
+                  :created_at => 'time'}
       @message.client.should_receive('get').with(@message.href).and_return(double('response', :status => 200, :body => response))
       @message.get
-      @message.body.should == 'processed'
-      @message.subject.should == 'hey'
+      @message.body.should       == 'processed'
+      @message.subject.should    == 'hey'
       @message.from_email.should == 'eric@evotest.govdelivery.com'
+      @message.reply_to.should   == 'replyto@evotest.govdelivery.com'
+      @message.errors_to.should  == 'errors@evotest.govdelivery.com'
       @message.created_at.should == 'time'
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,12 +122,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 825628313063111602
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 825628313063111602
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -147,4 +153,3 @@ test_files:
 - spec/sms_messages_spec.rb
 - spec/spec_helper.rb
 - spec/tms_client_spec.rb
-has_rdoc: