dorky 2.1.4 → 2.1.6

package/README.md

@@ -85,5 +85,4 @@ Anyhow, we shall store it on a private storage, using **dorky**, that stores it
 ## To-Do
 
 [ ] Add stages for variables.
-[ ] Convert to TypeScript.
 

package/bin/index.js

@@ -104,7 +104,7 @@ async function init(storage) {
     var credentials;
     switch (storage) {
         case "aws":
-            credentials = { storage: "aws", acessKey: process.env.AWS_ACCESS_KEY, secretKey: process.env.AWS_SECRET_KEY, region: process.env.AWS_REGION, bucket: process.env.BUCKET_NAME }
+            credentials = { storage: "aws", accessKey: process.env.AWS_ACCESS_KEY, secretKey: process.env.AWS_SECRET_KEY, awsRegion: process.env.AWS_REGION, bucket: process.env.BUCKET_NAME }
             setupFilesAndFolders(metaData, credentials);
             break;
         case "google-drive":
@@ -172,22 +172,53 @@ function rm(listOfFiles) {
     else console.log(chalk.red("No files found that can be removed."));
 }
 
-function checkCredentials() {
-    const credentials = JSON.parse(fs.readFileSync(".dorky/credentials.json"));
-    // This only works for AWS S3, add credential checker for google drive also, fix this => TP | 2024-09-28 16:04:41
-    if (credentials.accessKey && credentials.secretKey && credentials.region && credentials.bucket) {
-        if (process.env.AWS_ACCESS_KEY && process.env.AWS_SECRET_KEY && process.env.AWS_REGION && process.env.BUCKET_NAME) {
-            return true;
+async function checkCredentials() {
+    try {
+        if (fs.existsSync(".dorky/credentials.json")) {
+            const credentials = JSON.parse(fs.readFileSync(".dorky/credentials.json"));
+            if (credentials.storage === "google-drive") {
+                if (credentials.access_token && credentials.scope && credentials.token_type && credentials.expiry_date) return true;
+                else return false;
+            } else {
+                if (credentials.accessKey && credentials.secretKey && credentials.awsRegion && credentials.bucket) return true;
+                else return false;
+            }
         } else {
-            console.log(chalk.red("Please provide credentials in .dorky/credentials.json"));
-            return false;
+            console.log("Setting the credentials again.")
+            if (process.env.AWS_ACCESS_KEY && process.env.AWS_SECRET_KEY && process.env.AWS_REGION && process.env.BUCKET_NAME) {
+                fs.writeFileSync(".dorky/credentials.json", JSON.stringify({
+                    "storage": "aws",
+                    "accessKey": process.env.AWS_ACCESS_KEY,
+                    "secretKey": process.env.AWS_SECRET_KEY,
+                    "awsRegion": process.env.AWS_REGION,
+                    "bucket": process.env.BUCKET_NAME
+                }, null, 2));
+                return true;
+            } else {
+                try {
+                    let credentials;
+                    const client = await authorizeGoogleDriveClient();
+                    credentials = { storage: "google-drive", ...client.credentials };
+                    fs.writeFileSync(".dorky/credentials.json", JSON.stringify(credentials, null, 2));
+                    console.log(chalk.green("Credentials saved in .dorky/credentials.json"));
+                    console.log(chalk.red("Please ignore the warning to set credentials below and run the command again."));
+                    return false;
+                } catch (err) {
+                    console.log(chalk.red("Failed to authorize Google Drive client: " + err.message));
+                    console.log(chalk.red("Please provide credentials in .dorky/credentials.json"));
+                    return false;
+                }
+            }
         }
-    } else return true;
+    } catch (err) {
+        console.log(chalk.red("Please provide credentials in .dorky/credentials.json"));
+        return false;
+    }
 }
 
-function push() {
+async function push() {
     checkIfDorkyProject();
-    if (!checkCredentials()) {
+    if (!(await checkCredentials())) {
         console.log(chalk.red("Please setup credentials in environment variables or in .dorky/credentials.json"));
         return;
     }
@@ -228,7 +259,7 @@ function push() {
 function pushToS3(files, credentials) {
     const s3 = new S3Client({
         credentials: {
-            accessKeyId: credentials.acessKey ?? process.env.AWS_ACCESS_KEY,
+            accessKeyId: credentials.accessKey ?? process.env.AWS_ACCESS_KEY,
             secretAccessKey: credentials.secretKey ?? process.env.AWS_SECRET_KEY
         },
         region: credentials.awsRegion ?? process.env.AWS_REGION
@@ -304,9 +335,9 @@ async function pushToGoogleDrive(files) {
     }
 }
 
-function pull() {
+async function pull() {
     checkIfDorkyProject();
-    if (!checkCredentials()) {
+    if (!(await checkCredentials())) {
         console.log(chalk.red("Please setup credentials in environment variables or in .dorky/credentials.json"));
         return;
     }
@@ -330,7 +361,7 @@ function pull() {
 function pullFromS3(files, credentials) {
     const s3 = new S3Client({
         credentials: {
-            accessKeyId: credentials.acessKey ?? process.env.AWS_ACCESS_KEY,
+            accessKeyId: credentials.accessKey ?? process.env.AWS_ACCESS_KEY,
             secretAccessKey: credentials.secretKey ?? process.env.AWS_SECRET_KEY
         },
         region: credentials.awsRegion ?? process.env.AWS_REGION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dorky",
-  "version": "2.1.4",
+  "version": "2.1.6",
   "description": "DevOps Records Keeper.",
   "bin": {
     "dorky": "bin/index.js"
@@ -40,4 +40,4 @@
     "mime-types": "^2.1.35",
     "yargs": "^17.7.2"
   }
-}
+}

package/web-app/package-lock.json

@@ -13,6 +13,7 @@
         "@testing-library/user-event": "^13.5.0",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
+        "react-router": "^7.1.1",
         "react-scripts": "5.0.1",
         "web-vitals": "^2.1.4"
       },
@@ -3701,6 +3702,12 @@
         "@types/node": "*"
       }
     },
+    "node_modules/@types/cookie": {
+      "version": "0.6.0",
+      "resolved": "https://registry.npmjs.org/@types/cookie/-/cookie-0.6.0.tgz",
+      "integrity": "sha512-4Kh9a6B2bQciAhf7FSuMRRkUWecJgJu9nPnx3yzpsfXX/c50REIqpHY4C82bXP90qrLtXtkDxTZosYO3UpOwlA==",
+      "license": "MIT"
+    },
     "node_modules/@types/eslint": {
       "version": "8.56.12",
       "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.56.12.tgz",
@@ -14258,6 +14265,39 @@
         "node": ">=0.10.0"
       }
     },
+    "node_modules/react-router": {
+      "version": "7.1.1",
+      "resolved": "https://registry.npmjs.org/react-router/-/react-router-7.1.1.tgz",
+      "integrity": "sha512-39sXJkftkKWRZ2oJtHhCxmoCrBCULr/HAH4IT5DHlgu/Q0FCPV0S4Lx+abjDTx/74xoZzNYDYbOZWlJjruyuDQ==",
+      "license": "MIT",
+      "dependencies": {
+        "@types/cookie": "^0.6.0",
+        "cookie": "^1.0.1",
+        "set-cookie-parser": "^2.6.0",
+        "turbo-stream": "2.4.0"
+      },
+      "engines": {
+        "node": ">=20.0.0"
+      },
+      "peerDependencies": {
+        "react": ">=18",
+        "react-dom": ">=18"
+      },
+      "peerDependenciesMeta": {
+        "react-dom": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/react-router/node_modules/cookie": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/cookie/-/cookie-1.0.2.tgz",
+      "integrity": "sha512-9Kr/j4O16ISv8zBBhJoi4bXOYNTkFLOqSL3UDB0njXxCXNezjeyVrJyGOWtgfs/q2km1gwBcfH8q1yEGoMYunA==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=18"
+      }
+    },
     "node_modules/react-scripts": {
       "version": "5.0.1",
       "resolved": "https://registry.npmjs.org/react-scripts/-/react-scripts-5.0.1.tgz",
@@ -15121,6 +15161,12 @@
         "node": ">= 0.8.0"
       }
     },
+    "node_modules/set-cookie-parser": {
+      "version": "2.7.1",
+      "resolved": "https://registry.npmjs.org/set-cookie-parser/-/set-cookie-parser-2.7.1.tgz",
+      "integrity": "sha512-IOc8uWeOZgnb3ptbCURJWNjWUPcO3ZnTTdzsurqERrP6nPyv+paC55vJM0LpOlT2ne+Ix+9+CRG1MNLlyZ4GjQ==",
+      "license": "MIT"
+    },
     "node_modules/set-function-length": {
       "version": "1.2.2",
       "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz",
@@ -16498,6 +16544,12 @@
       "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==",
       "license": "0BSD"
     },
+    "node_modules/turbo-stream": {
+      "version": "2.4.0",
+      "resolved": "https://registry.npmjs.org/turbo-stream/-/turbo-stream-2.4.0.tgz",
+      "integrity": "sha512-FHncC10WpBd2eOmGwpmQsWLDoK4cqsA/UT/GqNoaKOQnT8uzhtCbg3EoUDMvqpOSAI0S26mr0rkjzbOO6S3v1g==",
+      "license": "ISC"
+    },
     "node_modules/type-check": {
       "version": "0.4.0",
       "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz",

package/web-app/package.json

@@ -8,6 +8,7 @@
     "@testing-library/user-event": "^13.5.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
+    "react-router": "^7.1.1",
     "react-scripts": "5.0.1",
     "web-vitals": "^2.1.4"
   },

package/web-app/src/PrivacyPolicy.js

@@ -0,0 +1,26 @@
+export default function PrivacyPolicy() {
+    return (
+        <div className="p-8 text-white">
+            <h1 className="text-3xl font-bold mb-4">Privacy Policy</h1>
+            <p className="mb-4"><strong>Effective Date:</strong> 28th December 2024</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Introduction</h2>
+            <p className="mb-4">Dorky is committed to protecting your privacy. This Privacy Policy outlines our practices regarding the collection, use, and disclosure of information when you use our software.</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Information Collection and Use</h2>
+            <p className="mb-4">Dorky does not collect, store, or transmit any personal data from its users. All operations are performed locally on your machine, and any interactions with storage services like AWS S3 or Google Drive are conducted directly between your environment and the respective service.</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Third-Party Services</h2>
+            <p className="mb-4">While Dorky facilitates the storage of files on third-party services such as AWS S3 and Google Drive, it does not transmit any data to these services on its own. Users are responsible for configuring and managing their credentials and data with these services.</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Security</h2>
+            <p className="mb-4">We prioritize the security of your data. However, it's essential to ensure that your environment and the third-party services you use are properly secured and that you follow best practices for credential management.</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Changes to This Privacy Policy</h2>
+            <p className="mb-4">We may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on our GitHub repository.</p>
+
+            <h2 className="text-2xl font-semibold mb-2">Contact Us</h2>
+            <p className="mb-4">If you have any questions about this Privacy Policy, please contact us through our GitHub repository's issue tracker.</p>
+        </div>
+    );
+}

package/web-app/src/TermsAndConditions.js

@@ -0,0 +1,41 @@
+import React from 'react';
+
+export default function TermsAndConditions() {
+    return (
+        <div className="p-6 shadow-md rounded-lg">
+            <h1 className="text-2xl font-bold mb-4">Terms and Conditions</h1>
+            <p className="mb-2"><strong>Effective Date:</strong> 28th December 2024</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Acceptance of Terms</h2>
+            <p className="mb-2">By using Dorky, you agree to comply with and be bound by these Terms and Conditions. If you do not agree, please do not use the software.</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">License</h2>
+            <p className="mb-2">Dorky is licensed under the <strong> MIT License</strong>. You may use, distribute, and modify the software in accordance with the terms of this license.</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Usage Restrictions</h2>
+            <ul className="list-disc list-inside mb-2">
+                <li>Do not use Dorky for any illegal or unauthorized purposes.</li>
+                <li>Ensure that your use of Dorky does not violate any applicable laws or regulations.</li>
+            </ul>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Limitation of Liability</h2>
+            <p className="mb-2">Dorky is provided "as is," without warranty of any kind. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability arising from the use of the software.</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">User Responsibilities</h2>
+            <ul className="list-disc list-inside mb-2">
+                <li>Maintain the confidentiality of any credentials used with Dorky.</li>
+                <li>Ensure that you have the necessary permissions to store and manage files on third-party services.</li>
+            </ul>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Modifications to the Software</h2>
+            <p className="mb-2">We reserve the right to modify, suspend, or discontinue Dorky at any time without prior notice.</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Governing Law</h2>
+            <p className="mb-2">These Terms and Conditions are governed by and construed in accordance with the laws of <strong>[Insert Jurisdiction]</strong>.</p>
+
+            <h2 className="text-xl font-semibold mt-4 mb-2">Contact Information</h2>
+            <p className="mb-2">For any questions or concerns regarding these Terms and Conditions, please reach out via the issue tracker on our GitHub repository.</p>
+
+        </div>
+    );
+}

package/web-app/src/index.js

@@ -1,13 +1,22 @@
 import React from 'react';
 import ReactDOM from 'react-dom/client';
+import { BrowserRouter, Routes, Route } from 'react-router';
 import './index.css';
 import App from './App';
+import PrivacyPolicy from './PrivacyPolicy';
 import reportWebVitals from './reportWebVitals';
+import TermsAndConditions from './TermsAndConditions';
 
 const root = ReactDOM.createRoot(document.getElementById('root'));
 root.render(
   <React.StrictMode>
-    <App />
+    <BrowserRouter>
+      <Routes>
+        <Route path="/" element={<App />} />
+        <Route path="/privacy-policy" element={<PrivacyPolicy />} />
+        <Route path="/terms-and-conditions" element={<TermsAndConditions />} />
+      </Routes>
+    </BrowserRouter>
   </React.StrictMode>
 );