browserstack-webdriver 0.0.1

data/lib/selenium/webdriver/common/keys.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module Selenium
+  module WebDriver
+    module Keys
+
+      #
+      # @see Element#send_keys
+      # @see http://www.google.com.au/search?&q=unicode+pua&btnG=Search
+      #
+
+      KEYS = {
+      # \x works on both 1.8.6/1.9
+        :null         => "\xEE\x80\x80",
+        :cancel       => "\xEE\x80\x81",
+        :help         => "\xEE\x80\x82",
+        :backspace    => "\xEE\x80\x83",
+        :tab          => "\xEE\x80\x84",
+        :clear        => "\xEE\x80\x85",
+        :return       => "\xEE\x80\x86",
+        :enter        => "\xEE\x80\x87",
+        :shift        => "\xEE\x80\x88",
+        :left_shift   => "\xEE\x80\x88",
+        :control      => "\xEE\x80\x89",
+        :left_control => "\xEE\x80\x89",
+        :alt          => "\xEE\x80\x8A",
+        :left_alt     => "\xEE\x80\x8A",
+        :pause        => "\xEE\x80\x8B",
+        :escape       => "\xEE\x80\x8C",
+        :space        => "\xEE\x80\x8D",
+        :page_up      => "\xEE\x80\x8E",
+        :page_down    => "\xEE\x80\x8F",
+        :end          => "\xEE\x80\x90",
+        :home         => "\xEE\x80\x91",
+        :left         => "\xEE\x80\x92",
+        :arrow_left   => "\xEE\x80\x92",
+        :up           => "\xEE\x80\x93",
+        :arrow_up     => "\xEE\x80\x93",
+        :right        => "\xEE\x80\x94",
+        :arrow_right  => "\xEE\x80\x94",
+        :down         => "\xEE\x80\x95",
+        :arrow_down   => "\xEE\x80\x95",
+        :insert       => "\xEE\x80\x96",
+        :delete       => "\xEE\x80\x97",
+        :semicolon    => "\xEE\x80\x98",
+        :equals       => "\xEE\x80\x99",
+        :numpad0      => "\xEE\x80\x9A",
+        :numpad1      => "\xEE\x80\x9B",
+        :numpad2      => "\xEE\x80\x9C",
+        :numpad3      => "\xEE\x80\x9D",
+        :numpad4      => "\xEE\x80\x9E",
+        :numpad5      => "\xEE\x80\x9F",
+        :numpad6      => "\xEE\x80\xA0",
+        :numpad7      => "\xEE\x80\xA1",
+        :numpad8      => "\xEE\x80\xA2",
+        :numpad9      => "\xEE\x80\xA3",
+        :multiply     => "\xEE\x80\xA4",
+        :add          => "\xEE\x80\xA5",
+        :separator    => "\xEE\x80\xA6",
+        :subtract     => "\xEE\x80\xA7",
+        :decimal      => "\xEE\x80\xA8",
+        :divide       => "\xEE\x80\xA9",
+        :f1           => "\xEE\x80\xB1",
+        :f2           => "\xEE\x80\xB2",
+        :f3           => "\xEE\x80\xB3",
+        :f4           => "\xEE\x80\xB4",
+        :f5           => "\xEE\x80\xB5",
+        :f6           => "\xEE\x80\xB6",
+        :f7           => "\xEE\x80\xB7",
+        :f8           => "\xEE\x80\xB8",
+        :f9           => "\xEE\x80\xB9",
+        :f10          => "\xEE\x80\xBA",
+        :f11          => "\xEE\x80\xBB",
+        :f12          => "\xEE\x80\xBC",
+        :meta         => "\xEE\x80\xBD",
+        :command      => "\xEE\x80\xBD" # alias
+      }
+
+      #
+      # @api private
+      #
+
+      def self.[](key)
+        KEYS[key] or raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
+      end
+
+      #
+      # @api private
+      #
+
+      def self.encode(keys)
+        keys.map do |arg|
+          case arg
+          when Symbol
+            Keys[arg]
+          when Array
+            arg = arg.map { |e| e.kind_of?(Symbol) ? Keys[e] : e }.join
+            arg << Keys[:null]
+
+            arg
+          else
+            arg.to_s
+          end
+        end
+      end
+
+    end # Keys
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/log_entry.rb

