Cleanup

Author: areed1192

.vscode/settings.json

@@ -1,11 +1,18 @@
 {
   "python.linting.enabled": true,
-  "python.linting.pylintEnabled": false,
-  "python.pythonPath": "C:\\Users\\Alex\\AppData\\Local\\Programs\\Python\\Python39\\python.exe",
-  "python.linting.flake8Enabled": true,
-  "python.linting.flake8Args": ["--max-line-length=140", "--ignore=E402"],
-  "python.testing.unittestArgs": ["-v", "-s", "./tests", "-p", "test_*.py"],
+  "python.linting.pylintEnabled": true,
+  // Ignore Module Doc Strings.
+  "python.linting.pylintArgs": [
+    "--disable",
+    "C0114,C0415"
+  ],
+  "python.testing.unittestArgs": [
+    "-v",
+    "-s",
+    "./tests",
+    "-p",
+    "test_*.py"
+  ],
   "python.testing.pytestEnabled": false,
-  "python.testing.nosetestsEnabled": false,
   "python.testing.unittestEnabled": true
-}
+}

ms_graph/client.py

@@ -1,5 +1,4 @@
 import json
-import msal
 import time
 import urllib
 import random
@@ -9,6 +8,8 @@
 from typing import List
 from typing import Dict
 
+import msal
+
 from ms_graph.users import Users
 from ms_graph.drives import Drives
 from ms_graph.groups import Groups
@@ -22,6 +23,13 @@
 
 class MicrosoftGraphClient():
 
+    """
+    ### Overview:
+    ----
+    Used as the main entry point for the Microsoft Graph
+    API Service.
+    """
+
     RESOURCE = 'https://graph.microsoft.com/'
 
     AUTHORITY_URL = 'https://login.microsoftonline.com/'
@@ -32,9 +40,16 @@ class MicrosoftGraphClient():
     OFFICE365_AUTH_ENDPOINT = '/oauth20_authorize.srf?'
     OFFICE365_TOKEN_ENDPOINT = '/oauth20_token.srf'
 
