sendgrid-ruby 6.3.9 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf21bd306727e384a838c428f07f5866f9108ab03f41160b8dfe429d3116537b
-  data.tar.gz: b73d7dfbb09c9d817096762a882e85e1eeb77bd2abd3397d45923fcf4f81b4cc
+  metadata.gz: 8a77256d8db572200bdedd90a2b719d0f36d1a1aecbf17070968b555ed404028
+  data.tar.gz: 10081de69452a519515b2fe5f086460935cac375e1d3ade7528412477aab38a9
 SHA512:
-  metadata.gz: 52f3285d9ff1f54c4fd46372118de4847fb7508e8c28720362d66aebde5f67decb780a51a9fdaa295d4a67c38bae70ae484ab17ec53e80b38aa8a614de7a0083
-  data.tar.gz: 21b3545263c927498194e31f628d91ded1d6ba39da5e81865a3368729a804338be697f6cb9ca9c89ddeb0dcebca7635b4c8a1a7c99516cf3b8c4425c2bca8688
+  metadata.gz: fa4e2a6a2cd904d43f1c32a57ecbc1ea7db0729fed4cab05303566515975661fd12bb0e1d3f92480b3101276019db4a1858dc060ff35a1055ff587dc5582d071
+  data.tar.gz: 10493d88b4836f3f90a8813dbe3bb6d40e141a3d0f1ed99adc35c34a308c7a149104b7bde9829c8bf5b5b1efb7e855ad1236fc43c5f6c444c656a1e6f740599c

data/.rubocop_todo.yml

@@ -34,6 +34,8 @@ Metrics/BlockLength:
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 2006
+  Exclude:
+    - 'test/sendgrid/test_sendgrid-ruby.rb'
 
 # Offense count: 41
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods.

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+[2021-02-10] Version 6.4.0
+--------------------------
+**Library - Feature**
+- [PR #455](https://github.com/sendgrid/sendgrid-ruby/pull/455): Add http_options as a param in the SendGrid::API's constructor. Thanks to [@hoangtuanictvn](https://github.com/hoangtuanictvn)!
+
+
 [2021-01-27] Version 6.3.9
 --------------------------
 **Library - Fix**

data/lib/sendgrid/base_interface.rb

@@ -4,7 +4,7 @@ require_relative 'version'
 # Initialize the HTTP client
 class BaseInterface
   attr_accessor :client
-  attr_reader :request_headers, :host, :version, :impersonate_subuser
+  attr_reader :request_headers, :host, :version, :impersonate_subuser, :http_options
 
   # * *Args* :
   #   - +auth+ -> authorization header value
@@ -14,8 +14,9 @@ class BaseInterface
   #                  currently only "v3" is supported
   #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
   #                              in the "On-Behalf-Of" header
+  #   - +http_options+ -> http options that you want to be globally applied to each request
   #
-  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil)
+  def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
     @auth = auth
     @host = host
     @version = version || 'v3'
@@ -31,7 +32,9 @@ class BaseInterface
     @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser
 
     @request_headers = @request_headers.merge(request_headers) if request_headers
+    @http_options = http_options
     @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
-                                   request_headers: @request_headers)
+                                   request_headers: @request_headers,
+                                   http_options: @http_options)
   end
 end

data/lib/sendgrid/sendgrid.rb

@@ -9,12 +9,13 @@ module SendGrid
     #                  currently only "v3" is supported
     #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
     #                              in the "On-Behalf-Of" header
+    #   - +http_options+ -> http options that you want to be globally applied to each request
     #
-    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
+    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
       auth = "Bearer #{api_key}"
       host ||= 'https://api.sendgrid.com'
 
-      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser, http_options: http_options)
     end
   end
 end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '6.3.9'.freeze
+  VERSION = '6.4.0'.freeze
 end

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -33,8 +33,9 @@ class TestAPI < MiniTest::Test
     assert_equal(test_headers, sg.request_headers)
     assert_equal('v3', sg.version)
     assert_equal(subuser, sg.impersonate_subuser)
-    assert_equal('6.3.9', SendGrid::VERSION)
+    assert_equal('6.4.0', SendGrid::VERSION)
     assert_instance_of(SendGrid::Client, sg.client)
+    assert_equal({}, sg.http_options)
   end
 
   def test_init_when_impersonate_subuser_is_not_given
@@ -42,6 +43,23 @@ class TestAPI < MiniTest::Test
     refute_includes(sg.request_headers, 'On-Behalf-Of')
   end
 
+  def test_init_when_http_options_is_given
+    params = JSON.parse('{"subuser": "test_string", "ip": "test_string", "limit": 1, "exclude_whitelabels": "true", "offset": 1}')
+    headers = JSON.parse('{"X-Mock": 200}')
+    http_options = {
+      open_timeout: 40,
+      read_timeout: 40
+    }
+
+    sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY', version: 'v3', http_options: http_options)
+    client = sg.client.ips
+    response = client.get(query_params: params, request_headers: headers)
+
+    assert_equal(40, client.http.open_timeout)
+    assert_equal(40, client.http.read_timeout)
+    assert_equal('200', response.status_code)
+  end
+
   def test_access_settings_activity_get
     params = JSON.parse('{"limit": 1}')
     headers = JSON.parse('{"X-Mock": 200}')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 6.3.9
+  version: 6.4.0
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client