sendgrid4r 1.1.0 → 1.2.0

data/spec/rest/contacts/recipients_spec.rb

@@ -5,7 +5,6 @@ describe SendGrid4r::REST::Contacts::Recipients do
   describe 'integration test', :it do
     before do
       begin
-        pending 'waiting sendgrid documentation update'
         Dotenv.load
         @client = SendGrid4r::Client.new(api_key: ENV['API_KEY'])
         @email1 = 'jones@example.com'
@@ -33,7 +32,7 @@ describe SendGrid4r::REST::Contacts::Recipients do
         params['email'] = @email1
         params['last_name'] = @last_name1
         params[@custom_field_name] = @pet1
-        @new_recipient = @client.post_recipient(params: params)
+        @result = @client.post_recipients(params: [params])
       rescue RestClient::ExceptionWithResponse => e
         puts e.inspect
         raise e
@@ -41,77 +40,59 @@ describe SendGrid4r::REST::Contacts::Recipients do
     end
 
     context 'without block call' do
-      it '#post_recipient' do
+      it '#post_recipients' do
         begin
           params = {}
           params['email'] = @email2
           params['last_name'] = @last_name2
           params[@custom_field_name] = @pet2
-          new_recipient = @client.post_recipient(params: params)
-          expect(new_recipient.created_at).to be_a(Time)
-          new_recipient.custom_fields.each do |custom_field|
-            expect(
-              custom_field
-            ).to be_a(SendGrid4r::REST::Contacts::CustomFields::Field)
-          end
-          expect(new_recipient.email).to eq(@email2)
-          expect(new_recipient.first_name).to eq(nil)
-          expect(new_recipient.id).to eq(@email2)
-          expect(new_recipient.last_clicked).to eq(nil)
-          expect(new_recipient.last_emailed).to eq(nil)
-          expect(new_recipient.last_name).to eq(@last_name2)
-          expect(new_recipient.last_opened).to eq(nil)
-          expect(new_recipient.updated_at).to be_a(Time)
+          result = @client.post_recipients(params: [params])
+          expect(result.error_count).to eq(0)
+          expect(result.error_indices).to eq([])
+          expect(result.new_count).to eq(1)
+          expect(result.persisted_recipients).to be_a(Array)
+          expect(result.updated_count).to eq(0)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#post_recipient for same key' do
+      it '#patch_recipients' do
         begin
           params = {}
           params['email'] = @email1
