RubyGems - sendgrid4r - Versions diffs - 0.2.0 → 0.3.0 - Mend

sendgrid4r 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

checksums.yaml +4 -4
data/.env.example +5 -0
data/.rubocop.yml +8 -8
data/README.md +2 -0
data/lib/auth.rb +5 -2
data/lib/client.rb +4 -2
data/lib/sendgrid4r/factory/version_factory.rb +1 -1
data/lib/sendgrid4r/rest/api.rb +4 -0
data/lib/sendgrid4r/rest/api_keys/api_keys.rb +73 -0
data/lib/sendgrid4r/rest/asm/asm.rb +28 -0
data/lib/sendgrid4r/rest/asm/global_suppressions.rb +12 -8
data/lib/sendgrid4r/rest/asm/groups.rb +29 -22
data/lib/sendgrid4r/rest/asm/suppressions.rb +25 -15
data/lib/sendgrid4r/rest/categories/categories.rb +19 -9
data/lib/sendgrid4r/rest/contacts/custom_fields.rb +14 -8
data/lib/sendgrid4r/rest/contacts/lists.rb +32 -20
data/lib/sendgrid4r/rest/contacts/recipients.rb +42 -31
data/lib/sendgrid4r/rest/contacts/reserved_fields.rb +6 -2
data/lib/sendgrid4r/rest/contacts/segments.rb +22 -12
data/lib/sendgrid4r/rest/ips/addresses.rb +36 -22
data/lib/sendgrid4r/rest/ips/pools.rb +31 -16
data/lib/sendgrid4r/rest/ips/warmup.rb +34 -15
data/lib/sendgrid4r/rest/request.rb +33 -19
data/lib/sendgrid4r/rest/settings/enforced_tls.rb +12 -5
data/lib/sendgrid4r/rest/stats/advanced.rb +73 -25
data/lib/sendgrid4r/rest/stats/category.rb +11 -6
data/lib/sendgrid4r/rest/stats/global.rb +6 -4
data/lib/sendgrid4r/rest/stats/parse.rb +10 -4
data/lib/sendgrid4r/rest/stats/stats.rb +13 -18
data/lib/sendgrid4r/rest/stats/subuser.rb +10 -6
data/lib/sendgrid4r/rest/templates/templates.rb +23 -16
data/lib/sendgrid4r/rest/templates/versions.rb +39 -36
data/lib/sendgrid4r/version.rb +1 -1
data/spec/api_keys/api_keys_spec.rb +152 -0
data/spec/asm/asm_spec.rb +33 -0
data/spec/asm/global_suppressions_spec.rb +111 -45
data/spec/asm/groups_spec.rb +172 -48
data/spec/asm/suppressions_spec.rb +180 -54
data/spec/categories/categories_spec.rb +81 -25
data/spec/client_spec.rb +11 -4
data/spec/contacts/custom_fields_spec.rb +135 -44
data/spec/contacts/lists_spec.rb +314 -84
data/spec/contacts/recipients_spec.rb +337 -92
data/spec/contacts/reserved_fields_spec.rb +80 -60
data/spec/contacts/segments_spec.rb +219 -88
data/spec/factory/condition_factory_spec.rb +12 -12
data/spec/factory/segment_factory_spec.rb +19 -19
data/spec/factory/version_factory_spec.rb +6 -6
data/spec/ips/addresses_spec.rb +177 -84
data/spec/ips/pools_spec.rb +190 -34
data/spec/ips/warmup_spec.rb +106 -38
data/spec/settings/enforced_tls_spec.rb +76 -18
data/spec/stats/advanced_spec.rb +373 -196
data/spec/stats/category_spec.rb +133 -71
data/spec/stats/global_spec.rb +74 -47
data/spec/stats/parse_spec.rb +46 -29
data/spec/stats/stats_spec.rb +246 -0
data/spec/stats/subuser_spec.rb +99 -54
data/spec/templates/templates_spec.rb +219 -54
data/spec/templates/versions_spec.rb +171 -67
metadata +10 -2

data/spec/stats/stats_spec.rb ADDED Viewed

@@ -0,0 +1,246 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+describe SendGrid4r::REST::Stats do
+  describe 'unit test' 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(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)
+        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/stats/subuser_spec.rb CHANGED Viewed

@@ -1,31 +1,29 @@
 # encoding: utf-8
 require File.dirname(__FILE__) + '/../spec_helper'
-describe 'SendGrid4r::REST::Stats::Subuser' do
-  before :all do
-    Dotenv.load
-    @client = SendGrid4r::Client.new(
-      ENV['SILVER_SENDGRID_USERNAME'], ENV['SILVER_SENDGRID_PASSWORD'])
-    @subuser = ENV['SILVER_SUBUSER']
-  end
+describe SendGrid4r::REST::Stats::Subuser do
+  describe 'integration test' do
+    before do
+      Dotenv.load
+      @client = SendGrid4r::Client.new(
+        username: ENV['SILVER_SENDGRID_USERNAME'],
+        password: ENV['SILVER_SENDGRID_PASSWORD'])
+      @subuser = ENV['SILVER_SUBUSER']
+    end
-  context 'always' do
-    describe '#get_subusers_stats' do
-      it 'returns subusers stats if specify mandatory params' do
+    context 'without block call' do
+      it '#get_subusers_stats with mandatory params' do
         begin
