sendgrid4r 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f917e5bad6e118fb4038ed40d03c754cf0c47a29
-  data.tar.gz: 36b3c7f7bf0a50841a9a6970c017f76d41669c67
+  metadata.gz: b3ee86e446ae380f740a78f1e87062d7bb5db054
+  data.tar.gz: a8a4dfe52c631a858531cab5de61435f13e11b0e
 SHA512:
-  metadata.gz: e58bdc185eee38e7a8e07a9ab6720639e65d20fb4484e8ab98b94223a9b100f210bd5cc47be5adc76c58bcc3fe0c4702e898b3e611aa98102a1706fe39f11bc5
-  data.tar.gz: fde6e1b9d2abf15276d6f700a2d169c583752c73b946b364aabb3bdd30f1cabbb5f6564cf7d3756383d3bbaffa33ff3078d246115af1ab02e8e1edc6901d3cfe
+  metadata.gz: f2a14376adeaf79d4297555e52bf4547759990bdfd4ed69f4ff4ba6270361f0cfc76e33ed59e57930a912dd44d6672b5172c0f8a30f613e036a2ce1e02581821
+  data.tar.gz: d33323175ab7e3beee707805ef572f3e5ec461670412ae22760c2f88625102bd4688c01554eb73eada984f51be19904eb4e324b439175e721d8992fc2f321aff

data/lib/sendgrid4r/rest/api.rb

@@ -29,12 +29,14 @@ require 'sendgrid4r/rest/contacts/reserved_fields'
 require 'sendgrid4r/rest/contacts/segments'
 require 'sendgrid4r/rest/campaigns/campaigns'
 require 'sendgrid4r/rest/api_keys/api_keys'
-require 'sendgrid4r/rest/subusers/subusers'
+require 'sendgrid4r/rest/subusers'
 require 'sendgrid4r/rest/email_activity/email_activity'
 require 'sendgrid4r/rest/whitelabel/domains'
 require 'sendgrid4r/rest/whitelabel/ips'
 require 'sendgrid4r/rest/whitelabel/links'
-require 'sendgrid4r/rest/users/users'
+require 'sendgrid4r/rest/users'
+require 'sendgrid4r/rest/bounces'
+require 'sendgrid4r/rest/cancel_scheduled_sends'
 
 module SendGrid4r
   module REST
@@ -75,6 +77,8 @@ module SendGrid4r
       include SendGrid4r::REST::Whitelabel::Ips
       include SendGrid4r::REST::Whitelabel::Links
       include SendGrid4r::REST::Users
+      include SendGrid4r::REST::Bounces
+      include SendGrid4r::REST::CancelScheduledSends
     end
   end
 end

data/lib/sendgrid4r/rest/asm/groups.rb

@@ -13,7 +13,7 @@ module SendGrid4r
         include SendGrid4r::REST::Request
 
         Group = Struct.new(
-          :id, :name, :description, :last_email_sent_at, :unsubscribes)
+          :id, :name, :description, :unsubscribes)
 
         def self.url(group_id = nil)
           url = "#{BASE_URL}/asm/groups"
@@ -36,7 +36,6 @@ module SendGrid4r
             resp['id'],
             resp['name'],
             resp['description'],
-            resp['last_email_sent_at'],
             resp['unsubscribes']
           )
         end

