browserstack-webdriver 0.0.1

data/lib/selenium/webdriver/remote/capabilities.rb

@@ -0,0 +1,267 @@
+module Selenium
+  module WebDriver
+    module Remote
+      #
+      # Specification of the desired and/or actual capabilities of the browser that the
+      # server is being asked to create.
+      #
+      class Capabilities
+
+        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
+        }
+
+        DEFAULTS.each_key do |key|
+          define_method key do
+            @capabilities.fetch(key)
+          end
+
+          define_method "#{key}=" do |value|
+            @capabilities[key] = value
+          end
+        end
+
+        alias_method :css_selectors_enabled?, :css_selectors_enabled
+        alias_method :javascript_enabled?   , :javascript_enabled
+        alias_method :native_events?        , :native_events
+        alias_method :takes_screenshot?     , :takes_screenshot
+        alias_method :rotatable?            , :rotatable
+
+        #
+        # Convenience methods for the common choices.
+        #
+
+        class << self
+          def android(opts = {})
+            new({
+              :browser_name     => "android",
+              :platform         => :android,
+              :rotatable        => true,
+              :takes_screenshot => true
+            }.merge(opts))
+          end
+
+          def chrome(opts = {})
+            new({
+              :browser_name          => "chrome",
+              :javascript_enabled    => true,
+              :css_selectors_enabled => true
+            }.merge(opts))
+          end
+
+          def firefox(opts = {})
+            new({
+              :browser_name          => "firefox",
+              :javascript_enabled    => true,
+              :takes_screenshot      => true,
+              :css_selectors_enabled => true
+            }.merge(opts))
+          end
+
+          def htmlunit(opts = {})
+            new({
+              :browser_name => "htmlunit"
+            }.merge(opts))
+          end
+
+          def htmlunitwithjs(opts = {})
+            new({
+              :browser_name => "htmlunit",
+              :javascript_enabled => true
+            }.merge(opts))
+          end
+
+          def internet_explorer(opts = {})
+            new({
+              :browser_name          => "internet explorer",
+              :platform              => :windows,
+              :takes_screenshot      => true,
+              :css_selectors_enabled => true,
+              :native_events         => true
+            }.merge(opts))
+          end
+          alias_method :ie, :internet_explorer
+
+          def iphone(opts = {})
+            new({
+              :browser_name       => "iPhone",
+              :platform           => :mac,
+              :javascript_enabled => true
+            }.merge(opts))
+          end
+
+          def ipad(opts = {})
+            new({
+              :browser_name       => "iPad",
+              :platform           => :mac,
+              :javascript_enabled => true
+            }.merge(opts))
+          end
+
+          def opera(opts = {})
+            new({
+              :browser_name          => "opera",
+              :javascript_enabled    => true,
+              :takes_screenshot      => true,
+              :css_selectors_enabled => true
+            }.merge(opts))
+          end
+
+          def phantomjs(opts = {})
+            new({
+              :browser_name          => "phantomjs",
+              :javascript_enabled    => true,
+              :takes_screenshot      => true,
+              :css_selectors_enabled => true
+            }.merge(opts))
+          end
+
+          def safari(opts = {})
+            new({
+              :browser_name          => "safari",
+              :javascript_enabled    => true,
+              :takes_screenshot      => true,
+              :css_selectors_enabled => true
+            }.merge(opts))
+          end
+
+          #
+          # @api private
+          #
+
+          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
+        end
+
+        # @option :browser_name           [String] required browser name
+        # @option :version                [String] required browser version number
+        # @option :platform               [Symbol] one of :any, :win, :mac, or :x
+        # @option :javascript_enabled     [Boolean] does the driver have javascript enabled?
+        # @option :css_selectors_enabled  [Boolean] does the driver support CSS selectors?
+        # @option :takes_screenshot       [Boolean] can this driver take screenshots?
+        # @option :native_events          [Boolean] does this driver use native events?
+        # @option :proxy                  [Selenium::WebDriver::Proxy, Hash] proxy configuration
+        #
+        # Firefox-specific options:
+        #
+        # @option :firefox_profile        [Selenium::WebDriver::Firefox::Profile] the firefox profile to use
+        #
+        # @api public
+        #
+
+        def initialize(opts = {})
+          @capabilities = DEFAULTS.merge(opts)
+          self.proxy    = opts.delete(:proxy)
+        end
+
+        #
+        # Allows setting arbitrary capabilities.
+        #
+
+        def []=(key, value)
+          @capabilities[key] = value
+        end
+
+        def [](key)
+          @capabilities[key]
+        end
+
+        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
+
+        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
+
+        # @api private
+        #
+
+        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
+
+        def to_json(*args)
+          WebDriver.json_dump as_json
+        end
+
+        def ==(other)
+          return false unless other.kind_of? self.class
+          as_json == other.as_json
+        end
+        alias_method :eql?, :==
+
+        protected
+
+        def capabilities
+          @capabilities
+        end
+
+        private
+
+        def camel_case(str)
+          str.gsub(/_([a-z])/) { $1.upcase }
+        end
+
+      end # Capabilities
+    end # Remote
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,193 @@
+# @api private
+class Selenium::WebDriver::Remote::Bridge
+
+  #
+  # http://code.google.com/p/selenium/wiki/JsonWireProtocol#Command_Reference
+  #
+
+  command :newSession,                             :post,    "session"
+  command :getCapabilities,                        :get,     "session/:session_id"
+  command :status,                                 :get,     "status"
+
+  #
+  # basic driver
+  #
+
+  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 :quit,                                   :delete,  "session/:session_id"
+  command :close,                                  :delete,  "session/:session_id/window"
+  command :getVisible,                             :get,     "session/:session_id/visible"
+  command :setVisible,                             :post,    "session/:session_id/visible"
+  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"
+
+  #
+  # window handling
+  #
+
+  command :getCurrentWindowHandle,                 :get,     "session/:session_id/window_handle"
+  command :getWindowHandles,                       :get,     "session/:session_id/window_handles"
+  command :setWindowSize,                          :post,    "session/:session_id/window/:window_handle/size"
+  command :setWindowPosition,                      :post,    "session/:session_id/window/:window_handle/position"
+  command :getWindowSize,                          :get,     "session/:session_id/window/:window_handle/size"
+  command :getWindowPosition,                      :get,     "session/:session_id/window/:window_handle/position"
+  command :maximizeWindow,                         :post,    "session/:session_id/window/:window_handle/maximize"
+
+  #
+  # script execution
+  #
+
+  command :executeScript,                          :post,    "session/:session_id/execute"
+  command :executeAsyncScript,                     :post,    "session/:session_id/execute_async"
+
+  #
+  # screenshot
+  #
+
+  command :screenshot,                             :get,     "session/:session_id/screenshot"
+
+  #
+  # alerts
+  #
+
+  command :dismissAlert,                           :post,    "session/:session_id/dismiss_alert"
+  command :acceptAlert,                            :post,    "session/:session_id/accept_alert"
+  command :getAlertText,                           :get,     "session/:session_id/alert_text"
+  command :setAlertValue,                          :post,    "session/:session_id/alert_text"
+
+  #
+  # target locator
+  #
+
+  command :switchToFrame,                          :post,    "session/:session_id/frame"
+  command :switchToWindow,                         :post,    "session/:session_id/window"
+
+  #
+  # options
+  #
+
+  command :getCookies,                             :get,     "session/:session_id/cookie"
+  command :addCookie,                              :post,    "session/:session_id/cookie"
+  command :deleteAllCookies,                       :delete,  "session/:session_id/cookie"
+  command :deleteCookie,                           :delete,  "session/:session_id/cookie/:name"
+
+  #
+  # timeouts
+  #
+
+  command :implicitlyWait,                         :post,    "session/:session_id/timeouts/implicit_wait"
+  command :setScriptTimeout,                       :post,    "session/:session_id/timeouts/async_script"
+  command :setTimeout,                             :post,    "session/:session_id/timeouts"
+
+  #
+  # element
+  #
+
+  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 :uploadFile,                             :post,    "session/:session_id/file"
+  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 :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 :getElementLocationOnceScrolledIntoView, :get,     "session/:session_id/element/:id/location_in_view"
+  command :getElementSize,                         :get,     "session/:session_id/element/:id/size"
+  command :dragElement,                            :post,    "session/:session_id/element/:id/drag"
+  command :getElementValueOfCssProperty,           :get,     "session/:session_id/element/:id/css/:property_name"
+  command :getElementText,                         :get,     "session/:session_id/element/:id/text"
+
+  #
+  # rotatable
+  #
+
+  command :getScreenOrientation,                   :get,     "session/:session_id/orientation"
+  command :setScreenOrientation,                   :post,    "session/:session_id/orientation"
+
+  #
+  # interactions API
+  #
+
+  command :click,                                  :post,    "session/:session_id/click"
+  command :doubleClick,                            :post,    "session/:session_id/doubleclick"
+  command :mouseDown,                              :post,    "session/:session_id/buttondown"
+  command :mouseUp,                                :post,    "session/:session_id/buttonup"
+  command :mouseMoveTo,                            :post,    "session/:session_id/moveto"
+  command :sendModifierKeyToActiveElement,         :post,    "session/:session_id/modifier"
+  command :sendKeysToActiveElement,                :post,    "session/:session_id/keys"
+
+  #
+  # html 5
+  #
+
+  command :executeSql,                             :post,   "session/:session_id/execute_sql"
+
+  command :getLocation,                            :get,    "session/:session_id/location"
+  command :setLocation,                            :post,   "session/:session_id/location"
+
+  command :getAppCache,                            :get,    "session/:session_id/application_cache"
+  command :getAppCacheStatus,                      :get,    "session/:session_id/application_cache/status"
+  command :clearAppCache,                          :delete, "session/:session_id/application_cache/clear"
+
+  command :isBrowserOnline,                        :get,    "session/:session_id/browser_connection"
+  command :setBrowserOnline,                       :post,   "session/:session_id/browser_connection"
+
+  command :getLocalStorageItem,                    :get,    "session/:session_id/local_storage/key/:key"
+  command :removeLocalStorageItem,                 :delete, "session/:session_id/local_storage/key/:key"
+  command :getLocalStorageKeys,                    :get,    "session/:session_id/local_storage"
+  command :setLocalStorageItem,                    :post,   "session/:session_id/local_storage"
+  command :clearLocalStorage,                      :delete, "session/:session_id/local_storage"
+  command :getLocalStorageSize,                    :get,    "session/:session_id/local_storage/size"
+
+  command :getSessionStorageItem,                  :get,    "session/:session_id/session_storage/key/:key"
+  command :removeSessionStorageItem,               :delete, "session/:session_id/session_storage/key/:key"
+  command :getSessionStorageKeys,                  :get,    "session/:session_id/session_storage"
+  command :setSessionStorageItem,                  :post,   "session/:session_id/session_storage"
+  command :clearSessionStorage,                    :delete, "session/:session_id/session_storage"
+  command :getSessionStorageSize,                  :get,    "session/:session_id/session_storage/size"
+
+  #
+  # ime
+  #
+
+  command :imeGetAvailableEngines,                 :get,    "session/:session_id/ime/available_engines"
+  command :imeGetActiveEngine,                     :get,    "session/:session_id/ime/active_engine"
+  command :imeIsActivated,                         :get,    "session/:session_id/ime/activated"
+  command :imeDeactivate,                          :post,   "session/:session_id/ime/deactivate"
+  command :imeActivateEngine,                      :post,   "session/:session_id/ime/activate"
+
+  #
+  # touch
+  #
+
+  command :touchSingleTap,                         :post,   "session/:session_id/touch/click"
+  command :touchDoubleTap,                         :post,   "session/:session_id/touch/doubleclick"
+  command :touchLongPress,                         :post,   "session/:session_id/touch/longclick"
+  command :touchDown,                              :post,   "session/:session_id/touch/down"
+  command :touchUp,                                :post,   "session/:session_id/touch/up"
+  command :touchMove,                              :post,   "session/:session_id/touch/move"
+  command :touchScroll,                            :post,   "session/:session_id/touch/scroll"
+  command :touchFlick,                             :post,   "session/:session_id/touch/flick"
+
+  #
+  # logs
+  #
+
+  command :getAvailableLogTypes,                   :get,    "session/:session_id/log/types"
+  command :getLog,                                 :post,   "session/:session_id/log"
+end