3.0.0 - make compatible with abstract-blob-store api

Author: max-mapper

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+.DS_Store

index.js

@@ -3,6 +3,7 @@ var request = require('request')
 var concat = require('concat-stream')
 var mime = require('mime-types')
 var through = require('through2')
+var duplexify = require('duplexify')
 var formEncoder = require('form-urlencoded')
 var debug = require('debug')('google-drive-blobs')
 
@@ -83,8 +84,10 @@ Blobs.prototype.createWriteStream = function(options, cb) {
         var response = JSON.parse(body)
         self.addProperty(response.id, 'hash', response.md5Checksum, function(err, resp, props) {
           if (err) return cb(err)
+          if (resp.statusCode > 299) return cb(new Error(JSON.stringify(props)))
           response.hash = response.md5Checksum
-          response.size = response.fileSize
+          response.size = +response.fileSize
+          if (process.env['DEBUG']) debug('createWriteStream done', JSON.stringify(response))
           cb(null, response)
         })
       })
@@ -101,25 +104,28 @@ Blobs.prototype.addProperty = function(id, key, val, cb) {
 
   var reqOpts = {
     url: baseURL + 'files/' + id + '/properties',
-    json: hashProp
+    json: hashProp,
+    contentType: 'application/json'
   }
 
   return this.request(reqOpts, cb)
 }
 
