Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add one-import usage for sttp #125

Merged
merged 5 commits into from
Jul 19, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions core/js/src/main/scala/com/softwaremill/sttp/simpleApi.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.softwaremill.sttp

object simpleApi extends SttpApi{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would be leaning towards calling this package quick. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

implicit lazy val backend = FetchBackend()
}
5 changes: 5 additions & 0 deletions core/jvm/src/main/scala/com/softwaremill/sttp/simpleApi.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.softwaremill.sttp

object simpleApi extends SttpApi {
implicit lazy val backend = HttpURLConnectionBackend()
}
233 changes: 233 additions & 0 deletions core/shared/src/main/scala/com/softwaremill/sttp/SttpApi.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
package com.softwaremill.sttp

import java.io.{ByteArrayOutputStream, InputStream, OutputStream }
import java.nio.ByteBuffer

import com.softwaremill.sttp.internal.SttpFile

import scala.annotation.{implicitNotFound, tailrec}
import scala.collection.immutable.Seq
import scala.concurrent.duration._
import scala.language.higherKinds

trait SttpApi extends sttpExtensions {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe sttpExtensions could now become SttpApiExtensions?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, but this was the existing name so I feel changing it is kind of orthogonal to this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was for consistency, as previously these were extensions to the sttp package object. Hence the lower-case name prefix :)

type Id[X] = X
type Empty[X] = None.type

type PartialRequest[T, +S] = RequestT[Empty, T, S]
type Request[T, +S] = RequestT[Id, T, S]

@implicitNotFound(
"This is a partial request, the method & url are not specified. Use " +
".get(...), .post(...) etc. to obtain a non-partial request.")
private[sttp] type IsIdInRequest[U[_]] = U[Unit] =:= Id[Unit]

/**
* Provide an implicit value of this type to serialize arbitrary classes into a request body.
* Backends might also provide special logic for serializer instances which they define (e.g. to handle streaming).
*/
type BodySerializer[B] = B => BasicRequestBody

val DefaultReadTimeout: Duration = 1.minute

// constants

private[sttp] val Utf8 = "utf-8"
private[sttp] val Iso88591 = "iso-8859-1"
private[sttp] val CrLf = "\r\n"

// entry points

/**
* An empty request with no headers.
*/
val emptyRequest: RequestT[Empty, String, Nothing] =
RequestT[Empty, String, Nothing](None,
None,
NoBody,
Vector(),
asString,
RequestOptions(followRedirects = true, readTimeout = DefaultReadTimeout),
Map())

/**
* A starting request, with the following modifications comparing to
* `emptyRequest`:
*
* - `Accept-Encoding` set to `gzip, deflate` (handled automatically by the
* library)
*/
val sttp: RequestT[Empty, String, Nothing] =
emptyRequest.acceptEncoding("gzip, deflate")

// response specifications

def ignore: ResponseAs[Unit, Nothing] = IgnoreResponse

/**
* Use the `utf-8` encoding by default, unless specified otherwise in the response headers.
*/
def asString: ResponseAs[String, Nothing] = asString(Utf8)

/**
* Use the given encoding by default, unless specified otherwise in the response headers.
*/
def asString(encoding: String): ResponseAs[String, Nothing] =
ResponseAsString(encoding)

def asByteArray: ResponseAs[Array[Byte], Nothing] =
ResponseAsByteArray

/**
* Use the `utf-8` encoding by default, unless specified otherwise in the response headers.
*/
def asParams: ResponseAs[Seq[(String, String)], Nothing] =
asParams(Utf8)

/**
* Use the given encoding by default, unless specified otherwise in the response headers.
*/
def asParams(encoding: String): ResponseAs[Seq[(String, String)], Nothing] =
asString(encoding).map(ResponseAs.parseParams(_, encoding))

def asStream[S]: ResponseAs[S, S] = ResponseAsStream[S, S]()

private[sttp] def asSttpFile(file: SttpFile, overwrite: Boolean = false): ResponseAs[SttpFile, Nothing] =
ResponseAsFile(file, overwrite)

// multipart factory methods

