https://github.com/pepegar/hammock
Purely functional HTTP client
https://github.com/pepegar/hammock
cats fp http scala typelevel
Last synced: 6 months ago
JSON representation
Purely functional HTTP client
- Host: GitHub
- URL: https://github.com/pepegar/hammock
- Owner: pepegar
- License: mit
- Created: 2017-01-15T19:53:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T11:57:17.000Z (over 2 years ago)
- Last Synced: 2025-03-31T10:06:49.454Z (6 months ago)
- Topics: cats, fp, http, scala, typelevel
- Language: Scala
- Homepage: https://hammock.pepegar.com/
- Size: 1.47 MB
- Stars: 174
- Watchers: 6
- Forks: 19
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - pepegar/hammock - Purely functional HTTP client (Scala)
README
# Hammock
[](http://typelevel.org/projects)
[](https://gitter.im/pepegar/hammock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/pepegar/hammock)
[](https://codecov.io/gh/pepegar/hammock)
[]()
Hammock is yet another HTTP client for Scala. It tries to be typeful,
purely functional, and work along other technologies that you're
already using such as akka-http, circe, or cats.
## Installation
Add the following to your `build.sbt`.
```scala
// For Scala 2.10, 2.11, or 2.12
libraryDependencies ++= Seq(
"com.pepegar" %% "hammock-core" % "0.10.0",
// Hammock for standard Scala doesn't ship with a standard implementation
"com.pepegar" %% "hammock-apache-http" % "0.10.0"
)
// For ScalaJS
libraryDependencies += "com.pepegar" %%% "hammock-core" % "0.10.0"
```
## Rationale
1. It's easy to use, has a high level API
2. It's typeful, tries to represent effects at type level.
3. It does not force a specific target context. You can run your computations in any type `F[_]` that has an instance of cats-effect's `Sync[F]`.
4. It has good [documentation][docs].
5. [It's modular](#modules)
[httpcommons]: http://hc.apache.org/
[xhr]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
[docs]: http://pepegar.com/hammock
[circe]: http://circe.io
[akka-http]: https://doc.akka.io/docs/akka-http/current/scala/http/
[async-http-client]: https://github.com/asynchttpclient/async-http-client
## Modules
| Module name | Description | Version |
| -------------------- | ------------------------------------------ | ------- |
| `hammock-core` | the core functionality of hammock, using [XHR][xhr] in JS | `0.10.0` |
| `hammock-circe` | encode and decode HTTP entities with [Circe][circe] | `0.10.0` |
| `hammock-apache-http` | run your HTTP requests with [Apache HTTP commons][httpcommons] | `0.10.0` |
| `hammock-akka-http` | run your HTTP requests with [akka-http][akka-http] | `0.10.0` |
| `hammock-asynchttpclient` | run your HTTP requests with [AsyncHttpClient][async-http-client] | `0.10.0` |
## How does Hammock look in action?
```scala
import cats.effect.IO
import hammock._
import hammock.marshalling._
import hammock.apache.ApacheInterpreter
import hammock.circe.implicits._
object HttpClient {
// Using the Apache HTTP commons interpreter
implicit val interpreter = ApacheInterpreter.instance[IO]
val response = Hammock
.request(Method.GET, uri"https://api.fidesmo.com/apps", Map()) // In the `request` method, you describe your HTTP request
.as[List[String]]
.exec[IO]
}
```
## Code of conduct
People are expected to follow the [Typelevel Code of Conduct](http://typelevel.org/conduct.html) when discussing Hammock on the Github page, Gitter channel, or other venues.