sendgrid4r 1.8.1 → 1.10.0

data/spec/rest/mail/tracking_settings_spec.rb

@@ -0,0 +1,63 @@
+# 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_tracking_settings
+        expect(settings.to_h).to eq({})
+      end
+
+      it '#to_h with full parameters enable' do
+        settings =
+          SendGrid4r::Factory::MailFactory.create_tracking_settings
+        settings.enable_click_tracking(true)
+        settings.enable_open_tracking('<tag>')
+        settings.enable_subscription_tracking('text', 'html', '<tag>')
+        settings.enable_ganalytics(
+          'source', 'medium', 'term', 'content', 'campaign'
+        )
+        expect(settings.to_h).to eq(
+          click_tracking: { enable: true, enable_text: true },
+          open_tracking: {
+            enable: true,
+            substitution_tag: '<tag>'
+          },
+          subscription_tracking: {
+            enable: true, text: 'text', html: 'html',
+            substitution_tag: '<tag>'
+          },
+          ganalytics: {
+            enable: true,
+            utm_source: 'source',
+            utm_medium: 'medium',
+            utm_term: 'term',
+            utm_content: 'content',
+            utm_campaign: 'campaign'
+          }
+        )
+      end
+
+      it '#to_h with full parameters disable' do
+        settings =
+          SendGrid4r::Factory::MailFactory.create_tracking_settings
+        settings.disable_click_tracking
+        settings.disable_open_tracking
+        settings.disable_subscription_tracking
+        settings.disable_ganalytics
+        expect(settings.to_h).to eq(
+          click_tracking: { enable: false },
+          open_tracking: { enable: false },
+          subscription_tracking: { enable: false },
+          ganalytics: { enable: false }
+        )
+      end
+    end
+  end
+end

