mutuals.py

"""
mutuals.py
~~~~~~~~

so your first mistake was using my code, but since you are clearly reading this
let it be known that mutuals.py lets you create a mutuals list on the hell
site known as "twitter dot com".

assuming you have python3 installed and your account credentials properly
stored in secret.py, running `python3 mutuals.py` should do the trick.

:copyright: @ 2018
:author: elias julian marko garcia
:license: WTFNMFPL, see LICENSE
"""

import tweepy as ty
import time
import sys
from secret import (ACCESS_SECRET, ACCESS_TOKEN, CONSUMER_TOKEN,
                    CONSUMER_SECRET)


def setTwitterAuth():
    """
    obtains authorization from twitter API

    auth my ass, jack

    :return: api object for accessing user's twitter data
    """
    # sets the auth tokens for twitter using tweepy
    auth = ty.OAuthHandler(CONSUMER_TOKEN, CONSUMER_SECRET)
    auth.set_access_token(ACCESS_TOKEN, ACCESS_SECRET)
    api = ty.API(auth)
    return api


def handleCursorLimit(cursor):
    """
    can u handle the limit?????

    handles limit errors caused by calls to twitter's api through their cursor
    feature.

    :param cursor: cursor iterator for finding all friends
    :return: yields the next cursor to iterate over
    """
    while True:
        try:
            yield cursor.next()
        except ty.RateLimitError:
            print("you must have a lot of mutuals or something because we have"
                  " have officially just hit twitter's api limit. give it some"
                  " some time to reset, ~15 mins,  and the script will pickup")
            print("sleeping! {}".format(time.localtime()))
            # got fucked by jack's api once again, press F please
            time.sleep(60 * 15)


def mutuals(api):
    """
    this is the actual meat of the script. gathers a list of your friends,
    checks for mutual status, and creates a list of them.

    if you are wondering what the fuck i'm doing with these try catches,
    blame the fact twitter only partially implements pagination in their
    api, thus defeating a very useful/clean feature for handling api
    limit exceptions.

    :param api: api object necessary to access user's account data
    """
    thyself = api.me().id
    iCanCountLol = 0
    mutualists = []
    # debugging
    # print("Your user ID number: {}".format(thyself))

    for fran in handleCursorLimit(ty.Cursor(api.friends).items()):
        # debugging
        # print("fran: {}".format(fran.id))

        # technically speaking, this api request can still fuck us over and
        # sideways, so let us pray together very very very very hard that the
        # magic dice of the universe roll our way on this request.
        for _ in range(11):
            try:
                franship = api.show_friendship(
                    source_id=thyself, target_id=fran.id)

                if franship[0].following and franship[0].followed_by:
                    iCanCountLol += 1
                    mutualists.append(franship[1].id)
                    print("{} is a mutual!".format(franship[1].screen_name))

                # we have made it out alive.... for now. @jack's bloodlust
                # goes unsatiated nonetheless.
                break

            except ty.RateLimitError:
                print("we hit the rate error, @jack is not pleased."
                      "give the script ~15 mins to finish what it is doing.")
                # we must satiate @jack's thirst for wasted cpu cycles
                time.sleep(60 * 15)
                continue

            except Exception as e:
                print(
                    "something really goofed up in the process of finding your"
                    " friends. Assuming they exist, then it is probably just"
                    " my shitty code. Error: {}".format(e))
                sys.exit()

    print("Assuming shit is not whack and my code is not whack, you"
          " have {} mutuals".format(iCanCountLol))

    print("we will now create the list. give me a quick sec")

    # this will create the list. if you have a list of the same name,
    # afaik, twitter makes a list with the same name, but its "slug"
    # willbe the list name + digit, where digit = # duplicate

    # also lol what are api limit checks yet again also lol let's talk
    # about side effects in code because what the fuck is this list api
    # creation method hahahahahahahahahahahahahahahahaha
    myOwnStasi = api.create_list("mutuals").id
    for muchie in mutualists:
        for _ in range(11):
            try:
                api.add_list_member(
                    user_id=muchie, list_id=myOwnStasi, owner_id=thyself)
                break
            except ty.RateLimitError:
                print("we hit the rate error, @jack is not pleased."
                      "give the script ~15 mins to finish what it is"
                      " doing.")
                # we must satiate @jack's thirst for wasted cpu cycles
                time.sleep(60 * 15)
                continue

            except Exception as e:
                print("wtf i make horrible code, exception while"
                      " making list: {}".format(e))
                print("muchie value: {} \nlist_id value: {} \nowner_id"
                      " value: {}".format(muchie, myOwnStasi, thyself))
                print("the code is going to exit, dm me or cry on github"
                      " to see if i"
                      " can fix my code (narrator voice: he might not do"
                      " it)")
                sys.exit()

    # lol
    print("Tada it worked or something, go check it out on twitter dot com and"
          " see for urself ")


if __name__ == '__main__':
    print("i am so sorry mom i could have been a real engineer")
    api = setTwitterAuth()
    mutuals(api)