selenium-webdriver 0.0.17 → 0.0.18

data/remote/client/src/rb/lib/selenium/webdriver/remote/bridge.rb

@@ -7,19 +7,13 @@ module Selenium
       #
       # Low level bridge to the remote server, through which the rest of the API works.
       #
-      # @api private
+      # @private
       #
 
       class Bridge
         include Find
         include BridgeHelper
 
-        DEFAULT_OPTIONS = {
-          :url                  => "http://localhost:4444/wd/hub",
-          :http_client          => DefaultHttpClient,
-          :desired_capabilities => Capabilities.firefox
-        }
-
         #
         # Defines a wrapper method for a command, which ultimately calls #execute.
         #
@@ -27,10 +21,7 @@ module Selenium
         #   name of the resulting method
         # @param url [String]
         #   a URL template, which can include some arguments, much like the definitions on the server.
-        #   the :session_id and :context parameters are implicitly handled, but the remainder will become
-        #   required method arguments.
-        #   e.g., "session/:session_id/:context/element/:id/text" will define a method that takes id
-        #   as it's first argument.
+        #   the :session_id parameter is implicitly handled, but the remainder will become required method arguments.
         # @param verb [Symbol]
         #   the appropriate http verb, such as :get, :post, or :delete
         #
@@ -51,7 +42,7 @@ module Selenium
         #
 
         def initialize(opts = {})
-          opts                 = DEFAULT_OPTIONS.merge(opts)
+          opts                 = default_options.merge(opts)
           http_client_class    = opts.delete(:http_client)
           desired_capabilities = opts.delete(:desired_capabilities)
           url                  = opts.delete(:url)
@@ -71,7 +62,6 @@ module Selenium
           uri = URI.parse(url)
           uri.path += "/" unless uri.path =~ /\/$/
 
-          @context      = "context"
           @http         = http_client_class.new uri
           @capabilities = create_session(desired_capabilities)
         end
@@ -92,17 +82,15 @@ module Selenium
           @session_id || raise(Error::WebDriverError, "no current session exists")
         end
 
-
         def create_session(desired_capabilities)
-          resp = raw_execute :newSession, {}, desired_capabilities
+          resp = raw_execute :newSession, {}, :desiredCapabilities => desired_capabilities
           @session_id = resp['sessionId'] || raise(Error::WebDriverError, 'no sessionId in returned payload')
-          @context    = resp['context']
 
           Capabilities.json_create resp['value']
         end
 
         def get(url)
-          execute :get, {}, url
+          execute :get, {}, :url => url
         end
 
         def goBack
@@ -134,15 +122,15 @@ module Selenium
         end
 
         def switchToWindow(name)
-          execute :switchToWindow, :name => name
+          execute :switchToWindow, {}, :name => name
         end
 
         def switchToFrame(id)
-          execute :switchToFrame, :id => id
+          execute :switchToFrame, {}, :id => id
         end
 
         def switchToDefaultContent
-          execute :switchToFrame, :id => nil
+          execute :switchToFrame, {}, :id => nil
         end
 
         def quit
@@ -166,7 +154,7 @@ module Selenium
         end
 
         def setSpeed(value)
-          execute :setSpeed, {}, value
+          execute :setSpeed, {}, :speed => value
         end
 
         def getSpeed
@@ -178,18 +166,16 @@ module Selenium
             raise Error::UnsupportedOperationError, "underlying webdriver instance does not support javascript"
           end
 
-          typed_args = args.map { |arg| wrap_script_argument(arg) }
-          response   = raw_execute :executeScript, {}, script, typed_args
-
-          unwrap_script_argument response['value']
+          result = execute :executeScript, {}, :script => script, :args => args
+          unwrap_script_result result
         end
 
         def addCookie(cookie)
-          execute :addCookie, {}, cookie
+          execute :addCookie, {}, :cookie => cookie
         end
 
         def deleteCookie(name)
-          execute :deleteCookie, :name => name
+          execute :deleteCookieNamed, :name => name
         end
 
         def getAllCookies
@@ -339,18 +325,20 @@ module Selenium
         end
 
         def dragElement(element, rigth_by, down_by)
