dat-link-resolve

Author: joehand

.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - '4'
+  - '6'
+cache:
+  directories:
+    - node_modules

LICENSE.md

@@ -0,0 +1,9 @@
+# [MIT License](https://spdx.org/licenses/MIT)
+
+Copyright (c) 2017 Joe Hand <joe@hand.email>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# dat-link-resolve
+
+resolve urls, links to a dat key using common methods
+
+[![npm][npm-image]][npm-url]
+[![travis][travis-image]][travis-url]
+[![standard][standard-image]][standard-url]
+
+### Supports
+
+* Common dat key representations (`dat://`, etc.)
+* URLs with keys in them (`datproject.org/6161616161616161616161616161616161616161616161616161616161616161`)
+* `hyperdrive-key` or `dat-key` headers
+* Url to JSON http request that returns `{key: <dat-key>}`
+
+## Install
+
+```
+npm install dat-link-resolve
+```
+
+## Usage
+
+```js
+var datResolve = require('dat-link-resolve')
+
+datResolve(link, function (err, key) {
+  console.log('found key', key)
+})
+```
+
+## API
+
+### `datResolve(link, callback(err, key))`
+
+Link can be string or buffer.
+
+Resolution order:
+
+1. Validate buffers or any strings with 64 character hashes in them via [dat-encoding](https://github.com/juliangruber/dat-encoding)
+2. Check headers in http request
+3. Check JSON request response for `key`
+
+## Contributing
+
+Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
+
+## License
+
+[MIT](LICENSE.md)
+
+[npm-image]: https://img.shields.io/npm/v/dat-link-resolve.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/dat-link-resolve
+[travis-image]: https://img.shields.io/travis/joehand/dat-link-resolve.svg?style=flat-square
+[travis-url]: https://travis-ci.org/joehand/dat-link-resolve
+[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
+[standard-url]: http://npm.im/standard

index.js

@@ -0,0 +1,51 @@
+var assert = require('assert')
+var stringKey = require('dat-encoding').toStr
+var nets = require('nets')
+var debug = require('debug')('dat-link-resolve')
+
+module.exports = resolve
+
+function resolve (link, cb) {
+  assert.ok(link, 'dat-link-resolve: link required')
+  assert.equal(typeof cb, 'function', 'dat-link-resolve: callback required')
+
+  var key = null
+
+  try {
+    // validates + removes dat://
+    // also works for http urls with keys in them
+    key = stringKey(link)
+    cb(null, key)
+  } catch (e) {
+    return lookup()
+  }
+
+  function lookup () {
+    var url = link.indexOf('http') > -1 ? link : 'http://' + link
+
+    // TODO: if TLD, check .well-known first
+
+    debug('lookup()', url)
+    nets({ url: url, json: true }, function (err, resp, body) {
+      if (err) return cb(err)
+      if (resp.statusCode !== 200) return cb(body.message)
+
+      // first check if key is in header response
+      key = resp.headers['hyperdrive-key'] || resp.headers['dat-key']
+      if (key) {
+        debug('Received key from http header:', key)
+        return cb(null, key)
+      }
+
+      // else fall back to parsing the body
+      try {
+        key = stringKey(body.url)
+        debug('Received key via json:', key)
+        if (key) return cb(null, key)
+      } catch (e) {
+        cb(new Error(e))
+      }
+      cb(new Error('Unable to lookup key from http link.'))
+    })
+  }
+}

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "dat-link-resolve",
+  "description": "resolve urls, links to a dat key",
+  "version": "1.0.0",
+  "author": "Joe Hand <joe@hand.email>",
+  "bugs": {
+    "url": "https://github.com/joehand/dat-link-resolve/issues"
+  },
+  "devDependencies": {
+    "standard": "*",
+    "tap-spec": "^4.0.2",
+    "tape": "^4.0.0"
+  },
+  "homepage": "https://github.com/joehand/dat-link-resolve",
+  "keywords": [
+    "dat"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joehand/dat-link-resolve.git"
+  },
+  "scripts": {
+    "test": "standard && tape test/*.js | tap-spec"
+  },
+  "dependencies": {
+    "dat-encoding": "^4.0.2",
+    "debug": "^2.6.6",
+    "nets": "^3.2.0"
+  }
+}

test/index.js

@@ -0,0 +1,25 @@
+var test = require('tape')
+var enc = require('dat-encoding')
+var datResolve = require('..')
+
+// Strings that do not require lookup
+var stringKeys = [
+  {type: 'valid', key: '6161616161616161616161616161616161616161616161616161616161616161'},
+  {type: 'valid', key: Buffer.from('6161616161616161616161616161616161616161616161616161616161616161', 'hex')},
+  {type: 'valid', key: 'dat://6161616161616161616161616161616161616161616161616161616161616161'},
+  {type: 'valid', key: 'datproject.org/6161616161616161616161616161616161616161616161616161616161616161'},
+  {type: 'valid', key: 'dat://6161616161616161616161616161616161616161616161616161616161616161/'},
+  {type: 'valid', key: 'datproject.org/6161616161616161616161616161616161616161616161616161616161616161/'},
+  {type: 'valid', key: 'host.com/whatever/6161616161616161616161616161616161616161616161616161616161616161'}
+]
+
+test('resolve key without http', function (t) {
+  t.plan(3 * 7) // 5 tests for 7 keys
+  stringKeys.forEach(function (key) {
+    datResolve(key.key, function (err, newKey) {
+      t.error(err, 'no error')
+      t.equal(newKey, '6161616161616161616161616161616161616161616161616161616161616161', 'link correct')
+      t.ok(enc.encode(newKey), 'valid key')
+    })
+  })
+})