sendgrid4r 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da33e4bfff93975445c5df1a4bc2d57f81aefef7
-  data.tar.gz: 89f466b9e9bc465e2556097b97f48cc4e2f6c152
+  metadata.gz: 4970f1d3bba5b4f0f5efe8267f7d8b339d50dba4
+  data.tar.gz: f3d6096eb69342dcb0b4d565e159263c588d5847
 SHA512:
-  metadata.gz: 67f7b15b77bca858a933297bb46e3983ac6603623be4fa050f3972e5877facd3126a3a18ed3e855a5388cac43cc7ee9366b8e6a61c9319ed2bad5fc8ead801c6
-  data.tar.gz: d740abe0a3629826d8f97d503daecb2325b51f53a63c712b0623c67e91ec5f76ee15800f662a90fe10f1a78bd76c04ad42d051479d4525474c454f7d0631d3f1
+  metadata.gz: f4f68701e16a3531a93b5c61adf659ef0da529eeb9df397d3cf3542baf728511394d6aeb8c66e63b13d24ed37d7914277ada11d56717566ff19f8e282826fd34
+  data.tar.gz: 8e13f566ebc9b52bae2d664756ddf8f8eddb496e4b4294c95d9f1216673f067fae2f783b6166eca892127bc64ca4df676ce8c8978c65d1d4cfeccb6802fcf326

data/lib/sendgrid4r/rest/api.rb

@@ -8,10 +8,10 @@ module SendGrid4r
     module API
       include SendGrid4r::REST::Templates
       include SendGrid4r::REST::Templates::Versions
-      include SendGrid4r::REST::Asm
-      include SendGrid4r::REST::Asm::Groups
-      include SendGrid4r::REST::Asm::Suppressions
-      include SendGrid4r::REST::Asm::GlobalSuppressions
+      include SendGrid4r::REST::Sm
+      include SendGrid4r::REST::Sm::Groups
+      include SendGrid4r::REST::Sm::Suppressions
+      include SendGrid4r::REST::Sm::GlobalUnsubscribes
       include SendGrid4r::REST::Settings
       include SendGrid4r::REST::Settings::EnforcedTls
       include SendGrid4r::REST::Settings::Mail
@@ -41,6 +41,9 @@ module SendGrid4r
       include SendGrid4r::REST::Whitelabel::Links
       include SendGrid4r::REST::Users
       include SendGrid4r::REST::Bounces
+      include SendGrid4r::REST::Blocks
+      include SendGrid4r::REST::InvalidEmails
+      include SendGrid4r::REST::SpamReports
       include SendGrid4r::REST::CancelScheduledSends
       include SendGrid4r::REST::Webhooks::Event
       include SendGrid4r::REST::Webhooks::Parse

data/lib/sendgrid4r/rest/blocks.rb

