sendgrid4r 1.8.1 → 1.10.0

data/spec/rest/stats/stats_spec.rb

@@ -1,11 +1,125 @@
 # encoding: utf-8
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe SendGrid4r::REST::Stats do
-  describe 'unit test', :ut do
-    it 'creates top_stats instance' do
-      json =
-        '['\
+module SendGrid4r::REST::Stats
+  describe SendGrid4r::REST::Stats do
+    describe 'unit test', :ut do
+      it 'creates top_stats instance' do
+        json =
+          '['\
+            '{'\
+              '"date": "2015-01-01",'\
+              '"stats": ['\
+                '{'\
+                  '"metrics": {'\
+                    '"blocks": 0,'\
+                    '"bounce_drops": 0,'\
+                    '"bounces": 0,'\
+                    '"clicks": 0,'\
+                    '"deferred": 0,'\
+                    '"delivered": 0,'\
+                    '"invalid_emails": 0,'\
+                    '"opens": 0,'\
+                    '"processed": 0,'\
+                    '"requests": 0,'\
+                    '"spam_report_drops": 0,'\
+                    '"spam_reports": 0,'\
+                    '"unique_clicks": 0,'\
+                    '"unique_opens": 0,'\
+                    '"unsubscribe_drops": 0,'\
+                    '"unsubscribes": 0'\
+                  '},'\
+                  '"name": "cat1",'\
+                  '"type": "category"'\
+                '},'\
+                '{'\
+                  '"metrics": {'\
+                    '"blocks": 0,'\
+                    '"bounce_drops": 0,'\
+                    '"bounces": 0,'\
+                    '"clicks": 0,'\
+                    '"deferred": 0,'\
+                    '"delivered": 0,'\
+                    '"invalid_emails": 0,'\
+                    '"opens": 0,'\
+                    '"processed": 0,'\
+                    '"requests": 0,'\
+                    '"spam_report_drops": 0,'\
+                    '"spam_reports": 0,'\
+                    '"unique_clicks": 0,'\
+                    '"unique_opens": 0,'\
+                    '"unsubscribe_drops": 0,'\
+                    '"unsubscribes": 0'\
+                  '},'\
+                  '"name": "cat2",'\
+                  '"type": "category"'\
+                '}'\
+              ']'\
+            '},'\
+            '{'\
+              '"date": "2015-01-02",'\
+              '"stats": ['\
+                '{'\
+                  '"metrics": {'\
+                    '"blocks": 10,'\
+                    '"bounce_drops": 0,'\
+                    '"bounces": 0,'\
+                    '"clicks": 0,'\
+                    '"deferred": 0,'\
+                    '"delivered": 0,'\
+                    '"invalid_emails": 0,'\
+                    '"opens": 0,'\
+                    '"processed": 0,'\
+                    '"requests": 10,'\
+                    '"spam_report_drops": 0,'\
+                    '"spam_reports": 0,'\
+                    '"unique_clicks": 0,'\
+                    '"unique_opens": 0,'\
+                    '"unsubscribe_drops": 0,'\
+                    '"unsubscribes": 0'\
+                  '},'\
+                  '"name": "cat1",'\
+                  '"type": "category"'\
+                '},'\
+                '{'\
+                  '"metrics": {'\
+                    '"blocks": 0,'\
+                    '"bounce_drops": 0,'\
+                    '"bounces": 0,'\
+                    '"clicks": 6,'\
+                    '"deferred": 0,'\
+                    '"delivered": 5,'\
+                    '"invalid_emails": 0,'\
+                    '"opens": 6,'\
+                    '"processed": 0,'\
+                    '"requests": 5,'\
+                    '"spam_report_drops": 0,'\
+                    '"spam_reports": 0,'\
+                    '"unique_clicks": 5,'\
+                    '"unique_opens": 5,'\
+                    '"unsubscribe_drops": 0,'\
+                    '"unsubscribes": 6'\
+                  '},'\
+                  '"name": "cat2",'\
+                  '"type": "category"'\
+                '}'\
+              ']'\
+            '}'\
+          ']'
+        hash = JSON.parse(json)
+        actual = SendGrid4r::REST::Stats.create_top_stats(hash)
+        expect(actual).to be_a(Array)
+        actual.each do |top_stat|
+          expect(top_stat).to be_a(TopStat)
+          top_stat.stats.each do |stat|
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
+          end
+        end
+      end
+
+      it 'creates top_stat instance' do
+        json =
           '{'\
             '"date": "2015-01-01",'\
             '"stats": ['\
