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

First Pass at a Bulk Reassign #24

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 2 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
173 changes: 173 additions & 0 deletions bulk_reassign_docs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
#!/usr/bin/env python3

import argparse
import requests
from utils import SigmaClient


def get_member_id(client, user_email):
""" Update member

:access_token: Generated access token
:user_email: Users email

:returns: ID associated with the user_email
"""
try:
response = client.get(
f"v2/members?search={user_email}"
)
response.raise_for_status()
# HTTP and other errors are handled generally by raising them as exceptions to be surfaced in downstream code
except requests.exceptions.HTTPError as errh:
# The API response's message value is sent in lieu of the full response to display to the user for clarity
raise Exception(errh.response.status_code,
f"API message: {errh.response.json()['message']}")
except requests.exceptions.ConnectionError as errc:
raise Exception(
f"Connection Error: {errc}, API response: {errc.response.text}")
except requests.exceptions.Timeout as errt:
raise Exception(
f"Timeout Error: {errt}, API response: {errt.response.text}")
except requests.exceptions.RequestException as err:
raise Exception(
f"Other Error: {err}, API response: {err.response.text}")
else:
data = response.json()
if len(data['entries']) == 0:
print("No users found with this email:", user_email)
raise SystemExit("Script aborted")
else:
return data['entries'][0]['memberId']
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved


def get_member_files(client, user_id):
""" Update member
:user_id: id of current owner

:returns: an array of file objects

"""
data = []
moreResults = True
nextPage = ''
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
while moreResults:
try:
response = client.get(
f"v2/members/{user_id}/files?typeFilters=workbook&typeFilters=dataset&limit=500{nextPage}"
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
)
response.raise_for_status()

except requests.exceptions.HTTPError as errh:
raise Exception(
f"Connection Error: {errh}, API response: {errh.response.text}")
except requests.exceptions.ConnectionError as errc:
raise Exception(
f"Connection Error: {errc}, API response: {errc.response.text}")
except requests.exceptions.Timeout as errt:
raise Exception(
f"Timeout Error: {errt}, API response: {errt.response.text}")
except requests.exceptions.RequestException as err:
raise Exception(
f"Other Error: {err}, API response: {err.response.text}")
else:
resp = response.json()
data = data + resp['entries']
if resp['nextPage'] is None:
moreResults = False
else:
pageID = str(resp['nextPage'])
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
nextPage = f'&page={pageID}'
return data


def update_file(client, user_id, file_id):
""" Update file

:access_token: Generated access token
:userId: ID of the new owner
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
:file_id: File to transfer ownership of

:returns: Response JSON

"""
try:
response = client.patch(
f"v2/files/{file_id}",
json={"ownerId": user_id}

Choose a reason for hiding this comment

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

Without a parentId, what happens with workbooks and unsaved explorations? Would these all be dumped into someone's "My documents" section? (I assume if the workbooks are in a workspace, then they won't be moved)

Could it be better to allow the end user to optionally designate a folder into which these reassigned files will go?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added optional arg for this

)
response.raise_for_status()
# HTTP and other errors are handled generally by raising them as exceptions to be surfaced in downstream code
except requests.exceptions.HTTPError as errh:
# The API response's message value is sent in lieu of the full response to display to the user for clarity
# Certain error response messages are useful for the user troubleshoot common issues, such as invalid Member Type or New Email already in use
raise Exception(errh.response.status_code,
f"API message: {errh.response.json()['message']}")
except requests.exceptions.ConnectionError as errc:
raise Exception(
f"Connection Error: {errc}, API response: {errc.response.text}")
except requests.exceptions.Timeout as errt:
raise Exception(
f"Timeout Error: {errt}, API response: {errt.response.text}")
except requests.exceptions.RequestException as err:
raise Exception(
f"Other Error: {err}, API response: {err.response.text}")
else:
data = response.json()
print("transfer of document:", file_id, "---", response)
return data


def main():
parser = argparse.ArgumentParser(
description='Transfer all a users documents to another user')
parser.add_argument(
'--env', type=str, required=True, help='env to use: [production | staging].')
parser.add_argument(
'--cloud', type=str, required=True, help='Cloud to use: [aws | gcp | azure]')
parser.add_argument(
'--client_id', type=str, required=True, help='Client ID generated from within Sigma')
parser.add_argument(
'--client_secret', type=str, required=True, help='Client secret API token generated from within Sigma')
parser.add_argument(
'--curr_owner', type=str, required=True, help='Org Member who currently owns the documents')
parser.add_argument(
'--new_owner', type=str, required=True, help='Org Member who you want to transfer the documents to')
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved

args = parser.parse_args()
client = SigmaClient(args.env, args.cloud,
args.client_id, args.client_secret)

# we need to confirm that both the existing user and new user are valid "check_users" fn
try:
curr_owner_id = get_member_id(client, args.curr_owner)
except Exception as e:
print(f"{e}")
raise SystemExit("Script aborted")

try:
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
new_owner_id = get_member_id(client, args.new_owner)
except Exception as e:
print(f"{e}")
raise SystemExit("Script aborted")

# get files of curr_user
try:
member_files = get_member_files(client, curr_owner_id)
except Exception as e:
print(f"{e}")
raise SystemExit("Script aborted")

# filter to only docs they own
filtered_arr = [p for p in member_files if p['ownerId'] == curr_owner_id]
# loop through and reassign ownership
for d in filtered_arr:
BrettBSigma marked this conversation as resolved.
Show resolved Hide resolved
try:
update_member_response = update_file(client, new_owner_id, d['id'])
except Exception as e:
print(f"{e}")
raise SystemExit("Script aborted")


if __name__ == '__main__':
main()