RubyGems - sendgrid-ruby - Versions diffs - 6.1.4 → 6.3.3 - Mend

sendgrid-ruby 6.1.4 → 6.3.3

Files changed (42) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +1 -1
data/.gitignore +2 -0
data/.rubocop.yml +6 -0
data/.travis.yml +11 -20
data/CHANGELOG.md +45 -0
data/CONTRIBUTING.md +4 -11
data/Dockerfile +14 -0
data/Gemfile +0 -1
data/Makefile +9 -2
data/README.md +0 -1
data/examples/helpers/eventwebhook/example.rb +16 -0
data/lib/rack/sendgrid_webhook_verification.rb +52 -0
data/lib/sendgrid-ruby.rb +5 -1
data/lib/sendgrid/base_interface.rb +36 -0
data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb +52 -0
data/lib/sendgrid/sendgrid.rb +20 -0
data/lib/sendgrid/twilio_email.rb +21 -0
data/lib/sendgrid/version.rb +1 -1
data/sendgrid-ruby.gemspec +2 -0
data/spec/fixtures/event_webhook.rb +16 -0
data/spec/rack/sendgrid_webhook_verification_spec.rb +116 -0
data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb +103 -0
data/spec/sendgrid/sendgrid_spec.rb +11 -0
data/spec/sendgrid/twilio_email_spec.rb +11 -0
data/spec/spec_helper.rb +2 -0
data/test/sendgrid/helpers/mail/test_mail.rb +1 -1
data/test/sendgrid/test_sendgrid-ruby.rb +24 -59
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 +57 -9
data/USE_CASES.md +0 -377
data/docker/Dockerfile +0 -12
data/docker/README.md +0 -30
data/lib/sendgrid/client.rb +0 -38
data/test/prism.sh +0 -42

data/USE_CASES.md DELETED

@@ -1,377 +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 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>
-# 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
-```
-<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/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
-```

data/lib/sendgrid/client.rb DELETED

@@ -1,38 +0,0 @@
-# Quickly and easily access the Twilio SendGrid API.
-require 'ruby_http_client'
-require_relative 'version'
-module SendGrid
-  # Initialize the HTTP client
-  class API
-    attr_accessor :client
-    attr_reader :request_headers, :host, :version, :impersonate_subuser
-    # * *Args*    :
-    #   - +api_key+ -> your Twilio SendGrid API key
-    #   - +host+ -> the base URL for the API
-    #   - +request_headers+ -> any headers that you want to be globally applied
-    #   - +version+ -> the version of the API you wish to access,
-    #                  currently only "v3" is supported
-    #
-    def initialize(api_key: '', host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
-      @api_key             = api_key
-      @host                = host ? host : 'https://api.sendgrid.com'
-      @version             = version ? version : 'v3'
-      @impersonate_subuser = impersonate_subuser
-      @user_agent          = "sendgrid/#{SendGrid::VERSION};ruby"
-      @request_headers     = JSON.parse('
-        {
-          "Authorization": "Bearer ' + @api_key + '",
-          "Accept": "application/json",
-          "User-Agent": "' + @user_agent + '"
-        }
-      ')
-      @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser
-      @request_headers = @request_headers.merge(request_headers) if request_headers
-      @client = Client.new(host: "#{@host}/#{@version}",
-                           request_headers: @request_headers)
-    end
-  end
-end