sendgrid-ruby 6.3.2 → 6.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84b6e88237dcfab04ae17b076923e3ff2199683514b1f5916c4e0851f83b871
-  data.tar.gz: 2d19e0c66fd9ff2abcc0a6b38ae8e080cbba4961dc12e2a086243069cd81f59b
+  metadata.gz: 0a99cbab593becca226765be0e10692ded5477764699344b3b93ca619aa3290e
+  data.tar.gz: 2db29c6f0abeef43197c19fd384a2760e42f0ba952ed490a3ba60efbab3a1261
 SHA512:
-  metadata.gz: 534ea0a42703026d6fccab526263f44cf6fdcc3f65228fcbc06a6d3c7c6ad80dfc12e553d6273515d87f7595a170e171a9c897980a76b7c47d0a55b940551ffb
-  data.tar.gz: b9f2b208e7838d3e9716678c5227eea427fc168e244fa5ba7709970f9a83ec49f9da18062494a2901a1efc6e46dbc9e67e0cfc9bc559b1b09089ee9747a2e47c
+  metadata.gz: 4c9853763d323eef8a89334648df9cb8f8a3ed30687fedd463cffaec72aa6f4ca6627280a7c7805f8040001370c96441810e32fcec5b1528961b114734c85664
+  data.tar.gz: f46c413bb546de8f57eaa1bc4cb85ef73a585a372a5df1417c7511d79797f9b42ddfb2a7797550e831182a597fe5bdeebd95ce794d9dd505a1434d5ad4e929f0

data/.codeclimate.yml

@@ -16,6 +16,6 @@ ratings:
   - "**.rb"
 exclude_paths:
 - examples/
+- gemfiles/
 - spec/
 - test/
-- gemfiles/

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - examples/**/*
+    - gemfiles/**/*
+    - spec/**/*
+    - test/**/*

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2020-07-22] Version 6.3.3
+--------------------------
+**Library - Chore**
+- [PR #431](https://github.com/sendgrid/sendgrid-ruby/pull/431): migrate to new default sendgrid-oai branch. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+- [PR #366](https://github.com/sendgrid/sendgrid-ruby/pull/366): add Rubocop configuration file. Thanks to [@RolandBurrows](https://github.com/RolandBurrows)!
+
+**Library - Test**
+- [PR #429](https://github.com/sendgrid/sendgrid-ruby/pull/429): fix the license test and actually run the test scripts. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+**Library - Docs**
+- [PR #273](https://github.com/sendgrid/sendgrid-ruby/pull/273): Create a Use Cases Directory and Associated Files. Thanks to [@alanunruh](https://github.com/alanunruh)!
+
+
 [2020-07-08] Version 6.3.2
 --------------------------
 **Library - Test**

data/CONTRIBUTING.md

@@ -124,20 +124,13 @@ Tests for the mail send and Web API v3 endpoints.
 
 The Web API v3 client is `sendgrid-ruby.rb`
 
-<a name="testing"></a>
 ## Testing
 
-All PRs require passing tests before the PR will be reviewed.
+All PRs require passing tests before the PR will be reviewed. All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-ruby/tree/master/test) directory. For the purposes of contributing to this repo, please update the [`test_sendgrid-ruby.rb`](https://github.com/sendgrid/sendgrid-ruby/blob/master/test/test_sendgrid-ruby.rb) file with unit tests as you modify the code.
 
-All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-ruby/tree/master/test) directory.
+The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
 
-For the purposes of contributing to this repo, please update the [`test_sendgrid-ruby.rb`](https://github.com/sendgrid/sendgrid-ruby/blob/master/test/test_sendgrid-ruby.rb) file with unit tests as you modify the code.
-
-To run the tests:
-
-```bash
-rake
-```
+Once these are available, simply execute the Docker test target to run all tests: `make test-docker`. This command can also be used to open an interactive shell into the container where this library is installed. To start a *bash* shell for example, use this command: `command=bash make test-docker`.
 
 <a name="style-guidelines-and-naming-conventions"></a>
 ## Style Guidelines & Naming Conventions

data/Makefile

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

data/README.md

@@ -205,7 +205,6 @@ We encourage contribution to our libraries (you might even score some nifty swag
 
 - [Feature Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#feature_request)
 - [Bug Reports](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#submit_a_bug_report)
-- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#cla)
 - [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-ruby/tree/master/CONTRIBUTING.md#improvements_to_the_codebase)
 - [Review Pull Requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md#code-reviews)
 

data/lib/sendgrid/version.rb

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

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

@@ -34,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.3.2", SendGrid::VERSION)
+        assert_equal("6.3.3", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 
@@ -2652,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
-    end
-
-    def test_docker_exists
-      assert(File.file?('./Docker') || File.file?('./docker/Dockerfile'))
+    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_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/).

data/use-cases/email-statistics.md

@@ -0,0 +1,52 @@
+# 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
+```

data/use-cases/legacy-templates.md

@@ -0,0 +1,98 @@
+# 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
+```

data/use-cases/sms.md

@@ -0,0 +1,39 @@
+First, follow the [Twilio Setup](twilio-setup.md) guide 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).

data/use-cases/transactional-templates.md

@@ -0,0 +1,111 @@
+# 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
+```
+
+## 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.

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.3.2
+  version: 6.3.3
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -168,6 +168,7 @@ files:
 - ".codeclimate.yml"
 - ".env_sample"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -183,10 +184,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
@@ -291,6 +289,14 @@ files:
 - test/sendgrid/helpers/mail/test_personalizations.rb
 - test/sendgrid/permissions/test_scopes.rb
 - test/sendgrid/test_sendgrid-ruby.rb
+- 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
@@ -310,8 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Official Twilio SendGrid Gem

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).

data/docker/Dockerfile

@@ -1,12 +0,0 @@
-FROM ruby:2.5.1-jessie
-
-# Clone sendgrid-ruby
-WORKDIR /sources
-RUN git clone https://github.com/sendgrid/sendgrid-ruby.git
-
-# Bundle
-WORKDIR /sources/sendgrid-ruby
-RUN bundle install
-
-# Install prism
-RUN curl https://raw.githubusercontent.com/stoplightio/prism/master/install.sh | sh

data/docker/README.md

@@ -1,30 +0,0 @@
-# Docker image for sendgrid-ruby
-
-## Quickstart
-1. [Install Docker](https://docs.docker.com/engine/installation/) on your machine.
-2. Run `docker run --rm -it sendgrid/sendgrid-ruby irb`.
-3. Run `require './lib/sendgrid-ruby.rb'`.
-
-## Poke around
-
-If you would like to just poke around in the image and check some examples:
-```sh
-docker run --rm -it sendgrid/sendgrid-ruby bash
-```
-
-If you want to mount your fork or specific version of the gem:
-```sh
-docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby -it sendgrid/sendgrid-ruby bash
-```
-
-## Running tests
-
-If you would like to run the tests present in the image:
-```sh
-docker run --rm sendgrid/sendgrid-ruby rake
-```
-
-If you want to run tests on your fork or a specific version, mount the codebase onto the image:
-```sh
-docker run --rm -v /path/to/local/sendgrid-ruby:/sources/sendgrid-ruby sendgrid/sendgrid-ruby rake
-```