sendgrid-ruby 6.1.4 → 6.3.3

data/spec/fixtures/event_webhook.rb

@@ -0,0 +1,16 @@
+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
+  end
+end

data/spec/rack/sendgrid_webhook_verification_spec.rb

@@ -0,0 +1,116 @@
+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', /\/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/)
+        end.not_to raise_error
+      end
+    end
+
+    describe 'calling against one path' do
+      let(:middleware) { Rack::SendGridWebhookVerification.new(@app, public_key, /\/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, /\/email/, /\/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
+  end
+end

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

@@ -0,0 +1,103 @@
+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{ verify(
+          Fixtures::EventWebhook::PUBLIC_KEY,
+          Fixtures::EventWebhook::PAYLOAD,
+          Fixtures::EventWebhook::SIGNATURE, 
+          Fixtures::EventWebhook::TIMESTAMP
+        )}.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/sendgrid_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SendGrid::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = SendGrid::API.new(api_key: 'fake_key')
+      expect(mail_client.request_headers['Authorization']).to eq('Bearer fake_key')
+      expect(mail_client.host).to eq('https://api.sendgrid.com')
+    end
+  end
+end

data/spec/sendgrid/twilio_email_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe TwilioEmail::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = TwilioEmail::API.new(username: 'username', password: 'password')
+      expect(mail_client.request_headers['Authorization']).to eq('Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
+      expect(mail_client.host).to eq('https://email.twilio.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'simplecov'
+SimpleCov.start
 require 'rubygems'
 require 'bundler/setup'
 require 'pry'

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

@@ -1,5 +1,5 @@
 require_relative "../../../../lib/sendgrid/helpers/mail/mail"
-require_relative "../../../../lib/sendgrid/client"
+require_relative "../../../../lib/sendgrid/sendgrid"
 include SendGrid
 require "json"
 require 'minitest/autorun'

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -1,3 +1,5 @@
+require 'simplecov'
+SimpleCov.start
 require_relative '../../lib/sendgrid-ruby.rb'
 require 'ruby_http_client'
 require 'minitest/autorun'
@@ -5,34 +7,8 @@ require 'minitest/unit'
 
 class TestAPI < MiniTest::Test
 
-    unless File.exist?('/usr/local/bin/prism') || File.exist?(File.join(Dir.pwd, 'prism/bin/prism'))
-      if RUBY_PLATFORM =~ /mswin|mingw/
-        puts 'Please download the Windows binary (https://github.com/stoplightio/prism/releases) and place it in your /usr/local/bin directory'
-      else
-        puts 'Installing Prism'
-        IO.popen(['curl', '-s', 'https://raw.githubusercontent.com/stoplightio/prism/master/install.sh']) do |io|
-          out = io.read
-          unless system(out)
-            puts "Error downloading the prism binary, you can try downloading directly here (https://github.com/stoplightio/prism/releases) and place in your /usr/local/bin directory, #{out}"
-            exit
-          end
-        end
-      end
-    end
-
-    puts 'Activating Prism (~20 seconds)'
-    @@prism_pid = spawn('prism run --mock --list --spec https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json', [:out, :err] => '/dev/null')
-    sleep(15)
-    puts 'Prism started'
-
     def setup
-        host = "http://localhost:4010"
-        @sg = SendGrid::API.new(api_key: "SENDGRID_API_KEY", host: host)
-    end
-
-    Minitest.after_run do
-      Process.kill('TERM', @@prism_pid)
-      puts 'Prism shut down'
+        @sg = SendGrid::API.new(api_key: "SENDGRID_API_KEY")
     end
 
     def test_init
@@ -58,7 +34,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.1.4", SendGrid::VERSION)
+        assert_equal("6.3.3", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 
@@ -2676,76 +2652,65 @@ class TestAPI < MiniTest::Test
         self.assert_equal('200', response.status_code)
     end
 
-
-    def test_license_file_correct_year_range
-        if File.exist?('./LICENSE.md')
-            # get only the first line from the license txt file
-            year_range = File.open('./LICENSE.md', &:readline).gsub(/[^\d-]/, '')
-            self.assert_equal("#{Time.now.year}", year_range)
-        end
+    def test_license_file_year
+        # Read the third line from the license file
+        year = IO.readlines('./LICENSE.md')[2].gsub(/[^\d]/, '')
+        self.assert_equal("#{Time.now.year}", year)
     end
 
-    def test_docker_exists
-      assert(File.file?('./Docker') || File.file?('./docker/Dockerfile'))
-    end
-
-    # def test_docker_compose_exists
-    #   assert(File.file?('./docker-compose.yml') || File.file?('./docker/docker-compose.yml'))
-    # end
-
     def test_env_sample_exists
-      assert(File.file?('./.env_sample'))
+        assert(File.file?('./.env_sample'))
     end
 
     def test_gitignore_exists
-      assert(File.file?('./.gitignore'))
+        assert(File.file?('./.gitignore'))
     end
 
     def test_travis_exists
-      assert(File.file?('./.travis.yml'))
+        assert(File.file?('./.travis.yml'))
     end
 
     def test_codeclimate_exists
-      assert(File.file?('./.codeclimate.yml'))
+        assert(File.file?('./.codeclimate.yml'))
     end
 
     def test_changelog_exists
-      assert(File.file?('./CHANGELOG.md'))
+        assert(File.file?('./CHANGELOG.md'))
     end
 
     def test_code_of_conduct_exists
-      assert(File.file?('./CODE_OF_CONDUCT.md'))
+        assert(File.file?('./CODE_OF_CONDUCT.md'))
     end
 
     def test_contributing_exists
-      assert(File.file?('./CONTRIBUTING.md'))
+        assert(File.file?('./CONTRIBUTING.md'))
     end
 
     def test_issue_template_exists
-      assert(File.file?('./ISSUE_TEMPLATE.md'))
+        assert(File.file?('./ISSUE_TEMPLATE.md'))
     end
 
     def test_license_exists
-      assert(File.file?('./LICENSE.md'))
+        assert(File.file?('./LICENSE.md'))
     end
 
-    def test_pull_request_template_exists
-      assert(File.file?('./PULL_REQUEST_TEMPLATE.md'))
+    def test_pr_template_exists
+        assert(File.file?('./PULL_REQUEST_TEMPLATE.md'))
     end
 
     def test_readme_exists
-      assert(File.file?('./README.md'))
+        assert(File.file?('./README.md'))
     end
 
     def test_troubleshooting_exists
-      assert(File.file?('./TROUBLESHOOTING.md'))
+        assert(File.file?('./TROUBLESHOOTING.md'))
     end
 
     def test_usage_exists
-      assert(File.file?('./USAGE.md'))
+        assert(File.file?('./USAGE.md'))
     end
 
-    def test_use_cases_exists
-      assert(File.file?('./USE_CASES.md'))
+    def test_use_cases_readme_exists
+        assert(File.file?('./use-cases/README.md'))
     end
 end

data/use-cases/README.md

@@ -0,0 +1,16 @@
+This directory provides examples for specific use cases.
+
+Please [open an issue](https://github.com/sendgrid/sendgrid-ruby/issues) or [make a pull request](https://github.com/sendgrid/sendgrid-ruby/pulls) for any use cases you would like us to document here. Thank you!
+
+# Email Use Cases
+* [Transactional Templates](transactional-templates.md)
+* [Legacy Templates](legacy-templates.md)
+
+# Twilio Use Cases
+* [Twilio Setup](twilio-setup.md)
+* [Send an Email With Twilio Email (Pilot)](twilio-email.md)
+* [Send an SMS Message](sms.md)
+
+# Non-Email Use Cases
+* [How to Set up a Domain Authentication](domain-authentication.md)
+* [How to View Email Statistics](email-statistics.md)

data/use-cases/domain-authentication.md

@@ -0,0 +1,5 @@
+# How to Setup a Domain Authentication
+
+You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#sender-authentication).
+
+Find more information about all of Twilio SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).