sendgrid-ruby 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a77256d8db572200bdedd90a2b719d0f36d1a1aecbf17070968b555ed404028
-  data.tar.gz: 10081de69452a519515b2fe5f086460935cac375e1d3ade7528412477aab38a9
+  metadata.gz: 24757e772b52f0b9e130a824d65bea991c3fe5966f705cd3c2b67fdb8b1ade0e
+  data.tar.gz: 972ea7b52d490fce2ddb97315356965fab0001e1511087834979620cbeb118a9
 SHA512:
-  metadata.gz: fa4e2a6a2cd904d43f1c32a57ecbc1ea7db0729fed4cab05303566515975661fd12bb0e1d3f92480b3101276019db4a1858dc060ff35a1055ff587dc5582d071
-  data.tar.gz: 10493d88b4836f3f90a8813dbe3bb6d40e141a3d0f1ed99adc35c34a308c7a149104b7bde9829c8bf5b5b1efb7e855ad1236fc43c5f6c444c656a1e6f740599c
+  metadata.gz: af9a46c70ff25fadfce7458b64a75e0255063d7f082ff8b9d9f4bbff9f0aa3136969864b717f6f01666ee1c04c354a3bb03afc9dc3620de26ffb4b63e0011002
+  data.tar.gz: 7992f9c04da91c16f76eee4cfd6860df83584046c00cff6a3b3f1b5ac0318e2bde8c8f2ee1329016bc28d0fd7c62a0c92d56bedf71805bfb86a5a6436f85035a

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+contact_links:
+  - name: Twilio SendGrid Support
+    url: https://support.sendgrid.com
+    about: Get Support
+  - name: Stack Overflow
+    url: https://stackoverflow.com/questions/tagged/sendgrid-ruby+or+sendgrid+ruby
+    about: Ask questions on Stack Overflow
+  - name: Documentation
+    url: https://sendgrid.com/docs/for-developers/
+    about: View Reference Documentation

data/.travis.yml

@@ -1,25 +1,26 @@
 language: ruby
 env:
-  - version=ruby:2.7
-  - version=ruby:2.6
-  - version=ruby:2.5
-  - version=ruby:2.4
-  - version=jruby:9.2
-
+- version=ruby:3.0
+- version=ruby:2.7
+- version=ruby:2.6
+- version=ruby:2.5
+- version=ruby:2.4
+- version=jruby:9.2
 gemfile:
-  - gemfiles/Sinatra_1.gemfile
-  - gemfiles/Sinatra_2.gemfile
-
-script: make test-docker
-
+- gemfiles/Sinatra_1.gemfile
+- gemfiles/Sinatra_2.gemfile
+script:
+- if [[ "$TRAVIS_BRANCH" == "main"  ||  "$TRAVIS_BRANCH" == "travis" ]] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
+  echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin;
+  fi
+- make test-docker
 deploy:
   provider: rubygems
-  api_key: $RUBYGEMS_API_KEY
+  api_key: "$RUBYGEMS_API_KEY"
   gem: sendgrid-ruby
   on:
     tags: true
     condition: $version = ruby:2.4 && $BUNDLE_GEMFILE = *"gemfiles/Sinatra_1.gemfile"
-
 notifications:
   slack:
     if: branch = main
@@ -27,4 +28,4 @@ notifications:
     on_success: never
     on_failure: change
     rooms:
-      - secure: QwoVrGveeA1bo/26fO2A+OQHmUX69NLaC214qd18C1Z8ztYMHkd05/9+k9HFb+PSdPkGLSeYOPWAKJUqJWB7HfGINNGpRGIPFcmfB7vhvvLFnhud/SAdQPRZ+SCeZPdpZcjpVRLYENKv259ucGPBCPFXh1HfJF92R0IrKeW5CII=
+      secure: oSeohwM+ernyiRYSRLpNlICk0wgj0lku3y5LuouJLRHs45tCAzLZLbgxsor18wCSJkmhfn2vg4Rn969VnskFuj70OhJSLBKL4UXBnR1Ji0ClpfJlGojcbY/5Z8N/eGDrvf5ofA0Jc+L/ut+oSCMXnstEGbx4wBpPTajHuRtvb34=

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # 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**
+- [PR #472](https://github.com/sendgrid/sendgrid-ruby/pull/472): improve signed webhook event validation docs. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+
+[2021-09-08] Version 6.5.1
+--------------------------
+**Library - Chore**
+- [PR #470](https://github.com/sendgrid/sendgrid-ruby/pull/470): add support for ruby 3.0. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+
+[2021-08-11] Version 6.5.0
+--------------------------
+**Library - Feature**
+- [PR #466](https://github.com/sendgrid/sendgrid-ruby/pull/466): Add From address to personalization. Thanks to [@grin](https://github.com/grin)!
+
+
 [2021-02-10] Version 6.4.0
 --------------------------
 **Library - Feature**

data/README.md

@@ -2,7 +2,6 @@
 
 [![Travis Badge](https://travis-ci.com/sendgrid/sendgrid-ruby.svg?branch=main)](https://travis-ci.com/sendgrid/sendgrid-ruby)
 [![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
-[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
 [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-ruby.svg)](https://github.com/sendgrid/sendgrid-ruby/graphs/contributors)

data/TROUBLESHOOTING.md

@@ -17,6 +17,7 @@ If you can't find a solution below, please open an [issue](https://github.com/se
 * [Rails Specifics](#rails-specifics)
 * [Ruby Versions](#ruby-versions)
 * [Viewing the Request Body](#viewing-the-request-body)
+* [Verifying Event Webhooks](#signed-webhooks)
 
 <a name="migrating"></a>
 ## Migrating from v2 to v3
@@ -137,3 +138,14 @@ You can do this before `response = sg.client.mail._('send').post(request_body: m
 ```ruby
 puts mail.to_json
 ```
+
+<a name="signed-webhooks"></a>
+## Signed Webhook Verification
+
+Twilio SendGrid's Event Webhook will notify a URL via HTTP POST with information about events that occur as your mail is processed. [This](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features) article covers all you need to know to secure the Event Webhook, allowing you to verify that incoming requests originate from Twilio SendGrid. The sendgrid-ruby library can help you verify these Signed Event Webhooks.
+
+You can find the usage example [here](examples/helpers/eventwebhook/example.rb) and the tests [here](spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb). 
+If you are still having trouble getting the validation to work, follow the following instructions:
+- Be sure to use the *raw* payload for validation
+- Be sure to include a trailing carriage return and newline in your payload
+- In case of multi-event webhooks, make sure you include the trailing newline and carriage return after *each* event

data/examples/helpers/mail/example.rb

@@ -18,6 +18,7 @@ def hello_world
   puts response.headers
 end
 
+# rubocop:disable Metrics/AbcSize
 def kitchen_sink
   mail = SendGrid::Mail.new
   mail.from = Email.new(email: 'test@example.com')
@@ -29,6 +30,9 @@ def kitchen_sink
   personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
   personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
   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.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'))
@@ -124,6 +128,7 @@ def kitchen_sink
   puts response.body
   puts response.headers
 end
+# rubocop:enable Metrics/AbcSize
 
 def dynamic_template_data_hello_world
   mail = Mail.new

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

@@ -2,13 +2,14 @@ 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
 
     def initialize
       @tos = []
+      @from = nil
       @ccs = []
       @bccs = []
       @subject = nil
@@ -25,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)
 
@@ -59,6 +64,7 @@ module SendGrid
     def to_json(*)
       {
         'to' => tos,
+        'from' => from,
         'cc' => ccs,
         'bcc' => bccs,
         'subject' => subject,

data/lib/sendgrid/version.rb

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

data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb

@@ -19,14 +19,14 @@ describe SendGrid::MailSettingsDto do
   describe '.fetch' do
     it 'calls get on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
-      expect(mail_settings.fetch(args)).to be_a SendGrid::Response
+      expect(mail_settings.fetch(**args)).to be_a SendGrid::Response
     end
   end
 
   describe '.update' do
     it 'calls patch on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
-      expect(mail_settings.update(args)).to be_a SendGrid::Response
+      expect(mail_settings.update(**args)).to be_a SendGrid::Response
     end
   end
 end

data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb

@@ -11,14 +11,14 @@ describe SendGrid::PartnerSettingsDto do
   describe '.fetch' do
     it 'calls get on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
-      expect(partner_settings.fetch(args)).to be_a SendGrid::Response
+      expect(partner_settings.fetch(**args)).to be_a SendGrid::Response
     end
   end
 
   describe '.update' do
     it 'calls patch on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
-      expect(partner_settings.update(args)).to be_a SendGrid::Response
+      expect(partner_settings.update(**args)).to be_a SendGrid::Response
     end
   end
 end

data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb

@@ -14,14 +14,14 @@ describe SendGrid::TrackingSettingsDto do
   describe '.fetch' do
     it 'calls get on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
-      expect(tracking_settings.fetch(args)).to be_a SendGrid::Response
+      expect(tracking_settings.fetch(**args)).to be_a SendGrid::Response
     end
   end
 
   describe '.update' do
     it 'calls patch on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
-      expect(tracking_settings.update(args)).to be_a SendGrid::Response
+      expect(tracking_settings.update(**args)).to be_a SendGrid::Response
     end
   end
 end

data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb

@@ -11,14 +11,14 @@ describe SendGrid::UserSettingsDto do
   describe '.fetch' do
     it 'calls get on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
-      expect(user_settings.fetch(args)).to be_a SendGrid::Response
+      expect(user_settings.fetch(**args)).to be_a SendGrid::Response
     end
   end
 
   describe '.update' do
     it 'calls patch on sendgrid_client' do
       args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
-      expect(user_settings.update(args)).to be_a SendGrid::Response
+      expect(user_settings.update(**args)).to be_a SendGrid::Response
     end
   end
 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.4.0', 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.4.0
+  version: 6.6.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -167,6 +167,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".env_sample"
+- ".github/ISSUE_TEMPLATE/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -299,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