-          # TODO: why is element sent twice in the payload?
-          execute :dragElement, {:id => element}, element, rigth_by, down_by
+          execute :dragElement, {:id => element}, :x => rigth_by, :y => down_by
+        end
+
+        def getCapabilities
+          Capabilities.json_create execute(:getCapabilities)
         end
 
         private
 
         def find_element_by(how, what, parent = nil)
           if parent
-            # TODO: why is how sent twice in the payload?
-            id = execute :findChildElement, {:id => parent, :using => how}, {:using => how, :value => what}
+            id = execute :findChildElement, {:id => parent}, {:using => how, :value => what}
           else
-            id = execute :findElement, {}, how, what
+            id = execute :findElement, {}, {:using => how, :value => what}
           end
 
           Element.new self, element_id_from(id)
@@ -359,9 +347,9 @@ module Selenium
         def find_elements_by(how, what, parent = nil)
           if parent
             # TODO: why is how sent twice in the payload?
-            ids = execute :findChildElements, {:id => parent, :using => how}, {:using => how, :value => what}
+            ids = execute :findChildElements, {:id => parent}, {:using => how, :value => what}
           else
-            ids = execute :findElements, {}, how, what
+            ids = execute :findElements, {}, {:using => how, :value => what}
           end
 
           ids.map { |id| Element.new self, element_id_from(id) }
@@ -385,21 +373,37 @@ module Selenium
         # Returns a WebDriver::Remote::Response instance
         #
 
-        def raw_execute(command, opts = {}, *args)
+        def raw_execute(command, opts = {}, command_hash = nil)
           verb, path = COMMANDS[command] || raise("unknown command #{command.inspect}")
           path       = path.dup
 
           path[':session_id'] = @session_id if path.include?(":session_id")
-          path[':context']    = @context if path.include?(":context")
 
           begin
-            opts.each { |key, value| path[key.inspect] = URI.escape(value.to_s) }
+            opts.each { |key, value| path[key.inspect] = URI.escape(value.to_s)}
           rescue IndexError
             raise ArgumentError, "#{opts.inspect} invalid for #{command.inspect}"
           end
 
           puts "-> #{verb.to_s.upcase} #{path}" if $DEBUG
-          http.call verb, path, *args
+          http.call verb, path, command_hash
+        end
+
+        def default_options
+          {
+            :url                  => "http://localhost:4444/wd/hub",
+            # TODO(jari): enable Patron when http://github.com/toland/patron/issues/issue/13 is fixed
+            :http_client          => DefaultHttpClient,
+            :desired_capabilities => Capabilities.firefox
+          }
+        end
+
+        def http_client_class
+          require "selenium/webdriver/remote/patron_http_client"
+          PatronHttpClient
+        rescue LoadError
+          # patron not available
+          DefaultHttpClient
         end
 
       end # Bridge

data/remote/client/src/rb/lib/selenium/webdriver/remote/commands.rb

@@ -1,53 +1,62 @@
+# @private
 class Selenium::WebDriver::Remote::Bridge