-          params['last_name'] = @last_name1
-          params[@custom_field_name] = @pet1
-          @client.post_recipient(params: params)
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
-        end
-      end
-
-      it '#get_recipients' do
-        begin
-          recipients = @client.get_recipients(limit: 100, offset: 0)
-          expect(recipients.recipients.length).to be > 0
-          recipients.recipients.each do |recipient|
-            expect(
-              recipient
-            ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
-          end
+          params['last_name'] = 'JonesEdit'
+          result = @client.patch_recipients(params: [params])
+          expect(result.error_count).to eq(0)
+          expect(result.error_indices).to eq([])
+          expect(result.new_count).to eq(0)
+          expect(result.persisted_recipients).to be_a(Array)
+          expect(result.updated_count).to eq(1)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#get_recipient_count' do
+      it '#delete_recipients' do
         begin
-          actual_count = @client.get_recipients_count
-          expect(actual_count).to be >= 0
+          @client.delete_recipients(recipient_ids: @result.persisted_recipients)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#search_recipients' do
+      it '#get_recipients' do
         begin
-          params = {}
-          params['email'] = @email1
-          recipients = @client.search_recipients(params: params)
-          expect(recipients.recipients).to be_a(Array)
+          recipients = @client.get_recipients(page: 1, page_size: 100)
+          expect(recipients.recipients.length).to be > 0
+          recipients.recipients.each do |recipient|
+            expect(
+              recipient
+            ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
+          end
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
@@ -120,7 +101,9 @@ describe SendGrid4r::REST::Contacts::Recipients do
 
       it '#get_recipient' do
         begin
-          recipient = @client.get_recipient(recipient_id: @new_recipient.id)
+          recipient = @client.get_recipient(
+            recipient_id: @result.persisted_recipients[0]
+          )
           expect(
             recipient
           ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
@@ -130,58 +113,29 @@ describe SendGrid4r::REST::Contacts::Recipients do
         end
       end
 
-      it '#get_lists_recipient_belong' do
+      it '#delete_recipient' do
         begin
-          lists = @client.get_lists_recipient_belong(
-            recipient_id: @new_recipient.id
+          @client.delete_recipient(
+            recipient_id: @result.persisted_recipients[0]
           )
-          lists.lists.each do |list|
-            expect(
-              list.is_a?(SendGrid4r::REST::Contacts::Lists::List)
-            ).to eq(true)
-          end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
-        end
-      end
-
-      it '#post_recipients' do
-        begin
-          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
-          params = [recipient1, recipient2]
-          result = @client.post_recipients(params: params)
-          expect(result.error_count).to eq(0)
-          result.error_indices.each do |index|
-            expect(index).to be_a(Fixnum)
-          end
-          expect(result.new_count).to be_a(Fixnum)
-          expect(result.updated_count).to be_a(Fixnum)
+          expect do
+            @client.get_recipient(recipient_id: @result.persisted_recipients[0])
+          end.to raise_error(RestClient::ResourceNotFound)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#get_recipients_by_id' do
+      it '#get_lists_recipient_belong' do
         begin
-          recipient_ids = [@email1, @email2]
-          actual_recipients = @client.get_recipients_by_id(
-            recipient_ids: recipient_ids
+          lists = @client.get_lists_recipient_belong(
+            recipient_id: @result.persisted_recipients[0]
           )
-          expect(actual_recipients.recipients).to be_a(Array)
-          expect(actual_recipients.recipients.length).to eq(1)
-          actual_recipients.recipients.each do |recip|
+          lists.lists.each do |list|
             expect(
-              recip
-            ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
+              list.is_a?(SendGrid4r::REST::Contacts::Lists::List)
+            ).to eq(true)
           end
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
@@ -189,21 +143,22 @@ describe SendGrid4r::REST::Contacts::Recipients do
         end
       end
 
-      it '#delete_recipient' do
+      it '#get_recipient_count' do
         begin
-          @client.delete_recipient(recipient_id: @new_recipient.id)
-          expect do
-            @client.get_recipient(recipient_id: @new_recipient.id)
-          end.to raise_error(RestClient::ResourceNotFound)
+          actual_count = @client.get_recipients_count
+          expect(actual_count).to be >= 0
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#delete_recipients' do
+      it '#search_recipients' do
         begin
-          @client.delete_recipients(emails: [@email1, @email2])
+          params = {}
+          params['email'] = @email1
+          recipients = @client.search_recipients(params: params)
+          expect(recipients.recipients).to be_a(Array)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
@@ -223,7 +178,7 @@ describe SendGrid4r::REST::Contacts::Recipients do
           '"created_at": 1422313607,'\
           '"email": "jones@example.com",'\
           '"first_name": null,'\
-          '"id": "jones@example.com",'\
+          '"id": "YUBh",'\
           '"last_clicked": null,'\
           '"last_emailed": null,'\
           '"last_name": "Jones",'\
@@ -249,7 +204,7 @@ describe SendGrid4r::REST::Contacts::Recipients do
               '"created_at": 1422313607,'\
               '"email": "jones@example.com",'\
               '"first_name": null,'\
-              '"id": "jones@example.com",'\
+              '"id": "YUBh",'\
               '"last_clicked": null,'\
               '"last_emailed": null,'\
               '"last_name": "Jones",'\
@@ -307,68 +262,60 @@ describe SendGrid4r::REST::Contacts::Recipients do
       )
     end
 
-    it '#post_recipient' do
-      allow(client).to receive(:execute).and_return(recipient)
-      actual = client.post_recipient(params: {})
-      expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
+    it '#post_recipients' do
+      allow(client).to receive(:execute).and_return(result)
+      actual = client.post_recipients(params: {})
+      expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Result)
     end
 
-    it '#get_recipients' do
-      allow(client).to receive(:execute).and_return(recipients)
-      actual = client.get_recipients(limit: 0, offset: 0)
-      expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipients)
+    it '#patch_recipients' do
+      allow(client).to receive(:execute).and_return(result)
+      actual = client.patch_recipients(params: {})
+      expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Result)
     end
 
-    it '#get_recipient_count' do
-      allow(client).to receive(:execute).and_return(recipient_count)
-      actual = client.get_recipients_count
-      expect(actual).to be_a(Fixnum)
+    it '#delete_recipients' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_recipients(recipient_ids: ['', ''])
+      expect(actual).to eq('')
     end
 
-    it '#search_recipients' do
+    it '#get_recipients' do
       allow(client).to receive(:execute).and_return(recipients)
-      actual = client.search_recipients(params: {})
+      actual = client.get_recipients(page: 0, page_size: 0)
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipients)
     end
 
     it '#get_recipient' do
       allow(client).to receive(:execute).and_return(recipient)
