aboutsummaryrefslogtreecommitdiffstats
path: root/src/cowboy_constraints.erl
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-09-23 16:43:29 +0300
committerLoïc Hoguin <[email protected]>2014-09-23 16:43:29 +0300
commitf1c3b6d76f0c97e1ab927c288bb94891ae4c253b (patch)
tree5a14c007cdcb487032162b3ca96df648f521321a /src/cowboy_constraints.erl
parentb57f94661f5fd186f55eb0fead49849e0b1399d1 (diff)
downloadcowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.gz
cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.bz2
cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.zip
Breaking update of the cowboy_req interface
Simplify the interface for most cowboy_req functions. They all return a single value except the four body reading functions. The reply functions now only return a Req value. Access functions do not return a Req anymore. Functions that used to cache results do not have a cache anymore. The interface for accessing query string and cookies has therefore been changed. There are now three query string functions: qs/1 provides access to the raw query string value; parse_qs/1 returns the query string as a list of key/values; match_qs/2 returns a map containing the values requested in the second argument, after applying constraints and default value. Similarly, there are two cookie functions: parse_cookies/1 and match_cookies/2. More match functions will be added in future commits. None of the functions return an error tuple anymore. It either works or crashes. Cowboy will attempt to provide an appropriate status code in the response of crashed handlers. As a result, the content decode function has its return value changed to a simple binary, and the body reading functions only return on success.
Diffstat (limited to 'src/cowboy_constraints.erl')
-rw-r--r--src/cowboy_constraints.erl60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/cowboy_constraints.erl b/src/cowboy_constraints.erl
new file mode 100644
index 0000000..9a379e1
--- /dev/null
+++ b/src/cowboy_constraints.erl
@@ -0,0 +1,60 @@
+%% Copyright (c) 2014, Loïc Hoguin <[email protected]>
+%%
+%% Permission to use, copy, modify, and/or distribute this software for any
+%% purpose with or without fee is hereby granted, provided that the above
+%% copyright notice and this permission notice appear in all copies.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+-module(cowboy_constraints).
+
+-export([validate/2]).
+
+-type constraint() :: int | nonempty | fun().
+-export_type([constraint/0]).
+
+-spec validate(binary(), [constraint()]) -> true | {true, any()} | false.
+validate(Value, [Constraint]) ->
+ apply_constraint(Value, Constraint);
+validate(Value, Constraints) when is_list(Constraints) ->
+ validate_list(Value, Constraints, original);
+validate(Value, Constraint) ->
+ apply_constraint(Value, Constraint).
+
+validate_list(_, [], original) ->
+ true;
+validate_list(Value, [], modified) ->
+ {true, Value};
+validate_list(Value, [Constraint|Tail], State) ->
+ case apply_constraint(Value, Constraint) of
+ true ->
+ validate_list(Value, Tail, State);
+ {true, Value2} ->
+ validate_list(Value2, Tail, modified);
+ false ->
+ false
+ end.
+
+%% @todo {int, From, To}, etc.
+apply_constraint(Value, int) ->
+ int(Value);
+apply_constraint(Value, nonempty) ->
+ nonempty(Value);
+apply_constraint(Value, F) when is_function(F) ->
+ F(Value).
+
+%% Constraint functions.
+
+int(Value) when is_binary(Value) ->
+ try {true, list_to_integer(binary_to_list(Value))}
+ catch _:_ -> false
+ end.
+
+nonempty(<<>>) -> false;
+nonempty(Value) when is_binary(Value) -> true.