sendgrid-ruby 5.3.0 → 6.7.0

data/examples/suppression/suppression.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve all blocks #
 # GET /suppression/blocks #
@@ -19,9 +17,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"
   ]
 }')
@@ -34,8 +32,8 @@ puts response.headers
 # Retrieve a specific block #
 # GET /suppression/blocks/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.blocks._(email).get()
+email = 'test_url_param'
+response = sg.client.suppression.blocks._(email).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -44,8 +42,8 @@ puts response.headers
 # Delete a specific block #
 # DELETE /suppression/blocks/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.blocks._(email).delete()
+email = 'test_url_param'
+response = sg.client.suppression.blocks._(email).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -65,9 +63,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"
   ]
 }')
@@ -80,8 +78,8 @@ puts response.headers
 # Retrieve a Bounce #
 # GET /suppression/bounces/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.bounces._(email).get()
+email = 'test_url_param'
+response = sg.client.suppression.bounces._(email).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -91,7 +89,7 @@ puts response.headers
 # DELETE /suppression/bounces/{email} #
 
 params = JSON.parse('{"email_address": "example@example.com"}')
-email = "test_url_param"
+email = 'test_url_param'
 response = sg.client.suppression.bounces._(email).delete(query_params: params)
 puts response.status_code
 puts response.body
@@ -112,9 +110,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"
   ]
 }')
@@ -127,8 +125,8 @@ puts response.headers
 # Retrieve a specific invalid email #
 # GET /suppression/invalid_emails/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.invalid_emails._(email).get()
+email = 'test_url_param'
+response = sg.client.suppression.invalid_emails._(email).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -137,8 +135,8 @@ puts response.headers
 # Delete a specific invalid email #
 # DELETE /suppression/invalid_emails/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.invalid_emails._(email).delete()
+email = 'test_url_param'
+response = sg.client.suppression.invalid_emails._(email).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -147,8 +145,8 @@ puts response.headers
 # Retrieve a specific spam report #
 # GET /suppression/spam_report/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).get()
+email = 'test_url_param'
+response = sg.client.suppression.spam_report._(email).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -157,8 +155,8 @@ puts response.headers
 # Delete a specific spam report #
 # DELETE /suppression/spam_report/{email} #
 
-email = "test_url_param"
-response = sg.client.suppression.spam_report._(email).delete()
+email = 'test_url_param'
+response = sg.client.suppression.spam_reports._(email).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -178,9 +176,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"
   ]
 }')
@@ -198,4 +196,3 @@ response = sg.client.suppression.unsubscribes.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/templates/templates.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Create a transactional template. #
 # POST /templates #
@@ -17,10 +15,11 @@ puts response.body
 puts response.headers
 
 ##################################################
-# Retrieve all transactional templates. #
+# Retrieve all transactional templates (legacy & dynamic). #
 # GET /templates #
 
-response = sg.client.templates.get()
+params = JSON.parse('{"generations": "legacy,dynamic"}')
+response = sg.client.templates.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
@@ -32,7 +31,7 @@ puts response.headers
 data = JSON.parse('{
   "name": "new_example_name"
 }')
