initial commit

Author: pooya parsa

.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/node
+    steps:
+      # Checkout repository
+      - checkout
+
+      # Restore cache
+      - restore_cache:
+          key: yarn-{{ checksum "yarn.lock" }}
+
+      # Install dependencies
+      - run:
+          name: Install Dependencies
+          command: NODE_ENV=dev yarn
+
+      # Keep cache
+      - save_cache:
+          key: yarn-{{ checksum "yarn.lock" }}
+          paths:
+            - "node_modules"
+
+      # Lint
+      - run:
+          name: Lint
+          command: yarn lint
+
+      # Test
+      - run:
+          name: Tests
+          command: yarn jest
+
+      # Coverage
+      - run:
+          name: Coverage
+          command: yarn codecov

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[{package.json,*.yml,*.cjson}]
+indent_style = space
+indent_size = 2

.eslintrc.yml

@@ -0,0 +1 @@
+extends: standard

.gitignore

@@ -0,0 +1,5 @@
+.vscode
+node_modules
+*.log
+.DS_Store
+coverage

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 - Pooya Parsa <[email protected]>
+
+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,104 @@
+# 🇭TTP 🇫ilesystem
+
+[![Standard JS][standard-src]][standard-href]
+[![david dm][david-src]][david-href]
+[![codecov][codecov-src]][codecov-href]
+[![circleci][circleci-src]][circleci-href]
+
+[![npm version][npm-v-src]][npm-v-href]
+[![npm downloads][npm-dt-src]][npm-dt-href]
+[![package phobia][packagephobia-src]][packagephobia-href]
+
+### **NOTE** This module is under development and not ready for any production use!
+
+Expose filesystem via HTTP and access it from the other side!
+
+This module works best with [memory-fs](https://github.com/webpack/memory-fs).
+
+## Install
+
+Install package:
+
+```bash
+yarn add httpfs
+```
+
+OR
+
+```bash
+npm install httpfs
+```
+
+## Server
+
+Serving real fs is not a good idea. In this example we serve a virtual filesystem.
+
+```js
+const HTTPFSMiddleware = require('httpfs/lib/middleware')
+const express = require('express')
+const MFS = require('memory-fs')
+
+// Create a new express app listening on port 8080
+const app = express()
+app.listen(8080)
+
+// Create a new Virtual FileSystem with a test file
+const mfs = new MFS()
+mfs.mkdirpSync('/test')
+mfs.writeFileSync('/test/file.txt', 'Works!')
+
+// Create and register fs middleware
+app.use('/mfs', HTTPFSMiddleware(mfs))
+```
+
+You can now browse filesystem via a normal browser via http://localhost:8080/mfs/
+
+## Client
+
+Supported methods:
+
+- `exists(path): Promise<Boolean>`
+- `readFile(path): Promise<String>`
+
+```js
+const HTTPFSAClient = require('httpfs/lib/client')
+
+const fs = new HTTPFSAClient({
+  endpoint: 'http://localhost:8080/mfs'
+})
+
+fs.readFile('/test/file.txt').then((contents) => {
+  console.log('File contents:', contents)
+})
+```
+
+### Options
+
+- `endpoint`: HTTP Endpoint of server
+- `maxAge`: Time for cache
+
+## License
+
+MIT. Made with 💖
+
+<!-- Refs -->
+[standard-src]: https://flat.badgen.net/badge/code%20style/standard/green
+[standard-href]: https://standardjs.com
+
+[npm-v-src]: https://flat.badgen.net/npm/v/httpfs/latest
+[npm-v-href]: https://npmjs.com/package/httpfs
+
+[npm-dt-src]: https://flat.badgen.net/npm/dt/httpfs
+[npm-dt-href]: https://npmjs.com/package/httpfs
+
+[packagephobia-src]: https://flat.badgen.net/packagephobia/install/httpfs
+[packagephobia-href]: https://packagephobia.now.sh/result?p=httpfs
+
+[david-src]: https://flat.badgen.net/david/dep/jsless/httpfs
+[david-href]: https://david-dm.org/jsless/httpfs
+
+[codecov-src]: https://flat.badgen.net/codecov/c/github/jsless/httpfs/master
+[codecov-href]: https://codecov.io/gh/jsless/httpfs
+
+[circleci-src]: https://flat.badgen.net/circleci/github/jsless/httpfs/master
+[circleci-href]: https://circleci.com/gh/jsless/httpfs

jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  'testEnvironment': 'node',
+  'collectCoverage': true,
+  'collectCoverageFrom': [
+    'lib/**/*.js'
+  ]
+}

lib/client.js

@@ -0,0 +1,33 @@
+const fetch = require('node-fetch')
+const pMemoize = require('p-memoize')
+
+module.exports = class HTTPFSClient {
+  constructor ({ endpoint, maxAge = 1000 }) {
+    this.endpoint = endpoint.replace(/\/$/, '')
+    this._request = pMemoize(this._request, { maxAge })
+  }
+
+  _url (path) {
+    return this.endpoint + path
+  }
+
+  async _request (path, options) {
+    const url = this._url(path)
+    const res = await fetch(url, options)
+    return res
+  }
+
+  async exists (path) {
+    const res = await this._request(path)
+    switch (res.status) {
+      case 200: return true
+      case 404: return false
+      default: throw new Error('Invalid status ' + res.status)
+    }
+  }
+
+  async readFile (path) {
+    const res = await this._request(path)
+    return res.text()
+  }
+}

lib/middleware.js

@@ -0,0 +1,32 @@
+module.exports = function HTTPFSMiddleware (mfs) {
+  return (req, res) => {
+    // Resource path is url relative to /mfs
+    const resourcePath = req.url
+
+    // Stat path
+    let stat
+    try {
+      stat = mfs.statSync(resourcePath)
+    } catch (e) {
+      res.statusCode = 404
+      return res.end('No such a file or directory: ' + resourcePath)
+    }
+
+    // Directory listing
+    if (stat.isDirectory()) {
+      return res.end(`
+        <html>
+          <body>
+          <h1>Index of ${resourcePath}</h1>
+          <ul>
+            ${mfs.readdirSync(resourcePath).map(link => `<li><a href="${link}/">${link}</a></li>`).join('\n')}
+          </ul>
+          </body>
+        </html>
+      `)
+    }
+
+    // Serve file
+    res.end(mfs.readFileSync(resourcePath))
+  }
+}

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "httpfs",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Expose filesystem via HTTP and access it from the other side!",
+  "repository": "jesless/httpfs",
+  "contributes": [
+    "Pooya Parsa <[email protected]>"
+  ],
+  "scripts": {
+    "lint": "eslint lib",
+    "test": "npm run lint && npm run jest",
+    "jest": "jest",
+    "release": "standard-version && git push --follow-tags && npm publish",
+    "prepare": "npm run test"
+  },
+  "files": [
+    "lib"
+  ],
+  "devDependencies": {
+    "codecov": "^3.1.0",
+    "eslint": "^5.9.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-jest": "^22.1.0",
+    "eslint-plugin-node": "^8.0.0",
+    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-standard": "^4.0.0",
+    "express": "^4.16.4",
+    "jest": "^24.0.0",
+    "memory-fs": "^0.4.1",
+    "standard-version": "^4.4.0"
+  },
+  "dependencies": {
+    "errno": "^0.1.7",
+    "node-fetch": "^2.3.0",
+    "p-memoize": "^2.1.0"
+  }
+}