Add software that allows for specification of both the dat directory as

well as the directory for the dat secrets.

Author: brandonedens

index.js

@@ -18,6 +18,7 @@ module.exports = createDat
  * @param {Boolean} [opts.createIfMissing = true] - Create storage if it does not exit.
  * @param {Boolean} [opts.errorIfExists = false] - Error if storage exists.
  * @param {Boolean} [opts.temp = false] - Use random-access-memory for temporary storage
+ * @param {string} [opts.secretDir] - Directory for storage of secrets
  * @param {function(err, dat)} cb - callback that returns `Dat` instance
  * @see defaultStorage for storage information
  */

lib/storage.js

@@ -16,14 +16,15 @@ module.exports = defaultStorage
  *   Object is a hyperdrive storage object `{metadata: fn, content: fn}`.
  * @param {object} [opts] - options
  * @param {Boolean} [opts.temp] - Use temporary storage (random-access-memory)
+ * @param {string} [opts.secretDir] - Directory for storage of secrets.
  * @returns {object} hyperdrive storage object
  */
 function defaultStorage (storage, opts) {
   // Use custom storage or ram
   if (typeof storage !== 'string') return storage
   if (opts.temp) return ram
   if (opts.latest === false) {
-    // Store as SLEEP files inluding content.data
+    // Store as SLEEP files including content.data
     return {
       metadata: function (name, opts) {
         // I don't think we want this, we may get multiple 'ogd' sources
@@ -39,17 +40,23 @@ function defaultStorage (storage, opts) {
   try {
     // Store in .dat with secret in ~/.dat
     if (fs.statSync(storage).isDirectory()) {
-      return datStore(storage)
+      if (typeof opts.secretDir !== 'undefined') {
+        fs.statSync(opts.secretDir).isDirectory()
+      }
+      return datStore(storage, opts)
     }
   } catch (e) {
     // Does not exist, make dir
     try {
       fs.mkdirSync(storage)
+      if (typeof opts.secretDir !== 'undefined') {
+        fs.mkdirSync(opts.secretDir)
+      }
     } catch (e) {
       // Invalid path
       throw new Error('Invalid storage path')
     }
-    return datStore(storage)
+    return datStore(storage, opts)
   }
   error()
 

readme.md

@@ -102,24 +102,31 @@ We'll go through what these are for and a few of the common usages of each eleme
 
 ### Storage
 
-Every dat archive has **storage**, this is the required first argument for dat-node. By default, we use [dat-storage](http://github.com/datproject/dat-storage) which stores the secret key in `~/.dat/` and the rest of the ddata in `dir/.dat`. Other common options are:
+Every dat archive has **storage**, this is the required first argument for dat-node. By default, we use [dat-storage](http://github.com/datproject/dat-storage) which stores the secret key in `~/.dat/` and the rest of the data in `dir/.dat`. Other common options are:
 
 * **Persistent storage**: Stored files in `/my-dir` and metadata in `my-dir/.dat` by passing `/my-dir` as the first argument.
 * **Temporary Storage**: Use the `temp: true` option to keep metadata stored in memory.
+* **Secret Key Dir**: Specify secretDir in the second opts argument in the form of {secretDir: '/my-secrets'} to store files
+  in /my-dir and secrets in /my-secrets respectively.
 
 ```js
 // Permanent Storage
 Dat('/my-dir', function (err, dat) {
   // Do Dat Stuff
 })
 
+// Secret Storage
+Dat('/my-dir', {secretDir: '/my-secrets'}, function (err, dat) {
+  // Do Dat Stuff
+})
+
 // Temporary Storage
 Dat('/my-dir', {temp: true}, function (err, dat) {
   // Do Dat Stuff
 })
 ```
 
-Both of these will import files from `/my-dir` when doing `dat.importFiles()` but only the first will make a `.dat` folder and keep the metadata on disk.
+All of these will import files from `/my-dir` when doing `dat.importFiles()` but only the first two will make a `.dat` folder and keep the metadata on disk.
 
 The storage argument can also be passed through to hyperdrive for more advanced storage use cases.
 

test/download.js

@@ -62,6 +62,28 @@ test('download: Download with default opts', function (t) {
   })
 })
 
+test('download: Download with secretDir opt', function (t) {
+  shareFixtures(function (err, shareKey, closeShare) {
+    t.error(err, 'error')
+
+    tmpDir(function (err, downDir, cleanup) {
+      t.error(err, 'error')
+
+      tmpDir(function (err, downSecretDir, cleanup) {
+        t.error(err, 'error')
+
+        Dat(downDir, {secretDir: downSecretDir, key: shareKey}, function (err, dat) {
+          t.error(err, 'error')
+          t.ok(dat, 'callsback with dat object')
+          t.ok(dat.key, 'has key')
+          t.ok(dat.archive, 'has archive')
+          t.notOk(dat.writable, 'archive not writable')
+        })
+      })
+    })
+  })
+})
+
 // TODO:
 // rest of download tests
 // tests will be a lot better with some download-finished type check