Skip to content

Commit

Permalink
packs/GoogleDrive: add modify labels command (#28962)
Browse files Browse the repository at this point in the history 
* packs/GoogleDrive: add modify labels command

Add a command to modify labels in google drive

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: add modify labels command readme

Generate docs based on yaml

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: add get labels command

Get labels command to get all labels in google drive

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: get-file-labels command

Add command to get labels attached to file

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: update version 1.2.40

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: update release notes

Signed-off-by: Gal Nakash <[email protected]>

* Update Packs/GoogleDrive/Integrations/GoogleDrive/GoogleDrive.py

Co-authored-by: ostolero <[email protected]>

* packs/GoogleDrive: fix return value

Return result instead of return

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: add a test for list labels

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: add a test for modify label

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: rename test files

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: added context path for GoogleDrive modify lables

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: added context path for GoogleDrive get file labels

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: added context path for GoogleDrive get labels

Signed-off-by: Gal Nakash <[email protected]>

* packs/GoogleDrive: format file and fix test

Signed-off-by: Gal Nakash <[email protected]>

* update readme

* update docker

* packs/reco: fix test

Signed-off-by: Gal Nakash <[email protected]>

---------

Signed-off-by: Gal Nakash <[email protected]>
Co-authored-by: ostolero <[email protected]>
Co-authored-by: ostolero <[email protected]>
  • Loading branch information
@GalNakash-RecoLabs @ostolero
3 people authored Aug 22, 2023
1 parent 61d8de7 commit 22e90e7
Show file tree
Hide file tree
Showing 8 changed files with 1,022 additions and 23 deletions.
148 changes: 145 additions & 3 deletions Packs/GoogleDrive/Integrations/GoogleDrive/GoogleDrive.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
'EXCEPTION_LIST_GENERIC': 'Exception searching for {}: {}',

'EXCEPTION_GENERIC': 'Exception handling a {} request: {}',
'MODIFY_LABEL_SUCCESS': 'Modify label successfully assigned to {}.',
'GET_LABEL_SUCCESS': 'Label successfully retrieved.',
'GET_LABELS_SUCCESS': 'Labels successfully retrieved.',
}

SCOPES: dict[str, list[str]] = {
Expand Down Expand Up @@ -98,12 +101,17 @@
'FILE_PERMISSIONS_CRUD': [
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/drive.file',
]
],

'MODIFY_LABELS_PERMISSIONS_CRUD': [
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/drive.labels',
]
}

URLS: dict[str, str] = {
'DRIVE_ACTIVITY': 'https://driveactivity.googleapis.com/v2/activity:query'
'DRIVE_ACTIVITY': 'https://driveactivity.googleapis.com/v2/activity:query',
'DRIVE_LABELS': 'https://drivelabels.googleapis.com/v2/labels'
}
URL_SUFFIX: dict[str, str] = {
'DRIVE_CHANGES': 'drive/v3/changes',
Expand All @@ -120,6 +128,8 @@
'FILE_PERMISSION_CREATE': 'drive/v3/files/{}/permissions',
'FILE_PERMISSION_UPDATE': 'drive/v3/files/{}/permissions/{}',
'FILE_PERMISSION_DELETE': 'drive/v3/files/{}/permissions/{}',
'FILE_MODIFY_LABEL': 'drive/v3/files/{}/modifyLabels',
'FILE_GET_LABELS': 'drive/v3/files/{}/listLabels'
}

OUTPUT_PREFIX: dict[str, str] = {
Expand All @@ -143,6 +153,8 @@
'GOOGLE_DRIVE_FILE_PERMISSION_HEADER': 'GoogleDrive.FilePermission',
'FILE_PERMISSION': 'FilePermission',

'LABELS': 'GoogleDrive.Labels'

}

DATE_FORMAT: str = '%Y-%m-%d' # sample - 2020-08-23
Expand Down Expand Up @@ -1196,6 +1208,102 @@ def file_replace_existing_command(client: 'GSuiteClient', args: dict[str, str])
return handle_response_file_single(file, args)


@logger
def modify_label_command(client: 'GSuiteClient', args: dict[str, str]) -> CommandResults:
modify_label_request_res = prepare_file_modify_labels_request(
client, args, scopes=COMMAND_SCOPES['MODIFY_LABELS_PERMISSIONS_CRUD'])
http_request_params = modify_label_request_res['http_request_params']

url_suffix = URL_SUFFIX['FILE_MODIFY_LABEL'].format(args.get('file_id'))
body_request = {
"kind": "drive#modifyLabelsRequest",
"labelModifications": [
{
"fieldModifications": [
{
"kind": "drive#labelFieldModification",
"fieldId": args.get('field_id'),
"setSelectionValues": [
args.get('selection_label_id')
]
}
],
"kind": "drive#labelModification",
"labelId": args.get('label_id'),
"removeLabel": args.get('remove_label', False)
}
]
}

