aboutsummaryrefslogtreecommitdiffstats
path: root/examples/rest_basic_auth
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
commit394b4f0bf7f2a4d496ffe69c8e30cff153d69532 (patch)
tree82c3d7634f93596ec42b41050b4130805a359359 /examples/rest_basic_auth
parent4023e7f4e429179fd9c2cce4487c33646c6bd327 (diff)
downloadcowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.gz
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.bz2
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.zip
Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
Diffstat (limited to 'examples/rest_basic_auth')
-rw-r--r--examples/rest_basic_auth/README.asciidoc (renamed from examples/rest_basic_auth/README.md)31
-rw-r--r--examples/rest_basic_auth/src/toppage_handler.erl2
2 files changed, 13 insertions, 20 deletions
diff --git a/examples/rest_basic_auth/README.md b/examples/rest_basic_auth/README.asciidoc
index 236ce2f..04609b3 100644
--- a/examples/rest_basic_auth/README.md
+++ b/examples/rest_basic_auth/README.asciidoc
@@ -1,28 +1,20 @@
-Basic authorization example using REST
-======================================
+= Basic authorization example using REST
To try this example, you need GNU `make` and `git` in your PATH.
-To build the example, run the following command:
+To build and run the example, use the following command:
-``` bash
-$ make
-```
+[source,bash]
+$ make run
-To start the release in the foreground:
+Then point your browser to http://localhost:8080
-``` bash
-$ ./_rel/rest_basic_auth_example/bin/rest_basic_auth_example console
-```
-
-Then point your browser at [http://localhost:8080](http://localhost:8080).
-
-Example output
---------------
+== Example output
Request with no authentication:
-``` bash
+[source,bash]
+----
$ curl -i http://localhost:8080
HTTP/1.1 401 Unauthorized
connection: keep-alive
@@ -30,11 +22,12 @@ server: Cowboy
date: Sun, 20 Jan 2013 14:10:27 GMT
content-length: 0
www-authenticate: Basic realm="cowboy"
-```
+----
Request with authentication:
-``` bash
+[source,bash]
+----
$ curl -i -u "Alladin:open sesame" http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -44,4 +37,4 @@ content-length: 16
content-type: text/plain
Hello, Alladin!
-```
+----
diff --git a/examples/rest_basic_auth/src/toppage_handler.erl b/examples/rest_basic_auth/src/toppage_handler.erl
index 18a8cae..2e8250f 100644
--- a/examples/rest_basic_auth/src/toppage_handler.erl
+++ b/examples/rest_basic_auth/src/toppage_handler.erl
@@ -13,7 +13,7 @@ init(Req, Opts) ->
is_authorized(Req, State) ->
case cowboy_req:parse_header(<<"authorization">>, Req) of
- {<<"basic">>, {User = <<"Alladin">>, <<"open sesame">>}} ->
+ {basic, User = <<"Alladin">>, <<"open sesame">>} ->
{true, Req, User};
_ ->
{{false, <<"Basic realm=\"cowboy\"">>}, Req, State}