data/spec/rest/marketing_campaigns/contacts/custom_fields_spec.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module SendGrid4r::REST::MarketingCampaigns::Contacts
+  describe CustomFields do
+    describe 'integration test', :it do
+      before do
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @name1 = 'birthday'
+        @type1 = 'text'
+        @name2 = 'born_at'
+        @type2 = 'date'
+
+        # celan up test env
+        fields = @client.get_custom_fields
+        fields.custom_fields.each do |field|
+          next if field.name != @name1 && field.name != @name2
+          @client.delete_custom_field(custom_field_id: field.id)
+        end
+        # post a custom field
+        @new_field = @client.post_custom_field(name: @name1, type: @type1)
+      end
+
+      context 'without block call' do
+        it '#post_custom_field' do
+          new_field = @client.post_custom_field(name: @name2, type: @type2)
+          expect(new_field.id).to be_a(Fixnum)
+          expect(new_field.name).to eq(@name2)
+          expect(new_field.type).to eq(@type2)
+        end
+
+        it '#post_custom_field for same key' do
+          expect do
+            @client.post_custom_field(name: @name1, type: @type1)
+          end.to raise_error(RestClient::BadRequest)
+        end
+
+        it '#get_custom_fields' do
+          fields = @client.get_custom_fields
+          expect(fields.length).to be >= 1
+          fields.custom_fields.each do |field|
+            next if field.name != @name1
+            expect(field.id).to eq(@new_field.id)
+            expect(field.name).to eq(@new_field.name)
+            expect(field.type).to eq(@new_field.type)
+          end
+        end
+
+        it '#get_custom_field' do
+          actual_field = @client.get_custom_field(
+            custom_field_id: @new_field.id
+          )
+          expect(actual_field.id).to eq(@new_field.id)
+          expect(actual_field.name).to eq(@new_field.name)
+          expect(actual_field.type).to eq(@new_field.type)
+        end
+
+        it '#delete_custom_field' do
+          @client.delete_custom_field(custom_field_id: @new_field.id)
+        end
+      end
+    end
+
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
+
+      let(:field) do
+        JSON.parse(
+          '{'\
+            '"id": 1,'\
+            '"name": "pet",'\
+            '"type": "text"'\
+          '}'
+        )
+      end
+
+      let(:fields) do
+        JSON.parse(
+          '{'\
+            '"custom_fields": ['\
+              '{'\
+                '"id": 1,'\
+                '"name": "birthday",'\
+                '"type": "date"'\
+              '},'\
+              '{'\
+                '"id": 2,'\
+                '"name": "middle_name",'\
+                '"type": "text"'\
+              '},'\
+              '{'\
+                '"id": 3,'\
+                '"name": "favorite_number",'\
+                '"type": "number"'\
+              '}'\
+            ']'\
+          '}'
+        )
+      end
+
+      it '#post_custom_field' do
+        allow(client).to receive(:execute).and_return(field)
+        actual = client.post_custom_field(name: '', type: '')
+        expect(actual).to be_a(CustomFields::Field)
+      end
+
+      it '#get_custom_fields' do
+        allow(client).to receive(:execute).and_return(fields)
+        actual = client.get_custom_fields
+        expect(actual).to be_a(CustomFields::Fields)
+      end
+
+      it '#get_custom_field' do
+        allow(client).to receive(:execute).and_return(field)
+        actual = client.get_custom_field(custom_field_id: 0)
+        expect(actual).to be_a(CustomFields::Field)
+      end
+
+      it '#delete_custom_field' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.delete_custom_field(custom_field_id: 0)
+        expect(actual).to eq('')
+      end
+
+      it 'creates field instance' do
+        actual = CustomFields.create_field(field)
+        expect(actual).to be_a(CustomFields::Field)
+        expect(actual.id).to eq(1)
+        expect(actual.name).to eq('pet')
+        expect(actual.type).to eq('text')
+      end
+
+      it 'creates fields instance' do
+        actual = CustomFields.create_fields(fields)
+        expect(actual).to be_a(CustomFields::Fields)
+        expect(actual.custom_fields).to be_a(Array)
+        actual.custom_fields.each do |field|
+          expect(field).to be_a(CustomFields::Field)
+        end
+      end
+    end
+  end
+end

data/spec/rest/marketing_campaigns/contacts/lists_spec.rb

