RubyGems - sendgrid-ruby - Versions diffs - 5.3.0 → 6.0.0 - Mend

sendgrid-ruby 5.3.0 → 6.0.0

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 (47) hide show

checksums.yaml +4 -4
data/.github/PULL_REQUEST_TEMPLATE +3 -1
data/CHANGELOG.md +25 -0
data/CODE_OF_CONDUCT.md +11 -11
data/CONTRIBUTING.md +17 -22
data/LICENSE.txt +1 -1
data/README.md +25 -12
data/Rakefile +1 -1
data/TROUBLESHOOTING.md +21 -15
data/UPGRADE.md +5 -0
data/USAGE.md +1103 -1101
data/USE_CASES.md +248 -18
data/examples/helpers/mail/example.rb +7 -7
data/examples/ips/ips.rb +13 -0
data/examples/mail/mail.rb +2 -2
data/examples/scopes/scopes.rb +49 -3
data/examples/{whitelabel/whitelabel.rb → senderauthentication/senderauthentication.rb} +27 -27
data/examples/suppression/suppression.rb +10 -10
data/lib/sendgrid-ruby.rb +2 -0
data/lib/sendgrid/client.rb +12 -9
data/lib/sendgrid/helpers/inbound/README.md +22 -5
data/lib/sendgrid/helpers/inbound/app.rb +13 -1
data/lib/sendgrid/helpers/inbound/public/index.html +1 -1
data/lib/sendgrid/helpers/inbound/sample_data/default_data.txt +2 -2
data/lib/sendgrid/helpers/inbound/sample_data/raw_data.txt +2 -2
data/lib/sendgrid/helpers/inbound/sample_data/raw_data_with_attachments.txt +2 -2
data/lib/sendgrid/helpers/inbound/send.rb +2 -2
data/lib/sendgrid/helpers/ip_management/ip_management.rb +17 -0
data/lib/sendgrid/helpers/mail/README.md +1 -1
data/lib/sendgrid/helpers/mail/attachment.rb +24 -1
data/lib/sendgrid/helpers/mail/category.rb +0 -8
data/lib/sendgrid/helpers/mail/content.rb +3 -16
data/lib/sendgrid/helpers/mail/email.rb +3 -16
data/lib/sendgrid/helpers/mail/mail.rb +8 -40
data/lib/sendgrid/helpers/permissions/scope.rb +28 -0
data/lib/sendgrid/helpers/permissions/scopes.yml +309 -0
data/lib/sendgrid/helpers/settings/README.md +1 -1
data/lib/sendgrid/helpers/stats/stats_response.rb +1 -1
data/lib/sendgrid/version.rb +1 -1
data/mail_helper_v3.md +9 -9
data/sendgrid-ruby.gemspec +3 -3
data/spec/sendgrid/helpers/ip_management/ip_management_spec.rb +12 -0
data/test/sendgrid/helpers/mail/test_attachment.rb +35 -0
data/test/sendgrid/helpers/mail/test_mail.rb +29 -21
data/test/sendgrid/permissions/test_scopes.rb +38 -0
data/test/sendgrid/test_sendgrid-ruby.rb +15 -7
metadata +17 -6

data/USE_CASES.md CHANGED

