sendgrid4r 1.11.0 → 1.12.0

data/lib/sendgrid4r/rest/marketing_campaigns/senders.rb

@@ -67,19 +67,19 @@ module SendGrid4r::REST
     def post_sender(params:, &block)
       endpoint = MarketingCampaigns.url_sender
       resp = post(@auth, endpoint, params.to_h, &block)
-      MarketingCampaigns.create_sender(resp)
+      finish(resp, @raw_resp) { |r| MarketingCampaigns.create_sender(r) }
     end
 
     def get_senders(&block)
       endpoint = MarketingCampaigns.url_sender
       resp = get(@auth, endpoint, &block)
-      MarketingCampaigns.create_senders(resp)
+      finish(resp, @raw_resp) { |r| MarketingCampaigns.create_senders(r) }
     end
 
     def patch_sender(sender_id:, params:, &block)
       endpoint = MarketingCampaigns.url_sender(sender_id)
       resp = patch(@auth, endpoint, params.to_h, &block)
-      MarketingCampaigns.create_sender(resp)
+      finish(resp, @raw_resp) { |r| MarketingCampaigns.create_sender(r) }
     end
 
     def delete_sender(sender_id:, &block)
@@ -95,7 +95,7 @@ module SendGrid4r::REST
     def get_sender(sender_id:, &block)
       endpoint = MarketingCampaigns.url_sender(sender_id)
       resp = get(@auth, endpoint, &block)
-      MarketingCampaigns.create_sender(resp)
+      finish(resp, @raw_resp) { |r| MarketingCampaigns.create_sender(r) }
     end
   end
 end

data/lib/sendgrid4r/rest/request.rb

@@ -33,10 +33,7 @@ module SendGrid4r::REST
 
     def execute(method, auth, endpoint, params, payload, &block)
       args = create_args(method, auth, endpoint, params, payload)
-      body = RestClient::Request.execute(args, &block)
-      return nil if block_given?
-      return JSON.parse(body) unless body.nil? || body.length < 2
-      body
+      RestClient::Request.execute(args, &block)
     rescue RestClient::TooManyRequests => e
       duration = e.response.headers[:x_ratelimit_remaining].to_i
       sleep duration if duration > 0
@@ -77,5 +74,10 @@ module SendGrid4r::REST
     def process_array_params(v)
       v.is_a?(Array) ? v.join(',') : v.to_s
     end
+
+    def finish(resp, raw_resp = false)
+      return resp if raw_resp || resp.nil? || resp.length < 2
+      yield(JSON.parse(resp))
+    end
   end
 end

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

@@ -21,12 +21,16 @@ module SendGrid4r::REST
 
       def get_enforced_tls(&block)
         resp = get(@auth, Settings::EnforcedTls.url, &block)