@@ -0,0 +1,80 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Blocks
+    #
+    module Blocks
+      include SendGrid4r::REST::Request
+
+      Block = Struct.new(
+        :created, :email, :reason, :status
+      )
+
+      def self.url(email = nil)
+        url = "#{BASE_URL}/suppression/blocks"
+        url = "#{url}/#{email}" unless email.nil?
+        url
+      end
+
+      def self.create_blocks(resp)
+        return resp if resp.nil?
+        blocks = []
+        resp.each do |block|
+          blocks.push(SendGrid4r::REST::Blocks.create_block(block))
+        end
+        blocks
+      end
+
+      def self.create_block(resp)
+        return resp if resp.nil?
+        created = Time.at(resp['created']) unless resp['created'].nil?
+        Block.new(
+          created,
+          resp['email'],
+          resp['reason'],
+          resp['status']
+        )
+      end
+
+      def get_blocks(
+        start_time: nil, end_time: nil, limit: nil, offset: nil, &block
+      )
+        params = {}
+        params['start_time'] = start_time.to_i unless start_time.nil?
+        params['end_time'] = end_time.to_i unless end_time.nil?
+        params['limit'] = limit.to_i unless limit.nil?
+        params['offset'] = offset.to_i unless offset.nil?
+        resp = get(@auth, SendGrid4r::REST::Blocks.url, params, &block)
+        SendGrid4r::REST::Blocks.create_blocks(resp)
+      end
+
+      def delete_blocks(delete_all: nil, emails: nil, &block)
+        endpoint = SendGrid4r::REST::Blocks.url
+        payload = {}
+        if delete_all == true
+          payload['delete_all'] = delete_all
+        else
+          payload['emails'] = emails
+        end
+        delete(@auth, endpoint, nil, payload, &block)
+      end
+
+      def get_block(email:, &block)
+        endpoint = SendGrid4r::REST::Blocks.url(email)
+        params = {}
+        params['email'] = email
+        resp = get(@auth, endpoint, params, &block)
+        SendGrid4r::REST::Blocks.create_blocks(resp)
+      end
+
+      def delete_block(email:, &block)
+        endpoint = SendGrid4r::REST::Blocks.url(email)
+        params = {}
+        params['email'] = email
+        delete(@auth, endpoint, params, &block)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/invalid_emails.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 InvalidEmails
+    #
+    module InvalidEmails
+      include SendGrid4r::REST::Request
+
+      InvalidEmail = Struct.new(
+        :created, :email, :reason
+      )
+
+      def self.url(email = nil)
+        url = "#{BASE_URL}/suppression/invalid_emails"
+        url = "#{url}/#{email}" unless email.nil?
+        url
+      end
+
+      def self.create_invalid_emails(resp)
+        return resp if resp.nil?
+        invalid_emails = []
+        resp.each do |invalid_email|
+          invalid_emails.push(
+            SendGrid4r::REST::InvalidEmails.create_invalid_email(invalid_email)
+          )
+        end
+        invalid_emails
+      end
+
+      def self.create_invalid_email(resp)
+        return resp if resp.nil?
+        created = Time.at(resp['created']) unless resp['created'].nil?
+        InvalidEmail.new(
+          created,
+          resp['email'],
+          resp['reason']
+        )
+      end
+
+      def get_invalid_emails(
+        start_time: nil, end_time: nil, limit: nil, offset: nil, &block
+      )
+        params = {}
+        params['start_time'] = start_time.to_i unless start_time.nil?
+        params['end_time'] = end_time.to_i unless end_time.nil?
+        params['limit'] = limit.to_i unless limit.nil?
+        params['offset'] = offset.to_i unless offset.nil?
+        resp = get(@auth, SendGrid4r::REST::InvalidEmails.url, params, &block)
+        SendGrid4r::REST::InvalidEmails.create_invalid_emails(resp)
+      end
+
+      def delete_invalid_emails(delete_all: nil, emails: nil, &block)
+        endpoint = SendGrid4r::REST::InvalidEmails.url
+        payload = {}
+        if delete_all == true
+          payload['delete_all'] = delete_all
+        else
+          payload['emails'] = emails
+        end
+        delete(@auth, endpoint, nil, payload, &block)
+      end
+
+      def get_invalid_email(email:, &block)
+        endpoint = SendGrid4r::REST::InvalidEmails.url(email)
+        params = {}
+        params['email'] = email
+        resp = get(@auth, endpoint, params, &block)
+        SendGrid4r::REST::InvalidEmails.create_invalid_emails(resp)
+      end
+
+      def delete_invalid_email(email:, &block)
+        endpoint = SendGrid4r::REST::InvalidEmails.url(email)
+        params = {}
+        params['email'] = email
+        delete(@auth, endpoint, params, &block)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/sm/global_unsubscribes.rb

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module REST
+    module Sm
+      #
+      # SendGrid Web API v3 Suppression Management - Global Unsubscribes
+      #
+      module GlobalUnsubscribes
+        include SendGrid4r::REST::Request
+
+        Unsubscribe = Struct.new(:created, :email)
+
+        def self.url(email_address = nil)
+          url = "#{BASE_URL}/asm/suppressions/global"
+          url = "#{url}/#{email_address}" unless email_address.nil?
+          url
+        end
+
+        def self.url_unsubscribes
+          "#{BASE_URL}/suppression/unsubscribes"
+        end
+
+        def self.create_supressions(resp)
+          return resp if resp.nil?
+          suppressions = []
+          resp.each do |suppression|
+            created = Time.at(suppression['created'])
+            suppressions.push(Unsubscribe.new(created, suppression['email']))
+          end
+          suppressions
+        end
+
+        def get_global_unsubscribes(
+          start_time: nil, end_time: nil, limit: nil, offset: nil, &block
+        )
+          params = {}
+          params['start_time'] = start_time.to_i unless start_time.nil?
+          params['end_time'] = end_time.to_i unless end_time.nil?
+          params['limit'] = limit.to_i unless limit.nil?
+          params['offset'] = offset.to_i unless offset.nil?
+          endpoint = SendGrid4r::REST::Sm::GlobalUnsubscribes.url_unsubscribes
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Sm::GlobalUnsubscribes.create_supressions(resp)
+        end
+
+        def post_global_suppressed_emails(recipient_emails:, &block)
+          params = { recipient_emails: recipient_emails }
+          endpoint = SendGrid4r::REST::Sm::GlobalUnsubscribes.url
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Sm.create_recipient_emails(resp)
+        end
+
+        def get_global_suppressed_email(email_address:, &block)
+          endpoint =
+            SendGrid4r::REST::Sm::GlobalUnsubscribes.url(email_address)
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Sm.create_recipient_email(resp)
+        end
+
+        def delete_global_suppressed_email(email_address:, &block)
+          endpoint =
+            SendGrid4r::REST::Sm::GlobalUnsubscribes.url(email_address)
+          delete(@auth, endpoint, &block)
+        end
+
+        alias_method(:post_global_unsubscribes, :post_global_suppressed_emails)
+        alias_method(:get_global_unsubscribe, :get_global_suppressed_email)
+        alias_method(
+          :delete_global_unsubscribe, :delete_global_suppressed_email
+        )
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/{asm → sm}/groups.rb