-  command :addCookie,                       :post,    "session/:session_id/:context/cookie"
-  command :goBack,                          :post,    "session/:session_id/:context/back"
-  command :clearElement,                    :post,    "session/:session_id/:context/element/:id/clear"
-  command :clickElement,                    :post,    "session/:session_id/:context/element/:id/click"
-  command :close,                           :delete,  "session/:session_id/:context/window"
-  command :getCurrentUrl,                   :get,     "session/:session_id/:context/url"
-  command :deleteAllCookies,                :delete,  "session/:session_id/:context/cookie"
-  command :deleteCookie,                    :delete,  "session/:session_id/:context/cookie/:name"
-  command :dragElement,                     :post,    "session/:session_id/:context/element/:id/drag"
-  command :elementEquals,                   :get,     "session/:session_id/:context/element/:id/equals/:other"
-  command :executeScript,                   :post,    "session/:session_id/:context/execute"
-  command :findElement,                     :post,    "session/:session_id/:context/element"
-  command :findElements,                    :post,    "session/:session_id/:context/elements"
-  command :findChildElement,                :post,    "session/:session_id/:context/element/:id/element/:using"
-  command :findChildElements,               :post,    "session/:session_id/:context/element/:id/elements/:using"
-  command :goForward,                       :post,    "session/:session_id/:context/forward"
-  command :get,                             :post,    "session/:session_id/:context/url"
-  command :getActiveElement,                :post,    "session/:session_id/:context/element/active"
-  command :getAllCookies,                   :get,     "session/:session_id/:context/cookie"
-  # command :getCookie # TODO: getCookie
-  command :getCurrentWindowHandle,          :get,     "session/:session_id/:context/window_handle"
-  command :getElementAttribute,             :get,     "session/:session_id/:context/element/:id/attribute/:name"
-  command :getElementLocation,              :get,     "session/:session_id/:context/element/:id/location"
-  command :getElementSize,                  :get,     "session/:session_id/:context/element/:id/size"
-  command :getElementText,                  :get,     "session/:session_id/:context/element/:id/text"
-  command :getElementValue,                 :get,     "session/:session_id/:context/element/:id/value"
-  command :getSpeed,                        :get,     "session/:session_id/:context/speed"
-  command :getElementTagName,               :get,     "session/:session_id/:context/element/:id/name"
-  command :getTitle,                        :get,     "session/:session_id/:context/title"
-  command :getElementValueOfCssProperty,    :get,     "session/:session_id/:context/element/:id/css/:property_name"
-  command :getVisible,                      :get,     "session/:session_id/:context/visible"
-  command :getWindowHandles,                :get,     "session/:session_id/:context/window_handles"
-  command :hoverOverElement,                :post,    "session/:session_id/:context/element/:id/hover"
-  command :isElementDisplayed,              :get,     "session/:session_id/:context/element/:id/displayed"
-  command :isElementEnabled,                :get,     "session/:session_id/:context/element/:id/enabled"
-  command :isElementSelected,               :get,     "session/:session_id/:context/element/:id/selected"
+
+  #
+  # http://code.google.com/p/selenium/wiki/JsonWireProtocol#Command_Reference
+  #
+
   command :newSession,                      :post,    "session"
-  command :getPageSource,                   :get,     "session/:session_id/:context/source"
+  command :getCapabilities,                 :get,     "session/:session_id"
   command :quit,                            :delete,  "session/:session_id"
