sendgrid-ruby 6.5.2 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ae3c96f2f17a8c259ea3f8e369e19c37bb8764074abe57a2cbf9af9e14879e
-  data.tar.gz: 2bd8adf75c2e77b81c5c8d5f6c3e01cb4d8a52ea25252bdea2e24b8cbb9dbaa2
+  metadata.gz: 24757e772b52f0b9e130a824d65bea991c3fe5966f705cd3c2b67fdb8b1ade0e
+  data.tar.gz: 972ea7b52d490fce2ddb97315356965fab0001e1511087834979620cbeb118a9
 SHA512:
-  metadata.gz: 5e6c60136a7aac529987dc16543daa49da5ad7f65120ab994e41f66f00a86665e68aeea7990089893d39f43161d4601ebc08df37f05264b9dc967a169f3fdb7b
-  data.tar.gz: f940ee99e5254db6ae88e5bc6297ec16f941ad6bf2f1e619c1cefc1605cf9577c8a838ce0423e2ba8dc7e58f875f88aedb287a1ef50e59e4676491cc0e1011d6
+  metadata.gz: af9a46c70ff25fadfce7458b64a75e0255063d7f082ff8b9d9f4bbff9f0aa3136969864b717f6f01666ee1c04c354a3bb03afc9dc3620de26ffb4b63e0011002
+  data.tar.gz: 7992f9c04da91c16f76eee4cfd6860df83584046c00cff6a3b3f1b5ac0318e2bde8c8f2ee1329016bc28d0fd7c62a0c92d56bedf71805bfb86a5a6436f85035a

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2021-11-03] Version 6.6.0
+--------------------------
+**Library - Feature**
+- [PR #473](https://github.com/sendgrid/sendgrid-ruby/pull/473): update tests, use-cases, examples and implementation for From personalization. Thanks to [@beebzz](https://github.com/beebzz)!
+
+
 [2021-10-18] Version 6.5.2
 --------------------------
 **Library - Docs**

data/examples/helpers/mail/example.rb

@@ -32,7 +32,7 @@ def kitchen_sink
   personalization.add_bcc(Email.new(email: 'test6@example.com', 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: 'alias@example.com', name: "My alias")
+  personalization.add_from(Email.new(email: 'alias@example.com', 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'))

data/lib/sendgrid/helpers/mail/personalization.rb

@@ -2,10 +2,10 @@ require 'json'
 
 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 @@ module SendGrid
       @tos << to.to_json
     end
 
+    def add_from(from)
+      @from = from.to_json
+    end
+
     def add_cc(cc)
       raise DuplicatePersonalizationError if duplicate?(cc)
 

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.5.2'.freeze
+  VERSION = '6.6.0'.freeze
 end

data/test/sendgrid/helpers/mail/test_personalizations.rb

@@ -45,6 +45,19 @@ class TestPersonalization < Minitest::Test
     end
   end
 
+  def test_add_from
+    @personalization = Personalization.new
+    @personalization.add_from(Email.new(email: 'from1@example.com', name: 'Example Sender'))
+    expected_json = {
+      'from' => {
+        'email' => 'from1@example.com',
+        'name' => 'Example Sender'
+      }
+    }
+
+    assert_equal @personalization.to_json, expected_json
+  end
+
   def test_add_cc
     @personalization = Personalization.new
     @personalization.add_cc(Email.new(email: 'test1@example.com', name: 'Example User'))

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -33,7 +33,7 @@ class TestAPI < MiniTest::Test
     assert_equal(test_headers, sg.request_headers)
     assert_equal('v3', sg.version)
     assert_equal(subuser, sg.impersonate_subuser)
-    assert_equal('6.5.2', SendGrid::VERSION)
+    assert_equal('6.6.0', SendGrid::VERSION)
     assert_instance_of(SendGrid::Client, sg.client)
     assert_equal({}, sg.http_options)
   end

data/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)

data/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: 'test@example.com')
+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: 'test1@example.com'))
+mail.add_personalization(personalization)
+
+personalization2 = Personalization.new
+personalization2.add_to(Email.new(email: 'test2@example.com'))
+personalization2.add_from(Email.new(email: 'test3@example.com'))
+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
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.5.2
+  version: 6.6.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -300,6 +300,7 @@ files:
 - use-cases/domain-authentication.md
 - use-cases/email-statistics.md
 - use-cases/legacy-templates.md
+- use-cases/personalizations.md
 - use-cases/sms.md
 - use-cases/transactional-templates.md
 - use-cases/twilio-email.md