data/lib/sendgrid4r/rest/bounces.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Subusers
+    #
+    module Bounces
+      include SendGrid4r::REST::Request
+
+      Bounce = Struct.new(
+        :created, :email, :reason, :status
+      )
+
+      def self.url(email = nil)
+        url = "#{BASE_URL}/suppression/bounces"
+        url = "#{url}/#{email}" unless email.nil?
+        url
+      end
+
+      def self.create_bounces(resp)
+        return resp if resp.nil?
+        bounces = []
+        resp.each do |bounce|
+          bounces.push(SendGrid4r::REST::Bounces.create_bounce(bounce))
+        end
+        bounces
+      end
+
+      def self.create_bounce(resp)
+        return resp if resp.nil?
+        created = Time.at(resp['created']) unless resp['created'].nil?
+        Bounce.new(
+          created,
+          resp['email'],
+          resp['reason'],
+          resp['status']
+        )
+      end
+
+      def get_bounces(start_time: nil, end_time: 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?
+        resp = get(@auth, SendGrid4r::REST::Bounces.url, params, &block)
+        SendGrid4r::REST::Bounces.create_bounces(resp)
+      end
+
+      def delete_bounces(delete_all: nil, emails: nil, &block)
+        endpoint = SendGrid4r::REST::Bounces.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_bounce(email:, &block)
+        endpoint = SendGrid4r::REST::Bounces.url(email)
+        params = {}
+        params['email'] = email
+        resp = get(@auth, endpoint, params, &block)
+        SendGrid4r::REST::Bounces.create_bounces(resp)
+      end
+
+      def delete_bounce(email:, &block)
+        endpoint = SendGrid4r::REST::Bounces.url(email)
+        params = {}
+        params['email'] = email
+        delete(@auth, endpoint, params, &block)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/cancel_scheduled_sends.rb

@@ -0,0 +1,92 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 CancelScheduledSends
+    #
+    module CancelScheduledSends
+      include SendGrid4r::REST::Request
+
+      ScheduledSend = Struct.new(:batch_id, :status)
+
+      def self.batch_url(batch_id = nil)
+        url = "#{BASE_URL}/mail/batch"
+        url = "#{url}/#{batch_id}" unless batch_id.nil?
+        url
+      end
+
+      def self.scheduled_sends_url(batch_id = nil)
+        url = "#{BASE_URL}/user/scheduled_sends"
+        url = "#{url}/#{batch_id}" unless batch_id.nil?
+        url
+      end
+
+      def self.create_scheduled_sends(resp)
+        return resp if resp.nil?
+        scheduled_sends = []
+        resp.each do |scheduled_send|
+          scheduled_sends.push(
+            SendGrid4r::REST::CancelScheduledSends.create_scheduled_send(
+              scheduled_send
+            )
+          )
+        end
+        scheduled_sends
+      end
+
+      def self.create_scheduled_send(resp)
+        return resp if resp.nil?
+        ScheduledSend.new(resp['batch_id'], resp['status'])
+      end
+
+      def generate_batch_id(&block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.batch_url
+        resp = post(@auth, endpoint, nil, &block)
+        SendGrid4r::REST::CancelScheduledSends.create_scheduled_send(resp)
+      end
+
+      def validate_batch_id(batch_id:, &block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.batch_url(batch_id)
+        resp = get(@auth, endpoint, nil, &block)
+        SendGrid4r::REST::CancelScheduledSends.create_scheduled_send(resp)
+      end
+
+      def post_scheduled_send(batch_id:, status:, &block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.scheduled_sends_url
+        payload = {}
+        payload['batch_id'] = batch_id
+        payload['status'] = status
+        resp = post(@auth, endpoint, payload, &block)
+        SendGrid4r::REST::CancelScheduledSends.create_scheduled_send(resp)
+      end
+
+      def get_scheduled_sends(batch_id: nil, &block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.scheduled_sends_url(
+          batch_id
+        )
+        resp = get(@auth, endpoint, nil, nil, &block)
+        SendGrid4r::REST::CancelScheduledSends.create_scheduled_sends(resp)
+      end
+
+      def patch_scheduled_send(batch_id:, status:, &block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.scheduled_sends_url(
+          batch_id
+        )
+        payload = {}
+        payload['status'] = status
+        patch(@auth, endpoint, payload, &block)
+      end
+
+      def delete_scheduled_send(batch_id:, &block)
+        endpoint = SendGrid4r::REST::CancelScheduledSends.scheduled_sends_url(
+          batch_id
+        )
+        delete(@auth, endpoint, nil, &block)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/contacts/recipients.rb

@@ -30,21 +30,18 @@ module SendGrid4r
         def self.create_recipient(resp)
           return resp if resp.nil?
           custom_fields = []
-          resp['custom_fields'].each do |field|
-            custom_fields.push(
-              SendGrid4r::REST::Contacts::CustomFields.create_field(field)
-            )
+          unless resp['custom_fields'].nil?
+            resp['custom_fields'].each do |field|
+              custom_fields.push(
+                SendGrid4r::REST::Contacts::CustomFields.create_field(field)
+              )
+            end
           end
           Recipient.new(
-            Time.at(resp['created_at']),
-            custom_fields,
-            resp['email'],
-            resp['first_name'],
-            resp['id'],
-            resp['last_clicked'],
-            resp['last_emailed'],
-            resp['last_name'],
-            resp['last_opened'],
+            Time.at(resp['created_at']), custom_fields,
+            resp['email'], resp['first_name'], resp['id'],
+            resp['last_clicked'], resp['last_emailed'],
+            resp['last_name'], resp['last_opened'],
             Time.at(resp['updated_at'])
           )
         end

data/lib/sendgrid4r/rest/whitelabel/domains.rb

@@ -93,9 +93,9 @@ module SendGrid4r
         Result = Struct.new(:id, :valid, :validation_results)
         ValidationResults = Struct.new(
           # automatic_security:true
-          :mail_cname, :spf, :dkim1, :dkim2,
+          :mail_cname, :dkim1, :dkim2,
           # automatic_security:false
-          :mail_server, :subdomain_spf, :domain_spf, :dkim
+          :mail_server, :subdomain_spf, :dkim
         )
         ValidationResult = Struct.new(:valid, :reason)
 
@@ -119,14 +119,10 @@ module SendGrid4r
               resp['dkim1']),
             SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
               resp['dkim2']),
-            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
-              resp['spf']),
             SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
               resp['mail_server']),
             SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
               resp['subdomain_spf']),
-            SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
-              resp['domain_spf']),
             SendGrid4r::REST::Whitelabel::Domains.create_validation_result(
               resp['dkim'])
           )