-          actual = @client.get_subusers_stats(
+          top_stats = @client.get_subusers_stats(
             start_date: '2015-01-01',
             subusers: @subuser
           )
-          expect(actual.class).to be(Array)
-          expect(actual.length > 0).to be(true)
-          actual.each do |global_stat|
-            expect(global_stat.class).to be(SendGrid4r::REST::Stats::TopStat)
-            stats = global_stat.stats
-            expect(stats.length).to eq(1)
-            stats.each do |stat|
-              expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
-              expect(stat.metrics.class).to be(SendGrid4r::REST::Stats::Metric)
+          expect(top_stats).to be_a(Array)
+          top_stats.each do |global_stat|
+            expect(global_stat).to be_a(SendGrid4r::REST::Stats::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.metrics.blocks.nil?).to be(false)
               expect(stat.metrics.bounce_drops.nil?).to be(false)
               expect(stat.metrics.bounces.nil?).to be(false)
@@ -50,54 +48,101 @@ describe 'SendGrid4r::REST::Stats::Subuser' do
         end
       end
-      it 'returns subusers stats if specify all params' do
-        actual = @client.get_subusers_stats(
-          start_date: '2015-01-01',
-          end_date: '2015-01-02',
-          aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK,
-          subusers: @subuser
-        )
-        expect(actual.class).to be(Array)
-        expect(actual.length > 0).to be(true)
-        actual.each do |global_stat|
-          expect(global_stat.class).to be(SendGrid4r::REST::Stats::TopStat)
-          stats = global_stat.stats
-          expect(stats.length).to eq(1)
-          stats.each do |stat|
-            expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
-            expect(stat.metrics.class).to be(SendGrid4r::REST::Stats::Metric)
+      it '#get_subusers_stats with all params' do
+        begin
+          top_stats = @client.get_subusers_stats(
+            start_date: '2015-01-01',
+            end_date: '2015-01-02',
+            aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::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)
+            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)
+            end
           end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+      it '#get_subusers_stats_sums with mandatory params' do
+        begin
+          top_stat = @client.get_subusers_stats_sums(start_date: '2015-01-01')
+          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)
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        end
+      end
+      it '#get_subusers_stats_sums with all params' do
+        begin
+          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',
+            limit: 5,
+            offset: 0
+          )
+          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)
+          end
+        rescue => e
+          puts e.inspect
+          raise e
         end
       end
     end
-    describe '#get_subusers_stats_sums' do
-      it 'returns subusers stats sums if specify mandatory params' do
-        actual = @client.get_subusers_stats_sums(start_date: '2015-01-01')
-        expect(actual.class).to be(SendGrid4r::REST::Stats::TopStat)
-        stats = actual.stats
-        expect(stats.length > 1).to eq(true)
-        stats.each do |stat|
-          expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
-          expect(stat.metrics.class).to be(SendGrid4r::REST::Stats::Metric)
+    context 'with block call' do
+      it '#get_subusers_stats with all params' do
+        @client.get_subusers_stats(
+          start_date: '2015-01-01',
+          end_date: '2015-01-02',
+          aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK,
+          subusers: @subuser
+        ) do |resp, req, res|
+          resp =
+            SendGrid4r::REST::Stats.create_top_stats(
+              JSON.parse(resp)
+            )
+          expect(resp).to be_a(Array)
+          resp.each do |stat|
+            expect(stat).to be_a(SendGrid4r::REST::Stats::TopStat)
+          end
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPOK)
         end
       end
-      it 'returns subusers stats sums if specify all params' do
-        actual = @client.get_subusers_stats_sums(
+      it '#get_subusers_stats_sums with all params' do
+        @client.get_subusers_stats_sums(
           start_date: '2015-01-01',
           end_date: '2015-01-02',
           sort_by_metric: 'opens',
           sort_by_direction: 'desc',
           limit: 5,
           offset: 0
-        )
-        expect(actual.class).to be(SendGrid4r::REST::Stats::TopStat)
-        stats = actual.stats
-        expect(stats.length).to eq(0)
-        stats.each do |stat|
-          expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
-          expect(stat.metrics.class).to be(SendGrid4r::REST::Stats::Metric)
+        ) do |resp, req, res|
+          resp =
+            SendGrid4r::REST::Stats.create_top_stat(
+              JSON.parse(resp)
+            )
+          expect(resp).to be_a(SendGrid4r::REST::Stats::TopStat)
+          expect(req).to be_a(RestClient::Request)
+          expect(res).to be_a(Net::HTTPOK)
         end
       end
     end