Class: Selenium::WebDriver::Remote::Capabilities
- Inherits:
-
Object
- Object
- Selenium::WebDriver::Remote::Capabilities
- Defined in:
- rb/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
- 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 }
Class Method Summary (collapse)
- + (Object) android(opts = {})
- + (Object) chrome(opts = {})
- + (Object) firefox(opts = {})
- + (Object) htmlunit(opts = {})
- + (Object) htmlunitwithjs(opts = {})
- + (Object) internet_explorer(opts = {}) (also: ie)
- + (Object) ipad(opts = {})
- + (Object) iphone(opts = {})
- + (Object) json_create(data) private
- + (Object) opera(opts = {})
- + (Object) phantomjs(opts = {})
- + (Object) safari(opts = {})
Instance Method Summary (collapse)
- - (Object) ==(other) (also: #eql?)
- - (Object) [](key)
-
- (Object) []=(key, value)
Allows setting arbitrary capabilities.
- - (Object) as_json(opts = nil) private
-
- (Capabilities) initialize(opts = {})
constructor
Firefox-specific options:.
- - (Object) merge!(other)
- - (Object) proxy=(proxy)
- - (Object) to_json(*args)
Constructor Details
- (Capabilities) initialize(opts = {})
Firefox-specific options:
178 179 180 181 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 178 def initialize(opts = {}) @capabilities = DEFAULTS.merge(opts) self.proxy = opts.delete(:proxy) end |
Class Method Details
+ (Object) android(opts = {})
44 45 46 47 48 49 50 51 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 44 def android(opts = {}) new({ :browser_name => "android", :platform => :android, :rotatable => true, :takes_screenshot => true }.merge(opts)) end |
+ (Object) chrome(opts = {})
53 54 55 56 57 58 59 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 53 def chrome(opts = {}) new({ :browser_name => "chrome", :javascript_enabled => true, :css_selectors_enabled => true }.merge(opts)) end |
+ (Object) firefox(opts = {})
61 62 63 64 65 66 67 68 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 61 def firefox(opts = {}) new({ :browser_name => "firefox", :javascript_enabled => true, :takes_screenshot => true, :css_selectors_enabled => true }.merge(opts)) end |
+ (Object) htmlunit(opts = {})
70 71 72 73 74 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 70 def htmlunit(opts = {}) new({ :browser_name => "htmlunit" }.merge(opts)) end |
+ (Object) htmlunitwithjs(opts = {})
76 77 78 79 80 81 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 76 def htmlunitwithjs(opts = {}) new({ :browser_name => "htmlunit", :javascript_enabled => true }.merge(opts)) end |
+ (Object) internet_explorer(opts = {}) Also known as: ie
83 84 85 86 87 88 89 90 91 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 83 def internet_explorer(opts = {}) new({ :browser_name => "internet explorer", :platform => :windows, :takes_screenshot => true, :css_selectors_enabled => true, :native_events => true }.merge(opts)) end |
+ (Object) ipad(opts = {})
102 103 104 105 106 107 108 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 102 def ipad(opts = {}) new({ :browser_name => "iPad", :platform => :mac, :javascript_enabled => true }.merge(opts)) end |
+ (Object) iphone(opts = {})
94 95 96 97 98 99 100 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 94 def iphone(opts = {}) new({ :browser_name => "iPhone", :platform => :mac, :javascript_enabled => true }.merge(opts)) end |
+ (Object) json_create(data)
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.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 141 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.to_sym if data.has_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.has_key?('proxy') # any remaining pairs will be added as is, with no conversion caps.merge!(data) caps end |
+ (Object) opera(opts = {})
110 111 112 113 114 115 116 117 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 110 def opera(opts = {}) new({ :browser_name => "opera", :javascript_enabled => true, :takes_screenshot => true, :css_selectors_enabled => true }.merge(opts)) end |
+ (Object) phantomjs(opts = {})
119 120 121 122 123 124 125 126 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 119 def phantomjs(opts = {}) new({ :browser_name => "phantomjs", :javascript_enabled => true, :takes_screenshot => true, :css_selectors_enabled => true }.merge(opts)) end |
+ (Object) safari(opts = {})
128 129 130 131 132 133 134 135 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 128 def safari(opts = {}) new({ :browser_name => "safari", :javascript_enabled => true, :takes_screenshot => true, :css_selectors_enabled => true }.merge(opts)) end |
Instance Method Details
- (Object) ==(other) Also known as: eql?
246 247 248 249 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 246 def ==(other) return false unless other.kind_of? self.class as_json == other.as_json end |
- (Object) [](key)
191 192 193 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 191 def [](key) @capabilities[key] end |
- (Object) []=(key, value)
Allows setting arbitrary capabilities.
187 188 189 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 187 def []=(key, value) @capabilities[key] = value end |
- (Object) as_json(opts = nil)
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.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 219 def as_json(opts = nil) 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 |
- (Object) merge!(other)
195 196 197 198 199 200 201 202 203 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 195 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 |
- (Object) proxy=(proxy)
205 206 207 208 209 210 211 212 213 214 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 205 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 |
- (Object) to_json(*args)
242 243 244 |
# File 'rb/lib/selenium/webdriver/remote/capabilities.rb', line 242 def to_json(*args) WebDriver.json_dump as_json end |