sendgrid-ruby 6.3.4 → 6.3.9

data/lib/sendgrid/helpers/stats/metrics.rb

@@ -1,12 +1,12 @@
 module SendGrid
   class Metrics
     attr_reader :blocks, :bounce_drops,
-      :bounces, :clicks, :deferred, :delivered,
-      :invalid_emails, :opens, :processed, :requests,
-      :spam_report_drops, :spam_reports, :unique_clicks,
-      :unique_opens, :unsubscribe_drops, :unsubscribes
+                :bounces, :clicks, :deferred, :delivered,
+                :invalid_emails, :opens, :processed, :requests,
+                :spam_report_drops, :spam_reports, :unique_clicks,
+                :unique_opens, :unsubscribe_drops, :unsubscribes
 
-    def initialize(args={})
+    def initialize(args = {})
       @date = args['date']
       @blocks = args['blocks']
       @bounce_drops = args['bounce_drops']

data/lib/sendgrid/sendgrid.rb

@@ -12,7 +12,7 @@ module SendGrid
     #
     def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
       auth = "Bearer #{api_key}"
-      host = 'https://api.sendgrid.com' unless host
+      host ||= 'https://api.sendgrid.com'
 
       super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
     end

data/lib/sendgrid/twilio_email.rb

@@ -13,7 +13,7 @@ module TwilioEmail
     #
     def initialize(username:, password:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
       auth = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
-      host = 'https://email.twilio.com' unless host
+      host ||= 'https://email.twilio.com'
 
       super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
     end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.3.4'
+  VERSION = '6.3.9'.freeze
 end

data/mail_helper_v3.md

@@ -263,7 +263,7 @@ attachments = [
                              'base64 encoded content',
                              'image/png',
                              'inline',
-                             'Banner 2'),                             
+                             'Banner 2'),
 ]
 msg.add_attachments(attachments)
 
@@ -279,7 +279,7 @@ msg.set_global_headers(global_headers)
 msg.add_section('%section1%', 'Substitution for Section 1 Tag')
 sections = [
     '%section2%' => 'Substitution for Section 2 Tag',
-    '%section3%' => 'Substitution for Section 3 Tag'    
+    '%section3%' => 'Substitution for Section 3 Tag'
 ]
 msg.add_sections(sections)
 
@@ -328,7 +328,7 @@ puts response.headers
 
 The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
-For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
+For this example, we assume you have created a [legacy transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html) in the UI or via the API. Following is the template content we used for testing.
 
 Template ID (replace with your own):
 

data/sendgrid-ruby.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sendgrid/version'
 
@@ -14,19 +13,19 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.license     = 'MIT'
+  spec.license = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
   spec.add_dependency 'ruby_http_client', '~> 3.4'
-  spec.add_development_dependency 'sinatra', '>= 1.4.7', '< 3'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'minitest', '~> 5.9'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'sinatra', '>= 1.4.7', '< 3'
 end

data/spec/fixtures/event_webhook.rb

@@ -1,16 +1,22 @@
-require "json" 
+require "json"
 
 module Fixtures
   module EventWebhook
