Merge pull request #15 from algorithmiaio/revert-ts-pr

Revert "Merge pull request #13 from algorithmiaio/DEV-86"

Author: Nathan Lyle Black

.gitignore

@@ -1 +1,30 @@
-node_modules/
+tmp/
+
+# 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
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# Commenting this out is preferred by some people, see
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Users Environment Variables
+.lock-wscript

.npmignore

@@ -0,0 +1,5 @@
+contrib
+examples
+src
+gulpfile.js
+tmp

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anthony Nowell
+
+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,248 @@
+algorithmia.js
+==============
+
+A nodejs library for calling algorithms on Algorithmia.com with partial support for the DataAPI
+
+[![npm](https://img.shields.io/npm/v/algorithmia.svg?maxAge=2592000)]()
+
+## Getting started
+
+The official Algorithmia nodejs client is available on NPM.
+Install it for your project by adding `algorithmia` to your package.json:
+
+```bash
+npm install --save algorithmia
+```
+
+Then instantiate an Algorithmia client using your API key:
+
+```javascript
+var algorithmia = require("algorithmia");
+
+var client = algorithmia(process.env.ALGORITHMIA_API_KEY);
+```
+
+Now you are ready to call algorithms.
+
+## Calling algorithms
+
+The following examples of calling algorithms are organized by type of input/output which vary between algorithms.
+
+Note: a single algorithm may have different input and output types, or accept multiple types of input, so consult the algorithm's description for usage examples specific to that algorithm.
+
+### Text input/output
+
+Call an algorithm with text input by passing a string into the `pipe` method.
+The returned promise will be called with the response with the Algorithm completes (or when an error occurs).
+If the algorithm output is text, then the `get()` method on the response will return a string.
+
+```javascript
+client.algo("algo://demo/Hello/0.1.1")
+      .pipe("HAL 9000")
+      .then(function(response) {
+        console.log(response.get());
+      });
+// -> Hello HAL 9000
+```
+
+### JSON input/output
+
+Call an algorithm with JSON input by passing in a native JavaScript type;
+most of the time this will be an `Object` or an `Array` (though `Boolean`, `Number`, and `Null` are possible).
+Similarly, if the algorithm response is JSON, the `get()` method will return the appropriate native JavaScript type.
+
+```javascript
+client.algo("algo://WebPredict/ListAnagrams/0.1.0")
+      .pipe(["transformer", "terraforms", "retransform"])
+      .then(function(response) {
+        console.log(response.get());
+        // -> ["transformer","retransform"]
+      });
+```
+
+Alternatively, if you already have serialized JSON, you can call `pipeJson` with the raw JSON string.
+The following example makes the same API call as the previous example:
+
+```javascript
+client.algo("algo://WebPredict/ListAnagrams/0.1.0")
+      .pipeJson('["transformer", "terraforms", "retransform"]')
+```
+
+### Binary input/output
+
+Call an algorithm with binary input by passing a `Buffer` into the pipe method.
+Similarly, if the algorithm response is binary data, then the `get` method on the response will be a byte array.
+
+```javascript
+var buffer = fs.readFileSync("/path/to/bender.jpg");
+client.algo("opencv/SmartThumbnail")
+    .pipe(buffer)
+    .then(function(response) {
+        var buffer = response.get();
+        // -> Buffer(...)
+    });
+```
+
+Note: while it is possible to use `response.result` for text or JSON responses, in the case of a binary resonse,
+the `result` field will be base64-encoded. The `get()` method is recommended
+because it will return the correct type in all cases.
+
+### Error handling
+
+If an error occurs when calling an algorithm, the response will contain an error field that you can check:
+
+```javascript
+client.algo('util/whoopsWrongAlgo').pipe('Hello, world!')
+      .then(function(response) {
+          if(response.error) {
+            console.log("Error: " + response.error.message);
+          } {
+            console.log(response.get());
+          }
+      });
+```
+
+### Request options
+
+The Algorithmia API exposes parameters to configure algorithm requests including support
+for changing the timeout of indicating that the API should include stdout in the response.
+Currently, the node.js client exposes these as query paremeters to the algorithm URI:
+
+```javascript
+client.algo("algo://demo/Hello/0.1.1?timeout=10&stdout=true")
+      .pipe("HAL 9000")
+```
+
+Note: `stdout=true` is only supported if you have access to the algorithm source.
+
+## Working with data
+
+The Algorithmia client also provides a way to manage both Algorithmia hosted data and data from Dropbox or S3 accounts that you've connected to you Algorithmia account.
+
+### Create directories
+
+Create directories by instantiating a `Dir` object and calling `create()`:
+
+```javascript
+var robots = client.dir("data://.my/robots");
+robots.create(function(response) {
+    if(response.error) {
+        return console.log("Failed to create dir: " + response.error.message);
+    }
+    console.log("Created directory: " + robots.data_path);
+});
+```
+
+### Upload files to a directory
+
+Upload files by calling the `putFile` method a `Dir` object or `put` on a `File` object:
+
+```javascript
+var robots = client.dir("data://.my/robots");
+robots.putFile("/path/to/Optimus_Prime.png", function(response) {
+    if(response.error) {
+        return console.log("Failed to upload file: " + response.error.message);
+    }
+    console.log("File uploaded.");
+);
+```
+
+You can also write to a `File` using the `put` method with either a `string` or `Buffer` as input:
+
+```javascript
+var prime = client.file("data://.my/robots/Optimus_Prime.txt");
+prime.put("Leader of the Autobots", function(response) {
+    if(response.error) {
+        return console.log("Failed to upload file: " + response.error.message);
+    }
+    console.log("File uploaded.");
+);
+```
+
+### Download content from files
+
+Download files by calling `get` on a `File` object:
+
+```javascript
+var robots = client.dir("data://.my/robots");
+
+// Get a text file's contents as a string
+robots.file("T-800.txt").get(function(err, data) {
+    console.log(data);
+});
+
+/// Get a binary file's contents as a Buffer
+robots.file("T-800.jpg").get(function(err, data) {
+    console.log("Received " + data.length + " bytes.");
+    fs.writeFileSync("/tmp/T-800.jpg", data);
+});
+```
+
+### Delete files and directories
+
+Delete files by calling `delete` on their respective `File` or `Dir` object.
+When deleting directories, you may optionally specify a `force` argument
+that indicates whether or not a directory should be deleted if it contains files or other directories (default = `false`).
+
+```javascript
+var c3po = client.file("data://.my/robots/C-3PO.txt");
+c3po.delete(function(response) {
+    if(response.error) {
+        return console.log("Failed to delete file: " + response.error.message);
+    }
+    console.log("Deleted file: " + c3po.data_path);
+});
+
+// Force delete a directory
+client.dir("data://.my/robots")
+    .delete(true, function(response) {
+        /* ommitting callback implementation */
+    });
+```
+
+### List directory contents
+
+Iterate over the contents of a directory using the iterated returned by calling `forEachDir` or `forEachFile` on a `Dir` object:
+
+```javascript
+// List top level directories
+client.dir("data://.my").forEachDir(function(err, dir) {
+    if(err) {
+        return console.log("Error: " + JSON.stringify(err));
+    }
+    console.log(dir.data_path);
+}).then(function() {
+    console.log("Finished listing directory");
+});
+
+
+// List files in the Public folder of your connected Dropbox account
+client.dir("dropbox://Public").forEachFile(function(err, file) {
+    if(err) {
+        return console.log("Error: " + JSON.stringify(err));
+    }
+    console.log(file.data_path);
+}).then(function() {
+    console.log("Finished listing directory");
+});
+```
+
+## Building the client
+
+This project uses gulp to compile coffeescript.
+
+```bash
+npm install
+npm install -g gulp-cli
+
+gulp
+```
+
+Note: Don't edit the .js in the `lib` directory; they will get overwritten on subsequent compiles.
+Instead, modify `.coffee` files in the `src` dir, and run `gulp`.
+
+Testing (kinda) is currently achieved by running this bash loop and checking for error messages.
+
+```
+for f in examples/*.js; do node $f; done
+```