Migrate from iamnapo/cbm-api

Author: iamnapo

.eslintignore

@@ -0,0 +1 @@
+lib/

.gitignore

@@ -0,0 +1,58 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

.npmignore

@@ -0,0 +1,2 @@
+.travis.yml
+codecov.yml

.travis.yml

@@ -0,0 +1,11 @@
+before_install:
+- npm update -g npm
+cache:
+  directories:
+  - node_modules
+language: node_js
+node_js:
+- node
+notifications:
+  email: false
+sudo: false

LICENSE

@@ -0,0 +1,165 @@
+# cbm-api    [![Build Status](https://travis-ci.org/cbmjs/cbm-api.svg?branch=master)](https://travis-ci.org/cbmjs/cbm-api) [![codecov](https://codecov.io/gh/cbmjs/cbm-api/branch/master/graph/badge.svg)](https://codecov.io/gh/cbmjs/cbm-api) [![npm version](https://badge.fury.io/js/cbm-api.svg)](https://badge.fury.io/js/cbm-api)
+
+Node.js interface to the CallByMeaning network server. For further information, consult the website of the server-side project: [CallByMeaning](https://github.com/cbmjs/CallByMeaning).
+
+## Introduction
+
+To require the module in a project, we can use the expression:
+
+```javascript
+const CallByMeaning = require('cbm-api');
+```
+
+## Getting Started
+
+The module exports a single constructor which can be used to open an API connection. Simply call it and store the expression result in a variable:
+
+``` javascript
+const cbm = new CallByMeaning();
+```
+
+In case that you are running your own copy of the CallByMeaning server, the constructor takes the hostname of the server as an optional argument. The default option evaluates to "[https://call-by-meaning.herokuapp.com](https://call-by-meaning.herokuapp.com/)".
+
+```javascript
+CallByMeaning(host);
+```
+
+Example:
+
+```javascript
+const cbm = new CallByMeaning('http://localhost:3000');
+```
+
+We can then use the following six methods to query the CallByMeaning API:
+
+## Methods
+
+### `.lookup(uri[, type])`
+
+This method expects a valid CallByMeaning URI as its first argument.
+`type` is an (optional) string that specifies the type of the GET request. It can have the keys `c`, `f` or `r`. This method is asynchronous and returns a promise that, when fulfilled, returns an object with two properties.`statusCode` which contains the status code of the request and `body` that holds the result set from the query.
+
+Example code:
+
+```javascript
+cbm.lookup('time', 'c').then((result) => {
+  if (result.statusCode === 200) console.log('Success!');
+  // insert code here
+}).catch((error) => console.error(error));
+```
+
+### `.getURI(text)`
+
+This method finds out what the CallByMeaning URI is for a given text, applying steps such as reducing English words to their root form and removing special characters.
+
+Example code:
+
+```javascript
+cbm.getURI('a (big) dog!'); //-> big_dog
+```
+
+### `.search(...args)`
+
+This method finds all the functions that correspond to given nodes and returns an array containing them. It can be called with two different ways. Either by providing only an object containing the search parameters or by providing the parameters themselves as arguments. This method is asynchronous and returns a promise that, when fulfilled, returns an object with two properties.`statusCode` which contains the status code of the request and `body` that holds the result set from the query. For a full overview of search parameters, check the [documentation](https://github.com/cbmjs/CallByMeaning/blob/master/docs/GETBYMEANING.md).
+
+Example code:
+
+```javascript
+cbm.search({'inputNodes': 'date', 'outputNodes': 'time'}).then((result) => {
+  if (result.statusCode === 200) console.log('Success!');
+  // insert code here
+}).catch((error) => console.error(error));
+
+cbm.search('date', 'time'}).then((result) => {
+  if (result.statusCode === 200) console.log('Success!');
+  // insert code here
+}).catch((error) => console.error(error));
+```
+
+### `.call(...args)`
+
+This method takes the search parameters and after finding an appropriate function - a function with the same concepts as inputs and outputs, but (maybe) in different units, that is - executes it and returns the result. If the (optional) argument `returnCode` is set to true, it instead returns the .js file's name and the description of the function. It can be called with two different ways. Either by providing only an object containing the search parameters (and maybe the optional returnCode as a second argument) or by providing the parameters themselves as arguments. This method is asynchronous and returns a promise that, when fulfilled, returns an object with two properties.`statusCode` which contains the status code of the request and `body` that holds the result set from the query. For a full overview of search parameters, check the [documentation](https://github.com/cbmjs/CallByMeaning/blob/master/docs/CALLBYMEANING.md).
+
+Example code:
+
+```javascript
+const bday = new Date(1994, 2, 24);
+
+cbm.call({
+  'inputNodes': 'date',
+  // 'date' doesn't have a unit, so we can omit it, or pass {'inputUnits': null} or {'inputUnits': []} or {'inputUnits: '-'} or {'inputUnits': 'date'}
+  'inputVars': bday,
+  'outputNodes': 'time',
+  'outputUnits': 'seconds'
+}.then((result) => {
+  if (result.statusCode === 200) console.log('Success!');
+  // insert code here
+}).catch((error) => console.error(error));
+
+cbm.call('date', null, 'time', 'seconds').then(...);
+cbm.call('date', null, 'time', 'seconds', true).then(...); // If we want the source code
+```
+
+### `.getCode(fileName)`
+
+This method acts as a small helper to the usage of `.search` and `.call` methods. It takes the `name` of a .js file in the server and returns its code in plain text.
+
+Example code:
+
+```javascript
+let code = cbm.getCode('getTime.js');
+const getTime = eval(code);
+getTime();
+```
+
+## `.create(params[, type])`
+
+This method creates a document in the server if it doesn't exist or modifies it, if it does. It accepts a [params](https://github.com/cbmjs/CallByMeaning/blob/master/docs/MODELS.md) object with the document parameters as its first argument and a string containing the type of the document. It can be one of `node`, `function`, `relation`. If it isn't provided, it defaults to `node`. This method is asynchronous and returns a promise that, when fulfilled, returns a boolean, depending of its success.
+
+Example code:
+
+```javascript
+let params = {
+  name: 'aNode',
+  desc: 'aDescription',
+};
+cbm.create(params);
+```
+
+```javascript
+let params = {
+  name: 'aFunction',
+  desc: 'aDescription',
+  argsNames: 'someArg',
+  argsUnits: 'someUnit',
+  returnsNames: 'someReturn',
+  returnsUnits: 'someUnit',
+};
+cbm.create(params, 'function');
+
+params.codeFile = __dirname.concat('/someFile.js');
+(async () => {
+  let res = await cbm.create(params, 'function');
+  return res;
+})().then((res) => console.log(res));
+```
+
+```javascript
+let params = {
+  name: 'unitConversion',
+  start: 'meters',
+  end: 'feet',
+  mathRelation: '0.3 * start'
+}
+cbm.create(params, 'relation')
+```
+
+## Unit Tests
+
+Run tests via the command `npm test`
+
+---
+
+## License
+
+[AGPL-3.0 license](./LICENSE).

README.md

@@ -0,0 +1,2 @@
+ignore:
+- lib/.*

codecov.yml

@@ -0,0 +1,18 @@
+class CallByMeaning {
+  constructor(host) {
+    this.host = 'https://call-by-meaning.herokuapp.com';
+    if (host) this.host = String(host);
+  }
+  fullAddress_(path) {
+    return this.host.concat(path);
+  }
+}
+
+CallByMeaning.prototype.lookup = require('./src/lookup');
+CallByMeaning.prototype.getURI = require('./src/getURI');
+CallByMeaning.prototype.search = require('./src/search');
+CallByMeaning.prototype.call = require('./src/call');
+CallByMeaning.prototype.getCode = require('./src/getCode');
+CallByMeaning.prototype.create = require('./src/create');
+
+module.exports = CallByMeaning;

index.js

@@ -0,0 +1,92 @@
+/**
+* JSONfn - javascript (both node.js and browser) plugin to stringify,
+*          parse and clone objects with Functions, Regexp and Date.
+*
+* Version - 1.1.0
+* Copyright (c) Vadim Kiryukhin
+* vkiryukhin @ gmail.com
+* http://www.eslinstructor.net/jsonfn/
+*
+* Licensed under the MIT license ( http://www.opensource.org/licenses/mit-license.php )
+*
+*   USAGE:
+*     browser:
+*         JSONfn.stringify(obj);
+*         JSONfn.parse(str[, date2obj]);
+*         JSONfn.clone(obj[, date2obj]);
+*
+*     nodejs:
+*       var JSONfn = require('path/to/json-fn');
+*       JSONfn.stringify(obj);
+*       JSONfn.parse(str[, date2obj]);
+*       JSONfn.clone(obj[, date2obj]);
+*
+*
+*     @obj      -  Object;
+*     @str      -  String, which is returned by JSONfn.stringify() function;
+*     @date2obj - Boolean (optional); if true, date string in ISO8061 format
+*                 is converted into a Date object; otherwise, it is left as a String.
+*/
+
+(function (exports) {
+  'use strict';
+
+  exports.stringify = function (obj) {
+
+    return JSON.stringify(obj, function (key, value) {
+      var fnBody;
+      if (value instanceof Function || typeof value == 'function') {
+
+
+        fnBody = value.toString();
+
+        if (fnBody.length < 8 || fnBody.substring(0, 8) !== 'function') { //this is ES6 Arrow Function
+          return '_NuFrRa_' + fnBody;
+        }
+        return fnBody;
+      }
+      if (value instanceof RegExp) {
+        return '_PxEgEr_' + value;
+      }
+      return value;
+    });
+  };
+
+  exports.parse = function (str, date2obj) {
+
+    var iso8061 = date2obj ? /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/ : false;
+
+    return JSON.parse(str, function (key, value) {
+      var prefix;
+
+      if (typeof value != 'string') {
+        return value;
+      }
+      if (value.length < 8) {
+        return value;
+      }
+
+      prefix = value.substring(0, 8);
+
+      if (iso8061 && value.match(iso8061)) {
+        return new Date(value);
+      }
+      if (prefix === 'function') {
+        return eval('(' + value + ')');
+      }
+      if (prefix === '_PxEgEr_') {
+        return eval(value.slice(8));
+      }
+      if (prefix === '_NuFrRa_') {
+        return eval(value.slice(8));
+      }
+
+      return value;
+    });
+  };
+
+  exports.clone = function (obj, date2obj) {
+    return exports.parse(exports.stringify(obj), date2obj);
+  };
+
+}(exports));