dynamic token saving to .token

.github/workflows/build.yaml

@@ -18,6 +18,7 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
+    - run: npm run clean
     - run: npm run build
     - run: npm run build-container-snapshot
     - run: npm run build-container-timelapse

Dockerfile

@@ -18,7 +18,6 @@ RUN apk add  --no-cache ffmpeg
 ARG command=snapshot
 
 ENV command=$command
-ENV token=$token
 
 WORKDIR /app
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Luke English
+Copyright (c) 2024 Luke English
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,22 +15,20 @@ In order to run the Docker container you need a ring refresh token.
 To generate the token use the following command:
 
 ``` bash
-docker run -i --rm docker.io/developedsoftware/ring-timelapse:token
+docker run -i --rm -v "/my/host/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:token
 ```
 
-> **NOTE**: Please keep this token safe and never share it with anybody
+> **NOTE**: Your token will be saved to "/my/host/folder/.token" and updated whenever a new token is received
 
 ## Creating Snapshots
 
 To take a snapshot of every camera run
 
 ``` bash
-docker run --rm -e token="<insert token here>" -v "/my/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:snapshot
+docker run --rm -v "/my/host/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:snapshot
 ```
 
-> Replace `token="<insert token here>"` with the ring token you generated during installation
-
-> Replace `/my/target/folder` with the directory on your host where you want the snapshots saved
+> Replace `/my/host/folder` with the directory on your host where you want the snapshots saved
 
 Upon completion the container stops and removes itself, allowing you to run it when and however you wish
 
@@ -40,26 +38,21 @@ Upon completion the container stops and removes itself, allowing you to run it w
 To create a timelapse run
 
 ``` bash
-docker run --rm -v "/my/target/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:timelapse
+docker run --rm -v "/my/host/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:timelapse
 ```
 
-> Replace `/my/target/folder` with the directory on your host where you want the snapshots saved
+> Replace `/my/host/folder` with the directory on your host where you want the snapshots saved
 
-> **NOTE** Once the video file is generated the snapshot files will be deleted. To keep these map the archive folder to a directory on your host by using `-v "/my/archive/folder:/app/dist/archive"`
+> **NOTE** Once the video file is generated the snapshot files will be deleted. To keep these map the archive folder to a directory on your host by using `-v "/my/host/archive/folder:/app/dist/archive"`
 
 Upon completion the container stops and removes itself, allowing you to run it when and however you wish
 
-## Environment Variables
-
-The following variables are required:
-
-`token` - your generated Ring token
-
 ## Crontab
 
 An example crontab file can be found below which captures a snapshot every 5 minutes and creates a timelapse once a month
 
 ```
-*/5 * * * * docker run --rm -e token="<insert token here>" -v "/my/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:snapshot
-0 0 1 * *   docker run --rm -v "/my/target/folder:/app/dist/target" -v "/my/archive/folder:/app/dist/archive" docker.io/developedsoftware/ring-timelapse:timelapse
+* * * * *   docker run --rm -v "/my/host/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:snapshot
+0 0 1 * *   docker run --rm -v "/my/host/folder:/app/dist/target" docker.io/developedsoftware/ring-timelapse:timelapse
+0 0 1 * *   docker run --rm -v "/my/host/folder:/app/dist/target" -v "/my/host/archive/folder:/app/dist/archive" docker.io/developedsoftware/ring-timelapse:timelapse
 ```

nbproject/project.properties

@@ -4,7 +4,7 @@ auxiliary.org-netbeans-modules-css-prep.less_2e_mappings=/less:/css
 auxiliary.org-netbeans-modules-css-prep.sass_2e_compiler_2e_options=
 auxiliary.org-netbeans-modules-css-prep.sass_2e_enabled=false
 auxiliary.org-netbeans-modules-css-prep.sass_2e_mappings=/scss:/css
