akephalos2 2.0.0

data/lib/akephalos/capybara.rb

@@ -0,0 +1,343 @@
+# Driver class exposed to Capybara. It implements Capybara's full driver API,
+# and is the entry point for interaction between the test suites and HtmlUnit.
+#
+# This class and +Capybara::Driver::Akephalos::Node+ are written to run on both
+# MRI and JRuby, and is agnostic whether the Akephalos::Client instance is used
+# directly or over DRb.
+class Capybara::Driver::Akephalos < Capybara::Driver::Base
+
+  # Akephalos-specific implementation for Capybara's Driver::Node class.
+  class Node < Capybara::Driver::Node
+
+    # @api capybara
+    # @return [String] the inner text of the node
+    def text
+      native.text
+    end
+
+    # @api capybara
+    # @param [String] name attribute name
+    # @return [String] the attribute value
+    def [](name)
+      name = name.to_s
+      case name
+      when 'checked'
+        native.checked?
+      else
+        native[name.to_s]
+      end
+    end
+
+    # @api capybara
+    # @return [String, Array<String>] the form element's value
+    def value
+      native.value
+    end
+
+    # Set the form element's value.
+    #
+    # @api capybara
+    # @param [String] value the form element's new value
+    def set(value)
+      if tag_name == 'textarea'
+        native.value = value.to_s
+      elsif tag_name == 'input' and type == 'radio'
+        click
+      elsif tag_name == 'input' and type == 'checkbox'
+        if value != self['checked']
+          click
+        end
+      elsif tag_name == 'input'
+        native.value = value.to_s
+      end
+    end
+
+    # @api capybara
+    def select_option
+      native.click
+    end
+
+    # Unselect an option from a select box.
+    #
+    # @api capybara
+    def unselect_option
+      unless select_node.multiple_select?
+        raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box."
+      end
+
+      native.unselect
+    end
+
+    # Click the element.
+    def click
+      native.click
+    end
+
+    # Drag the element on top of the target element.
+    #
+    # @api capybara
+    # @param [Node] element the target element
+    def drag_to(element)
+      trigger('mousedown')
+      element.trigger('mousemove')
+      element.trigger('mouseup')
+    end
+
+    # @api capybara
+    # @return [String] the element's tag name
+    def tag_name
+      native.tag_name
+    end
+
+    # @api capybara
+    # @return [true, false] the element's visiblity
+    def visible?
+      native.visible?
+    end
+
+    # @api capybara
+    # @return [true, false] the element's visiblity
+    def checked?
+      native.checked?
+    end
+
+    # @api capybara
+    # @return [true, false] the element's visiblity
+    def selected?
+      native.selected?
+    end
+
+    # @api capybara
+    # @return [String] the XPath to locate the node
+    def path
+      native.xpath
+    end
+
+    # Trigger an event on the element.
+    #
+    # @api capybara
+    # @param [String] event the event to trigger
+    def trigger(event)
+      native.fire_event(event.to_s)
+    end
+
+    # @api capybara
+    # @param [String] selector XPath query
+    # @return [Array<Node>] the matched nodes
+    def find(selector)
+      nodes = []
+      native.find(selector).each { |node| nodes << self.class.new(self, node) }
+      nodes
+    end
+
+    protected
+
+    # @return [true, false] whether the node allows multiple-option selection (if the node is a select).
+    def multiple_select?
+      tag_name == "select" && native.multiple_select?
+    end
+
+    private
+
+    # Return all child nodes which match the selector criteria.
+    #
+    # @api capybara
+    # @return [Array<Node>] the matched nodes
+    def all_unfiltered(selector)
+      nodes = []
+      native.find(selector).each { |node| nodes << self.class.new(driver, node) }
+      nodes
+    end
+
+    # @return [String] the node's type attribute
+    def type
+      native[:type]
+    end
+
+    # @return [Node] the select node, if this is an option node
+    def select_node
+      find('./ancestor::select').first
+    end
+  end
+
+  attr_reader :app, :rack_server, :options
+
+  # Creates a new instance of the Akephalos Driver for Capybara. The driver is
+  # registered with Capybara by a name, so that it can be chosen when
+  # Capybara's javascript_driver is changed. By default, Akephalos is
+  # registered like this:
+  #
+  #   Capybara.register_driver :akephalos do |app|
+  #     Capybara::Akephalos::Driver.new(
+  #       app,
+  #       :browser => :firefox_3_6,
+  #       :validate_scripts => true
+  #     )
+  #   end
+  #
+  # @param app the Rack application to run
+  # @param [Hash] options the Akephalos configuration options
+  # @option options [Symbol] :browser (:firefox_3_6) the browser
+  #   compatibility mode to run in. Available options:
+  #       :firefox_3_6
+  #       :firefox_3
+  #       :ie6
+  #       :ie7
+  #       :ie8
+  #
+  # @option options [true, false] :validate_scripts (true) whether to raise
+  #   exceptions on script errors
+  #
+  def initialize(app, options = {})
+    @app = app
+    @options = options
+    @rack_server = Capybara::Server.new(@app)
+    @rack_server.boot if Capybara.run_server
+  end
+
+  # Visit the given path in the browser.
+  #
+  # @param [String] path relative path to visit
+  def visit(path)
+    browser.visit(url(path))
+  end
+
+  # @return [String] the page's original source
+  def source
+    page.source
+  end
+
+  # @return [String] the page's modified source
+  # page.modified_source will return a string with
+  # html entities converted into the unicode equivalent
+  # but the string will be marked as ASCII-8BIT
+  # which causes conversion issues so we force the encoding
+  # to UTF-8 (ruby 1.9 only)
+  def body
+    body_source = page.modified_source
+
+    if body_source.respond_to?(:force_encoding)
+      body_source.force_encoding("UTF-8")
+    else
+      body_source
+    end
+  end
+
+  # @return [Hash{String => String}] the page's response headers
+  def response_headers
+    page.response_headers
+  end
+
+  # @return [Integer] the response's status code
+  def status_code
+    page.status_code
+  end
+
+  # Execute the given block within the context of a specified frame.
+  #
+  # @param [String] frame_id the frame's id
+  # @raise [Capybara::ElementNotFound] if the frame is not found
+  def within_frame(frame_id, &block)
+    unless page.within_frame(frame_id, &block)
+      raise Capybara::ElementNotFound, "Unable to find frame with id '#{frame_id}'"
+    end
+  end
+
+  # Clear all cookie session data.
+  # @deprecated This method is deprecated in Capybara's master branch. Use
+  #   {#reset!} instead.
+  def cleanup!
+    reset!
+  end
+
+  # Clear all cookie session data.
+  def reset!
+    cookies.clear
+  end
+
+  # Confirm or cancel the dialog, returning the text of the dialog
+  def confirm_dialog(confirm = true, &block)
+    browser.confirm_dialog(confirm, &block)
+  end
+
+  # @return [String] the page's current URL
+  def current_url
+    page.current_url
+  end
+
+  # Search for nodes which match the given XPath selector.
+  #
+  # @param [String] selector XPath query
+  # @return [Array<Node>] the matched nodes
+  def find(selector)
+    nodes = []
+    page.find(selector).each { |node| nodes << Node.new(self, node) }
+    nodes
+  end
+
+  # Execute JavaScript against the current page, discarding any return value.
+  #
+  # @param [String] script the JavaScript to be executed
+  # @return [nil]
+  def execute_script(script)
+    page.execute_script script
+  end
+
+  # Execute JavaScript against the current page and return the results.
+  #
+  # @param [String] script the JavaScript to be executed
+  # @return the result of the JavaScript
+  def evaluate_script(script)
+    page.evaluate_script script
+  end
+
+  # @return the current page
+  def page
+    browser.page
+  end
+
+  # @return the browser
+  def browser
+    @browser ||= Akephalos::Client.new(@options)
+  end
+
+  # @return the session cookies
+  def cookies
+    browser.cookies
+  end
+
+  # @return [String] the current user agent string
+  def user_agent
+    browser.user_agent
+  end
+
+  # Set the User-Agent header for this session. If :default is given, the
+  # User-Agent header will be reset to the default browser's user agent.
+  #
+  # @param [:default] user_agent the default user agent
+  # @param [String] user_agent the user agent string to use
+  def user_agent=(user_agent)
+    browser.user_agent = user_agent
+  end
+
+  # Disable waiting in Capybara, since waiting is handled directly by
+  # Akephalos.
+  #
+  # @return [false]
+  def wait
+    false
+  end
+
+  private
+
+  # @param [String] path
+  # @return [String] the absolute URL for the given path
+  def url(path)
+    rack_server.url(path)
+  end
+
+end
+
+Capybara.register_driver :akephalos do |app|
+  Capybara::Driver::Akephalos.new(app)
+end

