sendgrid4r 1.8.1 → 1.10.0

data/lib/sendgrid4r/rest/ips/addresses.rb

@@ -1,75 +1,66 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Ip Management
+  #
+  module Ips
     #
-    # SendGrid Web API v3 Ip Management
+    # SendGrid Web API v3 Ip Management - Pools
     #
-    module Ips
-      #
-      # SendGrid Web API v3 Ip Management - Pools
-      #
-      module Addresses
-        include SendGrid4r::REST::Request
+    module Addresses
+      include Request
 
-        Address = Struct.new(
-          :ip, :pools, :warmup, :start_date, :subusers, :rdns, :pool_name)
+      Address = Struct.new(
+        :ip, :pools, :warmup, :start_date, :subusers, :rdns, :pool_name
+      )
 
-        def self.create_addresses(resp)
-          return resp if resp.nil?
-          ips = []
-          resp.each do |address|
-            ips.push(SendGrid4r::REST::Ips::Addresses.create_address(address))
-          end
-          ips
-        end
+      def self.create_addresses(resp)
+        return resp if resp.nil?
+        resp.map { |address| Ips::Addresses.create_address(address) }
+      end
 
-        def self.create_address(resp)
-          return resp if resp.nil?
-          Address.new(
-            resp['ip'],
-            resp['pools'],
-            resp['warmup'],
-            resp['start_date'].nil? ? nil : Time.at(resp['start_date']),
-            resp['subusers'],
-            resp['rdns'],
-            resp['pool_name']
-          )
-        end
+      def self.create_address(resp)
+        return resp if resp.nil?
+        Address.new(
+          resp['ip'],
+          resp['pools'],
+          resp['warmup'],
+          resp['start_date'].nil? ? nil : Time.at(resp['start_date']),
+          resp['subusers'],
+          resp['rdns'],
+          resp['pool_name']
+        )
+      end
 
-        def self.url(ip = nil)
-          url = "#{BASE_URL}/ips"
-          url = "#{url}/#{ip}" unless ip.nil?
-          url
-        end
+      def self.url(ip = nil)
+        url = "#{BASE_URL}/ips"
+        url = "#{url}/#{ip}" unless ip.nil?
+        url
+      end
 
