aboutsummaryrefslogtreecommitdiffstats
path: root/examples/rest_basic_auth
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-07 16:23:13 +0200
committerLoïc Hoguin <[email protected]>2013-09-07 16:23:13 +0200
commitbb9a2e975e4657d2f03d93b4d9595160e8190566 (patch)
tree75b6f8ae8649dd00e572fa1413970a7ce9cd3574 /examples/rest_basic_auth
parent51ce122858c4dc09f4440269a412a91afb19ebe7 (diff)
downloadcowboy-bb9a2e975e4657d2f03d93b4d9595160e8190566.tar.gz
cowboy-bb9a2e975e4657d2f03d93b4d9595160e8190566.tar.bz2
cowboy-bb9a2e975e4657d2f03d93b4d9595160e8190566.zip
Rename the basic_auth example to rest_basic_auth
Diffstat (limited to 'examples/rest_basic_auth')
-rw-r--r--examples/rest_basic_auth/README.md48
-rw-r--r--examples/rest_basic_auth/src/rest_basic_auth.app.src15
-rw-r--r--examples/rest_basic_auth/src/rest_basic_auth_app.erl25
-rw-r--r--examples/rest_basic_auth/src/rest_basic_auth_sup.erl23
-rw-r--r--examples/rest_basic_auth/src/toppage_handler.erl29
5 files changed, 140 insertions, 0 deletions
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}.