sendgrid4r 0.0.5 → 0.1.0

data/spec/stats/category_spec.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Stats::Cateogry' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+  end
+
+  context 'always' do
+    describe '#get_categories_stats' do
+      it 'returns categories stats if specify mandatory params' do
+        actual = @client.get_categories_stats(
+          start_date: '2015-01-01',
+          categories: 'yui'
+        )
+        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(stat.metrics.blocks.nil?).to be(false)
+            expect(stat.metrics.bounce_drops.nil?).to be(false)
+            expect(stat.metrics.bounces.nil?).to be(false)
+            expect(stat.metrics.clicks.nil?).to be(false)
+            expect(stat.metrics.deferred.nil?).to be(false)
+            expect(stat.metrics.delivered.nil?).to be(false)
+            expect(stat.metrics.invalid_emails.nil?).to be(false)
+            expect(stat.metrics.opens.nil?).to be(false)
+            expect(stat.metrics.processed.nil?).to be(false)
+            expect(stat.metrics.requests.nil?).to be(false)
+            expect(stat.metrics.spam_report_drops.nil?).to be(false)
+            expect(stat.metrics.spam_reports.nil?).to be(false)
+            expect(stat.metrics.unique_clicks.nil?).to be(false)
+            expect(stat.metrics.unique_opens.nil?).to be(false)
+            expect(stat.metrics.unsubscribe_drops.nil?).to be(false)
+            expect(stat.metrics.unsubscribes.nil?).to be(false)
+          end
+        end
+      end
+      it 'returns categories stats if specify all params' do
+        actual = @client.get_categories_stats(
+          start_date: '2015-01-01',
+          end_date: '2015-01-02',
+          aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK,
+          categories: 'yui'
+        )
+        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)
+          end
+        end
+      end
+    end
+    describe '#get_categories_stats_sums' do
+      it 'returns categories stats sums if specify mandatory params' do
+        actual = @client.get_categories_stats_sums(start_date: '2015-01-01')
+        expect(actual.class).to be(SendGrid4r::REST::Stats::TopStat)
+        stats = actual.stats
+        expect(stats.length).to eq(3)
+        stats.each do |stat|
+          expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
+          expect(stat.metrics.class).to be(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)
+          expect(stat.metrics.clicks.nil?).to be(false)
+          expect(stat.metrics.deferred.nil?).to be(false)
+          expect(stat.metrics.delivered.nil?).to be(false)
+          expect(stat.metrics.invalid_emails.nil?).to be(false)
+          expect(stat.metrics.opens.nil?).to be(false)
+          expect(stat.metrics.processed.nil?).to be(false)
+          expect(stat.metrics.requests.nil?).to be(false)
+          expect(stat.metrics.spam_report_drops.nil?).to be(false)
+          expect(stat.metrics.spam_reports.nil?).to be(false)
+          expect(stat.metrics.unique_clicks.nil?).to be(false)
+          expect(stat.metrics.unique_opens.nil?).to be(false)
+          expect(stat.metrics.unsubscribe_drops.nil?).to be(false)
+          expect(stat.metrics.unsubscribes.nil?).to be(false)
+        end
+      end
+      it 'returns categories stats sums if specify all params' do
+        actual = @client.get_categories_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)
+        end
+      end
+    end
+  end
+end

data/spec/stats/global_spec.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Stats::Global' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+  end
+
+  context 'always' do
+    describe '#get_global_stats' do
+      it 'returns global stats if specify mandatory params' do
+        actual = @client.get_global_stats(start_date: '2015-01-01')
+        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(stat.metrics.blocks.nil?).to be(false)
+            expect(stat.metrics.bounce_drops.nil?).to be(false)
+            expect(stat.metrics.bounces.nil?).to be(false)
+            expect(stat.metrics.clicks.nil?).to be(false)
+            expect(stat.metrics.deferred.nil?).to be(false)
+            expect(stat.metrics.delivered.nil?).to be(false)
+            expect(stat.metrics.invalid_emails.nil?).to be(false)
+            expect(stat.metrics.opens.nil?).to be(false)
+            expect(stat.metrics.processed.nil?).to be(false)
+            expect(stat.metrics.requests.nil?).to be(false)
+            expect(stat.metrics.spam_report_drops.nil?).to be(false)
+            expect(stat.metrics.spam_reports.nil?).to be(false)
+            expect(stat.metrics.unique_clicks.nil?).to be(false)
+            expect(stat.metrics.unique_opens.nil?).to be(false)
+            expect(stat.metrics.unsubscribe_drops.nil?).to be(false)
+            expect(stat.metrics.unsubscribes.nil?).to be(false)
+          end
+        end
+      end
+
+      it 'returns global stats if specify all params' do
+        actual = @client.get_global_stats(
+          start_date: '2015-01-01',
+          end_date: '2015-01-01',
+          aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK
+        )
+        expect(actual.class).to be(Array)
+        expect(actual.length).to eq(2)
+        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)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/stats/parse_spec.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Stats::Parse' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD'])
+  end
+
+  context 'always' do
+    describe '#get_parse_stats' do
+      it 'returns parse stats if specify mandatory params' do
+        actual = @client.get_parse_stats(start_date: '2015-01-01')
+        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(stat.metrics.received.nil?).to be(false)
+            expect(stat.metrics.blocks.nil?).to be(true)
+          end
+        end
+      end
+      it 'returns parse stats if specify all params' do
+        actual = @client.get_parse_stats(
+          start_date: '2015-01-01',
+          end_date: '2015-01-02',
+          aggregated_by: SendGrid4r::REST::Stats::AggregatedBy::WEEK
+        )
+        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)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/stats/subuser_spec.rb

