sendgrid-ruby 1.1.6 → 6.6.2

data/README.md

@@ -1,296 +1,220 @@
-# SendGrid::Ruby
+![Twilio SendGrid Logo](twilio_sendgrid_logo.png)
 
-This Gem allows you to quickly and easily send emails through SendGrid's Web API using native Ruby.
+[![Travis Badge](https://github.com/sendgrid/sendgrid-ruby/actions/workflows/test-and-deploy.yml/badge.svg)](https://github.com/sendgrid/sendgrid-ruby/actions/workflows/test-and-deploy.yml)
+[![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
+[![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-ruby.svg)](https://github.com/sendgrid/sendgrid-ruby/graphs/contributors)
+[![Open Source Helpers](https://www.codetriage.com/sendgrid/sendgrid-ruby/badges/users.svg)](https://www.codetriage.com/sendgrid/sendgrid-ruby)
 
-You can read our official documentation on the Web API's Mail feature [here](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
+**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
 
-[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-ruby)
+**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Ruby.**
 
+Version 3.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
 
-## Installation
+This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-ruby/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
 
-Add this line to your application's Gemfile:
-
-    gem 'sendgrid-ruby'
-
-And then execute:
+Please browse the rest of this README for further details.
 
-    $ bundle
+We appreciate your continued support, thank you!
 
-Or install it yourself using:
+# Table of Contents
 
-    $ gem install sendgrid-ruby
+* [Announcements](#announcements)
+* [Installation](#installation)
+* [Quick Start](#quick-start)
+* [Processing Inbound Email](#inbound)
+* [Usage](#usage)
+* [Use Cases](#use_cases)
+* [Announcements](#announcements)
+* [How to Contribute](#contribute)
+* [Troubleshooting](#troubleshooting)
+* [About](#about)
+* [License](#license)
 
-## Usage
+<a name="installation"></a>
+# Installation
 
-Create a new client with your SendGrid Username and Password.
+## Prerequisites
 
-```ruby
-require 'sendgrid-ruby'
+- Ruby version >= 2.4 (except version [2.6.0](TROUBLESHOOTING.md#ruby-versions))
+- The Twilio SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
 
-# As a hash
-client = SendGrid::Client.new(api_user: 'SENDGRID_USERNAME', api_key: 'SENDGRID_PASSWORD')
+## Setup Environment Variables
 
-# Or as a block
-client = SendGrid::Client.new do |c|
-  c.api_user = 'SENDGRID_USERNAME'
-  c.api_key = 'SENDGRID_PASSWORD'
-end
+Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:
 
-# or as a block with the API key only #
-client = SendGrid::Client.new do |c|
-  c.api_key = 'SENDGRID_APIKEY'
-end
+```bash
+echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
+echo "sendgrid.env" >> .gitignore
+source ./sendgrid.env
 ```
+## Install Package
 
-Create a new Mail object and send:
-```ruby
-mail = SendGrid::Mail.new do |m|
-  m.to = 'test@sendgrid.com'
-  m.from = 'taco@cat.limo'
-  m.subject = 'Hello world!'
-  m.text = 'I heard you like pineapple.'
-end
-
-res = client.send(mail)
-puts res.code
-puts res.body
-# 200
-# {"message"=>"success"}
-```
-
-You can also create a Mail object with a hash:
-```ruby
-res = client.send(SendGrid::Mail.new(to: 'example@example.com', from: 'taco@cat.limo', subject: 'Hello world!', text: 'Hi there!', html: '<b>Hi there!</b>'))
-puts res.code
-puts res.body
-# 200
-# {"message"=>"success"}
-```
-
-#### Attachments
+Add this line to your application's Gemfile:
 
-Attachments can be added to a Mail object with the `add_attachment` method. The first parameter is the path to the file, the second (optional) parameter is the desired name of the file. If a file name is not provided, it will use the original filename.
-```ruby
-mail.add_attachment('/tmp/report.pdf', 'july_report.pdf')
+```bash
+gem 'sendgrid-ruby'
 ```
 
-#### Inline Content
+And then execute:
 
-Inline content can be added to a Mail object with the `add_content` method. The first parameter is the path to the file, the second parameter is the cid to be referenced in the html. 
-```ruby
-mail = SendGrid::Mail.new do |m|
-  m.to = 'test@sendgrid.com'
-  m.from = 'taco@cat.limo'
-  m.subject = 'Hello world!'
-  m.text = 'I heard you like the beach.'
-  m.html = 'I heard you like the beach <div><img src="cid:beach"></div>'
-end
-mail.add_content('/tmp/beach.jpg', 'beach')
-result = client.send(mail)
+```bash
+bundle
 ```
 
-#### Available Params
+Or install it yourself using:
 
-```ruby
-params = {
-	:to,
-	:to_name,
-	:from,
-	:from_name,
-	:subject,
-	:text,
-	:html,
-	:cc,
-	:cc_name,
-	:bcc,
-	:bcc_name,
-	:reply_to,
-	:date,
-	:smtpapi,
-	:attachments,
-	:template
-}
+```bash
+gem install sendgrid-ruby
 ```
 
-#### Setting Params
+## Dependencies
 
-Params can be set in the usual Ruby ways, including a block or a hash.
+- [Ruby-HTTP-Client](https://github.com/sendgrid/ruby-http-client)
 
-````ruby
-mail = SendGrid::Mail.new do |m|
-  m.to = 'rbin@sendgrid.com'
-  m.from = 'taco@rbin.codes'
-end
+<a name="quick-start"></a>
+# Quick Start
 
-client.send(SendGrid::Mail.new(to: 'rbin@sendgrid.com', from: 'taco@cat.limo'))
-````
+## Hello Email
 
-#### :to
+The following is the minimum needed code to send an email with the [/mail/send Helper](lib/sendgrid/helpers/mail) ([here](examples/helpers/mail/example.rb#L21) is a full example):
 
-Using the **:to** param, we can pass a single email address as a string, or an array of email address strings.
-
-````ruby
-mail = SendGrid::Mail.new
-mail.to = 'taco@rbin.codes'
-# or
-mail.to = ['Example Dude <example@email.com>', 'john@email.com']
-# or
-mail.to = ['rbin@sendgrid.com', 'taco@cat.limo']
-````
-
-#### :from
+### With Mail Helper Class
 
 ```ruby
-mail = SendGrid::Mail.new
-mail.from = 'me@sendgrid.com'
-```
-
-#### :cc
-
-As with **:to**, **:cc** can take a single string or an array of strings.
-
-```ruby
-mail = SendGrid::Mail.new
-mail.cc = ['robin@sendgrid.com', 'taco@cat.limo']
-```
-
-#### :bcc
-
-As with **:to** and **:cc**, **:bcc** can take a single string or an array of strings.
-
-```ruby
-mail = SendGrid::Mail.new
-mail.bcc = ['robin@sendgrid.com', 'taco@cat.limo']
-```
+require 'sendgrid-ruby'
+include SendGrid
 
-#### :subject
+from = SendGrid::Email.new(email: 'test@example.com')
+to = SendGrid::Email.new(email: 'test@example.com')
+subject = 'Sending with Twilio SendGrid is Fun'
+content = SendGrid::Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
+mail = SendGrid::Mail.new(from, subject, to, content)
 
-```ruby
-mail = SendGrid::Mail.new
-mail.subject = 'This is a subject string'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+response = sg.client.mail._('send').post(request_body: mail.to_json)
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
 ```
 
-### Email Bodies:
-#### :text
+For more complex scenarios, please do not use the above constructor and instead build your own personalization object as [demonstrated here](examples/helpers/mail/example.rb#L21).
 
-Using the **:text** param allows us to add plain text to our email body.
+### Without Mail Helper Class
 
-```ruby
-mail = SendGrid::Mail.new
-mail.text = 'WHATTUP KITTY CAT!?'
-```
+The following is the minimum needed code to send an email without the /mail/send Helper ([here](examples/mail/mail.rb#L26) is a full example):
 
-#### :html
-
-Using the **:html** param allows us to add html content to our email body.
 ```ruby
-mail = SendGrid::Mail.new
-mail.html = '<html><body>Stuff in here, yo!</body></html>'
-```
-
-#### :template
-
-The **:template** param allows us to specify a template object for this email to use. The initialized `Template` will automatically be included in the `smtpapi` header and passed to SendGrid.
+require 'sendgrid-ruby'
+include SendGrid
+
+data = JSON.parse('{
+  "personalizations": [
+    {
+      "to": [
+        {
+          "email": "test@example.com"
+        }
+      ],
+      "subject": "Sending with Twilio SendGrid is Fun"
+    }
+  ],
+  "from": {
+    "email": "test@example.com"
+  },
+  "content": [
+    {
+      "type": "text/plain",
+      "value": "and easy to do anywhere, even with Ruby"
+    }
+  ]
+}')
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+response = sg.client.mail._("send").post(request_body: data)
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
+```
+
+## General v3 Web API Usage (With Fluent Interface)
 
 ```ruby
-template = SendGrid::Template.new('MY_TEMPLATE_ID')
-mail.template = template
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+response = sg.client.suppression.bounces.get()
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
 ```
 
-## Working with Templates
-
-Another easy way to use the [SendGrid Templating](https://sendgrid.com/docs/API_Reference/Web_API_v3/Template_Engine/index.html) system is with the `Recipient`, `Mail`, `Template`, and `TemplateMailer` objects.
-
-Create some `Recipients`
+## General v3 Web API Usage (Without Fluent Interface)
 
 ```ruby
-users = User.where(email: ['first@gmail.com', 'second@gmail.com'])
-
-recipients = []
-
-users.each do |user|
-  recipient = SendGrid::Recipient.new(user.email)
-  recipient.add_substitution('first_name', user.first_name)
-  recipient.add_substitution('city', user.city)
-
-  recipients << recipient
-end
+require 'sendgrid-ruby'
+sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+response = sg.client._("suppression/bounces").get()
+puts response.status_code
+puts response.body
+puts response.parsed_body
+puts response.headers
 ```
 
-Create a `Template`
+<a name="inbound"></a>
+# Processing Inbound Email
 
-```ruby
-template = SendGrid::Template.new('MY_TEMPLATE_ID')
-```
-
-Create a `Client`
+Please see [our helper](lib/sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
 
-```ruby
-client = SendGrid::Client.new(api_user: my_user, api_key: my_key)
-```
+<a name="usage"></a>
+# Usage
 
-Initialize mail defaults and create the `TemplateMailer`
+- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html)
+- [Library Usage Docs](USAGE.md)
+- [Example Code](examples)
+- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
+- [v3 Web API Mail Send Helper](lib/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
+- [Settings Helper](lib/sendgrid/helpers/settings)
 
-```ruby
-mail_defaults = {
-  from: 'admin@email.com',
-  html: '<h1>I like email</h1>',
-  text: 'I like email',
-  subject: 'Email is great',
-}
-
-mailer = SendGrid::TemplateMailer.new(client, template, recipients)
-```
+<a name="use_cases"></a>
+# Use Cases
 
-Mail it!
+[Examples of common API use cases](use-cases), such as how to send an email with a transactional template.
 
-```ruby
-mailer.mail(mail_defaults)
-```
+<a name="announcements"></a>
+# Announcements
 
-## Using SendGrid's X-SMTPAPI Header
+Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-ruby/issues/94). Your support is appreciated!
 
-<blockquote>
-To utilize the X-SMTPAPI header, we have directly integrated the <a href="https://github.com/SendGridJP/smtpapi-ruby">SendGridJP/smtpapi-ruby</a> gem.
-For more information, view our <a href=https://sendgrid.com/docs/API_Reference/SMTP_API/index.html>SMTPAPI docs page</a>.
-</blockquote>
+All updates to this library are documented in our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
 
-```ruby
+<a name="contribute"></a>
+# How to Contribute
 
-header = Smtpapi::Header.new
-header.add_to(['john.doe@example.com', 'jane.doe@example.com'])
-header.add_substitution('keep', ['secret'])        # sub = {keep: ['secret']}
-header.add_substitution('other', ['one', 'two'])   # sub = {keep: ['secret'], other: ['one', 'two']}
-header.add_unique_arg("unique_code", "8675309")
-header.add_category("Newsletter")
-header.add_filter('templates', 'enable', 1)	   # necessary for each time the template engine is used
-header.add_filter('templates', 'template_id', '1234-5678-9100-abcd')
-header.set_ip_pool("marketing_ip_pool")
-mail.smtpapi = header
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
 
-```
-## Testing ##
+- [Feature Request](CONTRIBUTING.md#feature_request)
+- [Bug Reports](CONTRIBUTING.md#submit_a_bug_report)
+- [Improvements to the Codebase](CONTRIBUTING.md#improvements_to_the_codebase)
+- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
 
-`bundle exec rake test`
+<a name="troubleshooting"></a>
+# Troubleshooting
 
-## Deploying ##
+Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues.
 
-1. Confirm tests pass `bundle exec rake test`
-2. Bump the version in `lib/sendgrid/version.rb` and `spec/lib/sendgrid_spec.rb`
-3. Update CHANGELOG.md
-4. Commit Version bump vX.X.X
-5. `rake release`
-6. Push changes to GitHub
-7. Release tag on GitHub vX.X.X
+<a name="about"></a>
+# About
 
-## Contributing ##
+sendgrid-ruby is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of Twilio SendGrid, Inc.
 
-1. Fork it ( https://github.com/[my-github-username]/sendgrid-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
 
-***Hit up [@rbin](http://twitter.com/rbin) or [@sendgrid](http://twitter.com/sendgrid) on Twitter with any issues.***
+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
+[The MIT License (MIT)](LICENSE)

data/Rakefile

@@ -1,8 +1,14 @@
+require 'rake/testtask'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/sendgrid/test*.rb', 'test/sendgrid/helpers/mail/test*.rb', 'test/sendgrid/helpers/permissions/test*.rb']
+  t.verbose = true
+end
 
-task test: :spec
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+desc 'Run tests'
+task default: %i[spec test]

data/TROUBLESHOOTING.md

@@ -0,0 +1,151 @@
+If you have an issue logging into your Twilio SendGrid account, please read this [document](https://sendgrid.com/docs/ui/account-and-settings/troubleshooting-login/). For any questions regarding login issues, please contact our [support team](https://support.sendgrid.com).
+
+If you have a non-library Twilio SendGrid issue, please contact our [support team](https://support.sendgrid.com).
+
+If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-ruby/issues).
+
+
+## Table of Contents
+
+* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
+* [Continue Using v2](#continue-using-v2)
+* [Testing v3 /mail/send Calls Directly](#testing-v3-mailsend-calls-directly)
+* [Error Messages](#error-messages)
+* [Versioning](#versioning)
+* [Environment Variables and Your Twilio SendGrid API Key](#environment-variables-and-your-twilio-sendgrid-api-key)
+* [Using the Package Manager](#using-the-package-manager)
+* [Rails Specifics](#rails-specifics)
+* [Ruby Versions](#ruby-versions)
+* [Viewing the Request Body](#viewing-the-request-body)
+* [Verifying Event Webhooks](#signed-webhooks)
+
+<a name="migrating"></a>
+## Migrating from v2 to v3
+
+Please review [our guide](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) on how to migrate from v2 to v3.
+
+<a name="v2"></a>
+## Continue Using v2
+
+[Here](https://github.com/sendgrid/sendgrid-ruby/tree/0fbf579c0f7ed1dff87adc4957c4dc5a6b257068) is the last working version with v2 support.
+
+Using RubyGems:
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'sendgrid-ruby',  '1.1.6'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself using:
+
+```bash
+gem install sendgrid-ruby -v 1.1.6
+```
+
+Download:
+
+Click the "Clone or download" green button in [GitHub](https://github.com/sendgrid/sendgrid-ruby/tree/0fbf579c0f7ed1dff87adc4957c4dc5a6b257068) and choose download.
+
+<a name="testing"></a>
+## Testing v3 /mail/send Calls Directly
+
+[Here](https://sendgrid.com/docs/for-developers/sending-email/curl-examples/) are some cURL examples for common use cases.
+
+<a name="error"></a>
+## Error Messages
+
+To read the error message returned by SendGrid's API:
+
+```ruby
+begin
+    response = sg.client.mail._("send").post(request_body: mail.to_json)
+rescue Exception => e
+    puts e.message
+end
+```
+
+<a name="versioning"></a>
+## Versioning
+
+We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
+
+<a name="environment"></a>
+## Environment Variables and Your Twilio SendGrid API Key
+
+All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-ruby#setup-environment-variables) to hold your Twilio SendGrid API key.
+
+If you choose to add your Twilio SendGrid API key directly (not recommended):
+
+`sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])`
+
+becomes
+
+`sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY')`
+
+In the first case, SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
+
+<a name="package-manager"></a>
+## Using the Package Manager
+
+We upload this library to [RubyGems](https://rubygems.org/gems/sendgrid-ruby) whenever we make a release. This allows you to use [RubyGems](https://rubygems.org) for easy installation.
+
+In most cases we recommend you download the latest version of the library, but if you need a different version, please use:
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'sendgrid-ruby',  'X.X.X'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself using:
+
+```bash
+gem install sendgrid-ruby -v X.X.X
+```
+
+<a name="rails-specifics"></a>
+## Rails Specifics
+
+- Namespace collision between Rails own `Mail` class and sendgrid class `Mail`. To avoid that issues please use `SendGrid:: Mail` instead.
+
+- The possibility of a namespace collision between the sendgrid class `Email` and your own defined `Email` class. To avoid these issues, you can skip the `include SendGrid` line and use the `SendGrid::` prefix for Email. Please see this [SO answer](https://stackoverflow.com/questions/41508464/rails-model-name-conflict-with-included-gem?noredirect=1#comment70223099_41508464) for specifics.
+
+<a name="ruby-versions"></a>
+## Ruby Versions
+
+This SDK [does not work with ruby version 2.6.0](https://github.com/sendgrid/sendgrid-ruby/issues/378) because of [this bug](https://bugs.ruby-lang.org/issues/15468). Please use any other [supported version](https://github.com/sendgrid/sendgrid-ruby#prerequisites).
+
+<a name="request-body"></a>
+## Viewing the Request Body
+
+When debugging or testing, it may be useful to examine the raw request header to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html).
+
+You can do this before `response = sg.client.mail._('send').post(request_body: mail.to_json)` like so:
+
+```ruby
+puts mail.to_json
+```
+
+<a name="signed-webhooks"></a>
+## Signed Webhook Verification
+
+Twilio SendGrid's Event Webhook will notify a URL via HTTP POST with information about events that occur as your mail is processed. [This](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features) article covers all you need to know to secure the Event Webhook, allowing you to verify that incoming requests originate from Twilio SendGrid. The sendgrid-ruby library can help you verify these Signed Event Webhooks.
+
+You can find the usage example [here](examples/helpers/eventwebhook/example.rb) and the tests [here](spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb). 
+If you are still having trouble getting the validation to work, follow the following instructions:
+- Be sure to use the *raw* payload for validation
+- Be sure to include a trailing carriage return and newline in your payload
+- In case of multi-event webhooks, make sure you include the trailing newline and carriage return after *each* event

data/UPGRADE.md

@@ -0,0 +1,5 @@
+# Upgrading from 5.X to 6.X
+
+Note, this is only necessary if you are using inbound processing.
+
+* Add this gem to your Gemfile: `gem 'sinatra', '>= 1.4.7', '< 3'`