-template_id = "test_url_param"
+template_id = 'test_url_param'
 response = sg.client.templates._(template_id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -42,8 +41,8 @@ puts response.headers
 # Retrieve a single transactional template. #
 # GET /templates/{template_id} #
 
-template_id = "test_url_param"
-response = sg.client.templates._(template_id).get()
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -52,8 +51,8 @@ puts response.headers
 # Delete a template. #
 # DELETE /templates/{template_id} #
 
-template_id = "test_url_param"
-response = sg.client.templates._(template_id).delete()
+template_id = 'test_url_param'
+response = sg.client.templates._(template_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -63,14 +62,14 @@ puts response.headers
 # POST /templates/{template_id}/versions #
 
 data = JSON.parse('{
-  "active": 1, 
-  "html_content": "<%body%>", 
-  "name": "example_version_name", 
-  "plain_content": "<%body%>", 
-  "subject": "<%subject%>", 
+  "active": 1,
+  "html_content": "<%body%>",
+  "name": "example_version_name",
+  "plain_content": "<%body%>",
+  "subject": "<%subject%>",
   "template_id": "ddb96bbc-9b92-425e-8979-99464621b543"
 }')
-template_id = "test_url_param"
+template_id = 'test_url_param'
 response = sg.client.templates._(template_id).versions.post(request_body: data)
 puts response.status_code
 puts response.body
@@ -81,14 +80,14 @@ puts response.headers
 # PATCH /templates/{template_id}/versions/{version_id} #
 
 data = JSON.parse('{
-  "active": 1, 
-  "html_content": "<%body%>", 
-  "name": "updated_example_name", 
-  "plain_content": "<%body%>", 
+  "active": 1,
+  "html_content": "<%body%>",
+  "name": "updated_example_name",
+  "plain_content": "<%body%>",
   "subject": "<%subject%>"
 }')
-template_id = "test_url_param"
-version_id = "test_url_param"
+template_id = 'test_url_param'
+version_id = 'test_url_param'
 response = sg.client.templates._(template_id).versions._(version_id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -98,9 +97,9 @@ puts response.headers
 # Retrieve a specific transactional template version. #
 # GET /templates/{template_id}/versions/{version_id} #
 
-template_id = "test_url_param"
-version_id = "test_url_param"
-response = sg.client.templates._(template_id).versions._(version_id).get()
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -109,9 +108,9 @@ puts response.headers
 # Delete a transactional template version. #
 # DELETE /templates/{template_id}/versions/{version_id} #
 
-template_id = "test_url_param"
-version_id = "test_url_param"
-response = sg.client.templates._(template_id).versions._(version_id).delete()
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -120,10 +119,9 @@ puts response.headers
 # Activate a transactional template version. #
 # POST /templates/{template_id}/versions/{version_id}/activate #
 
-template_id = "test_url_param"
-version_id = "test_url_param"
-response = sg.client.templates._(template_id).versions._(version_id).activate.post()
+template_id = 'test_url_param'
+version_id = 'test_url_param'
+response = sg.client.templates._(template_id).versions._(version_id).activate.post
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/trackingsettings/trackingsettings.rb

@@ -1,9 +1,7 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Retrieve Tracking Settings #
 # GET /tracking_settings #
@@ -30,7 +28,7 @@ puts response.headers
 # Retrieve Click Track Settings #
 # GET /tracking_settings/click #
 
-response = sg.client.tracking_settings.click.get()
+response = sg.client.tracking_settings.click.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -40,11 +38,11 @@ puts response.headers
 # PATCH /tracking_settings/google_analytics #
 
 data = JSON.parse('{
-  "enabled": true, 
-  "utm_campaign": "website", 
-  "utm_content": "", 
-  "utm_medium": "email", 
-  "utm_source": "sendgrid.com", 
+  "enabled": true,
+  "utm_campaign": "website",
+  "utm_content": "",
+  "utm_medium": "email",
+  "utm_source": "sendgrid.com",
   "utm_term": ""
 }')
 response = sg.client.tracking_settings.google_analytics.patch(request_body: data)
@@ -56,7 +54,7 @@ puts response.headers
 # Retrieve Google Analytics Settings #
 # GET /tracking_settings/google_analytics #
 
-response = sg.client.tracking_settings.google_analytics.get()
+response = sg.client.tracking_settings.google_analytics.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -77,7 +75,7 @@ puts response.headers
 # Get Open Tracking Settings #
 # GET /tracking_settings/open #
 
-response = sg.client.tracking_settings.open.get()
+response = sg.client.tracking_settings.open.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -87,11 +85,11 @@ puts response.headers
 # PATCH /tracking_settings/subscription #
 
 data = JSON.parse('{
-  "enabled": true, 
-  "html_content": "html content", 
-  "landing": "landing page html", 
-  "plain_content": "text content", 
-  "replace": "replacement tag", 
+  "enabled": true,
+  "html_content": "html content",
+  "landing": "landing page html",
+  "plain_content": "text content",
+  "replace": "replacement tag",
   "url": "url"
 }')
 response = sg.client.tracking_settings.subscription.patch(request_body: data)
@@ -103,8 +101,7 @@ puts response.headers
 # Retrieve Subscription Tracking Settings #
 # GET /tracking_settings/subscription #
 
-response = sg.client.tracking_settings.subscription.get()
+response = sg.client.tracking_settings.subscription.get
 puts response.status_code
 puts response.body
 puts response.headers
-

data/examples/user/user.rb

@@ -1,14 +1,12 @@
 require 'sendgrid-ruby'
 
-
 sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
 
-
 ##################################################
 # Get a user's account information. #
 # GET /user/account #
 
-response = sg.client.user.account.get()
+response = sg.client.user.account.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -17,7 +15,7 @@ puts response.headers
 # Retrieve your credit balance #
 # GET /user/credits #
 
-response = sg.client.user.credits.get()
+response = sg.client.user.credits.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -38,7 +36,7 @@ puts response.headers
 # Retrieve your account email address #
 # GET /user/email #
 
-response = sg.client.user.email.get()
+response = sg.client.user.email.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -48,7 +46,7 @@ puts response.headers
 # PUT /user/password #
 
 data = JSON.parse('{
-  "new_password": "new_password", 
+  "new_password": "new_password",
   "old_password": "old_password"
 }')
 response = sg.client.user.password.put(request_body: data)
@@ -61,8 +59,8 @@ puts response.headers
 # PATCH /user/profile #
 
 data = JSON.parse('{
-  "city": "Orange", 
-  "first_name": "Example", 
+  "city": "Orange",
+  "first_name": "Example",
   "last_name": "User"
 }')
 response = sg.client.user.profile.patch(request_body: data)
@@ -74,7 +72,7 @@ puts response.headers
 # Get a user's profile #
 # GET /user/profile #
 
-response = sg.client.user.profile.get()
+response = sg.client.user.profile.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -84,7 +82,7 @@ puts response.headers
 # POST /user/scheduled_sends #
 
 data = JSON.parse('{
-  "batch_id": "YOUR_BATCH_ID", 
+  "batch_id": "YOUR_BATCH_ID",
   "status": "pause"
 }')
 response = sg.client.user.scheduled_sends.post(request_body: data)
@@ -96,7 +94,7 @@ puts response.headers
 # Retrieve all scheduled sends #
 # GET /user/scheduled_sends #
 
-response = sg.client.user.scheduled_sends.get()
+response = sg.client.user.scheduled_sends.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -108,7 +106,7 @@ puts response.headers
 data = JSON.parse('{
   "status": "pause"
 }')
-batch_id = "test_url_param"
+batch_id = 'test_url_param'
 response = sg.client.user.scheduled_sends._(batch_id).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -118,8 +116,8 @@ puts response.headers
 # Retrieve scheduled send #
 # GET /user/scheduled_sends/{batch_id} #
 
-batch_id = "test_url_param"
-response = sg.client.user.scheduled_sends._(batch_id).get()
+batch_id = 'test_url_param'
+response = sg.client.user.scheduled_sends._(batch_id).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -128,8 +126,8 @@ puts response.headers
 # Delete a cancellation or pause of a scheduled send #
 # DELETE /user/scheduled_sends/{batch_id} #
 
-batch_id = "test_url_param"
-response = sg.client.user.scheduled_sends._(batch_id).delete()
+batch_id = 'test_url_param'
+response = sg.client.user.scheduled_sends._(batch_id).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -139,7 +137,7 @@ puts response.headers
 # PATCH /user/settings/enforced_tls #
 
 data = JSON.parse('{
-  "require_tls": true, 
+  "require_tls": true,
   "require_valid_cert": false
 }')
 response = sg.client.user.settings.enforced_tls.patch(request_body: data)
@@ -151,7 +149,7 @@ puts response.headers
 # Retrieve current Enforced TLS settings. #
 # GET /user/settings/enforced_tls #
 
-response = sg.client.user.settings.enforced_tls.get()
+response = sg.client.user.settings.enforced_tls.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -172,7 +170,7 @@ puts response.headers
 # Retrieve your username #
 # GET /user/username #
 
-response = sg.client.user.username.get()
+response = sg.client.user.username.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -182,18 +180,18 @@ puts response.headers
 # PATCH /user/webhooks/event/settings #
 
 data = JSON.parse('{
-  "bounce": true, 
-  "click": true, 
-  "deferred": true, 
-  "delivered": true, 
-  "dropped": true, 
-  "enabled": true, 
-  "group_resubscribe": true, 
-  "group_unsubscribe": true, 
-  "open": true, 
-  "processed": true, 
-  "spam_report": true, 
-  "unsubscribe": true, 
+  "bounce": true,
+  "click": true,
+  "deferred": true,
+  "delivered": true,
+  "dropped": true,
+  "enabled": true,
+  "group_resubscribe": true,
+  "group_unsubscribe": true,
+  "open": true,
+  "processed": true,
+  "spam_report": true,
+  "unsubscribe": true,
   "url": "url"
 }')
 response = sg.client.user.webhooks.event.settings.patch(request_body: data)
@@ -205,7 +203,7 @@ puts response.headers
 # Retrieve Event Webhook settings #
 # GET /user/webhooks/event/settings #
 
-response = sg.client.user.webhooks.event.settings.get()
+response = sg.client.user.webhooks.event.settings.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -227,9 +225,9 @@ puts response.headers
 # POST /user/webhooks/parse/settings #
 
 data = JSON.parse('{
-  "hostname": "myhostname.com", 
-  "send_raw": false, 
-  "spam_check": true, 
+  "hostname": "myhostname.com",
+  "send_raw": false,
+  "spam_check": true,
   "url": "http://email.myhosthame.com"
 }')
 response = sg.client.user.webhooks.parse.settings.post(request_body: data)
@@ -241,7 +239,7 @@ puts response.headers
 # Retrieve all parse settings #
 # GET /user/webhooks/parse/settings #
 
-response = sg.client.user.webhooks.parse.settings.get()
+response = sg.client.user.webhooks.parse.settings.get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -251,11 +249,11 @@ puts response.headers
 # PATCH /user/webhooks/parse/settings/{hostname} #
 
 data = JSON.parse('{
-  "send_raw": true, 
-  "spam_check": false, 
+  "send_raw": true,
+  "spam_check": false,
   "url": "http://newdomain.com/parse"
 }')
-hostname = "test_url_param"
+hostname = 'test_url_param'
 response = sg.client.user.webhooks.parse.settings._(hostname).patch(request_body: data)
 puts response.status_code
 puts response.body
@@ -265,8 +263,8 @@ puts response.headers
 # Retrieve a specific parse setting #
 # GET /user/webhooks/parse/settings/{hostname} #
 
-hostname = "test_url_param"
-response = sg.client.user.webhooks.parse.settings._(hostname).get()
+hostname = 'test_url_param'
+response = sg.client.user.webhooks.parse.settings._(hostname).get
 puts response.status_code
 puts response.body
 puts response.headers
@@ -275,8 +273,8 @@ puts response.headers
 # Delete a parse setting #
 # DELETE /user/webhooks/parse/settings/{hostname} #
 
-hostname = "test_url_param"
-response = sg.client.user.webhooks.parse.settings._(hostname).delete()
+hostname = 'test_url_param'
+response = sg.client.user.webhooks.parse.settings._(hostname).delete
 puts response.status_code
 puts response.body
 puts response.headers
@@ -290,4 +288,3 @@ response = sg.client.user.webhooks.parse.stats.get(query_params: params)
 puts response.status_code
 puts response.body
 puts response.headers
-

data/lib/rack/sendgrid_webhook_verification.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Rack
+  # Middleware that verifies webhooks from SendGrid using the EventWebhook
+  # verifier.
+  #
+  # The middleware takes a public key with which to set up the request
+  # validator and any number of paths. When a path matches the incoming request
+  # path, the request will be verified using the signature and timestamp of the
+  # request.
+  #
+  # Example:
+  #
+  # require 'rack'
+  # use Rack::SendGridWebhookVerification, ENV['PUBLIC_KEY'], /\/emails/
+  #
+  # The above appends this middleware to the stack, using a public key saved in
+  # the ENV and only against paths that match /\/emails/. If the request
+  # validates then it gets passed on to the action as normal. If the request
+  # doesn't validate then the middleware responds immediately with a 403 status.
+  class SendGridWebhookVerification
+    def initialize(app, public_key, *paths)
+      @app = app
+      @public_key = public_key
+      @path_regex = Regexp.union(paths)
+    end
+
+    def call(env)
+      return @app.call(env) unless env['PATH_INFO'].match(@path_regex)
+
+      request = Rack::Request.new(env)
+
+      event_webhook = SendGrid::EventWebhook.new
+      ec_public_key = event_webhook.convert_public_key_to_ecdsa(@public_key)
+      verified = event_webhook.verify_signature(
+        ec_public_key,
+        request.body.read,
+        request.env[SendGrid::EventWebhookHeader::SIGNATURE],
+        request.env[SendGrid::EventWebhookHeader::TIMESTAMP]
+      )
+
+      request.body.rewind
+
+      if verified
+        @app.call(env)
+      else
+        [
+          403,
+          { 'Content-Type' => 'text/plain' },
+          ['SendGrid Request Verification Failed.']
+        ]
+      end
+    end
+  end
+end