-        def post_ip_to_pool(pool_name:, ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips')
-          resp = post(@auth, endpoint, ip: ip, &block)
-          SendGrid4r::REST::Ips::Addresses.create_address(resp)
-        end
+      def post_ip_to_pool(pool_name:, ip:, &block)
+        resp = post(@auth, Ips::Pools.url(pool_name, :ips), ip: ip, &block)
+        Ips::Addresses.create_address(resp)
+      end
 
-        def get_ips(&block)
-          resp = get(@auth, SendGrid4r::REST::Ips::Addresses.url, &block)
-          SendGrid4r::REST::Ips::Addresses.create_addresses(resp)
-        end
+      def get_ips(&block)
+        resp = get(@auth, Ips::Addresses.url, &block)
+        Ips::Addresses.create_addresses(resp)
+      end
 
-        def get_ips_assigned(&block)
-          endpoint = SendGrid4r::REST::Ips::Addresses.url('assigned')
-          resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Ips::Addresses.create_addresses(resp)
-        end
+      def get_ips_assigned(&block)
+        resp = get(@auth, Ips::Addresses.url(:assigned), &block)
+        Ips::Addresses.create_addresses(resp)
+      end
 
-        def get_ip(ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Addresses.url(ip)
-          resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Ips::Addresses.create_address(resp)
-        end
+      def get_ip(ip:, &block)
+        resp = get(@auth, Ips::Addresses.url(ip), &block)
+        Ips::Addresses.create_address(resp)
+      end
 
-        def delete_ip_from_pool(pool_name:, ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Pools.url(pool_name, 'ips', ip)
-          delete(@auth, endpoint, &block)
-        end
+      def delete_ip_from_pool(pool_name:, ip:, &block)
+        delete(@auth, Ips::Pools.url(pool_name, :ips, ip), &block)
       end
     end
   end

data/lib/sendgrid4r/rest/ips/pools.rb

@@ -1,69 +1,58 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Ip Management
+  #
+  module Ips
     #
-    # SendGrid Web API v3 Ip Management
+    # SendGrid Web API v3 Ip Management - Pools
     #
-    module Ips
-      #
-      # SendGrid Web API v3 Ip Management - Pools
-      #
-      module Pools
-        include SendGrid4r::REST::Request
+    module Pools
+      include Request
 
-        Pool = Struct.new(:pool_name, :name, :ips)
+      Pool = Struct.new(:pool_name, :name, :ips)
 
-        def self.create_pools(resp)
-          return resp if resp.nil?
-          pools = []
-          resp.each do |pool|
-            pools.push(SendGrid4r::REST::Ips::Pools.create_pool(pool))
-          end
-          pools
-        end
+      def self.create_pools(resp)
+        return resp if resp.nil?
+        resp.map { |pool| Ips::Pools.create_pool(pool) }
+      end
 
-        def self.create_pool(resp)
-          return resp if resp.nil?
-          ips = []
-          Array(resp['ips']).each { |ip| ips.push(ip) }
-          Pool.new(resp['pool_name'], resp['name'], ips)
-        end
+      def self.create_pool(resp)
+        return resp if resp.nil?
+        Pool.new(resp['pool_name'], resp['name'], resp['ips'])
+      end
 
-        def self.url(name = nil, ips = nil, ip = nil)
-          url = "#{BASE_URL}/ips/pools"
-          url = "#{url}/#{name}" unless name.nil?
-          url = "#{url}/#{ips}" unless ips.nil?
-          url = "#{url}/#{ip}" unless ip.nil?
-          url
-        end
+      def self.url(name = nil, ips = nil, ip = nil)
+        url = "#{BASE_URL}/ips/pools"
+        url = "#{url}/#{name}" unless name.nil?
+        url = "#{url}/#{ips}" unless ips.nil?
+        url = "#{url}/#{ip}" unless ip.nil?
+        url
+      end
 
-        def post_pool(name:, &block)
-          endpoint = SendGrid4r::REST::Ips::Pools.url
-          resp = post(@auth, endpoint, name: name, &block)
-          SendGrid4r::REST::Ips::Pools.create_pool(resp)
-        end
+      def post_pool(name:, &block)
+        resp = post(@auth, Ips::Pools.url, name: name, &block)
+        Ips::Pools.create_pool(resp)
+      end
 
-        def get_pools(&block)
-          resp = get(@auth, SendGrid4r::REST::Ips::Pools.url, &block)
-          SendGrid4r::REST::Ips::Pools.create_pools(resp)
-        end
+      def get_pools(&block)
+        resp = get(@auth, Ips::Pools.url, &block)
+        Ips::Pools.create_pools(resp)
+      end
 
-        def get_pool(name:, &block)
-          endpoint = SendGrid4r::REST::Ips::Pools.url(name)
-          resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Ips::Pools.create_pool(resp)
-        end
+      def get_pool(name:, &block)
+        resp = get(@auth, Ips::Pools.url(name), &block)
+        Ips::Pools.create_pool(resp)
+      end
 
-        def put_pool(name:, new_name:, &block)
-          endpoint = SendGrid4r::REST::Ips::Pools.url(name)
-          resp = put(@auth, endpoint, name: new_name, &block)
-          SendGrid4r::REST::Ips::Pools.create_pool(resp)
-        end
+      def put_pool(name:, new_name:, &block)
+        resp = put(@auth, Ips::Pools.url(name), name: new_name, &block)
+        Ips::Pools.create_pool(resp)
+      end
 
-        def delete_pool(name:, &block)
-          delete(@auth, SendGrid4r::REST::Ips::Pools.url(name), &block)
-        end
+      def delete_pool(name:, &block)
+        delete(@auth, Ips::Pools.url(name), &block)
       end
     end
   end

data/lib/sendgrid4r/rest/ips/warmup.rb

@@ -1,60 +1,51 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    module Ips
-      #
-      # SendGrid Web API v3 Ip Management - Warmup
-      #
-      module Warmup
-        include SendGrid4r::REST::Request
-
-        WarmupIp = Struct.new(:ip, :start_date)
-
-        def self.create_warmup_ips(resp)
-          return resp if resp.nil?
-          ips = []
-          resp.each do |warmup_ip|
-            ips.push(SendGrid4r::REST::Ips::Warmup.create_warmup_ip(warmup_ip))
-          end
-          ips
-        end
-
-        def self.create_warmup_ip(resp)
-          return resp if resp.nil?
-          WarmupIp.new(
-            resp['ip'],
-            resp['start_date'].nil? ? nil : Time.at(resp['start_date'])
-          )
-        end
-
-        def self.url(ip_address = nil)
-          url = "#{BASE_URL}/ips/warmup"
-          url = "#{url}/#{ip_address}" unless ip_address.nil?
-          url
-        end
-
-        def get_warmup_ips(&block)
-          resp = get(@auth, SendGrid4r::REST::Ips::Warmup.url, &block)
-          SendGrid4r::REST::Ips::Warmup.create_warmup_ips(resp)
-        end
-
-        def get_warmup_ip(ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Warmup.url(ip)
-          resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
-        end
-
-        def post_warmup_ip(ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Warmup.url
-          resp = post(@auth, endpoint, ip: ip, &block)
-          SendGrid4r::REST::Ips::Warmup.create_warmup_ip(resp)
-        end
-
-        def delete_warmup_ip(ip:, &block)
-          endpoint = SendGrid4r::REST::Ips::Warmup.url(ip)
-          delete(@auth, endpoint, &block)
-        end
+module SendGrid4r::REST
+  module Ips
+    #
+    # SendGrid Web API v3 Ip Management - Warmup
+    #
+    module Warmup
+      include Request
+
+      WarmupIp = Struct.new(:ip, :start_date)
+
+      def self.create_warmup_ips(resp)
+        return resp if resp.nil?
+        resp.map { |warmup_ip| Ips::Warmup.create_warmup_ip(warmup_ip) }
+      end
+
+      def self.create_warmup_ip(resp)
+        return resp if resp.nil?
+        WarmupIp.new(
+          resp['ip'],
+          resp['start_date'].nil? ? nil : Time.at(resp['start_date'])
+        )
+      end
+
+      def self.url(ip_address = nil)
+        url = "#{BASE_URL}/ips/warmup"
+        url = "#{url}/#{ip_address}" unless ip_address.nil?
+        url
+      end
+
+      def get_warmup_ips(&block)
+        resp = get(@auth, Ips::Warmup.url, &block)
+        Ips::Warmup.create_warmup_ips(resp)
+      end
+
+      def get_warmup_ip(ip:, &block)
+        resp = get(@auth, Ips::Warmup.url(ip), &block)
+        Ips::Warmup.create_warmup_ip(resp)
+      end
+
+      def post_warmup_ip(ip:, &block)
+        resp = post(@auth, Ips::Warmup.url, ip: ip, &block)
+        Ips::Warmup.create_warmup_ip(resp)
+      end
+
+      def delete_warmup_ip(ip:, &block)
+        delete(@auth, Ips::Warmup.url(ip), &block)
       end
     end
   end

data/lib/sendgrid4r/rest/mail/address.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    Address = Struct.new(:email, :name) do
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/attachment.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+require 'base64'
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    Attachment = Struct.new(
+      :content, :filename, :type, :disposition, :content_id
+    ) do
+      def content=(content)
+        tap { |s| s[:content] = Base64.strict_encode64(content) }
+      end
+
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/content.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    Content = Struct.new(:type, :value)
+  end
+end

data/lib/sendgrid4r/rest/mail/mail.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    include Request
+
+    def self.url
+      "#{BASE_URL}/mail/send/beta"
+    end
+
+    def self.warn_beta
+      warn(
+        '[WARN] Mail endpoint is currently in beta! Do not use '\
+        'this method in production. When this endpoint is ready for '\
+        'general release, your code might require an update in order to '\
+        'use the official one.'
+      )
+    end
+
+    def send(params:, &block)
+      Mail.warn_beta
+      post(@auth, Mail.url, params.to_h, &block)
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/mail_settings.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    MailSettings = Struct.new(
+      :bcc, :bypass_list_management, :footer, :sandbox_mode, :spam_check
+    ) do
+      def enable_bcc(email)
+        tap { |s| s[:bcc] = { enable: true, email: email } }
+      end
+
+      def disable_bcc
+        tap { |s| s[:bcc] = { enable: false } }
+      end
+
+      def enable_bypass_list_management
+        tap { |s| s[:bypass_list_management] = { enable: true } }
+      end
+
+      def disable_bypass_list_management
+        tap { |s| s[:bypass_list_management] = { enable: false } }
+      end
+
+      def enable_footer(text, html)
+        tap { |s| s[:footer] = { enable: true, text: text, html: html } }
+      end
+
+      def disable_footer
+        tap { |s| s[:footer] = { enable: false } }
+      end
+
+      def enable_sandbox_mode
+        tap { |s| s[:sandbox_mode] = { enable: true } }
+      end
+
+      def disable_sandbox_mode
+        tap { |s| s[:sandbox_mode] = { enable: false } }
+      end
+
+      def enable_spam_check(threshold, post_to_url)
+        tap do |s|
+          s[:spam_check] = {
+            enable: true,
+            threshold: threshold,
+            post_to_url: post_to_url
+          }
+        end
+      end
+
+      def disable_spam_check
+        tap { |s| s[:spam_check] = { enable: false } }
+      end
+
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/params.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    Params = Struct.new(
+      :personalizations, :from, :content, :reply_to, :attachments,
+      :template_id, :sections, :headers, :categories, :custom_args,
+      :send_at, :batch_id, :asm, :ip_pool_name, :mail_settings,
+      :tracking_settings, :subject
+    ) do
+      def personalizations=(personalizations)
+        tap do |s|
+          s[:personalizations] = personalizations.map(&:to_h)
+        end
+      end
+
+      def from=(from)
+        tap { |s| s[:from] = from.to_h }
+      end
+
+      def content=(content)
+        tap { |s| s[:content] = content.map(&:to_h) }
+      end
+
+      def reply_to=(reply_to)
+        tap { |s| s[:reply_to] = reply_to.to_h }
+      end
+
+      def attachments=(attachments)
+        tap { |s| s[:attachments] = attachments.map(&:to_h) }
+      end
+
+      def send_at=(send_at)
+        tap { |s| s[:send_at] = send_at.to_i }
+      end
+
+      def asm=(asm)
+        if asm.is_a?(Fixnum)
+          tap { |s| s[:asm] = { group_id: asm } }
+        elsif asm.is_a?(Array)
+          tap do |s|
+            s[:asm] = { group_id: asm[0] }
+            s[:asm][:groups_to_display] = asm[1]
+          end
+        end
+      end
+
+      def mail_settings=(mail_settings)
+        tap { |s| s[:mail_settings] = mail_settings.to_h }
+      end
+
+      def tracking_settings=(tracking_settings)
+        tap { |s| s[:tracking_settings] = tracking_settings.to_h }
+      end
+
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/personalization.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    Personalization = Struct.new(
+      :to, :subject, :cc, :bcc, :headers, :substitutions, :custom_args,
+      :send_at
+    ) do
+      def to=(to)
+        tap { |s| s[:to] = to.map(&:to_h) }
+      end
+
+      def cc=(cc)
+        tap { |s| s[:cc] = cc.map(&:to_h) }
+      end
+
+      def bcc=(bcc)
+        tap { |s| s[:bcc] = bcc.map(&:to_h) }
+      end
+
+      def send_at=(send_at)
+        tap { |s| s[:send_at] = send_at.to_i }
+      end
+
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/mail/tracking_settings.rb

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Mail
+  #
+  module Mail
+    TrackingSettings = Struct.new(
+      :click_tracking, :open_tracking, :subscription_tracking,
+      :ganalytics
+    ) do
+      def enable_click_tracking(enable_text)
+        tap do |s|
+          s[:click_tracking] = { enable: true, enable_text: enable_text }
+        end
+      end
+
+      def disable_click_tracking
+        tap { |s| s[:click_tracking] = { enable: false } }
+      end
+
+      def enable_open_tracking(substitution_tag)
+        tap do |s|
+          s[:open_tracking] = {
+            enable: true,
+            substitution_tag: substitution_tag
+          }
+        end
+      end
+
+      def disable_open_tracking
+        tap { |s| s[:open_tracking] = { enable: false } }
+      end
+
+      def enable_subscription_tracking(text, html, substitution_tag)
+        tap do |s|
+          s[:subscription_tracking] = {
+            enable: true,
+            text: text,
+            html: html,
+            substitution_tag: substitution_tag
+          }
+        end
+      end
+
+      def disable_subscription_tracking
+        tap { |s| s[:subscription_tracking] = { enable: false } }
+      end
+
+      def enable_ganalytics(
+        utm_source, utm_medium, utm_term, utm_content, utm_campaign
+      )
+        tap do |s|
+          s[:ganalytics] = {
+            enable: true,
+            utm_source: utm_source,
+            utm_medium: utm_medium,
+            utm_term: utm_term,
+            utm_content: utm_content,
+            utm_campaign: utm_campaign
+          }
+        end
+      end
+
+      def disable_ganalytics
+        tap { |s| s[:ganalytics] = { enable: false } }
+      end
+
+      def to_h
+        super.reject { |_key, value| value.nil? }
+      end
+    end
+  end
+end