sendgrid-ruby 6.3.9 → 6.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf21bd306727e384a838c428f07f5866f9108ab03f41160b8dfe429d3116537b
-  data.tar.gz: b73d7dfbb09c9d817096762a882e85e1eeb77bd2abd3397d45923fcf4f81b4cc
+  metadata.gz: e9ae3c96f2f17a8c259ea3f8e369e19c37bb8764074abe57a2cbf9af9e14879e
+  data.tar.gz: 2bd8adf75c2e77b81c5c8d5f6c3e01cb4d8a52ea25252bdea2e24b8cbb9dbaa2
 SHA512:
-  metadata.gz: 52f3285d9ff1f54c4fd46372118de4847fb7508e8c28720362d66aebde5f67decb780a51a9fdaa295d4a67c38bae70ae484ab17ec53e80b38aa8a614de7a0083
-  data.tar.gz: 21b3545263c927498194e31f628d91ded1d6ba39da5e81865a3368729a804338be697f6cb9ca9c89ddeb0dcebca7635b4c8a1a7c99516cf3b8c4425c2bca8688
+  metadata.gz: 5e6c60136a7aac529987dc16543daa49da5ad7f65120ab994e41f66f00a86665e68aeea7990089893d39f43161d4601ebc08df37f05264b9dc967a169f3fdb7b
+  data.tar.gz: f940ee99e5254db6ae88e5bc6297ec16f941ad6bf2f1e619c1cefc1605cf9577c8a838ce0423e2ba8dc7e58f875f88aedb287a1ef50e59e4676491cc0e1011d6

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/.rubocop_todo.yml

@@ -34,6 +34,8 @@ Metrics/BlockLength:
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 2006
+  Exclude:
+    - 'test/sendgrid/test_sendgrid-ruby.rb'
 
 # Offense count: 41
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.

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-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**
+- [PR #455](https://github.com/sendgrid/sendgrid-ruby/pull/455): Add http_options as a param in the SendGrid::API's constructor. Thanks to [@hoangtuanictvn](https://github.com/hoangtuanictvn)!
+
+
 [2021-01-27] Version 6.3.9
 --------------------------
 **Library - Fix**

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.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/base_interface.rb

@@ -4,7 +4,7 @@ require_relative 'version'
 # Initialize the HTTP client
 class BaseInterface
   attr_accessor :client
-  attr_reader :request_headers, :host, :version, :impersonate_subuser
+  attr_reader :request_headers, :host, :version, :impersonate_subuser, :http_options
 
   # * *Args* :
   #   - +auth+ -> authorization header value
@@ -14,8 +14,9 @@ class BaseInterface
   #                  currently only "v3" is supported
   #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
   #                              in the "On-Behalf-Of" header
+  #   - +http_options+ -> http options that you want to be globally applied to each request
   #
-  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil)
+  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
     @auth = auth
     @host = host
     @version = version || 'v3'
@@ -31,7 +32,9 @@ class BaseInterface
     @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser
 
     @request_headers = @request_headers.merge(request_headers) if request_headers
+    @http_options = http_options
     @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
-                                   request_headers: @request_headers)
+                                   request_headers: @request_headers,
+                                   http_options: @http_options)
   end
 end

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

@@ -5,10 +5,11 @@ module SendGrid
     attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
                 :dynamic_template_data
 
-    attr_accessor :send_at, :subject
+    attr_accessor :send_at, :subject, :from
 
     def initialize
       @tos = []
+      @from = nil
       @ccs = []
       @bccs = []
       @subject = nil
@@ -59,6 +60,7 @@ module SendGrid
     def to_json(*)
       {
         'to' => tos,
+        'from' => from,
         'cc' => ccs,
         'bcc' => bccs,
         'subject' => subject,

data/lib/sendgrid/sendgrid.rb

@@ -9,12 +9,13 @@ module SendGrid
     #                  currently only "v3" is supported
     #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
     #                              in the "On-Behalf-Of" header
+    #   - +http_options+ -> http options that you want to be globally applied to each request
     #
-    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
+    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
       auth = "Bearer #{api_key}"
       host ||= 'https://api.sendgrid.com'
 
-      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser, http_options: http_options)
     end
   end
 end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.3.9'.freeze
+  VERSION = '6.5.2'.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/test_sendgrid-ruby.rb

@@ -33,8 +33,9 @@ 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.3.9', SendGrid::VERSION)
+    assert_equal('6.5.2', SendGrid::VERSION)
     assert_instance_of(SendGrid::Client, sg.client)
+    assert_equal({}, sg.http_options)
   end
 
   def test_init_when_impersonate_subuser_is_not_given
@@ -42,6 +43,23 @@ class TestAPI < MiniTest::Test
     refute_includes(sg.request_headers, 'On-Behalf-Of')
   end
 
+  def test_init_when_http_options_is_given
+    params = JSON.parse('{"subuser": "test_string", "ip": "test_string", "limit": 1, "exclude_whitelabels": "true", "offset": 1}')
+    headers = JSON.parse('{"X-Mock": 200}')
+    http_options = {
+      open_timeout: 40,
+      read_timeout: 40
+    }
+
+    sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY', version: 'v3', http_options: http_options)
+    client = sg.client.ips
+    response = client.get(query_params: params, request_headers: headers)
+
+    assert_equal(40, client.http.open_timeout)
+    assert_equal(40, client.http.read_timeout)
+    assert_equal('200', response.status_code)
+  end
+
   def test_access_settings_activity_get
     params = JSON.parse('{"limit": 1}')
     headers = JSON.parse('{"X-Mock": 200}')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.3.9
+  version: 6.5.2
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-10-18 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"