sendgrid-ruby 5.3.0 → 6.7.0

data/lib/sendgrid/base_interface.rb

@@ -0,0 +1,57 @@
+require 'ruby_http_client'
+require_relative 'version'
+
+# Initialize the HTTP client
+class BaseInterface
+  attr_accessor :client
+  attr_reader :request_headers, :host, :version, :impersonate_subuser, :http_options
+
+  # * *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
+  #   - +http_options+ -> http options that you want to be globally applied to each request
+  #
+  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
+    @auth = auth
+    @host = host
+    @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
+    @http_options = http_options
+    @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
+                                   request_headers: @request_headers,
+                                   http_options: @http_options)
+  end
+
+  # Client libraries contain setters for specifying region/edge.
+  # This supports global and eu regions only. This set will likely expand in the future.
+  # Global is the default residency (or region)
+  # Global region means the message will be sent through https://api.sendgrid.com
+  # EU region means the message will be sent through https://api.eu.sendgrid.com
+  # Parameters:
+  # - region(String) : specify the region. Currently supports "global" and "eu"
+  def sendgrid_data_residency(region:)
+    region_host_dict = { "eu" => 'https://api.eu.sendgrid.com', "global" => 'https://api.sendgrid.com' }
+    raise ArgumentError, "region can only be \"eu\" or \"global\"" if region.nil? || !region_host_dict.key?(region)
+
+    @host = region_host_dict[region]
+    @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
+                                   request_headers: @request_headers,
+                                   http_options: @http_options)
+  end
+end

data/lib/sendgrid/helpers/eventwebhook/eventwebhook.rb

