From bb9a2e975e4657d2f03d93b4d9595160e8190566 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 7 Sep 2013 16:23:13 +0200 Subject: Rename the basic_auth example to rest_basic_auth --- examples/README.md | 6 +-- examples/basic_auth/README.md | 48 ---------------------- examples/basic_auth/src/basic_auth.app.src | 15 ------- examples/basic_auth/src/basic_auth_app.erl | 25 ----------- examples/basic_auth/src/basic_auth_sup.erl | 23 ----------- examples/basic_auth/src/toppage_handler.erl | 29 ------------- examples/rest_basic_auth/README.md | 48 ++++++++++++++++++++++ .../rest_basic_auth/src/rest_basic_auth.app.src | 15 +++++++ .../rest_basic_auth/src/rest_basic_auth_app.erl | 25 +++++++++++ .../rest_basic_auth/src/rest_basic_auth_sup.erl | 23 +++++++++++ examples/rest_basic_auth/src/toppage_handler.erl | 29 +++++++++++++ 11 files changed, 143 insertions(+), 143 deletions(-) delete mode 100644 examples/basic_auth/README.md delete mode 100644 examples/basic_auth/src/basic_auth.app.src delete mode 100644 examples/basic_auth/src/basic_auth_app.erl delete mode 100644 examples/basic_auth/src/basic_auth_sup.erl delete mode 100644 examples/basic_auth/src/toppage_handler.erl create mode 100644 examples/rest_basic_auth/README.md create mode 100644 examples/rest_basic_auth/src/rest_basic_auth.app.src create mode 100644 examples/rest_basic_auth/src/rest_basic_auth_app.erl create mode 100644 examples/rest_basic_auth/src/rest_basic_auth_sup.erl create mode 100644 examples/rest_basic_auth/src/toppage_handler.erl diff --git a/examples/README.md b/examples/README.md index 0e20d5f..013313a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,9 +1,6 @@ Cowboy Examples =============== - * [basic_auth](./basic_auth): - basic HTTP authorization with REST - * [chunked_hello_world](./chunked_hello_world): demonstrates chunked data transfer with two one-second delays @@ -34,6 +31,9 @@ Cowboy Examples * [markdown_middleware](./markdown_middleware): static file handler with markdown preprocessor + * [rest_basic_auth](./rest_basic_auth): + basic HTTP authorization with REST + * [rest_hello_world](./rest_hello_world): return the data type that matches the request type (ex: html, text, json) diff --git a/examples/basic_auth/README.md b/examples/basic_auth/README.md deleted file mode 100644 index eea6fd9..0000000 --- a/examples/basic_auth/README.md +++ /dev/null @@ -1,48 +0,0 @@ -Basic authorization example using REST -====================================== - -To try this example, you need GNU `make`, `git` and -[relx](https://github.com/erlware/relx) in your PATH. - -To build the example, run the following command: - -``` bash -$ make -``` - -To start the release in the foreground: - -``` bash -$ ./_rel/bin/hello_world_example console -``` - -Then point your browser at [http://localhost:8080](http://localhost:8080). - -Example output --------------- - -Request with no authentication: - -``` bash -$ curl -i http://localhost:8080 -HTTP/1.1 401 Unauthorized -connection: keep-alive -server: Cowboy -date: Sun, 20 Jan 2013 14:10:27 GMT -content-length: 0 -www-authenticate: Basic realm="cowboy" -``` - -Request with authentication: - -``` bash -$ curl -i -u "Alladin:open sesame" http://localhost:8080 -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Sun, 20 Jan 2013 14:11:12 GMT -content-length: 16 -content-type: text/plain - -Hello, Alladin! -``` diff --git a/examples/basic_auth/src/basic_auth.app.src b/examples/basic_auth/src/basic_auth.app.src deleted file mode 100644 index cbf4ea1..0000000 --- a/examples/basic_auth/src/basic_auth.app.src +++ /dev/null @@ -1,15 +0,0 @@ -%% Feel free to use, reuse and abuse the code in this file. - -{application, basic_auth, [ - {description, "Cowboy Basic HTTP Authorization example."}, - {vsn, "1"}, - {modules, []}, - {registered, []}, - {applications, [ - kernel, - stdlib, - cowboy - ]}, - {mod, {basic_auth_app, []}}, - {env, []} -]}. diff --git a/examples/basic_auth/src/basic_auth_app.erl b/examples/basic_auth/src/basic_auth_app.erl deleted file mode 100644 index 24c766e..0000000 --- a/examples/basic_auth/src/basic_auth_app.erl +++ /dev/null @@ -1,25 +0,0 @@ -%% Feel free to use, reuse and abuse the code in this file. - -%% @private --module(basic_auth_app). --behaviour(application). - -%% API. --export([start/2]). --export([stop/1]). - -%% API. - -start(_Type, _Args) -> - Dispatch = cowboy_router:compile([ - {'_', [ - {"/", toppage_handler, []} - ]} - ]), - {ok, _} = cowboy:start_http(http, 100, [{port, 8080}], [ - {env, [{dispatch, Dispatch}]} - ]), - basic_auth_sup:start_link(). - -stop(_State) -> - ok. diff --git a/examples/basic_auth/src/basic_auth_sup.erl b/examples/basic_auth/src/basic_auth_sup.erl deleted file mode 100644 index 6219b5f..0000000 --- a/examples/basic_auth/src/basic_auth_sup.erl +++ /dev/null @@ -1,23 +0,0 @@ -%% Feel free to use, reuse and abuse the code in this file. - -%% @private --module(basic_auth_sup). --behaviour(supervisor). - -%% API. --export([start_link/0]). - -%% supervisor. --export([init/1]). - -%% API. - --spec start_link() -> {ok, pid()}. -start_link() -> - supervisor:start_link({local, ?MODULE}, ?MODULE, []). - -%% supervisor. - -init([]) -> - Procs = [], - {ok, {{one_for_one, 10, 10}, Procs}}. diff --git a/examples/basic_auth/src/toppage_handler.erl b/examples/basic_auth/src/toppage_handler.erl deleted file mode 100644 index 2914064..0000000 --- a/examples/basic_auth/src/toppage_handler.erl +++ /dev/null @@ -1,29 +0,0 @@ -%% Feel free to use, reuse and abuse the code in this file. - -%% @doc Handler with basic HTTP authorization. --module(toppage_handler). - --export([init/3]). --export([content_types_provided/2]). --export([is_authorized/2]). --export([to_text/2]). - -init(_Transport, _Req, []) -> - {upgrade, protocol, cowboy_rest}. - -is_authorized(Req, State) -> - {ok, Auth, Req1} = cowboy_req:parse_header(<<"authorization">>, Req), - case Auth of - {<<"basic">>, {User = <<"Alladin">>, <<"open sesame">>}} -> - {true, Req1, User}; - _ -> - {{false, <<"Basic realm=\"cowboy\"">>}, Req1, State} - end. - -content_types_provided(Req, State) -> - {[ - {<<"text/plain">>, to_text} - ], Req, State}. - -to_text(Req, User) -> - {<< "Hello, ", User/binary, "!\n" >>, Req, User}. diff --git a/examples/rest_basic_auth/README.md b/examples/rest_basic_auth/README.md new file mode 100644 index 0000000..eea6fd9 --- /dev/null +++ b/examples/rest_basic_auth/README.md @@ -0,0 +1,48 @@ +Basic authorization example using REST +====================================== + +To try this example, you need GNU `make`, `git` and +[relx](https://github.com/erlware/relx) in your PATH. + +To build the example, run the following command: + +``` bash +$ make +``` + +To start the release in the foreground: + +``` bash +$ ./_rel/bin/hello_world_example console +``` + +Then point your browser at [http://localhost:8080](http://localhost:8080). + +Example output +-------------- + +Request with no authentication: + +``` bash +$ curl -i http://localhost:8080 +HTTP/1.1 401 Unauthorized +connection: keep-alive +server: Cowboy +date: Sun, 20 Jan 2013 14:10:27 GMT +content-length: 0 +www-authenticate: Basic realm="cowboy" +``` + +Request with authentication: + +``` bash +$ curl -i -u "Alladin:open sesame" http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Sun, 20 Jan 2013 14:11:12 GMT +content-length: 16 +content-type: text/plain + +Hello, Alladin! +``` diff --git a/examples/rest_basic_auth/src/rest_basic_auth.app.src b/examples/rest_basic_auth/src/rest_basic_auth.app.src new file mode 100644 index 0000000..d715b6a --- /dev/null +++ b/examples/rest_basic_auth/src/rest_basic_auth.app.src @@ -0,0 +1,15 @@ +%% Feel free to use, reuse and abuse the code in this file. + +{application, rest_basic_auth, [ + {description, "Cowboy Basic HTTP Authorization example."}, + {vsn, "1"}, + {modules, []}, + {registered, []}, + {applications, [ + kernel, + stdlib, + cowboy + ]}, + {mod, {rest_basic_auth_app, []}}, + {env, []} +]}. diff --git a/examples/rest_basic_auth/src/rest_basic_auth_app.erl b/examples/rest_basic_auth/src/rest_basic_auth_app.erl new file mode 100644 index 0000000..c19349d --- /dev/null +++ b/examples/rest_basic_auth/src/rest_basic_auth_app.erl @@ -0,0 +1,25 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @private +-module(rest_basic_auth_app). +-behaviour(application). + +%% API. +-export([start/2]). +-export([stop/1]). + +%% API. + +start(_Type, _Args) -> + Dispatch = cowboy_router:compile([ + {'_', [ + {"/", toppage_handler, []} + ]} + ]), + {ok, _} = cowboy:start_http(http, 100, [{port, 8080}], [ + {env, [{dispatch, Dispatch}]} + ]), + rest_basic_auth_sup:start_link(). + +stop(_State) -> + ok. diff --git a/examples/rest_basic_auth/src/rest_basic_auth_sup.erl b/examples/rest_basic_auth/src/rest_basic_auth_sup.erl new file mode 100644 index 0000000..f6ce67c --- /dev/null +++ b/examples/rest_basic_auth/src/rest_basic_auth_sup.erl @@ -0,0 +1,23 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @private +-module(rest_basic_auth_sup). +-behaviour(supervisor). + +%% API. +-export([start_link/0]). + +%% supervisor. +-export([init/1]). + +%% API. + +-spec start_link() -> {ok, pid()}. +start_link() -> + supervisor:start_link({local, ?MODULE}, ?MODULE, []). + +%% supervisor. + +init([]) -> + Procs = [], + {ok, {{one_for_one, 10, 10}, Procs}}. diff --git a/examples/rest_basic_auth/src/toppage_handler.erl b/examples/rest_basic_auth/src/toppage_handler.erl new file mode 100644 index 0000000..2914064 --- /dev/null +++ b/examples/rest_basic_auth/src/toppage_handler.erl @@ -0,0 +1,29 @@ +%% Feel free to use, reuse and abuse the code in this file. + +%% @doc Handler with basic HTTP authorization. +-module(toppage_handler). + +-export([init/3]). +-export([content_types_provided/2]). +-export([is_authorized/2]). +-export([to_text/2]). + +init(_Transport, _Req, []) -> + {upgrade, protocol, cowboy_rest}. + +is_authorized(Req, State) -> + {ok, Auth, Req1} = cowboy_req:parse_header(<<"authorization">>, Req), + case Auth of + {<<"basic">>, {User = <<"Alladin">>, <<"open sesame">>}} -> + {true, Req1, User}; + _ -> + {{false, <<"Basic realm=\"cowboy\"">>}, Req1, State} + end. + +content_types_provided(Req, State) -> + {[ + {<<"text/plain">>, to_text} + ], Req, State}. + +to_text(Req, User) -> + {<< "Hello, ", User/binary, "!\n" >>, Req, User}. -- cgit v1.2.3