-Blobs.prototype.createReadStream = function(hash) {
+Blobs.prototype.createReadStream = function(opts) {
   var self = this
-  var proxy = through()
-  
-  self.get(hash, function(err, file) {
-    if (err) return proxy.emit('error', err)
-    self.request({
+  var duplex = duplexify()
+  debug('createReadStream', JSON.stringify(opts))
+  self.get(opts.hash, function(err, file) {
+    if (err) return duplex.destroy(err)
+    if (!file) return duplex.destroy(new Error('Blob not found'))
+    var req = self.request({
       url: file.downloadUrl,
       method: 'GET',
-    }).pipe(proxy)
+    })
+    duplex.setReadable(req)
   })
 
-  return proxy
+  return duplex
 }
 
 Blobs.prototype.mkdir = function(filename, opts, cb) {
@@ -153,8 +159,12 @@ Blobs.prototype.request = function(opts, cb) {
   }
 
   if (opts.url) reqOpts.url = opts.url
-  
   return request(reqOpts, function(err, resp, body) {
+    if (process.env['DEBUG']) {
+      var bodyStr = body
+      if (bodyStr && typeof bodyStr.length === 'undefined') bodyStr = JSON.stringify(bodyStr)
+      debug(resp.statusCode, JSON.stringify(reqOpts), bodyStr)
+    }
     // token may have expired, refresh + retry
     if (resp.statusCode > 299) return self.refreshToken(function(err) {
       if (err) return cb(err)
@@ -181,18 +191,18 @@ Blobs.prototype.get = function(hash, cb) {
   })
 }
 
-Blobs.prototype.remove = function(hash, cb) {
+Blobs.prototype.remove = function(opts, cb) {
   var self = this
 
-  self.get(hash, function(err, file) {
+  self.get(opts.hash, function(err, file) {
     if (err) return cb(err)
     var reqOpts = {
       method: 'DELETE',
       url: baseURL + 'files/' + file.id
     }
 
     self.request(reqOpts, function(err, resp, results) {
-      if (err || resp.statusCode > 299) return cb(results)
+      if (err || resp.statusCode > 299) return cb(results || new Error('could not delete'))
       cb(null)
     })
   })

package.json

@@ -1,19 +1,22 @@
 {
   "name": "google-drive-blobs",
-  "version": "2.0.1",
-  "description": "a simple content-addressable blob store API on top of google drive",
+  "version": "3.0.0",
+  "description": "a simple content-addressable streaming blob store API on top of google drive",
   "main": "index.js",
   "scripts": {
     "test": "node test.js"
   },
   "author": "max ogden",
-  "license": "bSD",
+  "license": "BSD",
   "dependencies": {
     "debug": "^0.8.1",
+    "duplexify": "^3.1.0",
     "form-urlencoded": "0.0.6",
     "mime-types": "^1.0.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "abstract-blob-store": "^1.0.4"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/maxogden/google-drive-blobs.git"

readme.md

@@ -2,6 +2,8 @@
 
 a simple content-addressable blob store API on top of google drive
 
+compatible with the [abstract-blob-store](https://github.com/maxogden/abstract-blob-store) API and passes its test suite
+
 [![NPM](https://nodei.co/npm/google-drive-blobs.png)](https://nodei.co/npm/google-drive-blobs/)
 
 ## API
@@ -22,16 +24,20 @@ returns a writable stream that you can pipe data to.
 
 `cb` will be called with `(err, response)` where `response` is the response metadata
 
-### blobs.createReadStream(md5)
+### blobs.createReadStream(opts)
+
+opts should be `{hash: md5}`
 
 returns a readable stream of data for the first file in your drive whose md5 checksum matches the `md5` argument
 
 ### blobs.get(md5, cb)
 
 gets google drive metadata for the first file in your drive whose md5 checksum matches the `md5` argument
 
-### blobs.remove(md5, cb)
+### blobs.remove(opts, cb)
 
+opts should be `{hash: md5}`
+ 
 deletes file by md5
 
 ### blobs.addProperty(fileId, key, val, cb)

test.js

@@ -3,15 +3,29 @@ var path = require('path')
 var crypto = require('crypto')
 var test = require('tape')
 var concat = require('concat-stream')
+var abstractBlobTests = require('abstract-blob-store/tests')
 var gdb = require('./')
 
 // assumes you are using npm install googleauth -g
 var tokens = JSON.parse(fs.readFileSync(path.join(process.env.HOME, '.config', 'googleauth.json')))
-tokens.client_id = process.env['GOOGLE_CLIENT'] || process.env[3]
-tokens.client_secret = process.env['GOOGLE_SECRET'] || process.env[4]
+tokens.client_id = process.env['GOOGLEAUTH_CLIENT'] || process.env[3]
+tokens.client_secret = process.env['GOOGLEAUTH_SECRET'] || process.env[4]
 
 var testmd5 = crypto.createHash('md5').update(fs.readFileSync('./test.js')).digest('hex')
 
+var common = {
+  setup: function(t, cb) {
+    var store = gdb(tokens)
+    cb(null, store)
+  },
+  teardown: function(t, store, blob, cb) {
+    if (blob) store.remove(blob, cb)
+    else cb()
+  }
+}
+
+abstractBlobTests(test, common)
+
 test('constructor does not throw', function(t) {
   var blobs = gdb()
   t.ok(blobs, 'constructed')
@@ -20,37 +34,37 @@ test('constructor does not throw', function(t) {
 
 test('uploads a blob', function(t) {
   var blobs = gdb(tokens)
-  
+
   var ws = blobs.createWriteStream({filename: 'test.js'}, function(err, resp) {
     t.false(err, 'should not error')
     if (err) console.error(err)
     t.equal(resp.hash, testmd5)
     t.end()
   })
-  
+
   fs.createReadStream('./test.js').pipe(ws)
 })
 
 test('gets blob metadata by md5', function(t) {
   var blobs = gdb(tokens)
-  
+
   blobs.get(testmd5, function(err, file) {
     t.false(err, 'no err')
     t.equal(file.title, 'test.js')
     t.end()
   })
 })
- 
+
 test('gets a blob', function(t) {
   var blobs = gdb(tokens)
-  
-  var ws = blobs.createReadStream(testmd5)
-  
+
+  var ws = blobs.createReadStream({hash: testmd5})
+
   ws.on('error', function(e) {
-    t.false(e, 'should not error')
+    t.error(e)
     t.end()
   })
-  
+
   ws.pipe(concat(function(contents) {
     t.equal(contents.toString(), fs.readFileSync('./test.js').toString(), 'file contents match')
     t.end()
@@ -59,14 +73,14 @@ test('gets a blob', function(t) {
 
 test('deletes a blob', function(t) {
   var blobs = gdb(tokens)
-  
-  var ws = blobs.remove(testmd5, function(err) {
+
+  var ws = blobs.remove({hash: testmd5}, function(err) {
     t.false(err, 'snould not err')
     blobs.get(testmd5, function(err, file) {
       t.false(err, 'should not err')
       t.false(file, 'should have no results')
       t.end()
     })
   })
-  
+
 })