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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
use config::ConfigBuilder;
use error::{IntoCatch, DefaultCatch};
use middleware::Identity;
use response::{DefaultSerializer, Serializer};
use routing::{Resource, IntoResource, RoutedService};
use service::NewWebService;
use util::{BufStream, Chain};
use util::http::{HttpService, HttpMiddleware};

use std::io;
use std::net::SocketAddr;

/// Configure and build a web service.
///
/// `ServiceBuilder` collects all the components and configuration required to
/// build the HTTP service. Once the service is defined, it can be run
/// with `run`.
///
/// # Examples
///
/// Defining a service with a single resource;
///
/// ```rust
/// # #[macro_use] extern crate tower_web;
/// use tower_web::ServiceBuilder;
///
/// struct MyResource;
///
/// impl_web! {
///     impl MyResource {
///         // ...
///     }
/// }
///
/// # if false {
/// # let addr = "127.0.0.1:8080".parse().unwrap();
/// ServiceBuilder::new()
///     .resource(MyResource)
///     .run(&addr);
/// # }
/// ```
///
/// Defining a service with a multiple resources;
///
/// ```rust
/// # #[macro_use] extern crate tower_web;
/// use tower_web::ServiceBuilder;
///
/// struct MyResource1;
/// struct MyResource2;
/// struct MyResource3;
///
/// impl_web! {
///     impl MyResource1 {
///         // ...
///     }
///
///     impl MyResource2 {
///         // ...
///     }
///
///     impl MyResource3 {
///         // ...
///     }
/// }
///
/// # if false {
/// # let addr = "127.0.0.1:8080".parse().unwrap();
/// ServiceBuilder::new()
///     .resource(MyResource1)
///     .resource(MyResource2)
///     .resource(MyResource3)
///     .run(&addr);
/// # }
/// ```
///
/// Defining a middleware stack
///
/// ```rust
/// # #[macro_use] extern crate tower_web;
/// use tower_web::ServiceBuilder;
/// # type FooMiddleware = tower_web::middleware::log::LogMiddleware;
/// # type BarMiddleware = tower_web::middleware::log::LogMiddleware;
///
/// struct MyResource;
///
/// impl_web! {
///     impl MyResource {
///         // ...
///     }
/// }
///
/// # if false {
/// # let addr = "127.0.0.1:8080".parse().unwrap();
/// ServiceBuilder::new()
///     .resource(MyResource)
///     .middleware(FooMiddleware::new("foo"))
///     .middleware(BarMiddleware::new("bar"))
///     .run(&addr);
/// # }
/// ```
#[derive(Debug)]
pub struct ServiceBuilder<T, Serializer, Catch, Middleware> {
    /// The inner resource
    resource: T,
    serializer: Serializer,
    catch: Catch,
    middleware: Middleware,
    config: ConfigBuilder,
}

impl ServiceBuilder<(), DefaultSerializer, DefaultCatch, Identity> {
    /// Create a new `ServiceBuilder` with default configuration.
    ///
    /// At least one resource must be added before building the service.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:8080".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn new() -> Self {
        ServiceBuilder {
            resource: (),
            serializer: DefaultSerializer::new(),
            catch: DefaultCatch::new(),
            middleware: Identity::new(),
            config: ConfigBuilder::new(),
        }
    }
}

impl<T, S, C, M> ServiceBuilder<T, S, C, M> {
    /// Add a resource to the service.
    ///
    /// Resources are prioritized based on the order they are added to the
    /// `ServiceBuilder`. If two resources handle the same route, then the one
    /// that was added first gets priority.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:8080".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn resource<U>(self, resource: U)
        -> ServiceBuilder<<T as Chain<U>>::Output, S, C, M>
    where
        T: Chain<U>,
    {
        ServiceBuilder {
            resource: self.resource.chain(resource),
            serializer: self.serializer,
            catch: self.catch,
            middleware: self.middleware,
            config: self.config,
        }
    }

