Initial import of client - scales not tested

Author: Michael Townsend

.gitignore

@@ -0,0 +1,34 @@
+# Logs
+logs
+*.log
+npm-debug.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 directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history

README.md

@@ -0,0 +1,127 @@
+# PrintNode-NodeJS
+
+Cloud Printing wrapper for the [PrintNode](https://www.printnode.com) API.
+
+## Installation
+
+Install dependencies
+```
+  npm install printnode-client
+```
+
+Require and instantiate a client:
+
+```
+  var PrintNodeClient = require('printnode');
+  var client = new PrintNodeClient({ api_key: "DUMMY_API_KEY", default_printer_id: 123456 });
+```
+
+## Usage
+### [Account Information](https://www.printnode.com/docs/api/curl/#account_information)
+
+```
+  // fetch metadata about account
+  client.whoAmI().then(console.log);
+
+  // fetch account credits
+  client.credits().then(console.log);
+```
+
+### [Computers](https://www.printnode.com/docs/api/curl/#computers)
+
+```
+  // fetch computers
+  client.fetchComputers().then(...);
+```
+
+### [Printers](https://www.printnode.com/docs/api/curl/#printers)
+
+```
+  // Fetch printers
+  client.fetchPrinters().then(...);
+
+  // Fetch printers for a specific computer
+  client.fetchPrinters(computer_id).then(...);
+
+  // Fetch a specific printer (returns array of one)
+  client.fetchPrinters(printer_id).then(...);
+
+  // Fetch a specific printer from a computer
+  client.fetchPrinters(computer_id, printer_id).then(...);
+```
+
+### [PrintJobs](https://www.printnode.com/docs/api/curl/#printjobs)
+
+#### Fetching:
+```
+  // Fetch all print jobs
+  client.fetchPrintJob().then(...);
+
+  // Fetch a specific print jobs (returns array of one)
+  client.fetchPrintJob(printjob_id).then(...);
+
+  // Fetch all print jobs for a specific printer
+  client.fetchPrintJobsForPrinter(printer_id).then(...);
+
+  // Fetch a specific printer from a printer (returns array of one)
+  client.fetchPrintJobForPrinter(printer_id, printjob_id).then(...);
+```
+
+#### Creating
+[API documentation has full options for PrintJob creation](https://www.printnode.com/docs/api/curl/#printjobs)
+```
+  // Create a print job
+  var options = {
+    title: "Printing example 1",
+    source: "PrintNode-NodeJS", // defaults to this
+    content: "https://app.printnode.com/testpdfs/4x6_combo_vertical_ol829.pdf",
+    contentType: "pdf_uri"
+  };
+  client.createPrintJob(options).then(console.log); // returns printjob id only
+
+  // Create a print job from a local PDF file
+  var options = {
+    title: "Printing example 2",
+    filename: "./test/examples/label.pdf"
+  };
+  client.createPrintJobFromPDF().then(...);
+
+
+  // Create a print job from a local raw print file
+  var options = {
+    title: "Printing example 2",
+    filename: "./test/examples/label.pdf"
+  };
+  client.createPrintJobFromRaw().then(...);
+
+```
+
+### [Scales](https://www.printnode.com/docs/api/curl/#scales)
+
+```
+  // Fetch all print jobs
+  client.fetchPrintJob().then(...);
+
+  // Fetch a specific print jobs (returns array of one)
+  client.fetchPrintJob(printjob_id).then(...);
+
+  // Fetch all print jobs for a specific printer
+  client.fetchPrintJobsForPrinter(printer_id).then(...);
+
+  // Fetch a specific printer from a printer (returns array of one)
+  client.fetchPrintJobForPrinter(printer_id, printjob_id).then(...);
+```
+
+## Testing
+
+The tests in place at the moment are simply testing for positive responses, they are not looking at the detail of the response.
+
+Requirements:
+- a live account. This should be setup on [printnode.com](https://printnode.com)
+- the printnode client to be installed and logged in on that computer
+- at least one active printer to be available on that computer, you can use a pdf printer to avoid printing during testing [CutePDF](http://cutepdf.com/)
+
+Running the tests
+
+  1. Change the API_KEY and ACTIVE_PRINTER_ID 
+  2. Run `npm test`

index.js

@@ -0,0 +1,12 @@
+var _ = require('lodash');
+
+var client = require('./lib/client');
+
+_.assign(client.prototype, require('./lib/account-information'));
+// _.assign(client.prototype, require('./lib/account-management'));
+_.assign(client.prototype, require('./lib/computers'));
+_.assign(client.prototype, require('./lib/printers'));
+_.assign(client.prototype, require('./lib/printjobs'));
+_.assign(client.prototype, require('./lib/scales'));
+
+module.exports = client;

lib/account-information.js

@@ -0,0 +1,17 @@
+/** @mixin Account */
+var Account = {
+
+  /** Fetch metadata about PrintNode account */
+  whoami: function () {
+    return this._getJSON('whoami');
+  },
+
+  /** Fetch print credits available to PrintNode account */
+  credits: function () {
+    return this._getJSON('credits');
+  }
+  
+};
+
+module.exports = Account;
+  

lib/client.js

@@ -0,0 +1,58 @@
+var request = require('request');
+var _ = require('lodash');
+
+/**
+ * Instantiate a client
+ *
+ * @class PrintNodeClient
+ * @mixes Account
+ * @mixes Computers
+ * @mixes Printers
+ * @mixes PrintJobs
+ * @mixes Scales
+ */
+var PrintNodeClient = function (options) {
+  if( !options || !options.api_key ) {
+    throw new Error('Must instantiate PrintNodeClient with minimum of: { api_key: "#API-KEY#" }');
+  }
+
+  this.api_key = options.api_key;
+  this.default_printer_id = options.default_printer_id;
+  this.version = "~3";
+  this.base_url = "https://" + this.api_key + ":@api.printnode.com/";
+};
+
+PrintNodeClient.prototype._getJSON = function (path) {
+  return this._makeRequest(path);
+};
+
+PrintNodeClient.prototype._postJSON = function (path, body) {
+  return this._makeRequest(path, {
+    method: "POST",
+    body: body
+  });
+};
+
+PrintNodeClient.prototype._makeRequest = function (path, options) {
+  var defaults = { 
+    url: this.base_url + path,
+    json: true
+  };
+
+  var xhr_options = _.defaults(options || {}, defaults);
+
+  return new Promise(function (resolve, reject) {
+    request(xhr_options, function (err, response, body) {
+      if (err) {
+        reject(err);
+      } else if (!(/^2/.test('' + response.statusCode))) { // Status Codes other than 2xx
+        var message = body && body.message ? body.message : body;
+        reject(new Error(response.statusCode + " - " + message));
+      } else {
+        resolve(body);
+      }
+    });
+  });
+};
+
+module.exports = PrintNodeClient;

lib/computers.js

@@ -0,0 +1,28 @@
+/** @mixin Computers */
+var Computers = {
+  /**
+   * Retrieves an array of computers associated with this client / account.
+   * 
+   * ```
+   * @for PrintNodeClient
+   * @return {promise} response - promise which fulfils with an array of computers:
+   *
+   *  [{
+   *    "id": 11,
+   *    "name": "AnalyticalEngine",
+   *    "inet": null,
+   *    "inet6": null,
+   *    "hostname": null,
+   *    "version": null,
+   *    "jre": null,
+   *    "createTimestamp": "2015-06-28T18:29:19.871Z",
+   *    "state": "disconnected"
+   *  }]
+   * ``` 
+   */
+  fetchComputers: function () {
+    return this._getJSON('computers');
+  },
+};
+
+module.exports = Computers;

lib/printers.js

@@ -0,0 +1,35 @@
+var _ = require('lodash');
+
+/** @mixin Printers */
+var Printers = {
+
+  /**
+   * Retrieves an array of computers associated with this client / account.
+   */
+  fetchPrinters: function () {
+    return this._getJSON('printers');
+  },
+
+  /** 
+   * Retrieves the printer for the specified id.
+   */
+  fetchPrinter: function (printer_id) {
+    return this._getJSON('printers/' + printer_id);
+  },
+  
+  /**
+   * Retrieves all printers for a single computer.
+   */
+  fetchPrintersForComputer: function (computer_id) {
+    return this._getJSON('computers/' + computer_id + '/printers');
+  },
+
+  /**
+   * Retrieves a single printer from the specified computer.
+   */
+  fetchPrinterForComputer: function (computer_id, printer_id) {
+    return this._getJSON('computers/' + computer_id + '/printers/' + printer_id);
+  }
+};
+
+module.exports = Printers;