Class: SharedTools::Tools::Browser::BaseDriver

Inherits:
Object
  • Object
show all
Defined in:
lib/shared_tools/tools/browser/base_driver.rb

Overview

A base driver intended to be overridden by specific browser drivers (e.g. waitir).

Direct Known Subclasses

FerrumDriver, WatirDriver

Constant Summary collapse

TIMEOUT = 
Integer(ENV.fetch("OMNIAI_BROWSER_TIMEOUT", 10))

Instance Method Summary collapse

Constructor Details

#initialize(logger: Logger.new(IO::NULL)) ⇒ BaseDriver

Returns a new instance of BaseDriver.

Parameters:

  • logger (Logger) (defaults to: Logger.new(IO::NULL)) 


11
12
13
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 11

def initialize(logger: Logger.new(IO::NULL))
  @logger = logger
end

Instance Method Details

#click(selector:) ⇒ Hash

Parameters:

  • selector (String) —

    e.g. “button”, “div#parent > span.child”, etc

Returns:

  • (Hash)

Raises:

  • (NotImplementedError) 


58
59
60
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 58

def click(selector:)
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#close ⇒ Object

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 15

def close
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#fill_in(selector:, text:) ⇒ Hash

Parameters:

  • selector (String)
  • text (String)

Returns:

  • (Hash)

Raises:

  • (NotImplementedError) 


51
52
53
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 51

def fill_in(selector:, text:)
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#goto(url:) ⇒ Hash

Parameters:

  • url (String)

Returns:

  • (Hash)

Raises:

  • (NotImplementedError) 


43
44
45
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 43

def goto(url:)
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#html ⇒ String

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 30

def html
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#screenshot {|file| ... } ⇒ Object

Yields:

  • (file)

Yield Parameters:

  • file (File)

Raises:

  • (NotImplementedError) 


36
37
38
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 36

def screenshot
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#title ⇒ String

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


25
26
27
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 25

def title
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end

#url ⇒ String

Returns:

  • (String)

Raises:

  • (NotImplementedError) 


20
21
22
 
# File 'lib/shared_tools/tools/browser/base_driver.rb', line 20

def url
  raise NotImplementedError, "#{self.class.name}#{__method__} undefined"
end