qranswers 1.0.0

package/lib/Webhooks.js

@@ -0,0 +1,94 @@
+'use strict';
+const crypto = require('crypto');
+
+const Webhook = {
+  DEFAULT_TOLERANCE: 300000,	// in ms
+  EXPECTED_SCHEME: 'v1',
+
+  constructEvent(payload, header, secret, tolerance) {
+		console.log('constructEvent', payload);
+    this.verifyHeader(payload, header, secret, tolerance || this.DEFAULT_TOLERANCE);
+		console.log('returning ', JSON.parse(payload));
+    return JSON.parse(payload);
+  },
+  verifyHeader(
+    encodedPayload,
+    encodedHeader,
+    secret,
+    tolerance
+  ) {
+    const {
+      decodedHeader: header,
+      decodedPayload: payload,
+      details,
+    } = parseEventDetails(encodedPayload, encodedHeader, this.EXPECTED_SCHEME);
+
+    const expectedSignature = crypto.createHmac('sha256', secret)
+    .update(`${details.timestamp}.${encodedPayload.toString('utf8')}`)
+    .digest('hex');
+
+    for (var i=0; i<details.signatures.length; i++) {
+      if (crypto.timingSafeEqual(Buffer.from(details.signatures[i]), Buffer.from(expectedSignature))) {
+
+        const timestampAge = Date.now() - details.timestamp;
+        if (tolerance > 0 && timestampAge > tolerance) {
+          // @ts-ignore
+          throw new Error('Timestamp outside the tolerance zone');
+        }
+        return true;
+      }
+    }
+
+    throw new Error('Invalid signature');
+  }
+};
+
+function parseEventDetails(encodedPayload, encodedHeader, expectedScheme) {
+
+  const decodedPayload = Buffer.isBuffer(encodedPayload)
+    ? encodedPayload.toString('utf8')
+    : encodedPayload;
+  if (Array.isArray(encodedHeader)) {
+    throw new Error(
+      'Unexpected: An array was passed as a header, which should not be possible for the qranswers--signature header.'
+    );
+  }
+  const decodedHeader = Buffer.isBuffer(encodedHeader)
+    ? encodedHeader.toString('utf8')
+    : encodedHeader;
+  const details = parseHeader(decodedHeader, expectedScheme);
+  if (!details || details.timestamp === -1) {
+    throw new Error('Unable to extract timestamp and signatures from header');
+  }
+  if (!details.signatures.length) {
+    throw new Error('No signatures found with expected scheme');
+  }
+  return {
+    decodedPayload,
+    decodedHeader,
+    details,
+  };
+};
+function parseHeader(header, scheme) {
+  if (typeof header !== 'string') {
+    return null;
+  }
+  return header.split(',').reduce(
+    (accum, item) => {
+      const kv = item.split('=');
+      if (kv[0] === 't') {
+        accum.timestamp = parseInt(kv[1], 10);
+      }
+      if (kv[0] === scheme) {
+        accum.signatures.push(kv[1]);
+      }
+      return accum;
+    },
+    {
+      timestamp: -1,
+      signatures: [],
+    }
+  );
+}
+module.exports = Webhook;
+

package/lib/qranswers.js

@@ -0,0 +1,95 @@
+'use strict';
+const DEFAULT_HOST = 'api.qr-answers.com';
+const DEFAULT_PORT = '443';
+const DEFAULT_TIMEOUT = 80000;
+QRAnswers.PACKAGE_VERSION = require('../package.json').version;
+const ALLOWED_CONFIG_PROPERTIES = [
+  'timeout',
+  'host',
+  'port',
+  'protocol',
+];
+
+function QRAnswers(key, config = {}) {
+  if (!(this instanceof QRAnswers)) {
+    return new QRAnswers(key, config);
+  }
+  const props = this._getPropsFromConfig(config);
+
+  this.VERSION = QRAnswers.PACKAGE_VERSION;
+
+  if (
+    props.protocol &&
+    props.protocol !== 'https' &&
+    (!props.host || /\.stripe\.com$/.test(props.host))
+  ) {
+    throw new Error(
+      'The `https` protocol must be used when sending requests to `*.stripe.com`'
+    );
+  }
+  const agent = props.httpAgent || null;
+  this._api = {
+    auth: null,
+    host: props.host || DEFAULT_HOST,
+    port: props.port || DEFAULT_PORT,
+    protocol: props.protocol || 'https',
+    basePath: DEFAULT_BASE_PATH,
+    version: props.apiVersion || DEFAULT_API_VERSION,
+    timeout: utils.validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
+  };
+
+}
+QRAnswers.webhooks = require("./Webhooks");
+QRAnswers.prototype = {
+  VERSION: null,
+  webhooks: null,
+  _api: null,
+  _setApiKey(key) {
+    if (key) {
+      this._setApiField('auth', `Bearer ${key}`);
+    }
+  },
+  _setApiField(key, value) {
+    this._api[key] = value;
+  },
+  getApiField(key) {
+    return this._api[key];
+  },
+  getMaxNetworkRetries() {
+    return this.getApiField('maxNetworkRetries');
+  },
+
+  /**
+   * @private
+   * This may be removed in the future.
+   */
+  _getPropsFromConfig(config) {
+    if (!config) {
+      return {};
+    }
+    const isObject = config === Object(config) && !Array.isArray(config);
+    if (!isObject) {
+      throw new Error('Config must be an object');
+    }
+    // If config is an object, we assume the new behavior and make sure it doesn't contain any unexpected values
+    const values = Object.keys(config).filter(
+      (value) => !ALLOWED_CONFIG_PROPERTIES.includes(value)
+    );
+    if (values.length > 0) {
+      throw new Error(
+        `Config object may only contain the following: ${ALLOWED_CONFIG_PROPERTIES.join(
+          ', '
+        )}`
+      );
+    }
+    return config;
+  },
+
+};
+module.exports = QRAnswers;
+// expose constructor as a named property to enable mocking with Sinon.JS
+module.exports.Stripe = QRAnswers;
+// Allow use with the TypeScript compiler without `esModuleInterop`.
+// We may also want to add `Object.defineProperty(exports, "__esModule", {value: true});` in the future, so that Babel users will use the `default` version.
+module.exports.default = QRAnswers;
+

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "qranswers",
+  "version": "1.0.0",
+  "description": "Helper module to access QR-Answers API",
+  "main": "lib/qranswers.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/ggcespia/qranswers_module.git"
+  },
+  "keywords": [
+    "qranswers",
+    "qrcontest",
+    "qrcode",
+    "api"
+  ],
+  "author": "Greg Carpenter",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ggcespia/qranswers_module/issues"
+  },
+  "homepage": "https://github.com/ggcespia/qranswers_module#readme",
+  "dependencies": {
+    "crypto": "^1.0.1"
+  }
+}