@@ -0,0 +1,307 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module SendGrid4r::REST::MarketingCampaigns::Contacts
+  describe Lists do
+    describe 'integration test', :it do
+      before do
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @list_name1 = 'test_list1'
+        @edit_name1 = 'test_list1_edit'
+        @list_name2 = 'test_list2'
+        @email1 = 'jones@example.com'
+        @email2 = 'miller@example.com'
+        @last_name1 = 'Jones'
+        @last_name2 = 'Miller'
+        @pet1 = 'Fluffy'
+        @pet2 = 'FrouFrou'
+
+        # celan up test env(lists)
+        lists = @client.get_lists
+        lists.lists.each do |list|
+          @client.delete_list(list_id: list.id) if list.name == @list_name1
+          @client.delete_list(list_id: list.id) if list.name == @edit_name1
+          @client.delete_list(list_id: list.id) if list.name == @list_name2
+        end
+        # celan up test env(recipients)
+        recipients = @client.get_recipients
+        recipients.recipients.each do |recipient|
+          @client.delete_recipient(
+            recipient_id: recipient.id
+          ) if recipient.email == @email1
+          @client.delete_recipient(
+            recipient_id: recipient.id
+          ) if recipient.email == @email2
+        end
+        # post a first list
+        @list1 = @client.post_list(name: @list_name1)
+        # add multiple recipients
+        recipient1 = {}
+        recipient1['email'] = @email1
+        recipient1['last_name'] = @last_name1
+        recipient2 = {}
+        recipient2['email'] = @email2
+        recipient2['last_name'] = @last_name2
+        result = @client.post_recipients(params: [recipient1, recipient2])
+        @recipients = result.persisted_recipients
+        @client.post_recipient_to_list(
+          list_id: @list1.id, recipient_id: result.persisted_recipients[0]
+        )
+        @client.post_recipient_to_list(
+          list_id: @list1.id, recipient_id: result.persisted_recipients[1]
+        )
+      end
+
+      context 'without block call' do
+        it '#post_list' do
+          list2 = @client.post_list(name: @list_name2)
+          expect(list2.id).to be_a(Fixnum)
+          expect(list2.name).to eq(@list_name2)
+          expect(list2.recipient_count).to eq(0)
+          @client.delete_list(list_id: list2.id)
+        end
+
+        it '#post_list for same key' do
+          expect do
+            @client.post_list(name: @list_name1)
+          end.to raise_error(RestClient::BadRequest)
+        end
+
+        it '#get_lists' do
+          lists = @client.get_lists
+          expect(lists.length).to be >= 1
+          lists.lists.each do |list|
+            next if list.name != @list_name1
+            expect(list.id).to eq(@list1.id)
+            expect(list.name).to eq(@list1.name)
+            expect(list.recipient_count).to be_a(Fixnum)
+          end
+        end
+
+        it '#get_list' do
+          actual_list = @client.get_list(list_id: @list1.id)
+          expect(actual_list.id).to eq(@list1.id)
+          expect(actual_list.name).to eq(@list1.name)
+          expect(actual_list.recipient_count).to be_a(Fixnum)
+        end
+
+        it '#patch_list' do
+          edit_list = @client.patch_list(list_id: @list1.id, name: @edit_name1)
+          expect(edit_list.id).to eq(@list1.id)
+          expect(edit_list.name).to eq(@edit_name1)
+        end
+
+        it '#get_recipients_from_list' do
+          recipients = @client.get_recipients_from_list(list_id: @list1.id)
+          recipients.recipients.each do |recipient|
+            expect(recipient).to be_a(Recipients::Recipient)
+          end
+        end
+
+        it '#get_recipients_from_list with offset & limit' do
+          recipients = @client.get_recipients_from_list(
+            list_id: @list1.id, page: 1, page_size: 10
+          )
+          recipients.recipients.each do |recipient|
+            expect(recipient).to be_a(Recipients::Recipient)
+          end
+        end
+
+        it '#delete_recipient_from_list' do
+          @client.delete_recipient_from_list(
+            list_id: @list1.id, recipient_id: @recipients[0]
+          )
+        end
+
+        it '#delete_list' do
+          @client.delete_list(list_id: @list1.id)
+          expect do
+            @client.get_list(list_id: @list1.id)
+          end.to raise_error(RestClient::ResourceNotFound)
+        end
+
+        it '#delete_lists' do
+          list2 = @client.post_list(name: @list_name2)
+          @client.delete_lists(list_ids: [@list1.id, list2.id])
+        end
+
+        it '#post_recipients_to_list' do
+          @client.post_recipients_to_list(
+            list_id: @list1.id, recipients: @recipients
+          )
+        end
+
+        it '#post_recipient_to_list' do
+          recipient1 = {}
+          recipient1['email'] = @email1
+          recipient1['last_name'] = @last_name1
+          result = @client.post_recipients(params: [recipient1])
+          @client.post_recipient_to_list(
+            list_id: @list1.id, recipient_id: result.persisted_recipients[0]
+          )
+        end
+      end
+    end
+
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
+
+      let(:list) do
+        JSON.parse(
+          '{'\
+            '"id": 1,'\
+            '"name": "listname",'\
+            '"recipient_count": 0'\
+          '}'
+        )
+      end
+
+      let(:lists) do
+        JSON.parse(
+          '{'\
+            '"lists": ['\
+              '{'\
+                '"id": 1,'\
+                '"name": "the jones",'\
+                '"recipient_count": 1'\
+              '}'\
+            ']'\
+          '}'
+        )
+      end
+
+      let(:recipient) do
+        JSON.parse(
+          '{'\
+            '"created_at": 1422313607,'\
+            '"email": "jones@example.com",'\
+            '"first_name": null,'\
+            '"id": "jones@example.com",'\
+            '"last_clicked": null,'\
+            '"last_emailed": null,'\
+            '"last_name": "Jones",'\
+            '"last_opened": null,'\
+            '"updated_at": 1422313790,'\
+            '"custom_fields": ['\
+              '{'\
+                '"id": 23,'\
+                '"name": "pet",'\
+                '"value": "Fluffy",'\
+                '"type": "text"'\
+              '}'\
+            ']'\
+          '}'
+        )
+      end
+
+      let(:recipients) do
+        JSON.parse(
+          '{'\
+            '"recipients": ['\
+              '{'\
+                '"created_at": 1422313607,'\
+                '"email": "jones@example.com",'\
+                '"first_name": null,'\
+                '"id": "jones@example.com",'\
+                '"last_clicked": null,'\
+                '"last_emailed": null,'\
+                '"last_name": "Jones",'\
+                '"last_opened": null,'\
+                '"updated_at": 1422313790,'\
+                '"custom_fields": ['\
+                  '{'\
+                    '"id": 23,'\
+                    '"name": "pet",'\
+                    '"value": "Fluffy",'\
+                    '"type": "text"'\
+                  '}'\
+                ']'\
+              '}'\
+            ']'\
+          '}'
+        )
+      end
+
+      it '#post_list' do
+        allow(client).to receive(:execute).and_return(list)
+        actual = client.post_list(name: '')
+        expect(actual).to be_a(Lists::List)
+      end
+
+      it '#get_lists' do
+        allow(client).to receive(:execute).and_return(lists)
+        actual = client.get_lists
+        expect(actual).to be_a(Lists::Lists)
+      end
+
+      it '#get_list' do
+        allow(client).to receive(:execute).and_return(list)
+        actual = client.get_list(list_id: 0)
+        expect(actual).to be_a(Lists::List)
+      end
+
+      it '#patch_list' do
+        allow(client).to receive(:execute).and_return(list)
+        actual = client.patch_list(list_id: 0, name: '')
+        expect(actual).to be_a(Lists::List)
+      end
+
+      it '#get_recipients_from_list' do
+        allow(client).to receive(:execute).and_return(recipients)
+        actual = client.get_recipients_from_list(list_id: 0)
+        expect(actual).to be_a(Recipients::Recipients)
+      end
+
+      it '#delete_recipient_from_list' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.delete_recipient_from_list(list_id: 0, recipient_id: '')
+        expect(actual).to eq('')
+      end
+
+      it '#delete_list' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.delete_list(list_id: 0)
+        expect(actual).to eq('')
+      end
+
+      it '#delete_lists' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.delete_lists(list_ids: [0, 1])
+        expect(actual).to eq('')
+      end
+
+      it '#post_recipients_to_list' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.post_recipients_to_list(
+          list_id: 0, recipients: ['', '']
+        )
+        expect(actual).to eq('')
+      end
+
+      it '#post_recipient_to_list' do
+        allow(client).to receive(:execute).and_return('')
+        actual = client.post_recipient_to_list(list_id: 0, recipient_id: 0)
+        expect(actual).to eq('')
+      end
+
+      it 'creates list instance' do
+        actual = Lists.create_list(list)
+        expect(actual).to be_a(Lists::List)
+        expect(actual.id).to eq(1)
+        expect(actual.name).to eq('listname')
+        expect(actual.recipient_count).to eq(0)
+      end
+
+      it 'creates lists instance' do
+        actual = Lists.create_lists(lists)
+        expect(actual.lists).to be_a(Array)
+        actual.lists.each do |list|
+          expect(list).to be_a(Lists::List)
+        end
+      end
+    end
+  end
+end