3 files changed, 455 insertions(+), 0 deletions(-)

A => LICENSE
A => README.md
A => googlechat.groovy
A => LICENSE +201 -0
@@ 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 2019 Jeff Turner <jeff@redradishtech.com>
+
+   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.

          
A => README.md +20 -0
@@ 0,0 1,20 @@ 
+# Jira / Google Chat Integration
+
+This [ScriptRunner for Jira](https://scriptrunner.adaptavist.com/latest/index.html) script lets your Jira send event updates to a Google Chat (https://chat.google.com) room.
+
+The chat room is notified by webhook, and in this implementation, the webhook is read per-issue from a custom field. This means that chat notification needs to be explicitly configured per-issue. Feel free to modify the code (`getWebhookUrl`) to just return a static webhook URL for all issues.
+
+## Installation
+
+Assuming you have ScriptRunner for Jira installed:
+
+ 1. Save the script to $JIRAHOME/scripts/googlechat.groovy
+ 2. In Jira, create a custom field called **Chat Webhook**, of type **Text Field (single line)**, scoped appropriately for projects you may want Chat notifications for. Note the ID of this new custom field.
+ 3. Edit googlechat.groovy and set the `WEBHOOK_CHAT_CUSTOMFIELD_ID` value to the ID of your field.
+ 4. In ScriptRunner, click 'Create Listener' ->  Custom Listener. Pick the project(s) and issue event(s) you want notifications for (non-issue events won't work). Set 'Script file' to 'googlechat.groovy' (or wherever you put it, relative to $JIRAHOME/scripts/).
+ 5. In a https://chat.google.com chatroom, click the top menu beneath the room name, then 'Configure Webooks'. Create a new webhook. As Avatar URL, enter https://jira.atlassian.com/images/64jira.png ![](https://jira.atlassian.com/images/64jira.png)
+ 6. In a Jira issue, set the **Chat Webhook** field value to the webhook URL.
+ 7. Comment or update the issue. You should see a corresponding message in your chat room.
+
+### Debugging
+If it doesn't work, check the ScriptRunner listener history, where you can see any failures in the logs, or HTTP failure messages returned from Google. 

          
A => googlechat.groovy +234 -0
@@ 0,0 1,234 @@ 
+/** 
+ * ScriptRunner for Jira listener that messages a Google Chat group of an event, via a webhook whose URL is embedded as a custom field on issues.
+ * 
+ * jeff@redradishtech.com,  20 June 2019
+ * Apache license 2.0
+ */
+
+import java.util.regex.Pattern
+import java.net.URI
+
+import groovyx.net.http.HTTPBuilder
+import groovyx.net.http.URIBuilder
+import groovy.json.JsonBuilder
+import static groovyx.net.http.ContentType.*
+import groovyx.net.http.ContentType
+import static groovyx.net.http.Method.*
+import groovy.json.JsonSlurper
+import net.sf.json.groovy.JsonSlurper
+import groovy.json.JsonOutput
+
+import com.atlassian.jira.event.type.EventTypeManager
+import com.atlassian.jira.component.ComponentAccessor
+import com.atlassian.jira.workflow.WorkflowManager
+import com.atlassian.jira.issue.Issue
+import com.atlassian.jira.event.issue.*
+
+import org.ofbiz.core.entity.GenericValue
+
+Long WEBHOOK_CHAT_CUSTOMFIELD_ID = 16901;
+
+def log(msg) {
+	System.out.println(msg);
+}
+
+/* Return the URL webhook this issue wants to update, or null if unset. */
+def String getWebhookUrl(Issue issue, Long chatWebhookCFId) {
+	def chatWebhookCF = ComponentAccessor.customFieldManager.getCustomFieldObject(chatWebhookCFId);
+	if (chatWebhookCF) {
+		def chatWebhookCFVal = issue.getCustomFieldValue(chatWebhookCF);
+		if (chatWebhookCFVal) {
+			def pattern = ~"^https://chat.googleapis.com/v1/spaces/";
+			if (chatWebhookCFVal =~ pattern) {
+				log.debug("${chatWebhookCFVal} matched pattern ${pattern}");
+				return chatWebhookCFVal;
+			} else {
+				log.warn("Issue ${issue} contains a ${chatWebhookCF} field whose value (${chatWebhookCFVal}) does not match the expected pattern ${pattern}");
+			}
+		} else {
+			log.debug("No '${chatWebhookCF}' field on ${issue}");
+		}
+	} else {
+		log.warn("Custom field with ID ${chatWebhookCFId} does not exist. It should be a single line text field called 'Chat Webhook' or similar.");
+	}
+	// Returns null if anything fails.
+}
+
+def debugMessages(IssueEvent event) {
+	log "--------------------------------------";
+	log "event: ${event?.getClass()}";
+	log "event.issue: ${event.issue.getClass()}";
+	log "event.changeLog: is ${event?.changeLog?.getClass()}";
+	log "event.comment: is ${event.comment?.getClass()}";
+	log "Event methods:";
+	log(event.metaClass.methods*.name.sort().unique()  );
+	if (event?.changeLog) {
+		log "changeitems: ${event.changeLog.getRelated('ChildChangeItem').getClass()}";
+		event.changeLog.getRelated("ChildChangeItem").each {
+			def ci = it as GenericValue;
+			log "Change: ${ci.getString('oldstring')} → ${ci.getString('newstring')}";
+		}
+	}
+}
+
+def String getBaseUrl() {
+	// https://community.atlassian.com/t5/Answers-Developer-Questions/How-do-I-programatically-find-JIRA-s-base-URL/qaq-p/519640
+	return ComponentAccessor.getApplicationProperties().getString("jira.baseurl");
+}
+
+def messageWebhook(String webhookUrl, IssueEvent event) {
+	//debugMessages(event);
+
+	def threadKey = baseUrl.replaceAll("https://", '') + "-" + event.issue.key;
+	URIBuilder uriBuilder = new URIBuilder(webhookUrl).addQueryParam("threadKey", threadKey);
+	log.debug "Built URL ${uriBuilder}";
+
+	Card card = new Card(event);
+	// https://developers.google.com/hangouts/chat/reference/rest/v1/spaces.messages/create
+	def http = new HTTPBuilder("${uriBuilder}");
+
+	// https://community.atlassian.com/t5/Adaptavist-questions/POST-to-Rest-API-Scriptrunner/qaq-p/645062
+	http.request(POST, ContentType.JSON) { request ->
+
+		// https://stackoverflow.com/questions/35636099/using-groovys-httpbuilder-how-do-you-set-timeouts
+		request.getParams().setParameter("http.socket.timeout", 5000);
+		request.getParams().setParameter("http.connection.timeout", 5000);
+		requestContentType = ContentType.JSON;
+		request.addHeader("Content-Type", "application/json; charset=UTF-8");
+		//body = new JsonBuilder( ['text': messageText] ).toString()
+		// https://developers.google.com/hangouts/chat/reference/message-formats/cards
+
+		body = card.toJSON();
+
+		response.success = { resp, JSON ->
+			log.warn("Success response: ${JSON}");
+			return JSON
+		};
+		response.failure = { resp, JSON ->
+			log.warn("Failure response: ${JSON}");
+			return JSON
+		};
+	}
+}
+
+/** Create a Google Card JSON representation of an event.
+ * https://developers.google.com/hangouts/chat/reference/message-formats/cards
+ */
+class Card {
+	Issue issue
+		IssueEvent event
+
+		Card(event) {
+			this.event = event;
+			this.issue = event.issue;
+		}
+
+	def log(msg) {
+		System.out.println(msg);
+	}
+
+	def getBaseUrl() {
+		// https://community.atlassian.com/t5/Answers-Developer-Questions/How-do-I-programatically-find-JIRA-s-base-URL/qaq-p/519640
+		return ComponentAccessor.getApplicationProperties().getString("jira.baseurl");
+	}
+
+	def getEventType() {
+		def Long eventTypeID = event.getEventTypeId();
+		return ComponentAccessor.eventTypeManager.getEventType(event.getEventTypeId()).getName();
+	}
+
+
+	String keyValue(key, value)
+	{
+		if (value != null) {
+			"""
+			{
+				"keyValue": {
+					"topLabel": "${key}",
+						"content": "${value}"
+				}
+			}"""
+		} else { null }
+	}
+
+	String textPara(key, value)
+	{
+		if (value != null) {
+			"""
+			{
+				"textParagraph": {
+					"text": "${value}"
+				}
+			}"""
+		} else { null }
+	}
+
+	String changeLog() {
+		if (event?.changeLog) {
+			// "changeitems: ${event.changeLog.getRelated('ChildChangeItem').getClass()}";
+			return event.changeLog.getRelated("ChildChangeItem").collect {
+				def ci = it as GenericValue;
+				def field = ci.getString("field");
+				//if (field == "status") return "";
+				def oldval = ci.getString("oldstring");
+				def newval = ci.getString("newstring");
+				keyValue(field, newval + (oldval ? " (was: ${oldval})" : ""));
+			}
+			.join(", ")
+		} else {
+			return ""
+		}
+	}
+
+	String toJSON() 
+	{
+		"""
+		{
+			"cards": [
+			{
+				"header": {
+					"title": "${eventType}: [${issue.key}] ${issue.summary}",
+						"subtitle": ""
+				},
+					"sections": [
+					{
+						"widgets": [ """ + [
+							keyValue("Status", issue.status.name)
+								, keyValue("Assignee", issue.assignee?.displayName)
+								, keyValue("Updated By", event.user?.displayName)
+								, keyValue("Comment", event.comment?.body)
+								, changeLog()
+						].findResults { it // keyValue() returns null for unset fields.
+						}.join(", ") + 
+						"""
+						]
+					},
+					{
+						"widgets": [
+						{
+							"buttons": [
+							{
+								"textButton": {
+									"text": "OPEN ISSUE",
+									"onClick": {
+										"openLink": {
+											"url": "${baseUrl}/browse/${issue.key}"
+										}
+									}
+								}
+							}
+							]
+						}
+						]
+					}
+				]
+			}
+			]
+		}""";
+	}
+}
+
+def webhookUrl = getWebhookUrl(event.issue, WEBHOOK_CHAT_CUSTOMFIELD_ID);
+if (webhookUrl) {
+	messageWebhook(webhookUrl, event);
+}