⚡️ Functional Scala HTTP facade and toolkit.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
source
.gitignore
.travis.yml
LICENSE
README.md
build.sbt
version.sbt

README.md

Zenith

Build Status Join the chat at https://gitter.im/sungiant/zenith License Maven Central Coverage status

Zenith is a functional HTTP toolkit for Scala.

Getting started

Zenith is currently available for Scala 2.11.12 and 2.12.4.

To get started with SBT, simply add the following to your build.sbt file:

libraryDependencies += "io.github.sungiant" %% "zenith" % "0.4.5"

Additionally, the zenith-netty package contains an off the shelf implementation of Zenith's abstract network layer:

libraryDependencies += "io.github.sungiant" %% "zenith-netty" % "0.4.5"

Finally the zenith-default package is great for getting started, it contains an the shelf implementation of a Zenith compatible sequencing context as well as some useful Zenith plugins:

libraryDependencies += "io.github.sungiant" %% "zenith-default" % "0.4.5"

A working example

A demo project can be found in the orphan demo branch of this repository.

Architecture

Zenith is achitected around an abstract network layer and a generic sequencing context. This make it possible to write a web service using Zenith that allows for easily changing both the network layer implementation (Netty, Akka HTTP...) and the sequencing context (Scala Future, Twitter Future, Akka Future + WriterT Monad Transformer) that binds operations together.

Zenith makes it easy to write a webservice against exactly the dependences you want, if you decide that you want your project to only have dependencies on Akka HTTP, you can do that, simply switch out the zenith-netty package for your own implementation of Zenith's abstract network layer using Akka HTTP. Zenith doesn't impose such choices upon your project.

Zenith is written in a functional style; the codebase does not include a single instance of Scala's var keyword.

The core part of Zenith, the package zenith, depends upon:

An implementation of Zenith's abstract network layer is provided in a seperate package zenith-netty that additionally depends upon:

  • netty an event-driven asynchronous network application framework

An implementation of a Zenith compatible sequencing context and a handful of useful plugins are, again, provided in a seperate package zenith-default that additionally depends upon:

  • circe for functional JSON

Alternatives

  • unfiltered a toolkit for servicing HTTP requests
  • finch a combinator library for building Finagle HTTP services

License

Zenith is licensed under the MIT License; you may not use this software except in compliance with the License.

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.