sendgrid4r 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7417acd0a5a7f7568d4b05a42983b09da86d716
-  data.tar.gz: eba6a546a827b39af30df5128b267d5432820c80
+  metadata.gz: 564f7a655ea8602232bee0429bb54c57b9ddbc75
+  data.tar.gz: 6ff6101f1f35683236bd613632ad0c0733dc725a
 SHA512:
-  metadata.gz: 8bf55ba5f91ea40f8e9062208b87597a0242526a3101bddd52f6da55c537a99478bccb357676eb99b67bdac5aff8d9b69f17fb9fe4f42e2bad74c6170db39f4d
-  data.tar.gz: 8573913c991b79f02d8c39168e41f574b63ceba5abc4151b1e89d2a0083a8c442c488b5e4b9dbfbaa2958622f6000e6144730f2809e2c5d21fc9c633651b309e
+  metadata.gz: ca1835713c3a05441b889827e5bc7bf9f1467369bed32fffd596d273f4a064cb583d99cb573dffbc7ac2d526cbc2473b63be6ab430db428b1781119b457e03a8
+  data.tar.gz: 7b7537d0800a842fb0b2ca1a1eb7eb11e7fd3c91b1ae883f4226f762b55e643f079e98c52a4d9e83054bdf22b84c95de9dfc9d275a7d5c3899c355970779a3bc

data/lib/sendgrid4r/rest/api.rb

@@ -7,7 +7,11 @@ require 'sendgrid4r/rest/asm/asm'
 require 'sendgrid4r/rest/asm/groups'
 require 'sendgrid4r/rest/asm/suppressions'
 require 'sendgrid4r/rest/asm/global_suppressions'
+require 'sendgrid4r/rest/settings/settings'
 require 'sendgrid4r/rest/settings/enforced_tls'
+require 'sendgrid4r/rest/settings/mail'
+require 'sendgrid4r/rest/settings/partner'
+require 'sendgrid4r/rest/settings/tracking'
 require 'sendgrid4r/rest/ips/addresses'
 require 'sendgrid4r/rest/ips/pools'
 require 'sendgrid4r/rest/ips/warmup'
@@ -39,7 +43,11 @@ module SendGrid4r
       include SendGrid4r::REST::Asm::Groups
       include SendGrid4r::REST::Asm::Suppressions
       include SendGrid4r::REST::Asm::GlobalSuppressions
+      include SendGrid4r::REST::Settings
       include SendGrid4r::REST::Settings::EnforcedTls
+      include SendGrid4r::REST::Settings::Mail
+      include SendGrid4r::REST::Settings::Partner
+      include SendGrid4r::REST::Settings::Tracking
       include SendGrid4r::REST::Ips::Addresses
       include SendGrid4r::REST::Ips::Warmup
       include SendGrid4r::REST::Ips::Pools

data/lib/sendgrid4r/rest/settings/enforced_tls.rb

@@ -28,7 +28,7 @@ module SendGrid4r
           SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
         end
 
-        def patch_enforced_tls(params, &block)
+        def patch_enforced_tls(params:, &block)
           endpoint = SendGrid4r::REST::Settings::EnforcedTls.url
           resp = patch(@auth, endpoint, params.to_h, &block)
           SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)

data/lib/sendgrid4r/rest/settings/mail.rb