    /// Add a serializer to the service.
    ///
    /// Serializers convert response structs to bytes. Each given serializer
    /// handles a specific content-type. A service may have many registered
    /// serializers, each handling different content-types.
    ///
    /// By default, the service is able to respond with "text/plain" and
    /// "application/json" bodies. Adding new serializers adds the ability to
    /// handle additional formats.
    ///
    /// Currently, the only other supported format is "text/html" and is
    /// provided by the [handlebars] serializer. In future releases, third party
    /// crates will be able to provide serializer implementations.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    /// use tower_web::view::Handlebars;
    ///
    /// struct MyResource;
    ///
    /// #[derive(Response)]
    /// #[web(template = "index")]
    /// struct Index {
    ///     title: &'static str,
    /// }
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         #[get("/")]
    ///         fn index(&self) -> Result<Index, ()> {
    ///             Ok(Index {
    ///                 title: "hello world",
    ///             })
    ///         }
    ///     }
    /// }
    ///
    /// # fn dox() {
    /// # let addr = "127.0.0.1:0".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .serializer(Handlebars::new())
    ///     .resource(MyResource)
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn serializer<U>(self, serializer: U)
        -> ServiceBuilder<T, <S as Chain<U>>::Output, C, M>
    where
        S: Chain<U>,
    {
        ServiceBuilder {
            resource: self.resource,
            serializer: self.serializer.chain(serializer),
            catch: self.catch,
            middleware: self.middleware,
            config: self.config,
        }
    }

    /// Add a config to the service.
    ///
    /// Configs may be retrieved by their type and used from within extractors.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    /// use tower_web::extract::{Extract, Context, Immediate};
    /// use tower_web::util::BufStream;
    ///
    /// struct MyResource;
    /// struct MyConfig {
    ///     foo: String
    /// }
    /// struct MyParam {
    ///     bar: String
    /// }
    ///
    /// impl<B: BufStream> Extract<B> for MyParam {
    ///     type Future = Immediate<MyParam>;
    ///
    ///     fn extract(context: &Context) -> Self::Future {
    ///         let config = context.config::<MyConfig>().unwrap();
    ///         let param = MyParam { bar: config.foo.clone() };
    ///         Immediate::ok(param)
    ///     }
    /// }
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         #[get("/")]
    ///         fn action(&self, param: MyParam) -> Result<String, ()> {
    ///             Ok(param.bar)
    ///         }
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:0".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .config(MyConfig { foo: "bar".to_owned() })
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn config<U>(self, config: U)
                       -> ServiceBuilder<T, S, C, M>
        where
            U: Send + Sync + 'static,
    {
        ServiceBuilder {
            resource: self.resource,
            serializer: self.serializer,
            catch: self.catch,
            middleware: self.middleware,
            config: self.config.insert(config),
        }
    }

    /// Add a middleware to the service.
    ///
    /// Middleware that are defined last will receive requests first. In other
    /// words, when a middleware is added to the `ServiceBuilder`, it will wrap
    /// all previous middeware and all resources.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    /// # type FooMiddleware = tower_web::middleware::log::LogMiddleware;
    /// # type BarMiddleware = tower_web::middleware::log::LogMiddleware;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:8080".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .middleware(FooMiddleware::new("foo"))
    ///     .middleware(BarMiddleware::new("bar"))
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn middleware<U>(self, middleware: U)
        -> ServiceBuilder<T, S, C, <M as Chain<U>>::Output>
    where
        M: Chain<U>,
    {
        ServiceBuilder {
            resource: self.resource,
            serializer: self.serializer,
            catch: self.catch,
            middleware: self.middleware.chain(middleware),
            config: self.config,
        }
    }

