[feature] codebase migration

.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# vscode
+.vscode/
+.idea/
+
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Main.py → yocial/Main.py

@@ -4,13 +4,12 @@
 # Ultimately, I want Main.py to only have command arguments processing. Will work on that later
 # Right now Main.py is used to demonstrate how to use the API
 import sys
-
-import Utils
+import yocial.Utils as Utils
 import private_constants
-from Instagram import Instagram
-from SocialDetector import SocialDetector
-from Telegram import Telegram
-from Whatsapp import Whatsapp
+from yocial.features.Instagram.Instagram import Instagram
+from yocial.features.SocialDetector import SocialDetector
+from yocial.features.Telegram.Telegram import Telegram
+from yocial.features.Whatsapp.Whatsapp import Whatsapp
 
 
 def main():

Utils.py → yocial/Utils.py

@@ -1,6 +1,6 @@
 import os
 
-from PhoneNumber import PhoneNumber
+from yocial.features.PhoneNumber import PhoneNumber
 
 
 def file_to_phone_number(file_path):
@@ -10,19 +10,24 @@ def file_to_phone_number(file_path):
             phone_number_list.append(PhoneNumber(line.strip('\n')))
     return phone_number_list
 
-
 # Convert command line arguments to PhoneNumber objects. If the arguments is a file's name then that file will be
 # processed and not the arguments themselves
 def cmd_args_to_phone_number(arguments):
+
     # Currently the processing of numbers to objects is sensitive. Meaning that empty and invalid lines might get
     # processed into an objects, which obviously shouldn't. Bear that in mind
 
-    assert len(arguments) >= 1, "No arguments are provided"
-
+    # as a bypass for the time being until I develop verify function I will incrment the condition to 2
+    # as arguments[0] is always the project entry point `__main__.py`
+    assert len(arguments) >= 2, "No arguments are provided"
+
     phone_number_list = []
     if os.path.isfile(arguments[1]):
         return file_to_phone_number(arguments[1])
     else:
         for raw_phone_number in arguments[1:]:
-            phone_number_list.append(PhoneNumber(raw_phone_number))
+            # ensure PhoneNumber object initialize only for valid numbers
+            verified = PhoneNumber.verifier(number=raw_phone_number)
+            if(verified):
+                phone_number_list.append(PhoneNumber(raw_phone_number))
     return phone_number_list

yocial/__init__.py

@@ -0,0 +1,4 @@
+from os.path import dirname, basename, isfile, join
+import glob
+modules = glob.glob(join(dirname(__file__), "*.py"))
+__all__ = [ basename(f)[:-3] for f in modules if isfile(f) and not f.endswith('__init__.py')]

yocial/__main__.py

@@ -0,0 +1,9 @@
+
+
+'''
+Entry point to run yocial module `python3 -m yocial`.
+'''
+
+from yocial.Main import main
+
+main()

Instagram.py → yocial/features/Instagram/Instagram.py

@@ -7,8 +7,8 @@
 
 import requests
 
-import PhoneNumber
-from BaseSocialApp import BaseSocialApp
+import yocial.features.PhoneNumber as PhoneNumber
+from yocial.features.BaseSocialApp import BaseSocialApp
 
 API_URL = 'https://i.instagram.com/api/v1/'
 USERS_LOOKUP_URL = API_URL + 'users/lookup/'
@@ -99,7 +99,7 @@ def generate_data(self, phone_number_raw):
 
     def detect_single_number(self, phone_number):
         self.setup_session()
-        data = self.generate_data(phone_number.get_phone_number())
+        data = self.generate_data(phone_number.phone_number)
 
         response = self.current_session.post(USERS_LOOKUP_URL, data=generate_signature(json.dumps(data)))
         self.last_response = response
@@ -113,6 +113,10 @@ def detect_single_number(self, phone_number):
                 phone_number.set_app_state("Whatsapp", PhoneNumber.AppUsageEnum.NO_USAGE)
         elif response.status_code == 404:
             phone_number.set_app_state(self.get_name(), PhoneNumber.AppUsageEnum.NO_USAGE)
+        else:
+            # a generic bypass for generic failures for unexpected errors
+            # for my case I faced `Too many requests` error
+            phone_number.set_app_state(self.get_name(), response.reason)
 
     def detect_numbers(self, phone_numbers):
         for phone in phone_numbers:

yocial/features/PhoneNumber.py

@@ -0,0 +1,58 @@
+
+from enum import Enum
+from dataclasses import dataclass, field
+class AppUsageEnum(Enum):
+    ERROR = -1  # There was an error while trying to detect whether this phone number uses a certain social app.
+    NO_USAGE = 0  # This phone number does not use the app
+    USAGE = 1  # This phone number has the app and it uses it
+
+@dataclass
+class PhoneNumber:
+    _phone_number: str = ""
+     # Used to track which apps are used by this phone number
+    app_usage: dict = field(init=False,default_factory=dict)
+
+    # get a current phone number
+    @property
+    def phone_number(self) -> str:
+        return self._phone_number
+
+    # set a new phone number
+    @phone_number.setter
+    def phone_number(self, value: str) -> None:
+        self._phone_number = value
+
+    # Return a constant of AppUsageEnum
+    def has_app(self, app_name):
+        return self.app_usage[app_name]
+
+    # Sets whether a phone number is using an app
+    # state will be a constant of AppUsageEnum
+    def set_app_state(self, app_name, state):
+        self.app_usage[app_name] = state
+
+    def __str__(self):
+        usage_as_string = self.phone_number + "\n"
+        for key, val in self.app_usage.items():
+            # to handle errors
+            try:
+                usage_as_string += key + " => " + val.name + "\n"
+            except:
+                usage_as_string += key + " => " + val + "\n"
+        return usage_as_string
+
+    def verifier(number) -> bool:
+        '''
+        Return boolean value based on the verification logic
+
+            Parameters:
+                number  -> the number need to be verified
+            Return:
+                True    -> if it's valid
+                False   -> if it's not valid
+        '''
+        # TODO: substring condition
+        if(len(number) == 10):
+             return True
+        else:
+            return False