Merge pull request #66 from SpiceBot/development

Development

sopel_modules/SpiceBot/Sherlock.py

@@ -0,0 +1,89 @@
+# coding=utf8
+from __future__ import unicode_literals, absolute_import, division, print_function
+"""A way to search google"""
+
+import sopel_modules
+
+from .Tools import read_directory_json_to_dict
+
+import os
+from fake_useragent import UserAgent
+import requests
+import time
+
+
+class Sherlock():
+
+    def __init__(self):
+        self.header = {'User-Agent': str(UserAgent().chrome)}
+        self.dict = {}
+
+        dir_to_scan = []
+        for plugin_dir in set(sopel_modules.__path__):
+            configsdir = os.path.join(plugin_dir, "SpiceBot_Configs")
+            usercfgdir = os.path.join(configsdir, "sherlock")
+            dir_to_scan.append(usercfgdir)
+
+        valid_usernames_dict = read_directory_json_to_dict(dir_to_scan, "Gif API", "SpiceBot_Gif")
+
+        for social_network in list(valid_usernames_dict.keys()):
+            self.dict[social_network] = valid_usernames_dict[social_network]
+            self.dict[social_network]["cache"] = dict()
+
+    def check_network(self, username, social_network):
+
+        if username in list(self.dict[social_network]["cache"].keys()):
+            if time.time() - self.dict[social_network]["cache"][username]["time"] <= 1800:
+                return self.dict[social_network]["cache"][username]["exists"]
+
+        url = self.dict.get(social_network).get("url").format(username)
+        error_type = self.dict.get(social_network).get("errorType")
+        cant_have_period = self.dict.get(social_network).get("noPeriod")
+
+        if ("." in username) and (cant_have_period == "True"):
+            while ("." in username):
+                username = username.replace(".", '')
+
+        r, error_type = self.make_request(url=url, error_type=error_type, social_network=social_network)
+
+        user_exists = False
+
+        if error_type == "message":
+            error = self.dict.get(social_network).get("errorMsg")
+            # Checks if the error message is in the HTML
+            if error not in r.text:
+                user_exists = True
+
+        elif error_type == "status_code":
+            # Checks if the status code of the repsonse is 404
+            if not r.status_code == 404:
+                user_exists = True
+
+        elif error_type == "response_url":
+            error = self.dict.get(social_network).get("errorUrl")
+            # Checks if the redirect url is the same as the one defined in data.json
+            if error not in r.url:
+                user_exists = True
+
+        self.dict[social_network]["cache"][username] = {
+                                                        "time": time.time(),
+                                                        "exists": user_exists
+                                                        }
+
+        if user_exists:
+            return True
+        else:
+            return False
+
+    def make_request(self, url, error_type, social_network):
+        try:
+            r = requests.get(url, headers=self.header)
+            if r.status_code:
+                return r, error_type
+        except Exception as e:
+            returnval = e
+            returnval = None
+            return returnval, ""
+
+
+sherlock = Sherlock()

sopel_modules/SpiceBot/Tools.py