response = client.http_request(url_suffix=url_suffix, method='POST', params=http_request_params, body=body_request)

table_hr_md = tableToMarkdown(HR_MESSAGES['MODIFY_LABEL_SUCCESS'].format(args.get('file_id')),
response,
headerTransform=pascalToSpace,
removeNull=False)
outputs_context = {
OUTPUT_PREFIX['LABELS']: response
}

return CommandResults(
outputs=outputs_context,
raw_response=response,
readable_output=table_hr_md,
)


def get_file_labels_command(client: 'GSuiteClient', args: dict[str, str]) -> CommandResults:
modify_label_request_res = prepare_file_modify_labels_request(
client, args, scopes=COMMAND_SCOPES['MODIFY_LABELS_PERMISSIONS_CRUD'])
http_request_params = modify_label_request_res['http_request_params']

url_suffix = URL_SUFFIX['FILE_GET_LABELS'].format(args.get('file_id'))

response = client.http_request(url_suffix=url_suffix, method='GET', params=http_request_params)

outputs_context = {
OUTPUT_PREFIX['LABELS']: response,
OUTPUT_PREFIX['GOOGLE_DRIVE_FILE_HEADER']: {
OUTPUT_PREFIX['FILE']: {
'id': args.get('file_id'),
},
}
}

table_hr_md = tableToMarkdown(HR_MESSAGES['GET_LABEL_SUCCESS'].format(args.get('file_id')),
response['labels'],
headerTransform=pascalToSpace,
removeNull=False)

return CommandResults(
outputs=outputs_context,
readable_output=table_hr_md,
)


def get_labels_command(client: 'GSuiteClient', args: dict[str, str]) -> CommandResults:
modify_label_request_res = prepare_get_labels_request(
client, args, scopes=COMMAND_SCOPES['MODIFY_LABELS_PERMISSIONS_CRUD'])
http_request_params = modify_label_request_res['http_request_params']

full_url = URLS['DRIVE_LABELS'] + '?' + urllib.parse.urlencode(http_request_params)
demisto.info(f'full url for get labels is: {full_url}')
response = client.http_request(full_url=full_url, method='GET')

outputs_context = {
OUTPUT_PREFIX['LABELS']: response
}

table_hr_md = tableToMarkdown(HR_MESSAGES['GET_LABELS_SUCCESS'],
response['labels'],
headerTransform=pascalToSpace,
removeNull=False)
return CommandResults(
readable_output=table_hr_md,
outputs=outputs_context
)


@logger
def file_delete_command(client: 'GSuiteClient', args: dict[str, str]) -> CommandResults:
"""
Expand Down Expand Up @@ -1319,6 +1427,37 @@ def prepare_file_permission_request(client: 'GSuiteClient', args: dict[str, str]
}


def prepare_file_modify_labels_request(client: 'GSuiteClient', args: dict[str, str], scopes: list[str]) -> dict[str, Any]:
# user_id can be overridden in the args
user_id = args.get('user_id') or client.user_id
client.set_authorized_http(scopes=scopes, subject=user_id)
# Prepare generic HTTP request params
http_request_params: dict[str, str] = assign_params(
fileId=args.get('file_id')
)

return {
'client': client,
'http_request_params': http_request_params,
'user_id': user_id,
}


def prepare_get_labels_request(client: 'GSuiteClient', args: dict[str, str], scopes: list[str]) -> dict[str, Any]:
# user_id can be overridden in the args
user_id = args.get('user_id') or client.user_id
client.set_authorized_http(scopes=scopes, subject=user_id)
http_request_params: dict[str, str] = assign_params(
view='LABEL_VIEW_FULL'
)

return {
'client': client,
'http_request_params': http_request_params,
'user_id': user_id,
}


@logger
def file_permission_list_command(client: 'GSuiteClient', args: dict[str, str]) -> CommandResults:
"""
Expand Down Expand Up @@ -1675,6 +1814,9 @@ def main() -> None:
'google-drive-file-permission-create': file_permission_create_command,
'google-drive-file-permission-update': file_permission_update_command,
'google-drive-file-permission-delete': file_permission_delete_command,
'google-drive-file-modify-label': modify_label_command,
'google-drive-get-labels': get_labels_command,
'google-drive-get-file-labels': get_file_labels_command,
}
command = demisto.command()

Expand Down Expand Up @@ -1709,7 +1851,7 @@ def main() -> None:
# This is the call made when pressing the integration Test button.
if demisto.command() == 'test-module':
result = test_module(gsuite_client, demisto.getLastRun(), params)
demisto.results(result)
return_results(result)
elif demisto.command() == 'fetch-incidents':

incidents, next_run = fetch_incidents(gsuite_client,
Expand Down
Loading

0 comments on commit 22e90e7

Please sign in to comment.