sendgrid4r 1.8.1 → 1.10.0

data/spec/rest/ips/warmup_spec.rb

@@ -1,16 +1,16 @@
 # encoding: utf-8
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe SendGrid4r::REST::Ips::Warmup do
-  describe 'integration test', :it do
-    before do
-      Dotenv.load
-      @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
-    end
-
-    context 'account is silver' do
+module SendGrid4r::REST::Ips
+  describe Warmup do
+    describe 'integration test', :it do
       before do
-        begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+      end
+
+      context 'account is silver' do
+        before do
           # celan up test env
           warmup_ips = @client.get_warmup_ips
           if warmup_ips.length > 0
@@ -18,15 +18,10 @@ describe SendGrid4r::REST::Ips::Warmup do
               @client.delete_warmup_ip(ip: warmup_ip.ip)
             end
           end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
         end
-      end
 
-      context 'without block call' do
-        it 'warmup_ip spec' do
-          begin
+        context 'without block call' do
+          it 'warmup_ip spec' do
             # get warmup ip
             warmup_ips = @client.get_warmup_ips
             expect(warmup_ips.length).to eq(0)
@@ -42,74 +37,71 @@ describe SendGrid4r::REST::Ips::Warmup do
             expect do
               @client.get_warmup_ip(ip: warmup_ip.ip)
             end.to raise_error(RestClient::ResourceNotFound)
-          rescue RestClient::ExceptionWithResponse => ex
-            puts ex.inspect
-            raise ex
           end
         end
       end
     end
-  end
-
-  describe 'unit test', :ut do
-    let(:client) do
-      SendGrid4r::Client.new(api_key: '')
-    end
 
-    let(:warmup_ip) do
-      JSON.parse(
-        '{'\
-          '"ip":"0.0.0.0",'\
-          '"start_date":1409616000'\
-        '}'
-      )
-    end
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
 
-    let(:warmup_ips) do
-      JSON.parse(
-        '['\
+      let(:warmup_ip) do
+        JSON.parse(
           '{'\
-            '"ip": "0.0.0.0",'\
-            '"start_date": 1409616000'\
-          '}'\
-        ']'
-      )
-    end
+            '"ip":"0.0.0.0",'\
+            '"start_date":1409616000'\
+          '}'
+        )
+      end
 
-    it '#get_warmup_ips' do
-      allow(client).to receive(:execute).and_return(warmup_ips)
-      actual = client.get_warmup_ips
-      expect(actual).to be_a(Array)
-      actual.each do |warmup_ip|
-        expect(warmup_ip).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
+      let(:warmup_ips) do
+        JSON.parse(
+          '['\
+            '{'\
+              '"ip": "0.0.0.0",'\
+              '"start_date": 1409616000'\
+            '}'\
+          ']'
+        )
       end
-    end
 
-    it '#get_warmup_ip' do
-      allow(client).to receive(:execute).and_return(warmup_ip)
-      actual = client.get_warmup_ip(ip: '')
-      expect(actual).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
-    end
+      it '#get_warmup_ips' do
+        allow(client).to receive(:execute).and_return(warmup_ips)
+        actual = client.get_warmup_ips
+        expect(actual).to be_a(Array)
+        actual.each do |warmup_ip|
+          expect(warmup_ip).to be_a(Warmup::WarmupIp)
+        end
+      end
 
-    it '#post_warmup_ip' do
-      allow(client).to receive(:execute).and_return(warmup_ip)
-      actual = client.post_warmup_ip(ip: '')
-      expect(actual).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
-    end
+      it '#get_warmup_ip' do
+        allow(client).to receive(:execute).and_return(warmup_ip)
+        actual = client.get_warmup_ip(ip: '')
+        expect(actual).to be_a(Warmup::WarmupIp)
+      end
 
-    it '#delete_warmup_ip' do
-      allow(client).to receive(:execute).and_return('')
-      actual = client.delete_warmup_ip(ip: '')
-      expect(actual).to eq('')
-    end
+      it '#post_warmup_ip' do
+        allow(client).to receive(:execute).and_return(warmup_ip)
+        actual = client.post_warmup_ip(ip: '')
+        expect(actual).to be_a(Warmup::WarmupIp)
+      end
 
