qranswers 1.0.2 → 1.0.4

package/README.md

@@ -0,0 +1,71 @@
+# qranswers_module
+QR-Answers API module
+
+This module allows you to use nodejs to access the QR-Answers API.
+
+## Webhooks
+
+To use a webhook, create an endpoint (e.g.  https://mydomain.com/qrhook)
+In the app, go to Home -> Manage Plan -> Developer to retrieve your API key and Secret Key as well as input your endpoint.  
+For the webhook, you need to select which events you would like to receive from the Events to send section.  Choose events from
+the dropdown and you will see them appear in a list below.  You may remove any events you no longer want to receive by 
+clicking the trash can next to the event and choosing Update Webhook.
+
+To use this module:
+
+```
+npm install qranswers
+```
+
+Your webhook will need to collect the raw Body (a Buffer) of the request received.  If you use express, you may add this to your file:
+
+```
+npm install body-parser
+```
+
+Then, in your nodejs app:
+
+```
+const bodyParser = require('body-parser')
+
+app.use(
+  bodyParser.json({
+    verify: function(req, res, buf) {
+      req.rawBody = buf;
+    }
+  })
+);
+```
+
+Then when you receive the event via a post, you will need to retrieve the ```x-qr-signature``` header and verify the event with the ```qranswers.webhook.constructEvent()``` method.
+The method will throw an error if the signature does not match or if the period between the request and the decoding is too long.
+You should return a json response to the QR-Answers server like below.
+
+```
+app.post('/qrhook', function(req, res) {
+  const sig = req.headers['x-qr-signature'];
+  let event
+  try {
+    event = qranswers.webhooks.constructEvent(req.rawBody, sig, endpointSecret)
+  } catch (err) {
+    console.log('Error', err);
+    res.json({error: `Webhook Error: ${err.message}`});
+    return;
+  }
+
+  switch (event.type) {
+    case 'vote.evResponseVote':
+      const data = event.data.object;
+      console.log('Received event:', event);
+      break;
+  }
+
+  res.json({success: 'post call succeed!', url: req.url, body: req.body})
+});
+```
+
+The QR-Answers server(s) will only try 3 times with backoff to deliver your event.  The server determines whether to retry sending the event by examining the 
+{success: "xxx"} field in the returned JSON.
+
+
+## API

package/lib/Subscriptions.js

@@ -0,0 +1,85 @@
+'use strict';
+const {Amplify, API} = require('aws-amplify');
+
+Amplify.configure({
+	'aws_appsync_graphqlEndpoint': "https://sy35eokcbzcrvjomxqrx3xgawy.appsync-api.us-east-1.amazonaws.com/graphql",
+	'aws_appsync_region': "us-east-1",
+	'aws_appsync_authenticationType': "AWS_LAMBDA",	
+})
+
+const onResponseByClientId = /* GraphQL */ `
+  subscription OnResponseByClientId($clientId: String!) {
+    onResponseByClientId(clientId: $clientId) {
+			clientId
+			projectId
+			baseId
+			answerId
+			count
+    }
+  }
+`;
+const getClientIdFromApiKey = /* GraphQL */ `
+  query GetClientIdFromApiKey($apiKey: String!) {
+    getClientIdFromApiKey(apiKey: $apiKey) {
+      clientID
+    }
+  }
+`;
+
+const QRSubscription = {
+	setKey(key) {
+		this._apiKey = key;
+	},
+	async initialize() {
+		const apiKey = this._apiKey;
+		if (apiKey === undefined) {
+			throw new Error("You must provide your API key when establishing the module. const qranswers = require('qranswers')(apiKey); ");
+		}
+		if (this.clientId !== undefined) {
+			return true;
+		}
+		// We need to get our clientId from the server
+		try {
+			const qlResp = await API.graphql({
+				query: getClientIdFromApiKey,
+				variables: { apiKey: apiKey },
+				authToken: this._apiKey
+			});
+			this._clientId = qlResp.data.getClientIdFromApiKey.clientID;
+			return true;
+		} catch (err) {
+			console.warn(err);
+			return false;
+		}
+	},
+	subscribeToResponse(callBack, errCallBack) {
+		if (this._clientId === undefined) {
+			throw new Error('You must first call qranswers.subscriptions.initialize() before calling any subscription');
+		}
+
+		const subscription = API.graphql({
+			query: onResponseByClientId,
+			variables: { clientId: this._clientId },
+			authToken: this._apiKey
+		}
+		).subscribe({
+			next: ({ provider, value }) => {
+				const response = value.data.onResponseByClientId;
+				callBack(response);
+			},
+			error: (error) => {
+				console.warn(error)
+				if (errCallBack) {
+					errCallBack(error);
+				}
+			},
+		});
+		return subscription;
+	},
+	unsubscribeToResponse(subscription) {
+		subscription.unsubscribe();
+	}
+}
+
+module.exports = QRSubscription;
+//export default QRSubscription;

package/lib/Webhooks.js

@@ -1,5 +1,5 @@
 'use strict';
-const crypto = require('crypto');
+//const crypto = require('crypto');
 
 const Webhook = {
   DEFAULT_TOLERANCE: 300000,	// in ms
@@ -89,6 +89,7 @@ function parseHeader(header, scheme) {
       signatures: [],
     }
   );
-}
+};
+
 module.exports = Webhook;
 

package/lib/qranswers.js

@@ -24,10 +24,10 @@ function QRAnswers(key, config = {}) {
   if (
     props.protocol &&
     props.protocol !== 'https' &&
-    (!props.host || /\.stripe\.com$/.test(props.host))
+    (!props.host || /\.qr-answers\.com$/.test(props.host))
   ) {
     throw new Error(
-      'The `https` protocol must be used when sending requests to `*.stripe.com`'
+      'The `https` protocol must be used when sending requests to `*.qr-answers.com`'
     );
   }
   const agent = props.httpAgent || null;
@@ -40,16 +40,22 @@ function QRAnswers(key, config = {}) {
     version: props.apiVersion || DEFAULT_API_VERSION,
     timeout: utils.validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
   };
+  this._setApiKey(key);
+
+  this.webhooks = require('./Webhooks');
+  this.subscriptions = require('./Subscriptions');
+  this.subscriptions.setKey(key);
 
 }
 QRAnswers.webhooks = require("./Webhooks");
+QRAnswers.subscriptions = require("./Subscriptions");
 QRAnswers.prototype = {
   VERSION: null,
   webhooks: null,
   _api: null,
   _setApiKey(key) {
     if (key) {
-      this._setApiField('auth', `Bearer ${key}`);
+      this._setApiField('key', key);
     }
   },
   _setApiField(key, value) {
@@ -91,7 +97,7 @@ QRAnswers.prototype = {
 };
 module.exports = QRAnswers;
 // expose constructor as a named property to enable mocking with Sinon.JS
-module.exports.Stripe = QRAnswers;
+module.exports.QRAnswers = 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

@@ -1,6 +1,6 @@
 {
   "name": "qranswers",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Helper module to access QR-Answers API",
   "main": "lib/qranswers.js",
   "scripts": {
@@ -23,6 +23,7 @@
   },
   "homepage": "https://github.com/ggcespia/qranswers_module#readme",
   "dependencies": {
+    "aws-amplify": "^5.3.11",
     "crypto": "^1.0.1"
   }
 }