Class: Gotenberg::Chromium

Inherits:
Object
  • Object
show all
Includes:
Properties, Tools, Extractors, Files, Headers, Metadata
Defined in:
lib/gotenberg/chromium.rb,
lib/gotenberg/chromium/tools.rb,
lib/gotenberg/chromium/properties.rb

Defined Under Namespace

Modules: Properties, Tools

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Properties

#emulate_media_type, #extra_http_headers, #fail_on_console_exceptions, #landscape, #margins, #native_page_ranges, #paper_size, #pdf_format, #prefer_css_page_size, #print_background, #scale, #url, #user_agent, #wait_delay, #wait_for_expression

Methods included from Headers

#trace, #webhook, #webhook_error_method, #webhook_extra_http_headers, #webhook_method

Methods included from Metadata

#meta

Methods included from Tools

#assets, #footer, #header, #html, #markdown

Constructor Details

#initialize(args) {|_self| ... } ⇒ Chromium

Returns a new instance of Chromium.

Yields:

  • (_self)

Yield Parameters:



23
24
25
26
27
28
29
 
# File 'lib/gotenberg/chromium.rb', line 23

def initialize args
  args.each do |key, value|
    public_send(('%s=' % key), value)
  end

  yield self if block_given?
end

Instance Attribute Details

#base_path ⇒ Object

Returns the value of attribute base_path.



16
17
18
 
# File 'lib/gotenberg/chromium.rb', line 16

def base_path
  @base_path
end

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



17
18
19
 
# File 'lib/gotenberg/chromium.rb', line 17

def endpoint
  @endpoint
end

#exception ⇒ Object (readonly)

Returns the value of attribute exception.



17
18
19
 
# File 'lib/gotenberg/chromium.rb', line 17

def exception
  @exception
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



17
18
19
 
# File 'lib/gotenberg/chromium.rb', line 17

def response
  @response
end

Class Method Details

.call(base_path, &block) ⇒ Object 



19
20
21
 
# File 'lib/gotenberg/chromium.rb', line 19

def self.call(base_path, &block)
  new(base_path: base_path, &block).call
end

Instance Method Details

#call ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/gotenberg/chromium.rb', line 31

def call
  backtrace if html_debug?
  transform
  modify_metadata if modify_metadata?

  self
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/gotenberg/chromium.rb', line 39

def success?
  exception == nil
end

#to_binary ⇒ Object 



43
44
45
 
# File 'lib/gotenberg/chromium.rb', line 43

def to_binary
  response || raise(exception)
end