-      actual = client.get_recipient(recipient_id: 0)
+      actual = client.get_recipient(recipient_id: '')
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
     end
 
+    it '#delete_recipient' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_recipient(recipient_id: '')
+      expect(actual).to eq('')
+    end
+
     it '#get_lists_recipient_belong' do
       allow(client).to receive(:execute).and_return(lists)
-      actual = client.get_lists_recipient_belong(recipient_id: 0)
+      actual = client.get_lists_recipient_belong(recipient_id: '')
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Lists::Lists)
     end
 
-    it '#post_recipients' do
-      allow(client).to receive(:execute).and_return(result)
-      actual = client.post_recipients(recipients: [{}, {}])
-      expect(actual).to be_a(
-        SendGrid4r::REST::Contacts::Recipients::ResultAddMultiple
-      )
+    it '#get_recipient_count' do
+      allow(client).to receive(:execute).and_return(recipient_count)
+      actual = client.get_recipients_count
+      expect(actual).to be_a(Fixnum)
     end
 
-    it '#get_recipients_by_id' do
+    it '#search_recipients' do
       allow(client).to receive(:execute).and_return(recipients)
-      actual = client.get_recipients_by_id(recipient_ids: ['', ''])
+      actual = client.search_recipients(params: {})
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipients)
     end
 
-    it '#delete_recipient' do
-      allow(client).to receive(:execute).and_return('')
-      actual = client.delete_recipient(recipient_id: 0)
-      expect(actual).to eq('')
-    end
-
-    it '#delete_recipients' do
-      allow(client).to receive(:execute).and_return('')
-      actual = client.delete_recipients(emails: ['', ''])
-      expect(actual).to eq('')
-    end
-
     it 'creates recipient instance' do
       actual = SendGrid4r::REST::Contacts::Recipients.create_recipient(
         recipient
@@ -377,7 +324,7 @@ describe SendGrid4r::REST::Contacts::Recipients do
       expect(actual.created_at).to eq(Time.at(1422313607))
       expect(actual.email).to eq('jones@example.com')
       expect(actual.first_name).to eq(nil)
-      expect(actual.id).to eq('jones@example.com')
+      expect(actual.id).to eq('YUBh')
       expect(actual.last_clicked).to eq(nil)
       expect(actual.last_emailed).to eq(nil)
       expect(actual.last_name).to eq('Jones')

data/spec/rest/contacts/segments_spec.rb

@@ -41,7 +41,7 @@ describe SendGrid4r::REST::Contacts::Segments do
           field: @field, value: @value, operator: @operator, and_or: @and_or
         )
         params1 = @segment_factory.create(
-          name: @name1, conditions: [@condition]
+          name: @name1, list_id: nil, conditions: [@condition]
         )
         @segment1 = @client.post_segment(params: params1)
       rescue RestClient::ExceptionWithResponse => e
@@ -53,13 +53,14 @@ describe SendGrid4r::REST::Contacts::Segments do
     context 'without block call' do
       it '#post_segment' do
         begin
+          lists = @client.get_lists
           params2 = @segment_factory.create(
-            name: @name2, conditions: [@condition]
+            name: @name2, list_id: lists.lists[0].id, conditions: [@condition]
           )
           segment = @client.post_segment(params: params2)
           expect(segment.id).to be_a(Fixnum)
           expect(segment.name).to eq(@name2)