-    it 'creates warmup_ips instance' do
-      actual = SendGrid4r::REST::Ips::Warmup.create_warmup_ips(warmup_ips)
-      expect(actual).to be_a(Array)
-      actual.each do |warmup_ip|
-        expect(warmup_ip).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
-        expect(warmup_ip.ip).to eq('0.0.0.0')
-        expect(warmup_ip.start_date).to eq(Time.at(1409616000))
+      it '#delete_warmup_ip' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.delete_warmup_ip(ip: '')
+        expect(actual).to eq('')
+      end
+
+      it 'creates warmup_ips instance' do
+        actual = Warmup.create_warmup_ips(warmup_ips)
+        expect(actual).to be_a(Array)
+        actual.each do |warmup_ip|
+          expect(warmup_ip).to be_a(Warmup::WarmupIp)
+          expect(warmup_ip.ip).to eq('0.0.0.0')
+          expect(warmup_ip.start_date).to eq(Time.at(1409616000))
+        end
       end
     end
   end

data/spec/rest/mail/address_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      it '#to_h with mandatory parameters' do
+        em = SendGrid4r::Factory::MailFactory.create_address(
+          email: 'test@example.com'
+        )
+        expect(em.to_h).to eq(email: 'test@example.com')
+      end
+
+      it '#to_h with full parameters' do
+        em = SendGrid4r::Factory::MailFactory.create_address(
+          email: 'test@example.com', name: 'To name'
+        )
+        em.email = 'from@example.com'
+        em.name = 'To name2'
+        expect(em.to_h).to eq(email: 'from@example.com', name: 'To name2')
+      end
+    end
+  end
+end

data/spec/rest/mail/attachment_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      it '#to_h with mandatory parameters' do
+        attachment = SendGrid4r::Factory::MailFactory.create_attachment(
+          content: 'Hello', filename: 'example.txt'
+        )
+        expect(attachment.to_h).to eq(
+          content: 'SGVsbG8=', filename: 'example.txt'
+        )
+      end
+
+      it '#to_h with full parameters' do
+        attachment = SendGrid4r::Factory::MailFactory.create_attachment(
+          content: 'Hello', filename: 'example.txt'
+        )
+        attachment.content = 'MoMoMo'
+        attachment.filename = 'new.txt'
+        attachment.type = 'text/csv'
+        attachment.disposition = 'inline'
+        attachment.content_id = 'ii_139db99fdb5c3704'
+        expect(attachment.to_h).to eq(
+          content: 'TW9Nb01v',
+          filename: 'new.txt',
+          type: 'text/csv',
+          disposition: 'inline',
+          content_id: 'ii_139db99fdb5c3704'
+        )
+      end
+
+      it '#to_h with File' do
+        path = File.dirname(__FILE__) + '/../../photo.jpg'
+        binary = File.binread(path)
+        attachment = SendGrid4r::Factory::MailFactory.create_attachment(
+          content: binary, filename: 'photo.jpg'
+        )
+        expect(attachment.filename).to eq('photo.jpg')
+      end
+    end
+  end
+end

data/spec/rest/mail/content_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      it '#to_h with mandatory parameters' do
+        content = SendGrid4r::Factory::MailFactory.create_content(
+          type: 'text/plain', value: 'This is text part.'
+        )
+        expect(content.to_h).to eq(
+          type: 'text/plain', value: 'This is text part.'
+        )
+      end
+
+      it '#to_h with full parameters' do
+        content = SendGrid4r::Factory::MailFactory.create_content(
+          type: 'text/plain', value: 'This is text part.'
+        )
+        content.type = 'text/html'
+        content.value = '<div>This is html part.</div>'
+        expect(content.to_h).to eq(
+          type: 'text/html', value: '<div>This is html part.</div>'
+        )
+      end
+    end
+  end
+end

