Merge pull request #34 from oslabs-beta/ja/npmPackage

Ja/npm package

Author: ggbong734

.gitignore

@@ -103,17 +103,5 @@ dist
 # TernJS port file
 .tern-port
 
-<<<<<<< HEAD
-# Local
-ksqljsTest.js
-package-lock.json
-local_ignore/
-.gitignore
-
-# KSQLDB docker server settings
-ksqldb_server_config/
-
-=======
-# Local files
-./ksqljs.js
->>>>>>> jonTest
+
+

.npmignore

@@ -0,0 +1,3 @@
+#Test Files
+/__tests__/
+.yml

__tests__/integrationtests.js

@@ -1,5 +1,5 @@
 const { default: waitForExpect } = require('wait-for-expect');
-const ksqljs = require('../ksqljs/ksqlJS.js');
+const ksqldb = require('../ksqldb/ksqldb');
 // Pre-requisite: start a docker container
 /* To add to README: Prior to running test with 'npm test', please start the ksqlDB
 server using the command 'docker-compose up'. This will spin up a ksqlDB server on
@@ -16,7 +16,7 @@ need to be removed first.
 describe('--Integration Tests--', () => {
   describe('--Method Tests--', () => {
     beforeAll((done) => {
-      client = new ksqljs({ ksqldbURL: 'http://localhost:8088' });
+      client = new ksqldb({ ksqldbURL: 'http://localhost:8088' });
       done();
     });
 
@@ -61,7 +61,6 @@ describe('--Integration Tests--', () => {
       const data = [];
       await client.push('SELECT * FROM TESTJESTSTREAM EMIT CHANGES;', async (chunk) => {
         data.push(JSON.parse(chunk));
-        console.log(data);
         if (data[1]) {
           client.terminate(data[0].queryId);
           expect(data[1]).toEqual(["stab-rabbit", "123@mail.com", 100])
@@ -158,7 +157,7 @@ describe('--Integration Tests--', () => {
 
   describe('--Health Tests--', () => {
     beforeAll((done) => {
-      client = new ksqljs({ ksqldbURL: 'http://localhost:8088' });
+      client = new ksqldb({ ksqldbURL: 'http://localhost:8088' });
       done();
     });
 

__tests__/queryBuilderTests.js

@@ -1,5 +1,5 @@
-const queryBuilder = require('../ksqljs/queryBuilder.js');
-const { QueryBuilderError, EmptyQueryError, NumParamsError, InappropriateStringParamError } = require('../ksqljs/customErrors.js');
+const queryBuilder = require('../ksqldb/queryBuilder.js');
+const { QueryBuilderError, EmptyQueryError, NumParamsError, InappropriateStringParamError } = require('../ksqldb/customErrors.js');
 
 
 describe('Unit tests for query builder class', () => {

klip_64_ksqldb_js_client.md

@@ -5,7 +5,21 @@ const { ksqlDBError } = require("./customErrors.js");
 const queryBuilder = require('./queryBuilder.js');
 const builder = new queryBuilder();
 
-class ksqljs {
+class ksqldb {
+  /**
+   * Constructor
+   * @param {object} config 
+   * 
+   * Config object can have these properties 
+   * 
+   * ksqldbURL: Connection URL or address
+   * 
+   * API: Username or API key for basic authentication
+   * 
+   * secret: Password or secret for basic authentication
+   * 
+   * httpsAgent: httpsAgent for setting TLS properties
+   */
   constructor(config) {
     this.ksqldbURL = config.ksqldbURL;
     this.API = config.API ? config.API : null;
@@ -261,7 +275,16 @@ class ksqljs {
     // utilize query with variables to build actual query
     const query = builder.build(builderQuery, [streamName], ...propertiesArgs, [sourceStream]);
 
-    return axios.post(this.ksqldbURL + '/ksql', { ksql: query })
+    return axios.post(this.ksqldbURL + '/ksql', { ksql: query }, {
+      headers:
+        this.API && this.secret ?
+          {
+            "Authorization": `Basic ${Buffer.from(this.API + ":" + this.secret, 'utf8').toString('base64')}`,
+          }
+          :
+          {},
+      httpsAgent: this.httpsAgentAxios ? this.httpsAgentAxios : null,
+    })
       .then(res => res.data[0].commandStatus.queryId)
       .catch(error => console.log(error));
   }
@@ -331,34 +354,34 @@ class ksqljs {
       partitions: 1
     };
     Object.assign(defaultProps, propertiesObj);
-    
+
     // if there's no properties Obj, assign them all default values
 
     // expect user to input a conditions object of format {WHERE: condition, GROUP_BY: condition, HAVING: condition};
     // generate conditions string based on object
     // const builder = new queryBuilder();
 
     let conditionQuery = '';
-    if (conditionsObj){
+    if (conditionsObj) {
       const conditionsArr = ['WHERE', 'GROUP_BY', 'HAVING'];
       const sqlClauses = [];
-    
+
       let i = 0;
-      while (conditionsArr.length){
-        if (conditionsObj[conditionsArr[0]]){
-          sqlClauses[i] = [conditionsArr[0].replace('_',' ')]; // clause values are set as arrays for query builder
-          sqlClauses[i+1] =[' ' + conditionsObj[conditionsArr[0]] + ' '];
+      while (conditionsArr.length) {
+        if (conditionsObj[conditionsArr[0]]) {
+          sqlClauses[i] = [conditionsArr[0].replace('_', ' ')]; // clause values are set as arrays for query builder
+          sqlClauses[i + 1] = [' ' + conditionsObj[conditionsArr[0]] + ' '];
         }
         else {
           sqlClauses[i] = [''];
-          sqlClauses[i+1] = [''];
+          sqlClauses[i + 1] = [''];
         }
-        i+=2;
+        i += 2;
         conditionsArr.shift()
       }
       conditionQuery = builder.build('??????', sqlClauses[0], sqlClauses[1], sqlClauses[2], sqlClauses[3], sqlClauses[4], sqlClauses[5]);
     }
-  
+
 
     // reformat for builder
     tableName = [tableName];
@@ -368,21 +391,30 @@ class ksqljs {
 
 
     const query = builder.build(`CREATE TABLE ? WITH (kafka_topic=?, value_format=?, partitions=?) AS SELECT ? FROM ? ?EMIT CHANGES;`, tableName, defaultProps.topic, defaultProps.value_format, defaultProps.partitions, selectColStr, source, conditionQuery)
-    return axios.post(this.ksqldbURL + '/ksql', { ksql: query })
-    .catch(error => console.log(error));
+    return axios.post(this.ksqldbURL + '/ksql', { ksql: query }, {
+      headers:
+        this.API && this.secret ?
+          {
+            "Authorization": `Basic ${Buffer.from(this.API + ":" + this.secret, 'utf8').toString('base64')}`,
+          }
+          :
+          {},
+      httpsAgent: this.httpsAgentAxios ? this.httpsAgentAxios : null,
+    })
+      .catch(error => console.log(error));
   }
 
-    /**
-   * Inserts rows of data into a stream.
-   *
-   * <p>This method may be used to insert new rows of data into a stream.
-   *
-   * <p>This method is sql injection protected with the use of queryBuilder.
-   *
-   * @param {string} stream the name of the stream to insert data into.
-   * @param {object} rows an array that contains data that is being inserted into the stream.
-   * @return {Promise} this method returns a promise that resolves into an array describing the status of the row inserted.
-   */
+  /**
+ * Inserts rows of data into a stream.
+ *
+ * <p>This method may be used to insert new rows of data into a stream.
+ *
+ * <p>This method is sql injection protected with the use of queryBuilder.
+ *
+ * @param {string} stream the name of the stream to insert data into.
+ * @param {object} rows an array that contains data that is being inserted into the stream.
+ * @return {Promise} this method returns a promise that resolves into an array describing the status of the row inserted.
+ */
   //---------------------Insert Rows Into Existing Streams-----------------
   insertStream = (stream, rows) => {
     return new Promise((resolve, reject) => {
@@ -603,4 +635,4 @@ class ksqljs {
   }
 };
 
-module.exports = ksqljs;
+module.exports = ksqldb;