@@ -14,70 +128,65 @@ describe SendGrid4r::REST::Stats do
                   '"blocks": 0,'\
                   '"bounce_drops": 0,'\
                   '"bounces": 0,'\
-                  '"clicks": 0,'\
+                  '"clicks": 20,'\
                   '"deferred": 0,'\
-                  '"delivered": 0,'\
+                  '"delivered": 20,'\
                   '"invalid_emails": 0,'\
-                  '"opens": 0,'\
+                  '"opens": 20,'\
                   '"processed": 0,'\
-                  '"requests": 0,'\
+                  '"requests": 20,'\
                   '"spam_report_drops": 0,'\
                   '"spam_reports": 0,'\
-                  '"unique_clicks": 0,'\
-                  '"unique_opens": 0,'\
+                  '"unique_clicks": 20,'\
+                  '"unique_opens": 20,'\
                   '"unsubscribe_drops": 0,'\
-                  '"unsubscribes": 0'\
+                  '"unsubscribes": 20'\
                 '},'\
                 '"name": "cat1",'\
                 '"type": "category"'\
               '},'\
               '{'\
                 '"metrics": {'\
-                  '"blocks": 0,'\
+                  '"blocks": 1,'\
                   '"bounce_drops": 0,'\
                   '"bounces": 0,'\
-                  '"clicks": 0,'\
+                  '"clicks": 19,'\
                   '"deferred": 0,'\
-                  '"delivered": 0,'\
+                  '"delivered": 19,'\
                   '"invalid_emails": 0,'\
-                  '"opens": 0,'\
+                  '"opens": 19,'\
                   '"processed": 0,'\
-                  '"requests": 0,'\
+                  '"requests": 20,'\
                   '"spam_report_drops": 0,'\
                   '"spam_reports": 0,'\
-                  '"unique_clicks": 0,'\
-                  '"unique_opens": 0,'\
+                  '"unique_clicks": 19,'\
+                  '"unique_opens": 19,'\
                   '"unsubscribe_drops": 0,'\
-                  '"unsubscribes": 0'\
+                  '"unsubscribes": 19'\
                 '},'\
                 '"name": "cat2",'\
                 '"type": "category"'\
-              '}'\
-            ']'\
-          '},'\
-          '{'\
-            '"date": "2015-01-02",'\
-            '"stats": ['\
+              '},'\
               '{'\
                 '"metrics": {'\
-                  '"blocks": 10,'\
+                  '"blocks": 0,'\
                   '"bounce_drops": 0,'\
                   '"bounces": 0,'\
-                  '"clicks": 0,'\
                   '"deferred": 0,'\
-                  '"delivered": 0,'\
+                  '"clicks": 5,'\
+                  '"delivered": 5,'\
                   '"invalid_emails": 0,'\
-                  '"opens": 0,'\
+                  '"opens": 5,'\
                   '"processed": 0,'\
-                  '"requests": 10,'\
+                  '"requests": 5,'\
                   '"spam_report_drops": 0,'\
                   '"spam_reports": 0,'\
-                  '"unique_clicks": 0,'\
-                  '"unique_opens": 0,'\
+                  '"unique_clicks": 5,'\
+                  '"unique_opens": 5,'\
                   '"unsubscribe_drops": 0,'\
-                  '"unsubscribes": 0'\
+                  '"unsubscribes": 5'\
                 '},'\
-                '"name": "cat1",'\
+                '"name": "cat3",'\
                 '"type": "category"'\
               '},'\
               '{'\
@@ -99,148 +208,41 @@ describe SendGrid4r::REST::Stats do
                   '"unsubscribe_drops": 0,'\
                   '"unsubscribes": 6'\
                 '},'\
