RubyGems - sendgrid-ruby - Versions diffs - 6.3.1 → 6.3.6 - Mend

sendgrid-ruby 6.3.1 → 6.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (119) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +1 -1
data/.rubocop.yml +8 -0
data/.rubocop_todo.yml +109 -0
data/.travis.yml +2 -3
data/CHANGELOG.md +61 -9
data/CONTRIBUTING.md +10 -20
data/FIRST_TIMERS.md +79 -0
data/ISSUE_TEMPLATE.md +5 -1
data/Makefile +3 -2
data/PULL_REQUEST_TEMPLATE.md +1 -1
data/README.md +22 -27
data/Rakefile +2 -3
data/TROUBLESHOOTING.md +5 -5
data/USAGE.md +145 -38
data/examples/accesssettings/accesssettings.rb +9 -12
data/examples/alerts/alerts.rb +8 -11
data/examples/apikeys/apikeys.rb +12 -15
data/examples/asm/asm.rb +27 -30
data/examples/browsers/browsers.rb +0 -3
data/examples/campaigns/campaigns.rb +29 -32
data/examples/categories/categories.rb +0 -3
data/examples/clients/clients.rb +1 -4
data/examples/contactdb/contactdb.rb +63 -66
data/examples/devices/devices.rb +0 -3
data/examples/emailactivity/emailactivity.rb +52 -0
data/examples/geo/geo.rb +0 -3
data/examples/helpers/eventwebhook/example.rb +4 -4
data/examples/helpers/mail/example.rb +19 -13
data/examples/helpers/settings/example.rb +1 -1
data/examples/helpers/stats/example.rb +4 -4
data/examples/ips/ips.rb +19 -22
data/examples/mail/mail.rb +72 -75
data/examples/mailboxproviders/mailboxproviders.rb +0 -3
data/examples/mailsettings/mailsettings.rb +21 -24
data/examples/partnersettings/partnersettings.rb +3 -6
data/examples/scopes/scopes.rb +7 -9
data/examples/senderauthentication/senderauthentication.rb +41 -44
data/examples/senders/senders.rb +28 -31
data/examples/stats/stats.rb +0 -3
data/examples/subusers/subusers.rb +17 -20
data/examples/suppression/suppression.rb +15 -18
data/examples/templates/templates.rb +29 -31
data/examples/trackingsettings/trackingsettings.rb +14 -17
data/examples/user/user.rb +41 -44
data/lib/rack/sendgrid_webhook_verification.rb +5 -2
data/lib/sendgrid/base_interface.rb +1 -1
data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +4 -6
data/lib/sendgrid/helpers/inbound/README.md +5 -5
data/lib/sendgrid/helpers/inbound/app.rb +1 -1
data/lib/sendgrid/helpers/inbound/public/index.html +1 -1
data/lib/sendgrid/helpers/inbound/send.rb +2 -2
data/lib/sendgrid/helpers/ip_management/ip_management.rb +1 -1
data/lib/sendgrid/helpers/mail/README.md +3 -3
data/lib/sendgrid/helpers/mail/asm.rb +6 -18
data/lib/sendgrid/helpers/mail/attachment.rb +12 -42
data/lib/sendgrid/helpers/mail/bcc_settings.rb +6 -18
data/lib/sendgrid/helpers/mail/bypass_list_management.rb +8 -18
data/lib/sendgrid/helpers/mail/category.rb +2 -2
data/lib/sendgrid/helpers/mail/click_tracking.rb +6 -18
data/lib/sendgrid/helpers/mail/content.rb +4 -3
data/lib/sendgrid/helpers/mail/custom_arg.rb +6 -10
data/lib/sendgrid/helpers/mail/email.rb +5 -4
data/lib/sendgrid/helpers/mail/footer.rb +7 -27
data/lib/sendgrid/helpers/mail/ganalytics.rb +10 -54
data/lib/sendgrid/helpers/mail/header.rb +6 -10
data/lib/sendgrid/helpers/mail/mail.rb +30 -48
data/lib/sendgrid/helpers/mail/mail_settings.rb +9 -25
data/lib/sendgrid/helpers/mail/open_tracking.rb +6 -18
data/lib/sendgrid/helpers/mail/personalization.rb +34 -27
data/lib/sendgrid/helpers/mail/section.rb +6 -10
data/lib/sendgrid/helpers/mail/spam_check.rb +7 -27
data/lib/sendgrid/helpers/mail/subscription_tracking.rb +8 -36
data/lib/sendgrid/helpers/mail/substitution.rb +6 -10
data/lib/sendgrid/helpers/mail/tracking_settings.rb +7 -20
data/lib/sendgrid/helpers/permissions/scope.rb +1 -1
data/lib/sendgrid/helpers/settings/README.md +2 -2
data/lib/sendgrid/helpers/settings/settings.rb +1 -1
data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +3 -5
data/lib/sendgrid/helpers/stats/metrics.rb +5 -5
data/lib/sendgrid/sendgrid.rb +1 -1
data/lib/sendgrid/twilio_email.rb +1 -1
data/lib/sendgrid/version.rb +1 -1
data/mail_helper_v3.md +12 -12
data/sendgrid-ruby.gemspec +8 -8
data/spec/fixtures/event_webhook.rb +17 -11
data/spec/rack/sendgrid_webhook_verification_spec.rb +30 -4
data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +38 -36
data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +1 -1
data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +1 -1
data/spec/sendgrid/helpers/settings/settings_spec.rb +2 -2
data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +1 -1
data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +1 -1
data/spec/sendgrid/helpers/stats/email_stats_spec.rb +22 -23
data/spec/sendgrid/helpers/stats/metrics_spec.rb +19 -20
data/spec/sendgrid/helpers/stats/stats_response_spec.rb +22 -23
data/spec/spec_helper.rb +3 -1
data/static/img/github-fork.png +0 -0
data/static/img/github-sign-up.png +0 -0
data/test/sendgrid/helpers/mail/test_attachment.rb +4 -6
data/test/sendgrid/helpers/mail/test_category.rb +0 -2
data/test/sendgrid/helpers/mail/test_email.rb +9 -11
data/test/sendgrid/helpers/mail/test_mail.rb +101 -102
data/test/sendgrid/helpers/mail/test_personalizations.rb +106 -93
data/test/sendgrid/permissions/test_scopes.rb +0 -2
data/test/sendgrid/test_sendgrid-ruby.rb +1948 -1958
data/twilio_sendgrid_logo.png +0 -0
data/use-cases/README.md +16 -0
data/use-cases/domain-authentication.md +5 -0
data/use-cases/email-statistics.md +52 -0
data/use-cases/legacy-templates.md +98 -0
data/use-cases/sms.md +39 -0
data/use-cases/transactional-templates.md +111 -0
data/use-cases/twilio-email.md +13 -0
data/use-cases/twilio-setup.md +54 -0
metadata +53 -28
data/USE_CASES.md +0 -405
data/docker/Dockerfile +0 -12
data/docker/README.md +0 -30

data/USE_CASES.md DELETED

@@ -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 DELETED

@@ -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 DELETED

@@ -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
-```