sendgrid-ruby 6.2.0 → 6.6.2

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

@@ -11,7 +11,7 @@ module SendGrid
     def unassigned
       response = @sendgrid_client.ips.get
       ips = JSON.parse(response.body)
-      ips.select {|ip| ip.subusers.empty?}
+      ips.select { |ip| ip.subusers.empty? }
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 # 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

@@ -1,30 +1,18 @@
+require 'json'
+
 module SendGrid
   class ASM
-    def initialize(group_id: nil, groups_to_display: nil)
-      @group_id = group_id
-      @groups_to_display = groups_to_display
-    end
+    attr_accessor :group_id, :groups_to_display
 
-    def group_id=(group_id)
+    def initialize(group_id: nil, groups_to_display: nil)
       @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

@@ -2,6 +2,8 @@ require 'base64'
 
 module SendGrid
   class Attachment
+    attr_accessor :type, :filename, :disposition, :content_id
+
     def initialize
       @content = nil
       @type = nil
@@ -18,52 +20,20 @@ module SendGrid
     def 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)
-      @type = type
-    end
-
-    def type
-      @type
-    end
-
-    def filename=(filename)
-      @filename = filename
-    end
-
-    def filename
-      @filename
-    end
-
-    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
 

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

@@ -1,30 +1,18 @@
+require 'json'
+
 module SendGrid
   class BccSettings
-    def initialize(enable: nil, email: nil)
-      @enable = enable
-      @email = email
-    end
+    attr_accessor :enable, :email
 
-    def enable=(enable)
+    def initialize(enable: nil, email: nil)
       @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

@@ -1,40 +1,30 @@
+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

@@ -12,7 +12,7 @@ module SendGrid
       }.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

@@ -1,30 +1,18 @@
+require 'json'
+
 module SendGrid
   class ClickTracking
-    def initialize(enable: nil, enable_text: nil)
-      @enable = enable
-      @enable_text = enable_text
-    end
+    attr_accessor :enable, :enable_text
 
-    def enable=(enable)
+    def initialize(enable: nil, enable_text: nil)
       @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

@@ -1,6 +1,7 @@
+require 'json'
+
 module SendGrid
   class Content
-
     attr_accessor :type, :value
 
     def initialize(type: nil, value: nil)
@@ -10,8 +11,8 @@ module SendGrid
 
     def to_json(*)
       {
-        'type' => self.type,
-        'value' => self.value
+        'type' => type,
+        'value' => value
       }.delete_if { |_, value| value.to_s.strip == '' }
     end
   end

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

@@ -1,21 +1,17 @@
+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

@@ -1,9 +1,12 @@
+require 'json'
+
 module SendGrid
   class Email
-
     attr_accessor :email, :name
 
-    def initialize(email: nil, name: nil)
+    # @param [String] email required e-mail address
+    # @param [String] name optionally personification
+    def initialize(email:, name: nil)
       if name
         @email = email
         @name = name
@@ -14,13 +17,15 @@ module SendGrid
 
     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

@@ -1,40 +1,20 @@
+require 'json'
+
 module SendGrid
   class Footer
+    attr_accessor :enable, :text, :html
+
     def initialize(enable: nil, text: nil, html: nil)
       @enable = enable
       @text = text
       @html = html
     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 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

@@ -1,5 +1,9 @@
+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
@@ -10,62 +14,14 @@ 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

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

@@ -1,21 +1,17 @@
+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

@@ -1,12 +1,16 @@
 # Build the request body for the v3/mail/send endpoint
 # Please see the examples/helpers/mail/example.rb for a demonstration of usage
+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 = []
@@ -25,18 +29,14 @@ 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
@@ -54,7 +54,7 @@ module SendGrid
     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)
+        raise SecurityError, 'Content contains sensitive information.' if contents.match(pattern)
       end
     end
 
@@ -81,58 +81,42 @@ module SendGrid
       @custom_args = @custom_args.merge(custom_arg['custom_arg'])
     end
 
-    def asm=(asm)
-      @asm = asm
-    end
-
     def asm
       @asm.nil? ? nil : @asm.to_json
     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