/**
* Content type will be set to `text/plain` with `utf-8` encoding, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, data: String): Multipart =
Multipart(name, StringBody(data, Utf8), contentType = Some(contentTypeWithEncoding(MediaTypes.Text, Utf8)))

/**
* Content type will be set to `text/plain` with `utf-8` encoding, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, data: String, encoding: String): Multipart =
Multipart(name, StringBody(data, encoding), contentType = Some(contentTypeWithEncoding(MediaTypes.Text, Utf8)))

/**
* Content type will be set to `application/octet-stream`, can be overridden
* later using the `contentType` method.
*/
def multipart(name: String, data: Array[Byte]): Multipart =
Multipart(name, ByteArrayBody(data), contentType = Some(MediaTypes.Binary))

/**
* Content type will be set to `application/octet-stream`, can be overridden
* later using the `contentType` method.
*/
def multipart(name: String, data: ByteBuffer): Multipart =
Multipart(name, ByteBufferBody(data), contentType = Some(MediaTypes.Binary))

/**
* Content type will be set to `application/octet-stream`, can be overridden
* later using the `contentType` method.
*/
def multipart(name: String, data: InputStream): Multipart =
Multipart(name, InputStreamBody(data), contentType = Some(MediaTypes.Binary))

/**
* Content type will be set to `application/octet-stream`, can be overridden
* later using the `contentType` method.
*
* File name will be set to the name of the file.
*/
private[sttp] def multipartSttpFile(name: String, file: SttpFile): Multipart =
Multipart(name,
FileBody(file),
fileName = Some(file.name),
contentType = Some(MediaTypes.Binary))

/**
* Encodes the given parameters as form data using `utf-8`.
*
* Content type will be set to `application/x-www-form-urlencoded`, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, fs: Map[String, String]): Multipart =
Multipart(name, RequestBody.paramsToStringBody(fs.toList, Utf8), contentType = Some(MediaTypes.Form))

/**
* Encodes the given parameters as form data.
*
* Content type will be set to `application/x-www-form-urlencoded`, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, fs: Map[String, String], encoding: String): Multipart =
Multipart(name, RequestBody.paramsToStringBody(fs.toList, encoding), contentType = Some(MediaTypes.Form))

/**
* Encodes the given parameters as form data using `utf-8`.
*
* Content type will be set to `application/x-www-form-urlencoded`, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, fs: Seq[(String, String)]): Multipart =
Multipart(name, RequestBody.paramsToStringBody(fs, Utf8), contentType = Some(MediaTypes.Form))

/**
* Encodes the given parameters as form data.
*
* Content type will be set to `application/x-www-form-urlencoded`, can be
* overridden later using the `contentType` method.
*/
def multipart(name: String, fs: Seq[(String, String)], encoding: String): Multipart =
Multipart(name, RequestBody.paramsToStringBody(fs, encoding), contentType = Some(MediaTypes.Form))

/**
* Content type will be set to `application/octet-stream`, can be
* overridden later using the `contentType` method.
*/
def multipart[B: BodySerializer](name: String, b: B): Multipart =
Multipart(name, implicitly[BodySerializer[B]].apply(b), contentType = Some(MediaTypes.Binary))

// util

private[sttp] def contentTypeWithEncoding(ct: String, enc: String): String =
s"$ct; charset=$enc"

private[sttp] def encodingFromContentType(ct: String): Option[String] =
ct.split(";").map(_.trim.toLowerCase).collectFirst {
case s if s.startsWith("charset=") => s.substring(8)
}

private[sttp] def transfer(is: InputStream, os: OutputStream): Unit = {
var read = 0
val buf = new Array[Byte](1024)

@tailrec
def transfer(): Unit = {
read = is.read(buf, 0, buf.length)
if (read != -1) {
os.write(buf, 0, read)
transfer()
}
}

transfer()
}

private[sttp] def toByteArray(is: InputStream): Array[Byte] = {
val os = new ByteArrayOutputStream
transfer(is, os)
os.toByteArray
}

private[sttp] def concatByteBuffers(bb1: ByteBuffer, bb2: ByteBuffer): ByteBuffer =
ByteBuffer
.allocate(bb1.array().length + bb2.array().length)
.put(bb1)
.put(bb2)

// uri interpolator

implicit class UriContext(val sc: StringContext) {
def uri(args: Any*): Uri = UriInterpolator.interpolate(sc, args: _*)
}
}
Loading