sendgrid-ruby 5.3.0 → 6.0.0

data/examples/{whitelabel/whitelabel.rb → senderauthentication/senderauthentication.rb}

@@ -5,7 +5,7 @@ sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
 
 ##################################################
-# Create a domain whitelabel. #
+# Create a domain authentication. #
 # POST /whitelabel/domains #
 
 data = JSON.parse('{
@@ -26,7 +26,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# List all domain whitelabels. #
+# List all domain authentications. #
 # GET /whitelabel/domains #
 
 params = JSON.parse('{"username": "test_string", "domain": "test_string", "exclude_subusers": "true", "limit": 1, "offset": 1}')
@@ -36,7 +36,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Get the default domain whitelabel. #
+# Get the default domain authentication. #
 # GET /whitelabel/domains/default #
 
 response = sg.client.whitelabel.domains.default.get()
@@ -45,7 +45,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# List the domain whitelabel associated with the given user. #
+# List the domain authentication associated with the given user. #
 # GET /whitelabel/domains/subuser #
 
 response = sg.client.whitelabel.domains.subuser.get()
@@ -54,7 +54,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Disassociate a domain whitelabel from a given user. #
+# Disassociate a domain authentication from a given user. #
 # DELETE /whitelabel/domains/subuser #
 
 response = sg.client.whitelabel.domains.subuser.delete()
@@ -63,7 +63,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Update a domain whitelabel. #
+# Update a domain authentication. #
 # PATCH /whitelabel/domains/{domain_id} #
 
 data = JSON.parse('{
@@ -77,7 +77,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a domain whitelabel. #
+# Retrieve a domain authentication. #
 # GET /whitelabel/domains/{domain_id} #
 
 domain_id = "test_url_param"
@@ -87,7 +87,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete a domain whitelabel. #
+# Delete a domain authentication. #
 # DELETE /whitelabel/domains/{domain_id} #
 
 domain_id = "test_url_param"
@@ -97,7 +97,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Associate a domain whitelabel with a given user. #
+# Associate a domain authentication with a given user. #
 # POST /whitelabel/domains/{domain_id}/subuser #
 
 data = JSON.parse('{
@@ -110,7 +110,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Add an IP to a domain whitelabel. #
+# Add an IP to a domain authentication. #
 # POST /whitelabel/domains/{id}/ips #
 
 data = JSON.parse('{
@@ -123,7 +123,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Remove an IP from a domain whitelabel. #
+# Remove an IP from a domain authentication. #
 # DELETE /whitelabel/domains/{id}/ips/{ip} #
 
 id = "test_url_param"
@@ -134,7 +134,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate a domain whitelabel. #
+# Validate a domain authentication. #
 # POST /whitelabel/domains/{id}/validate #
 
 id = "test_url_param"
@@ -144,7 +144,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Create an IP whitelabel #
+# Create a reverse DNS record #
 # POST /whitelabel/ips #
 
 data = JSON.parse('{
@@ -158,7 +158,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve all IP whitelabels #
+# Retrieve a reverse DNS record #
 # GET /whitelabel/ips #
 
 params = JSON.parse('{"ip": "test_string", "limit": 1, "offset": 1}')
@@ -168,7 +168,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve an IP whitelabel #
+# Retrieve a reverse DNS record #
 # GET /whitelabel/ips/{id} #
 
 id = "test_url_param"
@@ -178,7 +178,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete an IP whitelabel #
+# Delete a reverse DNS record #
 # DELETE /whitelabel/ips/{id} #
 
 id = "test_url_param"
@@ -188,7 +188,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate an IP whitelabel #
+# Validate a reverse DNS record #
 # POST /whitelabel/ips/{id}/validate #
 
 id = "test_url_param"
@@ -198,7 +198,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Create a Link Whitelabel #
+# Create a Branded Link #
 # POST /whitelabel/links #
 
 data = JSON.parse('{
@@ -213,7 +213,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve all link whitelabels #
+# Retrieve all link brandings #
 # GET /whitelabel/links #
 
 params = JSON.parse('{"limit": 1}')
@@ -223,7 +223,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a Default Link Whitelabel #
+# Retrieve a Default Link Branding #
 # GET /whitelabel/links/default #
 
 params = JSON.parse('{"domain": "test_string"}')
@@ -233,7 +233,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve Associated Link Whitelabel #
+# Retrieve Associated Link Branding #
 # GET /whitelabel/links/subuser #
 
 params = JSON.parse('{"username": "test_string"}')
@@ -243,7 +243,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Disassociate a Link Whitelabel #
+# Disassociate a Link Branding #
 # DELETE /whitelabel/links/subuser #
 
 params = JSON.parse('{"username": "test_string"}')
@@ -253,7 +253,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Update a Link Whitelabel #
+# Update a Link Branding #
 # PATCH /whitelabel/links/{id} #
 
 data = JSON.parse('{
@@ -266,7 +266,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve a Link Whitelabel #
+# Retrieve a Link Branding #
 # GET /whitelabel/links/{id} #
 
 id = "test_url_param"
@@ -276,7 +276,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Delete a Link Whitelabel #
+# Delete a Link Branding #
 # DELETE /whitelabel/links/{id} #
 
 id = "test_url_param"
@@ -286,7 +286,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Validate a Link Whitelabel #
+# Validate a Link Branding #
 # POST /whitelabel/links/{id}/validate #
 
 id = "test_url_param"
@@ -296,7 +296,7 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Associate a Link Whitelabel #
+# Associate a Link Branding #
 # POST /whitelabel/links/{link_id}/subuser #
 
 data = JSON.parse('{

data/examples/suppression/suppression.rb

@@ -19,9 +19,9 @@ puts response.headers
 # DELETE /suppression/blocks #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')
@@ -65,9 +65,9 @@ puts response.headers
 # DELETE /suppression/bounces #
 
 data = JSON.parse('{
-  "delete_all": true, 
+  "delete_all": true,
   "emails": [
-    "example@example.com", 
+    "example@example.com",
     "example2@example.com"
   ]
 }')
@@ -112,9 +112,9 @@ puts response.headers
 # DELETE /suppression/invalid_emails #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')
@@ -148,7 +148,7 @@ puts response.headers
 # GET /suppression/spam_report/{email} #
 
 email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).get()
+response = sg.client.suppression.spam_reports._(email).get()
 puts response.status_code
 puts response.body
 puts response.headers
@@ -158,7 +158,7 @@ puts response.headers
 # DELETE /suppression/spam_report/{email} #
 
 email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).delete()
+response = sg.client.suppression.spam_reports._(email).delete()
 puts response.status_code
 puts response.body
 puts response.headers
@@ -178,9 +178,9 @@ puts response.headers
 # DELETE /suppression/spam_reports #
 
 data = JSON.parse('{
-  "delete_all": false, 
+  "delete_all": false,
   "emails": [
-    "example1@example.com", 
+    "example1@example.com",
     "example2@example.com"
   ]
 }')

data/lib/sendgrid-ruby.rb

@@ -1,5 +1,6 @@
 require_relative 'sendgrid/client'
 require_relative 'sendgrid/version'
+require_relative 'sendgrid/helpers/ip_management/ip_management'
 require_relative 'sendgrid/helpers/mail/asm'
 require_relative 'sendgrid/helpers/mail/attachment'
 require_relative 'sendgrid/helpers/mail/bcc_settings'
@@ -25,3 +26,4 @@ require_relative 'sendgrid/helpers/settings/settings'
 require_relative 'sendgrid/helpers/stats/email_stats'
 require_relative 'sendgrid/helpers/stats/stats_response'
 require_relative 'sendgrid/helpers/stats/metrics'
+require_relative 'sendgrid/helpers/permissions/scope'

data/lib/sendgrid/client.rb

@@ -1,4 +1,4 @@
-# Quickly and easily access the SendGrid API.
+# Quickly and easily access the Twilio SendGrid API.
 require 'ruby_http_client'
 require_relative 'version'
 
@@ -6,26 +6,29 @@ module SendGrid
   # Initialize the HTTP client
   class API
     attr_accessor :client
-    attr_reader :request_headers, :host, :version
+    attr_reader :request_headers, :host, :version, :impersonate_subuser
     # * *Args*    :
-    #   - +api_key+ -> your SendGrid API key
+    #   - +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)
-      @api_key          = api_key
-      @host             = host ? host : 'https://api.sendgrid.com'
-      @version          = version ? version : 'v3'
-      @user_agent       = "sendgrid/#{SendGrid::VERSION};ruby"
-      @request_headers  = JSON.parse('
+    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}",

data/lib/sendgrid/helpers/inbound/README.md

@@ -2,12 +2,29 @@
 
 ## Table of Contents
 
-* [Quick Start for Local Testing with Sample Data](#quick_start_local_sample)
-* [Quick Start for Local Testing with Real Data](#quick_start_local_real)
-* [Code Walkthrough](#code_walkthrough)
-* [Contributing](#contributing)
+- [Installation](#installation)
+- [Quick Start for Local Testing with Sample Data](#quick-start-for-local-testing-with-sample-data)
+- [Quick Start for Local Testing with Real Data](#quick-start-for-local-testing-with-real-data)
+- [Code Walkthrough](#code-walkthrough)
+  - [app.rb](#apprb)
+  - [config.yml](#configyml)
+  - [send.rb & /sample_data](#sendrb--sampledata)
+- [Contributing](#contributing)
 
 <a name="quick_start_local_sample"></a>
+
+
+# Installation
+
+In addition to the installation instructions in
+[the main readme](https://github.com/sendgrid/sendgrid-ruby/tree/master/#installation),
+you must also add sinatra to your Gemfile:
+
+```
+gem 'sinatra', '>= 1.4.7', '< 3'
+```
+
+
 # Quick Start for Local Testing with Sample Data
 
 ```bash
@@ -53,7 +70,7 @@ In another terminal, use [ngrok](https://ngrok.com/) to allow external access to
 ngrok http 9292
 ```
 
-Update your SendGrid Incoming Parse settings: [Settings Page](https://app.sendgrid.com/settings/parse) | [Docs](https://sendgrid.com/docs/Classroom/Basics/Inbound_Parse_Webhook/setting_up_the_inbound_parse_webhook.html#-Pointing-to-a-Hostname-and-URL)
+Update your Twilio SendGrid Incoming Parse settings: [Settings Page](https://app.sendgrid.com/settings/parse) | [Docs](https://sendgrid.com/docs/Classroom/Basics/Inbound_Parse_Webhook/setting_up_the_inbound_parse_webhook.html#-Pointing-to-a-Hostname-and-URL)
 
 - For the HOSTNAME field, use the domain that you changed the MX records (e.g. inbound.yourdomain.com)
 - For the URL field, use the URL generated by ngrok + /inbound, e.g http://XXXXXXX.ngrok.io/inbound

data/lib/sendgrid/helpers/inbound/app.rb

@@ -1,4 +1,16 @@
-require 'sinatra'
+begin
+  require 'sinatra'
+rescue LoadError
+  puts <<-NOTE
+    As of sengrid verison 6, sinatra is no longer specified as a dependency of
+    the sendgrid gem. All the functionality of the inbound server is still the same
+    and fully supported, but you just need to include the sinatra dependency in your gemfile
+    yourself, like so:
+
+        gem 'sinatra', '>= 1.4.7', '< 3'
+  NOTE
+  raise
+end
 require 'logger'
 require 'json'
 require 'yaml'

data/lib/sendgrid/helpers/inbound/public/index.html

@@ -1,6 +1,6 @@
 <html>
   <head>
-    <title>SendGrid Incoming Parse</title>
+    <title>Twilio SendGrid Incoming Parse</title>
   </head>
   <body>
     <h1>You have successfuly launched the server!</h1>

data/lib/sendgrid/helpers/inbound/sample_data/default_data.txt

@@ -20,7 +20,7 @@ inbound@inbound.example.com
 --xYzZY
 Content-Disposition: form-data; name="html"
 
-<html><body><strong>Hello SendGrid!</body></html>
+<html><body><strong>Hello Twilio SendGrid!</body></html>
 
 --xYzZY
 Content-Disposition: form-data; name="from"
@@ -29,7 +29,7 @@ Example User <test@example.com>
 --xYzZY
 Content-Disposition: form-data; name="text"
 
-Hello SendGrid!
+Hello Twilio SendGrid!
 
 --xYzZY
 Content-Disposition: form-data; name="sender_ip"

data/lib/sendgrid/helpers/inbound/sample_data/raw_data.txt

@@ -16,13 +16,13 @@ Content-Type: multipart/alternative; boundary=001a113ee97c89842f0539be8e7a
 --001a113ee97c89842f0539be8e7a
 Content-Type: text/plain; charset=UTF-8
 
-Hello SendGrid!
+Hello Twilio SendGrid!
 
 --001a113ee97c89842f0539be8e7a
 Content-Type: text/html; charset=UTF-8
 Content-Transfer-Encoding: quoted-printable
 
-<html><body><strong>Hello SendGrid!</body></html>
+<html><body><strong>Hello Twilio SendGrid!</body></html>
 
 --001a113ee97c89842f0539be8e7a--