@@ -0,0 +1,231 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Settings
+      #
+      # SendGrid Web API v3 Settings - Mail
+      #
+      module Mail
+        include SendGrid4r::REST::Request
+
+        AddressWhitelist = Struct.new(:enabled, :list)
+
+        def self.create_address_whitelist(resp)
+          return resp if resp.nil?
+          list = []
+          resp['list'].each do |address|
+            list.push(address)
+          end
+          AddressWhitelist.new(resp['enabled'], list)
+        end
+
+        Bcc = Struct.new(:enabled, :email)
+
+        def self.create_bcc(resp)
+          return resp if resp.nil?
+          Bcc.new(resp['enabled'], resp['email'])
+        end
+
+        BouncePurge = Struct.new(:enabled, :hard_bounces, :soft_bounces)
+
+        def self.create_bounce_purge(resp)
+          return resp if resp.nil?
+          BouncePurge.new(
+            resp['enabled'], resp['hard_bounces'], resp['soft_bounces']
+          )
+        end
+
+        EventNotification = Struct.new(
+          :enabled, :url, :group_resubscribe, :delivered, :group_unsubscribe,
+          :spam_report, :bounce, :deferred, :unsubscribe, :processed, :open,
+          :click, :dropped
+        )
+
+        def self.create_event_notification(resp)
+          return resp if resp.nil?
+          EventNotification.new(
+            resp['enabled'], resp['url'], resp['group_resubscribe'],
+            resp['delivered'], resp['group_unsubscribe'], resp['spam_report'],
+            resp['bounce'], resp['deferred'], resp['unsubscribe'],
+            resp['processed'], resp['open'], resp['click'], resp['dropped']
+          )
+        end
+
+        Footer = Struct.new(:enabled, :html_content, :plain_content)
+
+        def self.create_footer(resp)
+          return resp if resp.nil?
+          Footer.new(
+            resp['enabled'], resp['html_content'], resp['plain_content']
+          )
+        end
+
+        ForwardBounce = Struct.new(:enabled, :email)
+
+        def self.create_forward_bounce(resp)
+          return resp if resp.nil?
+          ForwardBounce.new(resp['enabled'], resp['email'])
+        end
+
+        ForwardSpam = Struct.new(:enabled, :email)
+
+        def self.create_forward_spam(resp)
+          return resp if resp.nil?
+          ForwardSpam.new(resp['enabled'], resp['email'])
+        end
+
+        Template = Struct.new(:enabled, :html_content)
+
+        def self.create_template(resp)
+          return resp if resp.nil?
+          Template.new(resp['enabled'], resp['html_content'])
+        end
+
+        PlainContent = Struct.new(:enabled)
+
+        def self.create_plain_content(resp)
+          return resp if resp.nil?
+          PlainContent.new(resp['enabled'])
+        end
+
+        def self.url(name = nil)
+          url = "#{BASE_URL}/mail_settings"
+          url = "#{url}/#{name}" unless name.nil?
+          url
+        end
+
+        def self.url_event(path)
+          "#{BASE_URL}/user/webhooks/event/#{path}"
+        end
+
+        def get_mail_settings(limit: nil, offset: nil, &block)
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          endpoint = SendGrid4r::REST::Settings::Mail.url
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Settings.create_results(resp)
+        end
+
+        def get_settings_address_whitelist(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('address_whitelist')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_address_whitelist(resp)
+        end
+
+        def patch_settings_address_whitelist(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('address_whitelist')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_address_whitelist(resp)
+        end
+
+        def get_settings_bcc(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('bcc')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_bcc(resp)
+        end
+
+        def patch_settings_bcc(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('bcc')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_bcc(resp)
+        end
+
+        def get_settings_bounce_purge(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('bounce_purge')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_bounce_purge(resp)
+        end
+
+        def patch_settings_bounce_purge(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('bounce_purge')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_bounce_purge(resp)
+        end
+
+        def get_settings_event_notification(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url_event('settings')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_event_notification(resp)
+        end
+
+        def patch_settings_event_notification(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url_event('settings')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_event_notification(resp)
+        end
+
+        def test_settings_event_notification(url:, &block)
+          params = {}
+          params['url'] = url
+          endpoint = SendGrid4r::REST::Settings::Mail.url_event('test')
+          post(@auth, endpoint, params, &block)
+        end
+
+        def get_settings_footer(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('footer')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_footer(resp)
+        end
+
+        def patch_settings_footer(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('footer')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_footer(resp)
+        end
+
+        def get_settings_forward_bounce(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('forward_bounce')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_forward_bounce(resp)
+        end
+
+        def patch_settings_forward_bounce(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('forward_bounce')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_forward_bounce(resp)
+        end
+
+        def get_settings_forward_spam(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('forward_spam')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_forward_spam(resp)
+        end
+
+        def patch_settings_forward_spam(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('forward_spam')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_forward_spam(resp)
+        end
+
+        def get_settings_template(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('template')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_template(resp)
+        end
+
+        def patch_settings_template(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('template')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_template(resp)
+        end
+
+        def get_settings_plain_content(&block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('plain_content')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Mail.create_plain_content(resp)
+        end
+
+        def patch_settings_plain_content(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Mail.url('plain_content')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Mail.create_plain_content(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/settings/partner.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Settings
+      #
+      # SendGrid Web API v3 Settings - Partner
+      #
+      module Partner
+        include SendGrid4r::REST::Request
+        Partner = Struct.new(:enabled, :license_key)
+
+        def self.create_partner(resp)
+          return resp if resp.nil?
+          Partner.new(resp['enabled'], resp['license_key'])
+        end
+
+        def self.url(name = nil)
+          url = "#{BASE_URL}/partner_settings"
+          url = "#{url}/#{name}" unless name.nil?
+          url
+        end
+
+        def get_partner_settings(limit: nil, offset: nil, &block)
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          endpoint = SendGrid4r::REST::Settings::Partner.url
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Settings.create_results(resp)
+        end
+
+        def get_settings_new_relic(&block)
+          endpoint = SendGrid4r::REST::Settings::Partner.url('new_relic')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Partner.create_partner(resp)
+        end
+
+        def patch_settings_new_relic(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Partner.url('new_relic')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Partner.create_partner(resp)
+        end
+
+        def get_settings_sendwithus(&block)
+          endpoint = SendGrid4r::REST::Settings::Partner.url('sendwithus')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Partner.create_partner(resp)
+        end
+
+        def patch_settings_sendwithus(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Partner.url('sendwithus')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Partner.create_partner(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/settings/settings.rb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    #
+    # SendGrid Web API v3 Settings
+    #
+    module Settings
+      Results = Struct.new(:result)
+      Result = Struct.new(:name, :title, :description, :enabled)
+
+      def self.create_results(resp)
+        return resp if resp.nil?
+        results = []
+        resp['result'].each do |result|
+          results.push(SendGrid4r::REST::Settings.create_result(result))
+        end
+        Results.new(results)
+      end
+
+      def self.create_result(resp)
+        return resp if resp.nil?
+        Result.new(
+          resp['name'], resp['title'], resp['description'], resp['enabled']
+        )
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/settings/tracking.rb

@@ -0,0 +1,123 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Settings
+      #
+      # SendGrid Web API v3 Settings - Tracking
+      #
+      module Tracking
+        include SendGrid4r::REST::Request
+
+        Click = Struct.new(:enabled)
+
+        def self.create_click(resp)
+          return resp if resp.nil?
+          Click.new(resp['enabled'])
+        end
+
+        GoogleAnalytics = Struct.new(
+          :enabled, :utm_source, :utm_medium, :utm_term, :utm_content,
+          :utm_campaign
+        )
+
+        def self.create_google_analytics(resp)
+          return resp if resp.nil?
+          GoogleAnalytics.new(
+            resp['enabled'], resp['utm_source'], resp['utm_medium'],
+            resp['utm_term'], resp['utm_content'], resp['utm_campaign']
+          )
+        end
+
+        Open = Struct.new(:enabled)
+
+        def self.create_open(resp)
+          return resp if resp.nil?
+          Open.new(resp['enabled'])
+        end
+
+        Subscription = Struct.new(
+          :enabled, :landing, :url, :replace, :html_content, :plain_content
+        )
+
+        def self.create_subscription(resp)
+          return resp if resp.nil?
+          Subscription.new(
+            resp['enabled'], resp['landing'], resp['url'], resp['replace'],
+            resp['html_content'], resp['plain_content']
+          )
+        end
+
+        def self.url(name = nil)
+          url = "#{BASE_URL}/tracking_settings"
+          url = "#{url}/#{name}" unless name.nil?
+          url
+        end
+
+        def get_tracking_settings(limit: nil, offset: nil, &block)
+          params = {}
+          params['limit'] = limit unless limit.nil?
+          params['offset'] = offset unless offset.nil?
+          endpoint = SendGrid4r::REST::Settings::Tracking.url
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Settings.create_results(resp)
+        end
+
+        def get_settings_click(&block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('click')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Tracking.create_click(resp)
+        end
+
+        def patch_settings_click(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('click')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Tracking.create_click(resp)
+        end
+
+        def get_settings_google_analytics(&block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url(
+            'google_analytics'
+          )
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Tracking.create_google_analytics(resp)
+        end
+
+        def patch_settings_google_analytics(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url(
+            'google_analytics'
+          )
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Tracking.create_google_analytics(resp)
+        end
+
+        def get_settings_open(&block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('open')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Tracking.create_open(resp)
+        end
+
+        def patch_settings_open(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('open')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Tracking.create_open(resp)
+        end
+
+        def get_settings_subscription(&block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('subscription')
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Settings::Tracking.create_subscription(resp)
+        end
+
+        def patch_settings_subscription(params:, &block)
+          endpoint = SendGrid4r::REST::Settings::Tracking.url('subscription')
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Settings::Tracking.create_subscription(resp)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/version.rb

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

data/spec/client_spec.rb

@@ -149,7 +149,7 @@ describe SendGrid4r::Client do
 
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('0.4.0')
+        expect(SendGrid4r::VERSION).to eq('0.5.0')
       end
     end
   end

data/spec/rest/email_activity/email_activity_spec.rb

@@ -45,7 +45,7 @@ describe SendGrid4r::REST::EmailActivity do
           activities = @client.get_email_activities(
             events: [SendGrid4r::Client::Event::DROPS]
           )
-          expect(activities.length).to be > 0
+          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')
@@ -74,7 +74,7 @@ describe SendGrid4r::REST::EmailActivity do
           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
+          expect(activities.length).to be >= 0
           activities.each do |activity|
             expect(activity).to be_a(SendGrid4r::REST::EmailActivity::Activity)
           end

data/spec/rest/settings/enforced_tls_spec.rb

@@ -30,7 +30,7 @@ describe SendGrid4r::REST::Settings::EnforcedTls do
           # patch both value
           actual.require_tls = false
           actual.require_valid_cert = false
-          edit = @client.patch_enforced_tls(actual)
+          edit = @client.patch_enforced_tls(params: actual)
           expect(actual.require_tls).to eq(edit.require_tls)
           expect(actual.require_valid_cert).to eq(edit.require_valid_cert)
         rescue => e
@@ -61,7 +61,7 @@ describe SendGrid4r::REST::Settings::EnforcedTls do
         # patch both value
         actual.require_tls = false
         actual.require_valid_cert = false
-        @client.patch_enforced_tls(actual) do |resp, req, res|
+        @client.patch_enforced_tls(params: actual) do |resp, req, res|
           resp =
             SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(
               JSON.parse(resp)
@@ -100,7 +100,7 @@ describe SendGrid4r::REST::Settings::EnforcedTls do
 
     it '#patch_enforced_tls' do
       allow(client).to receive(:execute).and_return(enforced_tls)
-      actual = client.patch_enforced_tls(nil)
+      actual = client.patch_enforced_tls(params: nil)
       expect(actual).to be_a(
         SendGrid4r::REST::Settings::EnforcedTls::EnforcedTls
       )