-        Settings::EnforcedTls.create_enforced_tls(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::EnforcedTls.create_enforced_tls(r)
+        end
       end
 
       def patch_enforced_tls(params:, &block)
         resp = patch(@auth, Settings::EnforcedTls.url, params.to_h, &block)
-        Settings::EnforcedTls.create_enforced_tls(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::EnforcedTls.create_enforced_tls(r)
+        end
       end
     end
   end

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

@@ -54,6 +54,13 @@ module SendGrid4r::REST
         ForwardSpam.new(resp['enabled'], resp['email'])
       end
 
+      SpamCheck = Struct.new(:enabled, :url, :max_score)
+
+      def self.create_spam_check(resp)
+        return resp if resp.nil?
+        SpamCheck.new(resp['enabled'], resp['url'], resp['max_score'])
+      end
+
       Template = Struct.new(:enabled, :html_content)
 
       def self.create_template(resp)
@@ -79,94 +86,141 @@ module SendGrid4r::REST
         params[:limit] = limit unless limit.nil?
         params[:offset] = offset unless offset.nil?
         resp = get(@auth, Settings::Mail.url, params, &block)
-        Settings.create_results(resp)
+        finish(resp, @raw_resp) { |r| Settings.create_results(r) }
       end
 
       def get_settings_address_whitelist(&block)
         resp = get(@auth, Settings::Mail.url(:address_whitelist), &block)
-        Settings::Mail.create_address_whitelist(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_address_whitelist(r)
+        end
       end
 
       def patch_settings_address_whitelist(params:, &block)
         endpoint = Settings::Mail.url(:address_whitelist)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_address_whitelist(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_address_whitelist(r)
+        end
       end
 
       def get_settings_bcc(&block)
         resp = get(@auth, Settings::Mail.url(:bcc), &block)
-        Settings::Mail.create_bcc(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_bcc(r)
+        end
       end
 
       def patch_settings_bcc(params:, &block)
         endpoint = Settings::Mail.url(:bcc)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_bcc(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_bcc(r)
+        end
       end
 
       def get_settings_bounce_purge(&block)
         resp = get(@auth, Settings::Mail.url(:bounce_purge), &block)
-        Settings::Mail.create_bounce_purge(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_bounce_purge(r)
+        end
       end
 
       def patch_settings_bounce_purge(params:, &block)
         endpoint = Settings::Mail.url(:bounce_purge)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_bounce_purge(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_bounce_purge(r)
+        end
       end
 
       def get_settings_footer(&block)
         resp = get(@auth, Settings::Mail.url(:footer), &block)
-        Settings::Mail.create_footer(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_footer(r)
+        end
       end
 
       def patch_settings_footer(params:, &block)
         resp = patch(@auth, Settings::Mail.url(:footer), params.to_h, &block)
-        Settings::Mail.create_footer(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_footer(r)
+        end
       end
 
       def get_settings_forward_bounce(&block)
         resp = get(@auth, Settings::Mail.url(:forward_bounce), &block)
-        Settings::Mail.create_forward_bounce(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_forward_bounce(r)
+        end
       end
 
       def patch_settings_forward_bounce(params:, &block)
         endpoint = Settings::Mail.url(:forward_bounce)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_forward_bounce(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_forward_bounce(r)
+        end
       end
 
       def get_settings_forward_spam(&block)
         resp = get(@auth, Settings::Mail.url(:forward_spam), &block)
-        Settings::Mail.create_forward_spam(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_forward_spam(r)
+        end
       end
 
       def patch_settings_forward_spam(params:, &block)
         endpoint = Settings::Mail.url(:forward_spam)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_forward_spam(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_forward_spam(r)
+        end
+      end
+
+      def get_settings_spam_check(&block)
+        resp = get(@auth, Settings::Mail.url(:spam_check), &block)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_spam_check(r)
+        end
+      end
+
+      def patch_settings_spam_check(params:, &block)
+        endpoint = Settings::Mail.url(:spam_check)
+        resp = patch(@auth, endpoint, params.to_h, &block)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_spam_check(r)
+        end
       end
 
       def get_settings_template(&block)
         resp = get(@auth, Settings::Mail.url(:template), &block)
-        Settings::Mail.create_template(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_template(r)
+        end
       end
 
       def patch_settings_template(params:, &block)
         endpoint = Settings::Mail.url(:template)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_template(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_template(r)
+        end
       end
 
       def get_settings_plain_content(&block)
         resp = get(@auth, Settings::Mail.url(:plain_content), &block)
-        Settings::Mail.create_plain_content(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_plain_content(r)
+        end
       end
 
       def patch_settings_plain_content(params:, &block)
         endpoint = Settings::Mail.url(:plain_content)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Mail.create_plain_content(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Mail.create_plain_content(r)
+        end
       end
     end
   end

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

@@ -26,18 +26,18 @@ module SendGrid4r::REST
         params[:limit] = limit unless limit.nil?
         params[:offset] = offset unless offset.nil?
         resp = get(@auth, Settings::Partner.url, params, &block)
-        Settings.create_results(resp)
+        finish(resp, @raw_resp) { |r| Settings.create_results(r) }
       end
 
       def get_settings_new_relic(&block)
         resp = get(@auth, Settings::Partner.url(:new_relic), &block)
-        Settings::Partner.create_partner(resp)
+        finish(resp, @raw_resp) { |r| Settings::Partner.create_partner(r) }
       end
 
       def patch_settings_new_relic(params:, &block)
         endpoint = Settings::Partner.url(:new_relic)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Partner.create_partner(resp)
+        finish(resp, @raw_resp) { |r| Settings::Partner.create_partner(r) }
       end
     end
   end

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

@@ -58,52 +58,60 @@ module SendGrid4r::REST
         params[:limit] = limit unless limit.nil?
         params[:offset] = offset unless offset.nil?
         resp = get(@auth, Settings::Tracking.url, params, &block)
-        Settings.create_results(resp)
+        finish(resp, @raw_resp) { |r| Settings.create_results(r) }
       end
 
       def get_settings_click(&block)
         resp = get(@auth, Settings::Tracking.url(:click), &block)
-        Settings::Tracking.create_click(resp)
+        finish(resp, @raw_resp) { |r| Settings::Tracking.create_click(r) }
       end
 
       def patch_settings_click(params:, &block)
         endpoint = Settings::Tracking.url(:click)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Tracking.create_click(resp)
+        finish(resp, @raw_resp) { |r| Settings::Tracking.create_click(r) }
       end
 
       def get_settings_google_analytics(&block)
         endpoint = Settings::Tracking.url(:google_analytics)
         resp = get(@auth, endpoint, &block)
-        Settings::Tracking.create_google_analytics(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Tracking.create_google_analytics(r)
+        end
       end
 
       def patch_settings_google_analytics(params:, &block)
         endpoint = Settings::Tracking.url(:google_analytics)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Tracking.create_google_analytics(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Tracking.create_google_analytics(r)
+        end
       end
 
       def get_settings_open(&block)
         resp = get(@auth, Settings::Tracking.url(:open), &block)
-        Settings::Tracking.create_open(resp)
+        finish(resp, @raw_resp) { |r| Settings::Tracking.create_open(r) }
       end
 
       def patch_settings_open(params:, &block)
         resp = patch(@auth, Settings::Tracking.url(:open), params.to_h, &block)
-        Settings::Tracking.create_open(resp)
+        finish(resp, @raw_resp) { |r| Settings::Tracking.create_open(r) }
       end
 
       def get_settings_subscription(&block)
         endpoint = Settings::Tracking.url(:subscription)
         resp = get(@auth, endpoint, &block)
-        Settings::Tracking.create_subscription(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Tracking.create_subscription(r)
+        end
       end
 
       def patch_settings_subscription(params:, &block)
         endpoint = Settings::Tracking.url(:subscription)
         resp = patch(@auth, endpoint, params.to_h, &block)
-        Settings::Tracking.create_subscription(resp)
+        finish(resp, @raw_resp) do |r|
+          Settings::Tracking.create_subscription(r)
+        end
       end
     end
   end

data/lib/sendgrid4r/rest/sm/global_unsubscribes.rb

@@ -38,19 +38,21 @@ module SendGrid4r::REST
         params[:offset] = offset.to_i unless offset.nil?
         endpoint = Sm::GlobalUnsubscribes.url_unsubscribes
         resp = get(@auth, endpoint, params, &block)
-        Sm::GlobalUnsubscribes.create_supressions(resp)
+        finish(resp, @raw_resp) do |r|
+          Sm::GlobalUnsubscribes.create_supressions(r)
+        end
       end
 
       def post_global_suppressed_emails(recipient_emails:, &block)
         params = { recipient_emails: recipient_emails }
         endpoint = Sm::GlobalUnsubscribes.url
         resp = post(@auth, endpoint, params, &block)
-        Sm.create_recipient_emails(resp)
+        finish(resp, @raw_resp) { |r| Sm.create_recipient_emails(r) }
       end
 
       def get_global_suppressed_email(email_address:, &block)
         resp = get(@auth, Sm::GlobalUnsubscribes.url(email_address), &block)
-        Sm.create_recipient_email(resp)
+        finish(resp, @raw_resp) { |r| Sm.create_recipient_email(r) }
       end
 
       def delete_global_suppressed_email(email_address:, &block)

data/lib/sendgrid4r/rest/sm/groups.rb

@@ -40,23 +40,23 @@ module SendGrid4r::REST
         params = { name: name, description: description }
         params[:is_default] = is_default unless is_default.nil?
         resp = post(@auth, Sm::Groups.url, params, &block)
-        Sm::Groups.create_group(resp)
+        finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
       end
 
       def get_groups(&block)
         resp = get(@auth, Sm::Groups.url, &block)
-        Sm::Groups.create_groups(resp)
+        finish(resp, @raw_resp) { |r| Sm::Groups.create_groups(r) }
       end
 
       def get_group(group_id:, &block)
         resp = get(@auth, Sm::Groups.url(group_id), &block)
-        Sm::Groups.create_group(resp)
+        finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
       end
 
       def patch_group(group_id:, group:, &block)
         endpoint = Sm::Groups.url(group_id)
         resp = patch(@auth, endpoint, group.to_h, &block)
-        Sm::Groups.create_group(resp)
+        finish(resp, @raw_resp) { |r| Sm::Groups.create_group(r) }
       end
 
       def delete_group(group_id:, &block)

data/lib/sendgrid4r/rest/sm/suppressions.rb

@@ -39,18 +39,21 @@ module SendGrid4r::REST
           recipient_emails: recipient_emails,
           &block
         )
-        Sm.create_recipient_emails(resp)
+        finish(resp, @raw_resp) { |r| Sm.create_recipient_emails(r) }
       end
 
       def get_suppressed_emails(group_id:, &block)
         endpoint = Sm::Suppressions.url(group_id)
-        get(@auth, endpoint, &block)
+        resp = get(@auth, endpoint, &block)
+        finish(resp, @raw_resp) { |r| r }
       end
 
       def get_suppressions(email_address:, &block)
         endpoint = "#{BASE_URL}/asm/suppressions/#{email_address}"
         resp = get(@auth, endpoint, &block)
-        Sm::Suppressions.create_suppressions(resp)
+        finish(resp, @raw_resp) do |r|
+          Sm::Suppressions.create_suppressions(r)
+        end
       end
 
       def delete_suppressed_email(group_id:, email_address:, &block)

data/lib/sendgrid4r/rest/spam_reports.rb

@@ -35,7 +35,7 @@ module SendGrid4r::REST
       params[:limit] = limit.to_i unless limit.nil?
       params[:offset] = offset.to_i unless offset.nil?
       resp = get(@auth, SpamReports.url, params, &block)
-      SpamReports.create_spam_reports(resp)
+      finish(resp, @raw_resp) { |r| SpamReports.create_spam_reports(r) }
     end
 
     def delete_spam_reports(delete_all: nil, emails: nil, &block)
@@ -50,7 +50,7 @@ module SendGrid4r::REST
     def get_spam_report(email:, &block)
       params = { email: email }
       resp = get(@auth, SpamReports.url(email), params, &block)
-      SpamReports.create_spam_reports(resp)
+      finish(resp, @raw_resp) { |r| SpamReports.create_spam_reports(r) }
     end
 
     def delete_spam_report(email:, &block)

data/lib/sendgrid4r/rest/stats/advanced.rb

@@ -22,7 +22,7 @@ module SendGrid4r::REST
           country: country
         }
         resp = get(@auth, "#{BASE_URL}/geo/stats", params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
 
       def get_devices_stats(
@@ -37,7 +37,7 @@ module SendGrid4r::REST
           aggregated_by: aggregated_by
         }
         resp = get(@auth, "#{BASE_URL}/devices/stats", params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
 
       def get_clients_stats(
@@ -52,7 +52,7 @@ module SendGrid4r::REST
           aggregated_by: aggregated_by
         }
         resp = get(@auth, "#{BASE_URL}/clients/stats", params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
 
       def get_clients_type_stats(
@@ -70,25 +70,25 @@ module SendGrid4r::REST
         }
         endpoint = "#{BASE_URL}/clients/#{client_type}/stats"
         resp = get(@auth, endpoint, params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
 
       def get_mailbox_providers_stats(
           start_date:,
           end_date: nil,
           aggregated_by: nil,
-          esps: nil,
+          mailbox_providers: nil,
           &block
       )
         params = {
           start_date: start_date,
           end_date: end_date,
           aggregated_by: aggregated_by,
-          esps: esps
+          mailbox_providers: mailbox_providers
         }
         endpoint = "#{BASE_URL}/mailbox_providers/stats"
         resp = get(@auth, endpoint, params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
 
       def get_browsers_stats(
@@ -105,7 +105,7 @@ module SendGrid4r::REST
           browsers: browsers
         }
         resp = get(@auth, "#{BASE_URL}/browsers/stats", params, &block)
-        Stats.create_top_stats(resp)
+        finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
       end
     end
   end