-
Notifications
You must be signed in to change notification settings - Fork 0
/
01.html
319 lines (287 loc) · 14.8 KB
/
01.html
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<title>Try Unfiltered · Unfiltered</title>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content='website'/>
<link href="https://fonts.googleapis.com/css?family=Roboto:100normal,100italic,300normal,300italic,400normal,400italic,500normal,500italic,700normal,700italic,900normal,900italicc" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="lib/jquery/jquery.min.js"></script>
<script type="text/javascript" src="js/page.js"></script>
<script type="text/javascript" src="js/warnOldVersion.js"></script>
<script type="text/javascript" src="js/groups.js"></script>
<script type="text/javascript" src="js/snippets.js"></script>
<link rel="stylesheet" type="text/css" href="lib/foundation/dist/foundation.min.css"/>
<link rel="stylesheet" type="text/css" href="css/page.css"/>
<!--
<link rel="shortcut icon" href="images/favicon.ico" />
-->
</head>
<body>
<div class="off-canvas-wrapper">
<div class="off-canvas-wrapper-inner" data-off-canvas-wrapper>
<div class="off-canvas position-left" id="off-canvas-menu" data-off-canvas>
<nav class="off-canvas-nav">
<div class="nav-home">
<a href="index.html" >
<span class="home-icon">⌂</span>Unfiltered
</a>
<div class="version-number">
0.12.0
</div>
</div>
<div class="nav-toc">
<ul>
<li><a href="01.html" class="active page">Try Unfiltered</a></li>
<li><a href="02.html" class="page">Plans and Intents</a></li>
<li><a href="03.html" class="page">Bindings and Servers</a></li>
<li><a href="04.html" class="page">Project Setup</a></li>
<li><a href="05.html" class="page">Community</a></li>
<li><a href="06/00.html" class="page">Matching and Responding</a>
<ul>
<li><a href="06/a.html" class="page">Request Matchers</a></li>
<li><a href="06/b.html" class="page">Within the Parameters</a></li>
<li><a href="06/c.html" class="page">Response Functions</a></li>
<li><a href="06/d.html" class="page">Silly Store</a></li>
</ul></li>
<li><a href="07/00.html" class="page">Directives and Validation</a>
<ul>
<li><a href="07/a.html" class="page">Directive Intent</a></li>
<li><a href="07/b.html" class="page">Parameters as Directives</a></li>
<li><a href="07/c.html" class="page">Interpreter Reuse and Implicits</a></li>
<li><a href="07/d.html" class="page">Required Parameters</a></li>
<li><a href="07/e.html" class="page">Independent Failure</a></li>
<li><a href="07/f.html" class="page">Interpreters of Your Own Design</a></li>
<li><a href="07/g.html" class="page">Let’s wrap this up, Ada</a></li>
</ul></li>
<li><a href="08/00.html" class="page">Application Structure</a>
<ul>
<li><a href="08/a.html" class="page">Planning for Any-thing</a></li>
<li><a href="08/b.html" class="page">Just Kitting</a></li>
</ul></li>
<li><a href="09/00.html" class="page">Identification and Cookies</a>
<ul>
<li><a href="09/a.html" class="page">Who’s Who</a></li>
<li><a href="09/b.html" class="page">Remembrance of Things Past</a></li>
</ul></li>
<li><a href="10/00.html" class="page">Netty Plans</a>
<ul>
<li><a href="10/a.html" class="page">Trying Netty</a></li>
<li><a href="10/b.html" class="page">Execution and Exceptions</a></li>
<li><a href="10/c.html" class="page">Chunked Requests</a></li>
<li><a href="10/d.html" class="page">Going Asynchronous</a></li>
<li><a href="10/e.html" class="page">Asyncrazy Temperature Server</a></li>
</ul></li>
<li><a href="11.html" class="page">Jetty Extras</a></li>
<li><a href="12.html" class="page">ScalaTest</a></li>
<li><a href="99.html" class="page">Who’s Using Unfiltered?</a></li>
</ul>
</div>
</nav>
</div>
<div class="off-canvas-content" data-off-canvas-content>
<header class="site-header expanded row">
<div class="small-12 column">
<a href="#" class="off-canvas-toggle hide-for-medium" data-toggle="off-canvas-menu"><svg class="svg-icon svg-icon-menu" version="1.1" id="Menu" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve"> <path class="svg-icon-menu-path" fill="#53CDEC" d="M16.4,9H3.6C3.048,9,3,9.447,3,10c0,0.553,0.048,1,0.6,1H16.4c0.552,0,0.6-0.447,0.6-1C17,9.447,16.952,9,16.4,9z M16.4,13
H3.6C3.048,13,3,13.447,3,14c0,0.553,0.048,1,0.6,1H16.4c0.552,0,0.6-0.447,0.6-1C17,13.447,16.952,13,16.4,13z M3.6,7H16.4
C16.952,7,17,6.553,17,6c0-0.553-0.048-1-0.6-1H3.6C3.048,5,3,5.447,3,6C3,6.553,3.048,7,3.6,7z"/></svg>
</a>
<div class="title"><a href="index.html">Unfiltered</a></div>
<!--
<a href="https://www.example.com" class="logo show-for-medium">logo</a>
-->
</div>
</header>
<div class="expanded row">
<div class="medium-3 large-2 show-for-medium column">
<nav class="site-nav">
<div class="nav-home">
<a href="index.html" >
<span class="home-icon">⌂</span>Unfiltered
</a>
<div class="version-number">
0.12.0
</div>
</div>
<div class="nav-toc">
<ul>
<li><a href="01.html" class="active page">Try Unfiltered</a></li>
<li><a href="02.html" class="page">Plans and Intents</a></li>
<li><a href="03.html" class="page">Bindings and Servers</a></li>
<li><a href="04.html" class="page">Project Setup</a></li>
<li><a href="05.html" class="page">Community</a></li>
<li><a href="06/00.html" class="page">Matching and Responding</a>
<ul>
<li><a href="06/a.html" class="page">Request Matchers</a></li>
<li><a href="06/b.html" class="page">Within the Parameters</a></li>
<li><a href="06/c.html" class="page">Response Functions</a></li>
<li><a href="06/d.html" class="page">Silly Store</a></li>
</ul></li>
<li><a href="07/00.html" class="page">Directives and Validation</a>
<ul>
<li><a href="07/a.html" class="page">Directive Intent</a></li>
<li><a href="07/b.html" class="page">Parameters as Directives</a></li>
<li><a href="07/c.html" class="page">Interpreter Reuse and Implicits</a></li>
<li><a href="07/d.html" class="page">Required Parameters</a></li>
<li><a href="07/e.html" class="page">Independent Failure</a></li>
<li><a href="07/f.html" class="page">Interpreters of Your Own Design</a></li>
<li><a href="07/g.html" class="page">Let’s wrap this up, Ada</a></li>
</ul></li>
<li><a href="08/00.html" class="page">Application Structure</a>
<ul>
<li><a href="08/a.html" class="page">Planning for Any-thing</a></li>
<li><a href="08/b.html" class="page">Just Kitting</a></li>
</ul></li>
<li><a href="09/00.html" class="page">Identification and Cookies</a>
<ul>
<li><a href="09/a.html" class="page">Who’s Who</a></li>
<li><a href="09/b.html" class="page">Remembrance of Things Past</a></li>
</ul></li>
<li><a href="10/00.html" class="page">Netty Plans</a>
<ul>
<li><a href="10/a.html" class="page">Trying Netty</a></li>
<li><a href="10/b.html" class="page">Execution and Exceptions</a></li>
<li><a href="10/c.html" class="page">Chunked Requests</a></li>
<li><a href="10/d.html" class="page">Going Asynchronous</a></li>
<li><a href="10/e.html" class="page">Asyncrazy Temperature Server</a></li>
</ul></li>
<li><a href="11.html" class="page">Jetty Extras</a></li>
<li><a href="12.html" class="page">ScalaTest</a></li>
<li><a href="99.html" class="page">Who’s Using Unfiltered?</a></li>
</ul>
</div>
</nav>
</div>
<div class="small-12 medium-9 large-10 column">
<section class="site-content">
<span id="version-warning"></span>
<div class="page-header row">
<div class="medium-12 show-for-medium column">
<div class="nav-breadcrumbs">
<ul>
<li><a href="index.html">Unfiltered</a></li>
<li>Try Unfiltered</li>
</ul>
</div>
</div>
</div>
<div class="page-content row">
<div class="small-12 large-9 column" id="docs">
<h2><a href="#try-unfiltered" name="try-unfiltered" class="anchor"><span class="anchor-link"></span></a>Try Unfiltered</h2>
<p>It’s not hard to write a request handler in the Scala console using Unfiltered. The tricky part is getting everything on the classpath.</p>
<h3><a href="#play-project" name="play-project" class="anchor"><span class="anchor-link"></span></a>Play Project</h3>
<p>The approach recommended here uses <a href="https://github.com/foundweekends/giter8#readme">giter8</a>, a tool for setting up projects based on templates stored in github. Assuming you don’t have giter8 installed and you are on a network-connected Linux or Mac, it’s easy to fix that.</p>
<pre class="prettyprint"><code class="language-sh">curl https://raw.githubusercontent.com/foundweekends/conscript/master/setup.sh | sh
</code></pre>
<p>That is <a href="https://github.com/foundweekends/conscript#readme">conscript</a>. Its <code>setup.sh</code> places a permanent (assuming you don’t delete it) executable script in <code>~/bin/cs</code>. At some point you may want to add <code>~/bin</code> to your executable search path, but these instructions will not assume it is.</p>
<pre class="prettyprint"><code class="language-sh">~/bin/cs foundweekends/giter8
</code></pre>
<p>That installs a <code>g8</code>. Now you have a script to run giter8. The next step creates a sbt project under the current working directory.</p>
<pre class="prettyprint"><code class="language-sh">~/bin/g8 unfiltered/unfiltered --name=justplayin
</code></pre>
<p>Okay, finally we can use this project with sbt to get a console for Unfiltered. You do have <a href="https://www.scala-sbt.org/">sbt setup</a>, don’t you?</p>
<pre class="prettyprint"><code class="language-sh">cd justplayin
sbt console
</code></pre>
<h3><a href="#consoled" name="consoled" class="anchor"><span class="anchor-link"></span></a>Consoled</h3>
<p>Now that you have a <code>scala></code> prompt with the <code>unfiltered-filter</code> and <code>unfiltered-jetty</code> modules on the classpath, let’s have some fun.</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/unfiltered/website/tree/v0.12.0/src/main/scala/01.scala#L6-L11" target="_blank" title="Go to snippet source">source</a><code class="language-scala">import unfiltered.request._
import unfiltered.response._
val echo = unfiltered.filter.Planify {
case Path(Seg(p :: Nil)) => ResponseString(p)
}</code></pre>
<p>This filter <code>echo</code> would work with any servlet container. We can use it in a Jetty server right now.</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/unfiltered/website/tree/v0.12.0/src/main/scala/01.scala#L16" target="_blank" title="Go to snippet source">source</a><code class="language-scala">unfiltered.jetty.Server.anylocal.plan(echo).run()</code></pre>
<p>The startup message tells you which open port was selected, and by default it is only listening to requests from 127.0.0.1. So on the same machine, you can make requests to your server. e.g.</p>
<pre class="prettyprint"><code class="language-sh">curl http://127.0.0.1:<the right port>/hello+world
</code></pre>
<p>Fancy desktop web browsers will work too. Notice that exactly one path segment is required for the filter to respond to the request. If you ask for the root path or a deeper path, the <code>echo</code> filter will not handle the request and Jetty responds with a 404 page.</p>
<p>If we want to handle any request, we could broaden the pattern matching expression. (Press enter to stop the running server.)</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/unfiltered/website/tree/v0.12.0/src/main/scala/01.scala#L21-L27" target="_blank" title="Go to snippet source">source</a><code class="language-scala">val echoNice = unfiltered.filter.Planify {
case Path(Seg(p :: Nil)) => ResponseString(p)
case _ => ResponseString(
"I can echo exactly one path element."
)
}
unfiltered.jetty.Server.anylocal.plan(echoNice).run()</code></pre>
<p>Or we could define another filter chain it to the first.</p>
<pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/unfiltered/website/tree/v0.12.0/src/main/scala/01.scala#L32-L37" target="_blank" title="Go to snippet source">source</a><code class="language-scala">val nice = unfiltered.filter.Planify {
case _ => ResponseString(
"I can echo exactly one path element."
)
}
unfiltered.jetty.Server.anylocal.plan(echo).plan(nice).run()</code></pre>
<p>Happy now?</p>
<div class="source-github">
The source code for this page can be found <a href="https://github.com/unfiltered/website/tree/v0.12.0/src/main/paradox/01.md">here</a>.
</div>
<div class="nav-next">
<p><strong>Next:</strong> <a href="02.html">Plans and Intents</a></p>
</div>
</div>
<div class="large-3 show-for-large column" data-sticky-container>
<nav class="sidebar sticky" data-sticky data-anchor="docs" data-sticky-on="large">
<div class="page-nav">
<div class="nav-title">On this page:</div>
<div class="nav-toc">
<ul>
<li><a href="01.html#try-unfiltered" class="header">Try Unfiltered</a>
<ul>
<li><a href="01.html#play-project" class="header">Play Project</a></li>
<li><a href="01.html#consoled" class="header">Consoled</a></li>
</ul></li>
</ul>
</div>
</div>
</nav>
</div>
</div>
</section>
</div>
</div>
<footer class="site-footer">
<section class="site-footer-nav">
<div class="expanded row">
<div class="small-12 large-offset-2 large-10 column">
<div class="row site-footer-content">
<div class="small-12 medium-4 large-3 text-center column">
<div class="nav-links">
<ul>
<!-- <li><a href="https://www.example.com/products/">Products</a> -->
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="site-footer-base">
<div class="expanded row">
<div class="small-12 large-offset-2 large-10 column">
<div class="row site-footer-content">
<div class="small-12 text-center large-9 column">
<!--
<div class="copyright">
<span class="text">© 2024</span>
<a href="https://www.example.com" class="logo">logo</a>
</div>
-->
</div>
</div>
</div>
</div>
</section>
</footer>
</div>
</div>
</div>
</body>
<script type="text/javascript" src="lib/foundation/dist/foundation.min.js"></script>
<script type="text/javascript">jQuery(document).foundation();</script>
<script type="text/javascript" src="js/magellan.js"></script>
<style type="text/css">@import "lib/prettify/prettify.css";</style>
<script type="text/javascript" src="lib/prettify/prettify.js"></script>
<script type="text/javascript" src="lib/prettify/lang-scala.js"></script>
<script type="text/javascript">jQuery(function(){window.prettyPrint && prettyPrint()});</script>
<script type="text/javascript">jQuery(function(jq){initOldVersionWarnings(jq, '0.12.0', '')});</script>
</html>