Merge pull request #26 from alertlogic/npm

Npm

Author: JDragovichAlertLogic

README.md

@@ -11,45 +11,31 @@ This repository contains the common JavaScript functions used by Node.js collect
 
 # HOWTO use this library in an AWS Lambda function
 
-Create a `package.json` file for [npm](https://www.npmjs.com/) 2.7.0 (or greater) in the root of your AWS Lambda function Node.js root directory.  Include this repo in the `dependencies` and `devDependencies` section as required.  
+To install:
+`npm i @alertlogic/al-aws-collector-js`
+
+in your file
+```javascript
+const {
+    AlAwsCollector,
+} = require('@alertlogic/al-aws-collect-js');
+```
 
-For example:
+# API
 
-```
-{
-  "name": "al-my-collector",
-  "version": "1.0.0",
-  "description": "Alert Logic My Collector",
-  "repository": {},
-  "private": true,
-  "scripts": {
-    "start": "node index.js",
-    "lint": "jshint --exclude \"./node_modules/*\" **/*.js",
-    "test": "JUNIT_REPORT_PATH=./test/report.xml nyc --reporter=cobertura mocha --colors --reporter mocha-jenkins-reporter"
-  },
-  "devDependencies": {
-    "aws-sdk": "*",
-    "aws-sdk-mock": "*",
-    "dotenv": "*",
-    "clone": "*",
-    "jshint": "^2.9.5",
-    "mocha": "^3.5.3",
-    "mocha-jenkins-reporter": "^0.3.10",
-    "nyc": "^11.3.0",
-    "rewire": "^2.5.2",
-    "sinon": "^3.3.0"
-  },
-  "dependencies": {
-    "async": "*",
-    "cfn-response": "*",
-    "moment": "^2.19.2",
-    "request": "*",
-    "request-promise-native": "*",
-    "al-aws-collector-js": "git://github.com/alertlogic/al-aws-collector-js#master"
-  },
-  "author": "Alert Logic Inc."
-}
-```
+## `AlAwsCollector`
+Base class for AWS lambda based collectors
+
+* @param {Object} context - context of Lambdas function.
+* @param {string} collectorType - collector type (cwe as example).
+* @param {string} ingestType - ingest data type (secmsgs, vpcflow, etc).
+* @param {string} version - version of collector.
+* @param {Object} aimsCreds - Alert Logic API credentials.
+* @param {string} [aimsCreds.access_key_id] - Alert Logic API access key id.
+* @param {string} [aimsCreds.secret_key] - Alert Logic API secret key.
+* @param {function} formatFun - callback formatting function
+* @param {Array.<function>} healthCheckFuns - list of custom health check functions (can be just empty, so only common are applied)
+* @param {Array.<function>} statsFuns - list of custom stats functions (can be just empty, so only common are applied)
 
 # Debugging
 
@@ -69,10 +55,6 @@ value "index" or "*".
 
 See [debug](https://www.npmjs.com/package/debug) for further details.
 
-# Known Issues/ Open Questions
-
-- TBD.
-
 # Useful Links
 
 - [Node.js static code analysis tool](http://jshint.com/install/)

al_aws_collector.js

@@ -16,7 +16,7 @@ const async = require('async');
 const response = require('cfn-response');
 const deepEqual = require('deep-equal');
 
-const m_alCollector = require('al-collector-js');
+const m_alCollector = require('@alertlogic/al-collector-js');
 const m_alAws = require('./al_aws');
 const m_healthChecks = require('./health_checks');
 const m_stats = require('./statistics');

package.json

@@ -1,18 +1,29 @@
 {
-  "name": "al-aws-collector-js",
-  "version": "1.0.0",
+  "name": "@alertlogic/al-aws-collector-js",
+  "version": "1.1.2",
+  "license": "MIT",
   "description": "Alert Logic AWS Collector Common Library",
-  "repository": {},
-  "private": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alertlogic/al-aws-collector-js#npm"
+  },
+  "private": false,
   "scripts": {
     "lint": "jshint --exclude \"./node_modules/*\" **/*.js",
     "test": "JUNIT_REPORT_PATH=./test/report.xml nyc --reporter=cobertura mocha --colors --reporter mocha-jenkins-reporter"
   },
+  "main": "index.js",
+  "maintainers": [
+    {
+      "name": "Alert Logic NPM Team",
+      "email": "[email protected]"
+    }
+  ],
   "devDependencies": {
-    "aws-sdk": "*",
-    "aws-sdk-mock": "*",
-    "dotenv": "*",
-    "clone": "*",
+    "aws-sdk": "^2.441.0",
+    "aws-sdk-mock": "^4.4.0",
+    "dotenv": "^7.0.0",
+    "clone": "^2.1.2",
     "jshint": "^2.9.5",
     "mocha": "^3.5.3",
     "mocha-jenkins-reporter": "^0.3.10",
@@ -21,11 +32,11 @@
     "sinon": "^3.3.0"
   },
   "dependencies": {
-    "al-collector-js": "git://github.com/alertlogic/al-collector-js#master",
-    "cfn-response": "*",
-    "async": "*",
+    "@alertlogic/al-collector-js": "^1.1.2",
+    "cfn-response": "^1.0.1",
+    "async": "^2.6.1",
     "moment": "^2.19.2",
-    "deep-equal": "*"
+    "deep-equal": "^1.0.1"
   },
   "author": "Alert Logic Inc."
 }

test/al_aws_collector_test.js

@@ -5,7 +5,7 @@ const m_response = require('cfn-response');
 const deepEqual = require('deep-equal');
 
 const AlAwsCollector = require('../al_aws_collector');
-var m_alCollector = require('al-collector-js');
+var m_alCollector = require('@alertlogic/al-collector-js');
 const m_healthChecks = require('../health_checks');
 var AWS = require('aws-sdk-mock');
 const colMock = require('./collector_mock');