sendgrid4r 1.8.1 → 1.10.0

data/spec/rest/cancel_scheduled_sends_spec.rb

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

data/spec/rest/categories_spec.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module SendGrid4r::REST
+  describe Categories do
+    describe 'integration test', :it do
+      before do
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+      end
+
+      context 'without block call' do
+        it '#get_categories if no params' do
+          categories = @client.get_categories
+          expect(categories.length).to be >= 0
+          categories.each do |category|
+            expect(category.category).to be_a(String)
+          end
+        end
+
+        it '#get_categories if name was specified' do
+          categories = @client.get_categories(category: 'Newsletter')
+          expect(categories.length).to eq(1)
+          categories.each do |category|
+            expect(category.category).to eq('Newsletter')
+          end
+        end
+
+        it '#get_categories if offset & limit were specified' do
+          categories = @client.get_categories(
+            category: nil, limit: 5, offset: 2
+          )
+          expect(categories.length).to be > 0
+          categories.each do |category|
+            expect(category.category).to be_a(String)
+          end
+        end
+      end
+    end
+
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
+
+      let(:categories) do
+        JSON.parse(
+          '['\
+            '{"category": "cat1"},'\
+            '{"category": "cat2"},'\
+            '{"category": "cat3"},'\
+            '{"category": "cat4"},'\
+            '{"category": "cat5"}'\
+          ']'
+        )
+      end
+
+      it '#get_categories' do
+        allow(client).to receive(:execute).and_return(categories)
+        actual = client.get_categories
+        expect(actual).to be_a(Array)
+        actual.each do |category|
+          expect(category).to be_a(Categories::Category)
+        end
+      end
+
+      it 'creates categories instance' do
+        actual = Categories.create_categories(categories)
+        expect(actual).to be_a(Array)
+        actual.each do |category|
+          expect(category).to be_a(Categories::Category)
+          expect(category.category).to be_a(String)
+        end
+      end
+    end
+  end
+end

data/spec/rest/email_activity_spec.rb

@@ -0,0 +1,151 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module SendGrid4r::REST
+  describe EmailActivity 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 '#get_email_activities' do
+          activities = @client.get_email_activities
+          activities.each do |activity|
+            expect(activity).to be_a(EmailActivity::Activity)
+          end
+        end
+
+        it '#get_email_activities with email' do
+          activities = @client.get_email_activities(email: 'test@test.com')
+          activities.each do |activity|
+            expect(activity).to be_a(EmailActivity::Activity)
+          end
+        end
+
+        it '#get_email_activities with events' do
+          activities = @client.get_email_activities(
+            events: [SendGrid4r::Client::Event::DROPS]
+          )
+          expect(activities.length).to be >= 0
+          activities.each do |activity|
+            expect(activity).to be_a(EmailActivity::Activity)
+            expect(activity.event).to eq('drop')
+          end
+        end
+
+        it '#get_email_activities with multiple events' do
+          events = []
+          events.push(SendGrid4r::Client::Event::DROPS)
+          events.push(SendGrid4r::Client::Event::DELIVERED)
+          events.push(SendGrid4r::Client::Event::BOUNCES)
+          events.push(SendGrid4r::Client::Event::CLICKS)
+          events.push(SendGrid4r::Client::Event::DEFERRED)
+          events.push(SendGrid4r::Client::Event::DELIVERED)
+          events.push(SendGrid4r::Client::Event::DROPS)
+          events.push(SendGrid4r::Client::Event::GROUP_UNSUBSCRIBE)
+          events.push(SendGrid4r::Client::Event::GROUP_RESUBSCRIBE)
+          events.push(SendGrid4r::Client::Event::OPENS)
+          events.push(SendGrid4r::Client::Event::PROCESSED)
+          events.push(SendGrid4r::Client::Event::PARSEAPI)
+          events.push(SendGrid4r::Client::Event::SPAM_REPORTS)
+          events.push(SendGrid4r::Client::Event::UNSUBSCRIBE)
+          activities = @client.get_email_activities(events: events)
+          expect(activities.length).to be >= 0
+          activities.each do |activity|
+            expect(activity).to be_a(EmailActivity::Activity)
+          end
+        end
+
+        it '#get_email_activities with start_time and end_time' do
+          pending('unknown field')
+          start_time = Time.local(2015, 5, 20, 12, 23, 45)
+          end_time = Time.local(2015, 5, 23, 12, 23, 45)
+          activities = @client.get_email_activities(
+            start_time: start_time, end_time: end_time
+          )
+          expect(activities.length).to be >= 0
+          activities.each do |activity|
+            expect(activity).to be_a(EmailActivity::Activity)
+            puts activity.inspect
+          end
+        end
+      end
+    end
+
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
+
+      let(:activities) do
+        JSON.parse(
+          '['\
+            '{'\
+              '"email": "test@example.com",'\
+              '"event": "processed",'\
+              '"created": 1431624000,'\
+              '"category": ["my_category"],'\
+              '"smtp_id": "filter001-2348927389",'\
+              '"asm_group_id": null,'\
+              '"msg_id": "xxx-abc-123",'\
+              '"ip": null,'\
+              '"url": null'\
+            '}'\
+          ']'
+        )
+      end
+
+      let(:activity) do
+        JSON.parse(
+          '{'\
+            '"email": "test@example.com",'\
+            '"event": "processed",'\
+            '"created": 1431624000,'\
+            '"category": ["my_category"],'\
+            '"smtp_id": "filter001-2348927389",'\
+            '"asm_group_id": null,'\
+            '"msg_id": "xxx-abc-123",'\
+            '"ip": null,'\
+            '"url": null'\
+          '}'\
+        )
+      end
+
+      it '#get_email_activities' do
+        allow(client).to receive(:execute).and_return(activities)
+        actual = client.get_email_activities
+        expect(actual).to be_a(Array)
+        actual.each do |activity|
+          expect(activity).to be_a(EmailActivity::Activity)
+        end
+      end
+
+      it 'creates activity instance' do
+        actual = EmailActivity.create_activity(activity)
+        expect(actual).to be_a(EmailActivity::Activity)
+        expect(actual.email).to eq('test@example.com')
+        expect(actual.event).to eq('processed')
+        expect(actual.created).to eq(Time.at(1431624000))
+        expect(actual.category).to be_a(Array)
+        actual.category.each do |category|
+          expect(category).to eq('my_category')
+        end
+        expect(actual.smtp_id).to eq('filter001-2348927389')
+        expect(actual.asm_group_id).to eq(nil)
+        expect(actual.msg_id).to eq('xxx-abc-123')
+        expect(actual.ip).to eq(nil)
+        expect(actual.url).to eq(nil)
+      end
+
+      it 'creates activities instance' do
+        actual = EmailActivity.create_activities(activities)
+        expect(actual).to be_a(Array)
+        actual.each do |activity|
+          expect(activity).to be_a(EmailActivity::Activity)
+        end
+      end
+    end
+  end
+end