data/spec/rest/mail/mail_settings_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      it '#to_h with mandatory parameters' do
+        settings = SendGrid4r::Factory::MailFactory.create_mail_settings
+        expect(settings.to_h).to eq({})
+      end
+
+      it '#to_h with full parameters enable' do
+        settings = SendGrid4r::Factory::MailFactory.create_mail_settings
+        settings.enable_bcc('bcc@example.com')
+        settings.enable_bypass_list_management
+        settings.enable_footer('text', 'html')
+        settings.enable_sandbox_mode
+        settings.enable_spam_check(5, 'http://post.url')
+        expect(settings.to_h).to eq(
+          bcc: { enable: true, email: 'bcc@example.com' },
+          bypass_list_management: { enable: true },
+          footer: { enable: true, text: 'text', html: 'html' },
+          sandbox_mode: { enable: true },
+          spam_check: {
+            enable: true, threshold: 5, post_to_url: 'http://post.url'
+          }
+        )
+      end
+
+      it '#to_h with full parameters disable' do
+        settings = SendGrid4r::Factory::MailFactory.create_mail_settings
+        settings.disable_bcc
+        settings.disable_bypass_list_management
+        settings.disable_footer
+        settings.disable_sandbox_mode
+        settings.disable_spam_check
+        expect(settings.to_h).to eq(
+          bcc: { enable: false },
+          bypass_list_management: { enable: false },
+          footer: { enable: false },
+          sandbox_mode: { enable: false },
+          spam_check: { enable: false }
+        )
+      end
+    end
+  end
+end

data/spec/rest/mail/mail_spec.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'integration test', :it do
+      before do
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['API_KEY'])
+      end
+
+      context 'without block call' do
+        it '#send with mandatory params' do
+          # Create Personalization
+          to = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['MAIL']
+          )
+          per = SendGrid4r::Factory::MailFactory.create_personalization(
+            to: [to]
+          )
+          # Create Params
+          from = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['FROM']
+          )
+          plain = SendGrid4r::Factory::MailFactory.create_content(
+            type: 'text/plain',
+            value: 'Hello! TEXT'
+          )
+          params = SendGrid4r::Factory::MailFactory.create_params(
+            personalizations: [per], from: from, content: [plain],
+            subject: 'Hello v3 Mail'
+          )
+          begin
+            @client.send(params: params)
+          rescue RestClient::ExceptionWithResponse => e
+            puts e.inspect
+            raise
+          end
+        end
+
+        it '#send with full params' do
+          # Create Personalization
+          to = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['MAIL'], name: 'To name'
+          )
+          cc = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['CC'], name: 'Cc name'
+          )
+          bcc = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['BCC'], name: 'Bcc name'
+          )
+          per = SendGrid4r::Factory::MailFactory.create_personalization(
+            to: [to]
+          )
+          per.bcc = [bcc]
+          per.cc = [cc]
+          per.headers = { 'X-CUSTOM' => 'X-VALUE' }
+          per.substitutions = {
+            'subkey' => 'subvalue', 'sectionkey' => 'sectionkey'
+          }
+          per.custom_args = { 'CUSTOM' => 'value' }
+          per.send_at = Time.utc(2016)
+          # Create Params
+          from = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['FROM'], name: 'From Name'
+          )
+          plain = SendGrid4r::Factory::MailFactory.create_content(
+            type: 'text/plain',
+            value: 'Hello! TEXT subkey'\
+              'sectionkey\nhttps://www.google.com'
+          )
+          html = SendGrid4r::Factory::MailFactory.create_content(
+            type: 'text/html',
+            value: '<h1>Hello! HTML subkey sectionkey</h1><br />'\
+              '<a href="https://www.google.com">Google</a>'
+          )
+          params = SendGrid4r::Factory::MailFactory.create_params(
+            personalizations: [per], from: from, content: [plain, html],
+            subject: 'Hello v3 Mail'
+          )
+          reply_to = SendGrid4r::Factory::MailFactory.create_address(
+            email: ENV['MAIL']
+          )
+          params.reply_to = reply_to
+          attachment0 = SendGrid4r::Factory::MailFactory.create_attachment(
+            content: 'XXX', filename: 'text.txt'
+          )
+          binary = File.binread(File.dirname(__FILE__) + '/../../photo.jpg')
+          attachment1 = SendGrid4r::Factory::MailFactory.create_attachment(
+            content: binary, filename: 'photo.jpg'
+          )
+          params.attachments = [attachment0, attachment1]
+          params.template_id = '8481d009-d1a6-4e1b-adae-22d2426da9fe'
+          params.sections = { 'sectionkey' => 'sectionvalue' }
+          params.headers = { 'X-GLOBAL' => 'GLOBAL_VALUE' }
+          params.categories = %w(CAT1 CAT2)
+          params.custom_args = { 'CUSTOM1' => 'CUSTOM_VALUE1' }
+          params.send_at = Time.local(2016)
+          params.asm = 3581
+          # Create MailSettings
+          mail_settings =
+            SendGrid4r::Factory::MailFactory.create_mail_settings
+          mail_settings.enable_bcc(ENV['MAIL'])
+          mail_settings.disable_bcc
+          mail_settings.enable_bypass_list_management
+          mail_settings.disable_bypass_list_management
+          mail_settings.enable_footer('text footer', '<p>html footer</p>')
+          mail_settings.disable_footer
+          mail_settings.enable_sandbox_mode
+          mail_settings.disable_sandbox_mode
+          mail_settings.enable_spam_check(10, 'http://www.kke.co.jp')
+          mail_settings.disable_spam_check
+          params.mail_settings = mail_settings
+          # Create TrackingSettings
+          tracking =
+            SendGrid4r::Factory::MailFactory.create_tracking_settings
+          tracking.enable_click_tracking(true)
+          tracking.disable_click_tracking
+          tracking.enable_open_tracking('open_tag')
+          tracking.disable_open_tracking
+          tracking.enable_subscription_tracking('', '', 'tag')
+          tracking.disable_subscription_tracking
+          tracking.enable_ganalytics('', '', '', '', '')
+          tracking.disable_ganalytics
+          params.tracking_settings = tracking
+          begin
+            @client.send(params: params)
+          rescue RestClient::ExceptionWithResponse => e
+            puts e.inspect
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rest/mail/params_spec.rb

