Initial version of the PostgreSQL data-connector.

Author: Chris Wiechmann

api-builder-plugin-dc-postgres/.gitignore

@@ -0,0 +1,61 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

api-builder-plugin-dc-postgres/README.md

@@ -0,0 +1,107 @@
+# PostgreSQL Connector
+
+The PostgreSQL data connector is a plugin for API Builder that can connect to your PostgreSQL database instance and interrogate your schema that will automatically provision Models into to your project, and optionally, automatically generate a rich CRUD API to the underlying tables.  The Models can be used programmatically, or can be used within the flow editor to interact with your database.
+
+## Minimum requirements
+
+### Supported versions
+* PostgreSQL 9.6
+* Other versions might be supported as well, please create an issue if encounter any.
+
+### Memory
+* ~7 MB
+
+### Disk space
+* ~10 MB
+
+### Supported features
+* Automatic generation of Models from SQL tables
+* Automatic generation of API for Models
+* Full CRUD operations on tables via Models
+* Connection pooling
+
+## Installation
+
+```bash
+npm install --no-optional @axway/api-builder-plugin-dc-postgres
+```
+
+A configuration file is generated for you and placed into the conf directory of your API Builder project. The configuration for your PostgreSQL is expected to be in environment variables or in the conf/.env file during development. 
+
+## Configuration
+
+Once the plugin is installed, the configuration file is located `<project>/conf/postgres.default.js`.
+
+| Option name | Type | Description |
+| ----------- | ---- | ----------- |
+| connector   | string | Must be: `@axway/api-builder-plugin-dc-postgres` |
+| connectionPooling | boolean | boolean Enables connection pooling for better performance and scalability. |
+| connectionLimit | number | Number of simultaneous connections when connectionPooling is enabled. |
+| host | string | The database host. |
+| port | number | The database post. |
+| database | string | The database instance name. |
+| scheme | string | The schema within your database to use |
+| user | string | The user with which to connect to the database. |
+| password | string | The user's password with which to connect to the database. |
+| generateModelsFromSchema | boolean | If enabled, API Builder will automatically interrogate the database and auto-generate Models from SQL tables. |
+| modelAutogen | boolean | If enabled, API Builder will automatically generate a full and rich CRUD API from the generated Models. |
+
+## Usage
+
+After you configure the connector, you can start up your API Builder project and visit the console (normally found under http://localhost:8080/console). Your connector will be listed under the [Connectors](http://localhost:8080/console/project/connectors) section of the console.
+
+Your database tables will be listed under the [Models](http://localhost:8080/console/project/models) section of the console. You can now click on the gear icon to the right of the table names and generate flow based APIs.
+
+You can also reference the connector in a custom model.
+
+```javascript
+const Account = APIBuilder.Model.extend('Account', {
+  fields: {
+    Name: { type: String, required: true }
+  },
+  connector: 'postgres'
+});
+```
+
+If you want to map a specific model to a specific table, use metadata.  For example, to map the `account` model to the table named `accounts`, set it such as:
+
+```javascript
+const Account = APIBuilder.Model.extend('account', {
+  fields: {
+    Name: { type: String, required: false, validator: /[a-zA-Z]{3,}/ }
+  },
+  connector: 'postgres',
+  metadata: {
+    'mysql': {
+      table: 'accounts'
+    }
+  }
+});
+```
+
+## Known issues and limitations
+
+1. Only supports SQL tables.
+1. Does not support views.
+1. Does not support stored procedures.
+
+## Changes
+
+#### 1.0.0
+- Initial version of the connector
+
+## Contributing
+
+Please read [Contributing.md](https://github.com/Axway-API-Management-Plus/Common/blob/master/Contributing.md) for details on our code of conduct, and the process for submitting pull requests to us.  
+
+## Team
+
+![alt text][Axwaylogo] Axway Team
+
+[Axwaylogo]: https://github.com/Axway-API-Management/Common/blob/master/img/AxwayLogoSmall.png  "Axway logo"
+
+[1]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_flows.html
+[2]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_getting_started_guide.html
+[3]: https://github.com/Axway-API-Builder-Ext/api-builder-extras/issues
+[4]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/environmentalization.html
+[5]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/project_configuration.html#ProjectConfiguration-Configurationfiles

api-builder-plugin-dc-postgres/config/postgres.default.js

@@ -0,0 +1,30 @@
+/*
+ * Use this file to configure your Postgres data connector
+ *
+ * By default, Postgres host, username, password and port are environment variables.
+ * You may configure them in conf/.env file during development phase.
+ * Example setting of environment variables manually:
+ * linux/mac: export POSTGRES_PASSWORD=password
+ * windows: setx POSTGRES_PASSWORD 'password'
+ */
+module.exports = {
+	connectors: {
+		postgres: {
+			connector: '@axway/api-builder-plugin-dc-postgres',
+			connectionPooling: true,
+			connectionLimit: 10,
+			host: process.env.POSTGRES_HOST,
+			port: process.env.POSTGRES_PORT,
+			database: process.env.POSTGRES_DB,
+			user: process.env.POSTGRES_USER,
+			password: process.env.POSTGRES_PASSWORD,
+			schema: 'public',
+
+			// Create models based on your schema that can be used in your API.
+			generateModelsFromSchema: true,
+
+			// Whether or not to generate APIs based on the methods in generated models.
+			modelAutogen: false
+		}
+	}
+};

api-builder-plugin-dc-postgres/lib/index.js

@@ -0,0 +1,32 @@
+/*
+ Welcome to the Postgres connector!
+ */
+const semver = require('semver');
+
+/**
+ * Creates the Postgres connector for API Builder.
+ * @param {object} APIBuilder - API Builder instance
+ * @returns {object} Connector instance
+ */
+exports.create = function (APIBuilder) {
+	if (semver.lt(APIBuilder.Version || '0.0.0', '4.0.0-0')) {
+		throw new Error('This connector requires at least version 4.0.0 of API Builder.');
+	}
+	const Connector = APIBuilder.Connector;
+	const Capabilities = Connector.Capabilities;
+
+	return Connector.extend({
+		filename: module.filename,
+		capabilities: [
+			Capabilities.ConnectsToADataSource,
+			Capabilities.ValidatesConfiguration,
+			// Capabilities.ContainsModels,
+			Capabilities.GeneratesModels,
+			Capabilities.CanCreate,
+			Capabilities.CanRetrieve,
+			Capabilities.CanUpdate,
+			Capabilities.CanDelete
+			// Capabilities.AuthenticatesThroughConnector
+		]
+	});
+};

api-builder-plugin-dc-postgres/lib/lifecycle/connect.js

@@ -0,0 +1,27 @@
+const { Pool } = require('pg');
+
+/**
+ * Connects to your data store; this connection can later be used by your connector's methods.
+ * @param {function} next - callback
+ */
+exports.connect = function (next) {
+	if (this.config.connection_pooling || this.config.connectionPooling) {
+		this.pool = new Pool(this.config); //pg.createPool(this.config);
+		this.pool.connect((err, connection) => {
+			if (err) {
+				if (err.code === 'ECONNREFUSED' || err.code === 'ENOTFOUND') {
+					err.message = 'Connecting to your Postgres server failed; either it isn\'t running, or your connection details are invalid.';
+				}
+				next(err);
+			} else {
+				// We successfully verified that the pool is working;
+				// release the connection for future use.
+				connection.release();
+				next();
+			}
+		});
+	} else {
+		this.connection = pg.createConnection(this.config);
+		this.connection.connect(next);
+	}
+};

api-builder-plugin-dc-postgres/lib/lifecycle/disconnect.js

@@ -0,0 +1,16 @@
+/**
+ * Disconnects from your data store.
+ * @param {function} next - callback
+ */
+exports.disconnect = function (next) {
+	const toEnd = this.pool || this.connection;
+
+	if (toEnd) {
+		toEnd.end(() => {
+			this.pool = this.connection = null;
+			next();
+		});
+	} else {
+		next();
+	}
+};

api-builder-plugin-dc-postgres/lib/metadata/fetchMetadata.js

@@ -0,0 +1,59 @@
+const APIBuilder = require('@axway/api-builder-runtime');
+
+/**
+ * Fetches metadata describing your connector's proper configuration.
+ * @param {function} next - callback
+ */
+exports.fetchMetadata = function fetchMetadata (next) {
+	next(null, {
+		fields: [
+			APIBuilder.Metadata.Checkbox({
+				name: 'connectionPooling',
+				description: 'Whether or not to use connection pooling',
+				required: false
+			}),
+			APIBuilder.Metadata.NumField({
+				name: 'connectionLimit',
+				description: 'If using connectionPooling, the number of connections to allow',
+				required: false
+			}),
+			APIBuilder.Metadata.Text({
+				name: 'host',
+				description: 'The host name of your database',
+				required: true
+			}),
+			APIBuilder.Metadata.NumField({
+				name: 'port',
+				description: 'The port your database is running on',
+				default: 3306,
+				required: false
+			}),
+			APIBuilder.Metadata.Text({
+				name: 'database',
+				description: 'The name of your database',
+				default: 'test',
+				required: true
+			}),
+			APIBuilder.Metadata.Text({
+				name: 'user',
+				description: 'The username for connecting to your database',
+				required: true
+			}),
+			APIBuilder.Metadata.Text({
+				name: 'password',
+				description: 'The password for connecting to your database',
+				required: false
+			}),
+			APIBuilder.Metadata.Checkbox({
+				name: 'generateModelsFromSchema',
+				description: 'Whether or not to generate models from your schema',
+				required: false
+			}),
+			APIBuilder.Metadata.Checkbox({
+				name: 'modelAutogen',
+				description: 'Whether or not generated models should create their own APIs',
+				required: false
+			})
+		]
+	});
+};

api-builder-plugin-dc-postgres/lib/methods/create.js

@@ -0,0 +1,43 @@
+/**
+ * Creates a new Model or Collection object.
+ * @param {APIBuilder.Model} Model The model class being updated.
+ * @param {Object} [values] Attributes to set on the new model(s).
+ * @param {Function} callback Callback passed an Error object (or null if successful),
+ * 		and the new model or collection.
+ * @throws {Error}
+ */
+exports.create = function (Model, values, callback) {
+	const table = this.getTableName(Model);
+	const payload = Model.instance(values, false).toPayload();
+	const primaryKeyColumn = this.getPrimaryKeyColumn(Model);
+	const isAutogenerated = this.getAutogenerated(Model);
+	const columns = this.fetchColumns(table, payload);
+	const placeholders = columns.map(this.returnPlaceholder);
+	const data = Object.values(payload);
+	let query;
+
+	if (!primaryKeyColumn) {
+		query = `INSERT INTO ${this.escapeKeys([ table ])[0]} (${this.escapeKeys(columns).join(',')}) VALUES (${placeholders.join(',')})`;
+	} else if (!isAutogenerated) {
+		data.unshift(values[primaryKeyColumn]);
+		placeholders.push('?');
+		/* eslint-disable */
+		query = 'INSERT INTO ' + this.escapeKeys([ table ])[0] + ' (' + primaryKeyColumn + ',' + this.escapeKeys(columns).join(',') + ') VALUES (' + placeholders.join(',') + ')';
+	} else {
+		/* eslint-disable */
+		query = 'INSERT INTO ' + this.escapeKeys([ table ])[0] + ' (' + this.escapeKeys(columns).join(',') + ') VALUES (' + placeholders.join(',') + ')';
+	}
+
+	this._query(query, data, callback, (result) => {
+		const instance = Model.instance(values);
+		const primaryKey = primaryKeyColumn && this.metadata.schema.objects[table][primaryKeyColumn];
+		if (primaryKey) {
+			if (isAutogenerated) {
+				instance.setPrimaryKey(result.insertId);
+			} else {
+				instance.setPrimaryKey(values[primaryKeyColumn]);
+			}
+		}
+		callback(null, instance);
+	});
+};