-    PUBLIC_KEY = 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEEDr2LjtURuePQzplybdC+u4CwrqDqBaWjcMMsTbhdbcwHBcepxo7yAQGhHPTnlvFYPAZFceEu/1FwCM/QmGUhA=='
-    FAILING_PUBLIC_KEY = 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEqTxd43gyp8IOEto2LdIfjRQrIbsd4SXZkLW6jDutdhXSJCWHw8REntlo7aNDthvj+y7GjUuFDb/R1NGe1OPzpA=='
-    SIGNATURE = 'MEUCIQCtIHJeH93Y+qpYeWrySphQgpNGNr/U+UyUlBkU6n7RAwIgJTz2C+8a8xonZGi6BpSzoQsbVRamr2nlxFDWYNH2j/0='
-    FAILING_SIGNATURE = 'MEUCIQCtIHJeH93Y+qpYeWrySphQgpNGNr/U+UyUlBkU6n7RAwIgJTz2C+8a8xonZGi6BpSzoQsbVRamr2nlxFDWYNH3j/0='
-    TIMESTAMP = '1588788367'
-    PAYLOAD = {
-        'category'=>'example_payload',
-        'event'=>'test_event',
-        'message_id'=>'message_id',
-    }.to_json
+    PUBLIC_KEY = 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE83T4O/n84iotIvIW4mdBgQ/7dAfSmpqIM8kF9mN1flpVKS3GRqe62gw+2fNNRaINXvVpiglSI8eNEc6wEA3F+g=='.freeze
+    FAILING_PUBLIC_KEY = 'MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEqTxd43gyp8IOEto2LdIfjRQrIbsd4SXZkLW6jDutdhXSJCWHw8REntlo7aNDthvj+y7GjUuFDb/R1NGe1OPzpA=='.freeze
+    SIGNATURE = 'MEUCIGHQVtGj+Y3LkG9fLcxf3qfI10QysgDWmMOVmxG0u6ZUAiEAyBiXDWzM+uOe5W0JuG+luQAbPIqHh89M15TluLtEZtM='.freeze
+    FAILING_SIGNATURE = 'MEUCIQCtIHJeH93Y+qpYeWrySphQgpNGNr/U+UyUlBkU6n7RAwIgJTz2C+8a8xonZGi6BpSzoQsbVRamr2nlxFDWYNH3j/0='.freeze
+    TIMESTAMP = '1600112502'.freeze
+    PAYLOAD = "#{[
+      {
+        email: 'hello@world.com',
+        event: 'dropped',
+        reason: 'Bounced Address',
+        sg_event_id: 'ZHJvcC0xMDk5NDkxOS1MUnpYbF9OSFN0T0doUTRrb2ZTbV9BLTA',
+        sg_message_id: 'LRzXl_NHStOGhQ4kofSm_A.filterdrecv-p3mdw1-756b745b58-kmzbl-18-5F5FC76C-9.0',
+        'smtp-id': '<LRzXl_NHStOGhQ4kofSm_A@ismtpd0039p1iad1.sendgrid.net>',
+        timestamp: 1_600_112_492
+      }
+    ].to_json}\r\n".freeze # Be sure to include the trailing carriage return and newline!
   end
 end

data/spec/rack/sendgrid_webhook_verification_spec.rb

@@ -12,19 +12,19 @@ unless RUBY_PLATFORM == 'java'
     describe 'new' do
       it 'should initialize with an app, public key and a path' do
         expect do
-          Rack::SendGridWebhookVerification.new(@app, 'ABC', /\/email/)
+          Rack::SendGridWebhookVerification.new(@app, 'ABC', %r{/email})
         end.not_to raise_error
       end
 
       it 'should initialize with an app, public key and paths' do
         expect do
-          Rack::SendGridWebhookVerification.new(@app, 'ABC', /\/email/, /\/event/)
+          Rack::SendGridWebhookVerification.new(@app, 'ABC', %r{/email}, %r{/event})
         end.not_to raise_error
       end
     end
 
     describe 'calling against one path' do
-      let(:middleware) { Rack::SendGridWebhookVerification.new(@app, public_key, /\/email/) }
+      let(:middleware) { Rack::SendGridWebhookVerification.new(@app, public_key, %r{/email}) }
 
       it "should not intercept when the path doesn't match" do
         expect(SendGrid::EventWebhook).to_not receive(:new)
@@ -81,7 +81,7 @@ unless RUBY_PLATFORM == 'java'
     end
 
     describe 'calling with multiple paths' do
-      let(:middleware) { Rack::SendGridWebhookVerification.new(@app, public_key, /\/email/, /\/events/) }
+      let(:middleware) { Rack::SendGridWebhookVerification.new(@app, public_key, %r{/email}, %r{/events}) }
 
       it "should not intercept when the path doesn't match" do
         expect(SendGrid::EventWebhook).to_not receive(:new)
@@ -112,5 +112,31 @@ unless RUBY_PLATFORM == 'java'
         expect(status).to eq(403)
       end
     end
+
+    describe 'request body which passed to an app' do
+      before do
+        @payload = nil
+        @spy_app = lambda do |env|
+          @payload = Rack::Request.new(env).body
+          [200, { 'Content-Type' => 'text/plain' }, ['Hello']]
+        end
+      end
+
+      let(:middleware) { Rack::SendGridWebhookVerification.new(@spy_app, public_key, %r{/email}) }
+
+      it 'keeps orignal reading position' do
+        options = {
+          :input => Fixtures::EventWebhook::PAYLOAD,
+          'Content-Type' => "application/json"
+        }
+        options[SendGrid::EventWebhookHeader::SIGNATURE] = Fixtures::EventWebhook::SIGNATURE
+        options[SendGrid::EventWebhookHeader::TIMESTAMP] = Fixtures::EventWebhook::TIMESTAMP
+        request = Rack::MockRequest.env_for('/email', options)
+        status, headers, body = middleware.call(request)
+        expect(status).to eq(200)
+        expect(@payload).not_to be_nil
+        expect(@payload.pos).to be_zero
+      end
+    end
   end
 end

