Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Google Slides & Google Drive #1031

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .flake8
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[flake8]
max-line-length = 100

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ bill_com_credentials.*

docs/html
docs/dirhtml
*.sw*
*.sw*
2 changes: 2 additions & 0 deletions parsons/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@
("parsons.google.google_bigquery", "GoogleBigQuery"),
("parsons.google.google_civic", "GoogleCivic"),
("parsons.google.google_cloud_storage", "GoogleCloudStorage"),
("parsons.google.google_drive", "GoogleDrive"),
("parsons.google.google_sheets", "GoogleSheets"),
("parsons.google.google_slides", "GoogleSlides"),
("parsons.hustle.hustle", "Hustle"),
("parsons.mailchimp.mailchimp", "Mailchimp"),
("parsons.mobilecommons.mobilecommons", "MobileCommons"),
Expand Down
153 changes: 153 additions & 0 deletions parsons/google/google_drive.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
import os
import json
import logging

from parsons.google.utitities import setup_google_application_credentials
elyse-weiss marked this conversation as resolved.
Show resolved Hide resolved
from googleapiclient.discovery import build
from google.oauth2.service_account import Credentials

logger = logging.getLogger(__name__)


class GoogleDrive:
"""
A connector for Google Drive, largely handling permissions.

`Args:`
google_keyfile_dict: dict
A dictionary of Google Drive API credentials, parsed from JSON provided
by the Google Developer Console. Required if env variable
``GOOGLE_DRIVE_CREDENTIALS`` is not populated.
subject: string
In order to use account impersonation, pass in the email address of the account to be
impersonated as a string.
"""

def __init__(self, google_keyfile_dict=None, subject=None):

scope = ["https://www.googleapis.com/auth/drive"]

setup_google_application_credentials(
google_keyfile_dict, "GOOGLE_DRIVE_CREDENTIALS"
)
google_credential_file = open(os.environ["GOOGLE_DRIVE_CREDENTIALS"])
credentials_dict = json.load(google_credential_file)

credentials = Credentials.from_service_account_info(
credentials_dict, scopes=scope, subject=subject
)
Comment on lines +30 to +38
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you consider using the new pattern adopted by other google connectors as of #1040 to avoid reimplementing the issue #1039?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@austinweisgrau I previously had:

self.client = build("drive", "v3", credentials=credentials)

If I follow your code from the other PR, will the following work too:

self.client = AuthorizedSession(credentials)


self.client = build("drive", "v3", credentials=credentials)

def get_permissions(self, file_id):
"""
`Args:`
file_id: str
this is the ID of the object you are hoping to share
`Returns:`
permission dict
"""

p = self.client.permissions().list(fileId=file_id).execute()

return p

def _share_object(self, file_id, permission_dict):

# Send the request to share the file
p = (
self.client.permissions()
.create(fileId=file_id, body=permission_dict)
.execute()
)

return p

def share_object(self, file_id, email_addresses=None, role="reader", type="user"):
"""
`Args:`
file_id: str
this is the ID of the object you are hoping to share
email_addresses: list
this is the list of the email addresses you want to share;
set to a list of domains like `['domain']` if you choose `type='domain'`;
set to `None` if you choose `type='anyone'`
role: str
Options are -- owner, organizer, fileOrganizer, writer, commenter, reader
https://developers.google.com/drive/api/guides/ref-roles
type: str
Options are -- user, group, domain, anyone
`Returns:`
List of permission objects
"""
if role not in [
"owner",
"organizer",
"fileOrganizer",
"writer",
"commenter",
"reader",
]:
raise Exception(
f"{role} not from the allowed list of: \
owner, organizer, fileOrganizer, writer, commenter, reader"
)

if type not in ["user", "group", "domain", "anyone"]:
raise Exception(
f"{type} not from the allowed list of: \
user, group, domain, anyone"
)

if type == "domain":
permissions = [
{"type": type, "role": role, "domain": email}
for email in email_addresses
]
else:
permissions = [
{"type": type, "role": role, "emailAddress": email}
for email in email_addresses
]

new_permissions = []
for permission in permissions:
p = self._share_object(file_id, permission)
new_permissions.append(p)

return new_permissions

def transfer_ownership(self, file_id, new_owner_email):
"""
`Args:`
file_id: str
this is the ID of the object you are hoping to share
new_owner_email: str
the email address of the intended new owner
`Returns:`
None
"""
permissions = self.client.permissions().list(fileId=file_id).execute()

# Find the current owner
current_owner_permission = next(
(p for p in permissions.get("permissions", []) if "owner" in p), None
)

if current_owner_permission:
# Update the permission to transfer ownership
new_owner_permission = {
"type": "user",
"role": "owner",
"emailAddress": new_owner_email,
}
self.client.permissions().update(
fileId=file_id,
permissionId=current_owner_permission["id"],
body=new_owner_permission,
).execute()
logger.info(f"Ownership transferred successfully to {new_owner_email}.")
else:
logger.info("File does not have a current owner.")

return None
Loading
Loading