Contents

require 'webmachine/header_negotiation'
require 'webmachine/translation'
require 'webmachine/constants'
require 'webmachine/version'

module Webmachine
  extend HeaderNegotiation
  extend Translation

  # Renders a standard error message body for the response. The
  # standard messages are defined in localization files.
  # @param [Fixnum] code the response status code
  # @param [Request] req the request object
  # @param [Response] req the response object
  # @param [Hash] options keys to override the defaults when rendering
  #     the response body
  def self.render_error(code, req, res, options={})
    res.code = code
    unless res.body
      title, message = t(["errors.#{code}.title", "errors.#{code}.message"],
                         { :method => req.method,
                           :error => res.error}.merge(options))
      res.body = t("errors.standard_body",
                   {:title => title,
                     :message => message,
                     :version => Webmachine::SERVER_STRING}.merge(options))
      res.headers[CONTENT_TYPE] = TEXT_HTML
    end
    ensure_content_length(res)
    ensure_date_header(res)
  end


  # Superclass of all errors generated by Webmachine.
  class Error < ::StandardError; end

  # Raised when the resource violates specific constraints on its API.
  class InvalidResource < Error; end

  # Raised when the client has submitted an invalid request, e.g. in
  # the case where a request header is improperly formed. Raising this
  # exception will result in a 400 response.
  class MalformedRequest < Error; end
end # module Webmachine

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
webmachine-1.4.0	lib/webmachine/errors.rb
webmachine-1.3.1	lib/webmachine/errors.rb
webmachine-1.3.0	lib/webmachine/errors.rb