data/lib/akephalos/client/cookies.rb

@@ -0,0 +1,73 @@
+module Akephalos
+  class Client
+    # Interface for working with HtmlUnit's CookieManager, providing a basic
+    # API for manipulating the cookies in a session.
+    class Cookies
+      include Enumerable
+
+      # @param [HtmlUnit::CookieManager] cookie manager
+      def initialize(cookie_manager)
+        @cookie_manager = cookie_manager
+      end
+
+      # @param [name] the cookie name
+      # @return [Cookie] the cookie with the given name
+      # @return [nil] when no cookie is found
+      def [](name)
+        cookie = @cookie_manager.getCookie(name)
+        Cookie.new(cookie) if cookie
+      end
+
+      # Clears all cookies for this session.
+      def clear
+        @cookie_manager.clearCookies
+      end
+
+      # Iterator for all cookies in the current session.
+      def each
+        @cookie_manager.getCookies.each do |cookie|
+          yield Cookie.new(cookie)
+        end
+      end
+
+      # Remove the cookie from the session.
+      #
+      # @param [Cookie] the cookie to remove
+      def delete(cookie)
+        @cookie_manager.removeCookie(cookie.native)
+      end
+
+      # @return [true, false] whether there are any cookies
+      def empty?
+        !any?
+      end
+
+      class Cookie
+
+        attr_reader :domain, :expires, :name, :path, :value
+
+        # @param [HtmlUnit::Cookie] the cookie
+        def initialize(cookie)
+          @_cookie = cookie
+          @domain = cookie.getDomain
+          @expires = cookie.getExpires
+          @name = cookie.getName
+          @path = cookie.getPath
+          @value = cookie.getValue
+          @secure = cookie.isSecure
+        end
+
+        def secure?
+          !!@secure
+        end
+
+        # @return [HtmlUnit::Cookie] the native cookie object
+        # @api private
+        def native
+          @_cookie
+        end
+      end
+
+    end
+  end
+end