@@ -0,0 +1,152 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      let(:to) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'to@example.com'
+        )
+      end
+
+      let(:from) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'from@example.com'
+        )
+      end
+
+      let(:per) do
+        SendGrid4r::Factory::MailFactory.create_personalization(to: [to])
+      end
+
+      let(:plain) do
+        SendGrid4r::Factory::MailFactory.create_content(
+          type: 'text/plain',
+          value: 'Hello! TEXT subkey '\
+            'sectionkey\nhttps://www.google.com'
+        )
+      end
+
+      let(:html) do
+        SendGrid4r::Factory::MailFactory.create_content(
+          type: 'text/html',
+          value: '<h1>Hello! HTML subkey sectionkey</h1><br />'\
+            '<a href="https://www.google.com">Google</a>'
+        )
+      end
+
+      let(:reply_to) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'reply_to@example.com'
+        )
+      end
+
+      let(:attachment) do
+        SendGrid4r::Factory::MailFactory.create_attachment(
+          content: 'Hello', filename: 'text.txt'
+        )
+      end
+
+      let(:mail_settings) do
+        SendGrid4r::Factory::MailFactory.create_mail_settings
+      end
+
+      let(:tracking_settings) do
+        SendGrid4r::Factory::MailFactory.create_tracking_settings
+      end
+
+      it '#to_h with mandatory parameters' do
+        params = SendGrid4r::Factory::MailFactory.create_params(
+          personalizations: [per], from: from, content: [plain, html],
+          subject: 'This is the subject'
+        )
+        expect(params.to_h).to eq(
+          personalizations: [
+            {
+              to: [{ email: 'to@example.com' }]
+            }
+          ],
+          from: { email: 'from@example.com' },
+          content: [
+            {
+              type: 'text/plain',
+              value: 'Hello! TEXT subkey '\
+                'sectionkey\nhttps://www.google.com'
+            },
+            {
+              type: 'text/html',
+              value: '<h1>Hello! HTML subkey sectionkey</h1><br />'\
+                '<a href="https://www.google.com">Google</a>'
+            }
+          ],
+          subject: 'This is the subject'
+        )
+      end
+
+      it '#to_h with full parameters' do
+        params = SendGrid4r::Factory::MailFactory.create_params(
+          personalizations: [per], from: from, content: [plain, html],
+          subject: 'This is the subject'
+        )
+        params.reply_to = reply_to
+        params.attachments = [attachment]
+        params.template_id = 'XXX-YYY-ZZZ'
+        params.sections = { 'sectionkey' => 'sectionvalue' }
+        params.headers = { 'X-GLOBAL' => 'GLOBAL_VALUE' }
+        params.categories = %w(CAT1 CAT2)
+        params.custom_args = { 'CUSTOM1' => 'CUSTOM_VALUE1' }
+        params.send_at = Time.utc(2016)
+        params.batch_id = '1234567890'
+        params.asm = 3581, [12, 34]
+        params.ip_pool_name = 'pool_name'
+        params.mail_settings = mail_settings
+        params.tracking_settings = tracking_settings
+
+        expect(params.to_h).to eq(
+          personalizations: [
+            {
+              to: [{ email: 'to@example.com' }]
+            }
+          ],
+          from: { email: 'from@example.com' },
+          content: [
+            {
+              type: 'text/plain',
+              value: 'Hello! TEXT subkey '\
+                'sectionkey\nhttps://www.google.com'
+            },
+            {
+              type: 'text/html',
+              value: '<h1>Hello! HTML subkey sectionkey</h1><br />'\
+                '<a href="https://www.google.com">Google</a>'
+            }
+          ],
+          reply_to: { email: 'reply_to@example.com' },
+          attachments: [
+            {
+              content: 'SGVsbG8=',
+              filename: 'text.txt'
+            }
+          ],
+          template_id: 'XXX-YYY-ZZZ',
+          sections: { 'sectionkey' => 'sectionvalue' },
+          headers: { 'X-GLOBAL' => 'GLOBAL_VALUE' },
+          categories: %w(CAT1 CAT2),
+          custom_args: { 'CUSTOM1' => 'CUSTOM_VALUE1' },
+          send_at: 1451606400,
+          batch_id: '1234567890',
+          asm: { group_id: 3581, groups_to_display: [12, 34] },
+          ip_pool_name: 'pool_name',
+          mail_settings: {},
+          tracking_settings: {},
+          subject: 'This is the subject'
+        )
+      end
+    end
+  end
+end

