Class: Selenium::WebDriver::Remote::W3CCapabilities Private

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/webdriver/remote/w3c_capabilities.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Specification of the desired and/or actual capabilities of the browser that the server is being asked to create.

Constant Summary collapse

DEFAULTS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  :browser_name => '',
  :browser_version => :any,
  :platform_name => :any,
  :platform_version => :any,
  :accept_ssl_certs => false,
  :takes_screenshot => false,
  :takes_element_screenshot => false,
  :page_load_strategy => 'normal',
  :proxy => nil
}
KNOWN =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

[
    :remote_session_id,
    :specification_level,
    :xul_app_id,
    :raise_accessibility_exceptions,
    :rotatable,
    :app_build_id,
    :device
]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ W3CCapabilities

Returns a new instance of W3CCapabilities.

Parameters:

  • opts (Hash) (defaults to: {})
  • :browser_name (Hash) —

    a customizable set of options

  • :browser_version (Hash) —

    a customizable set of options

  • :platform_name (Hash) —

    a customizable set of options

  • :platform_version (Hash) —

    a customizable set of options

  • :accept_ssl_certs (Hash) —

    a customizable set of options

  • :takes_screenshot (Hash) —

    a customizable set of options

  • :takes_element_screenshot (Hash) —

    a customizable set of options

  • :proxy (Hash) —

    a customizable set of options



156
157
158
159
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 156

def initialize(opts = {})
  @capabilities = DEFAULTS.merge(opts)
  self.proxy = opts.delete(:proxy)
end

Class Method Details

.edge(opts = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



76
77
78
79
80
81
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 76

def edge(opts = {})
  new({
    :browser_name => "MicrosoftEdge",
    :platform => :windows,
      }.merge(opts))
end

.firefox(opts = {}) ⇒ Object Also known as: ff

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



83
84
85
86
87
88
89
90
91
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 83

def firefox(opts = {})
  opts[:browser_version] = opts.delete :version
  opts[:platform_name] = opts.delete :platform

  new({
    :browser_name => "firefox",
    :marionette => true
      }.merge(opts))
end

.json_create(data) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 103

def json_create(data)
  data = data.dup

  # Convert due to Remote Driver implementation
  data["browserVersion"] = data.delete("version") if data.key? "version"
  data["platformName"] = data.delete("platform") if data.key? "platform"

  caps = new
  caps.browser_name = data.delete("browserName") if data.key? "browserName"
  caps.browser_version = data.delete("browserVersion") if data.key? "browserVersion"
  caps.platform_name = data.delete("platformName") if data.key? "platformName"
  caps.platform_version = data.delete("platformVersion") if data.key? "platformVersion"
  caps.accept_ssl_certs = data.delete("acceptSslCerts") if data.key? "acceptSslCerts"
  caps.takes_screenshot = data.delete("takesScreenshot") if data.key? "takesScreenshot"
  caps.takes_element_screenshot = data.delete("takesElementScreenshot") if data.key? "takesElementScreenshot"
  caps.page_load_strategy = data.delete("pageLoadStrategy") if data.key? "pageloadStrategy"
  proxy = data.delete('proxy')
  caps.proxy = Proxy.json_create(proxy) unless proxy.nil? || proxy.empty?

  # Remote Server Specific
  caps[:remote_session_id] = data.delete('webdriver.remote.sessionid')

  # Obsolete capabilities returned by Remote Server
  data.delete("javascriptEnabled")
  data.delete('cssSelectorsEnabled')

  # Marionette Specific
  caps[:specification_level] = data.delete("specificationLevel")
  caps[:xul_app_id] = data.delete("XULappId")
  caps[:raise_accessibility_exceptions] = data.delete('raisesAccessibilityExceptions')
  caps[:rotatable] = data.delete('rotatable')
  caps[:app_build_id] = data.delete('appBuildId')
  caps[:device] = data.delete('device')

  # any remaining pairs will be added as is, with no conversion
  caps.merge!(data)
  caps
end

.w3c?(opts = {}) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 95

def w3c?(opts = {})
  opts[:desired_capabilities].is_a?(W3CCapabilities) || opts[:marionette]
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



222
223
224
225
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 222

def ==(other)
  return false unless other.kind_of? self.class
  as_json == other.as_json
end

#[](key) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



169
170
171
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 169

def [](key)
  @capabilities[key]
end

#[]=(key, value) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allows setting arbitrary capabilities.



165
166
167
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 165

def []=(key, value)
  @capabilities[key] = value
end

#as_json(opts = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 197

def as_json(opts = nil)
  hash = {}

  @capabilities.each do |key, value|
    case key
    when :platform
      hash['platform'] = value.to_s.upcase
    when :proxy
      hash['proxy'] = value.as_json if value
    when String, :firefox_binary
      hash[key.to_s] = value
    when Symbol
      hash[camel_case(key.to_s)] = value
    else
      raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class} / #{value.inspect}"
    end
  end

  hash
end

#merge!(other) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



173
174
175
176
177
178
179
180
181
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 173

def merge!(other)
  if other.respond_to?(:capabilities, true) && other.capabilities.kind_of?(Hash)
    @capabilities.merge! other.capabilities
  elsif other.kind_of? Hash
    @capabilities.merge! other
  else
    raise ArgumentError, "argument should be a Hash or implement #capabilities"
  end
end

#proxy=(proxy) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 183

def proxy=(proxy)
  case proxy
  when Hash
    @capabilities[:proxy] = Proxy.new(proxy)
  when Proxy, nil
    @capabilities[:proxy] = proxy
  else
    raise TypeError, "expected Hash or #{Proxy.name}, got #{proxy.inspect}:#{proxy.class}"
  end
end

#to_json(*args) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



218
219
220
 
# File 'lib/selenium/webdriver/remote/w3c_capabilities.rb', line 218

def to_json(*args)
  JSON.generate as_json
end