Lots of cleanup and add more workbook endpoints.

Author: areed1192

ms_graph/_workbooks.py

@@ -20,8 +20,10 @@
 from ms_graph.personal_contacts import PersonalContacts
 from ms_graph.mail import Mail
 
+from ms_graph.workbooks_and_charts.workbook import Workbooks
 
-class MicrosoftGraphClient():
+
+class MicrosoftGraphClient:
 
     """
     ### Overview:
@@ -30,25 +32,25 @@ class MicrosoftGraphClient():
     API Service.
     """
 
-    RESOURCE = 'https://graph.microsoft.com/'
+    RESOURCE = "https://graph.microsoft.com/"
 
-    AUTHORITY_URL = 'https://login.microsoftonline.com/'
-    AUTH_ENDPOINT = '/oauth2/v2.0/authorize?'
-    TOKEN_ENDPOINT = '/oauth2/v2.0/token'
+    AUTHORITY_URL = "https://login.microsoftonline.com/"
+    AUTH_ENDPOINT = "/oauth2/v2.0/authorize?"
+    TOKEN_ENDPOINT = "/oauth2/v2.0/token"
 
-    OFFICE365_AUTHORITY_URL = 'https://login.live.com'
-    OFFICE365_AUTH_ENDPOINT = '/oauth20_authorize.srf?'
-    OFFICE365_TOKEN_ENDPOINT = '/oauth20_token.srf'
+    OFFICE365_AUTHORITY_URL = "https://login.live.com"
+    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',
+        account_type: str = "consumers",
         office365: bool = False,
-        credentials: str = None
+        credentials: str = None,
     ):
         """Initializes the Graph Client.
 
@@ -71,7 +73,7 @@ def __init__(
             to have access to.
 
         account_type : str, optional
-            [description], by default 'common'
+            [description], by default "common"
 
         office365 : bool, optional
             [description], by default False
@@ -85,19 +87,19 @@ def __init__(
 
         self.client_id = client_id
         self.client_secret = client_secret
-        self.api_version = 'v1.0'
+        self.api_version = "v1.0"
         self.account_type = account_type
         self.redirect_uri = redirect_uri
 
         self.scope = scope
-        self.state = ''.join(random.choice(letters) for i in range(10))
+        self.state = "".join(random.choice(letters) for i in range(10))
 
         self.access_token = None
         self.refresh_token = None
         self.graph_session = None
         self.id_token = None
 
-        self.base_url = self.RESOURCE + self.api_version + '/'
+        self.base_url = self.RESOURCE + self.api_version + "/"
         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
@@ -107,7 +109,7 @@ def __init__(
         self.client_app = msal.ConfidentialClientApplication(
             client_id=self.client_id,
             authority=self.AUTHORITY_URL + self.account_type,
-            client_credential=self.client_secret
+            client_credential=self.client_secret,
         )
 
     def _state(self, action: str, token_dict: dict = None) -> bool:
@@ -134,18 +136,18 @@ def _state(self, action: str, token_dict: dict = None) -> bool:
         does_exists = pathlib.Path(self.credentials).exists()
 
         # If it exists and we are loading it then proceed.
-        if does_exists and action == 'load':
+        if does_exists and action == "load":
 
             # Load the file.
-            with open(file=self.credentials, mode='r', encoding='utf-8') 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.
-            if 'refresh_token' in credentials:
+            if "refresh_token" in credentials:
 
-                self.refresh_token = credentials['refresh_token']
-                self.access_token = credentials['access_token']
-                self.id_token = credentials['id_token']
+                self.refresh_token = credentials["refresh_token"]
+                self.access_token = credentials["access_token"]
+                self.id_token = credentials["id_token"]
                 self.token_dict = credentials
 
                 return True
@@ -154,22 +156,22 @@ def _state(self, action: str, token_dict: dict = None) -> bool:
                 return False
 
         # If we are saving the state then open the file and dump the dictionary.
-        elif action == 'save':
+        elif action == "save":
 
-            token_dict['expires_in'] = time.time(
-            ) + int(token_dict['expires_in'])
-            token_dict['ext_expires_in'] = time.time(
-            ) + int(token_dict['ext_expires_in'])
+            token_dict["expires_in"] = time.time() + int(token_dict["expires_in"])
+            token_dict["ext_expires_in"] = time.time() + int(
+                token_dict["ext_expires_in"]
+            )
 
-            self.refresh_token = token_dict['refresh_token']
-            self.access_token = token_dict['access_token']
-            self.id_token = token_dict['id_token']
+            self.refresh_token = token_dict["refresh_token"]
+            self.access_token = token_dict["access_token"]
+            self.id_token = token_dict["id_token"]
             self.token_dict = token_dict
 
-            with open(file=self.credentials, mode='w+', encoding='utf-8') 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:
+    def _token_seconds(self, token_type: str = "access_token") -> int:
         """Determines time till expiration for a token.
 
         Return the number of seconds until the current access token or refresh token
@@ -179,34 +181,36 @@ def _token_seconds(self, token_type: str = 'access_token') -> int:
         ### Arguments:
         ----
         token_type {str} --  The type of token you would like to determine lifespan for.
