sendgrid-ruby 5.3.0 → 6.7.0

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

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

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

@@ -2,7 +2,11 @@ require 'json'
 
 module SendGrid
   class Email
-    def initialize(email: nil, name: nil)
+    attr_accessor :email, :name
+
+    # @param [String] email required e-mail address
+    # @param [String] name optionally personification
+    def initialize(email:, name: nil)
       if name
         @email = email
         @name = name
@@ -11,31 +15,17 @@ 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]
+      raise ArgumentError, "email (#{email}) is invalid" unless split
+
+      [split[:email], split[:address]]
     end
 
     def to_json(*)
       {
-        'email' => self.email,
-        'name' => self.name
+        'email' => email,
+        'name' => name
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -2,41 +2,19 @@ require 'json'
 
 module SendGrid
   class Footer
-    def initialize(enable: nil, text: nil, html: nil)
-      @enable = enable
-      @text = text
-      @html = html
-    end
+    attr_accessor :enable, :text, :html
 
-    def enable=(enable)
+    def initialize(enable: nil, text: nil, html: nil)
       @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 to_json(*)
       {
-        'enable' => self.enable,
-        'text' => self.text,
-        'html' => self.html
+        'enable' => enable,
+        'text' => text,
+        'html' => html
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -2,6 +2,8 @@ require 'json'
 
 module SendGrid
   class Ganalytics
+    attr_accessor :enable, :utm_source, :utm_medium, :utm_term, :utm_content, :utm_name, :utm_campaign
+
     def initialize(enable: nil, utm_source: nil, utm_medium: nil, utm_term: nil, utm_content: nil, utm_campaign: nil, utm_name: nil)
       @enable = enable
       @utm_source = utm_source
@@ -12,63 +14,15 @@ module SendGrid
       @utm_name = utm_name
     end
 
-    def enable=(enable)
-      @enable = enable
-    end
-
-    def enable
-      @enable
-    end
-
-    def utm_source=(utm_source)
-      @utm_source = utm_source
-    end
-
-    def utm_source
-      @utm_source
-    end
-
-    def utm_medium=(utm_medium)
-      @utm_medium = utm_medium
-    end
-
-    def utm_medium
-      @utm_medium
-    end
-
-    def utm_term=(utm_term)
-      @utm_term = utm_term
-    end
-
-    def utm_term
-      @utm_term
-    end
-
-    def utm_content=(utm_content)
-      @utm_content = utm_content
-    end
-
-    def utm_content
-      @utm_content
-    end
-
-    def utm_campaign=(utm_campaign)
-      @utm_campaign = utm_campaign
-    end
-
-    def utm_campaign
-      @utm_campaign
-    end
-
     def to_json(*)
       {
-        'enable' => self.enable,
-        'utm_source' => self.utm_source,
-        'utm_medium' => self.utm_medium,
-        'utm_term' => self.utm_term,
-        'utm_content' => self.utm_content,
-        'utm_campaign' => self.utm_campaign
+        'enable' => enable,
+        'utm_source' => utm_source,
+        'utm_medium' => utm_medium,
+        'utm_term' => utm_term,
+        'utm_content' => utm_content,
+        'utm_campaign' => utm_campaign
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end
-end
+end

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

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

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

@@ -4,10 +4,13 @@ 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
+    attr_writer :from, :asm, :mail_settings, :tracking_settings, :reply_to
 
-    def initialize(from_email=nil, subj=nil, to_email=nil, cont=nil)
+    # We allow for all nil values here to create uninitialized Mail objects
+    # (e.g. <project-root>/use-cases/transactional-templates.md)
+    def initialize(from_email = nil, subj = nil, to_email = nil, cont = nil) # rubocop:disable Metrics/ParameterLists
       @from = nil
       @subject = nil
       @personalizations = []
@@ -26,32 +29,20 @@ module SendGrid
       @tracking_settings = nil
       @reply_to = nil
 
-      if !(from_email.nil? && subj.nil? && to_email.nil? && cont.nil?)
-        self.from = from_email
-        self.subject = subj
-        personalization = Personalization.new
-        personalization.add_to(to_email)
-        self.add_personalization(personalization)
-        self.add_content(cont)
-      end
-    end
+      return if from_email.nil? && subj.nil? && to_email.nil? && cont.nil?
 
-    def from=(from)
-      @from = from
+      self.from = from_email
+      self.subject = subj
+      personalization = Personalization.new
+      personalization.add_to(to_email)
+      add_personalization(personalization)
+      add_content(cont)
     end
 
     def from
       @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 +51,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, 'Content contains sensitive information.' if contents.match(pattern)
+      end
+    end
+
     def add_attachment(attachment)
       @attachments << attachment.to_json
     end
@@ -68,14 +66,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,82 +81,42 @@ 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
-
     def asm
       @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
-
     def mail_settings
       @mail_settings.nil? ? nil : @mail_settings.to_json
     end
 
-    def tracking_settings=(tracking_settings)
-      @tracking_settings = tracking_settings
-    end
-
     def tracking_settings
       @tracking_settings.nil? ? nil : @tracking_settings.to_json
     end
 
-    def reply_to=(reply_to)
-      @reply_to = reply_to
-    end
-
     def reply_to
       @reply_to.nil? ? nil : @reply_to.to_json
     end
 
     def to_json(*)
       {
-        'from' => self.from,
-        'subject' => self.subject,
-        'personalizations' => self.personalizations,
-        'content' => self.contents,
-        'attachments' => self.attachments,
-        'template_id' => self.template_id,
-        'sections' => self.sections,
-        'headers' => self.headers,
-        'categories' => self.categories,
-        'custom_args' => self.custom_args,
-        'send_at' => self.send_at,
-        'batch_id' => self.batch_id,
-        'asm' => self.asm,
-        'ip_pool_name' => self.ip_pool_name,
-        'mail_settings' => self.mail_settings,
-        'tracking_settings' => self.tracking_settings,
-        'reply_to' => self.reply_to
-      }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+        'from' => from,
+        'subject' => subject,
+        'personalizations' => personalizations,
+        'content' => contents,
+        'attachments' => attachments,
+        'template_id' => template_id,
+        'sections' => sections,
+        'headers' => headers,
+        'categories' => categories,
+        'custom_args' => custom_args,
+        'send_at' => send_at,
+        'batch_id' => batch_id,
+        'asm' => asm,
+        'ip_pool_name' => ip_pool_name,
+        'mail_settings' => mail_settings,
+        'tracking_settings' => tracking_settings,
+        'reply_to' => reply_to
+      }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {} }
     end
   end
 end

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

@@ -2,6 +2,8 @@ require 'json'
 
 module SendGrid
   class MailSettings
+    attr_writer :sandbox_mode, :footer, :bcc, :spam_check, :bypass_list_management
+
     def initialize
       @bcc = nil
       @bypass_list_management = nil
@@ -10,53 +12,33 @@ module SendGrid
       @spam_check = nil
     end
 
-    def sandbox_mode=(sandbox_mode)
-      @sandbox_mode = sandbox_mode
-    end
-
     def sandbox_mode
       @sandbox_mode.nil? ? nil : @sandbox_mode.to_json
     end
 
-    def bypass_list_management=(bypass_list_management)
-      @bypass_list_management = bypass_list_management
-    end
-
     def bypass_list_management
       @bypass_list_management.nil? ? nil : @bypass_list_management.to_json
     end
 
-    def footer=(footer)
-      @footer = footer
-    end
-
     def footer
       @footer.nil? ? nil : @footer.to_json
     end
 
-    def bcc=(bcc)
-      @bcc = bcc
-    end
-
     def bcc
       @bcc.nil? ? nil : @bcc.to_json
     end
 
-    def spam_check=(spam_check)
-      @spam_check = spam_check
-    end
-
     def spam_check
       @spam_check.nil? ? nil : @spam_check.to_json
     end
 
     def to_json(*)
       {
-        'bcc' => self.bcc,
-        'bypass_list_management' => self.bypass_list_management,
-        'footer' => self.footer,
-        'sandbox_mode' => self.sandbox_mode,
-        'spam_check' => self.spam_check
+        'bcc' => bcc,
+        'bypass_list_management' => bypass_list_management,
+        'footer' => footer,
+        'sandbox_mode' => sandbox_mode,
+        'spam_check' => spam_check
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

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

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

@@ -2,12 +2,14 @@ require 'json'
 
 module SendGrid
   class Personalization
+    attr_reader :tos, :from, :ccs, :bccs, :headers, :substitutions, :custom_args,
+                :dynamic_template_data
 
-    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
-      :dynamic_template_data
+    attr_accessor :send_at, :subject
 
     def initialize
       @tos = []
+      @from = nil
       @ccs = []
       @bccs = []
       @subject = nil
@@ -19,23 +21,25 @@ module SendGrid
     end
 
     def add_to(to)
+      raise DuplicatePersonalizationError if duplicate?(to)
+
       @tos << to.to_json
     end
 
+    def add_from(from)
+      @from = from.to_json
+    end
+
     def add_cc(cc)
+      raise DuplicatePersonalizationError if duplicate?(cc)
+
       @ccs << cc.to_json
     end
 
     def add_bcc(bcc)
-      @bccs << bcc.to_json
-    end
-
-    def subject=(subject)
-      @subject = subject
-    end
+      raise DuplicatePersonalizationError if duplicate?(bcc)
 
-    def subject
-      @subject
+      @bccs << bcc.to_json
     end
 
     def add_header(header)
@@ -57,26 +61,33 @@ module SendGrid
       @dynamic_template_data.merge!(dynamic_template_data)
     end
 
-    def send_at=(send_at)
-      @send_at = send_at
+    def to_json(*)
+      {
+        'to' => tos,
+        'from' => from,
+        'cc' => ccs,
+        'bcc' => bccs,
+        'subject' => subject,
+        'headers' => headers,
+        'substitutions' => substitutions,
+        'custom_args' => custom_args,
+        'dynamic_template_data' => dynamic_template_data,
+        'send_at' => send_at
+      }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {} }
     end
 
-    def send_at
-      @send_at
-    end
+    private
 
-    def to_json(*)
-      {
-        'to' => self.tos,
-        'cc' => self.ccs,
-        'bcc' => self.bccs,
-        'subject' => self.subject,
-        'headers' => self.headers,
-        'substitutions' => self.substitutions,
-        'custom_args' => self.custom_args,
-        'dynamic_template_data' => self.dynamic_template_data,
-        'send_at' => self.send_at
-      }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+    def duplicate?(addition)
+      additional_email = addition.email.downcase
+
+      [@tos, @ccs, @bccs].flatten.each do |elm|
+        return true if elm&.dig('email')&.downcase == additional_email
+      end
+
+      false
     end
   end
+
+  class DuplicatePersonalizationError < StandardError; end
 end

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

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

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