@@ -2,9 +2,9 @@
 
 module SendGrid4r
   module REST
-    module Asm
+    module Sm
       #
-      # SendGrid Web API v3 Advanced Suppression Manager - Groups
+      # SendGrid Web API v3 Suppression Management - Groups
       #
       module Groups
         include SendGrid4r::REST::Request
@@ -24,7 +24,7 @@ module SendGrid4r
           return resp if resp.nil?
           groups = []
           resp.each do |group|
-            groups.push(SendGrid4r::REST::Asm::Groups.create_group(group))
+            groups.push(SendGrid4r::REST::Sm::Groups.create_group(group))
           end
           groups
         end
@@ -44,28 +44,28 @@ module SendGrid4r
         def post_group(name:, description:, is_default: nil, &block)
           params = { name: name, description: description }
           params['is_default'] = is_default unless is_default.nil?
-          resp = post(@auth, SendGrid4r::REST::Asm::Groups.url, params, &block)
-          SendGrid4r::REST::Asm::Groups.create_group(resp)
+          resp = post(@auth, SendGrid4r::REST::Sm::Groups.url, params, &block)
+          SendGrid4r::REST::Sm::Groups.create_group(resp)
         end
 
         def get_groups(&block)
-          resp = get(@auth, SendGrid4r::REST::Asm::Groups.url, &block)
-          SendGrid4r::REST::Asm::Groups.create_groups(resp)
+          resp = get(@auth, SendGrid4r::REST::Sm::Groups.url, &block)
+          SendGrid4r::REST::Sm::Groups.create_groups(resp)
         end
 
         def get_group(group_id:, &block)
-          resp = get(@auth, SendGrid4r::REST::Asm::Groups.url(group_id), &block)
-          SendGrid4r::REST::Asm::Groups.create_group(resp)
+          resp = get(@auth, SendGrid4r::REST::Sm::Groups.url(group_id), &block)
+          SendGrid4r::REST::Sm::Groups.create_group(resp)
         end
 
         def patch_group(group_id:, group:, &block)
-          endpoint = SendGrid4r::REST::Asm::Groups.url(group_id)
+          endpoint = SendGrid4r::REST::Sm::Groups.url(group_id)
           resp = patch(@auth, endpoint, group.to_h, &block)
-          SendGrid4r::REST::Asm::Groups.create_group(resp)
+          SendGrid4r::REST::Sm::Groups.create_group(resp)
         end
 
         def delete_group(group_id:, &block)
-          delete(@auth, SendGrid4r::REST::Asm::Groups.url(group_id), &block)
+          delete(@auth, SendGrid4r::REST::Sm::Groups.url(group_id), &block)
         end
       end
     end

data/lib/sendgrid4r/rest/{asm/asm.rb → sm/sm.rb}

@@ -3,9 +3,9 @@
 module SendGrid4r
   module REST
     #
-    # SendGrid Web API v3 Advanced Suppression Manager
+    # SendGrid Web API v3 Suppression Management
     #
-    module Asm
+    module Sm
       include SendGrid4r::REST::Request
 
       RecipientEmails = Struct.new(:recipient_emails)

data/lib/sendgrid4r/rest/{asm → sm}/suppressions.rb

