sendgrid-ruby 6.1.4 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee5a58da05e1ac621914725e55f8d8edd5fbe41998e63d96ae34a27b61e46c3
-  data.tar.gz: bcafe9bf1024882418c847d5fcc2118c587b4b1275e63033592eb6fc84ab6676
+  metadata.gz: eebc101d8e4c0fd0b310052df65639517dce3d1274d8469f7ca12c7854307b06
+  data.tar.gz: 89565ce858129ddbf1921a474b34661f18852241339225038181e43c58f74af2
 SHA512:
-  metadata.gz: 5349c910cd270a5579f1aef22b860c9267210467115e17b15a873b2d2f9b2f826afa51272b8741035c9426da2bea72a81a0b1f127a3c1a1144afa775689f28c5
-  data.tar.gz: 1cd1328b16c887ac2f1c9b7f5676c07c2bc07b37b8d09419a97b341c1361735608638b27b5eae1acaf99eef1b15eec338014523824ac77abe00fb5cbdb792d9d
+  metadata.gz: 180658efc2dd204c30090d9ca812430e36f75280519e054991227a5b6d5dd6f49860e84284ed7e51ebb9039d1460ad59a3cf269736c69cfd12d1f49b4e732501
+  data.tar.gz: 060a8cee0e604d646be5dfdeee262eb2fb244c8c17d1ed0d6c112d004506201f2092c125e4cfda2c96a04a92b6bdc6b7a91b44f6149bba4ca4753a08cca0c10d

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2020-04-29] Version 6.2.0
+--------------------------
+**Library - Feature**
+- [PR #417](https://github.com/sendgrid/sendgrid-ruby/pull/417): add support for Twilio Email. Thanks to [@childish-sambino](https://github.com/childish-sambino)!
+
+
 [2020-04-15] Version 6.1.4
 --------------------------
 **Library - Fix**

data/USE_CASES.md

@@ -11,14 +11,8 @@ This documentation provides examples for specific use cases. Please [open an iss
   * [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)
+* [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
@@ -299,59 +293,98 @@ end
 
 ```
 
-<a name="sms"></a>
-# Send a SMS Message
+# Send an Email With Twilio Email (Pilot)
 
-Following are the steps to add Twilio SMS to your app:
-
-## 1. Obtain a Free Twilio Account
+### 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
+### 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).
 
-You can obtain your Account Sid and Auth Token from [twilio.com/console](https://twilio.com/console).
+Once you have those, follow the steps below based on your operating system.
 
-### Mac
+#### 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
+#### 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
 ```
 
-Permanently set the environment variable (accessible in all subsequent CLI sessions):
+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. Install the Twilio Helper Library
-
-To install using [Bundler][bundler] grab the latest stable version:
+### 3. Initialize the Twilio Email Client
 
 ```ruby
-gem 'twilio-ruby', '~> 5.23.1'
+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'])
 ```
 
-To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
+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
-gem install twilio-ruby -v 5.23.1
+bundle
 ```
 
-## 4. Setup Work
+Or install it yourself using:
+
+```bash
+gem install twilio-ruby
+```
+
+Finally, send a message.
 
 ```ruby
 require 'twilio-ruby'
@@ -362,11 +395,6 @@ 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',

data/lib/sendgrid-ruby.rb

@@ -1,4 +1,6 @@
-require_relative 'sendgrid/client'
+require_relative 'sendgrid/base_interface'
+require_relative 'sendgrid/sendgrid'
+require_relative 'sendgrid/twilio_email'
 require_relative 'sendgrid/version'
 require_relative 'sendgrid/helpers/ip_management/ip_management'
 require_relative 'sendgrid/helpers/mail/asm'

data/lib/sendgrid/base_interface.rb

@@ -0,0 +1,36 @@
+require 'ruby_http_client'
+require_relative 'version'
+
+# Initialize the HTTP client
+class BaseInterface
+  attr_accessor :client
+  attr_reader :request_headers, :host, :version, :impersonate_subuser
+  # * *Args* :
+  #   - +auth+ -> authorization header value
+  #   - +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
+  #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+  #                              in the "On-Behalf-Of" header
+  #
+  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil)
+    @auth = auth
+    @host = host
+    @version = version ? version : 'v3'
+    @impersonate_subuser = impersonate_subuser
+    @user_agent = "sendgrid/#{SendGrid::VERSION};ruby"
+    @request_headers = JSON.parse('
+        {
+          "Authorization": "' + @auth + '",
+          "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 = SendGrid::Client.new(host: "#{@host}/#{@version}",
+                                   request_headers: @request_headers)
+  end
+end

data/lib/sendgrid/sendgrid.rb

@@ -0,0 +1,20 @@
+# Quickly and easily access the Twilio SendGrid API.
+module SendGrid
+  class API < BaseInterface
+    # * *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
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #
+    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
+      auth = "Bearer #{api_key}"
+      host = 'https://api.sendgrid.com' unless host
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+    end
+  end
+end

data/lib/sendgrid/twilio_email.rb

@@ -0,0 +1,21 @@
+# Quickly and easily access the Twilio Email API.
+module TwilioEmail
+  class API < BaseInterface
+    # * *Args* :
+    #   - +username+ -> your Twilio Email API key SID or Account SID
+    #   - +password+ -> your Twilio Email API key secret or Account Auth Token
+    #   - +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
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #
+    def initialize(username:, password:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
+      auth = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
+      host = 'https://email.twilio.com' unless host
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+    end
+  end
+end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.1.4'
+  VERSION = '6.2.0'
 end

data/spec/sendgrid/sendgrid_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SendGrid::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = SendGrid::API.new(api_key: 'fake_key')
+      expect(mail_client.request_headers['Authorization']).to eq('Bearer fake_key')
+      expect(mail_client.host).to eq('https://api.sendgrid.com')
+    end
+  end
+end

data/spec/sendgrid/twilio_email_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe TwilioEmail::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = TwilioEmail::API.new(username: 'username', password: 'password')
+      expect(mail_client.request_headers['Authorization']).to eq('Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
+      expect(mail_client.host).to eq('https://email.twilio.com')
+    end
+  end
+end

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -58,7 +58,7 @@ class TestAPI < MiniTest::Test
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
         assert_equal(subuser, sg.impersonate_subuser)
-        assert_equal("6.1.4", SendGrid::VERSION)
+        assert_equal("6.2.0", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.1.4
+  version: 6.2.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -189,7 +189,7 @@ files:
 - gemfiles/Sinatra_1.gemfile
 - gemfiles/Sinatra_2.gemfile
 - lib/sendgrid-ruby.rb
-- lib/sendgrid/client.rb
+- lib/sendgrid/base_interface.rb
 - lib/sendgrid/helpers/inbound/README.md
 - lib/sendgrid/helpers/inbound/app.rb
 - lib/sendgrid/helpers/inbound/config.yml
@@ -232,6 +232,8 @@ files:
 - lib/sendgrid/helpers/stats/email_stats.rb
 - lib/sendgrid/helpers/stats/metrics.rb
 - lib/sendgrid/helpers/stats/stats_response.rb
+- lib/sendgrid/sendgrid.rb
+- lib/sendgrid/twilio_email.rb
 - lib/sendgrid/version.rb
 - mail_helper_v3.md
 - sendgrid-ruby.gemspec
@@ -244,6 +246,8 @@ files:
 - spec/sendgrid/helpers/stats/email_stats_spec.rb
 - spec/sendgrid/helpers/stats/metrics_spec.rb
 - spec/sendgrid/helpers/stats/stats_response_spec.rb
+- spec/sendgrid/sendgrid_spec.rb
+- spec/sendgrid/twilio_email_spec.rb
 - spec/spec_helper.rb
 - test/prism.sh
 - test/sendgrid/helpers/mail/test_attachment.rb
@@ -286,6 +290,8 @@ test_files:
 - spec/sendgrid/helpers/stats/email_stats_spec.rb
 - spec/sendgrid/helpers/stats/metrics_spec.rb
 - spec/sendgrid/helpers/stats/stats_response_spec.rb
+- spec/sendgrid/sendgrid_spec.rb
+- spec/sendgrid/twilio_email_spec.rb
 - spec/spec_helper.rb
 - test/prism.sh
 - test/sendgrid/helpers/mail/test_attachment.rb

data/lib/sendgrid/client.rb

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