diff --git a/.gitignore b/.gitignore index 6704566..0d2b293 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +src/config.ts +package-lock.json +built/* + # Logs logs *.log diff --git a/package.json b/package.json new file mode 100644 index 0000000..bd89820 --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "quote-of-the-day", + "version": "1.0.0", + "description": "A method for sending a quote every day to a Discord webhook from the Twitch Center API for quotes", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Tyler-A/quote-of-the-day.git" + }, + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Tyler-A/quote-of-the-day/issues" + }, + "homepage": "https://github.com/Tyler-A/quote-of-the-day#readme", + "dependencies": { + "@types/node": "^13.1.2", + "@types/request": "^2.48.4", + "@types/request-promise-native": "^1.0.17", + "request": "^2.88.0", + "request-promise-native": "^1.0.8" + } +} diff --git a/src/config.template.ts b/src/config.template.ts new file mode 100644 index 0000000..93d846d --- /dev/null +++ b/src/config.template.ts @@ -0,0 +1,11 @@ +// The number of seconds between each push, this must be a minimum of 300 +export const DELAY: number = 24 * 60 * 60 + + +// The twitch.center URL for the quotes list, this endpoint must return a +// plaintext response with newline characters separating each quote +export const QUOTE_URL: string = ``; + + +// The Discord webhook URL that we are sending the quotes to. +export const DISCORD_WEBHOOK: string = ``; \ No newline at end of file diff --git a/src/main.ts b/src/main.ts new file mode 100644 index 0000000..53028fd --- /dev/null +++ b/src/main.ts @@ -0,0 +1,44 @@ +// +// main.ts +// +// Written by: Tyler Akins (2019/12/31) +// + + +import { GET_RANDOM_QUOTE } from "./utils/api"; +import { WEBHOOK_PUSH } from "./utils/webhook"; +import { DELAY } from "./config"; + + + +const MAIN = async () => { + const args = process.argv; + + + if (args.includes("--single")) { + console.log(`* Emitting a quote`) + let quote = await GET_RANDOM_QUOTE(); + await WEBHOOK_PUSH(quote); + process.exit(0); + }; + + + if (args.includes("--repeat")) { + + if (DELAY < 30) { + console.log("Can't have a delay < 30 seconds."); + process.exit(1); + }; + + setInterval( + async () => { + console.log(`* Emitting a quote`) + await WEBHOOK_PUSH(await GET_RANDOM_QUOTE()); + }, + DELAY * 1000 + ); + }; +}; + + +MAIN(); \ No newline at end of file diff --git a/src/utils/api.ts b/src/utils/api.ts new file mode 100644 index 0000000..fa89089 --- /dev/null +++ b/src/utils/api.ts @@ -0,0 +1,18 @@ +// +// api.ts +// +// Written by: Tyler Akins (2019/12/31) +// + + +import * as requests from "request-promise-native" +import { QUOTE_URL } from "../config"; + + +export const GET_RANDOM_QUOTE = async (): Promise => { + let response = await requests.get(QUOTE_URL); + + let quotes = response.split("\n") + + return quotes[Math.floor(Math.random() * quotes.length)]; +}; \ No newline at end of file diff --git a/src/utils/webhook.ts b/src/utils/webhook.ts new file mode 100644 index 0000000..31d8ac7 --- /dev/null +++ b/src/utils/webhook.ts @@ -0,0 +1,25 @@ +// +// webhook.ts +// +// Written by: Tyler Akins (2019/12/31) +// + + +import * as requests from "request-promise-native"; +import { DISCORD_WEBHOOK } from "../config"; + + +export const WEBHOOK_PUSH = async (quote: string): Promise => { + return await requests.post({ + uri: DISCORD_WEBHOOK, + body: { + content: quote + }, + qs: { + wait: true + }, + json: true + }) + .then(() => {return true}) + .catch(() => {return false}); +}; \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..202f560 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,68 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 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', or 'react'. */ + // "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": "./built", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* 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. */ + + /* 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": [ + "./src" + ], /* 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": "./src", /* 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. */ + }, + "exclude": [ + "./src/*.template.ts" + ] +}