docs updated

Author: sfxcode

src/main/paradox/features/aggregation.md

@@ -1,4 +1,4 @@
-# Features - Aggregation
+# Feature - Aggregation
 
 ## Info
 

src/main/paradox/features/converter.md

@@ -1,4 +1,4 @@
-# Features - BSON Converter
+# Feature - BSON Converter
 
 ## Info
 

src/main/paradox/features/observable.md

@@ -0,0 +1,50 @@
+# Feature - Observable
+
+## Info
+
+@@@ note { title=MongoDB_Scala_Driver_Documentation }
+
+The MongoDB Scala Driver is an asynchronous and non blocking driver. Using the Observable model asynchronous events become simple, composable operations, freed from the complexity of nested callbacks.
+@@@
+
+See [MongoDB Scala Driver Documentation](http://mongodb.github.io/mongo-scala-driver/2.4/reference/observables/).
+
+
+## Dealing with Observables
+
+### As Future
+
+```scala
+  
+  def findAllRestaurants: Future[Seq[Restaurant]] = 
+      RestaurantDAO.find().asFuture()
+
+```
+
+### Result Functions
+
+Convert Observable to result object. Import mongo package is needed.
+
+Functions headResult anf resultList have an optional maxWait in seconds parameter (Default maxWait = 10 seconds).
+
+```scala
+  import com.sfxcode.nosql.mongo._
+
+  def restaurantsSize = RestaurantDAO.count().headResult()
+  
+  def findAllRestaurants = RestaurantDAO.find().resultList(maxWait = 20)
+
+```
+
+### Implicit Result Functions
+
+  Implicit result conversion to a given type. Import mongo package is needed.
+
+```scala 
+  import com.sfxcode.nosql.mongo._
+
+  def restaurantsSize: Long = RestaurantDAO.count()
+  
+  def findAllRestaurants:List[Restaurant] = RestaurantDAO.find()
+
+```

src/main/paradox/features/relationships.md

@@ -1,4 +1,4 @@
-# Features - Relationships
+# Feature - Relationships
 
 ## Info
 

src/main/paradox/index.md

@@ -49,6 +49,7 @@ libraryDependencies += "com.sfxcode.nosql" %% "simple-mongo" % $app-version$
  - [GridFSDAO CRUD](gridfs/crud.md)
  - [Feature Aggregation](features/aggregation.md)
  - [Feature Relationships](features/relationships.md)
+ - [Feature Observable](features/observable.md)
  - [Tutorial Setup](tutorial/setup.md)
  - [Tutorial Database](tutorial/database.md)
  - [Tutorial Functions](tutorial/functions.md)

src/main/scala/com/sfxcode/nosql/mongo/database/DatabaseProvider.scala

@@ -1,25 +1,29 @@
 package com.sfxcode.nosql.mongo.database
 
 import com.sfxcode.nosql.mongo.bson.codecs.CustomCodecProvider
-import org.bson.codecs.configuration.CodecRegistries.fromProviders
+import org.bson.codecs.configuration.CodecRegistries.{ fromProviders, fromRegistries }
 import org.bson.codecs.configuration.CodecRegistry
 import org.mongodb.scala.bson.codecs.DEFAULT_CODEC_REGISTRY
-import org.mongodb.scala.{ MongoClient, MongoDatabase }
+import org.mongodb.scala.{ MongoClient, MongoDatabase, Observable }
 
-case class DatabaseProvider(databaseName: String, registry: CodecRegistry = DEFAULT_CODEC_REGISTRY, client: MongoClient = MongoClient()) {
+class DatabaseProvider(databaseName: String, registry: CodecRegistry, client: MongoClient) {
 
-  import org.bson.codecs.configuration.CodecRegistries.fromRegistries
-  import org.mongodb.scala.bson.codecs.DEFAULT_CODEC_REGISTRY
+  val database: MongoDatabase = client.getDatabase(databaseName).withCodecRegistry(registry)
 
+  def listDatabaseNames(): Observable[String] = client.listDatabaseNames()
+
+}
+
+object DatabaseProvider {
   private val CustomRegistry = fromProviders(CustomCodecProvider())
+  private val codecRegistry: CodecRegistry = fromRegistries(CustomRegistry, DEFAULT_CODEC_REGISTRY)
 
-  val codecRegistry: CodecRegistry = {
-    if (registry == DEFAULT_CODEC_REGISTRY)
-      fromRegistries(registry, CustomRegistry)
-    else
-      fromRegistries(registry, CustomRegistry, DEFAULT_CODEC_REGISTRY)
+  def apply(databaseName: String): DatabaseProvider = {
+    new DatabaseProvider(databaseName, codecRegistry, MongoClient())
   }
 
-  val database: MongoDatabase = client.getDatabase(databaseName).withCodecRegistry(codecRegistry)
+  def apply(databaseName: String, registry: CodecRegistry, client: MongoClient = MongoClient()): DatabaseProvider = {
+    new DatabaseProvider(databaseName, fromRegistries(registry, CustomRegistry, DEFAULT_CODEC_REGISTRY), client)
+  }
 
-}
+}

src/main/scala/com/sfxcode/nosql/mongo/gridfs/Base.scala

@@ -21,8 +21,7 @@ abstract class Base extends LazyLogging {
   }
 
   def downloadToStream(oid: ObjectId, outputPath: Path, openOptions: Seq[OpenOption] = List(StandardOpenOption.CREATE, StandardOpenOption.WRITE)): Observable[Long] = {
-    var result: Long = -1
-    var streamToDownloadTo: AsynchronousFileChannel = AsynchronousFileChannel.open(outputPath, openOptions: _*)
+    val streamToDownloadTo: AsynchronousFileChannel = AsynchronousFileChannel.open(outputPath, openOptions: _*)
     gridfsBucket.downloadToStream(oid, channelToOutputStream(streamToDownloadTo))
   }
 

src/main/scala/com/sfxcode/nosql/mongo/package.scala

@@ -6,13 +6,13 @@ import com.sfxcode.nosql.mongo.operation.ObservableIncludes
 import org.bson.BsonValue
 import org.bson.types.ObjectId
 import org.mongodb.scala.bson.conversions.Bson
-import org.mongodb.scala.gridfs.{ GridFSFile, GridFSFindObservable }
-import org.mongodb.scala.{ Document, FindObservable, MongoDatabase, Observable }
+import org.mongodb.scala.gridfs.{GridFSFile, GridFSFindObservable}
+import org.mongodb.scala.{Document, FindObservable, MongoDatabase, Observable, ObservableImplicits}
 
 import scala.collection.JavaConverters._
 import scala.language.implicitConversions
 
-package object mongo extends ObservableIncludes {
+package object mongo extends ObservableIncludes with ObservableImplicits {
 
   implicit def observableToResult[T](obs: Observable[T]): T = obs.headResult()
 
@@ -58,17 +58,17 @@ package object mongo extends ObservableIncludes {
     BsonConverter.asMapList(documents)
   }
 
+  // ObjectId
   implicit def stringToObjectId(str: String): ObjectId = new ObjectId(str)
 
   implicit def documentToObjectId(doc: Document): ObjectId = doc.getObjectId("_id")
 
   // gridfs
 
-  implicit def gridFSindObservableToFiles(observable:GridFSFindObservable):List[GridFSFile] = observable.resultList()
+  implicit def gridFSFindObservableToFiles(observable: GridFSFindObservable): List[GridFSFile] = observable.resultList()
 
+  implicit def gridFSFileToObjectId(file: GridFSFile): ObjectId = file.getObjectId
 
-  implicit def gridfSFileToObjectId(file: GridFSFile): ObjectId = file.getObjectId
-
-  implicit def gridfSFileToBSonIdValue(file: GridFSFile): BsonValue = file.getId
+  implicit def gridFSFileToBSonIdValue(file: GridFSFile): BsonValue = file.getId
 
 }

src/test/scala/com/sfxcode/nosql/mongo/demo/restaurant/RestaurantDemoDatabaseFunctions.scala

@@ -8,7 +8,6 @@ import com.sfxcode.nosql.mongo.demo.restaurant.RestaurantDemoDatabase._
 import com.sfxcode.nosql.mongo._
 // #import
 
-
 trait RestaurantDemoDatabaseFunctions {
 
   // #trait

src/test/scala/com/sfxcode/nosql/mongo/gridfs/GridFSDatabaseSpec.scala

@@ -18,13 +18,13 @@ class GridFSDatabaseSpec extends Specification with GridfsDatabaseFunctions with
 
     }
 
-    "find files by metadata valuein" in {
+    "find files by metadata value in" in {
       val fileName = "scala-logo.jpg"
 
       var files = findImages("group", "unknown")
       files must haveSize(0)
 
-      files = findImages("group", "templates")
+      files = findImages("group", "logos")
       files must haveSize(1)
     }