google docs connector (#1676)

Author: austinweisgrau

docs/google.rst

@@ -260,6 +260,61 @@ API
 .. autoclass :: parsons.google.google_civic.GoogleCivic
    :inherited-members:
 
+*************
+Google Docs
+*************
+
+========
+Overview
+========
+
+The GoogleDocs class allows you to interact with Google Docs. You can use this connector to access and manipulate Google Docs documents programmatically.
+
+In order to instantiate the class, you must pass Google service account credentials as a dictionary, or store the credentials as a JSON file locally and pass the path to the file as a string in the ``GOOGLE_DRIVE_CREDENTIALS`` environment variable. You can follow these steps:
+
+- Go to the `Google Developer Console <https://console.cloud.google.com/apis/dashboard>`_ and make sure the "Google Docs API" and "Google Drive API" are both enabled.
+- Go to the credentials page via the lefthand sidebar. On the credentials page, click "create credentials".
+- Choose the "Service Account" option and fill out the form provided. This should generate your credentials.
+- Select your newly created Service Account on the credentials main page.
+- select "keys", then "add key", then "create new key". Pick the key type JSON. The credentials should start to automatically download.
+
+You can now copy and paste the data from the key into your script or (recommended) save it locally as a JSON file.
+
+==========
+Quickstart
+==========
+
+To instantiate the GoogleDocs class, you can either pass the constructor a dict containing your Google service account credentials or define the environment variable ``GOOGLE_DRIVE_CREDENTIALS`` to contain a path to the JSON file containing the dict.
+
+.. code-block:: python
+
+   from parsons import GoogleDocs
+
+   # First approach: Use API credentials via environmental variables
+   docs = GoogleDocs()
+
+   # Second approach: Pass API credentials as argument
+   credential_filename = 'google_drive_service_credentials.json'
+   docs = GoogleDocs(app_creds=credential_filename)
+
+You can then use the client to interact with Google Docs:
+
+.. code-block:: python
+
+   # Access the Google Docs API client
+   document_id = 'your-document-id'
+   document = docs.client.documents().get(documentId=document_id).execute()
+
+   # Get the document content
+   content = document.get('body').get('content')
+
+===
+API
+===
+
+.. autoclass :: parsons.google.google_docs.GoogleDocs
+   :inherited-members:
+
 *************
 Google Drive
 *************

parsons/__init__.py

@@ -68,6 +68,7 @@
     ("parsons.google.google_civic", "GoogleCivic"),
     ("parsons.google.google_cloud_storage", "GoogleCloudStorage"),
     ("parsons.google.google_drive", "GoogleDrive"),
+    ("parsons.google.google_docs", "GoogleDocs"),
     ("parsons.google.google_sheets", "GoogleSheets"),
     ("parsons.hustle.hustle", "Hustle"),
     ("parsons.mailchimp.mailchimp", "Mailchimp"),

parsons/google/google_docs.py

@@ -0,0 +1,51 @@
+import logging
+import uuid
+from typing import Optional, Union
+
+from google.oauth2.credentials import Credentials
+from googleapiclient.discovery import build
+
+from parsons.google.utilities import (
+    load_google_application_credentials,
+    setup_google_application_credentials,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class GoogleDocs:
+    """
+    A connector for Google Docs
+
+    `Args:`
+        app_creds: dict | str | Credentials
+            Can be a dictionary of Google Drive API credentials, parsed from JSON provided
+            by the Google Developer Console, or a path string pointing to credentials
+            saved on disk, or a google.oauth2.credentials.Credentials object. Required
+            if env variable ``GOOGLE_DRIVE_CREDENTIALS`` is not populated.
+    """
+
+    def __init__(
+        self,
+        app_creds: Optional[Union[str, dict, Credentials]] = None,
+    ):
+        scopes = [
+            "https://www.googleapis.com/auth/documents",
+            "https://www.googleapis.com/auth/drive",
+        ]
+
+        if isinstance(app_creds, Credentials):
+            credentials = app_creds
+        else:
+            env_credentials_path = str(uuid.uuid4())
+            setup_google_application_credentials(
+                app_creds, target_env_var_name=env_credentials_path
+            )
+            credentials = load_google_application_credentials(env_credentials_path, scopes=scopes)
+
+        self.client = build(
+            "docs",
+            "v1",
+            credentials=credentials,
+            cache_discovery=False,
+        )