-  command :refresh,                         :post,    "session/:session_id/:context/refresh"
-  command :screenshot,                      :get,     "session/:session_id/:context/screenshot"
-  command :sendKeysToElement,               :post,    "session/:session_id/:context/element/:id/value"
-  command :setElementSelected,              :post,    "session/:session_id/:context/element/:id/selected"
-  command :setSpeed,                        :post,    "session/:session_id/:context/speed"
-  command :setVisible,                      :post,    "session/:session_id/:context/visible"
-  command :submitElement,                   :post,    "session/:session_id/:context/element/:id/submit"
-  command :switchToFrame,                   :post,    "session/:session_id/:context/frame/:id"
+  command :getCurrentWindowHandle,          :get,     "session/:session_id/window_handle"
+  command :getWindowHandles,                :get,     "session/:session_id/window_handles"
+  command :getCurrentUrl,                   :get,     "session/:session_id/url"
+  command :get,                             :post,    "session/:session_id/url"
+  command :goForward,                       :post,    "session/:session_id/forward"
+  command :goBack,                          :post,    "session/:session_id/back"
+  command :refresh,                         :post,    "session/:session_id/refresh"
+  command :executeScript,                   :post,    "session/:session_id/execute"
+  command :screenshot,                      :get,     "session/:session_id/screenshot"
+  command :switchToFrame,                   :post,    "session/:session_id/frame"
+  command :switchToWindow,                  :post,    "session/:session_id/window"
+  command :getSpeed,                        :get,     "session/:session_id/speed"
+  command :setSpeed,                        :post,    "session/:session_id/speed"
+  command :getAllCookies,                   :get,     "session/:session_id/cookie"
+  command :addCookie,                       :post,    "session/:session_id/cookie"
+  command :deleteAllCookies,                :delete,  "session/:session_id/cookie"
+  command :deleteCookieNamed,               :delete,  "session/:session_id/cookie/:name"
+  command :getPageSource,                   :get,     "session/:session_id/source"
+  command :getTitle,                        :get,     "session/:session_id/title"
+  command :findElement,                     :post,    "session/:session_id/element"
+  command :findElements,                    :post,    "session/:session_id/elements"
+  command :getActiveElement,                :post,    "session/:session_id/element/active"
+  command :describeElement,                 :get,     "session/:session_id/element/:id"
+  command :findChildElement,                :post,    "session/:session_id/element/:id/element"
+  command :findChildElements,               :post,    "session/:session_id/element/:id/elements"
+  command :clickElement,                    :post,    "session/:session_id/element/:id/click"
+  command :submitElement,                   :post,    "session/:session_id/element/:id/submit"
+  command :getElementValue,                 :get,     "session/:session_id/element/:id/value"
+  command :sendKeysToElement,               :post,    "session/:session_id/element/:id/value"
+  command :getElementTagName,               :get,     "session/:session_id/element/:id/name"
+  command :clearElement,                    :post,    "session/:session_id/element/:id/clear"
+  command :isElementSelected,               :get,     "session/:session_id/element/:id/selected"
+  command :setElementSelected,              :post,    "session/:session_id/element/:id/selected"
+  command :toggleElement,                   :post,    "session/:session_id/element/:id/toggle"
+  command :isElementEnabled,                :get,     "session/:session_id/element/:id/enabled"
+  command :getElementAttribute,             :get,     "session/:session_id/element/:id/attribute/:name"
+  command :elementEquals,                   :get,     "session/:session_id/element/:id/equals/:other"
+  command :isElementDisplayed,              :get,     "session/:session_id/element/:id/displayed"
+  command :getElementLocation,              :get,     "session/:session_id/element/:id/location"
+  command :getElementLocationInView,        :get,     "session/:session_id/element/:id/location_in_view"
+  command :getElementSize,                  :get,     "session/:session_id/element/:id/size"
+  command :hoverOverElement,                :post,    "session/:session_id/element/:id/hover"
+  command :dragElement,                     :post,    "session/:session_id/element/:id/drag"
+  command :getElementValueOfCssProperty,    :get,     "session/:session_id/element/:id/css/:property_name"
+
+  command :close,                           :delete,  "session/:session_id/window"
+  command :getElementText,                  :get,     "session/:session_id/element/:id/text"
+  command :getVisible,                      :get,     "session/:session_id/visible"
+  command :setVisible,                      :post,    "session/:session_id/visible"
   # command :switchToFrameByIndex # TODO: switchToFrameByIndex
   # command :switchToDefaultContent # TODO: switchToDefaultContent
-  command :switchToWindow,                  :post,    "session/:session_id/:context/window/:name"
-  command :toggleElement,                   :post,    "session/:session_id/:context/element/:id/toggle"
 end

data/remote/client/src/rb/lib/selenium/webdriver/remote/default_http_client.rb

@@ -3,45 +3,33 @@ require "net/http"
 module Selenium
   module WebDriver
     module Remote
+
+      # @private
       class DefaultHttpClient
         CONTENT_TYPE    = "application/json"
-        DEFAULT_HEADERS = { "Accept" => CONTENT_TYPE }
-
-        class RetryException < StandardError; end
+        DEFAULT_HEADERS = { "Accept" => CONTENT_TYPE, "Content-Length" => "0" }
 
         def initialize(url)
           @server_url = url
         end
 
-        def call(verb, url, *args)
+        def call(verb, url, command_hash)
           response = nil
           url      = @server_url.merge(url) unless url.kind_of?(URI)
           headers  = DEFAULT_HEADERS.dup
 
-          if args.any?
-            headers.merge!("Content-Type" => "#{CONTENT_TYPE}; charset=utf-8")
-            payload = args.to_json
-            puts "   >>> #{payload}" if $DEBUG
-          end
-
-          begin
-            request = Net::HTTP.const_get(verb.to_s.capitalize).new(url.path, headers)
+          if command_hash
+            payload = command_hash.to_json
+            headers["Content-Type"] = "#{CONTENT_TYPE}; charset=utf-8"
+            headers["Content-Length"] = payload.bytesize.to_s if [:post, :put].include?(verb)
 
