RubyGems - sendgrid4r - Versions diffs - 1.7.1 → 1.8.0 - Mend

sendgrid4r 1.7.1 → 1.8.0

Files changed (9) hide show

checksums.yaml +4 -4
data/lib/sendgrid4r/factory/campaign_factory.rb +4 -2
data/lib/sendgrid4r/rest/campaigns/campaigns.rb +5 -4
data/lib/sendgrid4r/version.rb +1 -1
data/spec/client_spec.rb +1 -1
data/spec/factory/campaign_factory_spec.rb +4 -0
data/spec/rest/campaigns/campaigns_spec.rb +42 -5
data/spec/rest/whitelabel/domains_spec.rb +132 -9
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2df9fbdd15763250ba845eb33ef85f763c13de0b
-  data.tar.gz: 119cdeda58f5a1cc4b80141e55bafd6c7e48798c
+  metadata.gz: e1456b89898c396cb01b4fe09b50365bdc08420a
+  data.tar.gz: 30a908eb6d4d7483b09e86ef1b95b6e097db17fc
 SHA512:
-  metadata.gz: 773ed665ffd716b13bd8d1ee2c97db3367f6c8d67422e911308da613407aa5e3f4221096dd8eaddc991745845c827ca64384e9bfe4541ca1855734b9fce31eae
-  data.tar.gz: fbc2f5bd38405a4e1ae287249d341c354080866313b4dd97d6e2c5d94b26da63637fb3ebb7922aff26b90daaa6105c545c5c6b81f24506cf682de3b9a771957e
+  metadata.gz: 11522ace9bad41893d214781ff1980a5431e16f72b77032f54fc0712cf7dcf29cfd5a30f79a40082432e4432a3d6e2a108fa823abfe6b3bf532ad0a31636ae85
+  data.tar.gz: 400cae07547c5d4543b9198bee59810c2b2fb3f310beff5797043242056365a95a228b75e9f991e418058d86e5048788a41c833b7a270acfb179cedf84ebd3f6

data/lib/sendgrid4r/factory/campaign_factory.rb CHANGED Viewed

@@ -8,10 +8,12 @@ module SendGrid4r
     class CampaignFactory
       def create(title: nil, subject: nil, sender_id: nil, list_ids: nil,
         segment_ids: nil, categories: nil, suppression_group_id: nil,
-        html_content: nil, plain_content: nil)
+        custom_unsubscribe_url: nil, ip_pool: nil, html_content: nil,
+        plain_content: nil)
         segment = SendGrid4r::REST::Campaigns::Campaigns::Campaign.new(
           nil, title, subject, sender_id, list_ids, segment_ids, categories,
-          suppression_group_id, html_content, plain_content, nil, nil
+          suppression_group_id, custom_unsubscribe_url, ip_pool, html_content,
+          plain_content, nil, nil
         )
         hash = segment.to_h
         segment.to_h.each do |key, value|

data/lib/sendgrid4r/rest/campaigns/campaigns.rb CHANGED Viewed

@@ -11,8 +11,8 @@ module SendGrid4r
         Campaign = Struct.new(
           :id, :title, :subject, :sender_id, :list_ids, :segment_ids,
-          :categories, :suppression_group_id, :html_content,
-          :plain_content, :send_at, :status
+          :categories, :suppression_group_id, :custom_unsubscribe_url,
+          :ip_pool, :html_content, :plain_content, :send_at, :status
         )
         Campaigns = Struct.new(:result)
@@ -23,8 +23,9 @@ module SendGrid4r
           Campaign.new(
             resp['id'], resp['title'], resp['subject'], resp['sender_id'],
             resp['list_ids'], resp['segment_ids'], resp['categories'],
-            resp['suppression_group_id'], resp['html_content'],
-            resp['plain_content'], send_at, resp['status']
+            resp['suppression_group_id'], resp['custom_unsubscribe_url'],
+            resp['ip_pool'], resp['html_content'], resp['plain_content'],
+            send_at, resp['status']
           )
         end

data/lib/sendgrid4r/version.rb CHANGED Viewed

@@ -2,5 +2,5 @@
 # SendGrid API v3 wrapper implementation.
 #
 module SendGrid4r
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/spec/client_spec.rb CHANGED Viewed

