guratan 0.2.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 hankei6km
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# guratan
+
+Google Drive へファイルを送信する簡易ツール。
+
+## Usage
+
+```
+$ GOOGLE_APPLICATION_CREDENTIALS=./gha-creds-temp.json npx guratan send --parent-id 12345ABC --dest-file-name test.txt --src-file-name path/to/test.txt
+```
+
+- `GOOGLE_APPLICATION_CREDENTIALS` にはサービスアカウントの鍵ファイルを指定
+- 送信先フォルダー(`--parent-id`) に同名ファイル(`--dest-file-name`) が存在するときは上書きされる
+- 各オプションは環境変数での指定も可能(例. `--parent-id` = `GURATAN_PARENT_ID`)
+
+## License
+
+MIT License
+
+Copyright (c) 2022 hankei6km

package/dist/cli.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
+declare type Opts = {
+    parentId: string;
+    destFileName: string;
+    srcFileName: string;
+    printId: boolean;
+    stdout: Writable;
+    stderr: Writable;
+};
+export declare const cli: ({ parentId, destFileName, srcFileName, printId, stdout, stderr }: Opts) => Promise<number>;
+export {};

package/dist/cli.js

@@ -0,0 +1,15 @@
+import { driveClient, sendFile } from './tsend.js';
+export const cli = async ({ parentId, destFileName, srcFileName, printId, stdout, stderr }) => {
+    try {
+        const id = await sendFile(driveClient(), parentId, destFileName, srcFileName);
+        if (printId) {
+            stdout.write(id);
+        }
+    }
+    catch (err) {
+        stderr.write(err.toString());
+        stderr.write('\n');
+        return 1;
+    }
+    return 0;
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { sendFile } from './tsend.js';

package/dist/index.js

@@ -0,0 +1 @@
+export { sendFile } from './tsend.js';

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/main.js

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { cli } from './cli.js';
+const envVarsPrefix = process.env['GURATAN_ENV_VARS_PREFIX'] || 'GURATAN';
+const argv = await yargs(hideBin(process.argv))
+    .scriptName('guratan')
+    .env(envVarsPrefix)
+    .command('$0 send [OPTIONS]', 'send file to folder in Google Drive', (yargs) => {
+    return yargs.options({
+        'parent-id': {
+            type: 'string',
+            description: 'id of folder in Google Deive'
+        },
+        'dest-file-name': {
+            type: 'string',
+            description: 'file name in Google Drive'
+        },
+        'src-file-name': {
+            type: 'string',
+            description: 'file name in local filesystem'
+        },
+        'print-id': {
+            type: 'boolean',
+            required: false,
+            default: false,
+            description: 'print id of file that is sended into Google Drive'
+        }
+    });
+})
+    .demand(0)
+    .help().argv;
+process.exit(await cli({
+    parentId: argv['parent-id'] || '',
+    destFileName: argv['dest-file-name'] || '',
+    srcFileName: argv['src-file-name'] || '',
+    printId: argv['print-id'] || false,
+    stdout: process.stdout,
+    stderr: process.stderr
+}));

package/dist/tsend.d.ts

@@ -0,0 +1,48 @@
+import { drive_v3 } from '@googleapis/drive';
+export declare class GetFileIdError extends Error {
+    constructor(message: string);
+}
+export declare class UploadFileError extends Error {
+    constructor(message: string);
+}
+export declare class UpdateFileError extends Error {
+    constructor(message: string);
+}
+/**
+ * Validate value that is used in query parameter.
+ * return false if value has included "'">
+ * @param s - value string.
+ * @returns result of validation.
+ */
+export declare function validateQueryValue(s: string): boolean;
+/**
+ * Make instacen of drive that is authenticated.
+ * @returns instance of drive.
+ */
+export declare function driveClient(): drive_v3.Drive;
+/**
+ * Get file id in spesiced parent.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param fileName  - file name.
+ * @returns id of file or blank(when file is not found)
+ */
+export declare function getFileId(drive: drive_v3.Drive, parentId: string, fileName: string): Promise<string>;
+/**
+ * Create file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param destFileName - file name in Google Drive.
+ * @param srcFileName - file name in local filesystem.
+ * @returns id of file in Google Drive
+ */
+export declare function uploadFile(drive: drive_v3.Drive, parentId: string, destFileName: string, srcFileName: string): Promise<string>;
+/**
+ * Update file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param fileId  - id of file in Google Deive.
+ * @param srcFileName - file name in local filesystem.
+ * @returns id of file in Google Drive
+ */
+export declare function updateFile(drive: drive_v3.Drive, fileId: string, srcFileName: string): Promise<string>;
+export declare function sendFile(drive: drive_v3.Drive, parentId: string, destFileName: string, srcFileName: string): Promise<string>;

package/dist/tsend.js

@@ -0,0 +1,150 @@
+import * as path from 'path';
+import * as fs from 'fs';
+import { drive as gdrive } from '@googleapis/drive';
+import { GoogleAuth } from 'google-auth-library';
+export class GetFileIdError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, GetFileIdError.prototype);
+    }
+}
+export class UploadFileError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, UploadFileError.prototype);
+    }
+}
+export class UpdateFileError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, UpdateFileError.prototype);
+    }
+}
+/**
+ * Validate value that is used in query parameter.
+ * return false if value has included "'">
+ * @param s - value string.
+ * @returns result of validation.
+ */
+export function validateQueryValue(s) {
+    if (s.indexOf("'") >= 0) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Make instacen of drive that is authenticated.
+ * @returns instance of drive.
+ */
+export function driveClient() {
+    const SCOPES = ['https://www.googleapis.com/auth/drive.file'];
+    const auth = new GoogleAuth({
+        scopes: SCOPES
+    });
+    return gdrive({ version: 'v3', auth });
+}
+/**
+ * Get file id in spesiced parent.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param fileName  - file name.
+ * @returns id of file or blank(when file is not found)
+ */
+export async function getFileId(drive, parentId, fileName) {
+    try {
+        if (validateQueryValue(parentId) === false) {
+            throw new GetFileIdError(`Invalid paretnt id : ${parentId}`);
+        }
+        if (validateQueryValue(fileName) === false) {
+            throw new GetFileIdError(`Invalid file name : ${fileName}`);
+        }
+        const list = await drive.files.list({
+            pageSize: 10,
+            q: `'${parentId}' in parents and name = '${fileName}'`,
+            fields: 'files(id, name)'
+        });
+        if (list.data.files && list.data.files.length > 0) {
+            return list.data.files[0].id || '';
+        }
+        return '';
+    }
+    catch (err) {
+        if (err.errors) {
+            throw new GetFileIdError(JSON.stringify(err.errors));
+        }
+        throw err;
+    }
+}
+/**
+ * Create file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param destFileName - file name in Google Drive.
+ * @param srcFileName - file name in local filesystem.
+ * @returns id of file in Google Drive
+ */
+export async function uploadFile(drive, parentId, destFileName, srcFileName) {
+    try {
+        const res = await drive.files.create({
+            requestBody: {
+                name: path.basename(destFileName),
+                parents: [parentId]
+            },
+            media: {
+                // mimeType: 'image/jpeg',
+                body: fs.createReadStream(srcFileName)
+            },
+            fields: 'id'
+        });
+        return res.data.id || '';
+    }
+    catch (err) {
+        throw new UploadFileError(JSON.stringify(err.errors));
+    }
+}
+/**
+ * Update file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param fileId  - id of file in Google Deive.
+ * @param srcFileName - file name in local filesystem.
+ * @returns id of file in Google Drive
+ */
+export async function updateFile(drive, fileId, srcFileName) {
+    try {
+        const res = await drive.files.update({
+            fileId,
+            requestBody: {},
+            media: {
+                // mimeType: 'image/jpeg',
+                body: fs.createReadStream(srcFileName)
+            },
+            fields: 'id'
+        });
+        return res.data.id || '';
+    }
+    catch (err) {
+        throw new UpdateFileError(JSON.stringify(err.errors));
+    }
+}
+export async function sendFile(drive, parentId, destFileName, srcFileName) {
+    const fileId = await getFileId(drive, parentId, destFileName);
+    if (fileId === '') {
+        return uploadFile(drive, parentId, destFileName, srcFileName);
+    }
+    return updateFile(drive, fileId, srcFileName);
+}
+// try {
+//   const parentId = process.env['PARENT_ID'] || ''
+//   const destFileName = process.env['DEST_FILE_NAME'] || ''
+//   const srcFileName = process.env['SRC_FILE_NAME'] || ''
+//   const drive = driveClient()
+//   const id = await getFileId(drive, parentId, destFileName)
+//   console.log(id)
+//   console.log(await updateFile(drive, id, srcFileName))
+// } catch (err) {
+//   console.error('--err--')
+//   console.error(err)
+// }

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "guratan",
+  "version": "0.2.0",
+  "description": "Tiny send tool for Google Drive",
+  "author": "hankei6km <hankei6km@gmail.com> (https://github.com/hankei6km)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/hankei6km/tsend.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hankei6km/tsend/issues"
+  },
+  "keywords": [
+    "google",
+    "drive"
+  ],
+  "main": "dist/index.js",
+  "exports": "./dist/index.js",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "bin": {
+    "guratan": "dist/main.js"
+  },
+  "scripts": {
+    "start": "npm run build && node dist/main.js",
+    "build": "npm run clean && tsc && rimraf dist/test && mv dist/src/* dist/ && rimraf dist/src",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest",
+    "clean": "rimraf \"dist/*\"",
+    "upgrade-interactive": "npm-check --update",
+    "csb:test": "npm test -- --runInBand --watchAll"
+  },
+  "dependencies": {
+    "@googleapis/drive": "^2.3.0",
+    "yargs": "^17.3.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.21",
+    "@types/yargs": "^17.0.9",
+    "jest": "^27.5.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.2"
+  }
+}