@@ -0,0 +1,105 @@
+# 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
+
+  context 'always' do
+    describe '#get_subusers_stats' do
+      it 'returns subusers stats if specify mandatory params' do
+        begin
+          actual = @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(stat.metrics.blocks.nil?).to be(false)
+              expect(stat.metrics.bounce_drops.nil?).to be(false)
+              expect(stat.metrics.bounces.nil?).to be(false)
+              expect(stat.metrics.clicks.nil?).to be(false)
+              expect(stat.metrics.deferred.nil?).to be(false)
+              expect(stat.metrics.delivered.nil?).to be(false)
+              expect(stat.metrics.invalid_emails.nil?).to be(false)
+              expect(stat.metrics.opens.nil?).to be(false)
+              expect(stat.metrics.processed.nil?).to be(false)
+              expect(stat.metrics.requests.nil?).to be(false)
+              expect(stat.metrics.spam_report_drops.nil?).to be(false)
+              expect(stat.metrics.spam_reports.nil?).to be(false)
+              expect(stat.metrics.unique_clicks.nil?).to be(false)
+              expect(stat.metrics.unique_opens.nil?).to be(false)
+              expect(stat.metrics.unsubscribe_drops.nil?).to be(false)
+              expect(stat.metrics.unsubscribes.nil?).to be(false)
+            end
+          end
+        rescue => e
+          puts e.inspect
+          raise e
+        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)
+          end
+        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).to eq(2)
+        stats.each do |stat|
+          expect(stat.class).to be(SendGrid4r::REST::Stats::Stat)
+          expect(stat.metrics.class).to be(SendGrid4r::REST::Stats::Metric)
+        end
+      end
+
+      it 'returns subusers stats sums if specify all params' do
+        actual = @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)
+        end
+      end
+    end
+  end
+end

data/spec/templates/templates_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Templates' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD']
+    )
+    @template_name = 'template_test'
+    @template_edit = 'template_edit'
+  end
+
+  context 'always' do
+    it 'is normal' do
+      # celan up test env
+      tmps = @client.get_templates
+      expect(tmps.length >= 0).to eq(true)
+      tmps.each do |tmp|
+        if tmp.name == @template_name || tmp.name == @template_edit
+          @client.delete_template(tmp.id)
+        end
+      end
+      # post a template
+      new_template = @client.post_template(@template_name)
+      expect(@template_name).to eq(new_template.name)
+      expect([]).to eq(new_template.versions)
+      # get all templates
+      tmps = @client.get_templates
+      tmps.each do |tmp|
+        expect(false).to eq(tmp.id.nil?)
+        expect(false).to eq(tmp.name.nil?)
+        expect(true).to eq(tmp.versions.is_a?(Array))
+        tmp.versions.each do |ver|
+          expect(false).to eq(ver.id.nil?)
+          expect(false).to eq(ver.template_id.nil?)
+          expect(false).to eq(ver.active.nil?)
+          expect(false).to eq(ver.name.nil?)
+          expect(false).to eq(ver.updated_at.nil?)
+        end
+      end
+      # pach the template
+      edit_template = @client.patch_template(new_template.id, @template_edit)
+      expect(false).to eq(edit_template.id.nil?)
+      expect(false).to eq(edit_template.name.nil?)
+      expect(true).to eq(edit_template.versions.is_a?(Array))
+      edit_template.versions.each do |ver|
+        expect(false).to eq(ver.id.nil?)
+        expect(false).to eq(ver.template_id.nil?)
+        expect(false).to eq(ver.active.nil?)
+        expect(false).to eq(ver.name.nil?)
+        expect(false).to eq(ver.updated_at.nil?)
+      end
+      # get the template
+      edit_template = @client.get_template(new_template.id)
+      expect(new_template.id).to eq(edit_template.id)
+      expect(@template_edit).to eq(edit_template.name)
+      expect(new_template.versions).to eq(edit_template.versions)
+      # delete the template
+      @client.delete_template(edit_template.id)
+      expect do
+        @client.get_template(edit_template.id)
+      end.to raise_error(RestClient::ResourceNotFound)
+    end
+  end
+end