@@ -3,15 +3,127 @@ This documentation provides examples for specific use cases. Please [open an iss
 # Table of Contents
 * [Transactional Templates](#transactional-templates)
-* [How to Setup a Domain Whitelabel](#domain-whitelabel)
-* [How to View Email Statistics](#email-statistics)
+  * [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 a SMS Message](#send-a-sms-message)
+  * [1. Obtain a Free Twilio Account](#1-obtain-a-free-twilio-account)
+  * [2. Update Your Environment Variables](#2-update-your-environment-variables)
+    * [Mac](#mac)
+    * [Windows](#windows)
+  * [3. Install the Twilio Helper Library](#3-install-the-twilio-helper-library)
+  * [4. Setup Work](#4-setup-work)
+  * [5. Send an SMS](#5-send-an-sms)
 <a name="transactional-templates"></a>
-# (LEGACY) Transactional Templates
+# Transactional Templates
-IF YOU ARE USING OUR NEW TEMPLATES, PLEASE SEE [THIS ISSUE](https://github.com/sendgrid/sendgrid-ruby/issues/301).
+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.
-For this example, we assume you have created a [transactional 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
+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):
@@ -51,7 +163,7 @@ I hope you are having a great day in -city- :)
 require 'sendgrid-ruby'
 include SendGrid
-mail = Mail.new
+mail = SendGrid::Mail.new
 mail.from = Email.new(email: 'test@example.com')
 mail.subject = 'I\'m replacing the subject tag'
 personalization = Personalization.new
@@ -59,7 +171,6 @@ 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.add_content(Content.new(type: 'text/html', value: 'I\'m replacing the <strong>body tag</strong>'))
 mail.template_id = '13b8f94f-bcae-4ec6-b752-70d6cb59f932'
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -98,12 +209,6 @@ data = JSON.parse('{
   "from": {
     "email": "test@example.com"
   },
-  "content": [
-    {
-      "type": "text/html",
-      "value": "I\'m replacing the <strong>body tag</strong>"
-    }
-  ],
   "template_id": "13b8f94f-bcae-4ec6-b752-70d6cb59f932"
 }')
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -132,16 +237,141 @@ mail.add_attachment(attachment)
 ```
 Attachments must be base64 encoded, using Base64's strict_encode64 where no line feeds are added.
-<a name="domain-whitelabel"></a>
-# How to Setup a Domain Whitelabel
+<a name="domain-authentication"></a>
+# How to Setup a Domain Authentication
-You can find documentation for how to setup a domain whitelabel via the UI [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/setup_domain_whitelabel.html) and via API [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/USAGE.md#whitelabel).
+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 whitelabeling related documentation [here](https://sendgrid.com/docs/Classroom/Basics/Whitelabel/index.html).
+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 SendGrid processes your email.
+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
+```
+<a name="sms"></a>
+# Send a SMS Message
+Following are the steps to add Twilio SMS to your app:
+## 1. Obtain a Free Twilio Account
+Sign up for a free Twilio account [here](https://www.twilio.com/try-twilio?source=sendgrid-ruby).
+## 2. Update Your Environment Variables
+You can obtain your Account Sid and Auth Token from [twilio.com/console](https://twilio.com/console).
+### Mac
+```bash
+echo "export TWILIO_ACCOUNT_SID='YOUR_TWILIO_ACCOUNT_SID'" > twilio.env
+echo "export TWILIO_AUTH_TOKEN='YOUR_TWILIO_AUTH_TOKEN'" >> twilio.env
+echo "twilio.env" >> .gitignore
+source ./twilio.env
+```
+### Windows
+Temporarily set the environment variable (accessible only during the current CLI session):
+```bash
+set TWILIO_ACCOUNT_SID=YOUR_TWILIO_ACCOUNT_SID
+set TWILIO_AUTH_TOKEN=YOUR_TWILIO_AUTH_TOKEN
+```
+Permanently set the environment variable (accessible in all subsequent CLI sessions):
+```bash
+setx TWILIO_ACCOUNT_SID "YOUR_TWILIO_ACCOUNT_SID"
+setx TWILIO_AUTH_TOKEN "YOUR_TWILIO_AUTH_TOKEN"
+```
+## 3. Install the Twilio Helper Library
+To install using [Bundler][bundler] grab the latest stable version:
+```ruby
+gem 'twilio-ruby', '~> 5.23.1'
+```
+To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
+```bash
+gem install twilio-ruby -v 5.23.1
+```
+## 4. Setup Work
+```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
+```
+## 5. Send an SMS
+```ruby
+@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/examples/helpers/mail/example.rb CHANGED

@@ -4,10 +4,10 @@ require 'json'
 def hello_world
   from = Email.new(email: 'test@example.com')
-  subject = 'Hello World from the SendGrid Ruby Library'
+  subject = 'Hello World from the Twilio SendGrid Ruby Library'
   to = Email.new(email: 'test@example.com')
   content = Content.new(type: 'text/plain', value: 'some text here')
-  mail = Mail.new(from, subject, to, content)
+  mail = SendGrid::Mail.new(from, subject, to, content)
   # puts JSON.pretty_generate(mail.to_json)
   puts mail.to_json
@@ -19,9 +19,9 @@ def hello_world
 end
 def kitchen_sink
-  mail = Mail.new
+  mail = SendGrid::Mail.new
   mail.from = Email.new(email: 'test@example.com')
-  mail.subject = 'Hello World from the SendGrid Ruby Library'
+  mail.subject = 'Hello World from the Twilio SendGrid Ruby Library'
   personalization = Personalization.new
   personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))
   personalization.add_to(Email.new(email: 'test2@example.com', name: 'Example User'))
@@ -29,7 +29,7 @@ def kitchen_sink
   personalization.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
   personalization.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
   personalization.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
-  personalization.subject = 'Hello World from the Personalized SendGrid Ruby Library'
+  personalization.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
   personalization.add_header(Header.new(key: 'X-Test', value: 'True'))
   personalization.add_header(Header.new(key: 'X-Mock', value: 'False'))
   personalization.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
@@ -46,7 +46,7 @@ def kitchen_sink
   personalization2.add_cc(Email.new(email: 'test4@example.com', name: 'Example User'))
   personalization2.add_bcc(Email.new(email: 'test5@example.com', name: 'Example User'))
   personalization2.add_bcc(Email.new(email: 'test6@example.com', name: 'Example User'))
-  personalization2.subject = 'Hello World from the Personalized SendGrid Ruby Library'
+  personalization2.subject = 'Hello World from the Personalized Twilio SendGrid Ruby Library'
   personalization2.add_header(Header.new(key: 'X-Test', value: 'True'))
   personalization2.add_header(Header.new(key: 'X-Mock', value: 'False'))
   personalization2.add_substitution(Substitution.new(key: '%name%', value: 'Example User'))
@@ -129,7 +129,7 @@ def dynamic_template_data_hello_world
   mail = Mail.new
   mail.template_id = '' # a non-legacy template id
   mail.from = Email.new(email: 'test@example.com')
-  subject = 'Dynamic Template Data Hello World from the SendGrid Ruby Library'
+  subject = 'Dynamic Template Data Hello World from the Twilio SendGrid Ruby Library'
   mail.subject = subject
   personalization = Personalization.new
   personalization.add_to(Email.new(email: 'test1@example.com', name: 'Example User'))

data/examples/ips/ips.rb CHANGED

@@ -23,6 +23,19 @@ puts response.status_code
 puts response.body
 puts response.headers
+##################################################
+# Retrieve unassigned IPs #
+# GET /ips #
+params = {}
+response = sg.client.ips.get(query_params: params)
+all_ips = JSON.parse(response.body)
+unassigned_ips = all_ips.select {|ip| ip.subusers.empty?}
+puts response.status_code
+puts response.body
+puts unassigned_ips
+puts response.headers
 ##################################################
 # Create an IP pool. #
 # POST /ips/pools #

data/examples/mail/mail.rb CHANGED

@@ -79,8 +79,8 @@ data = JSON.parse('{
     },
     "footer": {
       "enable": true,
-      "html": "<p>Thanks</br>The SendGrid Team</p>",
-      "text": "Thanks,/n The SendGrid Team"
+      "html": "<p>Thanks</br>The Twilio SendGrid Team</p>",
+      "text": "Thanks,/n The Twilio SendGrid Team"
     },
     "sandbox_mode": {
       "enable": false

data/examples/scopes/scopes.rb CHANGED

@@ -1,9 +1,7 @@
-require 'sendgrid-ruby'
+require_relative '../../lib/sendgrid-ruby.rb'
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 ##################################################
 # Retrieve a list of scopes for which this user has access. #
 # GET /scopes #
@@ -13,3 +11,51 @@ puts response.status_code
 puts response.body
 puts response.headers
+##################################################
+# Update the name & scopes of an API Key #
+# PUT /api_keys/{api_key_id} #
+scopes = [
+  "user.profile.read",
+  "user.profile.update"
+]
+data = {
+  "name": "A New Hope",
+  "scopes": scopes
+}
+api_key_id = "test_url_param"
+response = sg.client.api_keys._(api_key_id).put(request_body: data)
+puts response.status_code
+puts response.body
+puts response.headers
+# The above method shows how to update the scopes
+# To get various scopes that each of the endpoint has, use the following
+# To get all admin permissions
+scopes = SendGrid::Scope.admin_permissions
+# To get all read only permissions
+scopes = SendGrid::Scope.read_only_permissions
+# There are two methods for each endpoints, namely
+# {endpoint}_read_only_permissions and {endpoint}_full_access_permissions
+# These are the endpoints :
+# alerts, api_keys, asm_groups, billing, categories, credentials, stats, ips, mail_settings, mail,
+# marketing_campaigns, partner_settings, scheduled_sends, subusers, suppression, teammates,
+# templates, tracking_settings, user_settings, webhooks, whitelabel, access_settings
+# read only permissions for alerts
+scopes = SendGrid::Scope.alerts_read_only_permissions
+# full access permissions for alerts
+scopes = SendGrid::Scope.alerts_full_access_permissions
+# read only permissions for billing
+scopes = SendGrid::Scope.billing_read_only_permissions
+# full access permissions for billing
+scopes = SendGrid::Scope.billing_full_access_permissions