-          expect(segment.list_id).to eq(nil)
+          expect(segment.list_id).to eq(lists.lists[0].id)
           expect(segment.conditions.length).to eq(1)
           expect(segment.recipient_count).to eq(0)
           condition = segment.conditions[0]
@@ -106,13 +107,12 @@ describe SendGrid4r::REST::Contacts::Segments do
         end
       end
 
-      it '#put_segment' do
+      it '#patch_segment' do
         begin
-          pending 'waiting for sendgrid documentation update'
           edit_params = @segment_factory.create(
             name: @edit_name1, conditions: [@condition]
           )
-          edit_segment = @client.put_segment(
+          edit_segment = @client.patch_segment(
             segment_id: @segment1.id, params: edit_params
           )
           expect(edit_segment.name).to eq(@edit_name1)
@@ -122,116 +122,31 @@ describe SendGrid4r::REST::Contacts::Segments do
         end
       end
 
-      it '#get_recipients_from_segment' do
+      it '#delete_segment' do
         begin
-          # list recipients from a single segment
-          recipients = @client.get_recipients_from_segment(
-            segment_id: @segment1.id
-          )
-          recipients.recipients.each do |recipient|
-            expect(
-              recipient
-            ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
-          end
+          @client.delete_segment(segment_id: @segment1.id)
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
 
-      it '#delete_segment' do
+      it '#get_recipients_on_segment' do
         begin
-          # delete the segment
-          @client.delete_segment(segment_id: @segment1.id)
+          recipients = @client.get_recipients_on_segment(
+            segment_id: @segment1.id
+          )
+          recipients.recipients.each do |recipient|
+            expect(
+              recipient
+            ).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipient)
+          end
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
         end
       end
     end
-
-    context 'with block all' do
-      it '#post_segment' do
-        params2 = @segment_factory.create(
-          name: @name2, conditions: [@condition]
-        )
-        @client.post_segment(params: params2) do |resp, req, res|
-          resp =
-            SendGrid4r::REST::Contacts::Segments.create_segment(
-              JSON.parse(resp)
-            )
-          expect(resp).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPCreated)
-        end
-      end
-
-      it '#get_segments' do
-        @client.get_segments do |resp, req, res|
-          resp =
-            SendGrid4r::REST::Contacts::Segments.create_segments(
-              JSON.parse(resp)
-            )
-          expect(resp).to be_a(SendGrid4r::REST::Contacts::Segments::Segments)
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPOK)
-        end
-      end
-
-      it '#get_segment' do
-        @client.get_segment(segment_id: @segment1.id) do |resp, req, res|
-          resp =
-            SendGrid4r::REST::Contacts::Segments.create_segment(
-              JSON.parse(resp)
-            )
-          expect(resp).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPOK)
-        end
-      end
-
-      it '#put_segment' do
-        pending 'waiting for sendgrid documentation update'
-        edit_params = @segment_factory.create(
-          name: @edit_name1, conditions: [@condition]
-        )
-        @client.put_segment(
-          segment_id: @segment1.id, params: edit_params
-        ) do |resp, req, res|
-          resp =
-            SendGrid4r::REST::Contacts::Segments.create_segment(
-              JSON.parse(resp)
-            )
-          expect(resp).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPOK)
-        end
-      end
-
-      it '#get_recipients_from_segment' do
-        @client.get_recipients_from_segment(
-          segment_id: @segment1.id
-        ) do |resp, req, res|
-          resp =
-            SendGrid4r::REST::Contacts::Recipients.create_recipients(
-              JSON.parse(resp)
-            )
-          expect(resp).to be_a(
-            SendGrid4r::REST::Contacts::Recipients::Recipients
-          )
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPOK)
-        end
-      end
-
-      it '#delete_segment' do
-        @client.delete_segment(segment_id: @segment1.id) do |resp, req, res|
-          expect(resp).to eq('')
-          expect(req).to be_a(RestClient::Request)
-          expect(res).to be_a(Net::HTTPNoContent)
-        end
-      end
-    end
   end
 
   describe 'unit test', :ut do
@@ -255,7 +170,7 @@ describe SendGrid4r::REST::Contacts::Segments do
         '{'\
           '"id": 1,'\
           '"name": "Last Name Miller",'\