data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb

@@ -6,77 +6,79 @@ describe SendGrid::EventWebhook do
     it 'verifies a valid signature' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          Fixtures::EventWebhook::SIGNATURE,
-          Fixtures::EventWebhook::TIMESTAMP
-        )).to be true
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be true
       end
     end
 
     it 'rejects a bad key' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::FAILING_PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          Fixtures::EventWebhook::SIGNATURE,
-          Fixtures::EventWebhook::TIMESTAMP
-        )).to be false
+                 Fixtures::EventWebhook::FAILING_PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
       end
     end
 
     it 'rejects a bad payload' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          'payload',
-          Fixtures::EventWebhook::SIGNATURE,
-          Fixtures::EventWebhook::TIMESTAMP
-        )).to be false
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 'payload',
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
       end
     end
 
     it 'rejects a bad signature' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          Fixtures::EventWebhook::FAILING_SIGNATURE,
-          Fixtures::EventWebhook::TIMESTAMP
-        )).to be false
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::FAILING_SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
       end
     end
 
     it 'rejects a bad timestamp' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          Fixtures::EventWebhook::SIGNATURE,
-          'timestamp'
-        )).to be false
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 'timestamp'
+               )).to be false
       end
     end
 
     it 'rejects a missing signature' do
       unless skip_jruby
         expect(verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          nil,
-          Fixtures::EventWebhook::TIMESTAMP
-        )).to be false
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 nil,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
       end
     end
 
     it 'throws an error when using jruby' do
       if skip_jruby
-        expect{ verify(
-          Fixtures::EventWebhook::PUBLIC_KEY,
-          Fixtures::EventWebhook::PAYLOAD,
-          Fixtures::EventWebhook::SIGNATURE, 
-          Fixtures::EventWebhook::TIMESTAMP
-        )}.to raise_error(SendGrid::EventWebhook::NotSupportedError)
+        expect do
+          verify(
+            Fixtures::EventWebhook::PUBLIC_KEY,
+            Fixtures::EventWebhook::PAYLOAD,
+            Fixtures::EventWebhook::SIGNATURE,
+            Fixtures::EventWebhook::TIMESTAMP
+          )
+        end.to raise_error(SendGrid::EventWebhook::NotSupportedError)
       end
     end
   end

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

@@ -4,7 +4,7 @@ describe SendGrid::MailSettingsDto do
   let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
   let(:mail_settings) { SendGrid::MailSettingsDto }
   let(:setting_name) { 'bcc' }
-  let(:setting_params) { {email: Faker::Internet.email, enabled: rand(1..100).even?} }
+  let(:setting_params) { { email: Faker::Internet.email, enabled: rand(1..100).even? } }
 
   it { should respond_to :bcc }
   it { should respond_to :address_whitelist }

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

@@ -4,7 +4,7 @@ describe SendGrid::PartnerSettingsDto do
   let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
   let(:partner_settings) { SendGrid::PartnerSettingsDto }
   let(:setting_name) { 'new_relic' }
-  let(:setting_params) { {license_key: 'key', enabled: rand(1..100).even?} }
+  let(:setting_params) { { license_key: 'key', enabled: rand(1..100).even? } }
 
   it { should respond_to :new_relic }
 

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

@@ -18,8 +18,8 @@ describe SendGrid::Settings do
 
   describe '.update_bcc' do
     it 'updates bcc' do
-      bcc_response = settings.update_bcc(enabled: true, email: "email@example.com")
+      bcc_response = settings.update_bcc(enabled: true, email: 'email@example.com')
       expect(bcc_response).to be_a SendGrid::Response
     end
   end
-end
+end

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

@@ -4,7 +4,7 @@ describe SendGrid::TrackingSettingsDto do
   let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
   let(:tracking_settings) { SendGrid::TrackingSettingsDto }
   let(:setting_name) { 'open_tracking' }
