sendgrid-ruby 6.2.0 → 6.3.4

data/use-cases/twilio-email.md

@@ -0,0 +1,13 @@
+First, follow the [Twilio Setup](twilio-setup.md) guide for creating a Twilio account and setting up environment variables with the proper credentials.
+
+Then, initialize the Twilio Email Client.
+
+```ruby
+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'])
+```
+
+This client has the same interface as the `SendGrid::API` client.

data/use-cases/twilio-setup.md

@@ -0,0 +1,54 @@
+## 1. Obtain a Free Twilio Account
+
+Sign up for a free Twilio account [here](https://www.twilio.com/try-twilio?source=sendgrid-ruby).
+
+## 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).
+
+Once you have those, follow the steps below based on your operating system.
+
+### 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
+
+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
+```
+
+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"
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.4
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -130,6 +130,34 @@ 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.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
 description: Official Twilio SendGrid Gem to Interact with Twilio SendGrids API in
   native Ruby
 email: help@twilio.com
@@ -140,10 +168,13 @@ files:
 - ".codeclimate.yml"
 - ".env_sample"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
+- FIRST_TIMERS.md
 - Gemfile
 - ISSUE_TEMPLATE.md
 - LICENSE.md
@@ -154,10 +185,7 @@ files:
 - TROUBLESHOOTING.md
 - UPGRADE.md
 - USAGE.md
-- USE_CASES.md
 - config.ru
-- docker/Dockerfile
-- docker/README.md
 - examples/accesssettings/accesssettings.rb
 - examples/alerts/alerts.rb
 - examples/apikeys/apikeys.rb
@@ -169,6 +197,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 +217,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/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
@@ -237,6 +268,9 @@ files:
 - 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
@@ -249,7 +283,8 @@ files:
 - spec/sendgrid/sendgrid_spec.rb
 - spec/sendgrid/twilio_email_spec.rb
 - spec/spec_helper.rb
-- test/prism.sh
+- static/img/github-fork.png
+- static/img/github-sign-up.png
 - test/sendgrid/helpers/mail/test_attachment.rb
 - test/sendgrid/helpers/mail/test_category.rb
 - test/sendgrid/helpers/mail/test_email.rb
@@ -257,6 +292,15 @@ files:
 - test/sendgrid/helpers/mail/test_personalizations.rb
 - test/sendgrid/permissions/test_scopes.rb
 - test/sendgrid/test_sendgrid-ruby.rb
+- twilio_sendgrid_logo.png
+- use-cases/README.md
+- use-cases/domain-authentication.md
+- use-cases/email-statistics.md
+- use-cases/legacy-templates.md
+- use-cases/sms.md
+- use-cases/transactional-templates.md
+- use-cases/twilio-email.md
+- use-cases/twilio-setup.md
 homepage: http://github.com/sendgrid/sendgrid-ruby
 licenses:
 - MIT
@@ -276,11 +320,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 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
@@ -293,7 +340,6 @@ test_files:
 - 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/USE_CASES.md

@@ -1,405 +0,0 @@
-This documentation provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/sendgrid-ruby/issues) or make a pull request for any use cases you would like us to document here. Thank you!
-
-# Table of Contents
-
-* [Transactional Templates](#transactional-templates)
-  * [With Mail Helper Class](#with-mail-helper-class)
-  * [Without Mail Helper Class](#without-mail-helper-class)
-* [Legacy Templates](#legacy-templates)
-  * [With Mail Helper Class](#with-mail-helper-class-1)
-  * [Without Mail Helper Class](#without-mail-helper-class-1)
-  * [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 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
-
-For this example, we assume you have created a [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):
-
-```text
-d-2c214ac919e84170b21855cc129b4a5f
-```
-Email Subject:
-```text
-{{subject}}
-```
-
-Template Body:
-
-```html
-<html>
-  <head>
-    <title></title>
-  </head>
-  <body>
-    Hello {{name}},
-    <br/><br/>
-    I'm glad you are trying out the template feature!
-    <br/><br/>
-    I hope you are having a great day in {{city}} :)
-    <br/><br/>
-  </body>
-</html>
-```
-
-## With Mail Helper Class
-```ruby
-require 'sendgrid-ruby'
-include SendGrid
-
-mail = Mail.new
-mail.from = Email.new(email: 'test@example.com')
-personalization = Personalization.new
-personalization.add_to(Email.new(email: 'test@example.com'))
-personalization.add_dynamic_template_data({
-    "subject" => "Testing Templates",
-    "name" => "Example User",
-    "city" => "Denver"
-  })
-mail.add_personalization(personalization)
-mail.template_id = 'd-2c214ac919e84170b21855cc129b4a5f'
-
-sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
-begin
-    response = sg.client.mail._("send").post(request_body: mail.to_json)
-rescue Exception => e
-    puts e.message
-end
-puts response.status_code
-puts response.body
-puts response.parsed_body
-puts response.headers
-```
-
-## Without Mail Helper Class
-
-```ruby
-require 'sendgrid-ruby'
-include SendGrid
-
-data = JSON.parse('{
-  "personalizations": [
-    {
-      "to": [
-        {
-          "email": "test@example.com"
-        }
-      ],
-      "dynamic_template_data": {
-        "subject": "Testing Templates",
-        "name": "Example User",
-        "city": "Denver"
-      }
-    }
-  ],
-  "from": {
-    "email": "test@example.com"
-  },
-  "template_id": "d-2c214ac919e84170b21855cc129b4a5f"
-}')
-sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
-begin
-    response = sg.client.mail._("send").post(request_body: data)
-rescue Exception => e
-    puts e.message
-end
-puts response.status_code
-puts response.body
-puts response.parsed_body
-puts response.headers
-```
-
-<a name="legacy-templates"></a>
-# Legacy Templates
-
-For this example, we assume you have created a [legacy template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
-
-Template ID (replace with your own):
-
-```text
-13b8f94f-bcae-4ec6-b752-70d6cb59f932
-```
-
-Email Subject:
-
-```text
-<%subject%>
-```
-
-Template Body:
-
-```html
-<html>
-<head>
-	<title></title>
-</head>
-<body>
-Hello -name-,
-<br /><br/>
-I'm glad you are trying out the template feature!
-<br /><br/>
-<%body%>
-<br /><br/>
-I hope you are having a great day in -city- :)
-<br /><br/>
-</body>
-</html>
-```
-
-## With Mail Helper Class
-
-```ruby
-require 'sendgrid-ruby'
-include SendGrid
-
-mail = SendGrid::Mail.new
-mail.from = Email.new(email: 'test@example.com')
-mail.subject = 'I\'m replacing the subject tag'
-personalization = Personalization.new
-personalization.add_to(Email.new(email: 'test@example.com'))
-personalization.add_substitution(Substitution.new(key: '-name-', value: 'Example User'))
-personalization.add_substitution(Substitution.new(key: '-city-', value: 'Denver'))
-mail.add_personalization(personalization)
-mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
-
-sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
-begin
-    response = sg.client.mail._("send").post(request_body: mail.to_json)
-rescue Exception => e
-    puts e.message
-end
-puts response.status_code
-puts response.body
-puts response.parsed_body
-puts response.headers
-```
-
-## Without Mail Helper Class
-
-```ruby
-require 'sendgrid-ruby'
-include SendGrid
-
-data = JSON.parse('{
-  "personalizations": [
-    {
-      "to": [
-        {
-          "email": "test@example.com"
-        }
-      ],
-      "substitutions": {
-        "-name-": "Example User",
-        "-city-": "Denver"
-      },
-      "subject": "I\'m replacing the subject tag"
-    }
-  ],
-  "from": {
-    "email": "test@example.com"
-  },
-  "template_id": "13b8f94f-bcae-4ec6-b752-70d6cb59f932"
-}')
-sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
-begin
-    response = sg.client.mail._("send").post(request_body: data)
-rescue Exception => e
-    puts e.message
-end
-puts response.status_code
-puts response.body
-puts response.parsed_body
-puts response.headers
-```
-
-## Adding Attachments
-
-```ruby
-attachment = Attachment.new
-attachment.content = Base64.strict_encode64(File.open(fpath, 'rb').read)
-attachment.type = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-attachment.filename = fname
-attachment.disposition = 'attachment'
-attachment.content_id = 'Reports Sheet'
-mail.add_attachment(attachment)
-
-```
-Attachments must be base64 encoded, using Base64's strict_encode64 where no line feeds are added.
-
-<a name="domain-authentication"></a>
-# 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-nodejs/blob/master/packages/client/USAGE.md#sender-authentication).
-
-Find more information about all of SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).
-
-<a name="email-statistics"></a>
-# How to View Email Statistics
-
-You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#stats).
-
-Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email.
-
-You can also use the email statistics helper to make it easier to interact with the API.
-
-```ruby
-require 'sendgrid-ruby'
-require 'date'
-
-include SendGrid
-
-sg_client = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']).client
-stats = SendGrid::EmailStats.new(sendgrid_client: sg_client)
-
-# Fetch stats by day, between 2 dates
-from = Date.new(2017, 10, 01)
-to = Date.new(2017, 10, 12)
-
-email_stats = stats.by_day(from, to)
-
-email_stats.metrics
-
-if !email_stats.error?
-  email_stats.metrics.each do |metric|
-    puts "Date - #{metric.date}"
-    puts "Number of Requests - #{metric.requests}"
-    puts "Bounces - #{metric.bounces}"
-    puts "Opens - #{metric.opens}"
-    puts "Clicks - #{metric.clicks}"
-  end
-end
-
-# Fetch stats by week, between 2 dates for a category
-from = Date.new(2017, 10, 01)
-to = Date.new(2017, 10, 12)
-category = 'abcd'
-
-email_stats = stats.by_week(from, to, category)
-
-if !email_stats.error?
-  email_stats.metrics.each do |metric|
-    puts "Date - #{metric.date}"
-    puts "Number of Requests - #{metric.requests}"
-    puts "Bounces - #{metric.bounces}"
-    puts "Opens - #{metric.opens}"
-    puts "Clicks - #{metric.clicks}"
-  end
-end
-
-```
-
-# Send an Email With Twilio Email (Pilot)
-
-### 1. Obtain a Free Twilio Account
-
-Sign up for a free Twilio account [here](https://www.twilio.com/try-twilio?source=sendgrid-ruby).
-
-### 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).
-
-Once you have those, follow the steps below based on your operating system.
-
-#### 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
-
-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
-```
-
-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. Initialize the Twilio Email Client
-
-```ruby
-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'])
-```
-
-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
-bundle
-```
-
-Or install it yourself using:
-
-```bash
-gem install twilio-ruby
-```
-
-Finally, send a message.
-
-```ruby
-require 'twilio-ruby'
-
-# put your own credentials here
-account_sid = ENV['TWILIO_ACCOUNT_SID']
-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
-@client.api.account.messages.create(
-  from: '+14159341234',
-  to: '+16105557069',
-  body: 'Hey there!'
-)
-```
-
-For more information, please visit the [Twilio SMS Ruby documentation](https://www.twilio.com/docs/sms/quickstart/ruby).