@@ -0,0 +1,50 @@
+require 'base64'
+require 'digest'
+require 'openssl'
+
+module SendGrid
+  # This class allows you to use the Event Webhook feature. Read the docs for
+  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
+  class EventWebhook
+    # * *Args* :
+    #   - +public_key+ -> verification key under Mail Settings
+    #
+    def convert_public_key_to_ecdsa(public_key)
+      verify_engine
+      OpenSSL::PKey::EC.new(Base64.decode64(public_key))
+    end
+
+    # * *Args* :
+    #   - +public_key+ -> elliptic curve public key
+    #   - +payload+ -> event payload in the request body
+    #   - +signature+ -> signature value obtained from the 'X-Twilio-Email-Event-Webhook-Signature' header
+    #   - +timestamp+ -> timestamp value obtained from the 'X-Twilio-Email-Event-Webhook-Timestamp' header
+    def verify_signature(public_key, payload, signature, timestamp)
+      verify_engine
+      timestamped_playload = "#{timestamp}#{payload}"
+      payload_digest = Digest::SHA256.digest(timestamped_playload)
+      decoded_signature = Base64.decode64(signature)
+      public_key.dsa_verify_asn1(payload_digest, decoded_signature)
+    rescue StandardError
+      false
+    end
+
+    def verify_engine
+      # JRuby does not fully support ECDSA: https://github.com/jruby/jruby-openssl/issues/193
+      raise NotSupportedError, "Event Webhook verification is not supported by JRuby" if RUBY_PLATFORM == "java"
+    end
+
+    class Error < ::RuntimeError
+    end
+
+    class NotSupportedError < Error
+    end
+  end
+
+  # This class lists headers that get posted to the webhook. Read the docs for
+  # more details: https://sendgrid.com/docs/for-developers/tracking-events/event
+  class EventWebhookHeader
+    SIGNATURE = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_SIGNATURE".freeze
+    TIMESTAMP = "HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_TIMESTAMP".freeze
+  end
+end

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](../../../../README.md#installation),
+you must also add sinatra to your Gemfile:
+
+```
+gem 'sinatra', '>= 1.4.7', '< 3'
+```
+
+
 # Quick Start for Local Testing with Sample Data
 
 ```bash
@@ -30,7 +47,7 @@ bundle install
 ruby ./lib/sendgrid/helpers/inbound/send.rb ./lib/sendgrid/helpers/inbound/sample_data/default_data.txt
 ```
 
-More sample data can be found [here](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/inbound/sample_data).
+More sample data can be found [here](sample_data).
 
 View the results in the first terminal.
 
@@ -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
@@ -65,11 +82,11 @@ Next, send an email to [anything]@inbound.yourdomain.com, then look at the termi
 
 ## app.rb
 
-This module runs a [Sinatra](http://www.sinatrarb.com/) server, that by default (you can change those settings [here](https://github.com/sendgrid/sendgrid-ruby/blob/master/sendgrid/helpers/inbound/config.yml)), listens for POSTs on http://localhost:9292. When the server receives the POST, it parses and prints the key/value data.
+This module runs a [Sinatra](http://www.sinatrarb.com/) server, that by default (you can change those settings [here](config.yml)), listens for POSTs on http://localhost:9292. When the server receives the POST, it parses and prints the key/value data.
 
 ## config.yml
 
-This module loads application environment variables (located in [config.yml](https://github.com/sendgrid/sendgrid-ruby/blob/master/sendgrid/helpers/inbound/config.yml)).
+This module loads application environment variables (located in [config.yml](config.yml)).
 
 ## send.rb & /sample_data
 
@@ -78,4 +95,4 @@ This module is used to send sample test data. It is useful for testing and devel
 <a name="contributing"></a>
 # Contributing
 
-If you would like to contribute to this project, please see our [contributing guide](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md). Thanks!
+If you would like to contribute to this project, please see our [contributing guide](../../../../CONTRIBUTING.md). Thanks!

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'
@@ -6,7 +18,7 @@ require 'yaml'
 class Main < Sinatra::Base
   configure :production, :development do
     enable :logging
-    set :config, YAML.load_file(File.dirname(__FILE__) + '/config.yml')
+    set :config, YAML.load_file("#{File.dirname(__FILE__)}/config.yml")
   end
 
   get '/' do
@@ -14,7 +26,7 @@ class Main < Sinatra::Base
   end
 
   post settings.config['endpoint'] do
-    filtered = params.select {|k, v| settings.config['keys'].include?(k)}
+    filtered = params.select { |k, _v| settings.config['keys'].include?(k) }
     logger.info JSON.pretty_generate(filtered)
   end
 end

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

@@ -1,10 +1,10 @@
 <html>
   <head>
-    <title>SendGrid Incoming Parse</title>
+    <title>Twilio SendGrid Incoming Parse</title>
   </head>
   <body>
     <h1>You have successfuly launched the server!</h1>
 
-       Check out <a href="https://github.com/sendgrid/sendgrid-ruby/tree/master/sendgrid/helpers/inbound">the documentation</a> on how to use this software to utilize the SendGrid Inbound Parse webhook.
+       Check out <a href="https://github.com/sendgrid/sendgrid-ruby/tree/HEAD/sendgrid/helpers/inbound">the documentation</a> on how to use this software to utilize the SendGrid Inbound Parse webhook.
   </body>
 </html>

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

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

@@ -19,13 +19,13 @@ Content-Type: multipart/alternative; boundary=001a1140ffb6f4fc5f053a2257e0
 --001a1140ffb6f4fc5f053a2257e0
 Content-Type: text/plain; charset=UTF-8
 
-Hello SendGrid!
+Hello Twilio SendGrid!
 
 --001a1140ffb6f4fc5f053a2257e0
 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>
 
 --001a1140ffb6f4fc5f053a2257e0--
 

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

@@ -1,20 +1,20 @@
-# A module for sending test SendGrid Inbound Parse messages
+# A module for sending test Twilio SendGrid Inbound Parse messages
 # Usage: ruby ./send.rb [path to file containing test data]
 require 'ruby_http_client'
 require 'yaml'
 require 'optparse'
 
-OPTS = {}
+OPTS = {}.freeze
 opt = OptionParser.new
-opt.on('--host=HOST') {|v| OPTS[:host] = v}
+opt.on('--host=HOST') { |v| OPTS[:host] = v }
 argv = opt.parse!(ARGV)
-config = YAML.load_file(File.dirname(__FILE__) + '/config.yml')
+config = YAML.load_file("#{File.dirname(__FILE__)}/config.yml")
 host = OPTS[:host] || config['host']
 client = SendGrid::Client.new(host: host)
 File.open(argv[0]) do |file|
   data = file.read
   headers = {
-    'User-Agent' => 'SendGrid-Test',
+    'User-Agent' => 'Twilio-SendGrid-Test',
     'Content-Type' => 'multipart/form-data; boundary=xYzZY'
   }
   response = client.post(

data/lib/sendgrid/helpers/ip_management/ip_management.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module SendGrid
+  class IpManagement
+    attr_accessor :sendgrid_client
+
+    def initialize(sendgrid_client:)
+      @sendgrid_client = sendgrid_client
+    end
+
+    def unassigned
+      response = @sendgrid_client.ips.get
+      ips = JSON.parse(response.body)
+      ips.select { |ip| ip.subusers.empty? }
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
-**This helper allows you to quickly and easily build a Mail object for sending email through SendGrid.**
+**This helper allows you to quickly and easily build a Mail object for sending email through Twilio SendGrid.**
 
 # Quick Start
 
-Run the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/mail) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+Run the [example](../../../../examples/helpers/mail) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
 
 ```bash
 ruby examples/helpers/mail/example.rb
@@ -10,5 +10,5 @@ ruby examples/helpers/mail/example.rb
 
 ## Usage
 
-- See the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/mail) for a complete working example.
-- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/overview.html)
+- See the [example](../../../../examples/helpers/mail) for a complete working example.
+- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html)

data/lib/sendgrid/helpers/mail/asm.rb

@@ -2,31 +2,17 @@ require 'json'
 
 module SendGrid
   class ASM
+    attr_accessor :group_id, :groups_to_display
+
     def initialize(group_id: nil, groups_to_display: nil)
       @group_id = group_id
       @groups_to_display = groups_to_display
     end
 
-    def group_id=(group_id)
-      @group_id = group_id
-    end
-
-    def group_id
-      @group_id
-    end
-
-    def groups_to_display=(groups_to_display)
-      @groups_to_display = groups_to_display
-    end
-
-    def groups_to_display
-      @groups_to_display
-    end
-
     def to_json(*)
       {
-        'group_id' => self.group_id,
-        'groups_to_display' => self.groups_to_display
+        'group_id' => group_id,
+        'groups_to_display' => groups_to_display
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

data/lib/sendgrid/helpers/mail/attachment.rb

@@ -1,7 +1,9 @@
-require 'json'
+require 'base64'
 
 module SendGrid
   class Attachment
+    attr_accessor :type, :filename, :disposition, :content_id
+
     def initialize
       @content = nil
       @type = nil
@@ -11,53 +13,43 @@ module SendGrid
     end
 
     def content=(content)
+      @encoded_content = nil
       @content = content
     end
 
     def content
-      @content
-    end
-
-    def type=(type)
-      @type = type
-    end
-
-    def type
-      @type
-    end
-
-    def filename=(filename)
-      @filename = filename
-    end
-
-    def filename
-      @filename
-    end
+      return @encoded_content if @encoded_content
 
-    def disposition=(disposition)
-      @disposition = disposition
-    end
-
-    def disposition
-      @disposition
-    end
-
-    def content_id=(content_id)
-      @content_id = content_id
-    end
-
-    def content_id
-      @content_id
+      @encoded_content = if @content.respond_to?(:read)
+                           encode @content
+                         else
+                           @content
+                         end
     end
 
     def to_json(*)
       {
-        'content' => self.content,
-        'type' => self.type,
-        'filename' => self.filename,
-        'disposition' => self.disposition,
-        'content_id' => self.content_id
+        'content' => content,
+        'type' => type,
+        'filename' => filename,
+        'disposition' => disposition,
+        'content_id' => content_id
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
+
+    private
+
+    def encode(io)
+      str = io.read
+      # Since the API expects UTF-8, we need to ensure that we're
+      # converting other formats to it so (byte-wise) Base64 encoding
+      # will come through properly on the other side.
+      #
+      # Not much to be done to try to handle encoding for files opened
+      # in binary mode, but at least we can faithfully convey the
+      # bytes.
+      str = str.encode('UTF-8') unless io.respond_to?(:binmode?) && io.binmode?
+      Base64.encode64 str
+    end
   end
 end

data/lib/sendgrid/helpers/mail/bcc_settings.rb

@@ -2,31 +2,17 @@ require 'json'
 
 module SendGrid
   class BccSettings
+    attr_accessor :enable, :email
+
     def initialize(enable: nil, email: nil)
       @enable = enable
       @email = email
     end
 
-    def enable=(enable)
-      @enable = enable
-    end
-
-    def enable
-      @enable
-    end
-
-    def email=(email)
-      @email = email
-    end
-
-    def email
-      @email
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable,
-        'email' => self.email
+        'enable' => enable,
+        'email' => email
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

data/lib/sendgrid/helpers/mail/bypass_list_management.rb

@@ -2,41 +2,29 @@ require 'json'
 
 module SendGrid
   class BypassListManagement
-    def initialize(enable: nil)
-      @enable = enable
-    end
+    attr_accessor :enable
 
-    def enable=(enable)
+    def initialize(enable: nil)
       @enable = enable
     end
 
-    def enable
-      @enable
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable
+        'enable' => enable
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end
 
   class SandBoxMode
-    def initialize(enable: nil)
-      @enable = enable
-    end
+    attr_accessor :enable
 
-    def enable=(enable)
+    def initialize(enable: nil)
       @enable = enable
     end
 
-    def enable
-      @enable
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable
+        'enable' => enable
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

data/lib/sendgrid/helpers/mail/category.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module SendGrid
   class Category
     attr_accessor :name
@@ -8,21 +6,13 @@ module SendGrid
       @name = name
     end
 
-    def name=(name)
-      @name = name
-    end
-
-    def name
-      @name
-    end
-
     def to_json(*)
       {
         'category' => name
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
 
-    alias :category :name
-    alias :category= :name=
+    alias category name
+    alias category= name=
   end
 end

data/lib/sendgrid/helpers/mail/click_tracking.rb

@@ -2,31 +2,17 @@ require 'json'
 
 module SendGrid
   class ClickTracking
+    attr_accessor :enable, :enable_text
+
     def initialize(enable: nil, enable_text: nil)
       @enable = enable
       @enable_text = enable_text
     end
 
-    def enable=(enable)
-      @enable = enable
-    end
-
-    def enable
-      @enable
-    end
-
-    def enable_text=(enable_text)
-      @enable_text = enable_text
-    end
-
-    def enable_text
-      @enable_text
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable,
-        'enable_text' => self.enable_text
+        'enable' => enable,
+        'enable_text' => enable_text
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

data/lib/sendgrid/helpers/mail/content.rb

@@ -2,31 +2,17 @@ require 'json'
 
 module SendGrid
   class Content
+    attr_accessor :type, :value
+
     def initialize(type: nil, value: nil)
       @type = type
       @value = value
     end
 
-    def type=(type)
-      @type = type
-    end
-
-    def type
-      @type
-    end
-
-    def value=(value)
-      @value = value
-    end
-
-    def value
-      @value
-    end
-
     def to_json(*)
       {
-        'type' => self.type,
-        'value' => self.value
+        'type' => type,
+        'value' => value
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end