RubyGems - sendgrid-ruby - Versions diffs - 1.1.6 → 6.6.2 - Mend

sendgrid-ruby 1.1.6 → 6.6.2

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

checksums.yaml +5 -5
data/.env_sample +1 -3
data/.github/ISSUE_TEMPLATE/config.yml +10 -0
data/.github/workflows/test-and-deploy.yml +120 -0
data/.gitignore +3 -0
data/.rubocop.yml +5 -27
data/.rubocop_todo.yml +127 -0
data/CHANGELOG.md +417 -1
data/CODE_OF_CONDUCT.md +73 -0
data/CONTRIBUTING.md +202 -0
data/Dockerfile +14 -0
data/FIRST_TIMERS.md +79 -0
data/Gemfile +4 -4
data/ISSUE_TEMPLATE.md +30 -0
data/LICENSE +21 -0
data/Makefile +14 -0
data/PULL_REQUEST_TEMPLATE.md +31 -0
data/README.md +153 -229
data/Rakefile +9 -3
data/TROUBLESHOOTING.md +151 -0
data/UPGRADE.md +5 -0
data/USAGE.md +5144 -0
data/config.ru +4 -0
data/examples/accesssettings/accesssettings.rb +80 -0
data/examples/alerts/alerts.rb +59 -0
data/examples/apikeys/apikeys.rb +81 -0
data/examples/asm/asm.rb +170 -0
data/examples/browsers/browsers.rb +13 -0
data/examples/campaigns/campaigns.rb +150 -0
data/examples/categories/categories.rb +33 -0
data/examples/clients/clients.rb +24 -0
data/examples/contactdb/contactdb.rb +392 -0
data/examples/devices/devices.rb +13 -0
data/examples/emailactivity/emailactivity.rb +52 -0
data/examples/geo/geo.rb +13 -0
data/examples/helpers/eventwebhook/example.rb +16 -0
data/examples/helpers/mail/example.rb +158 -0
data/examples/helpers/settings/example.rb +23 -0
data/examples/helpers/stats/example.rb +42 -0
data/examples/ips/ips.rb +164 -0
data/examples/mail/mail.rb +170 -0
data/examples/mailboxproviders/mailboxproviders.rb +13 -0
data/examples/mailsettings/mailsettings.rb +216 -0
data/examples/partnersettings/partnersettings.rb +36 -0
data/examples/scopes/scopes.rb +59 -0
data/examples/senderauthentication/senderauthentication.rb +307 -0
data/examples/senders/senders.rb +95 -0
data/examples/stats/stats.rb +13 -0
data/examples/subusers/subusers.rb +166 -0
data/examples/suppression/suppression.rb +198 -0
data/examples/templates/templates.rb +127 -0
data/examples/trackingsettings/trackingsettings.rb +107 -0
data/examples/user/user.rb +290 -0
data/gemfiles/Sinatra_1.gemfile +6 -0
data/gemfiles/Sinatra_2.gemfile +6 -0
data/lib/rack/sendgrid_webhook_verification.rb +55 -0
data/lib/sendgrid/base_interface.rb +40 -0
data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +50 -0
data/lib/sendgrid/helpers/inbound/README.md +98 -0
data/lib/sendgrid/helpers/inbound/app.rb +32 -0
data/lib/sendgrid/helpers/inbound/config.yml +26 -0
data/lib/sendgrid/helpers/inbound/public/index.html +10 -0
data/lib/sendgrid/helpers/inbound/sample_data/default_data.txt +58 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data.txt +57 -0
data/lib/sendgrid/helpers/inbound/sample_data/raw_data_with_attachments.txt +298 -0
data/lib/sendgrid/helpers/inbound/send.rb +26 -0
data/lib/sendgrid/helpers/ip_management/ip_management.rb +17 -0
data/lib/sendgrid/helpers/mail/README.md +14 -0
data/lib/sendgrid/helpers/mail/asm.rb +19 -0
data/lib/sendgrid/helpers/mail/attachment.rb +55 -0
data/lib/sendgrid/helpers/mail/bcc_settings.rb +19 -0
data/lib/sendgrid/helpers/mail/bypass_list_management.rb +31 -0
data/lib/sendgrid/helpers/mail/category.rb +18 -0
data/lib/sendgrid/helpers/mail/click_tracking.rb +19 -0
data/lib/sendgrid/helpers/mail/content.rb +19 -0
data/lib/sendgrid/helpers/mail/custom_arg.rb +18 -0
data/lib/sendgrid/helpers/mail/email.rb +32 -0
data/lib/sendgrid/helpers/mail/footer.rb +21 -0
data/lib/sendgrid/helpers/mail/ganalytics.rb +28 -0
data/lib/sendgrid/helpers/mail/header.rb +18 -0
data/lib/sendgrid/helpers/mail/mail.rb +122 -0
data/lib/sendgrid/helpers/mail/mail_settings.rb +45 -0
data/lib/sendgrid/helpers/mail/open_tracking.rb +19 -0
data/lib/sendgrid/helpers/mail/personalization.rb +93 -0
data/lib/sendgrid/helpers/mail/section.rb +18 -0
data/lib/sendgrid/helpers/mail/spam_check.rb +21 -0
data/lib/sendgrid/helpers/mail/subscription_tracking.rb +23 -0
data/lib/sendgrid/helpers/mail/substitution.rb +18 -0
data/lib/sendgrid/helpers/mail/tracking_settings.rb +39 -0
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 +14 -0
data/lib/sendgrid/helpers/settings/mail_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/partner_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/settings/settings.rb +28 -0
data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb +22 -0
data/lib/sendgrid/helpers/settings/user_settings_dto.rb +13 -0
data/lib/sendgrid/helpers/stats/email_stats.rb +46 -0
data/lib/sendgrid/helpers/stats/metrics.rb +33 -0
data/lib/sendgrid/helpers/stats/stats_response.rb +29 -0
data/lib/sendgrid/sendgrid.rb +21 -0
data/lib/sendgrid/twilio_email.rb +21 -0
data/lib/sendgrid/version.rb +1 -1
data/lib/sendgrid-ruby.rb +32 -7
data/mail_helper_v3.md +390 -0
data/sendgrid-ruby.gemspec +16 -20
data/spec/fixtures/event_webhook.rb +22 -0
data/spec/rack/sendgrid_webhook_verification_spec.rb +142 -0
data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +105 -0
data/spec/sendgrid/helpers/ip_management/ip_management_spec.rb +12 -0
data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb +32 -0
data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/settings/settings_spec.rb +25 -0
data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb +27 -0
data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb +24 -0
data/spec/sendgrid/helpers/stats/email_stats_spec.rb +111 -0
data/spec/sendgrid/helpers/stats/metrics_spec.rb +45 -0
data/spec/sendgrid/helpers/stats/stats_response_spec.rb +75 -0
data/spec/sendgrid/sendgrid_spec.rb +11 -0
data/spec/sendgrid/twilio_email_spec.rb +11 -0
data/spec/spec_helper.rb +12 -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 +33 -0
data/test/sendgrid/helpers/mail/test_category.rb +25 -0
data/test/sendgrid/helpers/mail/test_email.rb +41 -0
data/test/sendgrid/helpers/mail/test_mail.rb +260 -0
data/test/sendgrid/helpers/mail/test_personalizations.rb +214 -0
data/test/sendgrid/permissions/test_scopes.rb +36 -0
data/test/sendgrid/test_sendgrid-ruby.rb +2729 -0
data/twilio_sendgrid_logo.png +0 -0
data/use-cases/README.md +17 -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/personalizations.md +34 -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 +187 -112
data/.rspec +0 -2
data/.travis.yml +0 -20
data/FETCH_HEAD +0 -0
data/Guardfile +0 -10
data/LICENSE.txt +0 -22
data/example.rb +0 -41
data/lib/sendgrid/client.rb +0 -62
data/lib/sendgrid/exceptions.rb +0 -7
data/lib/sendgrid/mail.rb +0 -182
data/lib/sendgrid/recipient.rb +0 -29
data/lib/sendgrid/response.rb +0 -14
data/lib/sendgrid/template.rb +0 -26
data/lib/sendgrid/template_mailer.rb +0 -59
data/spec/lib/sendgrid/client_spec.rb +0 -87
data/spec/lib/sendgrid/mail_spec.rb +0 -151
data/spec/lib/sendgrid/recipient_spec.rb +0 -91
data/spec/lib/sendgrid/template_mailer_spec.rb +0 -86
data/spec/lib/sendgrid/template_spec.rb +0 -61
data/spec/lib/sendgrid_spec.rb +0 -7