@@ -333,7 +333,7 @@ def read_directory_json_to_dict(directories, configtypename="Config File", log_f
             if len(os.listdir(directory)) > 0:
                 for file in os.listdir(directory):
                     filepath = os.path.join(directory, file)
-                    if os.path.isfile(filepath):
+                    if os.path.isfile(filepath) and filepath.endswith('.json'):
                         filesprocess.append(filepath)
 
     for filepath in filesprocess:
@@ -356,7 +356,8 @@ def read_directory_json_to_dict(directories, configtypename="Config File", log_f
             filecount += 1
             slashsplit = str(filepath).split("/")
             filename = slashsplit[-1]
-            configs_dict[filename] = dict_from_file
+            filename_base = os.path.basename(filename).rsplit('.', 1)[0]
+            configs_dict[filename_base] = dict_from_file
         else:
             fileopenfail += 1
 

sopel_modules/SpiceBot/__init__.py

@@ -24,6 +24,7 @@ from .Users import *
 from .AI import *
 from .Google import *
 from .Gif import *
+from .Sherlock import *
 
 
 from .configure import *

sopel_modules/SpiceBot_Configs/sherlock/500px.json

@@ -0,0 +1,5 @@
+{
+"url": "https://500px.com/{}",
+"errorType": "message",
+"errorMsg": "Sorry, no such page."
+}

sopel_modules/SpiceBot_Configs/sherlock/About.me.json

@@ -0,0 +1,4 @@
+{
+"url": "https://about.me/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/AngelList.json

@@ -0,0 +1,5 @@
+{
+"url": "https://angel.co/{}",
+"errorType": "message",
+"errorMsg": "We couldn't find what you were looking for."
+}

sopel_modules/SpiceBot_Configs/sherlock/BLIP.fm.json

@@ -0,0 +1,5 @@
+{
+"url": "https://blip.fm/{}",
+"errorType": "message",
+"errorMsg": "Page Not Found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Bandcamp.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.bandcamp.com/{}",
+"errorType": "message",
+"errorMsg": "Sorry, that something isn’t here"
+}

sopel_modules/SpiceBot_Configs/sherlock/Behance.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.behance.net/{}",
+"errorType": "message",
+"errorMsg": "Oops! We can’t find that page."
+}

sopel_modules/SpiceBot_Configs/sherlock/BitBucket.json

@@ -0,0 +1,4 @@
+{
+"url": "https://bitbucket.org/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Blogger.json

@@ -0,0 +1,5 @@
+{
+"url": "https://{}.blogspot.com",
+"errorType": "status_code",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/BuzzFeed.json

@@ -0,0 +1,5 @@
+{
+"url": "https://buzzfeed.com/{}",
+"errorType": "message",
+"errorMsg": "We can't find the page you're looking for."
+}

sopel_modules/SpiceBot_Configs/sherlock/Canva.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.canva.com/{}",
+"errorType": "message",
+"errorMsg": "Not found (404)"
+}

sopel_modules/SpiceBot_Configs/sherlock/CashMe.json

@@ -0,0 +1,4 @@
+{
+"url": "https://cash.me/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Codecademy.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.codecademy.com/{}",
+"errorType": "message",
+"errorMsg": "404 error"
+}

sopel_modules/SpiceBot_Configs/sherlock/Codementor.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.codementor.io/{}",
+"errorType": "message",
+"errorMsg": "404"
+}

sopel_modules/SpiceBot_Configs/sherlock/ColourLovers.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.colourlovers.com/love/{}",
+"errorType": "message",
+"errorMsg": "Page Not Loved"
+}

sopel_modules/SpiceBot_Configs/sherlock/Contently.json

@@ -0,0 +1,6 @@
+{
+"url": "https://{}.contently.com/",
+"errorType": "message",
+"errorMsg": "We can't find that page!",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/DailyMotion.json

@@ -0,0 +1,6 @@
+
+{
+"url": "https://www.dailymotion.com/{}",
+"errorType": "message",
+"errorMsg": "Page not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Designspiration.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.designspiration.net/{}",
+"errorType": "message",
+"errorMsg": "Content Not Found"
+}

sopel_modules/SpiceBot_Configs/sherlock/DeviantART.json

@@ -0,0 +1,5 @@
+{
+"url": "https://{}.deviantart.com",
+"errorType": "status_code",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/Disqus.json

@@ -0,0 +1,4 @@
+{
+"url": "https://disqus.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Dribbble.json

@@ -0,0 +1,6 @@
+{
+"url": "https://dribbble.com/{}",
+"errorType": "message",
+"errorMsg": "Whoops, that page is gone.",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/Ebay.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.ebay.com/usr/{}",
+"errorType": "message",
+"errorMsg": "The User ID you entered was not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Ello.json

@@ -0,0 +1,5 @@
+{
+"url": "https://ello.co/{}",
+"errorType": "message",
+"errorMsg": "We couldn't find the page you're looking for"
+}

sopel_modules/SpiceBot_Configs/sherlock/Etsy.json

@@ -0,0 +1,4 @@
+{
+"url": "https://www.etsy.com/shop/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Facebook.json

@@ -0,0 +1,4 @@
+{
+"url": "https://www.facebook.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Flickr.json

@@ -0,0 +1,4 @@
+{
+"url": "https://www.flickr.com/people/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Flipboard.json

@@ -0,0 +1,5 @@
+{
+"url": "https://flipboard.com/@{}",
+"errorType": "message",
+"errorMsg": "loading"
+}

sopel_modules/SpiceBot_Configs/sherlock/Fotolog.json

@@ -0,0 +1,4 @@
+{
+"url": "https://fotolog.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Foursquare.json

@@ -0,0 +1,4 @@
+{
+"url": "https://foursquare.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/GitHub.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.github.com/{}",
+"errorType": "status_code",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/GoodReads.json

@@ -0,0 +1,4 @@
+{
+"url": "https://www.goodreads.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/GooglePlus.json

@@ -0,0 +1,4 @@
+{
+"url": "https://plus.google.com/+{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Gravatar.json

@@ -0,0 +1,4 @@
+{
+"url": "http://en.gravatar.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Gumroad.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.gumroad.com/{}",
+"errorType": "message",
+"errorMsg": "Page not found."
+}

sopel_modules/SpiceBot_Configs/sherlock/HackerNews.json

@@ -0,0 +1,5 @@
+{
+"url": "https://news.ycombinator.com/user?id={}",
+"errorType": "message",
+"errorMsg": "No such user."
+}

sopel_modules/SpiceBot_Configs/sherlock/HackerOne.json

@@ -0,0 +1,5 @@
+{
+"url": "https://hackerone.com/{}",
+"errorType": "message",
+"errorMsg": "Page not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Houzz.json

@@ -0,0 +1,5 @@
+{
+"url": "https://houzz.com/user/{}",
+"errorType": "message",
+"errorMsg": "The page you requested was not found."
+}

sopel_modules/SpiceBot_Configs/sherlock/IFTTT.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.ifttt.com/p/{}",
+"errorType": "message",
+"errorMsg": "The requested page or file does not exist"
+}

sopel_modules/SpiceBot_Configs/sherlock/Imgur.json

@@ -0,0 +1,4 @@
+{
+"url": "https://imgur.com/user/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Instagram.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.instagram.com/{}",
+"errorType": "message",
+"errorMsg": "The link you followed may be broken"
+}

sopel_modules/SpiceBot_Configs/sherlock/Instructables.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.instructables.com/member/{}",
+"errorType": "message",
+"errorMsg": "404: We're sorry, things break sometimes"
+}

sopel_modules/SpiceBot_Configs/sherlock/Keybase.json

@@ -0,0 +1,4 @@
+{
+"url": "https://keybase.io/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Kongregate.json

@@ -0,0 +1,6 @@
+{
+"url": "https://www.kongregate.com/accounts/{}",
+"errorType": "message",
+"errorMsg": "Sorry, no account with that name was found.",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/LiveJournal.json

@@ -0,0 +1,6 @@
+{
+"url": "https://{}.livejournal.com",
+"errorType": "message",
+"errorMsg": "Unknown Journal",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/Medium.json

@@ -0,0 +1,4 @@
+{
+"url": "https://medium.com/@{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/MixCloud.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.mixcloud.com/{}",
+"errorType": "message",
+"errorMsg": "Page Not Found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Newgrounds.json

@@ -0,0 +1,5 @@
+{
+"url": "https://{}.newgrounds.com",
+"errorType": "status_code",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/Pastebin.json

@@ -0,0 +1,5 @@
+{
+"url": "https://pastebin.com/u/{}",
+"errorType": "response_url",
+"errorUrl": "https://pastebin.com/index"
+}

sopel_modules/SpiceBot_Configs/sherlock/Patreon.json

@@ -0,0 +1,4 @@
+{
+"url": "https://www.patreon.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Pexels.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.pexels.com/@{}",
+"errorType": "message",
+"errorMsg": "Ouch, something went wrong!"
+}

sopel_modules/SpiceBot_Configs/sherlock/Pinterest.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.pinterest.com/{}",
+"errorType": "response_url",
+"errorUrl": "https://www.pinterest.com/?show_error=true"
+}

sopel_modules/SpiceBot_Configs/sherlock/Reddit.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.reddit.com/user/{}",
+"errorType": "message",
+"errorMsg": "page not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/ReverbNation.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.reverbnation.com/{}",
+"errorType": "message",
+"errorMsg": "Sorry, we couldn't find that page"
+}

sopel_modules/SpiceBot_Configs/sherlock/Roblox.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.roblox.com/user.aspx?username={}",
+"errorType": "message",
+"errorMsg": "Page cannot be found or no longer exists"
+}

sopel_modules/SpiceBot_Configs/sherlock/Scribd.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.scribd.com/{}",
+"errorType": "message",
+"errorMsg": "Page not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Slack.json

@@ -0,0 +1,5 @@
+{
+"url": "https://{}.slack.com",
+"errorType": "status_code",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/SlideShare.json

@@ -0,0 +1,4 @@
+{
+"url": "https://slideshare.net/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/SoundCloud.json

@@ -0,0 +1,4 @@
+{
+"url": "https://soundcloud.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Spotify.json

@@ -0,0 +1,4 @@
+{
+"url": "https://open.spotify.com/user/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Steam.json

@@ -0,0 +1,5 @@
+{
+"url": "https://steamcommunity.com/id/{}",
+"errorType": "message",
+"errorMsg": "The specified profile could not be found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Tinder.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.gotinder.com/@{}",
+"errorType": "message",
+"errorMsg": "Looking for Someone?"
+}

sopel_modules/SpiceBot_Configs/sherlock/Trakt.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.trakt.tv/users/{}",
+"errorType": "message",
+"errorMsg": "404"
+}

sopel_modules/SpiceBot_Configs/sherlock/Trip.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.trip.skyscanner.com/user/{}",
+"errorType": "message",
+"errorMsg": "Page not found"
+}

sopel_modules/SpiceBot_Configs/sherlock/TripAdvisor.json

@@ -0,0 +1,5 @@
+{
+"url": "https://tripadvisor.com/members/{}",
+"errorType": "message",
+"errorMsg": "This page is on vacation…"
+}

sopel_modules/SpiceBot_Configs/sherlock/Twitter.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.twitter.com/{}",
+"errorType": "message",
+"errorMsg": "page doesn’t exist"
+}

sopel_modules/SpiceBot_Configs/sherlock/Unsplash.json

@@ -0,0 +1,4 @@
+{
+"url": "https://unsplash.com/@{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/VK.json

@@ -0,0 +1,4 @@
+{
+"url": "https://vk.com/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/VSCO.json

@@ -0,0 +1,4 @@
+{
+"url": "https://vsco.co/{}",
+"errorType": "status_code"
+}

sopel_modules/SpiceBot_Configs/sherlock/Vimeo.json

@@ -0,0 +1,5 @@
+{
+"url": "https://vimeo.com/{}",
+"errorType": "message",
+"errorMsg": "404 Not Found"
+}

sopel_modules/SpiceBot_Configs/sherlock/Wattpad.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.wattpad.com/user/{}",
+"errorType": "message",
+"errorMsg": "This page seems to be missing..."
+}

sopel_modules/SpiceBot_Configs/sherlock/WeHeartIt.json

@@ -0,0 +1,5 @@
+{
+"url": "https://weheartit.com/{}",
+"errorType": "message",
+"errorMsg": "Oops! You've landed on a moving target!"
+}

sopel_modules/SpiceBot_Configs/sherlock/WordPress.json

@@ -0,0 +1,6 @@
+{
+"url": "https://{}.wordpress.com",
+"errorType": "response_url",
+"errorUrl": "wordpress.com/typo/?subdomain=",
+"noPeriod": "True"
+}

sopel_modules/SpiceBot_Configs/sherlock/YouTube.json

@@ -0,0 +1,5 @@
+{
+"url": "https://www.youtube.com/{}",
+"errorType": "message",
+"errorMsg": "Not Found"
+}

sopel_modules/SpiceBot_Configs/sherlock/devRant.json

@@ -0,0 +1,5 @@
+{
+"url": "https://devrant.com/users/{}",
+"errorType": "response_url",
+"errorUrl": "https://devrant.com/"
+}

sopel_modules/SpiceBot_Configs/sherlock/iMGSRC.RU.json

@@ -0,0 +1,5 @@
+{
+"url": "https://imgsrc.ru/main/user.php?user={}",
+"errorType": "response_url",
+"errorUrl": "https://imgsrc.ru/"
+}

sopel_modules/SpiceBot_Configs/sherlock/last.fm.json

@@ -0,0 +1,5 @@
+{
+"url": "https://last.fm/user/{}",
+"errorType": "message",
+"errorMsg": "Whoops! Sorry, but this page doesn't exist."
+}

sopel_modules/SpiceBot_Core_Commands/Sherlock.py

@@ -0,0 +1,49 @@
+# coding=utf8
+from __future__ import unicode_literals, absolute_import, division, print_function
+
+# sopel imports
+import sopel.module
+
+import spicemanip
+
+import sopel_modules.SpiceBot as SpiceBot
+
+
+@SpiceBot.prerun.prerun('module')
+@sopel.module.commands('sherlock', 'username')
+def bot_command_sherlock(bot, trigger):
+
+    netlist = list(SpiceBot.sherlock.dict.keys())
+
+    username = spicemanip.main(trigger.sb["args"], 1) or trigger.nick
+    trigger.sb["args"] = spicemanip.main(trigger.sb["args"], "2+", 'list')
+
+    checklist = netlist
+    checklistname = 'all'
+    if SpiceBot.inlist(username, netlist):
+        checklistname = SpiceBot.inlist_match(username, netlist)
+        checklist = [checklistname]
+        username = spicemanip.main(trigger.sb["args"], 1) or trigger.nick
+
+    bot.osd("Checking username " + username + " in " + checklistname + " network.")
+
+    inlist, notinlist = [], []
+
+    for social_network in checklist:
+
+        in_social = SpiceBot.sherlock.check_network(username, social_network)
+        if in_social:
+            inlist.append(social_network)
+        else:
+            notinlist.append(social_network)
+
+    if len(inlist):
+        if checklistname != 'all':
+            bot.osd(["The username " + username + " is in " + checklist[0], SpiceBot.sherlock.dict.get(social_network).get("url").format(username)])
+        else:
+            bot.osd(["The username " + username + " is in the following:", spicemanip.main(inlist, "andlist")], trigger.nick, 'NOTICE')
+    if len(notinlist):
+        if checklistname != 'all':
+            bot.osd(["The username " + username + " is NOT in the following:", spicemanip.main(notinlist, "andlist")])
+        else:
+            bot.osd(["The username " + username + " is NOT in the following:", spicemanip.main(notinlist, "andlist")], trigger.nick, 'NOTICE')

sopel_modules/SpiceBot_Core_Commands/__init__.py

@@ -19,6 +19,7 @@ from .BotPrivs import *
 from .Search import *
 from .AI import *
 from .Gif import *
+from .Sherlock import *
 
 __author__ = 'Sam Zick'
 __email__ = 'sam@deathbybandaid.net'