Class: Selenium::WebDriver::Remote::W3C::Capabilities
- Inherits:
-
Object
- Object
- Selenium::WebDriver::Remote::W3C::Capabilities
- Defined in:
- lib/selenium/webdriver/remote/w3c/capabilities.rb
Overview
TODO - uncomment when Mozilla fixes this: bugzilla.mozilla.org/show_bug.cgi?id=1326397
Constant Summary collapse
- EXTENSION_CAPABILITY_PATTERN =
/\A[\w-]+:.*\z/
- KNOWN =
TODO (alex): compare with spec
[ :browser_name, :browser_version, :platform_name, :platform_version, :accept_insecure_certs, :page_load_strategy, :proxy, :remote_session_id, :accessibility_checks, :device, :implicit_timeout, :page_load_timeout, :script_timeout, :unhandled_prompt_behavior, :timeouts, ].freeze
Class Method Summary collapse
- .edge(opts = {}) ⇒ Object
- .firefox(opts = {}) ⇒ Object (also: ff)
-
.from_oss(oss_capabilities) ⇒ Object
Creates W3C compliant capabilities from OSS ones.
- .json_create(data) ⇒ Object private
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
A new instance of Capabilities.
- #merge!(other) ⇒ Object
- #proxy=(proxy) ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(opts = {}) ⇒ Capabilities
Returns a new instance of Capabilities.
190 191 192 193 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 190 def initialize(opts = {}) @capabilities = opts self.proxy = opts.delete(:proxy) end |
Class Method Details
.edge(opts = {}) ⇒ Object
87 88 89 90 91 92 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 87 def edge(opts = {}) new({ browser_name: 'MicrosoftEdge', platform: :windows }.merge(opts)) end |
.firefox(opts = {}) ⇒ Object Also known as: ff
94 95 96 97 98 99 100 101 102 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 94 def firefox(opts = {}) opts[:browser_version] = opts.delete(:version) if opts.key?(:version) opts[:platform_name] = opts.delete(:platform) if opts.key?(:platform) opts[:timeouts] = {} opts[:timeouts]['implicit'] = opts.delete(:implicit_timeout) if opts.key?(:implicit_timeout) opts[:timeouts]['page load'] = opts.delete(:page_load_timeout) if opts.key?(:page_load_timeout) opts[:timeouts]['script'] = opts.delete(:script_timeout) if opts.key?(:script_timeout) new({browser_name: 'firefox', marionette: true}.merge(opts)) end |
.from_oss(oss_capabilities) ⇒ Object
Creates W3C compliant capabilities from OSS ones.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 148 def from_oss(oss_capabilities) w3c_capabilities = new # TODO (alex): make capabilities enumerable? oss_capabilities = oss_capabilities.__send__(:capabilities) unless oss_capabilities.is_a?(Hash) oss_capabilities.each do |name, value| next if value.nil? next if value.is_a?(String) && value.empty? capability_name = name.to_s if capability_name == 'firefox_options' msg = ':firefox_options is no longer a valid parameter for Remote::Capabilities, use Firefox::Options instead' raise Error::WebDriverError msg end snake_cased_capability_names = KNOWN.map(&:to_s) camel_cased_capability_names = snake_cased_capability_names.map(&w3c_capabilities.method(:camel_case)) next unless snake_cased_capability_names.include?(capability_name) || camel_cased_capability_names.include?(capability_name) || capability_name.match(EXTENSION_CAPABILITY_PATTERN) w3c_capabilities[name] = value end w3c_capabilities 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.
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 141 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 110 def json_create(data) data = data.dup caps = new caps.browser_name = data.delete('browserName') caps.browser_version = data.delete('browserVersion') caps.platform_name = data.delete('platformName') caps.platform_version = data.delete('platformVersion') caps.accept_insecure_certs = data.delete('acceptInsecureCerts') if data.key?('acceptInsecureCerts') caps.page_load_strategy = data.delete('pageLoadStrategy') timeouts = data.delete('timeouts') caps.implicit_timeout = timeouts['implicit'] if timeouts caps.page_load_timeout = timeouts['pageLoad'] if timeouts caps.script_timeout = timeouts['script'] if timeouts 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') # Marionette Specific caps[:accessibility_checks] = data.delete('moz:accessibilityChecks') caps[:profile] = data.delete('moz:profile') caps[:rotatable] = data.delete('rotatable') caps[:device] = data.delete('device') # any remaining pairs will be added as is, with no conversion caps.merge!(data) caps end |
Instance Method Details
#==(other) ⇒ Object Also known as: eql?
257 258 259 260 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 257 def ==(other) return false unless other.is_a? self.class as_json == other.as_json end |
#[](key) ⇒ Object
203 204 205 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 203 def [](key) @capabilities[key] end |
#[]=(key, value) ⇒ Object
Allows setting arbitrary capabilities.
199 200 201 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 199 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.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 232 def as_json(*) 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
207 208 209 210 211 212 213 214 215 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 207 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
217 218 219 220 221 222 223 224 225 226 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 217 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
253 254 255 |
# File 'lib/selenium/webdriver/remote/w3c/capabilities.rb', line 253 def to_json(*) JSON.generate as_json end |