@@ -0,0 +1,29 @@
+module Selenium
+  module WebDriver
+    class LogEntry
+      attr_reader :level, :timestamp, :message
+
+      def initialize(level, timestamp, message)
+        @level      = level
+        @timestamp = timestamp
+        @message    = message
+      end
+
+      def as_json(opts = nil)
+        {
+          'level'     => level,
+          'timestamp' => timestamp,
+          'message'   => message
+        }
+      end
+
+      def to_s
+        "#{level} #{time}: #{message}"
+      end
+
+      def time
+        Time.at timestamp / 1000
+      end
+    end
+  end
+end

data/lib/selenium/webdriver/common/logs.rb

@@ -0,0 +1,23 @@
+module Selenium
+  module WebDriver
+    class Logs
+
+      #
+      # @api private
+      #
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      def get(type)
+        @bridge.getLog type
+      end
+
+      def available_types
+        @bridge.getAvailableLogTypes
+      end
+
+    end
+  end
+end

data/lib/selenium/webdriver/common/mouse.rb

@@ -0,0 +1,72 @@
+module Selenium
+  module WebDriver
+
+    #
+    # @api private
+    # @see ActionBuilder
+    #
+
+    class Mouse
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      def click(element = nil)
+        move_if_needed element
+        @bridge.click
+      end
+
+      def double_click(element = nil)
+        move_if_needed element
+        @bridge.doubleClick
+      end
+
+      def context_click(element = nil)
+        move_if_needed element
+        @bridge.contextClick
+      end
+
+      def down(element = nil)
+        move_if_needed element
+        @bridge.mouseDown
+      end
+
+      def up(element = nil)
+        move_if_needed element
+        @bridge.mouseUp
+      end
+
+      #
+      # Move the mouse.
+      #
+      # Examples:
+      #
+      #   driver.mouse.move_to(element)
+      #   driver.mouse.move_to(element, 5, 5)
+      #
+
+      def move_to(element, right_by = nil, down_by = nil)
+        assert_element element
+
+        @bridge.mouseMoveTo element.ref, right_by, down_by
+      end
+
+      def move_by(right_by, down_by)
+        @bridge.mouseMoveTo nil, Integer(right_by), Integer(down_by)
+      end
+
+      private
+
+      def move_if_needed(element)
+        move_to element if element
+      end
+
+      def assert_element(element)
+        unless element.kind_of? Element
+          raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
+        end
+      end
+    end # Mouse
+  end # WebDriver
+end  # Selenium

data/lib/selenium/webdriver/common/navigation.rb

@@ -0,0 +1,43 @@
+module Selenium
+  module WebDriver
+    class Navigation
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      #
+      # Navigate to the given URL
+      #
+
+      def to(url)
+        @bridge.get url
+      end
+
+      #
+      # Move back a single entry in the browser's history.
+      #
+
+      def back
+        @bridge.goBack
+      end
+
+      #
+      # Move forward a single entry in the browser's history.
+      #
+
+      def forward
+        @bridge.goForward
+      end
+
+      #
+      # Refresh the current page.
+      #
+
+      def refresh
+        @bridge.refresh
+      end
+
+    end # Navigation
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/options.rb

