Class: BaseInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/sendgrid/base_interface.rb

Overview

Initialize the HTTP client

Direct Known Subclasses

SendGrid::API, TwilioEmail::API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil) ⇒ BaseInterface

  • Args :

    • auth -> authorization header value

    • host -> the base URL for the API

    • request_headers -> any headers that you want to be globally applied

    • version -> the version of the API you wish to access,

      currently only "v3" is supported

    • impersonate_subuser -> the subuser to impersonate, will be passed

      in the "On-Behalf-Of" header



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/sendgrid/base_interface.rb', line 17

def initialize(auth:, host:, request_headers: nil, version: nil, impersonate_subuser: nil)
  @auth = auth
  @host = host
  @version = version || 'v3'
  @impersonate_subuser = impersonate_subuser
  @user_agent = "sendgrid/#{SendGrid::VERSION};ruby"
  @request_headers = JSON.parse('
      {
        "Authorization": "' + @auth + '",
        "Accept": "application/json",
        "User-Agent": "' + @user_agent + '"
      }
  ')
  @request_headers['On-Behalf-Of'] = @impersonate_subuser if @impersonate_subuser

  @request_headers = @request_headers.merge(request_headers) if request_headers
  @client = SendGrid::Client.new(host: "#{@host}/#{@version}",
                                 request_headers: @request_headers)
end

Instance Attribute Details

#client ⇒ Object

Returns the value of attribute client.



6
7
8
 
# File 'lib/sendgrid/base_interface.rb', line 6

def client
  @client
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



7
8
9
 
# File 'lib/sendgrid/base_interface.rb', line 7

def host
  @host
end

#impersonate_subuser ⇒ Object (readonly)

Returns the value of attribute impersonate_subuser.



7
8
9
 
# File 'lib/sendgrid/base_interface.rb', line 7

def impersonate_subuser
  @impersonate_subuser
end

#request_headers ⇒ Object (readonly)

Returns the value of attribute request_headers.



7
8
9
 
# File 'lib/sendgrid/base_interface.rb', line 7

def request_headers
  @request_headers
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



7
8
9
 
# File 'lib/sendgrid/base_interface.rb', line 7

def version
  @version
end