-    def __init__(self, client_id: str, client_secret: str, redirect_uri: str,
-                 scope: List[str], account_type: str = 'consumers',
-                 office365: bool = False, credentials: str = None):
+    def __init__(
+        self,
+        client_id: str,
+        client_secret: str,
+        redirect_uri: str,
+        scope: List[str],
+        account_type: str = 'consumers',
+        office365: bool = False,
+        credentials: str = None
+    ):
         """Initializes the Graph Client.
 
         ### Parameters
@@ -86,6 +101,7 @@ def __init__(self, client_id: str, client_secret: str, redirect_uri: str,
         self.office_url = self.OFFICE365_AUTHORITY_URL + self.OFFICE365_AUTH_ENDPOINT
         self.graph_url = self.AUTHORITY_URL + self.account_type + self.AUTH_ENDPOINT
         self.office365 = office365
+        self._redirect_code = None
 
         # Initialize the Credential App.
         self.client_app = msal.ConfidentialClientApplication(
@@ -121,7 +137,7 @@ def _state(self, action: str, token_dict: dict = None) -> bool:
         if does_exists and action == 'load':
 
             # Load the file.
-            with open(file=self.credentials, mode='r') as state_file:
+            with open(file=self.credentials, mode='r', encoding='utf-8') as state_file:
                 credentials = json.load(fp=state_file)
 
             # Grab the Token if it exists.
@@ -150,7 +166,7 @@ def _state(self, action: str, token_dict: dict = None) -> bool:
             self.id_token = token_dict['id_token']
             self.token_dict = token_dict
 
-            with open(file=self.credentials, mode='w+') as state_file:
+            with open(file=self.credentials, mode='w+', encoding='utf-8') as state_file:
                 json.dump(obj=token_dict, fp=state_file, indent=2)
 
     def _token_seconds(self, token_type: str = 'access_token') -> int:
@@ -249,10 +265,12 @@ def login(self) -> None:
             # Build the URL.
             url = self.authorization_url()
 
-            # aks the user to go to the URL provided, they will be prompted to authenticate themsevles.
-            print('Please go to URL provided authorize your account: {}'.format(url))
+            # aks the user to go to the URL provided, they will be prompted
+            # to authenticate themsevles.
+            print(f'Please go to URL provided authorize your account: {url}')
 
-            # ask the user to take the final URL after authentication and paste here so we can parse.
+            # ask the user to take the final URL after authentication and
+            # paste here so we can parse.
             my_response = input('Paste the full URL redirect here: ')
 
             # store the redirect URL

requirements.txt

@@ -1,2 +1,2 @@
-msal==1.5.0
-requests==2.24.0
+msal>=1.5.0
+requests>=2.24.0

samples/configs/write_config.py

@@ -12,5 +12,5 @@
 config.set('graph_api', 'redirect_uri', '')
 
 # Write the file.
-with open(file='samples/configs/config.ini', mode='w+') as f:
+with open(file='samples/configs/config.ini', mode='w+', encoding='utf-8') as f:
     config.write(f)

samples/use_client.py

@@ -1,6 +1,6 @@
 from pprint import pprint
-from ms_graph.client import MicrosoftGraphClient
 from configparser import ConfigParser
+from ms_graph.client import MicrosoftGraphClient
 
 scopes = [
     'Calendars.ReadWrite',

samples/use_drive_services.py

@@ -1,6 +1,6 @@
 from pprint import pprint
-from ms_graph.client import MicrosoftGraphClient
 from configparser import ConfigParser
+from ms_graph.client import MicrosoftGraphClient
 
 scopes = [
     'Calendars.ReadWrite',

samples/use_mail_services.py

@@ -54,15 +54,17 @@
 graph_client.login()
 
 # Define a valid User ID.
-user_id = '8bc640c57cda25b6'
+USER_ID = '8bc640c57cda25b6'
 
 # Define a mail Item ID.
-mail_id = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgBGAAADpjqwNb_dak68rN7703u' + \
-          'ffQcAFNKsLOjbGUuHHmYnyKdJiAAAAgEhAAAAFNKsLOjbGUuHHmYnyKdJiAAFBMTneQAAAA=='
+MAIL_ID = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgBGAAADpjqwNb_dak68rN7703u' + \
+          'ffQcAFNKsLOjbGUuHHmYnyKdJiAAAAgEhAAAAFNKsLOjbGUuHHmYnyKdJiAAFBMTneQ' + \
+          'AAAA=='
 
 # Define a mail item ID with Attachments.
-mail_id_with_attachments = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgBGAAADpjqwNb+' + \
-                           'dak68rN7703uffQcAFNKsLOjbGUuHHmYnyKdJiAAAAgEMAAAAFNKsLOjbGUuHHmYnyKdJiAAE9ucV+AAAAA=='
+MAIL_ID_ATTACHMENTS = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgBGAAADpjqwNb+' + \
+                      'dak68rN7703uffQcAFNKsLOjbGUuHHmYnyKdJiAAAAgEMAAAAFNKsLO' + \
+                      'jbGUuHHmYnyKdJiAAE9ucV+AAAAA=='
 
 # Grab the Notes Services.
 mail_services = graph_client.mail()
@@ -75,21 +77,21 @@
 # Grab a specific message for the default user.
 pprint(
     mail_services.get_my_messages(
-        message_id=mail_id
+        message_id=MAIL_ID
     )
 )
 
 # Get a Specific User's Message.
 pprint(
     mail_services.get_user_messages(
-        user_id=user_id,
-        message_id=mail_id
+        user_id=USER_ID,
+        message_id=MAIL_ID
     )
 )
 
 # List the rules for a specific user..
 pprint(
-    mail_services.list_rules(user_id=user_id)
+    mail_services.list_rules(user_id=USER_ID)
 )
 
 # List the rules for the default user.
@@ -99,7 +101,7 @@
 
 # List the overrides for a specific user.
 pprint(
-    mail_services.list_overrides(user_id=user_id)
+    mail_services.list_overrides(user_id=USER_ID)
 )
 
 # List the overrides for the default user.
@@ -110,7 +112,7 @@
 # List the attachments for a specific message.
 pprint(
     mail_services.list_my_attachements(
-        message_id=mail_id_with_attachments
+        message_id=MAIL_ID_ATTACHMENTS
     )
 )
 

samples/use_personal_contacts_service.py

@@ -1,6 +1,6 @@
 from pprint import pprint
-from ms_graph.client import MicrosoftGraphClient
 from configparser import ConfigParser
+from ms_graph.client import MicrosoftGraphClient
 
 scopes = [
     'Contacts.ReadWrite',
@@ -41,10 +41,10 @@
 graph_client.login()
 
 # Define a valid User ID.
-user_id = '8bc640c57cda25b6'
+USER_ID = '8bc640c57cda25b6'
 
 # Define a folder ID.
-folder_id = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgAuAAADpjqwNb_d' + \
+FOLDER_ID = 'AQMkADAwATZiZmYAZC1hMDI2LTE3NTgtMDACLTAwCgAuAAADpjqwNb_d' + \
             'ak68rN7703uffQEAFNKsLOjbGUuHHmYnyKdJiAAFAP8ORwAAAA=='
 
 # Grab the Personal Contacts Service.
@@ -58,16 +58,16 @@
 # Grab a contact folder for a specific user and a specific ID.
 pprint(
     personal_contacts_service.list_contacts_folder_by_id(
-        user_id=user_id,
-        folder_id=folder_id
+        user_id=USER_ID,
+        folder_id=FOLDER_ID
     )
 )
 
 # Grab a contact folder for a specific user and a specific ID.
 pprint(
     personal_contacts_service.get_contacts_folder_by_id(
-        user_id=user_id,
-        folder_id=folder_id
+        user_id=USER_ID,
+        folder_id=FOLDER_ID
     )
 )
 
@@ -97,7 +97,7 @@
 # Create a new contact folder under the specified user profile.
 pprint(
     personal_contacts_service.create_user_contact_folder(
-        user_id=user_id,
+        user_id=USER_ID,
         folder_resource={
             "parentFolderId": "trading-robot-contacts",
             "displayName": "Trading Robot - Contacts"

samples/use_search_service.py

@@ -1,6 +1,6 @@
 from pprint import pprint
-from ms_graph.client import MicrosoftGraphClient
 from configparser import ConfigParser
+from ms_graph.client import MicrosoftGraphClient
 
 scopes = [
     'Calendars.ReadWrite',

samples/user_drive_items_services.py

@@ -1,6 +1,6 @@
 from pprint import pprint
-from ms_graph.client import MicrosoftGraphClient
 from configparser import ConfigParser
+from ms_graph.client import MicrosoftGraphClient
 
 scopes = [
     'Calendars.ReadWrite',
@@ -40,50 +40,50 @@
 drive_item_services = graph_client.drive_item()
 
 # Define a valid User ID.
-user_id = '8bc640c57cda25b6'
+USER_ID = '8bc640c57cda25b6'
 
 # Define a valid Drive ID.
-drive_id = '8bc640c57cda25b6'
+DRIVE_ID = '8bc640c57cda25b6'
 
 # Define a valid Drive Item ID.
-drive_item_id = '8BC640C57CDA25B6!3837'
+DRIVE_ITEM_ID = '8BC640C57CDA25B6!3837'
 
 # Grab a Drive Item, by ID.
 pprint(
     drive_item_services.get_drive_item(
-        drive_id=drive_id,
-        item_id=drive_item_id
+        drive_id=DRIVE_ID,
+        item_id=DRIVE_ITEM_ID
     )
 )
 
 # Grab a Drive Item, by path.
 pprint(
     drive_item_services.get_drive_item_by_path(
-        drive_id=drive_id,
+        drive_id=DRIVE_ID,
         item_path='/Career - Certifications & Exams'
     )
 )
 
 # Grab a Drive Item, for a specific user in a specific Drive.
 pprint(
     drive_item_services.get_user_drive_item(
-        user_id=user_id,
-        item_id=drive_item_id
+        user_id=USER_ID,
+        item_id=DRIVE_ITEM_ID
     )
 )
 
 # Grab a Drive Item, by path for a specific user in a specific Drive.
 pprint(
     drive_item_services.get_user_drive_item_by_path(
-        user_id=user_id,
+        user_id=USER_ID,
         item_path='/Career - Certifications & Exams'
     )
 )
 
 # Grab my Drive Item by ID.
 pprint(
     drive_item_services.get_my_drive_item(
-        item_id=drive_item_id
+        item_id=DRIVE_ITEM_ID
     )
 )
 
@@ -95,20 +95,20 @@
 )
 
 # Define a valid Group ID.
-group_id = 'GROUP_ID_GOES_HERE'
+GROUP_ID = 'GROUP_ID_GOES_HERE'
 
 # Grab a group Drive Item by ID.
 pprint(
     drive_item_services.get_group_drive_item(
-        group_id=group_id,
-        item_id=drive_item_id
+        group_id=GROUP_ID,
+        item_id=DRIVE_ITEM_ID
     )
 )
 
 # Grab a group Drive Item, by path.
 pprint(
     drive_item_services.get_group_drive_item_by_path(
-        group_id=group_id,
+        group_id=GROUP_ID,
         item_path='/Career - Certifications & Exams'
     )
 )