IMPORTANT: THIS REPO IS ABANDONED Please feel free to use it if it's useful to you, but it's three years old now, has not been built against newer scala versions or spray releases, and I have no interest in doing so.
I will delete this repo in 2018 (that's in 12 months), so if it's still of use to you, I advice you to fork.
A cookiejar exploration for spray-client
spray-cookies implements a cookiejar that can be plugged in to a spray-client pipeline. The cookiejar itself is mutable so that it remembers the current state
basic usage:
The pipeline example from spray-client at http://spray.io/documentation/1.2.1/spray-client/ is as follows:
import spray.http._
import spray.json.DefaultJsonProtocol
import spray.httpx.encoding.{Gzip, Deflate}
import spray.httpx.SprayJsonSupport._
import spray.client.pipelining._
case class Order(id: Int)
case class OrderConfirmation(id: Int)
object MyJsonProtocol extends DefaultJsonProtocol {
implicit val orderFormat = jsonFormat1(Order)
implicit val orderConfirmationFormat = jsonFormat1(OrderConfirmation)
}
import MyJsonProtocol._
implicit val system = ActorSystem()
import system.dispatcher // execution context for futures
val pipeline: HttpRequest => Future[OrderConfirmation] = (
addHeader("X-My-Special-Header", "fancy-value")
~> addCredentials(BasicHttpCredentials("bob", "secret"))
~> encode(Gzip)
~> sendReceive
~> decode(Deflate)
~> unmarshal[OrderConfirmation]
)
val response: Future[OrderConfirmation] =
pipeline(Post("http://example.com/orders", Order(42)))
To store cookies received from the http response on this pipeline you can use the withCookies function, which takes a cookiejar and the inner sendReive pipeline as arguments. The above example then becomes
case class Order(id: Int)
case class OrderConfirmation(id: Int)
object MyJsonProtocol extends DefaultJsonProtocol {
implicit val orderFormat = jsonFormat1(Order)
implicit val orderConfirmationFormat = jsonFormat1(OrderConfirmation)
}
import MyJsonProtocol._
implicit val system = ActorSystem()
import system.dispatcher // execution context for futures
val cookiejar = new CookieJar(DefaultEffectiveTldList)
val cookied = Cookiehandling.withCookies(Some(cookiejar), Some(cookiejar)) _
val pipeline: HttpRequest ⇒ Future[OrderConfirmation] = (
addHeader("X-My-Special-Header", "fancy-value")
~> addCredentials(BasicHttpCredentials("bob", "secret"))
~> cookied(encode(Gzip)
~> sendReceive
~> decode(Deflate))
~> unmarshal[OrderConfirmation]
)
val response: Future[OrderConfirmation] =
pipeline(Post("http://example.com/orders", Order(42)))
