- Crystal 0.25.0 support 🎉
- Add
Kemal::Context.get?
to safely access context storage 😎 - [Security] Don't serve 404 image dynamically 👍
- Disable
X-Powered-By
header #449. Thanks @Blacksmoke16 🙏
- Crystal 0.24.1 support 🎉
- Only return string from route.#408 thanks @crisward 🙏
- Don't crash on empty path when compiled in --release. #407 thanks @crisward 🙏
- Rename
Kemal::CommonLogHandler
toKemal::LogHandler
andKemal::CommonExceptionHandler
toKemal::ExceptionHandler
. - Allow videos to be opened with correct mime type. #406 thanks @crisward 🙏
- Add webm mime type.#413 thanks @reindeer-cafe 🙏
- Dynamically insert handlers 💪 Fixes #376.
- Add context to WebSocket. This allows one to use
HTTP::Server::Context
inws
declarations 😍 Fixes #349.
ws "/:room_name" do |socket, env|
env.params.url["room_name"]
end
- Add support for customizing the headers of built-in
Kemal::StaticFileHandler
🔨 Useful for supportingCORS
for single page applications 👏
static_headers do |response, filepath, filestat|
if filepath =~ /\.html$/
response.headers.add("Access-Control-Allow-Origin", "*")
end
response.headers.add("Content-Size", filestat.size.to_s)
end
end
-
Allow %w in Handler macros #385. Thanks @will 🙏
-
Security: X-Content-Type-Options: nosniff for static files. Fixes #379. Thanks @crisward 🙏
-
Performance: Remove tempfile management to OS. This brings %10 - 15 performance boost to Kemal 🚀
- Crystal 0.23.0 support! As always, Kemal is compatible with the latest major release of Crystal 💎
- Great news everyone 🎉 All handlers are now completely customizable!. Use the default
Kemal
handlers or go wild, it's all up to you ⛏
# Don't forget to add `Kemal::RouteHandler::INSTANCE` or your routes won't work!
Kemal.config.handlers = [Kemal::InitHandler.new, YourHandler.new, Kemal::RouteHandler::INSTANCE]
You can also insert a handler into a specific position.
# This adds MyCustomHandler instance to 1 position. Be aware that the index starts from 0.
add_handler MyCustomHandler.new, 1
- Updated Kilt to v0.4.0.
- Make
Route
aStruct
. This improves the performance of route declarations.
- Return no body for head route fixes #323. (thanks @crisward)
- Update
radix
to0.3.8
. (thanks @waghanza) - User defined context store types. (thanks @neovitange)
class User
property name
end
add_context_storage_type(User)
- Prevent `send_file returning filesize. (thanks @crisward)
- Dont call setup in
config#add_filter_handler
fixes #338.
- Remove
Gzip::Header
monkey patch since it's fixed inCrystal 0.21.1
.
- Fix Gzip in Kemal Seems broken for static files. This was caused by
Gzip::Writer
inCrystal 0.21.0
and currently mitigated by monkey patchingGzip::Header
.
- Crystal 0.21.0 support
- Drop
multipart.cr
dependency.multipart
support is now built-into Crystal <3 - Since Crystal 0.21.0 comes built-in with
multipart
there are some improvements and deprecations.
meta
has been removed from FileUpload
and it has the following properties
tmpfile
: This is temporary file for file upload. Useful for saving the upload file.filename
: File name of the file upload. (logo.png, images.zip e.g)headers
: Headers for the file upload.creation_time
: Creation time of the file upload.modification_time
: Last Modification time of the file upload.read_time
: Read time of the file upload.size
: Size of the file upload.
- Simpler file upload. File uploads can now be access from
HTTP::Server::Context
likeenv.params.files["filename"]
.
env.params.files["filename"]
has 5 methods
tmpfile
: This is temporary file for file upload. Useful for saving the upload file.tmpfile_path
: File path oftmpfile
.filename
: File name of the file upload. (logo.png, images.zip e.g)meta
: Meta information for the file upload.headers
: Headers for the file upload.
Here's a fully working sample for reading a image file upload image1
and saving it under public/uploads
.
post "/upload" do |env|
file = env.params.files["image1"].tmpfile
file_path = ::File.join [Kemal.config.public_folder, "uploads/", file.filename]
File.open(file_path, "w") do |f|
IO.copy(file, f)
end
"Upload ok"
end
To test
curl -F "image1=@/Users/serdar/Downloads/kemal.png" http://localhost:3000/upload
-
RF7233 support a.k.a file streaming. (kemalcr#299) (thanks @denysvitali)
-
Update Radix to 0.3.7. Fixes kemalcr#293
-
Configurable startup / shutdown logging. kemalcr#291 and kemalcr#292 (thanks @twisterghost).
- Update multipart.cr to 0.1.2. Fixes #285 related to multipart.cr
- Support for Crystal 0.20.3
- Add
Kemal.stop
. Fixes #269. HTTP::Handler
is not a class anymore, it's a module. See https://github.com/crystal-lang/crystal/releases/tag/0.20.3
- Handle missing 404 image. Fixes #263
- Remove basic auth middleware from core and move to kemalcr/kemal-basic-auth.
- Use body.gets_to_end for parse_json. Fixes #260.
- Update Radix to 0.3.5 and lock pessimistically. (thanks @luislavena)
- Treat
HTTP::Request
body as anIO
. Fixes #257
- Reimplemented Request middleware / filter routing.
Now all requests will first go through the Middleware stack then Filters (before_*) and will finally reach the matching route.
Which is illustrated as,
Request -> Middleware -> Filter -> Route
- Rename
return_with
ashalt
. - Route declaration must start with
/
. Fixes #242 - Set default exception Content-Type to text/html. Fixes #202
- Add
only
andexclude
paths forKemal::Handler
. This change requires that all handlers must inherit fromKemal::Handler
.
For example this handler will only work on /
path. By default the HTTP method is GET
.
class OnlyHandler < Kemal::Handler
only ["/"]
def call(env)
return call_next(env) unless only_match?(env)
puts "If the path is / i will be doing some processing here."
end
end
The handlers using exclude
will work on the paths that isn't specified. For example this handler will work on any routes other than /
.
class ExcludeHandler < Kemal::Handler
exclude ["/"]
def call(env)
return call_next(env) unless only_match?(env)
puts "If the path is NOT / i will be doing some processing here."
end
end
- Close response on
halt
. (thanks @samueleaton). - Update
Radix
tov0.3.4
. error
handler now also yields error. For example you can get the error mesasage like
error 500 do |env, err|
err.message
end
- Update
multipart.cr
tov0.1.1
- Improved Multipart support with more info on parsed files.
parse_multipart(env)
now yields anUploadFile
object which has the following propertiesfield
,data
,meta
,`headers.
post "/upload" do |env|
parse_multipart(env) do |f|
image1 = f.data if f.field == "image1"
image2 = f.data if f.field == "image2"
puts f.meta
puts f.headers
"Upload complete"
end
end
- Multipart support <3 (thanks @RX14). Now you can handle file uploads.
post "/upload" do |env|
parse_multipart(env) do |field, data|
image1 = data if field == "image1"
image2 = data if field == "image2"
"Upload complete"
end
end
- Make session configurable. Now you can specify session name and expire time wit
Kemal.config.session["name"] = "your_app"
Kemal.config.session["expire_time"] = 48.hours
- Session now supports more types. (String, Int32, Float64, Bool)
- Add
gzip
helper to enable / disable gzip compression on responses. - Static file caching with etag and gzip (thanks @crisward)
Kemal.run
now accepts port to listen.
- Don't forget to call_next on NullLogHandler
- Add context store
KEMAL_ENV
respects toKemal.config.env
and needs to be explicitly set.Kemal::InitHandler
is introduced. Adds initial configuration, headers likeX-Powered-By
.- Add
send_file
to helpers. - Add mime types.
- Fix parsing JSON params when "charset" is present in "Content-Type" header.
- Use http-only cookie for session
- Inject STDOUT by default in CommonLogHandler