-  let(:setting_params) { {enabled: rand(1..100).even?} }
+  let(:setting_params) { { enabled: rand(1..100).even? } }
 
   it { should respond_to :open_tracking }
   it { should respond_to :click_tracking }

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

@@ -4,7 +4,7 @@ describe SendGrid::UserSettingsDto do
   let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
   let(:user_settings) { SendGrid::UserSettingsDto }
   let(:setting_name) { 'enforced_tls' }
-  let(:setting_params) { {require_tls: rand(1..100).even?} }
+  let(:setting_params) { { require_tls: rand(1..100).even? } }
 
   it { should respond_to :enforced_tls }
 

data/spec/sendgrid/helpers/stats/email_stats_spec.rb

@@ -7,37 +7,36 @@ describe SendGrid::EmailStats do
 
   let(:sample_response) do
     [{
-      "date" => "2017-10-01",
-      "stats" => [
-        {"metrics" =>
+      'date' => '2017-10-01',
+      'stats' => [
+        { 'metrics' =>
           {
-            "blocks" => 101,
-            "bounce_drops" => 102,
-            "bounces" => 103,
-            "clicks" => 104,
-            "deferred" => 105,
-            "delivered" => 106,
-            "invalid_emails" => 107,
-            "opens" => 108,
-            "processed" => 109,
-            "requests" => 110,
-            "spam_report_drops" => 111,
-            "spam_reports" => 112,
-            "unique_clicks" => 113,
-            "unique_opens" => 114,
-            "unsubscribe_drops" => 115,
-            "unsubscribes" => 116
-          }
-        }
+            'blocks' => 101,
+            'bounce_drops' => 102,
+            'bounces' => 103,
+            'clicks' => 104,
+            'deferred' => 105,
+            'delivered' => 106,
+            'invalid_emails' => 107,
+            'opens' => 108,
+            'processed' => 109,
+            'requests' => 110,
+            'spam_report_drops' => 111,
+            'spam_reports' => 112,
+            'unique_clicks' => 113,
+            'unique_opens' => 114,
+            'unsubscribe_drops' => 115,
+            'unsubscribes' => 116
+          } }
       ]
     }]
   end
 
   let(:error_response) do
     {
-      "errors" => [
+      'errors' => [
         {
-          "message" => "end_date should be a YYYY-MM-DD formatted date"
+          'message' => 'end_date should be a YYYY-MM-DD formatted date'
         }
       ]
     }

data/spec/sendgrid/helpers/stats/metrics_spec.rb

@@ -3,23 +3,23 @@ require 'spec_helper'
 describe SendGrid::Metrics do
   let(:params) do
     {
-      "date" => "2017-10-01",
-      "blocks" => 101,
-      "bounce_drops" => 102,
-      "bounces" => 103,
-      "clicks" => 104,
-      "deferred" => 105,
-      "delivered" => 106,
-      "invalid_emails" => 107,
-      "opens" => 108,
-      "processed" => 109,
-      "requests" => 110,
-      "spam_report_drops" => 111,
-      "spam_reports" => 112,
-      "unique_clicks" => 113,
-      "unique_opens" => 114,
-      "unsubscribe_drops" => 115,
-      "unsubscribes" => 116
+      'date' => '2017-10-01',
+      'blocks' => 101,
+      'bounce_drops' => 102,
+      'bounces' => 103,
+      'clicks' => 104,
+      'deferred' => 105,
+      'delivered' => 106,
+      'invalid_emails' => 107,
+      'opens' => 108,
+      'processed' => 109,
+      'requests' => 110,
+      'spam_report_drops' => 111,
+      'spam_reports' => 112,
+      'unique_clicks' => 113,
+      'unique_opens' => 114,
+      'unsubscribe_drops' => 115,
+      'unsubscribes' => 116
     }
   end
 
@@ -33,14 +33,13 @@ describe SendGrid::Metrics do
     expect(subject.date).to be_a Date
   end
 
-  %w(
+  %w[
     blocks bounce_drops bounces clicks deferred delivered invalid_emails
     opens processed requests spam_report_drops spam_reports unique_clicks
     unique_opens unsubscribe_drops unsubscribes
-  ).each do |attribute|
+  ].each do |attribute|
     it "responds to #{attribute}" do
       expect(subject).to respond_to(attribute.to_sym)
     end
   end
-
 end