Packages

•  package root

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Provided herein is API documentation for Scamper, the HTTP library for Scala.

  Definition Classes

  root

•  package scamper

  Defines core types.

  Defines core types.

  HTTP Messages

  At the core of Scamper is HttpMessage, which is a trait that defines the fundamental characteristics of an HTTP message. HttpRequest and HttpResponse extend the specification to define characteristics specific to their respective message types.

  An HttpRequest is created using a factory method defined in its companion object. Or you can start with a RequestMethod and use builder methods to further define the request.

  import scamper.Header
  import scamper.Implicits.stringToUri
  import scamper.RequestMethod.Registry.Get
  
  val request = Get("/motd").setHeaders(
    Header("Host: localhost:8080"),
    Header("Accept: text/plain")
  )
  
  printf("Request Method: %s%n", request.method)
  printf("Target URI: %s%n", request.target)
  
  request.headers.foreach(println)
  
  val host: Option[String] = request.getHeaderValue("Host")

  An HttpResponse is created using a factory method defined in its companion object. Or you can start with a ResponseStatus and use builder methods to further define the response.

  import scamper.{ BodyParser, Header }
  import scamper.Implicits.stringToEntity
  import scamper.ResponseStatus.Registry.Ok
  
  val response = Ok("There is an answer.").setHeaders(
    Header("Content-Type: text/plain"),
    Header("Connection: close")
  )
  
  printf("Status Code: %s%n", response.statusCode)
  printf("Reason Phrase: %s%n", response.reasonPhrase)
  
  response.headers.foreach(println)
  
  val contentType: Option[String] = response.getHeaderValue("Content-Type")
  
  implicit val parser = BodyParser.text()
  
  printf("Body: %s%n", response.as[String])

  Definition Classes

  root

•  package client

  Provides HTTP client implementation.

  Provides HTTP client implementation.

  Using HTTP Client

  The HttpClient object can be used to send a request and handle the response.

  import scamper.BodyParser
  import scamper.Implicits.stringToUri
  import scamper.RequestMethod.Registry.Get
  import scamper.client.HttpClient
  
  implicit val parser = BodyParser.text()
  
  def getMessageOfTheDay(): Either[Int, String] = {
    val req = Get("localhost:8080/motd")
  
    // Send request and handle response
    HttpClient.send(req) { res =>
      res.isSuccessful match {
        case true  => Right(res.as[String])
        case false => Left(res.statusCode)
      }
    }
  }

  Note the request must be created with an absolute URI to make effective use of the client.

  Creating HTTP Client

  When using the HttpClient object as the client, it creates an HttpClient instance for one-time usage. If you plan to send multiple requests, you can create and maintain a reference to a client. With it, you also get access to methods corresponding to standard HTTP request methods.

  import scamper.BodyParser
  import scamper.Implicits.stringToUri
  import scamper.client.HttpClient
  
  implicit val parser = BodyParser.text()
  
  // Create HttpClient instance
  val client = HttpClient()
  
  def getMessageOfTheDay(): Either[Int, String] = {
    // Use client instance
    client.get("http://localhost:8080/motd") { res =>
      res.isSuccessful match {
        case true  => Right(res.as[String])
        case false => Left(res.statusCode)
      }
    }
  }

  And, if an implicit client is in scope, you can make use of send() on the request itself.

  import scamper.BodyParser
  import scamper.Implicits.stringToUri
  import scamper.RequestMethod.Registry.Get
  import scamper.client.HttpClient
  import scamper.client.Implicits.ClientHttpRequestType // Adds send method to request
  import scamper.headers.{ Accept, AcceptLanguage }
  import scamper.types.Implicits.{ stringToMediaRange, stringToLanguageRange }
  
  implicit val client = HttpClient()
  implicit val parser = BodyParser.text(4096)
  
  Get("http://localhost:8080/motd")
    .setAccept("text/plain")
    .setAcceptLanguage("en-US; q=0.6", "fr-CA; q=0.4")
    .send(res => println(res.as[String])) // Send request and print response

  See also ClientSettings for information about configuring the HTTP client before it is created.

  Definition Classes

  scamper

• ClientSettings
• HttpClient
• Implicits
• RequestAborted
• RequestFilter
• ResponseFilter
• ResponseHandler

scamper.client

HttpClient 

Companion trait HttpClient