-auxiliary.org-netbeans-modules-javascript-nodejs.enabled=false
+auxiliary.org-netbeans-modules-javascript-nodejs.enabled=true
 auxiliary.org-netbeans-modules-javascript-nodejs.node_2e_default=true
 auxiliary.org-netbeans-modules-javascript-nodejs.run_2e_enabled=false
 auxiliary.org-netbeans-modules-javascript-nodejs.sync_2e_enabled=true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-timelapse",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Ring Timelapse Generator",
   "scripts": {
     "build": "tsc",

src/snapshot.ts

@@ -1,4 +1,4 @@
-import { writeFileSync, mkdirSync, existsSync } from 'fs';
+import { writeFileSync, readFileSync, mkdirSync, existsSync } from 'fs';
 import { RingApi } from 'ring-client-api'
 import * as path from 'path'
 import * as dotenv from "dotenv";
@@ -16,19 +16,26 @@ async function snapshot() {
         log(' - no internet connection');
         return false;
     }
-
-    let systemId = (process.env.token as string).slice(0,32);
+
+    if (!existsSync(path.resolve(__dirname, "target", ".token"))) {
+        log(' - please generate a ring token using ring-timelapse:token');
+        return false;
+    }
+
+    let token = readFileSync(path.resolve(__dirname, "target", ".token"), "utf8");
+
+    let systemId = (token as string).slice(0,32);
 
     const ringApi = new RingApi({
-        refreshToken: process.env.token as string,
+        refreshToken: token as string,
         systemId: systemId as string,
         controlCenterDisplayName: 'ring-timelapse',
         debug: false
     });
 
     ringApi.onRefreshTokenUpdated.subscribe(
         async ({ newRefreshToken, oldRefreshToken }) => {
-          process.env.token = newRefreshToken;
+            return writeFileSync(path.resolve(__dirname, "target", ".token"), newRefreshToken);
         }
     );
 

src/token.ts

@@ -1,3 +1,40 @@
 #!/usr/bin/env node
 "use strict";
-require('../node_modules/ring-client-api/ring-auth-cli');
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logRefreshToken = exports.acquireRefreshToken = void 0;
+const rest_client_1 = require("../node_modules/ring-client-api/lib/api/rest-client");
+const util_1 = require("../node_modules/ring-client-api/lib/api/");
+const fs = require('fs');
+async function acquireRefreshToken() {
+    const email = await (0, util_1.requestInput)('Email: '), password = await (0, util_1.requestInput)('Password: '), restClient = new rest_client_1.RingRestClient({ email, password }), getAuthWith2fa = async () => {
+        const code = await (0, util_1.requestInput)('2FA Code: ');
+        try {
+            return await restClient.getAuth(code);
+        }
+        catch (_) {
+            console.log('Incorrect code. Please try again.');
+            return getAuthWith2fa();
+        }
+    }, auth = await restClient.getCurrentAuth().catch((e) => {
+        if (restClient.promptFor2fa) {
+            console.log(restClient.promptFor2fa);
+            return getAuthWith2fa();
+        }
+        console.error(e);
+        process.exit(1);
+    });
+    return auth.refresh_token;
+}
+exports.acquireRefreshToken = acquireRefreshToken;
+async function logRefreshToken() {
+    const refreshToken = await acquireRefreshToken();
+    try {
+        fs.writeFileSync('/app/dist/target/.token', refreshToken);
+        console.log('\nSuccessfully generated a refresh token. You can now run ring-timelapse:snapshot\n');
+    } catch (err) {
+        console.error(err);
+    }
+}
+exports.logRefreshToken = logRefreshToken;
+process.on('unhandledRejection', () => { });
+logRefreshToken();

tsconfig.json

@@ -1,64 +1,12 @@
 {
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-    /* Basic Options */
-    // "incremental": true,                         /* Enable incremental compilation */
-    "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                                   /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                             /* Allow javascript files to be compiled. */
-    // "checkJs": true,                             /* Report errors in .js files. */
-    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-    "outDir": "./dist", /* Redirect output structure to the directory. */
-    "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                           /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-    /* Strict Type-Checking Options */
-    "strict": true, /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                    /* Enable strict null checks. */
-    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
-    /* Additional Checks */
-    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
-    /* Module Resolution Options */
-    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-    /* Advanced Options */
-    "skipLibCheck": true, /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+    "target": "es5",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
   }
 }