@@ -0,0 +1,136 @@
+module Selenium
+  module WebDriver
+    class Options
+
+      #
+      # @api private
+      #
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      #
+      # Add a cookie to the browser
+      #
+      # @param [Hash] opts the options to create a cookie with.
+      # @option opts [String] :name A name
+      # @option opts [String] :value A value
+      # @option opts [String] :path ('/') A path
+      # @option opts [String] :secure (false) A boolean
+      # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
+      #
+      # @raise [ArgumentError] if :name or :value is not specified
+      #
+
+      def add_cookie(opts = {})
+        raise ArgumentError, "name is required" unless opts[:name]
+        raise ArgumentError, "value is required" unless opts[:value]
+
+        opts[:path] ||= "/"
+        opts[:secure] ||= false
+
+        if obj = opts.delete(:expires)
+          opts[:expiry] = seconds_from(obj)
+        end
+
+
+        @bridge.addCookie opts
+      end
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        all_cookies.find { |c| c[:name] == name }
+      end
+
+      #
+      # Delete the cookie with the given name
+      #
+      # @param [String] name the name of the cookie to delete
+      #
+
+      def delete_cookie(name)
+        @bridge.deleteCookie name
+      end
+
+      #
+      # Delete all cookies
+      #
+
+      def delete_all_cookies
+        @bridge.deleteAllCookies
+      end
+
+      #
+      # Get all cookies
+      #
+      # @return [Array<Hash>] list of cookies
+      #
+
+      def all_cookies
+        @bridge.getAllCookies.map do |cookie|
+          {
+            :name    => cookie["name"],
+            :value   => cookie["value"],
+            :path    => cookie["path"],
+            :domain  => cookie["domain"] && strip_port(cookie["domain"]),
+            :expires => cookie["expiry"] && datetime_at(cookie['expiry']),
+            :secure  => cookie["secure"]
+          }
+        end
+      end
+
+      def timeouts
+        @timeouts ||= Timeouts.new(@bridge)
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def logs
+        @logs ||= Logs.new(@bridge)
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def window
+        @window ||= Window.new(@bridge)
+      end
+
+      private
+
+      SECONDS_PER_DAY = 86_400.0
+
+      def datetime_at(int)
+        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
+      end
+
+      def seconds_from(obj)
+        case obj
+        when Time
+          obj.to_f
+        when DateTime
+          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
+        when Numeric
+          obj
+        else
+          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+        end
+      end
+
+      def strip_port(str)
+        str.split(":", 2).first
+      end
+
+    end # Options
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/platform.rb

