sendgrid-ruby 5.3.0 → 6.0.4

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

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,4 +1,4 @@
-# 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'
@@ -14,7 +14,7 @@ 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,4 +1,4 @@
-**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
 

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

@@ -1,4 +1,5 @@
 require 'json'
+require 'base64'
 
 module SendGrid
   class Attachment
@@ -11,11 +12,18 @@ module SendGrid
     end
 
     def content=(content)
+      @encoded_content = nil
       @content = content
     end
 
     def content
-      @content
+      return @encoded_content if @encoded_content
+
+      if @content.respond_to?(:read)
+        @encoded_content = encode @content
+      else
+        @encoded_content = @content
+      end
     end
 
     def type=(type)
@@ -59,5 +67,20 @@ module SendGrid
         'content_id' => self.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/category.rb

@@ -8,14 +8,6 @@ module SendGrid
       @name = name
     end
 
-    def name=(name)
-      @name = name
-    end
-
-    def name
-      @name
-    end
-
     def to_json(*)
       {
         'category' => name

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

@@ -2,27 +2,14 @@ require 'json'
 
 module SendGrid
   class Content
-    def initialize(type: nil, value: nil)
-      @type = type
-      @value = value
-    end
-
-    def type=(type)
-      @type = type
-    end
 
-    def type
-      @type
-    end
+    attr_accessor :type, :value
 
-    def value=(value)
+    def initialize(type: nil, value: nil)
+      @type = type
       @value = value
     end
 
-    def value
-      @value
-    end
-
     def to_json(*)
       {
         'type' => self.type,

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

@@ -2,6 +2,9 @@ require 'json'
 
 module SendGrid
   class Email
+
+    attr_accessor :email, :name
+
     def initialize(email: nil, name: nil)
       if name
         @email = email
@@ -11,22 +14,6 @@ module SendGrid
       end
     end
 
-    def email=(email)
-      @email = email
-    end
-
-    def email
-      @email
-    end
-
-    def name=(name)
-      @name = name
-    end
-
-    def name
-      @name
-    end
-
     def split_email(email)
       split = /(?:(?<address>.+)\s)?<?(?<email>.+@[^>]+)>?/.match(email)
       return split[:email], split[:address]

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

@@ -5,6 +5,7 @@ require 'json'
 module SendGrid
   class Mail
 
+    attr_accessor :subject, :ip_pool_name, :template_id, :send_at, :batch_id
     attr_reader :personalizations, :contents, :attachments, :categories, :sections, :headers, :custom_args
 
     def initialize(from_email=nil, subj=nil, to_email=nil, cont=nil)
@@ -44,14 +45,6 @@ module SendGrid
       @from.nil? ? nil : @from.to_json
     end
 
-    def subject=(subject)
-      @subject = subject
-    end
-
-    def subject
-      @subject
-    end
-
     def add_personalization(personalization)
       @personalizations << personalization.to_json
     end
@@ -60,6 +53,13 @@ module SendGrid
       @contents << content.to_json
     end
 
+    def check_for_secrets(patterns)
+      contents = @contents.map { |content| content['value'] }.join(' ')
+      patterns.each do |pattern|
+        raise SecurityError.new('Content contains sensitive information.') if contents.match(pattern)
+      end
+    end
+
     def add_attachment(attachment)
       @attachments << attachment.to_json
     end
@@ -68,14 +68,6 @@ module SendGrid
       @categories << category.name
     end
 
-    def template_id=(template_id)
-      @template_id = template_id
-    end
-
-    def template_id
-      @template_id
-    end
-
     def add_section(section)
       section = section.to_json
       @sections = @sections.merge(section['section'])
@@ -91,22 +83,6 @@ module SendGrid
       @custom_args = @custom_args.merge(custom_arg['custom_arg'])
     end
 
-    def send_at=(send_at)
-      @send_at = send_at
-    end
-
-    def send_at
-      @send_at
-    end
-
-    def batch_id=(batch_id)
-      @batch_id = batch_id
-    end
-
-    def batch_id
-      @batch_id
-    end
-
     def asm=(asm)
       @asm = asm
     end
@@ -115,14 +91,6 @@ module SendGrid
       @asm.nil? ? nil : @asm.to_json
     end
 
-    def ip_pool_name=(ip_pool_name)
-      @ip_pool_name = ip_pool_name
-    end
-
-    def ip_pool_name
-      @ip_pool_name
-    end
-
     def mail_settings=(mail_settings)
       @mail_settings = mail_settings
     end

data/lib/sendgrid/helpers/permissions/scope.rb

@@ -0,0 +1,28 @@
+# This is used for getting scopes
+require 'yaml'
+
+module SendGrid
+  class Scope
+    SCOPES = YAML.load_file(File.dirname(__FILE__) + '/scopes.yml').freeze
+    
+    class << self
+      def admin_permissions
+        SCOPES.values.map(&:values).flatten
+      end
+
+      def read_only_permissions
+        SCOPES.map { |_, v| v[:read] }.flatten
+      end
+
+      SCOPES.each_key do |endpoint|
+        define_method "#{endpoint}_read_only_permissions" do
+          SCOPES[endpoint][:read]
+        end
+
+        define_method "#{endpoint}_full_access_permissions" do
+          SCOPES[endpoint].values.flatten
+        end
+      end
+    end
+  end
+end