@@ -313,7 +313,7 @@ describe SendGrid4r::Client do
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('1.7.1')
+        expect(SendGrid4r::VERSION).to eq('1.8.0')
       end
     end
   end

data/spec/factory/campaign_factory_spec.rb CHANGED Viewed

@@ -17,6 +17,8 @@ describe SendGrid4r::Factory::CampaignFactory do
         segment_ids: [110],
         categories: ['spring line'],
         suppression_group_id: 42,
+        custom_unsubscribe_url: 'https://sendgrid.com',
+        ip_pool: 'marketing',
         html_content: '<html><head><title></title></head><body>'\
           '<p>Check out our spring line!</p></body></html>',
         plain_content: 'Check out our spring line!'
@@ -29,6 +31,8 @@ describe SendGrid4r::Factory::CampaignFactory do
       @expect[:segment_ids] = [110]
       @expect[:categories] = ['spring line']
       @expect[:suppression_group_id] = 42
+      @expect[:custom_unsubscribe_url] = 'https://sendgrid.com'
+      @expect[:ip_pool] = 'marketing'
       @expect[:html_content] = '<html><head><title></title></head><body>'\
         '<p>Check out our spring line!</p></body></html>'
       @expect[:plain_content] = 'Check out our spring line!'

data/spec/rest/campaigns/campaigns_spec.rb CHANGED Viewed

@@ -6,7 +6,7 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
     before do
       begin
         Dotenv.load
-        @client = SendGrid4r::Client.new(api_key: ENV['API_KEY'])
+        @client = SendGrid4r::Client.new(api_key: ENV['KN_API_KEY'])
         @title1 = 'Test Title1'
         @title2 = 'Test Title2'
         @title1_edit = 'Edit Title1'
@@ -17,6 +17,7 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
         @last_name1 = 'Last Name1'
         @list_name1 = 'List Name1'
         @group_name1 = 'Group Name1'
+        @pool_name1 = 'pool_test1'
         # celan up test env
         # delete campaigns
@@ -50,6 +51,11 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
           next if grp.name != @group_name1
           @client.delete_group(group_id: grp.id)
         end
+        # delete ip pools
+        pools = @client.get_pools
+        pools.each do |pool|
+          @client.delete_pool(name: pool.name) if pool.name == @pool_name1
+        end
         # post a recipient
         recipient1 = {}
         recipient1['email'] = @email1
@@ -61,12 +67,14 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
         @client.post_recipient_to_list(
           list_id: @list1.id, recipient_id: @result.persisted_recipients[0]
         )
-        # add agroup
+        # add a group
         @group1 = @client.post_group(name: @group_name1, description: 'test')
