feat: Introduce a method for setting credentials (setConfig()) that d…

.npmignore

@@ -3,6 +3,4 @@ src
 build/example.js
 .vscode
 .env.example
-babel.config.js
-jest.config.js
 tsconfig.json

README.md

@@ -30,8 +30,10 @@ This library looks for the terms "lynx blue line" and "delay" to determine if a
 
 1. You'll need to register your own [Twitter Application](https://developer.twitter.com)
 2. Generate a Bearer token
-3. Create a `.env` using the provided `.env.example` with your Twitter application credentials
-4. Follow the example code in `src/example.ts` for your own implementation
+3. Follow the example code in `src/example.ts` for your own implementation
+   - The first thing you'll need to call is `setConfig` and pass it an object with your `{BEARER_TOKEN: ''}`.
+   - `CONSUMER_KEY` and `CONSUMER_SECRET` _can_ be set if you want. Streamlined auto-auth may be added in the future.
+   - The example code uses `dotenv`; Create a `.env` using the provided `.env.example` with your Twitter application credentials. If you want to use this method in the future you'll need to install `dotenv` into your own project.
 
 ### Libraries
 

package.json

@@ -1,27 +1,21 @@
 {
   "name": "@opencltbrigade/cats-tweet-analyzer",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "description": "",
   "main": "./build/index.js",
   "private": false,
   "scripts": {
-    "test": "jest",
     "build": "tsc",
     "start": "tsc && node ./build/example.js"
   },
   "author": "Open Charlotte Brigade",
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "^7.6.2",
-    "@babel/preset-env": "^7.6.2",
-    "@babel/preset-typescript": "^7.6.0",
     "@types/node": "^12.7.5",
-    "babel-jest": "^24.9.0",
-    "jest": "^24.9.0",
-    "typescript": "^3.6.3"
+    "typescript": "^3.6.3",
+    "dotenv": "^8.1.0"
   },
   "dependencies": {
-    "dotenv": "^8.1.0",
     "node-fetch": "^2.6.0",
     "twitter": "^1.7.1"
   }

src/example.ts

@@ -1,9 +1,14 @@
 import getTimelineAnalysis from './getTimelineAnalysis';
-import { getTimeline } from './lib';
+import { getTimeline, setConfig } from './lib';
 import { AnalyzedTweet } from './types';
 
+require('dotenv').config();
+
 const displayAlertTweets = async () => {
   try {
+    const { TWITTER_BEARER_TOKEN } = process.env;
+    setConfig({ BEARER_TOKEN: TWITTER_BEARER_TOKEN });
+
     const tweets: Array<AnalyzedTweet> = await getTimelineAnalysis();
     const filtered = tweets.filter(
       (tweet) =>

src/index.ts

@@ -1,4 +1,9 @@
 import getTimelineAnalysis from './getTimelineAnalysis';
-import { analyzeTweets, getTimeline, getTwitterClient } from './lib';
+import {
+  analyzeTweets,
+  getTimeline,
+  getTwitterClient,
+  setConfig
+  } from './lib';
 
-export { getTimeline, analyzeTweets, getTwitterClient, getTimelineAnalysis };
+export { getTimeline, analyzeTweets, getTwitterClient, getTimelineAnalysis, setConfig };

src/lib/config.ts

@@ -0,0 +1,15 @@
+import { Configuration } from '../types';
+
+let config: Configuration = {
+  CONSUMER_KEY: '',
+  CONSUMER_SECRET: '',
+  BEARER_TOKEN: ''
+};
+
+export const setConfig = (newValues: Configuration): void => {
+  config = { ...config, ...newValues };
+};
+
+export const getConfig = (): Configuration => {
+  return { ...config };
+};

src/lib/getTwitterClient.ts

@@ -1,13 +1,14 @@
-require('dotenv').config();
+import { getConfig } from '.';
+
 const TwitterClient = require('twitter');
 
 export function getTwitterClient() {
-  const { TWITTER_CONSUMER_KEY, TWITTER_CONSUMER_SECRET, TWITTER_BEARER_TOKEN } = process.env;
+  const { CONSUMER_KEY: consumer_key, CONSUMER_SECRET: consumer_secret, BEARER_TOKEN: bearer_token } = getConfig();
 
   const twitter = new TwitterClient({
-    consumer_key: TWITTER_CONSUMER_KEY,
-    consumer_secret: TWITTER_CONSUMER_SECRET,
-    bearer_token: TWITTER_BEARER_TOKEN
+    consumer_key,
+    consumer_secret,
+    bearer_token
   });
   return twitter;
 }

src/lib/index.ts

@@ -1,5 +1,6 @@
 import analyzeTweets from './analyzeTweets';
+import { getConfig, setConfig } from './config';
 import getTimeline from './getTimeline';
 import getTwitterClient from './getTwitterClient';
 
-export { getTwitterClient, getTimeline, analyzeTweets };
+export { getTwitterClient, getTimeline, analyzeTweets, getConfig, setConfig };

src/types/Configuration.ts

@@ -0,0 +1,7 @@
+export interface Configuration {
+  CONSUMER_KEY?: string;
+  CONSUMER_SECRET?: string;
+  BEARER_TOKEN?: string;
+}
+
+export default Configuration;

src/types/index.ts

@@ -1,8 +1,9 @@
 import AnalyzedTweet from './AnalyzedTweet';
+import Configuration from './Configuration';
 import NestedTweet from './NestedTweet';
 import ServiceDelayData from './ServiceDelayData';
 import ServiceRestorationData from './ServiceRestorationData';
 import TimelineResponse from './TimelineResponse';
 import Tweet from './Tweet';
 
-export { Tweet, TimelineResponse, AnalyzedTweet, ServiceDelayData, ServiceRestorationData, NestedTweet };
+export { Tweet, TimelineResponse, AnalyzedTweet, ServiceDelayData, ServiceRestorationData, NestedTweet, Configuration };