sendgrid4r 1.8.1 → 1.10.0

data/lib/sendgrid4r/rest/request.rb

@@ -4,80 +4,78 @@ require 'rest-client'
 require 'uri'
 require 'json'
 
-module SendGrid4r
-  module REST
-    #
-    # SendGrid Web API v3 Request
-    #
-    module Request
-      BASE_URL = 'https://api.sendgrid.com/v3'
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Request
+  #
+  module Request
+    BASE_URL = 'https://api.sendgrid.com/v3'
 
-      def get(auth, endpoint, params = nil, payload = nil, &block)
-        execute(:get, auth, endpoint, params, payload, &block)
-      end
+    def get(auth, endpoint, params = nil, payload = nil, &block)
+      execute(:get, auth, endpoint, params, payload, &block)
+    end
 
-      def post(auth, endpoint, payload = nil, &block)
-        execute(:post, auth, endpoint, nil, payload, &block)
-      end
+    def post(auth, endpoint, payload = nil, &block)
+      execute(:post, auth, endpoint, nil, payload, &block)
+    end
 
-      def patch(auth, endpoint, payload, &block)
-        execute(:patch, auth, endpoint, nil, payload, &block)
-      end
+    def patch(auth, endpoint, payload, &block)
+      execute(:patch, auth, endpoint, nil, payload, &block)
+    end
 
-      def put(auth, endpoint, payload, &block)
-        execute(:put, auth, endpoint, nil, payload, &block)
-      end
+    def put(auth, endpoint, payload, &block)
+      execute(:put, auth, endpoint, nil, payload, &block)
+    end
 
-      def delete(auth, endpoint, params = nil, payload = nil, &block)
-        execute(:delete, auth, endpoint, params, payload, &block)
-      end
+    def delete(auth, endpoint, params = nil, payload = nil, &block)
+      execute(:delete, auth, endpoint, params, payload, &block)
+    end
 
-      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
-      rescue RestClient::TooManyRequests => e
-        duration = e.response.headers[:x_ratelimit_remaining].to_i
-        sleep duration if duration > 0
-        retry
-      end
+    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
+    rescue RestClient::TooManyRequests => e
+      duration = e.response.headers[:x_ratelimit_remaining].to_i
+      sleep duration if duration > 0
+      retry
+    end
 
-      def create_args(method, auth, endpoint, params, payload)
-        args = {}
-        args[:method] = method
-        args[:url] = process_url_params(endpoint, params)
-        headers = {}
-        headers[:content_type] = :json
-        # Added for Campaign API
-        headers['Accept-Encoding'] = 'plain'
-        #
-        if !auth.api_key.nil?
-          headers[:authorization] = "Bearer #{auth.api_key}"
-        else
-          args[:user] = auth.username
-          args[:password] = auth.password
-        end
-        args[:headers] = headers
-        args[:payload] = payload.to_json unless payload.nil?
-        args
+    def create_args(method, auth, endpoint, params, payload)
+      args = {}
+      args[:method] = method
+      args[:url] = process_url_params(endpoint, params)
+      headers = {}
+      headers[:content_type] = :json
+      # Added for Campaign API
+      headers['Accept-Encoding'] = 'plain'
+      #
+      if !auth.api_key.nil?
+        headers[:authorization] = "Bearer #{auth.api_key}"
+      else
+        args[:user] = auth.username
+        args[:password] = auth.password
       end
+      args[:headers] = headers
+      args[:payload] = payload.to_json unless payload.nil?
+      args
+    end
 
-      def process_url_params(endpoint, params)
-        if params.nil? || params.empty?
-          endpoint
-        else
-          query_string = params.collect do |k, v|
-            "#{k}=#{CGI.escape(process_array_params(v))}"
-          end.join('&')
-          endpoint + "?#{query_string}"
-        end
+    def process_url_params(endpoint, params)
+      if params.nil? || params.empty?
+        endpoint
+      else
+        query_string = params.collect do |k, v|
+          "#{k}=#{CGI.escape(process_array_params(v))}"
+        end.join('&')
+        endpoint + "?#{query_string}"
       end
+    end
 
-      def process_array_params(v)
-        v.is_a?(Array) ? v.join(',') : v.to_s
-      end
+    def process_array_params(v)
+      v.is_a?(Array) ? v.join(',') : v.to_s
     end
   end
 end

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

@@ -1,35 +1,32 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    module Settings
-      #
-      # SendGrid Web API v3 Settings - EnforcedTls
-      #
-      module EnforcedTls
-        include SendGrid4r::REST::Request
-        EnforcedTls = Struct.new(:require_tls, :require_valid_cert)
+module SendGrid4r::REST
+  module Settings
+    #
+    # SendGrid Web API v3 Settings - EnforcedTls
+    #
+    module EnforcedTls
+      include Request
 
-        def self.create_enforced_tls(resp)
-          return resp if resp.nil?
-          EnforcedTls.new(resp['require_tls'], resp['require_valid_cert'])
-        end
+      EnforcedTls = Struct.new(:require_tls, :require_valid_cert)
 