+        # add an ip pool
+        @pool1 = @client.post_pool(name: @pool_name1)
         # add a campaign
         @campaign_factory = SendGrid4r::Factory::CampaignFactory.new
         @params = @campaign_factory.create(
-          title: @title1, subject: @subject1, sender_id: 493,
+          title: @title1, subject: @subject1, sender_id: 516,
           list_ids: [@list1.id], categories: ['cat1'],
           suppression_group_id: @group1.id,
           html_content: 'html <a href="[unsubscribe]">unsub</a>',
@@ -82,14 +90,14 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
       it '#post_campaign' do
         begin
           params = @campaign_factory.create(
-            title: @title2, subject: @subject2, sender_id: 493,
+            title: @title2, subject: @subject2, sender_id: 516,
             list_ids: [@list1.id], categories: ['cat1'],
             suppression_group_id: @group1.id, html_content: 'html',
             plain_content: 'plain')
           campaign2 = @client.post_campaign(params: params)
           expect(campaign2.title).to eq(@title2)
           expect(campaign2.subject).to eq(@subject2)
-          expect(campaign2.sender_id).to eq(493)
+          expect(campaign2.sender_id).to eq(516)
           expect(campaign2.list_ids).to eq([@list1.id])
           expect(campaign2.categories).to eq(['cat1'])
           expect(campaign2.suppression_group_id).to eq(@group1.id)
@@ -101,6 +109,27 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
         end
       end
+      it '#post_campaign with custom_unsubscribe_url' do
+        begin
+          params = @campaign_factory.create(
+            title: @title2, subject: @subject2, sender_id: 516,
+            list_ids: [@list1.id], categories: ['cat1'],
+            custom_unsubscribe_url: 'https://sendgrid.com',
+            ip_pool: @pool_name1, html_content: 'html', plain_content: 'plain')
+          campaign2 = @client.post_campaign(params: params)
+          expect(campaign2.title).to eq(@title2)
+          expect(campaign2.subject).to eq(@subject2)
+          expect(campaign2.sender_id).to eq(516)
+          expect(campaign2.list_ids).to eq([@list1.id])
+          expect(campaign2.categories).to eq(['cat1'])
+          expect(campaign2.html_content).to eq('html')
+          expect(campaign2.plain_content).to eq('plain')
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+          raise e
+        end
+      end
       it '#get_campaigns' do
         begin
           campaigns = @client.get_campaigns
@@ -262,6 +291,8 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
             '"spring line"'\
           '],'\
           '"suppression_group_id": 42,'\
+          '"custom_unsubscribe_url": "",'\
+          '"ip_pool": "marketing",'\
           '"html_content": "<html><head><title></title></head><body>'\
             '<p>Check out our spring line!</p></body></html>",'\
           '"plain_content": "Check out our spring line!",'\
@@ -290,6 +321,8 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
                 '"spring line"'\
               '],'\
               '"suppression_group_id": 42,'\
+              '"custom_unsubscribe_url": "",'\
+              '"ip_pool": "marketing",'\
               '"html_content": "<html><head><title></title></head><body>'\
                 '<p>Check out our spring line!</p></body></html>",'\
               '"plain_content": "Check out our spring line!",'\
@@ -311,6 +344,8 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
                 '"winter line"'\
               '],'\
               '"suppression_group_id": 42,'\
+              '"custom_unsubscribe_url": "",'\
+              '"ip_pool": "marketing",'\
               '"html_content": "<html><head><title></title></head><body>'\
                 '<p>Last call for winter clothes!</p></body></html>",'\
               '"plain_content": "Last call for winter clothes!",'\
@@ -418,6 +453,8 @@ describe SendGrid4r::REST::Campaigns::Campaigns do
       expect(actual.segment_ids).to eq([110])
       expect(actual.categories).to eq(['spring line'])
       expect(actual.suppression_group_id).to eq(42)
+      expect(actual.custom_unsubscribe_url).to eq('')
+      expect(actual.ip_pool).to eq('marketing')
       expect(actual.html_content).to eq(
         '<html><head><title></title></head><body>'\
         '<p>Check out our spring line!</p></body></html>')

data/spec/rest/whitelabel/domains_spec.rb CHANGED Viewed

@@ -20,6 +20,7 @@ describe SendGrid4r::REST::Whitelabel::Domains do
         @id1 = nil
         @id2 = nil
         @id3 = nil
+        @id4 = nil
         domains = @client.get_wl_domains
         domains.each do |domain|
           if domain.subdomain == "#{@subdomain_name}1" &&
@@ -34,16 +35,18 @@ describe SendGrid4r::REST::Whitelabel::Domains do
              domain.domain == @domain_name
             @id3 = domain.id
           end
+          if domain.subdomain == "#{@subdomain_name}4" &&
+             domain.domain == @domain_name
+            @id4 = domain.id
+          end
         end
         # post domain
         @domain1 = @client.post_wl_domain(
-          domain: @domain_name, subdomain: @subdomain_name + '1',
-          username: @username, ips: nil,
-          automatic_security: true, custom_spf: false, default: false
+          domain: @domain_name, subdomain: @subdomain_name + '1'
         ) if @id1.nil?
         @domain2 = @client.post_wl_domain(
           domain: @domain_name, subdomain: @subdomain_name + '2',
-          username: @username, ips: nil,
+          username: @username,
           automatic_security: false, custom_spf: true, default: false
         ) if @id2.nil?
         @domain3 = @client.post_wl_domain(
@@ -51,21 +54,31 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           username: @username, ips: nil,
           automatic_security: true, custom_spf: false, default: false
         ) if @id3.nil?
+        @domain4 = @client.post_wl_domain(
+          domain: @domain_name, subdomain: @subdomain_name + '4',
+          username: @username, ips: [@ip],
+          automatic_security: true, custom_spf: true, default: false
+        ) if @id4.nil?
         # make a default
         @id1 = @domain1.id if @id1.nil?
         @id2 = @domain2.id if @id2.nil?
         @id3 = @domain3.id if @id3.nil?
+        @id4 = @domain4.id if @id4.nil?
         @client.patch_wl_domain(id: @id3, default: true)
         @client.delete_wl_domain(id: @id1)
         @client.delete_wl_domain(id: @id2)
+        @client.delete_wl_domain(id: @id4)
         @domain1 = @client.post_wl_domain(
-          domain: @domain_name, subdomain: @subdomain_name + '1',
-          username: @username, ips: nil,
-          automatic_security: true, custom_spf: false, default: false
+          domain: @domain_name, subdomain: @subdomain_name + '1'
         )
         @domain2 = @client.post_wl_domain(
           domain: @domain_name, subdomain: @subdomain_name + '2',
           username: @username, ips: nil,
+          automatic_security: false, custom_spf: false, default: false
+        )
+        @domain4 = @client.post_wl_domain(
+          domain: @domain_name, subdomain: @subdomain_name + '4',
+          username: @username, ips: [@ip],
           automatic_security: false, custom_spf: true, default: false
         )
         # clean subusers
@@ -133,7 +146,7 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(@domain2.user_id).to be_a(Numeric)
           expect(@domain2.ips).to eq([])
           expect(@domain2.automatic_security).to eq(false)
-          expect(@domain2.custom_spf).to eq(true)
+          expect(@domain2.custom_spf).to eq(false)
           expect(@domain2.default).to eq(false)
           expect(@domain2.legacy).to eq(false)
           expect(@domain2.valid).to eq(false)
@@ -166,15 +179,36 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(domain1.default).to eq(false)
           expect(domain1.legacy).to eq(false)
           expect(domain1.valid).to eq(false)
+          # mail_cname
           expect(domain1.dns.mail_cname).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain1.dns.mail_cname.valid).to eq(false)
