sendgrid-ruby 6.0.0 → 6.4.0

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

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

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

@@ -2,6 +2,8 @@ require 'json'
 
 module SendGrid
   class SubscriptionTracking
+    attr_accessor :enable, :text, :html, :substitution_tag
+
     def initialize(enable: nil, text: nil, html: nil, substitution_tag: nil)
       @enable = enable
       @text = text
@@ -9,44 +11,12 @@ module SendGrid
       @substitution_tag = substitution_tag
     end
 
-    def enable=(enable)
-      @enable = enable
-    end
-
-    def enable
-      @enable
-    end
-
-    def text=(text)
-      @text = text
-    end
-
-    def text
-      @text
-    end
-
-    def html=(html)
-      @html = html
-    end
-
-    def html
-      @html
-    end
-
-    def substitution_tag=(substitution_tag)
-      @substitution_tag = substitution_tag
-    end
-
-    def substitution_tag
-      @substitution_tag
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable,
-        'text' => self.text,
-        'html' => self.html,
-        'substitution_tag' => self.substitution_tag
+        'enable' => enable,
+        'text' => text,
+        'html' => html,
+        'substitution_tag' => substitution_tag
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -2,22 +2,16 @@ require 'json'
 
 module SendGrid
   class Substitution
+    attr_accessor :substitution
+
     def initialize(key: nil, value: nil)
       @substitution = {}