-                '"name": "cat2",'\
+                '"name": "cat4",'\
+                '"type": "category"'\
+              '},'\
+              '{'\
+                '"metrics": {'\
+                  '"blocks": 10,'\
+                  '"bounce_drops": 0,'\
+                  '"bounces": 0,'\
+                  '"clicks": 0,'\
+                  '"deferred": 0,'\
+                  '"delivered": 0,'\
+                  '"invalid_emails": 0,'\
+                  '"opens": 0,'\
+                  '"processed": 0,'\
+                  '"requests": 10,'\
+                  '"spam_report_drops": 0,'\
+                  '"spam_reports": 0,'\
+                  '"unique_clicks": 0,'\
+                  '"unique_opens": 0,'\
+                  '"unsubscribe_drops": 0,'\
+                  '"unsubscribes": 0'\
+                '},'\
+                '"name": "cat5",'\
                 '"type": "category"'\
               '}'\
             ']'\
-          '}'\
-        ']'
-      hash = JSON.parse(json)
-      actual = SendGrid4r::REST::Stats.create_top_stats(hash)
-      expect(actual).to be_a(Array)
-      actual.each do |top_stat|
-        expect(top_stat).to be_a(SendGrid4r::REST::Stats::TopStat)
-        top_stat.stats.each do |stat|
-          expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-          expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
+          '}'
+        hash = JSON.parse(json)
+        actual = SendGrid4r::REST::Stats.create_top_stat(hash)
+        expect(actual).to be_a(TopStat)
+        actual.stats.each do |stat|
+          expect(stat).to be_a(Stat)
+          expect(stat.metrics).to be_a(Metric)
         end
       end
     end
-
-    it 'creates top_stat instance' do
-      json =
-        '{'\
-          '"date": "2015-01-01",'\
-          '"stats": ['\
-            '{'\
-              '"metrics": {'\
-                '"blocks": 0,'\
-                '"bounce_drops": 0,'\
-                '"bounces": 0,'\
-                '"clicks": 20,'\
-                '"deferred": 0,'\
-                '"delivered": 20,'\
-                '"invalid_emails": 0,'\
-                '"opens": 20,'\
-                '"processed": 0,'\
-                '"requests": 20,'\
-                '"spam_report_drops": 0,'\
-                '"spam_reports": 0,'\
-                '"unique_clicks": 20,'\
-                '"unique_opens": 20,'\
-                '"unsubscribe_drops": 0,'\
-                '"unsubscribes": 20'\
-              '},'\
-              '"name": "cat1",'\
-              '"type": "category"'\
-            '},'\
-            '{'\
-              '"metrics": {'\
-                '"blocks": 1,'\
-                '"bounce_drops": 0,'\
-                '"bounces": 0,'\
-                '"clicks": 19,'\
-                '"deferred": 0,'\
-                '"delivered": 19,'\
-                '"invalid_emails": 0,'\
-                '"opens": 19,'\
-                '"processed": 0,'\
-                '"requests": 20,'\
-                '"spam_report_drops": 0,'\
-                '"spam_reports": 0,'\
-                '"unique_clicks": 19,'\
-                '"unique_opens": 19,'\
-                '"unsubscribe_drops": 0,'\
-                '"unsubscribes": 19'\
-              '},'\
-              '"name": "cat2",'\
-              '"type": "category"'\
-            '},'\
-            '{'\
-              '"metrics": {'\
-                '"blocks": 0,'\
-                '"bounce_drops": 0,'\
-                '"bounces": 0,'\
-                '"deferred": 0,'\
-                '"clicks": 5,'\
-                '"delivered": 5,'\
-                '"invalid_emails": 0,'\
-                '"opens": 5,'\
-                '"processed": 0,'\
-                '"requests": 5,'\
-                '"spam_report_drops": 0,'\
-                '"spam_reports": 0,'\
-                '"unique_clicks": 5,'\
-                '"unique_opens": 5,'\
-                '"unsubscribe_drops": 0,'\
-                '"unsubscribes": 5'\
-              '},'\
-              '"name": "cat3",'\
-              '"type": "category"'\
-            '},'\
-            '{'\
-              '"metrics": {'\
-                '"blocks": 0,'\
-                '"bounce_drops": 0,'\
-                '"bounces": 0,'\
-                '"clicks": 6,'\
-                '"deferred": 0,'\
-                '"delivered": 5,'\
-                '"invalid_emails": 0,'\
-                '"opens": 6,'\
-                '"processed": 0,'\
-                '"requests": 5,'\
-                '"spam_report_drops": 0,'\
-                '"spam_reports": 0,'\
-                '"unique_clicks": 5,'\
-                '"unique_opens": 5,'\
-                '"unsubscribe_drops": 0,'\
-                '"unsubscribes": 6'\
-              '},'\
-              '"name": "cat4",'\
-              '"type": "category"'\
-            '},'\
-            '{'\
-              '"metrics": {'\
-                '"blocks": 10,'\
-                '"bounce_drops": 0,'\
-                '"bounces": 0,'\
-                '"clicks": 0,'\
-                '"deferred": 0,'\
-                '"delivered": 0,'\
-                '"invalid_emails": 0,'\
-                '"opens": 0,'\
-                '"processed": 0,'\
-                '"requests": 10,'\
-                '"spam_report_drops": 0,'\
-                '"spam_reports": 0,'\
-                '"unique_clicks": 0,'\
-                '"unique_opens": 0,'\
-                '"unsubscribe_drops": 0,'\
-                '"unsubscribes": 0'\
-              '},'\
-              '"name": "cat5",'\
-              '"type": "category"'\
-            '}'\
-          ']'\
-        '}'
-      hash = JSON.parse(json)
-      actual = SendGrid4r::REST::Stats.create_top_stat(hash)
-      expect(actual).to be_a(SendGrid4r::REST::Stats::TopStat)
-      actual.stats.each do |stat|
-        expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-        expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
-      end
-    end
   end
 end

