Class: Akephalos::Client::Filter

Inherits:
HtmlUnit::Util::WebConnectionWrapper
  • Object
show all
Defined in:
lib/akephalos/client/filter.rb

Overview

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.

Constant Summary collapse

HTTP_STATUS_CODES =

Map of status codes to their English descriptions.

{
  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

Instance Method Summary collapse

Instance Method Details

#filter(request) ⇒ WebResponse?

Filters an outgoing request, and if a match is found, returns the mock response.

Parameters:

  • request (WebRequest) —

    the pending HTTP request

Returns:

  • (WebResponse) —

    when the request matches a defined filter

  • (nil) —

    when no filters match the request



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/akephalos/client/filter.rb', line 19

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::WebResponse.new(response, request, Time.now - start_time)
  end
end

#find_filter(request) ⇒ Hash?

Searches for a filter which matches the request’s HTTP method and url.

Parameters:

  • request (WebRequest) —

    the pending HTTP request

Returns:

  • (Hash) —

    when a filter matches the request

  • (nil) —

    when no filters match the request



40
41
42
43
44
 
# File 'lib/akephalos/client/filter.rb', line 40

def find_filter(request)
  Akephalos.filters.find do |filter|
    request.http_method === filter[:method] && request.url.to_s =~ filter[:filter]
  end
end

#getResponse(request) ⇒ WebResponse

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.

Parameters:

  • request (WebRequest) —

    the pending HTTP request

Returns:

  • (WebResponse) 


53
54
55
 
# File 'lib/akephalos/client/filter.rb', line 53

def getResponse(request)
  filter(request) || super
end