Supports spray 1.1-M8 and spray-json 1.2.5

JsBSONHandlers.scala

import spray.json._
import reactivemongo.bson._
import scala.util.{ Try, Success, Failure }
import org.apache.commons.codec.binary.Hex
import org.joda.time.format.ISODateTimeFormat
import org.joda.time.{DateTime, DateTimeZone}
import java.nio.ByteBuffer

/**
  * From https://gist.github.com/nevang/4690568
  *
  * Readers and Writers for Reactivemongo BSON and Spray Json.
  *
  * Credits:
  * It is based on the work Stephane Godbillon and Pascal Voitot on play reactivemongo plugin
  * @see https://github.com/zenexity/Play-ReactiveMongo
  */
trait JsHandling  {
  /** Helper which allow to get json values from reactivemongo. */
  implicit object JsObjectReader extends BSONReader[BSONDocument, JsObject] {
    def read(bson: BSONDocument) = JsBSONReader.readObject(bson)
  }

  /** Helper which allow to get json values from reactivemongo. */
  implicit object JsValueReader extends BSONReader[BSONValue, JsValue] {
    def read(bson: BSONValue) = JsBSONReader.readValue(bson)
  }

  /** Helper which allow to send json values to reactivemongo. */
  object JsObjectWriter extends BSONWriter[JsObject, BSONDocument] {
    def write(t: JsObject): BSONDocument = JsBSONWriter.writeObject(t)
  }

  /** Helper which allow to send json values to reactivemongo. */
  implicit object JsValueWriter extends BSONWriter[JsValue, BSONValue] {
    def write(doc: JsValue) = {
      doc match {
        case o: JsObject => JsBSONWriter.writeObject(o)
        case a: JsArray  => JsBSONWriter.writeArray(a)
        case v           => JsBSONWriter.writeValue(v)
      }
    }
  }
}

/** Readers
  *
  * @see http://docs.mongodb.org/manual/reference/mongodb-extended-json/
  */
object JsBSONReader {

  def readObject(doc: BSONDocument) = JsObject(doc.elements.iterator.toList.map(readElement))

  def readElement(e: BSONElement): (String, JsValue) = e._1 -> readValue(e._2)

  def readValue(v: BSONValue) = v match {
    case BSONString(value) => JsString(value)
    case BSONInteger(value) => JsNumber(value)
    case BSONLong(value) => JsNumber(value)
    case BSONDouble(value) => JsNumber(value)
    case BSONBoolean(true) => JsTrue
    case BSONBoolean(false) => JsFalse
    case BSONNull => JsNull
    case doc: BSONDocument => readObject(doc)
    case arr: BSONArray => readArray(arr)
    case oid@BSONObjectID(value) => JsObject("$oid" -> JsString(oid.stringify))
    case BSONDateTime(value) => JsString(isoFormatter.print(value)) // Doesn't follow mongdb-extended
    case bb: BSONBinary => readBSONBinary(bb)
    case BSONRegex(value, flags) => JsObject("$regex" -> JsString(value), "$options" -> JsString(flags))
    case BSONTimestamp(value) => JsObject("$timestamp" -> JsObject(
      "t" -> JsNumber(value.toInt), "i" -> JsNumber((value >>> 32).toInt)))
    case BSONUndefined => JsObject("$undefined" -> JsTrue)
    // case BSONMinKey                   => JsObject("$minKey" -> JsNumber(1)) // Bug on reactivemongo
    case BSONMaxKey => JsObject("$maxKey" -> JsNumber(1))
    // case BSONDBPointer(value, id) => JsObject("$ref" -> JsString(value), "$id" -> JsString(Hex.encodeHexString(id))) // Not implemented
    // NOT STANDARD AT ALL WITH JSON and MONGO
    case BSONJavaScript(value) => JsObject("$js" -> JsString(value))
    case BSONSymbol(value) => JsObject("$sym" -> JsString(value))
    case BSONJavaScriptWS(value) => JsObject("$jsws" -> JsString(value))
  }

  def readArray(array: BSONArray) = JsArray(array.iterator.toList.map(_.toOption.map(readElement(_)._2)).flatten)

  def readBSONBinary(bb: BSONBinary) = {
    val arr = new Array[Byte](bb.value.readable())
    bb.value.readBytes(arr)
    val sub = ByteBuffer.allocate(4).putInt(bb.subtype.value).array
    JsObject("$binary" -> JsString(Hex.encodeHexString(arr)),
      "$type" -> JsString(Hex.encodeHexString(sub)))
  }