data/spec/rest/stats/subuser_spec.rb

@@ -1,38 +1,38 @@
 # encoding: utf-8
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe SendGrid4r::REST::Stats::Subuser do
-  describe 'integration test', :it do
-    before do
-      Dotenv.load
-      @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
-      @subuser = ENV['SUBUSER2']
-      @email1 = ENV['MAIL']
-      @password1 = ENV['PASS']
-      @ip = ENV['IP']
-      subusers = @client.get_subusers
-      count = subusers.count { |subuser| subuser.username == @subuser }
-      @client.post_subuser(
-        username: @subuser,
-        email: @email1,
-        password: @password1,
-        ips: [@ip]
-      ) if count == 0
-    end
+module SendGrid4r::REST::Stats
+  describe Subuser do
+    describe 'integration test', :it do
+      before do
+        Dotenv.load
+        @client = SendGrid4r::Client.new(api_key: ENV['SILVER_API_KEY'])
+        @subuser = ENV['SUBUSER2']
+        @email1 = ENV['MAIL']
+        @password1 = ENV['PASS']
+        @ip = ENV['IP']
+        subusers = @client.get_subusers
+        count = subusers.count { |subuser| subuser.username == @subuser }
+        @client.post_subuser(
+          username: @subuser,
+          email: @email1,
+          password: @password1,
+          ips: [@ip]
+        ) if count == 0
+      end
 
-    context 'without block call' do
-      it '#get_subusers_stats with mandatory params' do
-        begin
+      context 'without block call' do
+        it '#get_subusers_stats with mandatory params' do
           top_stats = @client.get_subusers_stats(
             start_date: '2015-01-01',
             subusers: @subuser
           )
           expect(top_stats).to be_a(Array)
           top_stats.each do |global_stat|
-            expect(global_stat).to be_a(SendGrid4r::REST::Stats::TopStat)
+            expect(global_stat).to be_a(TopStat)
             global_stat.stats.each do |stat|
-              expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-              expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
+              expect(stat).to be_a(Stat)
+              expect(stat.metrics).to be_a(Metric)
               expect(stat.metrics.blocks.nil?).to be(false)
               expect(stat.metrics.bounce_drops.nil?).to be(false)
               expect(stat.metrics.bounces.nil?).to be(false)
