presidium 1.3.2 → 1.4.1

package/Docker.js

@@ -24,21 +24,29 @@ const handleDockerHTTPResponse = require('./internal/handleDockerHTTPResponse')
  *
  * @docs
  * ```coffeescript [specscript]
- * new Docker() -> docker Docker
+ * new Docker(options {
+ *   apiVersion: string,
+ * }) -> docker Docker
  * ```
  *
  * Presidium Docker client for [Docker](https://docs.docker.com/reference/).
  *
  * Note: the Presidium Docker client connects to the Docker socket. Please use caution when creating production services using the Presidium Docker client, see [How would an attacker gain access to the host machine from within a Docker container?](https://www.google.com/search?hl=en&q=how%20would%20an%20attacker%20gain%20access%20to%20the%20host%20machine%20from%20within%20a%20docker%20container).
+ *
+ * Arguments:
+ *   * `options`
+ *     * `apiVersion` - the version of the Docker API. Defaults to `'1.48'`.
  */
 class Docker {
-  constructor() {
+  constructor(options = {}) {
     const agent = new http.Agent({
       socketPath: '/var/run/docker.sock',
       maxSockets: Infinity,
     })
 
-    this.http = new HTTP('http://0.0.0.0/v1.48', { agent })
+    this.apiVersion = options.apiVersion ?? '1.48'
+
+    this.http = new HTTP(`http://0.0.0.0/v${this.apiVersion}`, { agent })
   }
 
   /**

package/ECR.js

@@ -217,7 +217,7 @@ class ECR {
    *
    * @docs
    * ```coffeescript [specscript]
-   * ecr.getAuthorizationToken() -> authToken Promise<string>
+   * getAuthorizationToken() -> authToken Promise<string>
    * ```
    *
    * Gets an authorization token from Amazon ECR.

package/Secrets.js

@@ -0,0 +1,36 @@
+require('rubico/global')
+const fs = require('fs')
+
+/**
+ * @name Secrets
+ *
+ * @docs
+ * ```coffeescript [specscript]
+ * Secrets() -> secrets Promise<Object>
+ * ```
+ *
+ * Presidium Secrets class. Consumes the `.secrets` file in the current directory.
+ *
+ * Arguments:
+ *   * (none)
+ *
+ * Return:
+ *   * `secrets` - a promise of an object of secret key-value pairs.
+ *
+ * ```javascript
+ * const secrets = await Secrets()
+ * console.log(secrets.mySecret) // ********
+ * ```
+ */
+async function Secrets() {
+  const secrets = pipe(fs.promises.readFile('.secrets'), [
+    content => content.toString('utf8').trim().split('\n'),
+    map(line => line.split('=')),
+    Object.fromEntries,
+  ])
+  await fs.promises.rm('.secrets')
+
+  return secrets
+}
+
+module.exports = Secrets

package/index.js

@@ -12,6 +12,7 @@ module.exports = {
   Password: require('./Password.js'),
   Readable: require('./Readable.js'),
   S3Bucket: require('./S3Bucket.js'),
+  Secrets: require('./Secrets.js'),
   SecretsManager: require('./SecretsManager.js'),
   StrictValidator: require('./StrictValidator.js'),
   TranscribeStream: require('./TranscribeStream.js'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",
@@ -26,6 +26,7 @@
     "Password.js",
     "Readable.js",
     "S3Bucket.js",
+    "Secrets.js",
     "SecretsManager.js",
     "StrictValidator.js",
     "TranscribeStream.js",