data/lib/sendgrid4r/version.rb

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

data/spec/client_spec.rb

@@ -254,12 +254,26 @@ describe SendGrid4r::Client do
         expect(@client.respond_to?('get_user_profile')).to eq(true)
         expect(@client.respond_to?('patch_user_profile')).to eq(true)
         expect(@client.respond_to?('get_user_account')).to eq(true)
+
+        # Bounces API
+        expect(@client.respond_to?('get_bounces')).to eq(true)
+        expect(@client.respond_to?('delete_bounces')).to eq(true)
+        expect(@client.respond_to?('get_bounce')).to eq(true)
+        expect(@client.respond_to?('delete_bounce')).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)
+        expect(@client.respond_to?('post_scheduled_send')).to eq(true)
+        expect(@client.respond_to?('get_scheduled_sends')).to eq(true)
+        expect(@client.respond_to?('patch_scheduled_send')).to eq(true)
+        expect(@client.respond_to?('delete_scheduled_send')).to eq(true)
       end
     end
 
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('1.3.0')
+        expect(SendGrid4r::VERSION).to eq('1.4.0')
       end
     end
   end

data/spec/rest/asm/groups_spec.rb

@@ -60,7 +60,6 @@ describe SendGrid4r::REST::Asm::Groups do
           expect(group_edit1.id).to be_a(Fixnum)
           expect(group_edit1.name).to eq(@group_name_edit1)
           expect(group_edit1.description).to eq(@group_desc_edit)
-          expect(group_edit1.last_email_sent_at).to eq(nil)
           expect(group_edit1.unsubscribes).to eq(nil)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
@@ -87,7 +86,6 @@ describe SendGrid4r::REST::Asm::Groups do
           expect(group.id).to be_a(Fixnum)
           expect(group.name).to eq(@group_name1)
           expect(group.description).to eq(@group_desc)
-          expect(group.last_email_sent_at).to eq(nil)
           expect(group.unsubscribes).to eq(0)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
@@ -117,7 +115,6 @@ describe SendGrid4r::REST::Asm::Groups do
           '"id": 100,'\
           '"name": "Newsletters",'\
           '"description": "Our monthly newsletter.",'\
-          '"last_email_sent_at": "2014-09-04 01:34:43",'\
           '"unsubscribes": 400'\
         '}'
       )
@@ -130,14 +127,12 @@ describe SendGrid4r::REST::Asm::Groups do
             '"id": 100,'\
             '"name": "Newsletters",'\
             '"description": "Our monthly newsletter.",'\
-            '"last_email_sent_at": "2014-09-04 01:34:43",'\
             '"unsubscribes": 400'\
           '},'\
           '{'\
             '"id": 101,'\
             '"name": "Alerts",'\
             '"description": "Emails triggered by user-defined rules.",'\
-            '"last_email_sent_at": "2012-11-06 09:37:33",'\
             '"unsubscribes": 1'\
           '}'\
         ']'
@@ -185,7 +180,6 @@ describe SendGrid4r::REST::Asm::Groups do
       expect(actual.id).to eq(100)
       expect(actual.name).to eq('Newsletters')
       expect(actual.description).to eq('Our monthly newsletter.')
-      expect(actual.last_email_sent_at).to eq('2014-09-04 01:34:43')
       expect(actual.unsubscribes).to eq(400)
     end
 

