aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2012-07-22 04:46:05 +0200
committerLoïc Hoguin <[email protected]>2012-07-22 05:09:56 +0200
commitf212cafad20c498c927c85a39881a5b771727826 (patch)
treeb5ef502a21c245594faa45eefe759a0cd1331ef0 /examples
parent6ea32d605d45971b54a20b181600a94ff1e0592d (diff)
downloadcowboy-f212cafad20c498c927c85a39881a5b771727826.tar.gz
cowboy-f212cafad20c498c927c85a39881a5b771727826.tar.bz2
cowboy-f212cafad20c498c927c85a39881a5b771727826.zip
Add a REST Hello World example
Diffstat (limited to 'examples')
-rw-r--r--examples/rest_hello_world/README.md16
-rw-r--r--examples/rest_hello_world/rebar.config4
-rw-r--r--examples/rest_hello_world/src/rest_hello_world.app.src15
-rw-r--r--examples/rest_hello_world/src/rest_hello_world.erl12
-rw-r--r--examples/rest_hello_world/src/rest_hello_world_app.erl26
-rw-r--r--examples/rest_hello_world/src/rest_hello_world_sup.erl23
-rw-r--r--examples/rest_hello_world/src/toppage_handler.erl39
-rwxr-xr-xexamples/rest_hello_world/start.sh6
8 files changed, 141 insertions, 0 deletions
diff --git a/examples/rest_hello_world/README.md b/examples/rest_hello_world/README.md
new file mode 100644
index 0000000..6b62bd7
--- /dev/null
+++ b/examples/rest_hello_world/README.md
@@ -0,0 +1,16 @@
+Cowboy Hello World
+==================
+
+To compile this example you need rebar in your PATH.
+
+Type the following command:
+```
+$ rebar get-deps compile
+```
+
+You can then start the Erlang node with the following command:
+```
+./start.sh
+```
+
+Then run any given command or point your browser to the indicated URL.
diff --git a/examples/rest_hello_world/rebar.config b/examples/rest_hello_world/rebar.config
new file mode 100644
index 0000000..6ad3062
--- /dev/null
+++ b/examples/rest_hello_world/rebar.config
@@ -0,0 +1,4 @@
+{deps, [
+ {cowboy, ".*",
+ {git, "git://github.com/extend/cowboy.git", "master"}}
+]}.
diff --git a/examples/rest_hello_world/src/rest_hello_world.app.src b/examples/rest_hello_world/src/rest_hello_world.app.src
new file mode 100644
index 0000000..81446bd
--- /dev/null
+++ b/examples/rest_hello_world/src/rest_hello_world.app.src
@@ -0,0 +1,15 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+{application, rest_hello_world, [
+ {description, "Cowboy REST Hello World example."},
+ {vsn, "1"},
+ {modules, []},
+ {registered, []},
+ {applications, [
+ kernel,
+ stdlib,
+ cowboy
+ ]},
+ {mod, {rest_hello_world_app, []}},
+ {env, []}
+]}.
diff --git a/examples/rest_hello_world/src/rest_hello_world.erl b/examples/rest_hello_world/src/rest_hello_world.erl
new file mode 100644
index 0000000..7a63e41
--- /dev/null
+++ b/examples/rest_hello_world/src/rest_hello_world.erl
@@ -0,0 +1,12 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+-module(rest_hello_world).
+
+%% API.
+-export([start/0]).
+
+%% API.
+
+start() ->
+ ok = application:start(cowboy),
+ ok = application:start(rest_hello_world).
diff --git a/examples/rest_hello_world/src/rest_hello_world_app.erl b/examples/rest_hello_world/src/rest_hello_world_app.erl
new file mode 100644
index 0000000..01560f0
--- /dev/null
+++ b/examples/rest_hello_world/src/rest_hello_world_app.erl
@@ -0,0 +1,26 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @private
+-module(rest_hello_world_app).
+-behaviour(application).
+
+%% API.
+-export([start/2]).
+-export([stop/1]).
+
+%% API.
+
+start(_Type, _Args) ->
+ Dispatch = [
+ {'_', [
+ {[], toppage_handler, []}
+ ]}
+ ],
+ {ok, _} = cowboy:start_listener(http, 100,
+ cowboy_tcp_transport, [{port, 8080}],
+ cowboy_http_protocol, [{dispatch, Dispatch}]
+ ),
+ rest_hello_world_sup:start_link().
+
+stop(_State) ->
+ ok.
diff --git a/examples/rest_hello_world/src/rest_hello_world_sup.erl b/examples/rest_hello_world/src/rest_hello_world_sup.erl
new file mode 100644
index 0000000..3c0cecc
--- /dev/null
+++ b/examples/rest_hello_world/src/rest_hello_world_sup.erl
@@ -0,0 +1,23 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @private
+-module(rest_hello_world_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_hello_world/src/toppage_handler.erl b/examples/rest_hello_world/src/toppage_handler.erl
new file mode 100644
index 0000000..8ee1904
--- /dev/null
+++ b/examples/rest_hello_world/src/toppage_handler.erl
@@ -0,0 +1,39 @@
+%% Feel free to use, reuse and abuse the code in this file.
+
+%% @doc Hello world handler.
+-module(toppage_handler).
+
+-export([init/3]).
+-export([content_types_provided/2]).
+-export([hello_to_html/2]).
+-export([hello_to_json/2]).
+-export([hello_to_text/2]).
+
+init(_Transport, _Req, []) ->
+ {upgrade, protocol, cowboy_http_rest}.
+
+content_types_provided(Req, State) ->
+ {[
+ {<<"text/html">>, hello_to_html},
+ {<<"application/json">>, hello_to_json},
+ {<<"text/plain">>, hello_to_text}
+ ], Req, State}.
+
+hello_to_html(Req, State) ->
+ Body = <<"<html>
+<head>
+ <meta charset=\"utf-8\">
+ <title>REST Hello World!</title>
+</head>
+<body>
+ <p>REST Hello World as HTML!</p>
+</body>
+</html>">>,
+ {Body, Req, State}.
+
+hello_to_json(Req, State) ->
+ Body = <<"{\"rest\": \"Hello World!\"}">>,
+ {Body, Req, State}.
+
+hello_to_text(Req, State) ->
+ {<<"REST Hello World as text!">>, Req, State}.
diff --git a/examples/rest_hello_world/start.sh b/examples/rest_hello_world/start.sh
new file mode 100755
index 0000000..0533474
--- /dev/null
+++ b/examples/rest_hello_world/start.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+erl -pa ebin deps/*/ebin -s rest_hello_world \
+ -eval "io:format(\"Get HTML: curl -i http://localhost:8080~n\")." \
+ -eval "io:format(\"Get JSON: curl -i -H \\\"Accept: application/json\\\" http://localhost:8080~n\")." \
+ -eval "io:format(\"Get text: curl -i -H \\\"Accept: text/plain\\\" http://localhost:8080~n\")." \
+ -eval "io:format(\"Get a 406: curl -i -H \\\"Accept: text/css\\\" http://localhost:8080~n\")."