-            Possible values are ['access_token', 'refresh_token'] (default: {access_token})
+            Possible values are ["access_token", "refresh_token"] (default: {access_token})
 
         ### Returns:
         ----
         {int} -- The number of seconds till expiration.
         """
 
         # if needed check the access token.
-        if token_type == 'access_token':
+        if token_type == "access_token":
 
             # if the time to expiration is less than or equal to 0, return 0.
-            if not self.access_token or (time.time() + 60 >= self.token_dict['expires_in']):
+            if not self.access_token or (
+                time.time() + 60 >= self.token_dict["expires_in"]
+            ):
                 return 0
 
             # else return the number of seconds until expiration.
-            token_exp = int(self.token_dict['expires_in'] - time.time() - 60)
+            token_exp = int(self.token_dict["expires_in"] - time.time() - 60)
 
         # if needed check the refresh token.
-        elif token_type == 'refresh_token':
+        elif token_type == "refresh_token":
 
             # if the time to expiration is less than or equal to 0, return 0.
-            if not self.refresh_token or (time.time() + 60 >= self.token_dict['ext_expires_in']):
+            if not self.refresh_token or (
+                time.time() + 60 >= self.token_dict["ext_expires_in"]
+            ):
                 return 0
 
             # else return the number of seconds until expiration.
-            token_exp = int(
-                self.token_dict['ext_expires_in'] - time.time() - 60
-            )
+            token_exp = int(self.token_dict["ext_expires_in"] - time.time() - 60)
 
         return token_exp
 
@@ -223,7 +227,7 @@ def _token_validation(self, nseconds: int = 60):
             valid for before attempting to get a refresh token. (default: {5})
         """
 
-        if self._token_seconds(token_type='access_token') < nseconds:
+        if self._token_seconds(token_type="access_token") < nseconds:
             self.grab_refresh_token()
 
     def _silent_sso(self) -> bool:
@@ -236,21 +240,21 @@ def _silent_sso(self) -> bool:
         """
 
         # if the current access token is not expired then we are still authenticated.
-        if self._token_seconds(token_type='access_token') > 0:
+        if self._token_seconds(token_type="access_token") > 0:
             return True
 
         # if the current access token is expired then try and refresh access token.
         elif self.refresh_token and self.grab_refresh_token():
             return True
 
-        # More than likely a first time login, so can't do silent authenticaiton.
+        # More than likely a first time login, so can"t do silent authenticaiton.
         return False
 
     def login(self) -> None:
         """Logs the user into the session."""
 
         # Load the State.
-        self._state(action='load')
+        self._state(action="load")
 
         # Try a Silent SSO First.
         if self._silent_sso():
@@ -267,11 +271,11 @@ def login(self) -> None:
 
             # 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}')
+            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.
-            my_response = input('Paste the full URL redirect here: ')
+            my_response = input("Paste the full URL redirect here: ")
 
             # store the redirect URL
             self._redirect_code = my_response
@@ -292,9 +296,7 @@ def authorization_url(self):
 
         # Build the Auth URL.
         auth_url = self.client_app.get_authorization_request_url(
-            scopes=self.scope,
-            state=self.state,
-            redirect_uri=self.redirect_uri
+            scopes=self.scope, state=self.state, redirect_uri=self.redirect_uri
         )
 
         return auth_url
@@ -315,16 +317,11 @@ def grab_access_token(self) -> Dict:
 
         # Grab the Token.
         token_dict = self.client_app.acquire_token_by_authorization_code(
-            code=code,
-            scopes=self.scope,
-            redirect_uri=self.redirect_uri
+            code=code, scopes=self.scope, redirect_uri=self.redirect_uri
         )
 
         # Save the token dict.
-        self._state(
-            action='save',
-            token_dict=token_dict
-        )
+        self._state(action="save", token_dict=token_dict)
 
         return token_dict
 
@@ -339,19 +336,17 @@ def grab_refresh_token(self) -> Dict:
 
         # Grab a new token using our refresh token.
         token_dict = self.client_app.acquire_token_by_refresh_token(
-            refresh_token=self.refresh_token,
-            scopes=self.scope
+            refresh_token=self.refresh_token, scopes=self.scope
         )
 
-        if 'error' in token_dict:
+        if "error" in token_dict:
             print(token_dict)
-            raise PermissionError("Permissions not authorized, delete json file and run again.")
+            raise PermissionError(
+                "Permissions not authorized, delete json file and run again."
+            )
 
         # Save the Token.
-        self._state(
-            action='save',
-            token_dict=token_dict
-        )
+        self._state(action="save", token_dict=token_dict)
 
         return token_dict
 
@@ -449,7 +444,9 @@ def personal_contacts(self) -> PersonalContacts:
         """
 
         # Grab the `PersonalContacts` Object for the session.
-        personal_contacts_object: PersonalContacts = PersonalContacts(session=self.graph_session)
+        personal_contacts_object: PersonalContacts = PersonalContacts(
+            session=self.graph_session
+        )
 
         return personal_contacts_object
 
@@ -466,3 +463,17 @@ def mail(self) -> Mail:
         mail_service: Mail = Mail(session=self.graph_session)
 
         return mail_service
+
+    def workbooks(self) -> Workbooks:
+        """Used to access the Workbooks Services and metadata.
+
+        ### Returns
+        ---
+        Workbooks:
+            The `Workbooks` services Object.
+        """
+
+        # Grab the `Workbooks` Object for the session.
+        workbook_service: Workbooks = Workbooks(session=self.graph_session)
+
+        return workbook_service