sendgrid-ruby 6.1.3 → 6.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab4d1b81de6fefc4571266850736ec30444bef09540947937f33a7a24bd8af1
-  data.tar.gz: 7292fed94a9bc5818acc42c862e663efd5c3abbcda95876b5280d04d581cc0ba
+  metadata.gz: a84b6e88237dcfab04ae17b076923e3ff2199683514b1f5916c4e0851f83b871
+  data.tar.gz: 2d19e0c66fd9ff2abcc0a6b38ae8e080cbba4961dc12e2a086243069cd81f59b
 SHA512:
-  metadata.gz: 11b5c60df6c71140b6e69f0dc3d25ff830b243d709007301f93d5f9334a5173d427d86eeb2c6b6a646c7b0c44a7e052e35ac43e35aad5277e4984fcab408d295
-  data.tar.gz: b5c8232f4711aaa9aa1f12087920f6cd250d1153538fa8c0a72330b6774dfcd1531b51d0c9693c9f2c44e54b2c2ef044c3163dad52d29294152636699b5f9345
+  metadata.gz: 534ea0a42703026d6fccab526263f44cf6fdcc3f65228fcbc06a6d3c7c6ad80dfc12e553d6273515d87f7595a170e171a9c897980a76b7c47d0a55b940551ffb
+  data.tar.gz: b9f2b208e7838d3e9716678c5227eea427fc168e244fa5ba7709970f9a83ec49f9da18062494a2901a1efc6e46dbc9e67e0cfc9bc559b1b09089ee9747a2e47c

data/.gitignore

@@ -39,3 +39,5 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+prism*

data/.travis.yml

@@ -1,25 +1,17 @@
 language: ruby
-rvm:
-  - ruby-head
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-  - jruby-9.2
+env:
+  - 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
-before_script:
-  - mkdir prism
-  - mkdir prism/bin
-  - export PATH=$PATH:$PWD/prism/bin/
-  - "./test/prism.sh"
-install: make install
-script: make test
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
+
+script: make test-docker
+
 deploy:
   provider: rubygems
   api_key:
@@ -27,5 +19,13 @@ deploy:
   gem: sendgrid-ruby
   on:
     tags: true
-    rvm: '2.4'
-    condition: '$BUNDLE_GEMFILE == *"gemfiles/Sinatra_1.gemfile"'
+    condition: $version = ruby:2.4 && $BUNDLE_GEMFILE = *"gemfiles/Sinatra_1.gemfile"
+
+notifications:
+  slack:
+    if: branch = master
+    on_pull_requests: false
+    on_success: never
+    on_failure: change
+    rooms:
+      - secure: QwoVrGveeA1bo/26fO2A+OQHmUX69NLaC214qd18C1Z8ztYMHkd05/9+k9HFb+PSdPkGLSeYOPWAKJUqJWB7HfGINNGpRGIPFcmfB7vhvvLFnhud/SAdQPRZ+SCeZPdpZcjpVRLYENKv259ucGPBCPFXh1HfJF92R0IrKeW5CII=

data/CHANGELOG.md

