Class: Html2img::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/html2img/configuration.rb

Overview

Process-wide defaults, for applications that would rather configure once than pass a client around.

Html2img.configure do |config|
config.api_key = ENV.fetch("HTML2IMG_API_KEY")
config.timeout = 45
end

In a Rails app this belongs in an initializer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



36
37
38
39
40
41
 
# File 'lib/html2img/configuration.rb', line 36

def initialize
  @api_key = ENV.fetch("HTML2IMG_API_KEY", nil)
  @base_url = ENV.fetch("HTML2IMG_BASE_URI", nil) || DEFAULT_BASE_URL
  @timeout = DEFAULT_TIMEOUT
  @transport = nil
end

Instance Attribute Details

#api_key ⇒ String?

Returns sent as the X-API-Key header.

Returns:

  • (String, nil) —

    sent as the X-API-Key header



25
26
27
 
# File 'lib/html2img/configuration.rb', line 25

def api_key
  @api_key
end

#base_url ⇒ String

Returns the API base URL.

Returns:

  • (String) —

    the API base URL



28
29
30
 
# File 'lib/html2img/configuration.rb', line 28

def base_url
  @base_url
end

#timeout ⇒ Float

Returns request timeout in seconds.

Returns:

  • (Float) —

    request timeout in seconds



31
32
33
 
# File 'lib/html2img/configuration.rb', line 31

def timeout
  @timeout
end

#transport ⇒ #call?

Returns a custom transport, see Transport.

Returns:

  • (#call, nil) —

    a custom transport, see Transport



34
35
36
 
# File 'lib/html2img/configuration.rb', line 34

def transport
  @transport
end