sendgrid-ruby 1.1.6 → 6.6.2

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

@@ -0,0 +1,28 @@
+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
+      @utm_medium = utm_medium
+      @utm_term = utm_term
+      @utm_content = utm_content
+      @utm_campaign = utm_campaign
+      @utm_name = utm_name
+    end
+
+    def to_json(*)
+      {
+        '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

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

@@ -0,0 +1,18 @@
+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 to_json(*)
+      {
+        'header' => header
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# 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
+
+    # 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 = []
+      @contents = []
+      @attachments = []
+      @template_id = nil
+      @sections = {}
+      @headers = {}
+      @categories = []
+      @custom_args = {}
+      @send_at = nil
+      @batch_id = nil
+      @asm = nil
+      @ip_pool_name = nil
+      @mail_settings = nil
+      @tracking_settings = nil
+      @reply_to = nil
+
+      return 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)
+      add_personalization(personalization)
+      add_content(cont)
+    end
+
+    def from
+      @from.nil? ? nil : @from.to_json
+    end
+
+    def add_personalization(personalization)
+      @personalizations << personalization.to_json
+    end
+
+    def add_content(content)
+      @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
+
+    def add_category(category)
+      @categories << category.name
+    end
+
+    def add_section(section)
+      section = section.to_json
+      @sections = @sections.merge(section['section'])
+    end
+
+    def add_header(header)
+      header = header.to_json
+      @headers = @headers.merge(header['header'])
+    end
+
+    def add_custom_arg(custom_arg)
+      custom_arg = custom_arg.to_json
+      @custom_args = @custom_args.merge(custom_arg['custom_arg'])
+    end
+
+    def asm
+      @asm.nil? ? nil : @asm.to_json
+    end
+
+    def mail_settings
+      @mail_settings.nil? ? nil : @mail_settings.to_json
+    end
+
+    def tracking_settings
+      @tracking_settings.nil? ? nil : @tracking_settings.to_json
+    end
+
+    def reply_to
+      @reply_to.nil? ? nil : @reply_to.to_json
+    end
+
+    def to_json(*)
+      {
+        '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

@@ -0,0 +1,45 @@
+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
+      @footer = nil
+      @sandbox_mode = nil
+      @spam_check = nil
+    end
+
+    def sandbox_mode
+      @sandbox_mode.nil? ? nil : @sandbox_mode.to_json
+    end
+
+    def bypass_list_management
+      @bypass_list_management.nil? ? nil : @bypass_list_management.to_json
+    end
+
+    def footer
+      @footer.nil? ? nil : @footer.to_json
+    end
+
+    def bcc
+      @bcc.nil? ? nil : @bcc.to_json
+    end
+
+    def spam_check
+      @spam_check.nil? ? nil : @spam_check.to_json
+    end
+
+    def to_json(*)
+      {
+        '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
+end

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

@@ -0,0 +1,19 @@
+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 to_json(*)
+      {
+        'enable' => enable,
+        'substitution_tag' => substitution_tag
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require 'json'
+
+module SendGrid
+  class Personalization
+    attr_reader :tos, :from, :ccs, :bccs, :headers, :substitutions, :custom_args,
+                :dynamic_template_data
+
+    attr_accessor :send_at, :subject
+
+    def initialize
+      @tos = []
+      @from = nil
+      @ccs = []
+      @bccs = []
+      @subject = nil
+      @headers = {}
+      @substitutions = {}
+      @custom_args = {}
+      @dynamic_template_data = {}
+      @send_at = nil
+    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)
+      raise DuplicatePersonalizationError if duplicate?(bcc)
+
+      @bccs << bcc.to_json
+    end
+
+    def add_header(header)
+      header = header.to_json
+      @headers = @headers.merge(header['header'])
+    end
+
+    def add_substitution(substitution)
+      substitution = substitution.to_json
+      @substitutions = @substitutions.merge(substitution['substitution'])
+    end
+
+    def add_custom_arg(custom_arg)
+      custom_arg = custom_arg.to_json
+      @custom_args = @custom_args.merge(custom_arg['custom_arg'])
+    end
+
+    def add_dynamic_template_data(dynamic_template_data)
+      @dynamic_template_data.merge!(dynamic_template_data)
+    end
+
+    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
+
+    private
+
+    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

@@ -0,0 +1,18 @@
+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 to_json(*)
+      {
+        'section' => section
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+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
+      @html = html
+      @substitution_tag = substitution_tag
+    end
+
+    def to_json(*)
+      {
+        'enable' => enable,
+        'text' => text,
+        'html' => html,
+        'substitution_tag' => substitution_tag
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+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 to_json(*)
+      {
+        'substitution' => substitution
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'json'
+
+module SendGrid
+  class TrackingSettings
+    attr_writer :click_tracking, :open_tracking, :subscription_tracking, :ganalytics
+
+    def initialize
+      @click_tracking = nil
+      @open_tracking = nil
+      @subscription_tracking = nil
+      @ganalytics = nil
+    end
+
+    def click_tracking
+      @click_tracking.nil? ? nil : @click_tracking.to_json
+    end
+
+    def open_tracking
+      @open_tracking.nil? ? nil : @open_tracking.to_json
+    end
+
+    def subscription_tracking
+      @subscription_tracking.nil? ? nil : @subscription_tracking.to_json
+    end
+
+    def ganalytics
+      @ganalytics.nil? ? nil : @ganalytics.to_json
+    end
+
+    def to_json(*)
+      {
+        'click_tracking' => click_tracking,
+        'open_tracking' => open_tracking,
+        'subscription_tracking' => subscription_tracking,
+        'ganalytics' => ganalytics
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+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