@@ -1,6 +1,44 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2020-07-08] Version 6.3.2
+--------------------------
+**Library - Test**
+- [PR #368](https://github.com/sendgrid/sendgrid-ruby/pull/368): add Simplecov Local Enhancements. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
+
+
+[2020-06-25] Version 6.3.1
+--------------------------
+
+
+[2020-06-24] Version 6.3.0
+--------------------------
+**Library - Feature**
+- [PR #428](https://github.com/sendgrid/sendgrid-ruby/pull/428): adds rack middleware to make request verification easier in rack apps. Thanks to [@philnash](https://github.com/philnash)!
+- [PR #425](https://github.com/sendgrid/sendgrid-ruby/pull/425): verify signature from event webhook. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Library - Fix**
+- [PR #427](https://github.com/sendgrid/sendgrid-ruby/pull/427): drop the starkbank dependency. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-05-13] Version 6.2.1
+--------------------------
+**Library - Fix**
+- [PR #421](https://github.com/sendgrid/sendgrid-ruby/pull/421): migrate to common prism setup. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-04-29] Version 6.2.0
+--------------------------
+**Library - Feature**
+- [PR #417](https://github.com/sendgrid/sendgrid-ruby/pull/417): add support for Twilio Email. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
+[2020-04-15] Version 6.1.4
+--------------------------
+**Library - Fix**
+- [PR #416](https://github.com/sendgrid/sendgrid-ruby/pull/416): correct the User-Agent casing. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
 [2020-04-01] Version 6.1.3
 --------------------------
 **Library - Docs**

data/CONTRIBUTING.md

@@ -47,7 +47,7 @@ Before you decide to create a new issue, please try the following:
 
 ### Please use our Bug Report Template
 
-In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-ruby/blob/master/ISSUE_TEMPLATE.md) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
+In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
 
 <a name="improvements-to-the-codebase"></a>
 ## Improvements to the Codebase
@@ -206,8 +206,6 @@ Please run your code through:
 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
     with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
 
-If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
-
 <a name="code-reviews"></a>
 ## Code Reviews
 

data/Dockerfile

@@ -0,0 +1,14 @@
+ARG version=ruby:latest
+FROM $version
+
+# Needed for jruby
+RUN apt-get update \
+    && apt-get install -y make git
+
+COPY prism/prism/nginx/cert.crt /usr/local/share/ca-certificates/cert.crt
+RUN update-ca-certificates
+
+WORKDIR /app
+COPY . .
+
+RUN make install

data/Gemfile

@@ -3,4 +3,3 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'ruby_http_client'
-

data/Makefile

@@ -1,7 +1,14 @@
-.PHONY: install test
+.PHONY: install test test-integ test-docker
 
 install:
 	gem install bundler:2.1.2; bundle install
 
 test:
 	bundle exec rake spec
+
+test-integ: test
+
+version ?= ruby:latest
+test-docker:
+	curl -s https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/prism/prism.sh -o prism.sh
+	version=$(version) bash ./prism.sh

data/README.md

@@ -217,9 +217,11 @@ Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-ruby
 <a name="about"></a>
 # About
 
-sendgrid-ruby is guided and supported by the [Developer Experience Team](mailto:dx@sendgrid.com).
+sendgrid-ruby is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of Twilio SendGrid, Inc.
 
-sendgrid-ruby is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of SendGrid, Inc.
+If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
+
+If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
 
 <a name="license"></a>
 # License

data/USE_CASES.md

@@ -11,14 +11,8 @@ This documentation provides examples for specific use cases. Please [open an iss
   * [Adding Attachments](#adding-attachments)
 * [How to Setup a Domain Authentication](#how-to-setup-a-domain-authentication)
 * [How to View Email Statistics](#how-to-view-email-statistics)
-* [Send a SMS Message](#send-a-sms-message)
-  * [1. Obtain a Free Twilio Account](#1-obtain-a-free-twilio-account)
-  * [2. Update Your Environment Variables](#2-update-your-environment-variables)
-    * [Mac](#mac)
-    * [Windows](#windows)
-  * [3. Install the Twilio Helper Library](#3-install-the-twilio-helper-library)
-  * [4. Setup Work](#4-setup-work)
-  * [5. Send an SMS](#5-send-an-sms)
+* [Send an Email With Twilio Email (Pilot)](#send-an-email-with-twilio-email-pilot)
+* [Send an SMS Message](#send-an-sms-message)
 
 <a name="transactional-templates"></a>
 # Transactional Templates
@@ -299,59 +293,98 @@ end
 
 ```
 
-<a name="sms"></a>
-# Send a SMS Message
+# Send an Email With Twilio Email (Pilot)
 
-Following are the steps to add Twilio SMS to your app:
-
-## 1. Obtain a Free Twilio Account
+### 1. Obtain a Free Twilio Account
 
 Sign up for a free Twilio account [here](https://www.twilio.com/try-twilio?source=sendgrid-ruby).
 
-## 2. Update Your Environment Variables
+### 2. Set Up Your Environment Variables
+
+The Twilio API allows for authentication using with either an API key/secret or your Account SID/Auth Token. You can create an API key [here](https://twil.io/get-api-key) or obtain your Account SID and Auth Token [here](https://twil.io/console).
 
-You can obtain your Account Sid and Auth Token from [twilio.com/console](https://twilio.com/console).
+Once you have those, follow the steps below based on your operating system.
 
-### Mac
+#### Linux/Mac
 
 ```bash
+echo "export TWILIO_API_KEY='YOUR_TWILIO_API_KEY'" > twilio.env
+echo "export TWILIO_API_SECRET='YOUR_TWILIO_API_SECRET'" >> twilio.env
+
+# or
+
 echo "export TWILIO_ACCOUNT_SID='YOUR_TWILIO_ACCOUNT_SID'" > twilio.env
 echo "export TWILIO_AUTH_TOKEN='YOUR_TWILIO_AUTH_TOKEN'" >> twilio.env
+```
+
+Then:
+
+```bash
 echo "twilio.env" >> .gitignore
 source ./twilio.env
 ```
 
-### Windows
+#### Windows
 
 Temporarily set the environment variable (accessible only during the current CLI session):
 
 ```bash
+set TWILIO_API_KEY=YOUR_TWILIO_API_KEY
+set TWILIO_API_SECRET=YOUR_TWILIO_API_SECRET
+
+: or
+
 set TWILIO_ACCOUNT_SID=YOUR_TWILIO_ACCOUNT_SID
 set TWILIO_AUTH_TOKEN=YOUR_TWILIO_AUTH_TOKEN
 ```
 
-Permanently set the environment variable (accessible in all subsequent CLI sessions):
+Or permanently set the environment variable (accessible in all subsequent CLI sessions):
 
 ```bash
+setx TWILIO_API_KEY "YOUR_TWILIO_API_KEY"
+setx TWILIO_API_SECRET "YOUR_TWILIO_API_SECRET"
+
+: or
+
 setx TWILIO_ACCOUNT_SID "YOUR_TWILIO_ACCOUNT_SID"
 setx TWILIO_AUTH_TOKEN "YOUR_TWILIO_AUTH_TOKEN"
 ```
 
-## 3. Install the Twilio Helper Library
-
-To install using [Bundler][bundler] grab the latest stable version:
+### 3. Initialize the Twilio Email Client
 
 ```ruby
-gem 'twilio-ruby', '~> 5.23.1'
+mail_client = TwilioEmail::API(username: ENV['TWILIO_API_KEY'], password: ENV['TWILIO_API_SECRET'])
+
+# or
+
+mail_client = TwilioEmail::API(username: ENV['TWILIO_ACCOUNT_SID'], password: ENV['TWILIO_AUTH_TOKEN'])
 ```
 
-To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
+This client has the same interface as the `SendGrid::API` client.
+
+# Send an SMS Message
+
+First, follow the above steps for creating a Twilio account and setting up environment variables with the proper credentials.
+
+Then, install the Twilio Helper Library. Add this line to your application's Gemfile:
+
+```bash
+gem 'twilio-ruby'
+```
+
+And then execute:
 
 ```bash
-gem install twilio-ruby -v 5.23.1
+bundle
 ```
 
-## 4. Setup Work
+Or install it yourself using:
+
+```bash
+gem install twilio-ruby
+```
+
+Finally, send a message.
 
 ```ruby
 require 'twilio-ruby'
@@ -362,11 +395,6 @@ auth_token = ENV['TWILIO_AUTH_TOKEN']
 
 # set up a client to talk to the Twilio REST API
 @client = Twilio::REST::Client.new account_sid, auth_token
-```
-
-## 5. Send an SMS
-
-```ruby
 @client.api.account.messages.create(
   from: '+14159341234',
   to: '+16105557069',

data/examples/helpers/eventwebhook/example.rb

@@ -0,0 +1,16 @@
+require 'sengrid-ruby'
+include SendGrid
+
+def is_valid_signature(request)
+  public_key = 'base64-encoded public key'
+
+  event_webhook = SendGrid::EventWebhook.new
+  ec_public_key = event_webhook.convert_public_key_to_ecdsa(public_key)
+
+  event_webhook.verify_signature(
+      ec_public_key,
+      request.body.read,
+      request.env[SendGrid::EventWebhookHeader::SIGNATURE],
+      request.env[SendGrid::EventWebhookHeader::TIMESTAMP]
+  )
+end

data/lib/rack/sendgrid_webhook_verification.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rack
+  # Middleware that verifies webhooks from SendGrid using the EventWebhook
+  # verifier.
+  #
+  # The middleware takes a public key with which to set up the request
+  # validator and any number of paths. When a path matches the incoming request
+  # path, the request will be verified using the signature and timestamp of the
+  # request.
+  #
+  # Example:
+  #
+  # require 'rack'
+  # use Rack::SendGridWebhookVerification, ENV['PUBLIC_KEY'], /\/emails/
+  #
+  # The above appends this middleware to the stack, using a public key saved in
+  # the ENV and only against paths that match /\/emails/. If the request
+  # validates then it gets passed on to the action as normal. If the request
+  # doesn't validate then the middleware responds immediately with a 403 status.
+  class SendGridWebhookVerification
+    def initialize(app, public_key, *paths)
+      @app = app
+      @public_key = public_key
+      @path_regex = Regexp.union(paths)
+    end
+
+    def call(env)
+      return @app.call(env) unless env['PATH_INFO'].match(@path_regex)
+      request = Rack::Request.new(env)
+
+      event_webhook = SendGrid::EventWebhook.new
+      ec_public_key = event_webhook.convert_public_key_to_ecdsa(@public_key)
+      verified = event_webhook.verify_signature(
+        ec_public_key,
+        request.body.read,
+        request.env[SendGrid::EventWebhookHeader::SIGNATURE],
+        request.env[SendGrid::EventWebhookHeader::TIMESTAMP]
+      )
+
+      if verified
+        return @app.call(env)
+      else
+        return [
+          403,
+          { 'Content-Type' => 'text/plain' },
+          ['SendGrid Request Verification Failed.']
+        ]
+      end
+    end
+  end
+end

data/lib/sendgrid-ruby.rb

@@ -1,5 +1,8 @@
-require_relative 'sendgrid/client'
+require_relative 'sendgrid/base_interface'
+require_relative 'sendgrid/sendgrid'
+require_relative 'sendgrid/twilio_email'
 require_relative 'sendgrid/version'
+require_relative 'sendgrid/helpers/eventwebhook/eventwebhook'
 require_relative 'sendgrid/helpers/ip_management/ip_management'
 require_relative 'sendgrid/helpers/mail/asm'
 require_relative 'sendgrid/helpers/mail/attachment'
@@ -27,3 +30,4 @@ require_relative 'sendgrid/helpers/stats/email_stats'
 require_relative 'sendgrid/helpers/stats/stats_response'
 require_relative 'sendgrid/helpers/stats/metrics'
 require_relative 'sendgrid/helpers/permissions/scope'
+require_relative 'rack/sendgrid_webhook_verification'

data/lib/sendgrid/base_interface.rb

@@ -0,0 +1,36 @@
+require 'ruby_http_client'
+require_relative 'version'
+
+# Initialize the HTTP client
+class BaseInterface
+  attr_accessor :client
+  attr_reader :request_headers, :host, :version, :impersonate_subuser
+  # * *Args* :
+  #   - +auth+ -> authorization header value
+  #   - +host+ -> the base URL for the API
+  #   - +request_headers+ -> any headers that you want to be globally applied
+  #   - +version+ -> the version of the API you wish to access,
+  #                  currently only "v3" is supported
+  #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+  #                              in the "On-Behalf-Of" header
+  #
+  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil)
+    @auth = auth
+    @host = host
+    @version = version ? version : 'v3'
+    @impersonate_subuser = impersonate_subuser
+    @user_agent = "sendgrid/#{SendGrid::VERSION};ruby"
+    @request_headers = JSON.parse('
+        {
+          "Authorization": "' + @auth + '",
+          "Accept": "application/json",
+          "User-Agent": "' + @user_agent + '"
+        }
+    ')
+    @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser
+
+    @request_headers = @request_headers.merge(request_headers) if request_headers
+    @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
+                                   request_headers: @request_headers)
+  end
+end

data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb

@@ -0,0 +1,52 @@
+require 'base64'
+require 'digest'
+require 'openssl'
+
+module SendGrid
+  # This class allows you to use the Event Webhook feature. Read the docs for
+  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
+  class EventWebhook
+    # * *Args* :
+    #   - +public_key+ -> verification key under Mail Settings
+    #
+    def convert_public_key_to_ecdsa(public_key)
+      verify_engine
+      OpenSSL::PKey::EC.new(Base64.decode64(public_key))
+    end
+
+    # * *Args* :
+    #   - +public_key+ -> elliptic curve public key
+    #   - +payload+ -> event payload in the request body
+    #   - +signature+ -> signature value obtained from the 'X-Twilio-Email-Event-Webhook-Signature' header
+    #   - +timestamp+ -> timestamp value obtained from the 'X-Twilio-Email-Event-Webhook-Timestamp' header
+    def verify_signature(public_key, payload, signature, timestamp)
+      verify_engine
+      timestamped_playload = "#{timestamp}#{payload}"
+      payload_digest = Digest::SHA256.digest(timestamped_playload)
+      decoded_signature = Base64.decode64(signature)
+      public_key.dsa_verify_asn1(payload_digest, decoded_signature)
+    rescue
+      false
+    end
+
+    def verify_engine
+      # JRuby does not fully support ECDSA: https://github.com/jruby/jruby-openssl/issues/193
+      if RUBY_PLATFORM == "java"
+        raise NotSupportedError, "Event Webhook verification is not supported by JRuby"
+      end
+    end
+
+    class Error < ::RuntimeError
+    end
+
+    class NotSupportedError < Error
+    end
+  end
+
+  # This class lists headers that get posted to the webhook. Read the docs for
+  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
+  class EventWebhookHeader
+    SIGNATURE = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_SIGNATURE"
+    TIMESTAMP = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_TIMESTAMP"
+  end
+end

data/lib/sendgrid/sendgrid.rb

@@ -0,0 +1,20 @@
+# Quickly and easily access the Twilio SendGrid API.
+module SendGrid
+  class API < BaseInterface
+    # * *Args* :
+    #   - +api_key+ -> your Twilio SendGrid API key
+    #   - +host+ -> the base URL for the API
+    #   - +request_headers+ -> any headers that you want to be globally applied
+    #   - +version+ -> the version of the API you wish to access,
+    #                  currently only "v3" is supported
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #
+    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
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+    end
+  end
+end

data/lib/sendgrid/twilio_email.rb

@@ -0,0 +1,21 @@
+# Quickly and easily access the Twilio Email API.
+module TwilioEmail
+  class API < BaseInterface
+    # * *Args* :
+    #   - +username+ -> your Twilio Email API key SID or Account SID
+    #   - +password+ -> your Twilio Email API key secret or Account Auth Token
+    #   - +host+ -> the base URL for the API
+    #   - +request_headers+ -> any headers that you want to be globally applied
+    #   - +version+ -> the version of the API you wish to access,
+    #                  currently only "v3" is supported
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #
+    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
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+    end
+  end
+end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.1.3'
+  VERSION = '6.3.2'
 end

data/sendgrid-ruby.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name        = 'sendgrid-ruby'
   spec.version     = SendGrid::VERSION
   spec.authors     = ['Elmer Thomas', 'Robin Johnson', 'Eddie Zaneski']
-  spec.email       = 'dx@sendgrid.com'
+  spec.email       = 'help@twilio.com'
   spec.summary     = 'Official Twilio SendGrid Gem'
   spec.description = 'Official Twilio SendGrid Gem to Interact with Twilio SendGrids API in native Ruby'
   spec.homepage    = 'http://github.com/sendgrid/sendgrid-ruby'
@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'faker'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'minitest', '~> 5.9'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'simplecov'
 end

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/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
@@ -51,14 +27,14 @@ class TestAPI < MiniTest::Test
                     "Authorization": "Bearer SENDGRID_API_KEY",
                     "Accept": "application/json",
                     "X-Test": "test",
-                    "User-agent": "' + user_agent + '",
+                    "User-Agent": "' + user_agent + '",
                     "On-Behalf-Of": "' + subuser + '"
                 }
             ')
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
         assert_equal(subuser, sg.impersonate_subuser)
-        assert_equal("6.1.3", SendGrid::VERSION)
+        assert_equal("6.3.2", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.1.3
+  version: 6.3.2
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -130,9 +130,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Official Twilio SendGrid Gem to Interact with Twilio SendGrids API in
   native Ruby
-email: dx@sendgrid.com
+email: help@twilio.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -144,6 +172,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - ISSUE_TEMPLATE.md
 - LICENSE.md
@@ -169,6 +198,7 @@ files:
 - examples/contactdb/contactdb.rb
 - examples/devices/devices.rb
 - examples/geo/geo.rb
+- examples/helpers/eventwebhook/example.rb
 - examples/helpers/mail/example.rb
 - examples/helpers/settings/example.rb
 - examples/helpers/stats/example.rb
@@ -188,8 +218,10 @@ files:
 - examples/user/user.rb
 - gemfiles/Sinatra_1.gemfile
 - gemfiles/Sinatra_2.gemfile
+- lib/rack/sendgrid_webhook_verification.rb
 - lib/sendgrid-ruby.rb
-- lib/sendgrid/client.rb
+- lib/sendgrid/base_interface.rb
+- lib/sendgrid/helpers/eventwebhook/eventwebhook.rb
 - lib/sendgrid/helpers/inbound/README.md
 - lib/sendgrid/helpers/inbound/app.rb
 - lib/sendgrid/helpers/inbound/config.yml
@@ -232,9 +264,14 @@ files:
 - lib/sendgrid/helpers/stats/email_stats.rb
 - lib/sendgrid/helpers/stats/metrics.rb
 - lib/sendgrid/helpers/stats/stats_response.rb
+- lib/sendgrid/sendgrid.rb
+- lib/sendgrid/twilio_email.rb
 - lib/sendgrid/version.rb
 - mail_helper_v3.md
 - sendgrid-ruby.gemspec
+- spec/fixtures/event_webhook.rb
+- spec/rack/sendgrid_webhook_verification_spec.rb
+- spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb
 - spec/sendgrid/helpers/ip_management/ip_management_spec.rb
 - spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb
 - spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb
@@ -244,8 +281,9 @@ files:
 - spec/sendgrid/helpers/stats/email_stats_spec.rb
 - spec/sendgrid/helpers/stats/metrics_spec.rb
 - spec/sendgrid/helpers/stats/stats_response_spec.rb
+- spec/sendgrid/sendgrid_spec.rb
+- spec/sendgrid/twilio_email_spec.rb
 - spec/spec_helper.rb
-- test/prism.sh
 - test/sendgrid/helpers/mail/test_attachment.rb
 - test/sendgrid/helpers/mail/test_category.rb
 - test/sendgrid/helpers/mail/test_email.rb
@@ -272,11 +310,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Official Twilio SendGrid Gem
 test_files:
+- spec/fixtures/event_webhook.rb
+- spec/rack/sendgrid_webhook_verification_spec.rb
+- spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb
 - spec/sendgrid/helpers/ip_management/ip_management_spec.rb
 - spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb
 - spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb
@@ -286,8 +328,9 @@ test_files:
 - spec/sendgrid/helpers/stats/email_stats_spec.rb
 - spec/sendgrid/helpers/stats/metrics_spec.rb
 - spec/sendgrid/helpers/stats/stats_response_spec.rb
+- spec/sendgrid/sendgrid_spec.rb
+- spec/sendgrid/twilio_email_spec.rb
 - spec/spec_helper.rb
-- test/prism.sh
 - test/sendgrid/helpers/mail/test_attachment.rb
 - test/sendgrid/helpers/mail/test_category.rb
 - test/sendgrid/helpers/mail/test_email.rb

data/lib/sendgrid/client.rb

@@ -1,38 +0,0 @@
-# Quickly and easily access the Twilio SendGrid API.
-require 'ruby_http_client'
-require_relative 'version'
-
-module SendGrid
-  # Initialize the HTTP client
-  class API
-    attr_accessor :client
-    attr_reader :request_headers, :host, :version, :impersonate_subuser
-    # * *Args*    :
-    #   - +api_key+ -> your Twilio SendGrid API key
-    #   - +host+ -> the base URL for the API
-    #   - +request_headers+ -> any headers that you want to be globally applied
-    #   - +version+ -> the version of the API you wish to access,
-    #                  currently only "v3" is supported
-    #
-    def initialize(api_key: '', host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
-      @api_key             = api_key
-      @host                = host ? host : 'https://api.sendgrid.com'
-      @version             = version ? version : 'v3'
-      @impersonate_subuser = impersonate_subuser
-      @user_agent          = "sendgrid/#{SendGrid::VERSION};ruby"
-      @request_headers     = JSON.parse('
-        {
-          "Authorization": "Bearer ' + @api_key + '",
-          "Accept": "application/json",
-          "User-agent": "' + @user_agent + '"
-        }
-      ')
-      @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser
-
-
-      @request_headers = @request_headers.merge(request_headers) if request_headers
-      @client = Client.new(host: "#{@host}/#{@version}",
-                           request_headers: @request_headers)
-    end
-  end
-end

data/test/prism.sh

@@ -1,42 +0,0 @@
-#!/bin/bash
-
-install () {
-
-set -eu
-
-UNAME=$(uname)
-ARCH=$(uname -m)
-if [ "$UNAME" != "Linux" ] && [ "$UNAME" != "Darwin" ] && [ "$ARCH" != "x86_64" ] && [ "$ARCH" != "i686" ]; then
-    echo "Sorry, OS/Architecture not supported: ${UNAME}/${ARCH}. Download binary from https://github.com/stoplightio/prism/releases"
-    exit 1
-fi
-
-if [ "$UNAME" = "Darwin" ] ; then
-  OSX_ARCH=$(uname -m)
-  if [ "${OSX_ARCH}" = "x86_64" ] ; then
-    PLATFORM="darwin_amd64"
-  fi
-elif [ "$UNAME" = "Linux" ] ; then
-  LINUX_ARCH=$(uname -m)
-  if [ "${LINUX_ARCH}" = "i686" ] ; then
-    PLATFORM="linux_386"
-  elif [ "${LINUX_ARCH}" = "x86_64" ] ; then
-    PLATFORM="linux_amd64"
-  fi
-fi
-
-#LATEST=$(curl -s https://api.github.com/repos/stoplightio/prism/tags | grep -Eo '"name":.*?[^\\]",'  | head -n 1 | sed 's/[," ]//g' | cut -d ':' -f 2)
-LATEST="v0.2.7"
-URL="https://github.com/stoplightio/prism/releases/download/$LATEST/prism_$PLATFORM"
-DEST=./prism/bin/prism
-
-if [ -z $LATEST ] ; then
-  echo "Error requesting. Download binary from ${URL}"
-  exit 1
-else
-  curl -L $URL -o $DEST
-  chmod +x $DEST
-fi
-}
-
-install