diff --git a/gsheets/CHANGELOG.md b/gsheets/CHANGELOG.md new file mode 100644 index 0000000..78d9414 --- /dev/null +++ b/gsheets/CHANGELOG.md @@ -0,0 +1,6 @@ +# Change Log + +## 0.1.0 + +- Initial release + diff --git a/gsheets/LICENSE b/gsheets/LICENSE new file mode 100644 index 0000000..9c8f3ea --- /dev/null +++ b/gsheets/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/gsheets/README.md b/gsheets/README.md new file mode 100644 index 0000000..3b69cfa --- /dev/null +++ b/gsheets/README.md @@ -0,0 +1,20 @@ +# Google Sheets Integration Pack + +StackStorm integration with [Google Sheets](https://workspace.google.com/products/sheets/) platform. + +## Usage + +1. Create a [Google Cloud](https://cloud.google.com/) account if you don't have one already. +1. Go to [APIs and Services](https://console.cloud.google.com/apis/dashboard?project=messam-409712). +1. Enable Google Sheets API. +1. Go to [credentials](https://console.cloud.google.com/apis/credentials?project=messam-409712). +1. Create a service account for the integration. +1. Create a JSON key for the service account, convert it into base64 encoding. +1. Add the key into the pack configuration as service_account_key. +1. Note the email of the service account, and add the email as a collaborator on the sheet(s) you need it to access. + +## Actions + +* ``get`` - Get a range of values from a sheet, check [official Google documentation](https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#get) for usage. +* ``clear`` - Clear a range of values from a sheet. +* ``update`` - Update a range of values in a sheet, check [docs](https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#update) for usage. diff --git a/gsheets/actions/append.py b/gsheets/actions/append.py new file mode 100644 index 0000000..1242635 --- /dev/null +++ b/gsheets/actions/append.py @@ -0,0 +1,22 @@ +from st2common.runners.base_action import Action +import json, base64 + +from apiclient import discovery +from google.oauth2 import service_account + +class Append(Action): + def __init__(self, config=None, action_service=None): + super(Append, self).__init__( + config=config, action_service=action_service + ) + client_secret = json.loads(base64.b64decode(config.get('service_account_key'))) + credentials = service_account.Credentials.from_service_account_info(client_secret) + self._service = discovery.build('sheets', 'v4', credentials=credentials) + + def run(self, spreadsheet_id, range, values, value_input_option, insert_data_option=None, major_dimension=None, response_value_render_option=None, include_values_in_response=False): + data = self._service.spreadsheets().values().append(spreadsheetId=spreadsheet_id, range=range, body={ + "majorDimension": major_dimension, + "range": range, + "values": values + }, includeValuesInResponse=include_values_in_response, insertDataOption=insert_data_option, valueInputOption=value_input_option, responseValueRenderOption=response_value_render_option).execute() + return {"data": data} diff --git a/gsheets/actions/append.yaml b/gsheets/actions/append.yaml new file mode 100644 index 0000000..9258096 --- /dev/null +++ b/gsheets/actions/append.yaml @@ -0,0 +1,30 @@ +description: 'Append Range data https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#append' +enabled: true +entry_point: append.py +name: append +parameters: + spreadsheet_id: + type: string + required: true + range: + type: string + required: true + values: + type: array + required: true + insert_data_option: + type: string + required: false + value_input_option: + type: string + required: true + major_dimension: + type: string + required: false + response_value_render_option: + type: string + required: false + include_values_in_response: + type: boolean + required: false +runner_type: "python-script" \ No newline at end of file diff --git a/gsheets/actions/clear.py b/gsheets/actions/clear.py new file mode 100644 index 0000000..5d5d72c --- /dev/null +++ b/gsheets/actions/clear.py @@ -0,0 +1,18 @@ +from st2common.runners.base_action import Action +import json, base64 + +from apiclient import discovery +from google.oauth2 import service_account + +class Clear(Action): + def __init__(self, config=None, action_service=None): + super(Clear, self).__init__( + config=config, action_service=action_service + ) + client_secret = json.loads(base64.b64decode(config.get('service_account_key'))) + credentials = service_account.Credentials.from_service_account_info(client_secret) + self._service = discovery.build('sheets', 'v4', credentials=credentials) + + def run(self, spreadsheet_id, range): + self._service.spreadsheets().values().clear(spreadsheetId=spreadsheet_id, range=range).execute() + diff --git a/gsheets/actions/clear.yaml b/gsheets/actions/clear.yaml new file mode 100644 index 0000000..877aebc --- /dev/null +++ b/gsheets/actions/clear.yaml @@ -0,0 +1,12 @@ +description: 'Clear Range data https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#get' +enabled: true +entry_point: clear.py +name: clear +parameters: + spreadsheet_id: + type: string + required: true + range: + type: string + required: true +runner_type: "python-script" \ No newline at end of file diff --git a/gsheets/actions/get.py b/gsheets/actions/get.py new file mode 100644 index 0000000..1184258 --- /dev/null +++ b/gsheets/actions/get.py @@ -0,0 +1,21 @@ +from st2common.runners.base_action import Action +import json, base64 + +from apiclient import discovery +from google.oauth2 import service_account + +class Get(Action): + def __init__(self, config=None, action_service=None): + super(Get, self).__init__( + config=config, action_service=action_service + ) + client_secret = json.loads(base64.b64decode(config.get('service_account_key'))) + credentials = service_account.Credentials.from_service_account_info(client_secret) + self._service = discovery.build('sheets', 'v4', credentials=credentials) + + def run(self, spreadsheet_id, range, major_dimension="ROWS", value_render_option="FORMATTED_VALUE"): + data = self._service.spreadsheets().values().get(spreadsheetId=spreadsheet_id, range=range, majorDimension=major_dimension, valueRenderOption=value_render_option).execute() + values = [[]] + if data.get("values") is not None: + values = data.get("values") + return {"data": values} diff --git a/gsheets/actions/get.yaml b/gsheets/actions/get.yaml new file mode 100644 index 0000000..56329be --- /dev/null +++ b/gsheets/actions/get.yaml @@ -0,0 +1,18 @@ +description: 'Get Range data https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#get' +enabled: true +entry_point: get.py +name: get +parameters: + spreadsheet_id: + type: string + required: true + range: + type: string + required: true + major_dimension: + type: string + required: false + value_render_option: + type: string + required: false +runner_type: "python-script" \ No newline at end of file diff --git a/gsheets/actions/range_helper.py b/gsheets/actions/range_helper.py new file mode 100644 index 0000000..a0e3742 --- /dev/null +++ b/gsheets/actions/range_helper.py @@ -0,0 +1,24 @@ +from st2common.runners.base_action import Action +import math + +class Get(Action): + def run(self, row, column): + row += 1 + column_name_len = 0 + temp = column + start = 0 + while temp > 0: + column_name_len+=1 + temp -= 26 ** column_name_len + if temp > 0: + start += 26 ** column_name_len + letter_idx = [] + column = column - start + if column == 0: + letter_idx = [0] + else: + while column > 0: + letter_idx.append(int(column % 26)) + column = column // 26 + letter_idx.reverse() + return "".join([chr(ord('A') + x) for x in letter_idx]) + str(row) \ No newline at end of file diff --git a/gsheets/actions/range_helper.yaml b/gsheets/actions/range_helper.yaml new file mode 100644 index 0000000..b6f77c0 --- /dev/null +++ b/gsheets/actions/range_helper.yaml @@ -0,0 +1,12 @@ +description: 'Convert index to cell ID' +enabled: true +entry_point: range_helper.py +name: range_helper +parameters: + row: + type: number + required: true + column: + type: number + required: true +runner_type: "python-script" \ No newline at end of file diff --git a/gsheets/actions/update.py b/gsheets/actions/update.py new file mode 100644 index 0000000..383e521 --- /dev/null +++ b/gsheets/actions/update.py @@ -0,0 +1,22 @@ +from st2common.runners.base_action import Action +import json, base64 + +from apiclient import discovery +from google.oauth2 import service_account + +class Update(Action): + def __init__(self, config=None, action_service=None): + super(Update, self).__init__( + config=config, action_service=action_service + ) + client_secret = json.loads(base64.b64decode(config.get('service_account_key'))) + credentials = service_account.Credentials.from_service_account_info(client_secret) + self._service = discovery.build('sheets', 'v4', credentials=credentials) + + def run(self, spreadsheet_id, range, values, value_input_option, major_dimension=None, response_value_render_option=None, include_values_in_response=False): + data = self._service.spreadsheets().values().update(spreadsheetId=spreadsheet_id, range=range, body={ + "majorDimension": major_dimension, + "range": range, + "values": values + }, includeValuesInResponse=include_values_in_response, valueInputOption=value_input_option, responseValueRenderOption=response_value_render_option).execute() + return {"data": data} diff --git a/gsheets/actions/update.yaml b/gsheets/actions/update.yaml new file mode 100644 index 0000000..2637324 --- /dev/null +++ b/gsheets/actions/update.yaml @@ -0,0 +1,27 @@ +description: 'Update Range data https://googleapis.github.io/google-api-python-client/docs/dyn/sheets_v4.spreadsheets.values.html#update' +enabled: true +entry_point: update.py +name: update +parameters: + spreadsheet_id: + type: string + required: true + range: + type: string + required: true + values: + type: array + required: true + value_input_option: + type: string + required: true + major_dimension: + type: string + required: false + response_value_render_option: + type: string + required: false + include_values_in_response: + type: boolean + required: false +runner_type: "python-script" \ No newline at end of file diff --git a/gsheets/config.schema.yaml b/gsheets/config.schema.yaml new file mode 100644 index 0000000..65d8805 --- /dev/null +++ b/gsheets/config.schema.yaml @@ -0,0 +1,6 @@ +--- + service_account_key: + description: "Base64 encoded key of Service Account" + type: "string" + secret: true + required: true \ No newline at end of file diff --git a/gsheets/gsheets.yaml.example b/gsheets/gsheets.yaml.example new file mode 100644 index 0000000..e85076a --- /dev/null +++ b/gsheets/gsheets.yaml.example @@ -0,0 +1,2 @@ +--- +service_account_key: "SGVsbG8gdGhlcmU=" diff --git a/gsheets/icon.png b/gsheets/icon.png new file mode 100644 index 0000000..3229558 Binary files /dev/null and b/gsheets/icon.png differ diff --git a/gsheets/pack.yaml b/gsheets/pack.yaml new file mode 100644 index 0000000..3bf722e --- /dev/null +++ b/gsheets/pack.yaml @@ -0,0 +1,21 @@ +--- +# Pack reference. It can only contain lowercase letters, digits and underscores. +# This attribute is only needed if "name" attribute contains special characters. +ref: gsheets +# User-friendly pack name. If this attribute contains spaces or any other special characters, then +# the "ref" attribute must also be specified (see above). +name: Google Sheets +# User-friendly pack description. +description: Google Sheets API pack +# Keywords which are used when searching for packs. +keywords: + - sheets +# Pack version which must follow semver format (.. e.g. 1.0.0) +version: 0.1.0 +# A list of major Python versions pack is tested with and works with. +python_versions: + - "3" +# Name of the pack author. +author: M. Essam +# Email of the pack author. +email: info@messam.xyz diff --git a/gsheets/requirements.txt b/gsheets/requirements.txt new file mode 100644 index 0000000..5ed4a85 --- /dev/null +++ b/gsheets/requirements.txt @@ -0,0 +1,19 @@ +cachetools==5.3.3 +certifi==2024.6.2 +charset-normalizer==3.3.2 +google-api-core==2.19.1 +google-api-python-client==2.134.0 +google-auth==2.30.0 +google-auth-httplib2==0.2.0 +googleapis-common-protos==1.63.2 +httplib2==0.22.0 +idna==3.7 +proto-plus==1.24.0 +protobuf==5.27.2 +pyasn1==0.6.0 +pyasn1_modules==0.4.0 +pyparsing==3.1.2 +requests==2.32.3 +rsa==4.9 +uritemplate==4.1.1 +urllib3==2.2.2