snowplow / iglu-scala-client

Scala client for Iglu schema registry

Website GitHub

Scala client for Iglu

[ ![Build Status] travis-image ] travis [ ![Release] release-image ] releases [ License license-image ] license

A Scala client and resolver for [Iglu schema repositories] iglu-wiki from the team at [Snowplow Analytics] snowplow-website.

Iglu Scala Client is used extensively in [Snowplow] snowplow-repo to validate self-describing JSONs. For a presentation on how we came to build Iglu, see [this blog post] snowplow-schema-post.

scala-client-img scala-client-img

Installation

The latest version of Iglu Scala Client is 0.5.0, which is cross-built against Scala 2.10.x and 2.11.x.

If you're using SBT, add the following lines to your build file:

val igluClient = "com.snowplowanalytics" %% "iglu-scala-client" % "0.5.0"

Note the double percent (%%) between the group and artifactId. That'll ensure you get the right package for your Scala version.

Usage

Primary entity for working with Iglu Scala Client is com.snowplowanalytics.iglu.client.Resolver. Resolver companion object has parse method which allows you to create Resolver instance from [resolver configuration] resolver-config. Second working method is lookupSchema, receiving Schema key as String or directly com.snowplowanalytics.iglu.SchemaKey object, this method traverse all configured repositories trying to find Schema by its key.

import scalaz.ValidationNel
import com.fasterxml.jackson.databind.JsonNode
import com.github.fge.jsonschema.core.report.ProcessingMessage
import com.snowplowanalytics.iglu.client.{ Resolver, SchemaKey }

val resolverConfig: JsonNode = ???
val schema: ValidationNel[ProcessingMessage, JsonNode] = for {
  schemaKey <- SchemaKey.parseNel("iglu:com.snowplowanalytics.snowplow/mobile_context/jsonschema/1-0-0")
  resolver <- Resolver.parse(resolverConfig)
  schema <- resolver.lookupSchema(schemaKey)
} yield schema

Above snippet returns mobile context JSON Schema if you provide correct resolverConfig. If not you will get all errors (like invalid format, network failure, etc) accumulated in scalaz.NonEmptyList, which itself is left side of scalaz.ValidationNel, structure isomorphic to native Scala Either.

Developer quickstart

Assuming git, [Vagrant] vagrant-install and [VirtualBox] virtualbox-install installed:

 host> git clone https://github.com/snowplow/iglu-scala-client
 host> cd iglu-scala-client
 host> vagrant up && vagrant ssh
guest> cd /vagrant
guest> sbt compile

Find out more

[Technical Docs] techdocs [Setup Guide] setup Roadmap roadmap Contributing contributing
[![i1] techdocs-image] techdocs [![i2] setup-image] setup [![i3] roadmap-image] roadmap [![i4] contributing-image] contributing

Copyright and license

Iglu Scala Client is copyright 2014-2017 Snowplow Analytics Ltd.

Licensed under the [Apache License, Version 2.0] license (the "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.