1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
require "json"
require "./handler"
private macro define_method_calls(hash)
case namespace
{% for namespace, methods in hash %}
when "{{ namespace.id }}"
case method
{% for method in methods %}
when "{{ method }}"
do_{{ namespace.id }}_{{ method }}(context, get_method_args(
context.request.query_params,
"{{ namespace.id }}",
"{{ method.id }}"
))
{% end %}
else
raise "unknown method"
end
{% end %}
else
raise "unknown namespace"
end
end
module Guff
class APIHandler < Handler
API = {
"post": {
"get_posts": {
text: "Get posts matching query.",
args: {
"q": {
text: "Search string.",
type: :text,
required: false,
default: "",
},
"page": {
text: "Page number",
type: :int,
required: false,
default: "1",
},
"tags": {
text: "Comma-separated list of tags (union)",
type: :tags,
required: false,
default: "1",
},
"sort": {
text: "Sort order of results",
type: :sort,
required: false,
default: "date,desc",
},
},
},
},
"test": {
"version": {
text: "Get version",
},
"get_posts": {
text: "Test get posts",
},
"error": {
text: "Test error response",
},
}
}
TYPE_CHECKS = {
text: /.*/,
int: /^\d+$/,
tags: /^[a-z0-9_,-]+$/,
sort: /^[a-z0-9_]+,(?:asc|desc)$/,
}
PATH_RE = %r{
^/api
(?:
# method call
(?:
/
(?<namespace>[a-z0-9_-]+)
/
(?<method>[a-z0-9_]+)
)
|
# index.html
/(?:index(?:\.html|)|)
|
# implicit index (no trailing slash)
)
$
}mx
CONTENT_TYPES = {
"development": "text/html; charset=utf-8",
"production": "application/json; charset=utf8",
}
private def get_content_type
CONTENT_TYPES[@model.config["environment"]]
end
private def get_method_args(
params : HTTP::Params,
namespace : String,
method : String
)
return {} of String => String unless (
API[namespace]? &&
API[namespace][method] &&
API[namespace][method][:args]?
)
# get method args
args = API[namespace][method][:args] as \
Hash(String, Hash(Symbol, String | Symbol | Bool))
args.keys.reduce({} of String => String) do |r, arg_name|
arg_data = args[arg_name] as Hash(Symbol, String|Symbol|Bool)
# check for required parameter
if arg_data[:required] && !params.has_key?(arg_name)
raise "missing required parameter: %s" % [arg_name]
end
# get value
val = params.fetch(arg_name, arg_data[:default] as String)
# check value
if !TYPE_CHECKS[arg_data[:type]].match(val)
raise "invalid parameter format: %s" % [arg_name]
end
# add value to result
r[arg_name] = val
# return result
r
end
end
def call(context : HTTP::Server::Context)
if md = (context.request.path || "").match(PATH_RE)
if md["namespace"]?
# method call
do_call(context, md["namespace"], md["method"])
else
# api index
do_docs(context)
end
else
call_next(context)
end
end
private def do_call(
context : HTTP::Server::Context,
namespace : String,
method : String
)
context.response.content_type = get_content_type
# method call
json = begin
# equivalent to send("do_#{namespace}_#{method}".intern, context)
define_method_calls({
post: [
get_posts,
],
test: [
version,
get_posts,
error,
],
})
rescue e
{ "error": e.to_s }.to_json
end
# send body
context.response.puts json
end
private def do_docs(context : HTTP::Server::Context)
page = HTMLPageView.new(
"API Documentation",
"<p>API Documentation</p>"
)
context.response.content_type = page.content_type
context.response.puts page
end
################
# post methods #
################
private def do_post_get_posts(
context : HTTP::Server::Context,
args : Hash(String, String)
)
[{foo: "bar"}, {foo: "asdf"}].to_json
end
################
# test methods #
################
private def do_test_version(
context : HTTP::Server::Context,
args : Hash(String, String)
)
{version: Guff::VERSION}.to_json
end
private def do_test_get_posts(
context : HTTP::Server::Context,
args : Hash(String, String)
)
[{foo: "bar"}, {foo: "asdf"}].to_json
end
private def do_test_error(
context : HTTP::Server::Context,
args : Hash(String, String)
)
raise "some random error"
end
end
end
|
