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
|
package com.softwaremill
import java.io.{File, InputStream}
import java.net.URI
import java.nio.ByteBuffer
import java.nio.file.Path
import com.softwaremill.sttp.model._
import scala.annotation.implicitNotFound
import scala.language.higherKinds
package object sttp {
/*
- set headers
- set cookies (set from response)
- partial request (no uri + method) / full request
- start with an empty partial request
- multi-part uploads
- body: bytes, input stream (?), task/future, stream (fs2/akka), form data, file
- auth
- access uri/method/headers/cookies/body spec
- proxy
- user agent, buffer size
- charset
- zipped encodings
- SSL - mutual? (client side)
- stream responses (sendStreamAndReceive?) / strict responses
- make sure response is consumed - only fire request when we know what to do with response?
- reuse connections / connection pooling - in handler
- handler restriction? AnyHandler <: Handler Restriction
Options:
- timeouts (connection/read)
- follow redirect
- ignore SSL
//
We want to serialize to:
- string
- byte array
- input stream
- handler-specific stream of bytes/strings
post:
- data (bytes/is/string - but which encoding?)
- form data (kv pairs - application/x-www-form-urlencoded)
- multipart (files mixed with forms - multipart/form-data)
*/
//
type Id[X] = X
type Empty[X] = None.type
def ignoreResponse: ResponseAs[Unit] = IgnoreResponse
def responseAsString(encoding: String): ResponseAs[String] = ResponseAsString(encoding)
def responseAsByteArray: ResponseAs[Array[Byte]] = ResponseAsByteArray
def responseAsStream[S]: ResponseAsStream[S] = ResponseAsStream[S]()
/**
* Use the factory methods `multiPart` to conveniently create instances of this class. A part can be then
* further customised using `fileName`, `contentType` and `header` methods.
*/
case class MultiPart(name: String, data: BasicRequestBody, fileName: Option[String] = None,
contentType: Option[String] = None, additionalHeaders: Map[String, String] = Map()) {
def fileName(v: String): MultiPart = copy(fileName = Some(v))
def contentType(v: String): MultiPart = copy(contentType = Some(v))
def header(k: String, v: String): MultiPart = copy(additionalHeaders = additionalHeaders + (k -> v))
}
def multiPart(name: String, data: String): MultiPart = MultiPart(name, StringBody(data))
def multiPart(name: String, data: Array[Byte]): MultiPart = MultiPart(name, ByteArrayBody(data))
def multiPart(name: String, data: ByteBuffer): MultiPart = MultiPart(name, ByteBufferBody(data))
def multiPart(name: String, data: InputStream): MultiPart = MultiPart(name, InputStreamBody(data))
def multiPart(name: String, data: () => InputStream): MultiPart = MultiPart(name, InputStreamSupplierBody(data))
// mandatory content type?
def multiPart(name: String, data: File): MultiPart = MultiPart(name, FileBody(data), fileName = Some(data.getName))
def multiPart(name: String, data: Path): MultiPart = MultiPart(name, PathBody(data), fileName = Some(data.getFileName.toString))
case class RequestTemplate[U[_]](
method: U[Method],
uri: U[URI],
body: RequestBody,
headers: Map[String, String]
) {
def get(uri: URI): Request = this.copy[Id](uri = uri, method = Method.GET)
def head(uri: URI): Request = this.copy[Id](uri = uri, method = Method.HEAD)
def post(uri: URI): Request = this.copy[Id](uri = uri, method = Method.POST)
def put(uri: URI): Request = this.copy[Id](uri = uri, method = Method.PUT)
def delete(uri: URI): Request = this.copy[Id](uri = uri, method = Method.DELETE)
def options(uri: URI): Request = this.copy[Id](uri = uri, method = Method.OPTIONS)
def patch(uri: URI): Request = this.copy[Id](uri = uri, method = Method.PATCH)
def header(k: String, v: String): RequestTemplate[U] = this.copy(headers = headers + (k -> v))
def data(b: String): RequestTemplate[U] = this.copy(body = StringBody(b))
def data(b: Array[Byte]): RequestTemplate[U] = this.copy(body = ByteArrayBody(b))
def data(b: ByteBuffer): RequestTemplate[U] = this.copy(body = ByteBufferBody(b))
def data(b: InputStream): RequestTemplate[U] = this.copy(body = InputStreamBody(b))
def data(b: () => InputStream): RequestTemplate[U] = this.copy(body = InputStreamSupplierBody(b))
// mandatory content type?
def data(b: File): RequestTemplate[U] = this.copy(body = FileBody(b))
def data(b: Path): RequestTemplate[U] = this.copy(body = PathBody(b))
def formData(fs: Map[String, String]): RequestTemplate[U] = ???
def formData(fs: (String, String)*): RequestTemplate[U] = ???
def multipartData(parts: MultiPart*): RequestTemplate[U] = ???
def send[R[_], T](responseAs: ResponseAs[T])(
implicit handler: SttpHandler[R], isRequest: IsRequest[U]): R[Response[T]] = {
handler.send(this, responseAs)
}
def send[R[_], S](responseAs: ResponseAsStream[S])(
implicit handler: SttpStreamHandler[R, S], isRequest: IsRequest[U]): R[Response[S]] = {
handler.send(this, responseAs)
}
def sendStream[R[_], S, T](contentType: String, stream: S, responseAs: ResponseAs[T])(
implicit handler: SttpStreamHandler[R, S], isRequest: IsRequest[U]): R[Response[T]] = {
handler.sendStream(this, contentType, stream, responseAs)
}
}
object RequestTemplate {
val empty: RequestTemplate[Empty] = RequestTemplate[Empty](None, None, NoBody, Map.empty)
}
type PartialRequest = RequestTemplate[Empty]
type Request = RequestTemplate[Id]
@implicitNotFound("This is a partial request, the method & url are not specified. Use .get(...), .post(...) etc. to obtain a non-partial request.")
private type IsRequest[U[_]] = RequestTemplate[U] =:= Request
val sttp: RequestTemplate[Empty] = RequestTemplate.empty
}
|