@@ -0,0 +1,218 @@
+require 'rbconfig'
+require 'socket'
+
+module Selenium
+  module WebDriver
+
+    # @api private
+    module Platform
+
+      module_function
+
+      def home
+        # jruby has an issue with ENV['HOME'] on Windows
+        @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
+      end
+
+      def engine
+        @engine ||= (
+          if defined? RUBY_ENGINE
+            RUBY_ENGINE.to_sym
+          else
+            :ruby
+          end
+        )
+      end
+
+      def os
+        @os ||= (
+          host_os = RbConfig::CONFIG['host_os']
+          case host_os
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            :windows
+          when /darwin|mac os/
+            :macosx
+          when /linux/
+            :linux
+          when /solaris|bsd/
+            :unix
+          else
+            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+          end
+        )
+      end
+
+      def bitsize
+        @bitsize ||= (
+          if defined?(FFI::Platform::ADDRESS_SIZE)
+            FFI::Platform::ADDRESS_SIZE
+          elsif defined?(FFI)
+            FFI.type_size(:pointer) == 4 ? 32 : 64
+          elsif jruby?
+            Integer(ENV_JAVA['sun.arch.data.model'])
+          else
+            1.size == 4 ? 32 : 64
+          end
+        )
+      end
+
+      def jruby?
+        engine == :jruby
+      end
+
+      def ironruby?
+        engine == :ironruby
+      end
+
+      def ruby187?
+        !!(RUBY_VERSION =~ /^1\.8\.7/)
+      end
+
+      def ruby19?
+        !!(RUBY_VERSION =~ /^1\.9/)
+      end
+
+      def windows?
+        os == :windows
+      end
+
+      def mac?
+        os == :macosx
+      end
+
+      def linux?
+        os == :linux
+      end
+
+      def cygwin?
+        !!(RUBY_PLATFORM =~ /cygwin/)
+      end
+
+      def null_device
+        @null_device ||= (
+          if defined?(File::NULL)
+            File::NULL
+          else
+            Platform.windows? ? 'NUL' : '/dev/null'
+          end
+        )
+      end
+
+      def wrap_in_quotes_if_necessary(str)
+        windows? && !cygwin? ? %{"#{str}"} : str
+      end
+
+      def cygwin_path(path, opts = {})
+        flags = []
+        opts.each { |k,v| flags << "--#{k}" if v }
+
+        `cygpath #{flags.join ' '} "#{path}"`.strip
+      end
+
+      def make_writable(file)
+        File.chmod 0766, file
+      end
+
+      def assert_file(path)
+        unless File.file? path
+          raise Error::WebDriverError, "not a file: #{path.inspect}"
+        end
+      end
+
+      def assert_executable(path)
+        assert_file(path)
+
+        unless File.executable? path
+          raise Error::WebDriverError, "not executable: #{path.inspect}"
+        end
+      end
+
+      def exit_hook(&blk)
+        pid = Process.pid
+
+        at_exit do
+          yield if Process.pid == pid
+        end
+      end
+
+      def find_binary(*binary_names)
+        paths = ENV['PATH'].split(File::PATH_SEPARATOR)
+        binary_names.map! { |n| "#{n}.exe" } if windows?
+
+        binary_names.each do |binary_name|
+          paths.each do |path|
+            exe = File.join(path, binary_name)
+            return exe if File.executable?(exe)
+          end
+        end
+
+        nil
+      end
+
+      def find_in_program_files(*binary_names)
+        paths = [
+          ENV['PROGRAMFILES'] || "\\Program Files",
+          ENV['ProgramFiles(x86)'] || "\\Program Files (x86)"
+        ]
+
+        paths.each do |root|
+          binary_names.each do |name|
+            exe = File.join(root, name)
+            return exe if File.executable?(exe)
+          end
+        end
+
+        nil
+      end
+
+      def localhost
+        info = Socket.getaddrinfo "localhost", 80, Socket::AF_INET, Socket::SOCK_STREAM
+
+        if info.empty?
+          raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
+        end
+
+        info[0][3]
+      end
+
+      def ip
+        orig = Socket.do_not_reverse_lookup
+        Socket.do_not_reverse_lookup = true
+
+        begin
+          UDPSocket.open do |s|
+            s.connect '8.8.8.8', 53
+            return s.addr.last
+          end
+        ensure
+          Socket.do_not_reverse_lookup = orig
+        end
+      rescue Errno::ENETUNREACH, Errno::EHOSTUNREACH
+        # no external ip
+      end
+
+      def interfaces
+        interfaces = Socket.getaddrinfo("localhost", 8080).map { |e| e[3] }
+        interfaces += ["0.0.0.0", Platform.ip]
+
+        interfaces.compact.uniq
+      end
+
+    end # Platform
+  end # WebDriver
+end # Selenium
+
+if __FILE__ == $0
+  p :engine      => Selenium::WebDriver::Platform.engine,
+    :os          => Selenium::WebDriver::Platform.os,
+    :ruby187?    => Selenium::WebDriver::Platform.ruby187?,
+    :ruby19?     => Selenium::WebDriver::Platform.ruby19?,
+    :jruby?      => Selenium::WebDriver::Platform.jruby?,
+    :windows?    => Selenium::WebDriver::Platform.windows?,
+    :home        => Selenium::WebDriver::Platform.home,
+    :bitsize     => Selenium::WebDriver::Platform.bitsize,
+    :localhost   => Selenium::WebDriver::Platform.localhost,
+    :ip          => Selenium::WebDriver::Platform.ip,
+    :interfaces  => Selenium::WebDriver::Platform.interfaces,
+    :null_device => Selenium::WebDriver::Platform.null_device
+end