@@ -2,9 +2,9 @@
 
 module SendGrid4r
   module REST
-    module Asm
+    module Sm
       #
-      # SendGrid Web API v3 Advanced Suppression Manager - Suppressions
+      # SendGrid Web API v3 Suppression Management - Suppressions
       #
       module Suppressions
         include SendGrid4r::REST::Request
@@ -23,7 +23,7 @@ module SendGrid4r
           suppressions = []
           resp['suppressions'].each do |suppression|
             suppressions.push(
-              SendGrid4r::REST::Asm::Suppressions.create_suppression(
+              SendGrid4r::REST::Sm::Suppressions.create_suppression(
                 suppression
               )
             )
@@ -50,29 +50,29 @@ module SendGrid4r
         def post_suppressed_emails(group_id:, recipient_emails:, &block)
           resp = post(
             @auth,
-            SendGrid4r::REST::Asm::Suppressions.url(group_id),
+            SendGrid4r::REST::Sm::Suppressions.url(group_id),
             recipient_emails: recipient_emails,
             &block
           )
-          SendGrid4r::REST::Asm.create_recipient_emails(resp)
+          SendGrid4r::REST::Sm.create_recipient_emails(resp)
         end
 
         def get_suppressed_emails(group_id:, &block)
-          endpoint = SendGrid4r::REST::Asm::Suppressions.url(group_id)
+          endpoint = SendGrid4r::REST::Sm::Suppressions.url(group_id)
           resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Asm::Suppressions.create_emails(resp)
+          SendGrid4r::REST::Sm::Suppressions.create_emails(resp)
         end
 
         def get_suppressions(email_address:, &block)
           endpoint = "#{BASE_URL}/asm/suppressions/#{email_address}"
           resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Asm::Suppressions.create_suppressions(resp)
+          SendGrid4r::REST::Sm::Suppressions.create_suppressions(resp)
         end
 
         def delete_suppressed_email(group_id:, email_address:, &block)
           delete(
             @auth,
-            SendGrid4r::REST::Asm::Suppressions.url(group_id, email_address),
+            SendGrid4r::REST::Sm::Suppressions.url(group_id, email_address),
             &block
           )
         end

data/lib/sendgrid4r/rest/spam_reports.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 SpamReports
+    #
+    module SpamReports
+      include SendGrid4r::REST::Request
+
+      SpamReport = Struct.new(
+        :created, :email, :ip
+      )
+
+      def self.url(email = nil)
+        url = "#{BASE_URL}/suppression/spam_reports"
+        url = "#{url}/#{email}" unless email.nil?
+        url
+      end
+
+      def self.create_spam_reports(resp)
+        return resp if resp.nil?
+        spam_reports = []
+        resp.each do |spam_report|
+          spam_reports.push(
+            SendGrid4r::REST::SpamReports.create_spam_report(spam_report)
+          )
+        end
+        spam_reports
+      end
+
+      def self.create_spam_report(resp)
+        return resp if resp.nil?
+        created = Time.at(resp['created']) unless resp['created'].nil?
+        SpamReport.new(
+          created,
+          resp['email'],
+          resp['ip']
+        )
+      end
+
+      def get_spam_reports(
+        start_time: nil, end_time: nil, limit: nil, offset: nil, &block
+      )
+        params = {}
+        params['start_time'] = start_time.to_i unless start_time.nil?
+        params['end_time'] = end_time.to_i unless end_time.nil?
+        params['limit'] = limit.to_i unless limit.nil?
+        params['offset'] = offset.to_i unless offset.nil?
+        resp = get(@auth, SendGrid4r::REST::SpamReports.url, params, &block)
+        SendGrid4r::REST::SpamReports.create_spam_reports(resp)
+      end
+
+      def delete_spam_reports(delete_all: nil, emails: nil, &block)
+        endpoint = SendGrid4r::REST::SpamReports.url
+        payload = {}
+        if delete_all == true
+          payload['delete_all'] = delete_all
+        else
+          payload['emails'] = emails
+        end
+        delete(@auth, endpoint, nil, payload, &block)
+      end
+
+      def get_spam_report(email:, &block)
+        endpoint = SendGrid4r::REST::SpamReports.url(email)
+        params = {}
+        params['email'] = email
+        resp = get(@auth, endpoint, params, &block)
+        SendGrid4r::REST::SpamReports.create_spam_reports(resp)
+      end
+
+      def delete_spam_report(email:, &block)
+        endpoint = SendGrid4r::REST::SpamReports.url(email)
+        params = {}
+        params['email'] = email
+        delete(@auth, endpoint, params, &block)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/version.rb

@@ -2,5 +2,5 @@
 # SendGrid API v3 wrapper implementation.
 #
 module SendGrid4r
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/lib/sendgrid4r.rb

@@ -12,12 +12,15 @@ require 'sendgrid4r/rest/templates/versions'
 require 'sendgrid4r/rest/api_keys/api_keys'
 require 'sendgrid4r/rest/api_keys/permissions'
 
-require 'sendgrid4r/rest/asm/asm'
-require 'sendgrid4r/rest/asm/global_suppressions'
-require 'sendgrid4r/rest/asm/groups'
-require 'sendgrid4r/rest/asm/suppressions'
+require 'sendgrid4r/rest/sm/sm'
+require 'sendgrid4r/rest/sm/global_unsubscribes'
+require 'sendgrid4r/rest/sm/groups'
+require 'sendgrid4r/rest/sm/suppressions'
 
 require 'sendgrid4r/rest/bounces'
+require 'sendgrid4r/rest/blocks'
+require 'sendgrid4r/rest/invalid_emails'
+require 'sendgrid4r/rest/spam_reports'
 require 'sendgrid4r/rest/cancel_scheduled_sends'
 
 require 'sendgrid4r/rest/campaigns/campaigns'

data/spec/client_spec.rb

@@ -45,7 +45,7 @@ describe SendGrid4r::Client do
         expect(@client.respond_to?('post_api_key')).to eq(true)
         expect(@client.respond_to?('delete_api_key')).to eq(true)
         expect(@client.respond_to?('patch_api_key')).to eq(true)
-        # Advanced Suppression Manager
+        # Suppression Management
         # groups
         expect(@client.respond_to?('get_groups')).to eq(true)
         expect(@client.respond_to?('get_group')).to eq(true)
@@ -57,7 +57,12 @@ describe SendGrid4r::Client do
         expect(@client.respond_to?('get_suppressions')).to eq(true)
         expect(@client.respond_to?('get_suppressed_emails')).to eq(true)
         expect(@client.respond_to?('delete_suppressed_email')).to eq(true)
-        # global suppressions
+        # global unsubscribes
+        expect(@client.respond_to?('get_global_unsubscribes')).to eq(true)
+        expect(@client.respond_to?('post_global_unsubscribes')).to eq(true)
+        expect(@client.respond_to?('get_global_unsubscribe')).to eq(true)
+        expect(@client.respond_to?('delete_global_unsubscribe')).to eq(true)
+        # deprecated
         expect(@client.respond_to?('post_global_suppressed_emails')).to eq(true)
         expect(@client.respond_to?('get_global_suppressed_email')).to eq(true)
         expect(
@@ -259,6 +264,24 @@ describe SendGrid4r::Client do
         expect(@client.respond_to?('get_bounce')).to eq(true)
         expect(@client.respond_to?('delete_bounce')).to eq(true)
 
+        # Blocks API
+        expect(@client.respond_to?('get_blocks')).to eq(true)
+        expect(@client.respond_to?('delete_blocks')).to eq(true)
+        expect(@client.respond_to?('get_block')).to eq(true)
+        expect(@client.respond_to?('delete_block')).to eq(true)
+
+        # Invalid Emails API
+        expect(@client.respond_to?('get_invalid_emails')).to eq(true)
+        expect(@client.respond_to?('delete_invalid_emails')).to eq(true)
+        expect(@client.respond_to?('get_invalid_email')).to eq(true)
+        expect(@client.respond_to?('delete_invalid_email')).to eq(true)
+
+        # Spam Reports API
+        expect(@client.respond_to?('get_spam_reports')).to eq(true)
+        expect(@client.respond_to?('delete_spam_reports')).to eq(true)
+        expect(@client.respond_to?('get_spam_report')).to eq(true)
+        expect(@client.respond_to?('delete_spam_report')).to eq(true)
+
         # Cancel Scheduled Sends Api
         expect(@client.respond_to?('generate_batch_id')).to eq(true)
         expect(@client.respond_to?('validate_batch_id')).to eq(true)
@@ -290,7 +313,7 @@ describe SendGrid4r::Client do
 
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('1.6.0')
+        expect(SendGrid4r::VERSION).to eq('1.7.0')
       end
     end
   end