Class: Appium::Core::Base::Http::Default

Inherits:
Selenium::WebDriver::Remote::Http::Default show all
Defined in:
lib/appium_lib_core/common/base/http_default.rb,
sig/lib/appium_lib_core/common/base/http_default.rbs

Constant Summary

Constants inherited from Selenium::WebDriver::Remote::Http::Default

Selenium::WebDriver::Remote::Http::Default::MAX_RETRIES

Constants inherited from Selenium::WebDriver::Remote::Http::Common

Selenium::WebDriver::Remote::Http::Common::CONTENT_TYPE, Selenium::WebDriver::Remote::Http::Common::DEFAULT_HEADERS, Selenium::WebDriver::Remote::Http::Common::MAX_REDIRECTS

Instance Attribute Summary collapse

Attributes inherited from Selenium::WebDriver::Remote::Http::Default

#open_timeout, #proxy, #read_timeout

Attributes inherited from Selenium::WebDriver::Remote::Http::Common

#server_url

Instance Method Summary collapse

Methods inherited from Selenium::WebDriver::Remote::Http::Default

#close, #http, #new_http_client, #new_request_for, #proxy, #request, #response_for, #start, #use_proxy?

Methods inherited from Selenium::WebDriver::Remote::Http::Common

#call, #close, #create_response, extra_headers, extra_headers=, #quit_errors, #request, #server_url, user_agent, user_agent=

Constructor Details

#initialize(open_timeout: nil, read_timeout: nil) ⇒ Default

override

Parameters:

  • open_timeout: (Object, nil) (defaults to: nil)
  • read_timeout: (Object, nil) (defaults to: nil) 


38
39
40
41
42
43
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 38

def initialize(open_timeout: nil, read_timeout: nil)
  @open_timeout = open_timeout
  @read_timeout = read_timeout
  @additional_headers = {}
  super
end

Instance Attribute Details

#additional_headers ⇒ Object (readonly)

Returns the value of attribute additional_headers.

Returns:

  • (Object) 


32
33
34
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 32

def additional_headers
  @additional_headers
end

Instance Method Details

#delete_additional_header(key) ⇒ Object

Parameters:

  • key (Object)

Returns:

  • (Object) 


50
51
52
53
54
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 50

def delete_additional_header(key)
  @additional_headers.delete key
  ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
  @common_headers.delete key if defined? @common_headers
end

#set_additional_header(key, value) ⇒ Object

Parameters:

  • key (Object)
  • value (Object)

Returns:

  • (Object) 


45
46
47
48
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 45

def set_additional_header(key, value)
  @additional_headers[key] = value
  ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
end

#update_sending_request_to(scheme:, host:, port:, path:) ⇒ URI

Update server_url provided when ruby_lib _core created a default http client. Set @http as nil to re-create http client for the server_url

Parameters:

  • scheme (string) —

    A scheme to update server_url to

  • host (string) —

    A host to update server_url to

  • port (string|integer) —

    A port number to update server_url to

  • path (string) —

    A path to update server_url to

  • scheme: (Object)
  • host: (Object)
  • port: (Object)
  • path: (Object)

Returns:

  • (URI) —

    An instance of URI updated to. Returns default server_url if some of arguments are nil



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 65

def update_sending_request_to(scheme:, host:, port:, path:)
  return server_url unless validate_url_param(scheme, host, port, path)

  # Add / if 'path' does not have it
  path = "/#{path}" unless path.start_with?('/')
  path = "#{path}/" unless path.end_with?('/')

  @http = nil
  self.server_url = URI.parse "#{scheme}://#{host}:#{port}#{path}"
end

#validate_url_param(scheme, host, port, path) ⇒ Boolean

Parameters:

  • scheme (Object)
  • host (Object)
  • port (Object)
  • path (Object)

Returns:

  • (Boolean) 


78
79
80
81
82
83
84
 
# File 'lib/appium_lib_core/common/base/http_default.rb', line 78

def validate_url_param(scheme, host, port, path)
  return true unless [scheme, host, port, path].include?(nil)

  message = "Given parameters are scheme: '#{scheme}', host: '#{host}', port: '#{port}', path: '#{path}'"
  ::Appium::Logger.debug(message)
  false
end