-        def self.url
-          "#{BASE_URL}/user/settings/enforced_tls"
-        end
+      def self.create_enforced_tls(resp)
+        return resp if resp.nil?
+        EnforcedTls.new(resp['require_tls'], resp['require_valid_cert'])
+      end
+
+      def self.url
+        "#{BASE_URL}/user/settings/enforced_tls"
+      end
 
-        def get_enforced_tls(&block)
-          endpoint = SendGrid4r::REST::Settings::EnforcedTls.url
-          resp = get(@auth, endpoint, &block)
-          SendGrid4r::REST::Settings::EnforcedTls.create_enforced_tls(resp)
-        end
+      def get_enforced_tls(&block)
+        resp = get(@auth, Settings::EnforcedTls.url, &block)
+        Settings::EnforcedTls.create_enforced_tls(resp)
+      end
 
-        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)
-        end
+      def patch_enforced_tls(params:, &block)
+        resp = patch(@auth, Settings::EnforcedTls.url, params.to_h, &block)
+        Settings::EnforcedTls.create_enforced_tls(resp)
       end
     end
   end

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

@@ -1,188 +1,172 @@
 # -*- encoding: utf-8 -*-
 
-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
-
-        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 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_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
+module SendGrid4r::REST
+  module Settings
+    #
+    # SendGrid Web API v3 Settings - Mail
+    #
+    module Mail
+      include Request
+
+      AddressWhitelist = Struct.new(:enabled, :list)
+
+      def self.create_address_whitelist(resp)
+        return resp if resp.nil?
+        AddressWhitelist.new(resp['enabled'], resp['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
+
+      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 get_mail_settings(limit: nil, offset: nil, &block)
+        params = {}
+        params[:limit] = limit unless limit.nil?
+        params[:offset] = offset unless offset.nil?
+        resp = get(@auth, Settings::Mail.url, params, &block)
+        Settings.create_results(resp)
+      end
+
+      def get_settings_address_whitelist(&block)
+        resp = get(@auth, Settings::Mail.url(:address_whitelist), &block)
+        Settings::Mail.create_address_whitelist(resp)
+      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)
+      end
+
+      def get_settings_bcc(&block)
+        resp = get(@auth, Settings::Mail.url(:bcc), &block)
+        Settings::Mail.create_bcc(resp)
+      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)
+      end
+
+      def get_settings_bounce_purge(&block)
+        resp = get(@auth, Settings::Mail.url(:bounce_purge), &block)
+        Settings::Mail.create_bounce_purge(resp)
+      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)
+      end
+
+      def get_settings_footer(&block)
+        resp = get(@auth, Settings::Mail.url(:footer), &block)
+        Settings::Mail.create_footer(resp)
+      end
+
+      def patch_settings_footer(params:, &block)
+        resp = patch(@auth, Settings::Mail.url(:footer), params.to_h, &block)
+        Settings::Mail.create_footer(resp)
+      end
+
+      def get_settings_forward_bounce(&block)
+        resp = get(@auth, Settings::Mail.url(:forward_bounce), &block)
+        Settings::Mail.create_forward_bounce(resp)
+      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)
+      end
+
+      def get_settings_forward_spam(&block)
+        resp = get(@auth, Settings::Mail.url(:forward_spam), &block)
+        Settings::Mail.create_forward_spam(resp)
+      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)
+      end
+
+      def get_settings_template(&block)
+        resp = get(@auth, Settings::Mail.url(:template), &block)
+        Settings::Mail.create_template(resp)
+      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)
+      end
+
+      def get_settings_plain_content(&block)
+        resp = get(@auth, Settings::Mail.url(:plain_content), &block)
+        Settings::Mail.create_plain_content(resp)
+      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)
       end
     end
   end

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

@@ -1,46 +1,43 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    module Settings
-      #
-      # SendGrid Web API v3 Settings - Partner
-      #
-      module Partner
-        include SendGrid4r::REST::Request
-        Partner = Struct.new(:enabled, :license_key)
+module SendGrid4r::REST
+  module Settings
+    #
+    # SendGrid Web API v3 Settings - Partner
+    #
+    module Partner
+      include Request
 
-        def self.create_partner(resp)
-          return resp if resp.nil?
-          Partner.new(resp['enabled'], resp['license_key'])
-        end
+      Partner = Struct.new(:enabled, :license_key)
 
-        def self.url(name = nil)
-          url = "#{BASE_URL}/partner_settings"
-          url = "#{url}/#{name}" unless name.nil?
-          url
-        end
+      def self.create_partner(resp)
+        return resp if resp.nil?
+        Partner.new(resp['enabled'], resp['license_key'])
+      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 self.url(name = nil)
+        url = "#{BASE_URL}/partner_settings"
+        url = "#{url}/#{name}" unless name.nil?
+        url
+      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 get_partner_settings(limit: nil, offset: nil, &block)
+        params = {}
+        params[:limit] = limit unless limit.nil?
+        params[:offset] = offset unless offset.nil?
+        resp = get(@auth, Settings::Partner.url, params, &block)
+        Settings.create_results(resp)
+      end
+
+      def get_settings_new_relic(&block)
+        resp = get(@auth, Settings::Partner.url(:new_relic), &block)
+        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 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)
       end
     end
   end