data/twilio_sendgrid_logo.png ADDED Viewed

Binary file

data/use-cases/README.md ADDED Viewed

@@ -0,0 +1,17 @@
+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)
+* [Personalizations](personalizations.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 ADDED Viewed

@@ -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](../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 ADDED Viewed

@@ -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](../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 ADDED Viewed

@@ -0,0 +1,98 @@
+# Legacy Templates
+For this example, we assume you have created a [legacy 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
+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/personalizations.md ADDED Viewed

@@ -0,0 +1,34 @@
+# Personalizations
+This example demonstrates how to send multiple emails with personalizations. For further documentation, refer to [the SendGrid docs](https://docs.sendgrid.com/for-developers/sending-email/personalizations).
+```ruby
+require 'sendgrid-ruby'
+include SendGrid
+# Note that the domain for all From addresses must match
+mail = Mail.new
+mail.from = Email.new(email: 'test@example.com')
+mail.add_content(Content.new(type: 'text/plain', value: 'Some test text'))
+mail.subject = 'Personalized Test Email'
+personalization = Personalization.new
+personalization.add_to(Email.new(email: 'test1@example.com'))
+mail.add_personalization(personalization)
+personalization2 = Personalization.new
+personalization2.add_to(Email.new(email: 'test2@example.com'))
+personalization2.add_from(Email.new(email: 'test3@example.com'))
+mail.add_personalization(personalization2)
+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.headers
+```

data/use-cases/sms.md ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,111 @@
+# Transactional Templates
+For this example, we assume you have created a [dynamic transactional template](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transactional-templates/) 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 ADDED Viewed

@@ -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 ADDED Viewed

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