-      (key.nil? || value.nil?) ? @substitution = nil : @substitution[key] = value
-    end
-
-    def substitution=(substitution)
-      @substitution = substitution
-    end
-
-    def substitution
-      @substitution
+      key.nil? || value.nil? ? @substitution = nil : @substitution[key] = value
     end
 
     def to_json(*)
       {
-        'substitution' => self.substitution
+        'substitution' => substitution
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -2,6 +2,8 @@ require 'json'
 
 module SendGrid
   class TrackingSettings
+    attr_writer :click_tracking, :open_tracking, :subscription_tracking, :ganalytics
+
     def initialize
       @click_tracking = nil
       @open_tracking = nil
@@ -9,44 +11,28 @@ module SendGrid
       @ganalytics = nil
     end
 
-    def click_tracking=(click_tracking)
-      @click_tracking = click_tracking
-    end
-
     def click_tracking
       @click_tracking.nil? ? nil : @click_tracking.to_json
     end
 
-    def open_tracking=(open_tracking)
-      @open_tracking = open_tracking
-    end
-
     def open_tracking
       @open_tracking.nil? ? nil : @open_tracking.to_json
     end
 
-    def subscription_tracking=(subscription_tracking)
-      @subscription_tracking = subscription_tracking
-    end
-
     def subscription_tracking
       @subscription_tracking.nil? ? nil : @subscription_tracking.to_json
     end
 
-    def ganalytics=(ganalytics)
-      @ganalytics = ganalytics
-    end
-
     def ganalytics
       @ganalytics.nil? ? nil : @ganalytics.to_json
     end
 
     def to_json(*)
       {
-        'click_tracking' => self.click_tracking,
-        'open_tracking' => self.open_tracking,
-        'subscription_tracking' => self.subscription_tracking,
-        'ganalytics' => self.ganalytics
+        'click_tracking' => click_tracking,
+        'open_tracking' => open_tracking,
+        'subscription_tracking' => subscription_tracking,
+        'ganalytics' => ganalytics
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -3,8 +3,8 @@ require 'yaml'
 
 module SendGrid
   class Scope
-    SCOPES = YAML.load_file(File.dirname(__FILE__) + '/scopes.yml').freeze
-    
+    SCOPES = YAML.load_file("#{File.dirname(__FILE__)}/scopes.yml").freeze
+
     class << self
       def admin_permissions
         SCOPES.values.map(&:values).flatten

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

@@ -2,7 +2,7 @@
 
 # Quick Start
 
-Run the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/settings) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+Run the [example](../../../../examples/helpers/settings) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
 
 ```bash
 ruby examples/helpers/settings/example.rb
@@ -10,5 +10,5 @@ ruby examples/helpers/settings/example.rb
 
 ## Usage
 
-- See the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/settings) for a complete working example.
+- See the [example](../../../../examples/helpers/settings) for a complete working example.
 - [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Settings/index.html)

data/lib/sendgrid/helpers/settings/settings.rb

@@ -8,7 +8,7 @@ module SendGrid
     attr_accessor :sendgrid_client
 
     SETTING_TYPES = [SendGrid::MailSettingsDto, SendGrid::TrackingSettingsDto,
-                     SendGrid::PartnerSettingsDto, SendGrid::UserSettingsDto]
+                     SendGrid::PartnerSettingsDto, SendGrid::UserSettingsDto].freeze
 
     def initialize(sendgrid_client:)
       @sendgrid_client = sendgrid_client

data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb

@@ -1,9 +1,9 @@
 module SendGrid
   class TrackingSettingsDto
     attr_reader :open, :click, :google_analytics, :subscription
-    alias :click_tracking :click
-    alias :open_tracking :open
-    alias :subscription_tracking :subscription
+    alias click_tracking click
+    alias open_tracking open
+    alias subscription_tracking subscription
 
     def self.fetch(sendgrid_client:, name:, query_params:)
       name = scrub_alias_names(name.to_s)
@@ -15,8 +15,6 @@ module SendGrid
       sendgrid_client.tracking_settings.public_send(name).patch(request_body: request_body)
     end
 
-    private
-
     def self.scrub_alias_names(name)
       name.gsub(/_tracking/, '')
     end

data/lib/sendgrid/helpers/stats/metrics.rb

@@ -1,14 +1,12 @@
-require 'json'
-
 module SendGrid
   class Metrics
     attr_reader :blocks, :bounce_drops,
-      :bounces, :clicks, :deferred, :delivered,
-      :invalid_emails, :opens, :processed, :requests,
-      :spam_report_drops, :spam_reports, :unique_clicks,
-      :unique_opens, :unsubscribe_drops, :unsubscribes
+                :bounces, :clicks, :deferred, :delivered,
+                :invalid_emails, :opens, :processed, :requests,
+                :spam_report_drops, :spam_reports, :unique_clicks,
+                :unique_opens, :unsubscribe_drops, :unsubscribes
 
-    def initialize(args={})
+    def initialize(args = {})
       @date = args['date']
       @blocks = args['blocks']
       @bounce_drops = args['bounce_drops']

data/lib/sendgrid/helpers/stats/stats_response.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module SendGrid
   class StatsResponse
     def initialize(args)

data/lib/sendgrid/sendgrid.rb

@@ -0,0 +1,21 @@
+# 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
+    #   - +http_options+ -> http options that you want to be globally applied to each request
+    #
+    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
+      auth = "Bearer #{api_key}"
+      host ||= 'https://api.sendgrid.com'
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser, http_options: http_options)
+    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'
+
+      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.0.0'
+  VERSION = '6.4.0'.freeze
 end

data/mail_helper_v3.md

@@ -2,11 +2,11 @@ Hello!
 
 It is now time to implement the final piece of our v2 to v3 migration. Before we dig into writing the code, we would love to get feedback on the following proposed interfaces.
 
-We are starting with the use cases below for the first iteration. (we have completed this work on [our C# library](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md), you can check that out for a sneak peek of where we are heading).
+We are starting with the use cases below for the first iteration. (we have completed this work on [our C# library](https://github.com/sendgrid/sendgrid-csharp/blob/HEAD/USE_CASES.md), you can check that out for a sneak peek of where we are heading).
 
 # Send a Single Email to a Single Recipient
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
 ```ruby
 require 'sendgrid-ruby'
@@ -37,7 +37,7 @@ puts response.headers
 
 # Send a Single Email to Multiple Recipients
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
 ```ruby
 require 'sendgrid-ruby'
@@ -72,7 +72,7 @@ puts response.headers
 
 # Send Multiple Emails to Multiple Recipients
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
 ```ruby
 require 'sendgrid-ruby'
@@ -119,7 +119,7 @@ puts response.headers
 
 # Kitchen Sink - an example with all settings used
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
 ```ruby
 client = SendGrid::Client.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -233,7 +233,7 @@ msg.set_send_at(1461775052, 1)
 
 msg.set_subject('this subject overrides the Global Subject on the second Personalization', 1)
 
-# The values below this comment are global to entire message
+# The values below this comment are global to the entire message
 
 msg.set_from(SendGrid::Email.new('test0@example.com', 'Example User0'))
 
@@ -263,7 +263,7 @@ attachments = [
                              'base64 encoded content',
                              'image/png',
                              'inline',
-                             'Banner 2'),                             
+                             'Banner 2'),
 ]
 msg.add_attachments(attachments)
 
@@ -279,7 +279,7 @@ msg.set_global_headers(global_headers)
 msg.add_section('%section1%', 'Substitution for Section 1 Tag')
 sections = [
     '%section2%' => 'Substitution for Section 2 Tag',
-    '%section3%' => 'Substitution for Section 3 Tag'    
+    '%section3%' => 'Substitution for Section 3 Tag'
 ]
 msg.add_sections(sections)
 
@@ -295,7 +295,7 @@ puts response.headers
 
 # Attachments
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
 ```ruby
 client = SendGrid::Client.new(api_key: ENV['SENDGRID_API_KEY'])
@@ -326,9 +326,9 @@ puts response.headers
 
 # Transactional Templates
 
-The following code assumes you are storing the API key in an [environment variable (recommended)](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
+The following code assumes you are storing the API key in an [environment variable (recommended)](TROUBLESHOOTING.md#environment-variables-and-your-sendgrid-api-key). If you don't have your key stored in an environment variable, you can assign it directly to `api_key` for testing purposes.
 
-For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
+For this example, we assume you have created a [legacy transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html) in the UI or via the API. Following is the template content we used for testing.
 
 Template ID (replace with your own):
 
@@ -347,7 +347,7 @@ Template Body:
 ```html
 <html>
 <head>
-	<title></title>
+    <title></title>
 </head>
 <body>
 Hello -name-,

data/sendgrid-ruby.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sendgrid/version'
 
@@ -7,24 +6,26 @@ Gem::Specification.new do |spec|
   spec.name        = 'sendgrid-ruby'
   spec.version     = SendGrid::VERSION
   spec.authors     = ['Elmer Thomas', 'Robin Johnson', 'Eddie Zaneski']
-  spec.email       = 'dx@sendgrid.com'
+  spec.email       = 'help@twilio.com'
   spec.summary     = 'Official Twilio SendGrid Gem'
   spec.description = 'Official Twilio SendGrid Gem to Interact with Twilio SendGrids API in native Ruby'
   spec.homepage    = 'http://github.com/sendgrid/sendgrid-ruby'
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.license     = 'MIT'
+  spec.license = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
-  spec.add_dependency 'ruby_http_client', '~> 3.3.0'
-  spec.add_development_dependency 'sinatra', '>= 1.4.7', '< 3'
-  spec.add_development_dependency 'rake', '~> 0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
+  spec.add_dependency 'ruby_http_client', '~> 3.4'
   spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'minitest', '~> 5.9'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'sinatra', '>= 1.4.7', '< 3'
 end