data/lib/akephalos/client/filter.rb

@@ -0,0 +1,120 @@
+module Akephalos
+  class Client
+
+    # Akephalos::Client::Filter extends HtmlUnit's WebConnectionWrapper to
+    # enable filtering outgoing requests generated interally by HtmlUnit.
+    #
+    # When a request comes through, it will be tested against the filters
+    # defined in Akephalos.filters and return a mock response if a match is
+    # found. If no filters are defined, or no filters match the request, then
+    # the response will bubble up to HtmlUnit for the normal request/response
+    # cycle.
+    class Filter < HtmlUnit::Util::WebConnectionWrapper
+      # Filters an outgoing request, and if a match is found, returns the mock
+      # response.
+      #
+      # @param [WebRequest] request the pending HTTP request
+      # @return [WebResponseImpl] when the request matches a defined filter
+      # @return [nil] when no filters match the request
+      def filter(request)
+        if filter = find_filter(request)
+          start_time = Time.now
+          headers = filter[:headers].map do |name, value|
+            HtmlUnit::Util::NameValuePair.new(name.to_s, value.to_s)
+          end
+          response = HtmlUnit::WebResponseData.new(
+            filter[:body].to_s.to_java_bytes,
+            filter[:status],
+            HTTP_STATUS_CODES.fetch(filter[:status], "Unknown"),
+            headers
+          )
+          HtmlUnit::WebResponseImpl.new(response, request, Time.now - start_time)
+        end
+      end
+
+      # Searches for a filter which matches the request's HTTP method and url.
+      #
+      # @param [WebRequest] request the pending HTTP request
+      # @return [Hash] when a filter matches the request
+      # @return [nil] when no filters match the request
+      def find_filter(request)
+        Akephalos.filters.find do |filter|
+          request.http_method === filter[:method] && request.url.to_s =~ filter[:filter]
+        end
+      end
+
+      # This method is called by WebClient when a page is requested, and will
+      # return a mock response if the request matches a defined filter or else
+      # return the actual response.
+      #
+      # @api htmlunit
+      # @param [WebRequest] request the pending HTTP request
+      # @return [WebResponseImpl]
+      def getResponse(request)
+        filter(request) || super
+      end
+
+      # Map of status codes to their English descriptions.
+      HTTP_STATUS_CODES = {
+        100 => "Continue",
+        101 => "Switching Protocols",
+        102 => "Processing",
+        200 => "OK",
+        201 => "Created",
+        202 => "Accepted",
+        203 => "Non-Authoritative Information",
+        204 => "No Content",
+        205 => "Reset Content",
+        206 => "Partial Content",
+        207 => "Multi-Status",
+        300 => "Multiple Choices",
+        301 => "Moved Permanently",
+        302 => "Found",
+        303 => "See Other",
+        304 => "Not Modified",
+        305 => "Use Proxy",
+        306 => "Switch Proxy",
+        307 => "Temporary Redirect",
+        400 => "Bad Request",
+        401 => "Unauthorized",
+        402 => "Payment Required",
+        403 => "Forbidden",
+        404 => "Not Found",
+        405 => "Method Not Allowed",
+        406 => "Not Acceptable",
+        407 => "Proxy Authentication Required",
+        408 => "Request Timeout",
+        409 => "Conflict",
+        410 => "Gone",
+        411 => "Length Required",
+        412 => "Precondition Failed",
+        413 => "Request Entity Too Large",
+        414 => "Request-URI Too Long",
+        415 => "Unsupported Media Type",
+        416 => "Requested Range Not Satisfiable",
+        417 => "Expectation Failed",
+        418 => "I'm a teapot",
+        421 => "There are too many connections from your internet address",
+        422 => "Unprocessable Entity",
+        423 => "Locked",
+        424 => "Failed Dependency",
+        425 => "Unordered Collection",
+        426 => "Upgrade Required",
+        449 => "Retry With",
+        450 => "Blocked by Windows Parental Controls",
+        500 => "Internal Server Error",
+        501 => "Not Implemented",
+        502 => "Bad Gateway",
+        503 => "Service Unavailable",
+        504 => "Gateway Timeout",
+        505 => "HTTP Version Not Supported",
+        506 => "Variant Also Negotiates",
+        507 => "Insufficient Storage",
+        509 => "Bandwidth Limit Exceeded",
+        510 => "Not Extended",
+        530 => "User access denied"
+      }.freeze
+    end
+
+  end
+end