-          '"list_id": null,'\
+          '"list_id": 4,'\
           '"conditions": ['\
             '{'\
               '"field": "last_name",'\
@@ -276,7 +191,7 @@ describe SendGrid4r::REST::Contacts::Segments do
             '{'\
               '"id": 1,'\
               '"name": "Last Name Miller",'\
-              '"list_id": null,'\
+              '"list_id": 4,'\
               '"conditions": ['\
                 '{'\
                   '"field": "last_name",'\
@@ -338,15 +253,15 @@ describe SendGrid4r::REST::Contacts::Segments do
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
     end
 
-    it '#put_segment' do
+    it '#patch_segment' do
       allow(client).to receive(:execute).and_return(segment)
-      actual = client.put_segment(segment_id: 0, params: nil)
+      actual = client.patch_segment(segment_id: 0, params: nil)
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
     end
 
-    it '#get_recipients_from_segment' do
+    it '#get_recipients_on_segment' do
       allow(client).to receive(:execute).and_return(recipients)
-      actual = client.get_recipients_from_segment(segment_id: 0)
+      actual = client.get_recipients_on_segment(segment_id: 0)
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Recipients::Recipients)
     end
 
@@ -370,7 +285,7 @@ describe SendGrid4r::REST::Contacts::Segments do
       expect(actual).to be_a(SendGrid4r::REST::Contacts::Segments::Segment)
       expect(actual.id).to eq(1)
       expect(actual.name).to eq('Last Name Miller')
-      expect(actual.list_id).to eq(nil)
+      expect(actual.list_id).to eq(4)
       expect(actual.conditions).to be_a(Array)
       actual.conditions.each do |condition|
         expect(condition).to be_a(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid4r
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - awwa500@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -122,6 +122,7 @@ files:
 - lib/auth.rb
 - lib/client.rb
 - lib/sendgrid4r.rb
+- lib/sendgrid4r/factory/campaign_factory.rb
 - lib/sendgrid4r/factory/condition_factory.rb
 - lib/sendgrid4r/factory/segment_factory.rb
 - lib/sendgrid4r/factory/version_factory.rb
@@ -131,6 +132,7 @@ files:
 - lib/sendgrid4r/rest/asm/global_suppressions.rb
 - lib/sendgrid4r/rest/asm/groups.rb
 - lib/sendgrid4r/rest/asm/suppressions.rb
+- lib/sendgrid4r/rest/campaigns/campaigns.rb
 - lib/sendgrid4r/rest/categories/categories.rb
 - lib/sendgrid4r/rest/contacts/custom_fields.rb
 - lib/sendgrid4r/rest/contacts/lists.rb
@@ -163,6 +165,7 @@ files:
 - lib/sendgrid4r/version.rb
 - sendgrid4r.gemspec
 - spec/client_spec.rb
+- spec/factory/campaign_factory_spec.rb
 - spec/factory/condition_factory_spec.rb
 - spec/factory/segment_factory_spec.rb
 - spec/factory/version_factory_spec.rb
@@ -171,6 +174,7 @@ files:
 - spec/rest/asm/global_suppressions_spec.rb
 - spec/rest/asm/groups_spec.rb
 - spec/rest/asm/suppressions_spec.rb
+- spec/rest/campaigns/campaigns_spec.rb
 - spec/rest/categories/categories_spec.rb
 - spec/rest/contacts/custom_fields_spec.rb
 - spec/rest/contacts/lists_spec.rb
@@ -226,6 +230,7 @@ specification_version: 4
 summary: SendGrid Web API v3 module
 test_files:
 - spec/client_spec.rb
+- spec/factory/campaign_factory_spec.rb
 - spec/factory/condition_factory_spec.rb
 - spec/factory/segment_factory_spec.rb
 - spec/factory/version_factory_spec.rb
@@ -234,6 +239,7 @@ test_files:
 - spec/rest/asm/global_suppressions_spec.rb
 - spec/rest/asm/groups_spec.rb
 - spec/rest/asm/suppressions_spec.rb
+- spec/rest/campaigns/campaigns_spec.rb
 - spec/rest/categories/categories_spec.rb
 - spec/rest/contacts/custom_fields_spec.rb
 - spec/rest/contacts/lists_spec.rb