  val isoFormatter = ISODateTimeFormat.dateTime.withZone(DateTimeZone.UTC)
}

/** Writers
  *
  * @see http://docs.mongodb.org/manual/reference/mongodb-extended-json/
  */
object JsBSONWriter {

  def writeObject(obj: JsObject): BSONDocument = BSONDocument(obj.fields.map(writePair).toSeq)

  def writeArray(arr: JsArray): BSONArray =
    BSONArray(arr.elements.zipWithIndex.map(p => writePair(p._2.toString, p._1)).map(_._2))

  def writePair(p: (String, JsValue)): (String, BSONValue) = (p._1, writeValue(p._2))


  def writeValue(v: JsValue): BSONValue = v match {
    case JsString(str@IsoDateTime(y, m, d, h, mi, s, ms)) => manageDate(y, m, d, h, mi, s, ms) match {
      case Success(dt) => dt
      case Failure(_) => BSONString(str)
    }
    case JsString(str) => BSONString(str)
    case JsNumber(value) => BSONDouble(value.doubleValue())
    case obj: JsObject => manageSpecials(obj)
    case arr: JsArray => writeArray(arr)
    case JsTrue => BSONBoolean(true)
    case JsFalse => BSONBoolean(false)
    case JsNull => BSONNull
  }

  def manageDate(year: String, month: String, day: String, hour: String, minute: String, second: String, milli: String) =
    Try(BSONDateTime(new DateTime(year.toInt, month.toInt, day.toInt, hour.toInt,
      minute.toInt, second.toInt, milli.toInt, DateTimeZone.UTC).getMillis))

  def manageSpecials(obj: JsObject): BSONValue =
    if (obj.fields.size > 2) writeObject(obj)
    else (obj.fields.toList match {
      case ("$oid", JsString(str)) :: Nil            => Try(BSONObjectID(Hex.decodeHex(str.toArray)))
      case ("$undefined", JsTrue) :: Nil             => Success(BSONUndefined)
      // case ("$minKey", JsNumber(n)) :: Nil if n == 1 => Success(BSONMinKey) // Bug on reactivemongo
      case ("$maxKey", JsNumber(n)) :: Nil if n == 1 => Success(BSONMaxKey)
      case ("$js", JsString(str)) :: Nil             => Success(BSONJavaScript(str))
      case ("$sym", JsString(str)) :: Nil            => Success(BSONSymbol(str))
      case ("$jsws", JsString(str)) :: Nil           => Success(BSONJavaScriptWS(str))
      case ("$timestamp", ts: JsObject) :: Nil       => manageTimestamp(ts)
      case ("$regex", JsString(r)) :: ("$options", JsString(o)) :: Nil =>
        Success(BSONRegex(r, o))
      case ("$binary", JsString(d)) :: ("$type", JsString(t)) :: Nil =>
        Try(BSONBinary(d.getBytes, findSubtype(Hex.decodeHex(t.toArray))))
      // case ("$ref", JsString(v)) :: ("$id", JsString(i)) :: Nil => // Not implemented
      //   Try(BSONDBPointer(v, Hex.decodeHex(i.toArray)))
      case _ => Success(writeObject(obj))
    }) match {
      case Success(v) => v
      case Failure(_) => writeObject(obj)
    }

  def manageTimestamp(o: JsObject) = o.fields.toList match {
    case ("t", JsNumber(t)) :: ("i", JsNumber(i)) :: Nil =>
      Success(BSONTimestamp((t.toLong & 4294967295L) | (i.toLong << 32)))
    case _ => Failure(new IllegalArgumentException("Illegal timestamp value"))
  }

  def findSubtype(bytes: Array[Byte]) =
    ByteBuffer.wrap(bytes).getInt match {
      case 0x00 => Subtype.GenericBinarySubtype
      case 0x01 => Subtype.FunctionSubtype
      case 0x02 => Subtype.OldBinarySubtype
      case 0x03 => Subtype.UuidSubtype
      case 0x05 => Subtype.Md5Subtype
      // case 0X80 => Subtype.UserDefinedSubtype // Bug on reactivemongo
      case _    => throw new IllegalArgumentException("unsupported binary subtype")
    }

  val IsoDateTime = """^(\d{4,})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})\.(\d{3})Z$""".r
}