com.pagerduty.funhttpclient.HttpClient.scala Maven / Gradle / Ivy
/*
* Copyright 2015 PagerDuty, Inc.
*
* Author: Jesse Haber-Kucharsky
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.pagerduty.funhttpclient
import spray.http._
trait ClientError[A] {
type T = A
def fromNetworkError(e: NetworkError): A
}
/**
* Extend this trait to create your own HTTP client specialized to a certain application.
*
* The error type of the client must satisfy the [[ClientError]] interface.
*
* It is necessary to define both `clientError` and `httpDriver` on extending this trait.
*/
trait HttpClient {
type Error
/**
* An [[Http]] computation with an error-type specialized to [[Error]].
*/
type FixedHttp[A] = Http[Error, A]
val clientError: ClientError[Error]
/**
* The underlying HTTP driver used to make HTTP requests.
*/
val httpDriver: HttpDriver
/*
* Use this module to access [[HttpOps]].
*/
val httpOps = HttpOps[Error]
/**
* Perform an HTTP request.
*
* HTTP errors are converted to [[Error]] via [[ClientError.fromNetworkError]].
*/
def request(r: HttpRequest): FixedHttp[HttpResponse] = {
HttpOps.request(r)(httpDriver) mapError {
case e: NetworkError => clientError.fromNetworkError(e)
}
}
}