-            # TODO: should be checking against a maximum redirect count
-            http.request(request, payload) do |res|
-              if res.kind_of? Net::HTTPRedirection
-                verb, payload = :get, nil
-                url           = URI.parse(res["Location"])
-                raise RetryException
-              else
-                response = create_response(res)
-              end
+            if $DEBUG
+              puts "   >>> #{payload}"
+              puts "     > #{headers.inspect}"
             end
-
-            response
-          rescue RetryException
-            retry
           end
+
+          request verb, url, headers, payload
         end
 
         private
@@ -51,6 +39,18 @@ module Selenium
           @http ||= Net::HTTP.new @server_url.host, @server_url.port
         end
 
+        def request(verb, url, headers, payload)
+          request  = Net::HTTP.const_get(verb.to_s.capitalize).new(url.path, headers)
+          response = http.request(request, payload)
+
+          # TODO: should be checking against a maximum redirect count
+          if response.kind_of? Net::HTTPRedirection
+            request(:get, URI.parse(response['Location']), DEFAULT_HEADERS.dup, nil)
+          else
+            create_response response
+          end
+        end
+
         def create_response(res)
           puts "<- #{res.body}\n" if $DEBUG
           if res.content_type == CONTENT_TYPE
@@ -68,4 +68,4 @@ module Selenium
       end # DefaultHttpClient
     end # Remote
   end # WebDriver
-end # Selenium
+end # Selenium

data/remote/client/src/rb/lib/selenium/webdriver/remote/patron_http_client.rb

@@ -0,0 +1,58 @@
+require "patron"
+
+module Selenium
+  module WebDriver
+    module Remote
+
+      # @private
+      class PatronHttpClient
+        CONTENT_TYPE    = "application/json"
+        DEFAULT_HEADERS = { "Accept" => CONTENT_TYPE, "Content-Length" => "0" }
+
+        def initialize(url)
+          @session = Patron::Session.new
+          @session.base_url = url
+        end
+
+        def call(verb, url, command_hash)
+          DEFAULT_HEADERS.each do |key, val|
+            @session.headers[key] = val
+          end
+
+          if command_hash
+            payload = command_hash.to_json
+            @session.headers['Content-Type'] = "#{CONTENT_TYPE}; charset=utf-8;"
+            @session.headers['Content-Length'] = payload.bytesize.to_s if [:post, :put].include?(verb)
+            if $DEBUG
+              puts "   >>> #{payload}"
+              puts "     > #{@session.headers.inspect}"
+            end
+          end
+
+          if [:post, :put].include?(verb)
+            create_response @session.send(verb, url, payload || '')
+          else
+            create_response @session.send(verb, url)
+          end
+        end
+
+        private
+
+        def create_response(res)
+          puts "<- #{res.body}\n" if $DEBUG
+          if res.headers['Content-Type'].include? CONTENT_TYPE
+            Response.new do |r|
+              r.code         = res.status.to_i
+              r.payload      = JSON.parse(res.body.strip)
+            end
+          elsif res.status == '204'
+            Response.new { |r| r.code = res.code.to_i }
+          else
+            raise "Unexpected content type: #{res.headers.inspect} (#{res.status})\n#{res.body}"
+          end
+        end
+
+      end # PatronHttpClient
+    end # Remote
+  end # WebDriver
+end # Selenium

data/remote/client/src/rb/lib/selenium/webdriver/remote/response.rb

@@ -1,6 +1,8 @@
 module Selenium
   module WebDriver
     module Remote
+
+      # @private
       class Response
 
         attr_accessor :code
@@ -12,12 +14,11 @@ module Selenium
         end
 
         def error
-          if payload['error']
-            value = payload['value']
-            # the remote server gets this wrong, where the value is double encoded as JSON
-            # the iphone driver does the right thing
-            value.kind_of?(String) ? JSON.parse(value) : value
-          end
+          Error.for_code(payload['status'])
+        end
+
+        def error_message
+          payload['value']['message']
         end
 
         def [](key)
@@ -31,14 +32,11 @@ module Selenium
         private
 
         def assert_ok
-          if @code.nil? || @code > 400
+          if @code.nil? || @code >= 400
             if e = error()
-              raise(
-                Error.for_remote_class(e['class']),
-                e['message'] || self
-              )
+              raise(e, error_message)
             else
-              raise ServerError, self
+              raise Error::ServerError, self
             end
           end
         end