data/spec/rest/bounces_spec.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SendGrid4r::REST::Bounces do
+  describe 'integration test', :it do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @emails = ['a1@bounce.com', 'a2@bounce.com', 'a3@bounce.com']
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#get_bounces' do
+        begin
+          start_time = Time.now - 60 * 60 * 24 * 365
+          end_time = Time.now
+          bounces = @client.get_bounces(
+            start_time: start_time, end_time: end_time
+          )
+          expect(bounces).to be_a(Array)
+          bounces.each do |bounce|
+            expect(bounce).to be_a(SendGrid4r::REST::Bounces::Bounce)
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_bounces(delete_all: true)' do
+        begin
+          @client.delete_bounces(delete_all: true)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_bounces(emails: [])' do
+        begin
+          @client.delete_bounces(emails: @emails)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_bounce' do
+        begin
+          bounce = @client.get_bounce(email: @email)
+          expect(bounce).to be_a(Array)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_bounce' do
+        begin
+          expect do
+            @client.delete_bounce(email: 'a1@bounce.com')
+          end.to raise_error(RestClient::ResourceNotFound)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+  end
+
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
+
+    let(:bounces) do
+      JSON.parse(
+        '['\
+          '{'\
+            '"created": 1443651125,'\
+            '"email": "testemail1@test.com",'\
+            '"reason": "550 5.1.1 The email account that you tried to reach '\
+            'does not exist.'\
+            'Please try double-checking the recipient\'s email address for '\
+            'typos or unnecessary spaces. Learn more at '\
+            'https://support.google.com/mail/answer/6596'\
+            'o186si2389584ioe.63 - gsmtp ",'\
+            '"status": "5.1.1"'\
+          '},'\
+          '{'\
+            '"created": 1433800303,'\
+            '"email": "testemail2@testing.com",'\
+            '"reason": "550 5.1.1 <testemail2@testing.com>: Recipient address '\
+            'rejected: User unknown in virtual alias table ",'\
+            '"status": "5.1.1"'\
+          '}'\
+        ']'
+      )
+    end
+
+    let(:bounce) do
+      JSON.parse(
+        '{'\
+          '"created": 1433800303,'\
+          '"email": "testemail2@testing.com",'\
+          '"reason": "550 5.1.1 <testemail2@testing.com>: Recipient address '\
+          'rejected: User unknown in virtual alias table ",'\
+          '"status": "5.1.1"'\
+        '}'
+      )
+    end
+
+    it '#get_bounces' do
+      allow(client).to receive(:execute).and_return(bounces)
+      actual = client.get_bounces
+      expect(actual).to be_a(Array)
+      actual.each do |bounce|
+        expect(bounce).to be_a(SendGrid4r::REST::Bounces::Bounce)
+      end
+    end
+
+    it '#delete_bounces(delete_all: true)' do
+      allow(client).to receive(:execute).and_return('')
+      client.delete_bounces(delete_all: true)
+    end
+
+    it '#delete_bounces(emails: [])' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_bounces(emails: [])
+      expect(actual).to eq('')
+    end
+
+    it '#get_bounce' do
+      allow(client).to receive(:execute).and_return(bounces)
+      actual = client.get_bounce(email: '')
+      expect(actual).to be_a(Array)
+      actual.each do |bounce|
+        expect(bounce).to be_a(SendGrid4r::REST::Bounces::Bounce)
+      end
+    end
+
+    it '#delete_bounce' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_bounce(email: '')
+      expect(actual).to eq('')
+    end
+
+    it 'creates bounces instance' do
+      actual = SendGrid4r::REST::Bounces.create_bounces(bounces)
+      expect(actual).to be_a(Array)
+      actual.each do |subuser|
+        expect(subuser).to be_a(SendGrid4r::REST::Bounces::Bounce)
+      end
+    end
+
+    it 'creates bounce instance' do
+      actual = SendGrid4r::REST::Bounces.create_bounce(bounce)
+      expect(actual).to be_a(SendGrid4r::REST::Bounces::Bounce)
+      expect(actual.created).to eq(Time.at(1433800303))
+      expect(actual.email).to eq('testemail2@testing.com')
+      expect(actual.reason).to eq(
+        '550 5.1.1 <testemail2@testing.com>: '\
+        'Recipient address rejected: User unknown in virtual alias table '
+      )
+      expect(actual.status).to eq('5.1.1')
+    end
+  end
+end

data/spec/rest/cancel_scheduled_sends_spec.rb