data/spec/templates/versions_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'SendGrid4r::REST::Templates::Versions' do
+  before :all do
+    Dotenv.load
+    @client = SendGrid4r::Client.new(
+      ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD']
+    )
+    @template_edit = 'version_test'
+    @version1_name = 'version1_test'
+    @version2_name = 'version2_test'
+  end
+
+  context 'always' do
+    it 'is normal' do
+      begin
+        # celan up test env
+        tmps = @client.get_templates
+        tmps.each do |tmp|
+          next if tmp.name != @template_edit
+          tmp.versions.each do |ver|
+            @client.delete_version(tmp.id, ver.id)
+          end
+          @client.delete_template(tmp.id)
+        end
+        # post a template
+        new_template = @client.post_template(@template_edit)
+        expect(@template_edit).to eq(new_template.name)
+        # post a version
+        factory = SendGrid4r::VersionFactory.new
+        ver1 = factory.create(name: @version1_name)
+        ver1 = @client.post_version(new_template.id, ver1)
+        # get the version
+        actual = @client.get_version(new_template.id, ver1.id)
+        expect(ver1.template_id).to eq(actual.template_id)
+        expect(ver1.active).to eq(actual.active)
+        expect(ver1.name).to eq(actual.name)
+        expect(ver1.html_content).to eq(actual.html_content)
+        expect(ver1.plain_content).to eq(actual.plain_content)
+        expect(ver1.subject).to eq(actual.subject)
+        # edit the version
+        edit_ver1 = actual.dup
+        edit_ver1.name = 'edit_version'
+        edit_ver1.subject = 'edit<%subject%>edit'
+        edit_ver1.html_content = 'edit<%body%>edit'
+        edit_ver1.plain_content = 'edit<%body%>edit'
+        edit_ver1.active = 0
+        @client.patch_version(new_template.id, ver1.id, edit_ver1)
+        # get the version
+        actual = @client.get_version(new_template.id, ver1.id)
+        expect(new_template.id).to eq(actual.template_id)
+        expect(edit_ver1.active).to eq(actual.active)
+        expect(edit_ver1.name).to eq(actual.name)
+        expect(edit_ver1.html_content).to eq(actual.html_content)
+        expect(edit_ver1.plain_content).to eq(actual.plain_content)
+        expect(edit_ver1.subject).to eq(actual.subject)
+        # post a version 2
+        ver2 = factory.create(
+          name: @version2_name,
+          subject: '<%subject%>',
+          html_content: '<%body%>',
+          plain_content: '<%body%>'
+        )
+        ver2 = @client.post_version(new_template.id, ver2)
+        # activate version 2
+        @client.activate_version(new_template.id, ver2.id)
+        actual_ver1 = @client.get_version(new_template.id, ver1.id)
+        actual_ver2 = @client.get_version(new_template.id, ver2.id)
+        expect(0).to eq(actual_ver1.active)
+        expect(1).to eq(actual_ver2.active)
+        # delete the version
+        @client.delete_version(new_template.id, actual_ver1.id)
+        @client.delete_version(new_template.id, actual_ver2.id)
+        expect do
+          @client.get_version(new_template.id, actual_ver1.id)
+        end.to raise_error(RestClient::ResourceNotFound)
+        expect do
+          @client.get_version(new_template.id, actual_ver2.id)
+        end.to raise_error(RestClient::ResourceNotFound)
+        # delete the template
+        @client.delete_template(new_template.id)
+      rescue => e
+        puts e.inspect
+        raise e
+      end
+    end
+  end
+end

data/spec/version_factory_spec.rb

@@ -1,29 +1,34 @@
 # encoding: utf-8
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "SendGrid4r::VersionFactory" do
-
+describe 'SendGrid4r::VersionFactory' do
   before :all do
     Dotenv.load
     @factory = SendGrid4r::VersionFactory.new
   end
 
-  context "always" do
-    it "is simple case" do
-      version = @factory.create("version_name")
-      expect(version.name).to eq("version_name")
-      expect(version.subject).to eq("<%subject%>")
-      expect(version.html_content).to eq("<%body%>")
-      expect(version.plain_content).to eq("<%body%>")
+  context 'always' do
+    it 'is simple case' do
+      version = @factory.create(name: 'version_name')
+      expect(version.name).to eq('version_name')
+      expect(version.subject).to eq('<%subject%>')
+      expect(version.html_content).to eq('<%body%>')
+      expect(version.plain_content).to eq('<%body%>')
       expect(version.active).to eq(1)
     end
 
-    it "is full params case" do
-      version = @factory.create("version_name", "This is subject <%subject%>", "This is html content <%body%>", "This is plain content <%body%>", 0)
-      expect(version.name).to eq("version_name")
-      expect(version.subject).to eq("This is subject <%subject%>")
-      expect(version.html_content).to eq("This is html content <%body%>")
-      expect(version.plain_content).to eq("This is plain content <%body%>")
+    it 'is full params case' do
+      version = @factory.create(
+        name: 'version_name',
+        subject: 'This is subject <%subject%>',
+        html_content: 'This is html content <%body%>',
+        plain_content: 'This is plain content <%body%>',
+        active: 0
+      )
+      expect(version.name).to eq('version_name')
+      expect(version.subject).to eq('This is subject <%subject%>')
+      expect(version.html_content).to eq('This is html content <%body%>')
+      expect(version.plain_content).to eq('This is plain content <%body%>')
       expect(version.active).to eq(0)
     end
   end