+          expect(domain1.dns.mail_cname.type).to eq('cname')
+          expect(domain1.dns.mail_cname.host).to eq(
+            "#{@subdomain_name}1.#{@domain_name}"
+          )
+          expect(domain1.dns.mail_cname.data).to be_a(String)
+          # dkim1
           expect(domain1.dns.dkim1).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain1.dns.dkim1.valid).to eq(false)
+          expect(domain1.dns.dkim1.type).to eq('cname')
+          expect(domain1.dns.dkim1.host).to eq(
+            "s1._domainkey.#{@domain_name}"
+          )
+          expect(domain1.dns.dkim1.data).to be_a(String)
+          # dkim2
           expect(domain1.dns.dkim2).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain1.dns.dkim2.valid).to eq(false)
+          expect(domain1.dns.dkim2.type).to eq('cname')
+          expect(domain1.dns.dkim2.host).to eq(
+            "s2._domainkey.#{@domain_name}"
+          )
+          expect(domain1.dns.dkim2.data).to be_a(String)
           domain2 = @client.get_wl_domain(id: @domain2.id)
           expect(domain2).to be_a(SendGrid4r::REST::Whitelabel::Domains::Domain)
           expect(domain2.domain).to eq(@domain_name)
@@ -183,19 +217,90 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(domain2.user_id).to be_a(Numeric)
           expect(domain2.ips).to eq([])
           expect(domain2.automatic_security).to eq(false)
-          expect(domain2.custom_spf).to eq(true)
+          expect(domain2.custom_spf).to eq(false)
           expect(domain2.default).to eq(false)
           expect(domain2.legacy).to eq(false)
           expect(domain2.valid).to eq(false)
+          # mail_server
           expect(domain2.dns.mail_server).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain2.dns.mail_server.valid).to eq(false)
+          expect(domain2.dns.mail_server.type).to eq('mx')
+          expect(domain2.dns.mail_server.host).to eq(
+            "#{@subdomain_name}2.#{@domain_name}"
+          )
+          expect(domain2.dns.mail_server.data).to eq('mx.sendgrid.net.')
+          # subdomain_spf
           expect(domain2.dns.subdomain_spf).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain2.dns.subdomain_spf.valid).to eq(false)
+          expect(domain2.dns.subdomain_spf.type).to eq('txt')
+          expect(domain2.dns.subdomain_spf.host).to eq(
+            "#{@subdomain_name}2.#{@domain_name}"
+          )
+          expect(domain2.dns.subdomain_spf.data).to eq(
+            'v=spf1 include:sendgrid.net ~all'
+          )
+          # dkim
           expect(domain2.dns.dkim).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Record
           )
