Class: Selenium::WebDriver::Remote::Capabilities
- Inherits:
-
Object
- Object
- Selenium::WebDriver::Remote::Capabilities
- Defined in:
- lib/selenium/webdriver/remote/capabilities.rb
Overview
Specification of the desired and/or actual capabilities of the browser that the server is being asked to create.
Constant Summary collapse
- DEFAULTS =
{ browser_name: '', version: '', platform: :any, javascript_enabled: false, css_selectors_enabled: false, takes_screenshot: false, native_events: false, rotatable: false, firefox_profile: nil, proxy: nil }.freeze
Class Method Summary collapse
- .chrome(opts = {}) ⇒ Object
- .edge(opts = {}) ⇒ Object
- .firefox(opts = {}) ⇒ Object
- .htmlunit(opts = {}) ⇒ Object
- .htmlunitwithjs(opts = {}) ⇒ Object
- .internet_explorer(opts = {}) ⇒ Object (also: ie)
- .json_create(data) ⇒ Object private
- .phantomjs(opts = {}) ⇒ Object
- .safari(opts = {}) ⇒ Object
Instance Method Summary collapse
- #==(other) ⇒ Object (also: #eql?)
- #[](key) ⇒ Object
-
#[]=(key, value) ⇒ Object
Allows setting arbitrary capabilities.
- #as_json ⇒ Object private
-
#initialize(opts = {}) ⇒ Capabilities
constructor
Firefox-specific options:.
-
#javascript_enabled ⇒ Object
(also: #javascript_enabled?)
Returns javascript_enabled capability.
- #merge!(other) ⇒ Object
- #proxy=(proxy) ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(opts = {}) ⇒ Capabilities
Firefox-specific options:
184 185 186 187 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 184 def initialize(opts = {}) @capabilities = DEFAULTS.merge(opts) self.proxy = opts.delete(:proxy) end |
Class Method Details
.chrome(opts = {}) ⇒ Object
71 72 73 74 75 76 77 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 71 def chrome(opts = {}) new({ browser_name: 'chrome', javascript_enabled: true, css_selectors_enabled: true }.merge(opts)) end |
.edge(opts = {}) ⇒ Object
79 80 81 82 83 84 85 86 87 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 79 def edge(opts = {}) new({ browser_name: 'MicrosoftEdge', platform: :windows, javascript_enabled: true, takes_screenshot: true, css_selectors_enabled: true }.merge(opts)) end |
.firefox(opts = {}) ⇒ Object
89 90 91 92 93 94 95 96 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 89 def firefox(opts = {}) new({ browser_name: 'firefox', javascript_enabled: true, takes_screenshot: true, css_selectors_enabled: true }.merge(opts)) end |
.htmlunit(opts = {}) ⇒ Object
98 99 100 101 102 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 98 def htmlunit(opts = {}) new({ browser_name: 'htmlunit' }.merge(opts)) end |
.htmlunitwithjs(opts = {}) ⇒ Object
104 105 106 107 108 109 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 104 def htmlunitwithjs(opts = {}) new({ browser_name: 'htmlunit', javascript_enabled: true }.merge(opts)) end |
.internet_explorer(opts = {}) ⇒ Object Also known as: ie
111 112 113 114 115 116 117 118 119 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 111 def internet_explorer(opts = {}) new({ browser_name: 'internet explorer', platform: :windows, takes_screenshot: true, css_selectors_enabled: true, native_events: 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.
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 146 def json_create(data) data = data.dup caps = new caps.browser_name = data.delete('browserName') caps.version = data.delete('version') caps.platform = data.delete('platform').downcase.tr(' ', '_').to_sym if data.key?('platform') caps.javascript_enabled = data.delete('javascriptEnabled') caps.css_selectors_enabled = data.delete('cssSelectorsEnabled') caps.takes_screenshot = data.delete('takesScreenshot') caps.native_events = data.delete('nativeEvents') caps.rotatable = data.delete('rotatable') caps.proxy = Proxy.json_create(data['proxy']) if data.key?('proxy') && !data['proxy'].empty? # any remaining pairs will be added as is, with no conversion caps.merge!(data) caps end |
.phantomjs(opts = {}) ⇒ Object
122 123 124 125 126 127 128 129 130 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 122 def phantomjs(opts = {}) WebDriver.logger.deprecate 'Selenium support for PhantomJS', 'headless Chrome/Firefox or HTMLUnit' new({ browser_name: 'phantomjs', javascript_enabled: true, takes_screenshot: true, css_selectors_enabled: true }.merge(opts)) end |
.safari(opts = {}) ⇒ Object
132 133 134 135 136 137 138 139 140 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 132 def safari(opts = {}) new({ browser_name: 'safari', platform: :mac, javascript_enabled: true, takes_screenshot: true, css_selectors_enabled: true }.merge(opts)) end |
Instance Method Details
#==(other) ⇒ Object Also known as: eql?
253 254 255 256 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 253 def ==(other) return false unless other.is_a? self.class as_json == other.as_json end |
#[](key) ⇒ Object
197 198 199 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 197 def [](key) @capabilities[key] end |
#[]=(key, value) ⇒ Object
Allows setting arbitrary capabilities.
193 194 195 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 193 def []=(key, value) @capabilities[key] = value end |
#as_json ⇒ 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.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 226 def as_json(*) hash = {} @capabilities.each do |key, value| case key when :platform hash['platform'] = value.to_s.upcase when :firefox_profile hash['firefox_profile'] = value.as_json['zip'] if value 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 |
#javascript_enabled ⇒ Object Also known as: javascript_enabled?
Returns javascript_enabled capability. It is true if not set explicitly.
55 56 57 58 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 55 def javascript_enabled javascript_enabled = @capabilities.fetch(:javascript_enabled) javascript_enabled.nil? ? true : javascript_enabled end |
#merge!(other) ⇒ Object
201 202 203 204 205 206 207 208 209 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 201 def merge!(other) if other.respond_to?(:capabilities, true) && other.capabilities.is_a?(Hash) @capabilities.merge! other.capabilities elsif other.is_a? Hash @capabilities.merge! other else raise ArgumentError, 'argument should be a Hash or implement #capabilities' end end |
#proxy=(proxy) ⇒ Object
211 212 213 214 215 216 217 218 219 220 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 211 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 ⇒ Object
249 250 251 |
# File 'lib/selenium/webdriver/remote/capabilities.rb', line 249 def to_json(*) JSON.generate as_json end |