mirror of
https://github.com/edgurgel/httparrot
synced 2025-04-06 00:32:34 -04:00
Add @moduledoc for most handlers
[ci skip]
This commit is contained in:
parent
3dba102498
commit
704b38006d
11 changed files with 40 additions and 0 deletions
|
@ -1,4 +1,7 @@
|
||||||
defmodule HTTParrot.BasicAuthHandler do
|
defmodule HTTParrot.BasicAuthHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Challenges HTTPBasic Auth
|
||||||
|
"""
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.CookiesHandler do
|
defmodule HTTParrot.CookiesHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns cookie data.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.DeleteCookiesHandler do
|
defmodule HTTParrot.DeleteCookiesHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Deletes one or more simple cookies.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
defmodule HTTParrot.DeleteHandler do
|
defmodule HTTParrot.DeleteHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns DELETE data.
|
||||||
|
"""
|
||||||
alias HTTParrot.GeneralRequestInfo
|
alias HTTParrot.GeneralRequestInfo
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
defmodule HTTParrot.GetHandler do
|
defmodule HTTParrot.GetHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns GET data.
|
||||||
|
"""
|
||||||
alias HTTParrot.GeneralRequestInfo
|
alias HTTParrot.GeneralRequestInfo
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
defmodule HTTParrot.HiddenBasicAuthHandler do
|
defmodule HTTParrot.HiddenBasicAuthHandler do
|
||||||
|
@moduledoc """
|
||||||
|
404'd BasicAuth
|
||||||
|
"""
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.IPHandler do
|
defmodule HTTParrot.IPHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns Origin IP
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.RedirectToHandler do
|
defmodule HTTParrot.RedirectToHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Redirects to the foo URL.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.SetCookiesHandler do
|
defmodule HTTParrot.SetCookiesHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Sets one or more simple cookies.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.StatusCodeHandler do
|
defmodule HTTParrot.StatusCodeHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns given HTTP Status code.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
|
@ -1,4 +1,8 @@
|
||||||
defmodule HTTParrot.UserAgentHandler do
|
defmodule HTTParrot.UserAgentHandler do
|
||||||
|
@moduledoc """
|
||||||
|
Returns user-agent.
|
||||||
|
"""
|
||||||
|
|
||||||
def init(_transport, _req, _opts) do
|
def init(_transport, _req, _opts) do
|
||||||
{:upgrade, :protocol, :cowboy_rest}
|
{:upgrade, :protocol, :cowboy_rest}
|
||||||
end
|
end
|
||||||
|
|
Loading…
Add table
Reference in a new issue