feat: update tests, use-cases, examples and implementation for From personalization (#473)

Author: Bilal Boussayoud

examples/helpers/mail/example.rb

@@ -32,7 +32,7 @@ def kitchen_sink
   personalization.add_bcc(Email.new(email: '[email protected]', name: 'Example User'))
   # Note, the domain of the from email property specified in any personalization must
   # match the domain of the from email property specified at root level
-  personalization.from = Email.new(email: '[email protected]', name: "My alias")
+  personalization.add_from(Email.new(email: '[email protected]', name: "My alias"))
   personalization.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
   personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
   personalization.add_header(Header.new(key: 'X-Mock', value: 'False'))

lib/sendgrid/helpers/mail/personalization.rb

@@ -2,10 +2,10 @@
 
 module SendGrid
   class Personalization
-    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
+    attr_reader :tos, :from, :ccs, :bccs, :headers, :substitutions, :custom_args,
                 :dynamic_template_data
 
-    attr_accessor :send_at, :subject, :from
+    attr_accessor :send_at, :subject
 
     def initialize
       @tos = []
@@ -26,6 +26,10 @@ def add_to(to)
       @tos << to.to_json
     end
 
+    def add_from(from)
+      @from = from.to_json
+    end
+
     def add_cc(cc)
       raise DuplicatePersonalizationError if duplicate?(cc)
 

test/sendgrid/helpers/mail/test_personalizations.rb

@@ -45,6 +45,19 @@ def test_duplicate_add_to
     end
   end
 
+  def test_add_from
+    @personalization = Personalization.new
+    @personalization.add_from(Email.new(email: '[email protected]', name: 'Example Sender'))
+    expected_json = {
+      'from' => {
+        'email' => '[email protected]',
+        'name' => 'Example Sender'
+      }
+    }
+
+    assert_equal @personalization.to_json, expected_json
+  end
+
   def test_add_cc
     @personalization = Personalization.new
     @personalization.add_cc(Email.new(email: '[email protected]', name: 'Example User'))

use-cases/README.md

@@ -5,6 +5,7 @@ Please [open an issue](https://github.com/sendgrid/sendgrid-ruby/issues) or [mak
 # Email Use Cases
 * [Transactional Templates](transactional-templates.md)
 * [Legacy Templates](legacy-templates.md)
+* [Personalizations](personalizations.md)
 
 # Twilio Use Cases
 * [Twilio Setup](twilio-setup.md)

use-cases/personalizations.md

@@ -0,0 +1,34 @@
+# Personalizations
+
+This example demonstrates how to send multiple emails with personalizations. For further documentation, refer to [the SendGrid docs](https://docs.sendgrid.com/for-developers/sending-email/personalizations).
+
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+
+# Note that the domain for all From addresses must match
+mail = Mail.new
+mail.from = Email.new(email: '[email protected]')
+mail.add_content(Content.new(type: 'text/plain', value: 'Some test text'))
+mail.subject = 'Personalized Test Email'
+
+personalization = Personalization.new
+personalization.add_to(Email.new(email: '[email protected]'))
+mail.add_personalization(personalization)
+
+personalization2 = Personalization.new
+personalization2.add_to(Email.new(email: '[email protected]'))
+personalization2.add_from(Email.new(email: '[email protected]'))
+mail.add_personalization(personalization2)
+
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+
+puts response.status_code
+puts response.body
+puts response.headers
+```