    /// Add a global catch handler.
    ///
    /// In the event that a resource responds to a request with an error, the
    /// catch handler has an opportunity to convert that error to a response.
    /// Most of the time, the catch handler is used to convert the error to a
    /// friendy response status.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// extern crate http;
    /// use tower_web::ServiceBuilder;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:8080".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .catch(|_: &http::Request<()>, error: tower_web::Error| {
    ///         assert!(error.kind().is_not_found());
    ///
    ///         let response = http::response::Builder::new()
    ///             .status(404)
    ///             .header("content-type", "text/plain")
    ///             .body("where you at?")
    ///             .unwrap();
    ///
    ///         Ok(response)
    ///     })
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn catch<U>(self, catch: U) -> ServiceBuilder<T, S, U, M> {
        ServiceBuilder {
            resource: self.resource,
            serializer: self.serializer,
            catch,
            middleware: self.middleware,
            config: self.config,
        }
    }

    /// Build a `NewWebService` instance
    ///
    /// The returned value impements `tower_service::NewService` and is used to
    /// generate `service::WebService` values. usually, a `NewWebService`
    /// instance is used to generate one service per TCP connection established
    /// to the server.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// # extern crate tower_service;
    /// # extern crate futures;
    /// # extern crate http;
    ///
    /// use tower_web::ServiceBuilder;
    /// use tower_service::{Service, NewService};
    /// use futures::Future;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// let new_service = ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .build_new_service();
    ///
    /// // Use `new_service` to get an instance of our web service.
    /// let mut service = new_service.new_service()
    ///     .wait().unwrap();
    ///
    /// // Issue a request to the service
    /// let request = http::request::Builder::new()
    ///     .method("POST")
    ///     .uri("/hello")
    ///     .body("hello".to_string())
    ///     .unwrap();
    ///
    /// let response = service.call(request);
    /// ```
    pub fn build_new_service<RequestBody>(self) -> NewWebService<T::Resource, C::Catch, M>
    where T: IntoResource<S, RequestBody>,
          S: Serializer,
          C: IntoCatch<S>,
          M: HttpMiddleware<RoutedService<T::Resource, C::Catch>>,
          RequestBody: BufStream,
    {
        // Build the routes
        let routes = self.resource.routes();
        let serializer = self.serializer;

        // Create the routed service
        let routed = RoutedService::new(
            self.resource.into_resource(serializer),
            self.catch.into_catch(),
            self.config.into_config(),
            routes);

        NewWebService::new(
            routed,
            self.middleware)
    }

    /// Run the service
    ///
    /// This builds the service and passes it to Hyper to run.
    ///
    /// Note that Hyper requires all types to be `Send`. Thus, for this to work,
    /// all resources must have response types that are `Send`.
    ///
    /// ```rust
    /// # #[macro_use] extern crate tower_web;
    /// use tower_web::ServiceBuilder;
    ///
    /// struct MyResource;
    ///
    /// impl_web! {
    ///     impl MyResource {
    ///         // ...
    ///     }
    /// }
    ///
    /// # if false {
    /// # let addr = "127.0.0.1:8080".parse().unwrap();
    /// ServiceBuilder::new()
    ///     .resource(MyResource)
    ///     .run(&addr);
    /// # }
    /// ```
    pub fn run(self, addr: &SocketAddr) -> io::Result<()>
    where T: IntoResource<S, ::run::LiftReqBody>,
          S: Serializer,
          C: IntoCatch<S> + Send + 'static,
          C::Catch: Send,
          M: HttpMiddleware<RoutedService<T::Resource, C::Catch>, RequestBody = ::run::LiftReqBody> + Send + 'static,
          M::Service: Send,
          <M::Service as HttpService>::Future: Send,
          M::ResponseBody: Send,
          <M::ResponseBody as BufStream>::Item: Send,
          T::Resource: Send + 'static,
          <T::Resource as Resource>::Buf: Send,
          <T::Resource as Resource>::Body: Send,
          <T::Resource as Resource>::Future: Send,
    {
        ::run::run(addr, self.build_new_service())
    }
}