From 56142ab27577ec887959709739ae9422b5ac83b8 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:03:58 -0600 Subject: [PATCH 01/12] Ignore json files. --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 6704566..9399a8a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +*.json + + # Logs logs *.log From 47f19e4bc6f3a4d40fd35670fa03747d22432098 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:05:13 -0600 Subject: [PATCH 02/12] Ignore config --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 9399a8a..6713c46 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ *.json +src/config.ts # Logs From 937d379dae753e1fb9ce02c7161c92b1b29d3d60 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:05:23 -0600 Subject: [PATCH 03/12] Add config template. --- src/config.template.ts | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 src/config.template.ts diff --git a/src/config.template.ts b/src/config.template.ts new file mode 100644 index 0000000..54c4359 --- /dev/null +++ b/src/config.template.ts @@ -0,0 +1,8 @@ +export const CHANNEL: string = ""; + + +export const CLIENT_ID: string = ""; + + +export const USERNAME: string = ""; +export const OAUTH_TOKEN: string = ""; \ No newline at end of file From de8a0ac19ba6e32d091c7591ede4c20389c1a139 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:05:33 -0600 Subject: [PATCH 04/12] Add constants --- src/constants.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 src/constants.ts diff --git a/src/constants.ts b/src/constants.ts new file mode 100644 index 0000000..e131d3d --- /dev/null +++ b/src/constants.ts @@ -0,0 +1,10 @@ +// +// constants.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +export const TWITCH_URI: string = "https://api.twitch.tv/helix/streams"; + +export const DATAFILE: string = "data.temp.json"; \ No newline at end of file From 3a1cce6c39c86328d76c8f457f5bebc56a77c936 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:05:49 -0600 Subject: [PATCH 05/12] Add code for running the main bot. --- src/main.ts | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 src/main.ts diff --git a/src/main.ts b/src/main.ts new file mode 100644 index 0000000..bb09027 --- /dev/null +++ b/src/main.ts @@ -0,0 +1,17 @@ +// +// main.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +import { START_BOT } from "./Twitch" + + + +const MAIN = async () => { + START_BOT() +}; + + +MAIN() \ No newline at end of file From c803e7fd76eb87e122bc46cf723da38e10a01c79 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:06:14 -0600 Subject: [PATCH 06/12] Add main bot for actually interacting with Twitch and storing the data. --- src/Twitch.ts | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 src/Twitch.ts diff --git a/src/Twitch.ts b/src/Twitch.ts new file mode 100644 index 0000000..eac8d5d --- /dev/null +++ b/src/Twitch.ts @@ -0,0 +1,94 @@ +// +// Twitch.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +import * as requests from "request-promise-native"; +import * as tmi from "tmi.js"; + +import { TWITCH_URI } from "./constants"; +import * as config from "./config"; +import { + GET_FORMATTED_DATE, + WRITE_DATA, + LOAD_DATA +} from "./utils"; + + +const IS_LIVE = async (channel_name: string): Promise => { + + // Fetch the data from the Twitch API to check if the user is live + let response = await requests.get( + TWITCH_URI, + { + qs: { user_login: channel_name}, + headers: { + "Client-ID": config.CLIENT_ID + }, + json: true + } + ); + console.log(response) + return response.data.length !== 0; +}; + + + +export const START_BOT = async () => { + + const client = tmi.Client({ + options: { + debug: false, + clientId: config.CLIENT_ID + }, + connection: { + secure: true, + reconnect: true + }, + identity: { + username: config.USERNAME, + password: config.OAUTH_TOKEN + }, + channels: [config.CHANNEL] + }); + + client.on("cheer", (channel: string, ctx: tmi.Userstate, message: string) => { + + let bits: number = parseInt(ctx.bits); + let donator: string = ctx.username; + let date: string = GET_FORMATTED_DATE() + + let data: data = LOAD_DATA(); + + + // Ensure the channel is live when the bits are donated + if (!IS_LIVE(channel)) { return; }; + + + // Data already exists + if (data[date]) { + + // Check if the donator has already donated + if (!data[date].donators.includes(donator)) { + data[date].donators.push(donator); + }; + + // Add the bits to the total and the array of donations + data[date].total_bits += bits; + data[date].donations.push(bits); + } + + // Making new data point + else { + data[date] = { + total_bits: bits, + donators: [donator], + donations: [bits] + }; + }; + + WRITE_DATA(data); + }); +}; \ No newline at end of file From bffd0dd6e0feea1bdef1181b17a09c45ec0f234c Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:06:28 -0600 Subject: [PATCH 07/12] Add type declaration for the data structure. --- src/types.d.ts | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 src/types.d.ts diff --git a/src/types.d.ts b/src/types.d.ts new file mode 100644 index 0000000..7d8e33c --- /dev/null +++ b/src/types.d.ts @@ -0,0 +1,14 @@ +// +// types.d.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +interface data { + [key: string]: { + total_bits: number; + donators: string[]; + donations: number[]; + }; +} \ No newline at end of file From 8c41b1832d7974cff77b52ac9231da2cf285e822 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:06:48 -0600 Subject: [PATCH 08/12] Add functions for loading the data and generating the date string. --- src/utils.ts | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 src/utils.ts diff --git a/src/utils.ts b/src/utils.ts new file mode 100644 index 0000000..19d7d8c --- /dev/null +++ b/src/utils.ts @@ -0,0 +1,41 @@ +// +// utils.ts +// +// Written by: Tyler Akins (2020/01/06) +// + + +import { readFileSync, writeFileSync } from "fs" +import { DATAFILE } from "./constants"; + + + +export const GET_FORMATTED_DATE = () => { + let date = new Date(); + + let year = date.getFullYear(); + let month = date.getMonth() + 1; + let day = date.getDate(); + + return `${year}` + + `-${month < 10 ? `0${month}` : month}` + + `-${day < 10 ? `0${day}` : day}` +}; + + + +export const LOAD_DATA = (): data => { + let buffer = readFileSync(DATAFILE); + + // @ts-ignore + return JSON.parse(buffer); +}; + + + +export const WRITE_DATA = (data: data) => { + writeFileSync( + DATAFILE, + JSON.stringify(data) + ); +}; \ No newline at end of file From 6a0ed0bb6b2ea106a912e349e4d38678894301dc Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Tue, 7 Jan 2020 00:08:15 -0600 Subject: [PATCH 09/12] Unignore the npm and tsc configs. --- .gitignore | 2 ++ package.json | 28 +++++++++++++++++++++ tsconfig.json | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 99 insertions(+) create mode 100644 package.json create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index 6713c46..d0f5e81 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ *.json +!package.json +!tsconfig.json src/config.ts diff --git a/package.json b/package.json new file mode 100644 index 0000000..27efc86 --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "bit-stats-tracker", + "version": "1.0.0", + "description": "Tracks bit donation information in a specific Twitch channel.", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Tyler-A/bit-stats-tracker.git" + }, + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Tyler-A/bit-stats-tracker/issues" + }, + "homepage": "https://github.com/Tyler-A/bit-stats-tracker#readme", + "dependencies": { + "@types/node": "^13.1.4", + "@types/request": "^2.48.4", + "@types/request-promise-native": "^1.0.17", + "@types/tmi.js": "^1.4.0", + "request": "^2.88.0", + "request-promise-native": "^1.0.8", + "tmi.js": "^1.5.0" + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..ca796a6 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,69 @@ +{ + "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": "./dist", /* 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": [], /* 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. */ + }, + "include": [ + "src/" + ], + "exclude": [ + "src/config.template.ts" + ] +} \ No newline at end of file From 038e4cac26ee38dd00d8440732e744b9b5811254 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Wed, 8 Jan 2020 15:11:15 -0600 Subject: [PATCH 10/12] Add semicolon. --- src/main.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main.ts b/src/main.ts index bb09027..c9fd810 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,7 +1,7 @@ // // main.ts // -// Written by: Tyler Akins (2020/01/06) +// Written by: Tyler Akins (2020/01/06 - 2020/01/07) // @@ -10,7 +10,7 @@ import { START_BOT } from "./Twitch" const MAIN = async () => { - START_BOT() + START_BOT(); }; From 32f30a925a701739abee3f87521cdd93f44adfa7 Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Wed, 8 Jan 2020 15:11:43 -0600 Subject: [PATCH 11/12] Making it work, and storing some offline data as well because whynot? --- src/Twitch.ts | 79 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 52 insertions(+), 27 deletions(-) diff --git a/src/Twitch.ts b/src/Twitch.ts index eac8d5d..2c925f6 100644 --- a/src/Twitch.ts +++ b/src/Twitch.ts @@ -1,7 +1,7 @@ // // Twitch.ts // -// Written by: Tyler Akins (2020/01/06) +// Written by: Tyler Akins (2020/01/06 - 2020/01/08) // @@ -17,25 +17,28 @@ import { } from "./utils"; -const IS_LIVE = async (channel_name: string): Promise => { +const IS_LIVE = async (): Promise => { // Fetch the data from the Twitch API to check if the user is live let response = await requests.get( TWITCH_URI, { - qs: { user_login: channel_name}, + qs: { + "user_login": config.CHANNEL + }, headers: { "Client-ID": config.CLIENT_ID }, json: true } ); - console.log(response) + return response.data.length !== 0; }; + export const START_BOT = async () => { const client = tmi.Client({ @@ -54,7 +57,8 @@ export const START_BOT = async () => { channels: [config.CHANNEL] }); - client.on("cheer", (channel: string, ctx: tmi.Userstate, message: string) => { + + client.on("cheer", (ch: string, ctx: tmi.Userstate, msg: string) => { let bits: number = parseInt(ctx.bits); let donator: string = ctx.username; @@ -63,32 +67,53 @@ export const START_BOT = async () => { let data: data = LOAD_DATA(); - // Ensure the channel is live when the bits are donated - if (!IS_LIVE(channel)) { return; }; + IS_LIVE() + .then((response: boolean) => { + // Ensure the user is live + if (response) { + data["offline"].total_bits += bits; + data["offline"].donations.push(bits); + data["offline"].donators.push(donator) + } else { - // Data already exists - if (data[date]) { + // Data already exists + if (data[date]) { - // Check if the donator has already donated - if (!data[date].donators.includes(donator)) { - data[date].donators.push(donator); + // Check if the donator has already donated + if (!data[date].donators.includes(donator)) { + data[date].donators.push(donator); + }; + + // Add the bits to the total and the array of donations + data[date].total_bits += bits; + data[date].donations.push(bits); + } + + // Making new data point + else { + data[date] = { + total_bits: bits, + donators: [donator], + donations: [bits] + }; + }; }; - // Add the bits to the total and the array of donations - data[date].total_bits += bits; - data[date].donations.push(bits); - } - - // Making new data point - else { - data[date] = { - total_bits: bits, - donators: [donator], - donations: [bits] - }; - }; - - WRITE_DATA(data); + WRITE_DATA(data); + }) + .catch((err) => {throw err;}) }); + + + client.on("disconnected", (reason: string) => { + console.log(`* Disconnected from Twitch w/ reason: ${reason}`) + }); + + + client.on("connected", (addr: string, port: number) => { + console.log(`* Connected to Twitch on ${addr}:${port}`) + }); + + client.connect().catch((_) => {}); }; \ No newline at end of file From 3fa4e45e1afb289893cdcb9628dc8e2b5abc507d Mon Sep 17 00:00:00 2001 From: Tyler-A Date: Wed, 8 Jan 2020 15:12:03 -0600 Subject: [PATCH 12/12] Indent JSON so we aren't saving it grossly. --- src/utils.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/utils.ts b/src/utils.ts index 19d7d8c..e4a503e 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,11 +1,12 @@ // // utils.ts // -// Written by: Tyler Akins (2020/01/06) +// Written by: Tyler Akins (2020/01/06 - 2020/01/08) // import { readFileSync, writeFileSync } from "fs" +import { INDENT_DEPTH } from "./config"; import { DATAFILE } from "./constants"; @@ -36,6 +37,6 @@ export const LOAD_DATA = (): data => { export const WRITE_DATA = (data: data) => { writeFileSync( DATAFILE, - JSON.stringify(data) + JSON.stringify(data, null, INDENT_DEPTH) ); }; \ No newline at end of file