@@ -0,0 +1,210 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SendGrid4r::REST::CancelScheduledSends do
+  describe 'integration test', :it do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @scheduled_sends = @client.get_scheduled_sends
+        @scheduled_sends.each do |scheduled_send|
+          @client.delete_scheduled_send(batch_id: scheduled_send.batch_id)
+        end
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#generate_batch_id' do
+        begin
+          scheduled_send = @client.generate_batch_id
+          expect(scheduled_send).to be_a(
+            SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+          )
+          expect(scheduled_send.batch_id.length).to be > 0
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#validate_batch_id' do
+        begin
+          batch_id = @client.generate_batch_id.batch_id
+          scheduled_send = @client.validate_batch_id(batch_id: batch_id)
+          expect(scheduled_send).to be_a(
+            SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+          )
+          expect(scheduled_send.batch_id).to eq(batch_id)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#post_scheduled_send' do
+        begin
+          batch_id = @client.generate_batch_id.batch_id
+          scheduled_send = @client.post_scheduled_send(
+            batch_id: batch_id, status: 'cancel'
+          )
+          expect(scheduled_send).to be_a(
+            SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_scheduled_sends' do
+        begin
+          scheduled_sends = @client.get_scheduled_sends
+          expect(scheduled_sends).to be_a(Array)
+          scheduled_sends.each do |scheduled_send|
+            expect(scheduled_send).to be_a(
+              SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+            )
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#patch_scheduled_send' do
+        begin
+          batch_id = @client.generate_batch_id.batch_id
+          expect do
+            @client.patch_scheduled_send(
+              batch_id: batch_id, status: 'pause'
+            )
+          end.to raise_error(RestClient::ResourceNotFound)
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#delete_scheduled_send' do
+        begin
+          scheduled_sends = @client.get_scheduled_sends
+          scheduled_sends.each do |scheduled_send|
+            @client.delete_scheduled_send(batch_id: scheduled_send.batch_id)
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+  end
+
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
+
+    let(:scheduled_send) do
+      JSON.parse(
+        '{'\
+          '"batch_id": "YOUR_BATCH_ID"'\
+        '}'
+      )
+    end
+
+    let(:scheduled_sends) do
+      JSON.parse(
+        '['\
+          '{'\
+            '"batch_id": "BATCH_ID_1",'\
+            '"status": "cancel"'\
+          '},'\
+          '{'\
+            '"batch_id": "BATCH_ID_2",'\
+            '"status": "pause"'\
+          '}'\
+        ']'
+      )
+    end
+
+    it '#generate_batch_id' do
+      allow(client).to receive(:execute).and_return(scheduled_send)
+      actual = client.generate_batch_id
+      expect(actual).to be_a(
+        SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+      )
+      expect(actual.batch_id).to eq('YOUR_BATCH_ID')
+    end
+
+    it '#validate_batch_id' do
+      allow(client).to receive(:execute).and_return(scheduled_send)
+      actual = client.validate_batch_id(batch_id: '')
+      expect(actual).to be_a(
+        SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+      )
+      expect(actual.batch_id).to eq('YOUR_BATCH_ID')
+    end
+
+    it '#post_scheduled_send' do
+      allow(client).to receive(:execute).and_return(scheduled_send)
+      actual = client.post_scheduled_send(batch_id: '', status: '')
+      expect(actual).to be_a(
+        SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+      )
+      expect(actual.batch_id).to eq('YOUR_BATCH_ID')
+    end
+
+    it '#get_scheduled_sends' do
+      allow(client).to receive(:execute).and_return(scheduled_sends)
+      actual = client.get_scheduled_sends
+      expect(actual).to be_a(Array)
+      actual.each do |scheduled_send|
+        expect(scheduled_send).to be_a(
+          SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+        )
+      end
+    end
+
+    it '#patch_scheduled_send' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.patch_scheduled_send(batch_id: '', status: '')
+      expect(actual).to eq('')
+    end
+
+    it '#delete_scheduled_send' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_scheduled_send(batch_id: '')
+      expect(actual).to eq('')
+    end
+
+    it 'creates scheduled_sends instance' do
+      actual = SendGrid4r::REST::CancelScheduledSends.create_scheduled_sends(
+        scheduled_sends
+      )
+      expect(actual).to be_a(Array)
+      actual.each do |scheduled_send|
+        expect(scheduled_send).to be_a(
+          SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+        )
+        expect(actual[0].batch_id).to eq('BATCH_ID_1')
+        expect(actual[0].status).to eq('cancel')
+        expect(actual[1].batch_id).to eq('BATCH_ID_2')
+        expect(actual[1].status).to eq('pause')
+      end
+    end
+
+    it 'creates scheduled_send instance' do
+      actual = SendGrid4r::REST::CancelScheduledSends.create_scheduled_send(
+        scheduled_send
+      )
+      expect(actual).to be_a(
+        SendGrid4r::REST::CancelScheduledSends::ScheduledSend
+      )
+      expect(actual.batch_id).to eq('YOUR_BATCH_ID')
+    end
+  end
+end

data/spec/rest/contacts/lists_spec.rb

@@ -16,7 +16,6 @@ describe SendGrid4r::REST::Contacts::Lists do
         @last_name2 = 'Miller'
         @pet1 = 'Fluffy'
         @pet2 = 'FrouFrou'
-        @custom_field_name = 'pet'
 
         # celan up test env(lists)
         lists = @client.get_lists
@@ -41,11 +40,9 @@ describe SendGrid4r::REST::Contacts::Lists do
         recipient1 = {}
         recipient1['email'] = @email1
         recipient1['last_name'] = @last_name1
-        recipient1[@custom_field_name] = @pet1
         recipient2 = {}
         recipient2['email'] = @email2
         recipient2['last_name'] = @last_name2
-        recipient2[@custom_field_name] = @pet2
         result = @client.post_recipients(params: [recipient1, recipient2])
         @recipients = result.persisted_recipients
         @client.post_recipient_to_list(
@@ -54,8 +51,6 @@ describe SendGrid4r::REST::Contacts::Lists do
         @client.post_recipient_to_list(
           list_id: @list1.id, recipient_id: result.persisted_recipients[1]
         )
-        # # Add multiple recipients to a single list
-        # @client.post_recipients_to_list(@list1.id, @recipients)
       rescue RestClient::ExceptionWithResponse => e
         puts e.inspect
         raise e
@@ -205,7 +200,6 @@ describe SendGrid4r::REST::Contacts::Lists do
           recipient1 = {}
           recipient1['email'] = @email1
           recipient1['last_name'] = @last_name1
-          recipient1[@custom_field_name] = @pet1
           result = @client.post_recipients(params: [recipient1])
           @client.post_recipient_to_list(
             list_id: @list1.id, recipient_id: result.persisted_recipients[0]

data/spec/rest/contacts/recipients_spec.rb

@@ -13,7 +13,6 @@ describe SendGrid4r::REST::Contacts::Recipients do
         @last_name2 = 'Miller'
         @pet1 = 'Fluffy'
         @pet2 = 'FrouFrou'
-        @custom_field_name = 'pet'
 
         # celan up test env
         recipients = @client.get_recipients
@@ -21,17 +20,10 @@ describe SendGrid4r::REST::Contacts::Recipients do
           next if recipient.email != @email1 && recipient.email != @email2
           @client.delete_recipient(recipient_id: recipient.id)
         end
-        custom_fields = @client.get_custom_fields
-        custom_fields.custom_fields.each do |custom_field|
-          next if custom_field.name != @custom_field_name
-          @client.delete_custom_field(custom_field_id: custom_field.id)
-        end
-        @client.post_custom_field(name: @custom_field_name, type: 'text')
         # post a recipient
         params = {}
         params['email'] = @email1
         params['last_name'] = @last_name1
-        params[@custom_field_name] = @pet1
         @result = @client.post_recipients(params: [params])
       rescue RestClient::ExceptionWithResponse => e
         puts e.inspect
@@ -45,7 +37,6 @@ describe SendGrid4r::REST::Contacts::Recipients do
           params = {}
           params['email'] = @email2
           params['last_name'] = @last_name2
-          params[@custom_field_name] = @pet2
           result = @client.post_recipients(params: [params])
           expect(result.error_count).to eq(0)
           expect(result.error_indices).to eq([])

data/spec/rest/{subusers/subusers_spec.rb → subusers_spec.rb}

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SendGrid4r::REST::Subusers do
   describe 'integration test', :it do

data/spec/rest/{users/users_spec.rb → users_spec.rb}

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe SendGrid4r::REST::Users do
   describe 'integration test', :it do

data/spec/rest/whitelabel/domains_spec.rb

@@ -118,9 +118,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(@domain1.dns.mail_cname).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
-          expect(@domain1.dns.spf).to be_a(
-            SendGrid4r::REST::Whitelabel::Domains::Record
-          )
           expect(@domain1.dns.dkim1).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
@@ -146,9 +143,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(@domain2.dns.subdomain_spf).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
-          expect(@domain2.dns.domain_spf).to be_a(
-            SendGrid4r::REST::Whitelabel::Domains::Record
-          )
           expect(@domain2.dns.dkim).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
@@ -175,9 +169,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(domain1.dns.mail_cname).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
-          expect(domain1.dns.spf).to be_a(
-            SendGrid4r::REST::Whitelabel::Domains::Record
-          )
           expect(domain1.dns.dkim1).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
@@ -202,9 +193,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(domain2.dns.subdomain_spf).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
-          expect(domain2.dns.domain_spf).to be_a(
-            SendGrid4r::REST::Whitelabel::Domains::Record
-          )
           expect(domain2.dns.dkim).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
@@ -292,9 +280,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(result1.validation_results.dkim2.valid).to be(
             false
           )
-          expect(result1.validation_results.spf.valid).to be(
-            false
-          )
           result2 = @client.validate_wl_domain(id: @domain2.id)
           expect(result2).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Result
@@ -306,9 +291,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(result2.validation_results.subdomain_spf.valid).to be(
             false
           )
-          expect(result2.validation_results.domain_spf.valid).to be(
-            false
-          )
           expect(result2.validation_results.dkim.valid).to be(
             false
           )
@@ -382,12 +364,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
               '"data": "u7.wl.sendgrid.net",'\
               '"valid": true'\
             '},'\
-            '"spf": {'\
-              '"host": "example.com",'\
-              '"type": "txt",'\
-              '"data": "v=spf1 include:u7.wl.sendgrid.net -all",'\
-              '"valid": true'\
-            '},'\
             '"dkim1": {'\
               '"host": "s1._domainkey.example.com",'\
               '"type": "cname",'\
@@ -432,12 +408,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
               '"host": "mail2.example.com",'\
               '"data": "v=spf1 include:sendgrid.net ~all"'\
             '},'\
-            '"domain_spf": {'\
-              '"valid": false,'\
-              '"type": "txt",'\
-              '"host": "example.com",'\
-              '"data": "v=spf1 include:mail2.example.com -all"'\
-            '},'\
             '"dkim": {'\
               '"valid": false,'\
               '"type": "txt",'\
@@ -467,10 +437,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
             '"dkim2": {'\
               '"valid": true,'\
               '"reason": null'\
-            '},'\
-            '"spf": {'\
-              '"valid": true,'\
-              '"reason": null'\
             '}'\
           '}'\
         '}'
@@ -573,15 +539,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
       expect(actual.dns.mail_cname.type).to eq('cname')
       expect(actual.dns.mail_cname.data).to eq('u7.wl.sendgrid.net')
       expect(actual.dns.mail_cname.valid).to eq(true)
-      expect(actual.dns.spf).to be_a(
-        SendGrid4r::REST::Whitelabel::Domains::Record
-      )
-      expect(actual.dns.spf.host).to eq('example.com')
-      expect(actual.dns.spf.type).to eq('txt')
-      expect(actual.dns.spf.data).to eq(
-        'v=spf1 include:u7.wl.sendgrid.net -all'
-      )
-      expect(actual.dns.spf.valid).to eq(true)
       expect(actual.dns.dkim1).to be_a(
         SendGrid4r::REST::Whitelabel::Domains::Record
       )
@@ -629,15 +586,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
         'v=spf1 include:sendgrid.net ~all'
       )
       expect(actual.dns.subdomain_spf.valid).to eq(false)
-      expect(actual.dns.domain_spf).to be_a(
-        SendGrid4r::REST::Whitelabel::Domains::Record
-      )
-      expect(actual.dns.domain_spf.host).to eq('example.com')
-      expect(actual.dns.domain_spf.type).to eq('txt')
-      expect(actual.dns.domain_spf.data).to eq(
-        'v=spf1 include:mail2.example.com -all'
-      )
-      expect(actual.dns.domain_spf.valid).to eq(false)
       expect(actual.dns.dkim).to be_a(
         SendGrid4r::REST::Whitelabel::Domains::Record
       )
@@ -667,11 +615,6 @@ describe SendGrid4r::REST::Whitelabel::Domains do
       )
       expect(actual.validation_results.dkim2.valid).to be(true)
       expect(actual.validation_results.dkim2.reason).to be(nil)
-      expect(actual.validation_results.spf).to be_a(
-        SendGrid4r::REST::Whitelabel::Domains::ValidationResult
-      )
-      expect(actual.validation_results.spf.valid).to be(true)
-      expect(actual.validation_results.spf.reason).to be(nil)
     end
   end
 end

data/spec/rest/whitelabel/links_spec.rb

@@ -85,7 +85,7 @@ describe SendGrid4r::REST::Whitelabel::Links do
           expect(@link2.subdomain).to eq(@subdomain_name + '2')
           expect(@link2.username).to eq(@username)
           expect(@link2.user_id).to be_a(Numeric)
-          expect(@link2.default).to eq(true)
+          expect(@link2.default).to eq(false)
           expect(@link2.valid).to eq(false)
           expect(@link2.legacy).to eq(false)
           expect(@link2.dns.domain_cname).to be_a(
@@ -108,7 +108,7 @@ describe SendGrid4r::REST::Whitelabel::Links do
           expect(link2.subdomain).to eq(@subdomain_name + '2')
           expect(link2.username).to eq(@username)
           expect(link2.user_id).to be_a(Numeric)
-          expect(link2.default).to eq(true)
+          expect(link2.default).to eq(false)
           expect(link2.valid).to eq(false)
           expect(link2.legacy).to eq(false)
           expect(link2.dns.domain_cname).to be_a(
@@ -148,7 +148,7 @@ describe SendGrid4r::REST::Whitelabel::Links do
 
       it '#delete_wl_link' do
         begin
-          @client.delete_wl_link(id: @id1)
+          @client.delete_wl_link(id: @link2.id)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid4r
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - awwa500@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -132,7 +132,9 @@ files:
 - lib/sendgrid4r/rest/asm/global_suppressions.rb
 - lib/sendgrid4r/rest/asm/groups.rb
 - lib/sendgrid4r/rest/asm/suppressions.rb
+- lib/sendgrid4r/rest/bounces.rb
 - lib/sendgrid4r/rest/campaigns/campaigns.rb
+- lib/sendgrid4r/rest/cancel_scheduled_sends.rb
 - lib/sendgrid4r/rest/categories/categories.rb
 - lib/sendgrid4r/rest/contacts/custom_fields.rb
 - lib/sendgrid4r/rest/contacts/lists.rb
@@ -155,10 +157,10 @@ files:
 - lib/sendgrid4r/rest/stats/parse.rb
 - lib/sendgrid4r/rest/stats/stats.rb
 - lib/sendgrid4r/rest/stats/subuser.rb
-- lib/sendgrid4r/rest/subusers/subusers.rb
+- lib/sendgrid4r/rest/subusers.rb
 - lib/sendgrid4r/rest/templates/templates.rb
 - lib/sendgrid4r/rest/templates/versions.rb
-- lib/sendgrid4r/rest/users/users.rb
+- lib/sendgrid4r/rest/users.rb
 - lib/sendgrid4r/rest/whitelabel/domains.rb
 - lib/sendgrid4r/rest/whitelabel/ips.rb
 - lib/sendgrid4r/rest/whitelabel/links.rb
@@ -174,7 +176,9 @@ files:
 - spec/rest/asm/global_suppressions_spec.rb
 - spec/rest/asm/groups_spec.rb
 - spec/rest/asm/suppressions_spec.rb
+- spec/rest/bounces_spec.rb
 - spec/rest/campaigns/campaigns_spec.rb
+- spec/rest/cancel_scheduled_sends_spec.rb
 - spec/rest/categories/categories_spec.rb
 - spec/rest/contacts/custom_fields_spec.rb
 - spec/rest/contacts/lists_spec.rb
@@ -196,10 +200,10 @@ files:
 - spec/rest/stats/parse_spec.rb
 - spec/rest/stats/stats_spec.rb
 - spec/rest/stats/subuser_spec.rb
-- spec/rest/subusers/subusers_spec.rb
+- spec/rest/subusers_spec.rb
 - spec/rest/templates/templates_spec.rb
 - spec/rest/templates/versions_spec.rb
-- spec/rest/users/users_spec.rb
+- spec/rest/users_spec.rb
 - spec/rest/whitelabel/domains_spec.rb
 - spec/rest/whitelabel/ips_spec.rb
 - spec/rest/whitelabel/links_spec.rb
@@ -239,7 +243,9 @@ test_files:
 - spec/rest/asm/global_suppressions_spec.rb
 - spec/rest/asm/groups_spec.rb
 - spec/rest/asm/suppressions_spec.rb
+- spec/rest/bounces_spec.rb
 - spec/rest/campaigns/campaigns_spec.rb
+- spec/rest/cancel_scheduled_sends_spec.rb
 - spec/rest/categories/categories_spec.rb
 - spec/rest/contacts/custom_fields_spec.rb
 - spec/rest/contacts/lists_spec.rb
@@ -261,10 +267,10 @@ test_files:
 - spec/rest/stats/parse_spec.rb
 - spec/rest/stats/stats_spec.rb
 - spec/rest/stats/subuser_spec.rb
-- spec/rest/subusers/subusers_spec.rb
+- spec/rest/subusers_spec.rb
 - spec/rest/templates/templates_spec.rb
 - spec/rest/templates/versions_spec.rb
-- spec/rest/users/users_spec.rb
+- spec/rest/users_spec.rb
 - spec/rest/whitelabel/domains_spec.rb
 - spec/rest/whitelabel/ips_spec.rb
 - spec/rest/whitelabel/links_spec.rb