@@ -51,66 +51,106 @@ describe SendGrid4r::REST::Stats::Subuser do
               expect(stat.metrics.unsubscribes.nil?).to be(false)
             end
           end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
         end
-      end
 
-      it '#get_subusers_stats with all params' do
-        begin
+        it '#get_subusers_stats with all params' do
           top_stats = @client.get_subusers_stats(
             start_date: '2015-01-01',
             end_date: '2015-01-02',
-            aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK,
+            aggregated_by: :week,
             subusers: @subuser
           )
           expect(top_stats.class).to be(Array)
           top_stats.each do |global_stat|
-            expect(global_stat).to be_a(SendGrid4r::REST::Stats::TopStat)
+            expect(global_stat).to be_a(TopStat)
             global_stat.stats.each do |stat|
-              expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-              expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
+              expect(stat).to be_a(Stat)
+              expect(stat.metrics).to be_a(Metric)
             end
           end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
         end
-      end
 
-      it '#get_subusers_stats_sums with mandatory params' do
-        begin
+        it '#get_subusers_stats_sums with mandatory params' do
           top_stat = @client.get_subusers_stats_sums(start_date: '2015-01-01')
-          expect(top_stat).to be_a(SendGrid4r::REST::Stats::TopStat)
+          expect(top_stat).to be_a(TopStat)
           top_stat.stats.each do |stat|
-            expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-            expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
           end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
         end
-      end
 
-      it '#get_subusers_stats_sums with all params' do
-        begin
+        it '#get_subusers_stats_sums with all params' do
           top_stat = @client.get_subusers_stats_sums(
             start_date: '2015-01-01',
             end_date: '2015-01-02',
-            sort_by_metric: 'opens',
-            sort_by_direction: 'desc',
+            sort_by_metric: :opens,
+            sort_by_direction: :desc,
+            limit: 5,
+            offset: 0
+          )
+          expect(top_stat).to be_a(TopStat)
+          top_stat.stats.each do |stat|
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
+          end
+        end
+
+        it '#get_subusers_stats_monthly with mandatory params' do
+          top_stat = @client.get_subusers_stats_monthly(
+            date: '2015-01-01'
+          )
+          expect(top_stat).to be_a(TopStat)
+          top_stat.stats.each do |stat|
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
+          end
+        end
+
+        it '#get_subusers_stats_monthly with all params' do
+          begin
+            top_stat = @client.get_subusers_stats_monthly(
+              date: '2015-01-01',
+              subuser: ENV['SUBUSER'],
+              sort_by_metric: :opens,
+              sort_by_direction: :desc,
+              limit: 5,
+              offset: 0
+            )
+            expect(top_stat).to be_a(TopStat)
+            top_stat.stats.each do |stat|
+              expect(stat).to be_a(Stat)
+              expect(stat.metrics).to be_a(Metric)
+            end
+          rescue RestClient::ExceptionWithResponse => e
+            puts e.inspect
+            raise e
+          end
+        end
+
+        it '#get_subuser_stats_monthly with mandatory params' do
+          top_stat = @client.get_subuser_stats_monthly(
+            subuser_name: ENV['SUBUSER'], date: '2015-01-01'
+          )
+          expect(top_stat).to be_a(TopStat)
+          top_stat.stats.each do |stat|
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
+          end
+        end
+
+        it '#get_subuser_stats_monthly with all params' do
+          top_stat = @client.get_subuser_stats_monthly(
+            subuser_name: ENV['SUBUSER'], date: '2015-01-01',
+            sort_by_metric: :opens,
+            sort_by_direction: :desc,
             limit: 5,
             offset: 0
           )
-          expect(top_stat).to be_a(SendGrid4r::REST::Stats::TopStat)
+          expect(top_stat).to be_a(TopStat)
           top_stat.stats.each do |stat|
-            expect(stat).to be_a(SendGrid4r::REST::Stats::Stat)
-            expect(stat.metrics).to be_a(SendGrid4r::REST::Stats::Metric)
+            expect(stat).to be_a(Stat)
+            expect(stat.metrics).to be_a(Metric)
           end
-        rescue RestClient::ExceptionWithResponse => e
-          puts e.inspect
-          raise e
         end
       end
     end