data/spec/rest/mail/personalization_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module SendGrid4r::REST
+  describe Mail do
+    describe 'unit test', :ut do
+      before do
+        Dotenv.load
+      end
+
+      let(:to) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'to@example.com'
+        )
+      end
+
+      let(:cc) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'cc@example.com'
+        )
+      end
+
+      let(:bcc) do
+        SendGrid4r::Factory::MailFactory.create_address(
+          email: 'bcc@example.com'
+        )
+      end
+
+      it '#to_h with mandatory parameters' do
+        per = SendGrid4r::Factory::MailFactory.create_personalization(
+          to: [to]
+        )
+        expect(per.to_h).to eq(
+          to: [{ email: 'to@example.com' }]
+        )
+      end
+
+      it '#to_h with full parameters' do
+        per = SendGrid4r::Factory::MailFactory.create_personalization(
+          to: [to]
+        )
+        per.subject = 'This is subject.'
+        per.cc = [cc]
+        per.bcc = [bcc]
+        per.headers = { 'X-CUSTOM' => 'X-VALUE' }
+        per.substitutions = {
+          'subkey' => 'subval', 'sectionkey' => 'sectionkey'
+        }
+        per.custom_args = { 'CUSTOM' => 'value' }
+        per.send_at = Time.utc(2016)
+        expect(per.to_h).to eq(
+          to: [{ email: 'to@example.com' }],
+          subject: 'This is subject.',
+          cc: [{ email: 'cc@example.com' }],
+          bcc: [{ email: 'bcc@example.com' }],
+          headers: { 'X-CUSTOM' => 'X-VALUE' },
+          substitutions: {
+            'subkey' => 'subval', 'sectionkey' => 'sectionkey'
+          },
+          custom_args: { 'CUSTOM' => 'value' },
+          send_at: 1451606400
+        )
+      end
+    end
+  end
+end