Exception: Sidewalk::HttpError

Inherits:

RuntimeError

• Object
• RuntimeError
• Sidewalk::HttpError

Defined in:

lib/sidewalk/errors.rb

Overview

Base class for HTTP errors.

This is raised by controllers.

Direct Known Subclasses

ForbiddenError, NotAuthorizedError, NotFoundError, Redirect

Instance Method Summary

• #description(request) ⇒ String

  The description to return in response to the request.

• #initialize(status, description) ⇒ HttpError constructor

  Initialize an Error exception.

• #status(request) ⇒ Fixnum

  The status code to return in response to the request.

Constructor Details

#initialize(status, description) ⇒ HttpError

Initialize an Error exception.

If the parameters are nil, you will need to override #status and #description for this class to work as expected.

Parameters:

• status (Fixnum, nil) —

  is the numeric status code

• description (String, nil) —

  is a short description like ‘Not Found’

# File 'lib/sidewalk/errors.rb', line 14

def initialize status, description
  @status, @description = status, description
end

Instance Method Details

#description(request) ⇒ String

The description to return in response to the request.

It takes a request to allow different responses to be given to, for example, HTTP/1.0 clients vs HTTP/1.1 clients.

Parameters:

• request (Request) —

  is an object representing the current HTTP request

Returns:

• (String) —

  a text description of the code, like ‘Not Found’

# File 'lib/sidewalk/errors.rb', line 38

def description request
  @description
end

#status(request) ⇒ Fixnum

The status code to return in response to the request.

It takes a request to allow different responses to be given to, for example, HTTP/1.0 clients vs HTTP/1.1 clients.

Parameters:

• request (Request) —

  is an object representing the current HTTP request

Returns:

• (Fixnum) —

  a numeric HTTP status code.

# File 'lib/sidewalk/errors.rb', line 26

def status request
  @status
end