Top Level Namespace

Defined in:

Constant Summary

CONTENT_FOR_BLOCKS = Hash(String, Tuple(String, Proc(Nil))).new

FILTER_METHODS = ["get", "post", "put", "patch", "delete", "options", "all"] of ::String

HTTP_METHODS = ["get", "post", "put", "patch", "delete", "options"] of ::String

Kemal DSL is defined here and it's baked into global scope.

The DSL currently consists of:

• get post put patch delete options
• WebSocket(ws)
• before_*
• error

Method Summary

• add_handler(handler : HTTP::Handler, position : Int32)
• add_handler(handler : HTTP::Handler)

  Adds given Kemal::Handler to handlers chain.

• after_all(path : String = "*", &block : HTTP::Server::Context -> _)
• after_all(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_delete(path : String = "*", &block : HTTP::Server::Context -> _)
• after_delete(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_get(path : String = "*", &block : HTTP::Server::Context -> _)
• after_get(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_options(path : String = "*", &block : HTTP::Server::Context -> _)
• after_options(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_patch(path : String = "*", &block : HTTP::Server::Context -> _)
• after_patch(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_post(path : String = "*", &block : HTTP::Server::Context -> _)
• after_post(paths : Array(String), &block : HTTP::Server::Context -> _)
• after_put(path : String = "*", &block : HTTP::Server::Context -> _)
• after_put(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_all(path : String = "*", &block : HTTP::Server::Context -> _)
• before_all(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_delete(path : String = "*", &block : HTTP::Server::Context -> _)
• before_delete(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_get(path : String = "*", &block : HTTP::Server::Context -> _)
• before_get(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_options(path : String = "*", &block : HTTP::Server::Context -> _)
• before_options(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_patch(path : String = "*", &block : HTTP::Server::Context -> _)
• before_patch(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_post(path : String = "*", &block : HTTP::Server::Context -> _)
• before_post(paths : Array(String), &block : HTTP::Server::Context -> _)
• before_put(path : String = "*", &block : HTTP::Server::Context -> _)
• before_put(paths : Array(String), &block : HTTP::Server::Context -> _)
• delete(path : String, &block : HTTP::Server::Context -> _)
• error(status_code : Int32, &block : HTTP::Server::Context, Exception -> _)
• get(path : String, &block : HTTP::Server::Context -> _)
• gzip(status : Bool = false)

  Configures an HTTP::Server::Response to compress the response output, either using gzip or deflate, depending on the Accept-Encoding request header.

• headers(env : HTTP::Server::Context, additional_headers : Hash(String, String))

  Helper for easily modifying response headers.

• log(message : String)

  Logs the output via logger.

• logger(logger : Kemal::BaseLogHandler)

  This is used to replace the built-in Kemal::LogHandler with a custom logger.

• logging(status : Bool)

  Enables / Disables logging.

• options(path : String, &block : HTTP::Server::Context -> _)
• patch(path : String, &block : HTTP::Server::Context -> _)
• post(path : String, &block : HTTP::Server::Context -> _)
• public_folder(path : String)

  Sets public folder from which the static assets will be served.

• put(path : String, &block : HTTP::Server::Context -> _)
• render_404
• render_500(context, exception, verbosity)
• send_file(env : HTTP::Server::Context, path : String, mime_type : String | Nil = nil, *, filename : String | Nil = nil, disposition : String | Nil = nil)

  Send a file with given path and base the mime-type on the file extension or default application/octet-stream mime_type.

• send_file(env : HTTP::Server::Context, data : Slice(UInt8), mime_type : String | Nil = nil, *, filename : String | Nil = nil, disposition : String | Nil = nil)

  Send a file with given data and default application/octet-stream mime_type.

• serve_static(status : Bool | Hash)

  Enables / Disables static file serving.

• static_headers(&headers : HTTP::Server::Context, String, File::Info -> Void)

  Adds headers to Kemal::StaticFileHandler.

• ws(path : String, &block : HTTP::WebSocket, HTTP::Server::Context -> Void)

Macro Summary

• add_context_storage_type(type)

  Extends context storage with user defined types.

• content_for(key, file = __FILE__)

  content_for is a set of helpers that allows you to capture blocks inside views to be rendered later during the request.

• halt(env, status_code = 200, response = "")

  Halt execution with the current context.

• render(filename, layout)

  Render view with a layout as the superview.

• render(filename)

  Render view with the given filename.

• yield_content(key)

  Yields content for the given key if a content_for block exists for that key.

Method Detail

def call(env)
  headers(env, {"X-Custom-Header" => "This is a custom value"})
end

class MyCustomLogger < Kemal::BaseLogHandler
  def call(context)
    puts "I'm logging some custom stuff here."
    call_next(context) # => This calls the next handler
  end

  # This is used from `log` method.
  def write(message)
    STDERR.puts message # => Logs the output to STDERR
  end
end

logger MyCustomLogger.new

logging false

send_file env, "./path/to/file"

send_file env, "./path/to/file", "image/jpeg"

send_file env, "./path/to/file", filename: "image.jpg", disposition: "attachment"

send_file env, data_slice

send_file env, data_slice, "image/jpeg"

send_file env, data_slice, filename: "image.jpg", disposition: "attachment"

serve_static false

serve_static {"gzip" => true, "dir_listing" => false}

static_headers do |env, filepath, filestat|
  if filepath =~ /\.html$/
    env.response.headers.add("Access-Control-Allow-Origin", "*")
  end
  env.response.headers.add("Content-Size", filestat.size.to_s)
end

Macro Detail

class User
  property name
end

add_context_storage_type(User)

# index.ecr
<% content_for "some_key" do %>
  <chunk of="html">...</chunk>
<% end %>

# layout.ecr
<%= yield_content "some_key" %>

halt env, status_code: 403, response: "Forbidden"

render "src/views/index.ecr", "src/views/layout.ecr"