+          expect(domain2.dns.dkim.valid).to eq(false)
+          expect(domain2.dns.dkim.type).to eq('txt')
+          expect(domain2.dns.dkim.host).to eq(
+            "m1._domainkey.#{@domain_name}"
+          )
+          expect(domain2.dns.dkim.data).to start_with(
+            'k=rsa; t=s; p='
+          )
+          domain4 = @client.get_wl_domain(id: @domain4.id)
+          expect(domain4).to be_a(SendGrid4r::REST::Whitelabel::Domains::Domain)
+          expect(domain4.domain).to eq(@domain_name)
+          expect(domain4.subdomain).to eq(@subdomain_name + '4')
+          expect(domain4.username).to eq(@username)
+          expect(domain4.user_id).to be_a(Numeric)
+          expect(domain4.ips).to eq([@ip])
+          expect(domain4.automatic_security).to eq(false)
+          expect(domain4.custom_spf).to eq(true)
+          expect(domain4.default).to eq(false)
+          expect(domain4.legacy).to eq(false)
+          expect(domain4.valid).to eq(false)
+          # mail_server
+          expect(domain4.dns.mail_server).to be_a(
+            SendGrid4r::REST::Whitelabel::Domains::Record
+          )
+          expect(domain4.dns.mail_server.valid).to eq(false)
+          expect(domain4.dns.mail_server.type).to eq('mx')
+          expect(domain4.dns.mail_server.host).to eq(
+            "#{@subdomain_name}4.#{@domain_name}"
+          )
+          expect(domain4.dns.mail_server.data).to eq('mx.sendgrid.net.')
+          # subdomain_spf
+          expect(domain4.dns.subdomain_spf).to be_a(
+            SendGrid4r::REST::Whitelabel::Domains::Record
+          )
+          expect(domain4.dns.subdomain_spf.valid).to eq(false)
+          expect(domain4.dns.subdomain_spf.type).to eq('txt')
+          expect(domain4.dns.subdomain_spf.host).to eq(
+            "#{@subdomain_name}4.#{@domain_name}"
+          )
+          expect(domain4.dns.subdomain_spf.data).to eq(
+            "v=spf1 ip4:#{@ip} -all"
+          )
+          # dkim
+          expect(domain4.dns.dkim).to be_a(
+            SendGrid4r::REST::Whitelabel::Domains::Record
+          )
+          expect(domain4.dns.dkim.valid).to eq(false)
+          expect(domain4.dns.dkim.type).to eq('txt')
+          expect(domain4.dns.dkim.host).to eq(
+            "m1._domainkey.#{@domain_name}"
+          )
+          expect(domain4.dns.dkim.data).to start_with(
+            'k=rsa; t=s; p='
+          )
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e
@@ -274,12 +379,21 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(result1.validation_results.mail_cname.valid).to be(
             false
           )
+          expect(result1.validation_results.mail_cname.reason).to be_a(
+            String
+          )
           expect(result1.validation_results.dkim1.valid).to be(
             false
           )
+          expect(result1.validation_results.dkim1.reason).to be_a(
+            String
+          )
           expect(result1.validation_results.dkim2.valid).to be(
             false
           )
+          expect(result1.validation_results.dkim2.reason).to be_a(
+            String
+          )
           result2 = @client.validate_wl_domain(id: @domain2.id)
           expect(result2).to be_a(
             SendGrid4r::REST::Whitelabel::Domains::Result
@@ -288,12 +402,21 @@ describe SendGrid4r::REST::Whitelabel::Domains do
           expect(result2.validation_results.mail_server.valid).to be(
             false
           )
+          expect(result2.validation_results.mail_server.reason).to be_a(
+            String
+          )
           expect(result2.validation_results.subdomain_spf.valid).to be(
             false
           )
+          expect(result2.validation_results.subdomain_spf.reason).to be_a(
+            String
+          )
           expect(result2.validation_results.dkim.valid).to be(
             false
           )
+          expect(result2.validation_results.dkim.reason).to be_a(
+            String
+          )
         rescue RestClient::ExceptionWithResponse => e
           puts e.inspect
           raise e

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid4r
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - awwa500@gmail.com
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-26 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client