sendgrid-ruby 1.1.6 → 6.0.4

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

@@ -0,0 +1,43 @@
+require 'json'
+
+module SendGrid
+  class Footer
+    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
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'json'
+
+module SendGrid
+  class Ganalytics
+    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 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
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'json'
+
+module SendGrid
+  class 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
+    end
+
+    def to_json(*)
+      {
+        'header' => self.header
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+# 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
+
+    def initialize(from_email=nil, subj=nil, to_email=nil, cont=nil)
+      @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
+
+      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
+
+    def from=(from)
+      @from = from
+    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.new('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)
+      @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 == {}}
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'json'
+
+module SendGrid
+  class MailSettings
+    def initialize
+      @bcc = nil
+      @bypass_list_management = nil
+      @footer = nil
+      @sandbox_mode = nil
+      @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
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'json'
+
+module SendGrid
+  class OpenTracking
+    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
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require 'json'
+
+module SendGrid
+  class Personalization
+
+    attr_reader :tos, :ccs, :bccs, :headers, :substitutions, :custom_args,
+      :dynamic_template_data
+
+    def initialize
+      @tos = []
+      @ccs = []
+      @bccs = []
+      @subject = nil
+      @headers = {}
+      @substitutions = {}
+      @custom_args = {}
+      @dynamic_template_data = {}
+      @send_at = nil
+    end
+
+    def add_to(to)
+      @tos << to.to_json
+    end
+
+    def add_cc(cc)
+      @ccs << cc.to_json
+    end
+
+    def add_bcc(bcc)
+      @bccs << bcc.to_json
+    end
+
+    def subject=(subject)
+      @subject = subject
+    end
+
+    def subject
+      @subject
+    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 send_at=(send_at)
+      @send_at = send_at
+    end
+
+    def send_at
+      @send_at
+    end
+
+    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 == {}}
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'json'
+
+module SendGrid
+  class 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
+    end
+
+    def to_json(*)
+      {
+        'section' => self.section
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

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

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

@@ -0,0 +1,53 @@
+require 'json'
+
+module SendGrid
+  class SubscriptionTracking
+    def initialize(enable: nil, text: nil, html: nil, substitution_tag: nil)
+      @enable = enable
+      @text = text
+      @html = html
+      @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
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'json'
+
+module SendGrid
+  class 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
+    end
+
+    def to_json(*)
+      {
+        'substitution' => self.substitution
+      }.delete_if { |_, value| value.to_s.strip == '' }
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require 'json'
+
+module SendGrid
+  class TrackingSettings
+    def initialize
+      @click_tracking = nil
+      @open_tracking = nil
+      @subscription_tracking = nil
+      @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
+      }.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