sendgrid4r 0.3.0 → 0.4.0

data/spec/rest/email_activity/email_activity_spec.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SendGrid4r::REST::EmailActivity do
+  describe 'integration test', :it do
+    before do
+      begin
+        Dotenv.load
+        @client = SendGrid4r::Client.new(
+          username: ENV['SENDGRID_USERNAME'],
+          password: ENV['SENDGRID_PASSWORD'])
+      rescue => e
+        puts e.inspect
+        raise e
+      end
+    end
+
+    context 'without block call' do
+      it '#get_email_activities' do
+        begin
+          activities = @client.get_email_activities
+          activities.each do |activity|
+            expect(activity).to be_a(SendGrid4r::REST::EmailActivity::Activity)
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_email_activities with email' do
+        begin
+          activities = @client.get_email_activities(email: 'test@test.com')
+          activities.each do |activity|
+            expect(activity).to be_a(SendGrid4r::REST::EmailActivity::Activity)
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_email_activities with events' do
+        begin
+          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(SendGrid4r::REST::EmailActivity::Activity)
+            expect(activity.event).to eq('drop')
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_email_activities with multiple events' do
+        begin
+          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(SendGrid4r::REST::EmailActivity::Activity)
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+
+      it '#get_email_activities with start_time and end_time' do
+        begin
+          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(SendGrid4r::REST::EmailActivity::Activity)
+            puts activity.inspect
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+    end
+
+    context 'with block call' do
+      it '#get_email_activities' do
+        @client.get_api_keys do |resp, req, res|
+          resp =
+            SendGrid4r::REST::ApiKeys.create_api_keys(JSON.parse(resp))
+          expect(resp).to be_a(SendGrid4r::REST::ApiKeys::ApiKeys)
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPOK)
+        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(SendGrid4r::REST::EmailActivity::Activity)
+      end
+    end
+
+    it 'creates activity instance' do
+      actual = SendGrid4r::REST::EmailActivity.create_activity(activity)
+      expect(actual).to be_a(SendGrid4r::REST::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 = SendGrid4r::REST::EmailActivity.create_activities(activities)
+      expect(actual).to be_a(Array)
+      actual.each do |activity|
+        expect(activity).to be_a(SendGrid4r::REST::EmailActivity::Activity)
+      end
+    end
+  end
+end

data/spec/{ips → rest/ips}/addresses_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Ips::Addresses do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(
@@ -159,9 +159,26 @@ describe SendGrid4r::REST::Ips::Addresses do
       end
     end
 
-    describe 'unit test' do
-      it 'creates addresses instance' do
-        json =
+    describe 'unit test', :ut do
+      let(:client) do
+        SendGrid4r::Client.new(api_key: '')
+      end
+
+      let(:address) do
+        JSON.parse(
+          '{'\
+            '"ip": "000.00.00.0",'\
+            '"pools": ['\
+              '"test1"'\
+            '],'\
+            '"start_date": 1409616000,'\
+            '"warmup": true'\
+          '}'
+        )
+      end
+
+      let(:addresses) do
+        JSON.parse(
           '['\
             '{'\
               '"ip":"000.00.00.0",'\
@@ -173,8 +190,41 @@ describe SendGrid4r::REST::Ips::Addresses do
               '"pools": ["pool1", "pool2"]'\
             '}'\
           ']'
-        hash = JSON.parse(json)
-        actual = SendGrid4r::REST::Ips::Addresses.create_addresses(hash)
+        )
+      end
+
+      it '#get_ips' do
+        allow(client).to receive(:execute).and_return(addresses)
+        actual = client.get_ips
+        expect(actual).to be_a(Array)
+        actual.each do |address|
+          expect(address).to be_a(SendGrid4r::REST::Ips::Addresses::Address)
+        end
+      end
+
+      it '#get_ips_assigned' do
+        allow(client).to receive(:execute).and_return(addresses)
+        actual = client.get_ips_assigned
+        expect(actual).to be_a(Array)
+        actual.each do |address|
+          expect(address).to be_a(SendGrid4r::REST::Ips::Addresses::Address)
+        end
+      end
+
+      it '#get_ip' do
+        allow(client).to receive(:execute).and_return(address)
+        actual = client.get_ip('')
+        expect(actual).to be_a(SendGrid4r::REST::Ips::Addresses::Address)
+      end
+
+      it '#post_ip_to_pool' do
+        allow(client).to receive(:execute).and_return(address)
+        actual = client.post_ip_to_pool('', '')
+        expect(actual).to be_a(SendGrid4r::REST::Ips::Addresses::Address)
+      end
+
+      it 'creates addresses instance' do
+        actual = SendGrid4r::REST::Ips::Addresses.create_addresses(addresses)
         expect(actual).to be_a(Array)
         actual.each do |address|
           expect(
@@ -184,17 +234,7 @@ describe SendGrid4r::REST::Ips::Addresses do
       end
 
       it 'creates address instance' do
-        json =
-          '{'\
-            '"ip": "000.00.00.0",'\
-            '"pools": ['\
-              '"test1"'\
-            '],'\
-            '"start_date": 1409616000,'\
-            '"warmup": true'\
-          '}'
-        hash = JSON.parse(json)
-        actual = SendGrid4r::REST::Ips::Addresses.create_address(hash)
+        actual = SendGrid4r::REST::Ips::Addresses.create_address(address)
         expect(actual).to be_a(SendGrid4r::REST::Ips::Addresses::Address)
         expect(actual.ip).to eq('000.00.00.0')
         expect(actual.pools).to be_a(Array)

data/spec/{ips → rest/ips}/pools_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Ips::Pools do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       begin
         Dotenv.load
@@ -145,54 +145,89 @@ describe SendGrid4r::REST::Ips::Pools do
         end
       end
     end
+  end
 
-    describe 'unit test' do
-      it 'creates pool instance' do
-        json = '{"name":"marketing"}'
-        hash = JSON.parse(json)
-        actual = SendGrid4r::REST::Ips::Pools.create_pool(hash)
-        expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
-        expect(actual.name).to eq('marketing')
-      end
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
 
-      it 'creates pool instance with ips' do
-        json =
+    let(:pool) do
+      JSON.parse(
+        '{'\
+          '"ips":["167.89.21.3"],'\
+          '"name":"new_test5"'\
+        '}'
+      )
+    end
+
+    let(:pools) do
+      JSON.parse(
+        '['\
           '{'\
-            '"ips":["167.89.21.3"],'\
-            '"name":"new_test5"'\
-          '}'
-        hash = JSON.parse(json)
-        actual = SendGrid4r::REST::Ips::Pools.create_pool(hash)
-        expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
-        expect(actual.ips).to be_a(Array)
-        actual.ips.each do |ip|
-          expect(ip).to eq('167.89.21.3')
-        end
-        expect(actual.name).to eq('new_test5')
+            '"name": "test1"'\
+          '},'\
+          '{'\
+            '"name": "test2"'\
+          '},'\
+          '{'\
+            '"name": "test3"'\
+          '},'\
+          '{'\
+            '"name": "new_test3"'\
+          '}'\
+        ']'
+      )
+    end
+
+    it '#post_pool' do
+      allow(client).to receive(:execute).and_return(pool)
+      actual = client.post_pool('')
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
+    end
+
+    it '#get_pools' do
+      allow(client).to receive(:execute).and_return(pools)
+      actual = client.get_pools
+      expect(actual).to be_a(Array)
+      actual.each do |pool|
+        expect(pool).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
       end
+    end
 
-      it 'creates pool instances' do
-        json =
-          '['\
-            '{'\
-              '"name": "test1"'\
-            '},'\
-            '{'\
-              '"name": "test2"'\
-            '},'\
-            '{'\
-              '"name": "test3"'\
-            '},'\
-            '{'\
-              '"name": "new_test3"'\
-            '}'\
-          ']'
-        hash = JSON.parse(json)
-        actual = SendGrid4r::REST::Ips::Pools.create_pools(hash)
-        expect(actual).to be_a(Array)
-        actual.each do |pool|
-          expect(pool).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
-        end
+    it '#get_pool' do
+      allow(client).to receive(:execute).and_return(pool)
+      actual = client.get_pool('')
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
+    end
+
+    it '#put_pool' do
+      allow(client).to receive(:execute).and_return(pool)
+      actual = client.put_pool('', '')
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
+    end
+
+    it '#delete_pool' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_pool('')
+      expect(actual).to eq('')
+    end
+
+    it 'creates pool instance with ips' do
+      actual = SendGrid4r::REST::Ips::Pools.create_pool(pool)
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
+      expect(actual.ips).to be_a(Array)
+      actual.ips.each do |ip|
+        expect(ip).to eq('167.89.21.3')
+      end
+      expect(actual.name).to eq('new_test5')
+    end
+
+    it 'creates pools instances' do
+      actual = SendGrid4r::REST::Ips::Pools.create_pools(pools)
+      expect(actual).to be_a(Array)
+      actual.each do |pool|
+        expect(pool).to be_a(SendGrid4r::REST::Ips::Pools::Pool)
       end
     end
   end

data/spec/{ips → rest/ips}/warmup_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Ips::Warmup do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(
@@ -98,17 +98,60 @@ describe SendGrid4r::REST::Ips::Warmup do
     end
   end
 
-  describe 'unit test' do
-    it 'creates warmup_ip instance' do
-      json =
+  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
+
+    let(:warmup_ips) do
+      JSON.parse(
         '['\
           '{'\
             '"ip": "0.0.0.0",'\
             '"start_date": 1409616000'\
           '}'\
         ']'
-      hash = JSON.parse(json)
-      actual = SendGrid4r::REST::Ips::Warmup.create_warmup_ips(hash)
+      )
+    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)
+      end
+    end
+
+    it '#get_warmup_ip' do
+      allow(client).to receive(:execute).and_return(warmup_ip)
+      actual = client.get_warmup_ip('')
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
+    end
+
+    it '#post_warmup_ip' do
+      allow(client).to receive(:execute).and_return(warmup_ip)
+      actual = client.post_warmup_ip('')
+      expect(actual).to be_a(SendGrid4r::REST::Ips::Warmup::WarmupIp)
+    end
+
+    it '#delete_warmup_ip' do
+      allow(client).to receive(:execute).and_return('')
+      actual = client.delete_warmup_ip('')
+      expect(actual).to eq('')
+    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)

data/spec/{settings → rest/settings}/enforced_tls_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Settings::EnforcedTls do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(
@@ -76,15 +76,40 @@ describe SendGrid4r::REST::Settings::EnforcedTls do
     end
   end
 
-  describe 'unit test' do
-    it 'creates enforced_tls instance' do
-      json =
+  describe 'unit test', :ut do
+    let(:client) do
+      SendGrid4r::Client.new(api_key: '')
+    end
+
+    let(:enforced_tls) do
+      JSON.parse(
         '{'\
           '"require_tls": true,'\
           '"require_valid_cert": false'\
         '}'
-      hash = JSON.parse(json)
-      actual = SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(hash)
+      )
+    end
+
+    it '#get_enforced_tls' do
+      allow(client).to receive(:execute).and_return(enforced_tls)
+      actual = client.get_enforced_tls
+      expect(actual).to be_a(
+        SendGrid4r::REST::Settings::EnforcedTls::EnforcedTls
+      )
+    end
+
+    it '#patch_enforced_tls' do
+      allow(client).to receive(:execute).and_return(enforced_tls)
+      actual = client.patch_enforced_tls(nil)
+      expect(actual).to be_a(
+        SendGrid4r::REST::Settings::EnforcedTls::EnforcedTls
+      )
+    end
+
+    it 'creates enforced_tls instance' do
+      actual = SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(
+        enforced_tls
+      )
       expect(actual.require_tls).to eq(true)
       expect(actual.require_valid_cert).to eq(false)
     end

data/spec/{stats → rest/stats}/advanced_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats::Advanced do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(

data/spec/{stats → rest/stats}/category_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats::Category do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(

data/spec/{stats → rest/stats}/global_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats::Global do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(

data/spec/{stats → rest/stats}/parse_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats::Parse do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(

data/spec/{stats → rest/stats}/stats_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats do
-  describe 'unit test' do
+  describe 'unit test', :ut do
     it 'creates top_stats instance' do
       json =
         '['\

data/spec/{stats → rest/stats}/subuser_spec.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe SendGrid4r::REST::Stats::Subuser do
-  describe 'integration test' do
+  describe 'integration test', :it do
     before do
       Dotenv.load
       @client = SendGrid4r::Client.new(