sendgrid-ruby 6.0.0 → 6.4.0

data/spec/fixtures/event_webhook.rb

@@ -0,0 +1,22 @@
+require "json"
+
+module Fixtures
+  module EventWebhook
+    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

@@ -0,0 +1,142 @@
+require 'spec_helper'
+require 'rack/mock'
+require './spec/fixtures/event_webhook'
+
+unless RUBY_PLATFORM == 'java'
+  describe Rack::SendGridWebhookVerification do
+    let(:public_key) { Fixtures::EventWebhook::PUBLIC_KEY }
+    before do
+      @app = ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['Hello']] }
+    end
+
+    describe 'new' do
+      it 'should initialize with an app, public key and a path' do
+        expect do
+          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', %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, %r{/email}) }
+
+      it "should not intercept when the path doesn't match" do
+        expect(SendGrid::EventWebhook).to_not receive(:new)
+        request = Rack::MockRequest.env_for('/login')
+        status, headers, body = middleware.call(request)
+        expect(status).to eq(200)
+      end
+
+      it 'should allow a request through if it is verified' 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)
+      end
+
+      it 'should short circuit a request to 403 if there is no signature or timestamp' do
+        options = {
+          :input => Fixtures::EventWebhook::PAYLOAD,
+          'Content-Type' => "application/json"
+        }
+        request = Rack::MockRequest.env_for('/email', options)
+        status, headers, body = middleware.call(request)
+        expect(status).to eq(403)
+      end
+
+      it 'should short circuit a request to 403 if the signature is incorrect' do
+        options = {
+          :input => Fixtures::EventWebhook::PAYLOAD,
+          'Content-Type' => "application/json"
+        }
+        options[SendGrid::EventWebhookHeader::SIGNATURE] = Fixtures::EventWebhook::FAILING_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(403)
+      end
+
+      it 'should short circuit a request to 403 if the payload is incorrect' do
+        options = {
+          :input => '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(403)
+      end
+    end
+
+    describe 'calling with multiple paths' do
+      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)
+        request = Rack::MockRequest.env_for('/sms_events')
+        status, headers, body = middleware.call(request)
+        expect(status).to eq(200)
+      end
+
+      it 'should allow a request through if it is verified' 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('/events', options)
+        status, headers, body = middleware.call(request)
+        expect(status).to eq(200)
+      end
+
+      it 'should short circuit a request to 403 if there is no signature or timestamp' do
+        options = {
+          :input => Fixtures::EventWebhook::PAYLOAD,
+          'Content-Type' => "application/json"
+        }
+        request = Rack::MockRequest.env_for('/events', options)
+        status, headers, body = middleware.call(request)
+        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

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require './spec/fixtures/event_webhook'
+
+describe SendGrid::EventWebhook do
+  describe '.verify_signature' 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
+      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
+      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
+      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
+      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
+      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
+      end
+    end
+
+    it 'throws an error when using jruby' do
+      if skip_jruby
+        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
+end
+
+describe SendGrid::EventWebhookHeader do
+  it 'sets the signature header constant' do
+    expect(SendGrid::EventWebhookHeader::SIGNATURE).to eq("HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_SIGNATURE")
+  end
+
+  it 'sets the timestamp header constant' do
+    expect(SendGrid::EventWebhookHeader::TIMESTAMP).to eq("HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_TIMESTAMP")
+  end
+end
+
+def verify(public_key, payload, signature, timestamp)
+  ew = SendGrid::EventWebhook.new
+  ec_public_key = ew.convert_public_key_to_ecdsa(public_key)
+  ew.verify_signature(ec_public_key, payload, signature, timestamp)
+end
+
+def skip_jruby
+  RUBY_PLATFORM == 'java'
+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

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

@@ -3,28 +3,27 @@ require 'spec_helper'
 describe SendGrid::StatsResponse do
   let(:params) 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
@@ -51,9 +50,9 @@ describe SendGrid::StatsResponse do
   context 'errors' do
     let(:error_params) 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'
           }
         ]
       }