Add block list

Author: iranianpep

src/__tests__/__fixtures__/config.ts

@@ -18,7 +18,8 @@ export const getTweetDefaultConfigs = (overrides?: Partial<TweetConfig>, userCon
         minFavs: 3,
         minFavsToFollowers: 0.02,
         hashtagsLimit: 5,
-        userConfig: getUserDefaultConfigs(userConfigOverrides)
+        userConfig: getUserDefaultConfigs(userConfigOverrides),
+        wordBlockList: []
     };
 
     return {...defaultConfigs, ...overrides};

src/__tests__/entities/tweet.test.ts

@@ -145,6 +145,56 @@ describe('Tweet', () => {
         });
     });
 
+    describe('hasBlockListedWord', () => {
+        it('should return true if word block list is in tweet', () => {
+            const tweet = new Tweet(
+                getRawTweet({
+                    text: 'this tweet has a bad word in it'
+                }),
+                getTweetDefaultConfigs({
+                    wordBlockList: ['bad', 'worst']
+                })
+            );
+
+            expect(tweet.hasBlockListedWord()).toBe(true);
+        });
+
+        it('should return false if word block list is empty', () => {
+            const tweet = new Tweet(
+                getRawTweet(),
+                getTweetDefaultConfigs()
+            );
+
+            expect(tweet.hasBlockListedWord()).toBe(false);
+        });
+
+        it('should return false if tweet text is empty', () => {
+            const tweet = new Tweet(
+                getRawTweet({
+                    text: ''
+                }),
+                getTweetDefaultConfigs({
+                    wordBlockList: ['bad', 'worst']
+                })
+            );
+
+            expect(tweet.hasBlockListedWord()).toBe(false);
+        });
+
+        it('should return false if word block list is NOT in tweet', () => {
+            const tweet = new Tweet(
+                getRawTweet({
+                    text: 'this is a good tweet'
+                }),
+                getTweetDefaultConfigs({
+                    wordBlockList: ['bad', 'worst']
+                })
+            );
+
+            expect(tweet.hasBlockListedWord()).toBe(false);
+        });
+    });
+
     describe('isReTweetable', () => {
         it('should return true if tweet is eligible to be retweeted', () => {
             const tweet = new Tweet(getRawTweet({
@@ -288,6 +338,22 @@ describe('Tweet', () => {
             expect(tweet.retweetError).toBe('Tweet is withheld');
         });
 
+        it('should return false if tweet has a block listed word', () => {
+            const tweet = new Tweet(getRawTweet({
+                text: 'this tweet is the worst.',
+                favorite_count: 1000,
+                user: getRawUser({
+                    followers_count: 1000,
+                    statuses_count: 1000,
+                })
+            }), getTweetDefaultConfigs({
+                wordBlockList: ['worst']
+            }));
+
+            expect(tweet.isReTweetable()).toBe(false);
+            expect(tweet.retweetError).toBe('Tweet has block listed word in it');
+        });
+
         it('should return false if user is not eligible', () => {
             const tweet = new Tweet(getRawTweet({
                 favorite_count: 1000,

src/entities/Tweet.ts

@@ -7,7 +7,8 @@ export type TweetConfig = {
     minFavs: number,
     minFavsToFollowers: number,
     hashtagsLimit: number,
-    userConfig: TweetUserConfig
+    userConfig: TweetUserConfig,
+    wordBlockList?: string[]
 };
 
 export default class Tweet extends ReTweetableAbstract {
@@ -54,6 +55,17 @@ export default class Tweet extends ReTweetableAbstract {
         return Helper.objectExists(this.rawTweet.withheld_copyright) && this.rawTweet.withheld_copyright;
     }
 
+    hasBlockListedWord(): boolean {
+        if (!Helper.objectExists(this.config.wordBlockList)
+        || !Helper.objectExists(this.rawTweet.text)) {
+            return false;
+        }
+
+        const tweetText = this.rawTweet.text.toLowerCase();
+
+        return this.config.wordBlockList.some(blockListedWord => tweetText.includes(blockListedWord.toLowerCase()));
+    }
+
     getRetweetValidations(): Validation[] {
         return [
             {
@@ -84,6 +96,10 @@ export default class Tweet extends ReTweetableAbstract {
                 validate: () => this.isWithheld(),
                 message: () => 'Tweet is withheld'
             },
+            {
+                validate: () => this.hasBlockListedWord(),
+                message: () => 'Tweet has block listed word in it'
+            },
             {
                 validate: () => !this.tweetUser.isReTweetable(),
                 message: () => this.tweetUser.retweetError