├── .github
    ├── CODEOWNERS
    ├── linters
    │   ├── .htmlhintrc
    │   ├── .yaml-lint.yml
    │   └── sun_checks.xml
    ├── sync-repo-settings.yaml
    └── workflows
    │   ├── automation.yml
    │   ├── lint.yml
    │   └── test.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── final
    ├── Code.gs
    └── appsscript.json
├── step-3
    ├── Code.gs
    └── appsscript.json
├── step-4
    ├── Code.gs
    └── appsscript.json
├── step-5
    ├── Code.gs
    └── appsscript.json
└── step-6
    ├── Code.gs
    └── appsscript.json


/.github/CODEOWNERS:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
16 | 
17 | .github/ @googleworkspace/workspace-devrel-dpe
18 | 


--------------------------------------------------------------------------------
/.github/linters/.htmlhintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "tagname-lowercase": true,
 3 |   "attr-lowercase": true,
 4 |   "attr-value-double-quotes": true,
 5 |   "attr-value-not-empty": false,
 6 |   "attr-no-duplication": true,
 7 |   "doctype-first": false,
 8 |   "tag-pair": true,
 9 |   "tag-self-close": false,
10 |   "spec-char-escape": false,
11 |   "id-unique": true,
12 |   "src-not-empty": true,
13 |   "title-require": false,
14 |   "alt-require": true,
15 |   "doctype-html5": true,
16 |   "id-class-value": false,
17 |   "style-disabled": false,
18 |   "inline-style-disabled": false,
19 |   "inline-script-disabled": false,
20 |   "space-tab-mixed-disabled": "space",
21 |   "id-class-ad-disabled": false,
22 |   "href-abs-or-rel": false,
23 |   "attr-unsafe-chars": true,
24 |   "head-script-disabled": false
25 | }
26 | 


--------------------------------------------------------------------------------
/.github/linters/.yaml-lint.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | ###########################################
 3 | # These are the rules used for            #
 4 | # linting all the yaml files in the stack #
 5 | # NOTE:                                   #
 6 | # You can disable line with:              #
 7 | # # yamllint disable-line                 #
 8 | ###########################################
 9 | rules:
10 |   braces:
11 |     level: warning
12 |     min-spaces-inside: 0
13 |     max-spaces-inside: 0
14 |     min-spaces-inside-empty: 1
15 |     max-spaces-inside-empty: 5
16 |   brackets:
17 |     level: warning
18 |     min-spaces-inside: 0
19 |     max-spaces-inside: 0
20 |     min-spaces-inside-empty: 1
21 |     max-spaces-inside-empty: 5
22 |   colons:
23 |     level: warning
24 |     max-spaces-before: 0
25 |     max-spaces-after: 1
26 |   commas:
27 |     level: warning
28 |     max-spaces-before: 0
29 |     min-spaces-after: 1
30 |     max-spaces-after: 1
31 |   comments: disable
32 |   comments-indentation: disable
33 |   document-end: disable
34 |   document-start:
35 |     level: warning
36 |     present: true
37 |   empty-lines:
38 |     level: warning
39 |     max: 2
40 |     max-start: 0
41 |     max-end: 0
42 |   hyphens:
43 |     level: warning
44 |     max-spaces-after: 1
45 |   indentation:
46 |     level: warning
47 |     spaces: consistent
48 |     indent-sequences: true
49 |     check-multi-line-strings: false
50 |   key-duplicates: enable
51 |   line-length:
52 |     level: warning
53 |     max: 120
54 |     allow-non-breakable-words: true
55 |     allow-non-breakable-inline-mappings: true
56 |   new-line-at-end-of-file: disable
57 |   new-lines:
58 |     type: unix
59 |   trailing-spaces: disable


--------------------------------------------------------------------------------
/.github/linters/sun_checks.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <!--
  3 |  Copyright 2022 Google LLC
  4 |  Licensed under the Apache License, Version 2.0 (the "License");
  5 |  you may not use this file except in compliance with the License.
  6 |  You may obtain a copy of the License at
  7 |       http://www.apache.org/licenses/LICENSE-2.0
  8 |  Unless required by applicable law or agreed to in writing, software
  9 |  distributed under the License is distributed on an "AS IS" BASIS,
 10 |  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 11 |  See the License for the specific language governing permissions and
 12 |  limitations under the License.
 13 | -->
 14 | 
 15 | <!DOCTYPE module PUBLIC
 16 |         "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
 17 |         "https://checkstyle.org/dtds/configuration_1_3.dtd">
 18 | 
 19 | <!--
 20 |     Checkstyle configuration that checks the Google coding conventions from Google Java Style
 21 |     that can be found at https://google.github.io/styleguide/javaguide.html
 22 |     Checkstyle is very configurable. Be sure to read the documentation at
 23 |     http://checkstyle.org (or in your downloaded distribution).
 24 |     To completely disable a check, just comment it out or delete it from the file.
 25 |     To suppress certain violations please review suppression filters.
 26 |     Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
 27 |  -->
 28 | 
 29 | <module name="Checker">
 30 |     <property name="charset" value="UTF-8"/>
 31 | 
 32 |     <property name="severity" value="warning"/>
 33 | 
 34 |     <property name="fileExtensions" value="java, properties, xml"/>
 35 |     <!-- Excludes all 'module-info.java' files              -->
 36 |     <!-- See https://checkstyle.org/config_filefilters.html -->
 37 |     <module name="BeforeExecutionExclusionFileFilter">
 38 |         <property name="fileNamePattern" value="module\-info\.java$"/>
 39 |     </module>
 40 |     <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
 41 |     <module name="SuppressionFilter">
 42 |         <property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
 43 |                   default="checkstyle-suppressions.xml"/>
 44 |         <property name="optional" value="true"/>
 45 |     </module>
 46 | 
 47 |     <!-- Checks for whitespace                               -->
 48 |     <!-- See http://checkstyle.org/config_whitespace.html -->
 49 |     <module name="FileTabCharacter">
 50 |         <property name="eachLine" value="true"/>
 51 |     </module>
 52 | 
 53 |     <module name="LineLength">
 54 |         <property name="fileExtensions" value="java"/>
 55 |         <property name="max" value="100"/>
 56 |         <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
 57 |     </module>
 58 | 
 59 |     <module name="TreeWalker">
 60 |         <module name="OuterTypeFilename"/>
 61 |         <module name="IllegalTokenText">
 62 |             <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
 63 |             <property name="format"
 64 |                       value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
 65 |             <property name="message"
 66 |                       value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
 67 |         </module>
 68 |         <module name="AvoidEscapedUnicodeCharacters">
 69 |             <property name="allowEscapesForControlCharacters" value="true"/>
 70 |             <property name="allowByTailComment" value="true"/>
 71 |             <property name="allowNonPrintableEscapes" value="true"/>
 72 |         </module>
 73 |         <module name="AvoidStarImport"/>
 74 |         <module name="OneTopLevelClass"/>
 75 |         <module name="NoLineWrap">
 76 |             <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
 77 |         </module>
 78 |         <module name="EmptyBlock">
 79 |             <property name="option" value="TEXT"/>
 80 |             <property name="tokens"
 81 |                       value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
 82 |         </module>
 83 |         <module name="NeedBraces">
 84 |             <property name="tokens"
 85 |                       value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
 86 |         </module>
 87 |         <module name="LeftCurly">
 88 |             <property name="tokens"
 89 |                       value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
 90 |                     INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
 91 |                     LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
 92 |                     LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
 93 |                     OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
 94 |         </module>
 95 |         <module name="RightCurly">
 96 |             <property name="id" value="RightCurlySame"/>
 97 |             <property name="tokens"
 98 |                       value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
 99 |                     LITERAL_DO"/>
100 |         </module>
101 |         <module name="RightCurly">
102 |             <property name="id" value="RightCurlyAlone"/>
103 |             <property name="option" value="alone"/>
104 |             <property name="tokens"
105 |                       value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
106 |                     INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
107 |                     COMPACT_CTOR_DEF"/>
108 |         </module>
109 |         <module name="SuppressionXpathSingleFilter">
110 |             <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
111 |             <property name="id" value="RightCurlyAlone"/>
112 |             <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
113 |                                      or preceding-sibling::*[last()][self::LCURLY]]"/>
114 |         </module>
115 |         <module name="WhitespaceAfter">
116 |             <property name="tokens"
117 |                       value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
118 |                     LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
119 |         </module>
120 |         <module name="WhitespaceAround">
121 |             <property name="allowEmptyConstructors" value="true"/>
122 |             <property name="allowEmptyLambdas" value="true"/>
123 |             <property name="allowEmptyMethods" value="true"/>
124 |             <property name="allowEmptyTypes" value="true"/>
125 |             <property name="allowEmptyLoops" value="true"/>
126 |             <property name="ignoreEnhancedForColon" value="false"/>
127 |             <property name="tokens"
128 |                       value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
129 |                     BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
130 |                     LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
131 |                     LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
132 |                     LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
133 |                     NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
134 |                     SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
135 |             <message key="ws.notFollowed"
136 |                      value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
137 |             <message key="ws.notPreceded"
138 |                      value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
139 |         </module>
140 |         <module name="OneStatementPerLine"/>
141 |         <module name="MultipleVariableDeclarations"/>
142 |         <module name="ArrayTypeStyle"/>
143 |         <module name="MissingSwitchDefault"/>
144 |         <module name="FallThrough"/>
145 |         <module name="UpperEll"/>
146 |         <module name="ModifierOrder"/>
147 |         <module name="EmptyLineSeparator">
148 |             <property name="tokens"
149 |                       value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
150 |                     STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
151 |                     COMPACT_CTOR_DEF"/>
152 |             <property name="allowNoEmptyLineBetweenFields" value="true"/>
153 |         </module>
154 |         <module name="SeparatorWrap">
155 |             <property name="id" value="SeparatorWrapDot"/>
156 |             <property name="tokens" value="DOT"/>
157 |             <property name="option" value="nl"/>
158 |         </module>
159 |         <module name="SeparatorWrap">
160 |             <property name="id" value="SeparatorWrapComma"/>
161 |             <property name="tokens" value="COMMA"/>
162 |             <property name="option" value="EOL"/>
163 |         </module>
164 |         <module name="SeparatorWrap">
165 |             <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
166 |             <property name="id" value="SeparatorWrapEllipsis"/>
167 |             <property name="tokens" value="ELLIPSIS"/>
168 |             <property name="option" value="EOL"/>
169 |         </module>
170 |         <module name="SeparatorWrap">
171 |             <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
172 |             <property name="id" value="SeparatorWrapArrayDeclarator"/>
173 |             <property name="tokens" value="ARRAY_DECLARATOR"/>
174 |             <property name="option" value="EOL"/>
175 |         </module>
176 |         <module name="SeparatorWrap">
177 |             <property name="id" value="SeparatorWrapMethodRef"/>
178 |             <property name="tokens" value="METHOD_REF"/>
179 |             <property name="option" value="nl"/>
180 |         </module>
181 |         <module name="PackageName">
182 |             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
183 |             <message key="name.invalidPattern"
184 |                      value="Package name ''{0}'' must match pattern ''{1}''."/>
185 |         </module>
186 |         <module name="TypeName">
187 |             <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
188 |                     ANNOTATION_DEF, RECORD_DEF"/>
189 |             <message key="name.invalidPattern"
190 |                      value="Type name ''{0}'' must match pattern ''{1}''."/>
191 |         </module>
192 |         <module name="MemberName">
193 |             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
194 |             <message key="name.invalidPattern"
195 |                      value="Member name ''{0}'' must match pattern ''{1}''."/>
196 |         </module>
197 |         <module name="ParameterName">
198 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
199 |             <message key="name.invalidPattern"
200 |                      value="Parameter name ''{0}'' must match pattern ''{1}''."/>
201 |         </module>
202 |         <module name="LambdaParameterName">
203 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
204 |             <message key="name.invalidPattern"
205 |                      value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
206 |         </module>
207 |         <module name="CatchParameterName">
208 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
209 |             <message key="name.invalidPattern"
210 |                      value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
211 |         </module>
212 |         <module name="LocalVariableName">
213 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
214 |             <message key="name.invalidPattern"
215 |                      value="Local variable name ''{0}'' must match pattern ''{1}''."/>
216 |         </module>
217 |         <module name="PatternVariableName">
218 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
219 |             <message key="name.invalidPattern"
220 |                      value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
221 |         </module>
222 |         <module name="ClassTypeParameterName">
223 |             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
224 |             <message key="name.invalidPattern"
225 |                      value="Class type name ''{0}'' must match pattern ''{1}''."/>
226 |         </module>
227 |         <module name="RecordComponentName">
228 |             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
229 |             <message key="name.invalidPattern"
230 |                      value="Record component name ''{0}'' must match pattern ''{1}''."/>
231 |         </module>
232 |         <module name="RecordTypeParameterName">
233 |             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
234 |             <message key="name.invalidPattern"
235 |                      value="Record type name ''{0}'' must match pattern ''{1}''."/>
236 |         </module>
237 |         <module name="MethodTypeParameterName">
238 |             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
239 |             <message key="name.invalidPattern"
240 |                      value="Method type name ''{0}'' must match pattern ''{1}''."/>
241 |         </module>
242 |         <module name="InterfaceTypeParameterName">
243 |             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
244 |             <message key="name.invalidPattern"
245 |                      value="Interface type name ''{0}'' must match pattern ''{1}''."/>
246 |         </module>
247 |         <module name="NoFinalizer"/>
248 |         <module name="GenericWhitespace">
249 |             <message key="ws.followed"
250 |                      value="GenericWhitespace ''{0}'' is followed by whitespace."/>
251 |             <message key="ws.preceded"
252 |                      value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
253 |             <message key="ws.illegalFollow"
254 |                      value="GenericWhitespace ''{0}'' should followed by whitespace."/>
255 |             <message key="ws.notPreceded"
256 |                      value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
257 |         </module>
258 |         <module name="Indentation">
259 |             <property name="basicOffset" value="2"/>
260 |             <property name="braceAdjustment" value="2"/>
261 |             <property name="caseIndent" value="2"/>
262 |             <property name="throwsIndent" value="4"/>
263 |             <property name="lineWrappingIndentation" value="4"/>
264 |             <property name="arrayInitIndent" value="2"/>
265 |         </module>
266 |         <module name="AbbreviationAsWordInName">
267 |             <property name="ignoreFinal" value="false"/>
268 |             <property name="allowedAbbreviationLength" value="0"/>
269 |             <property name="tokens"
270 |                       value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
271 |                     PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
272 |                     RECORD_COMPONENT_DEF"/>
273 |         </module>
274 |         <module name="NoWhitespaceBeforeCaseDefaultColon"/>
275 |         <module name="OverloadMethodsDeclarationOrder"/>
276 |         <module name="VariableDeclarationUsageDistance"/>
277 |         <module name="CustomImportOrder">
278 |             <property name="sortImportsInGroupAlphabetically" value="true"/>
279 |             <property name="separateLineBetweenGroups" value="true"/>
280 |             <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
281 |             <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
282 |         </module>
283 |         <module name="MethodParamPad">
284 |             <property name="tokens"
285 |                       value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
286 |                     SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
287 |         </module>
288 |         <module name="NoWhitespaceBefore">
289 |             <property name="tokens"
290 |                       value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
291 |                     LABELED_STAT, METHOD_REF"/>
292 |             <property name="allowLineBreaks" value="true"/>
293 |         </module>
294 |         <module name="ParenPad">
295 |             <property name="tokens"
296 |                       value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
297 |                     EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
298 |                     LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
299 |                     METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
300 |                     RECORD_DEF"/>
301 |         </module>
302 |         <module name="OperatorWrap">
303 |             <property name="option" value="NL"/>
304 |             <property name="tokens"
305 |                       value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
306 |                     LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
307 |                     TYPE_EXTENSION_AND "/>
308 |         </module>
309 |         <module name="AnnotationLocation">
310 |             <property name="id" value="AnnotationLocationMostCases"/>
311 |             <property name="tokens"
312 |                       value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
313 |                       RECORD_DEF, COMPACT_CTOR_DEF"/>
314 |         </module>
315 |         <module name="AnnotationLocation">
316 |             <property name="id" value="AnnotationLocationVariables"/>
317 |             <property name="tokens" value="VARIABLE_DEF"/>
318 |             <property name="allowSamelineMultipleAnnotations" value="true"/>
319 |         </module>
320 |         <module name="NonEmptyAtclauseDescription"/>
321 |         <module name="InvalidJavadocPosition"/>
322 |         <module name="JavadocTagContinuationIndentation"/>
323 |         <module name="SummaryJavadoc">
324 |             <property name="forbiddenSummaryFragments"
325 |                       value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
326 |         </module>
327 |         <module name="JavadocParagraph"/>
328 |         <module name="RequireEmptyLineBeforeBlockTagGroup"/>
329 |         <module name="AtclauseOrder">
330 |             <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
331 |             <property name="target"
332 |                       value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
333 |         </module>
334 |         <module name="JavadocMethod">
335 |             <property name="accessModifiers" value="public"/>
336 |             <property name="allowMissingParamTags" value="true"/>
337 |             <property name="allowMissingReturnTag" value="true"/>
338 |             <property name="allowedAnnotations" value="Override, Test"/>
339 |             <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
340 |         </module>
341 |         <module name="MissingJavadocMethod">
342 |             <property name="scope" value="public"/>
343 |             <property name="minLineCount" value="2"/>
344 |             <property name="allowedAnnotations" value="Override, Test"/>
345 |             <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
346 |                                    COMPACT_CTOR_DEF"/>
347 |         </module>
348 |         <module name="MissingJavadocType">
349 |             <property name="scope" value="protected"/>
350 |             <property name="tokens"
351 |                       value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
352 |                       RECORD_DEF, ANNOTATION_DEF"/>
353 |             <property name="excludeScope" value="nothing"/>
354 |         </module>
355 |         <module name="MethodName">
356 |             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
357 |             <message key="name.invalidPattern"
358 |                      value="Method name ''{0}'' must match pattern ''{1}''."/>
359 |         </module>
360 |         <module name="SingleLineJavadoc"/>
361 |         <module name="EmptyCatchBlock">
362 |             <property name="exceptionVariableName" value="expected"/>
363 |         </module>
364 |         <module name="CommentsIndentation">
365 |             <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
366 |         </module>
367 |         <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
368 |         <module name="SuppressionXpathFilter">
369 |             <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
370 |                       default="checkstyle-xpath-suppressions.xml"/>
371 |             <property name="optional" value="true"/>
372 |         </module>
373 |     </module>
374 | </module>


--------------------------------------------------------------------------------
/.github/sync-repo-settings.yaml:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | # .github/sync-repo-settings.yaml
16 | # See https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings for app options.
17 | rebaseMergeAllowed: true
18 | squashMergeAllowed: true
19 | mergeCommitAllowed: false
20 | deleteBranchOnMerge: true
21 | branchProtectionRules:
22 |   - pattern: main
23 |     isAdminEnforced: false
24 |     requiresStrictStatusChecks: false
25 |     requiredStatusCheckContexts:
26 |       # .github/workflows/test.yml with a job called "test"
27 |       - "test"
28 |       # .github/workflows/lint.yml with a job called "lint"
29 |       - "lint"
30 |       # Google bots below
31 |       - "cla/google"
32 |       - "snippet-bot check"
33 |       - "header-check"
34 |       - "conventionalcommits.org"
35 |     requiredApprovingReviewCount: 1
36 |     requiresCodeOwnerReviews: true
37 | permissionRules:
38 |   - team: workspace-devrel-dpe
39 |     permission: admin
40 |   - team: workspace-devrel
41 |     permission: push
42 | 


--------------------------------------------------------------------------------
/.github/workflows/automation.yml:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | ---
15 | name: Automation
16 | on: [ push, pull_request, workflow_dispatch ]
17 | jobs:
18 |   dependabot:
19 |     runs-on: ubuntu-latest
20 |     if: ${{ github.actor == 'dependabot[bot]' &&  github.event_name == 'pull_request' }}
21 |     env:
22 |       PR_URL: ${{github.event.pull_request.html_url}}
23 |       GITHUB_TOKEN: ${{secrets.GOOGLEWORKSPACE_BOT_TOKEN}}
24 |     steps:
25 |       - name: approve
26 |         run: gh pr review --approve "$PR_URL"
27 |       - name: merge
28 |         run: gh pr merge --auto --squash --delete-branch "$PR_URL"
29 |   default-branch-migration:
30 |     # this job helps with migrating the default branch to main
31 |     # it pushes main to master if master exists and main is the default branch
32 |     # it pushes master to main if master is the default branch
33 |     runs-on: ubuntu-latest
34 |     if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master' }}
35 |     steps:
36 |       - uses: actions/checkout@v2
37 |         with:
38 |           fetch-depth: 0
39 |           # required otherwise GitHub blocks infinite loops in pushes originating in an action
40 |           token: ${{ secrets.GOOGLEWORKSPACE_BOT_TOKEN }}
41 |       - name: Set env
42 |         run: |
43 |           # set DEFAULT BRANCH
44 |           echo "DEFAULT_BRANCH=$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')" >> "$GITHUB_ENV";
45 | 
46 |           # set HAS_MASTER_BRANCH
47 |           if [ -n "$(git ls-remote --heads origin master)" ]; then
48 |             echo "HAS_MASTER_BRANCH=true" >> "$GITHUB_ENV"
49 |           else
50 |             echo "HAS_MASTER_BRANCH=false" >> "$GITHUB_ENV"
51 |           fi
52 |         env:
53 |           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54 |       - name: configure git
55 |         run: |
56 |           git config --global user.name 'googleworkspace-bot'
57 |           git config --global user.email 'googleworkspace-bot@google.com'
58 |       - if: ${{ env.DEFAULT_BRANCH == 'main' && env.HAS_MASTER_BRANCH == 'true' }}
59 |         name: Update master branch from main
60 |         run: |
61 |           git checkout -B master
62 |           git reset --hard origin/main
63 |           git push origin master
64 |       - if: ${{ env.DEFAULT_BRANCH == 'master'}}
65 |         name: Update main branch from master
66 |         run: |
67 |           git checkout -B main
68 |           git reset --hard origin/master
69 |           git push origin main
70 | 


--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | name: Lint
16 | on: [push, pull_request]
17 | jobs:
18 |   lint:
19 |     runs-on: ubuntu-latest
20 |     steps:
21 |       - uses: actions/checkout@v2
22 |       - run: |
23 |           echo "No lint checks";
24 |           exit 1;
25 | 


--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
 1 | # Copyright 2022 Google LLC
 2 | #
 3 | # Licensed under the Apache License, Version 2.0 (the "License");
 4 | # you may not use this file except in compliance with the License.
 5 | # You may obtain a copy of the License at
 6 | #
 7 | #      http://www.apache.org/licenses/LICENSE-2.0
 8 | #
 9 | # Unless required by applicable law or agreed to in writing, software
10 | # distributed under the License is distributed on an "AS IS" BASIS,
11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | # See the License for the specific language governing permissions and
13 | # limitations under the License.
14 | 
15 | name: Test
16 | on: [push, pull_request]
17 | jobs:
18 |   test:
19 |     runs-on: ubuntu-latest
20 |     steps:
21 |       - uses: actions/checkout@v2
22 |       - run: |
23 |           echo "No tests";
24 |           exit 1;
25 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | We'd love to accept your patches and contributions to this project. There are
 4 | just a few small guidelines you need to follow.
 5 | 
 6 | ## Contributor License Agreement
 7 | 
 8 | Contributions to this project must be accompanied by a Contributor License
 9 | Agreement. You (or your employer) retain the copyright to your contribution;
10 | this simply gives us permission to use and redistribute your contributions as
11 | part of the project. Head over to <https://cla.developers.google.com/> to see
12 | your current agreements on file or to sign a new one.
13 | 
14 | You generally only need to submit a CLA once, so if you've already submitted one
15 | (even if it was for a different project), you probably don't need to do it
16 | again.
17 | 
18 | ## Code reviews
19 | 
20 | All submissions, including submissions by project members, require review. We
21 | use GitHub pull requests for this purpose. Consult
22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23 | information on using pull requests.


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | **Important: The content of this repository is outdated, it's now in the GitHub repository [apps-script-samples](https://github.com/googleworkspace/apps-script-samples/tree/main/solutions/attendance-chat-app).**
 2 | 
 3 | # Attendance Bot: Hangouts Chat bot with Apps Script codelab
 4 | 
 5 | This code sample shows how to build a Hangouts Chat bot using Google
 6 | Apps Script. The bot responds to messages in a room or direct message (DM) and
 7 | allows the user to set a vacation responder in Gmail or add an all-day event to
 8 | their Calendar from Hangouts Chat.
 9 | 
10 | ## Usage
11 | 
12 | You can follow [this codelab](https://codelabs.developers.google.com/codelabs/chat-apps-script/index.html)
13 | to build and test this bot.
14 | 
15 | To use this bot, you must enable the Hangouts Chat API in the
16 | [Google API Console](https://console.developers.google.com/). After enabling
17 | the API, configuring the bot, and publishing it, you must add the bot to a room
18 | or DM to begin a conversation.
19 | 
20 | For more information about how to publish a bot, see
21 | [Publishing bots](https://developers.google.com/hangouts/chat/how-tos/bots-publish).
22 | 
23 | ## Disclaimer
24 | 
25 | This is not an official product.
26 | 


--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Report a security issue
2 | 
3 | To report a security issue, please use [https://g.co/vulnz](https://g.co/vulnz). We use
4 | [https://g.co/vulnz](https://g.co/vulnz) for our intake, and do coordination and disclosure here on
5 | GitHub (including using GitHub Security Advisory). The Google Security Team will
6 | respond within 5 working days of your report on [https://g.co/vulnz](https://g.co/vulnz).
7 | 


--------------------------------------------------------------------------------
/final/Code.gs:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Responds to an ADDED_TO_SPACE event in Hangouts Chat.
  3 |  * @param {object} event the event object from Hangouts Chat
  4 |  * @return {object} JSON-formatted response
  5 |  * @see https://developers.google.com/hangouts/chat/reference/message-formats/events
  6 |  */
  7 | function onAddToSpace(event) {
  8 |   console.info(event);
  9 |   var message = 'Thank you for adding me to ';
 10 |   if (event.space.type === 'DM') {
 11 |     message += 'a DM, ' + event.user.displayName + '!';
 12 |   } else {
 13 |     message += event.space.displayName;
 14 |   }
 15 |   return { text: message };
 16 | }
 17 | 
 18 | /**
 19 |  * Responds to a REMOVED_FROM_SPACE event in Hangouts Chat.
 20 |  * @param {object} event the event object from Hangouts Chat
 21 |  * @see https://developers.google.com/hangouts/chat/reference/message-formats/events
 22 |  */
 23 | function onRemoveFromSpace(event) {
 24 |   console.info(event);
 25 |   console.log('Bot removed from ', event.space.name);
 26 | }
 27 | 
 28 | var DEFAULT_IMAGE_URL = 'https://goo.gl/bMqzYS';
 29 | var HEADER = {
 30 |   header: {
 31 |     title : 'Attendance Bot',
 32 |     subtitle : 'Log your vacation time',
 33 |     imageUrl : DEFAULT_IMAGE_URL
 34 |   }
 35 | };
 36 | 
 37 | /**
 38 |  * Creates a card-formatted response.
 39 |  * @param {object} widgets the UI components to send
 40 |  * @return {object} JSON-formatted response
 41 |  */
 42 | function createCardResponse(widgets) {
 43 |   return {
 44 |     cards: [HEADER, {
 45 |       sections: [{
 46 |         widgets: widgets
 47 |       }]
 48 |     }]
 49 |   };
 50 | }
 51 | 
 52 | var REASON = {
 53 |   SICK: 'Out sick',
 54 |   OTHER: 'Out of office'
 55 | };
 56 | /**
 57 |  * Responds to a MESSAGE event triggered in Hangouts Chat.
 58 |  * @param {object} event the event object from Hangouts Chat
 59 |  * @return {object} JSON-formatted response
 60 |  */
 61 | function onMessage(event) {
 62 |   console.info(event);
 63 |   var reason = REASON.OTHER;
 64 |   var name = event.user.displayName;
 65 |   var userMessage = event.message.text;
 66 | 
 67 |   // If the user said that they were 'sick', adjust the image in the
 68 |   // header sent in response.
 69 |   if (userMessage.indexOf('sick') > -1) {
 70 |     // Hospital material icon
 71 |     HEADER.header.imageUrl = 'https://goo.gl/mnZ37b';
 72 |     reason = REASON.SICK;
 73 |   } else if (userMessage.indexOf('vacation') > -1) {
 74 |     // Spa material icon
 75 |     HEADER.header.imageUrl = 'https://goo.gl/EbgHuc';
 76 |   }
 77 | 
 78 |   var widgets = [{
 79 |     textParagraph: {
 80 |       text: 'Hello, ' + name + '.<br/>Are you taking time off today?'
 81 |     }
 82 |   }, {
 83 |     buttons: [{
 84 |       textButton: {
 85 |         text: 'Set vacation in Gmail',
 86 |         onClick: {
 87 |           action: {
 88 |             actionMethodName: 'turnOnAutoResponder',
 89 |             parameters: [{
 90 |               key: 'reason',
 91 |               value: reason
 92 |             }]
 93 |           }
 94 |         }
 95 |       }
 96 |     }, {
 97 |       textButton: {
 98 |         text: 'Block out day in Calendar',
 99 |         onClick: {
100 |           action: {
101 |             actionMethodName: 'blockOutCalendar',
102 |             parameters: [{
103 |               key: 'reason',
104 |               value: reason
105 |             }]
106 |           }
107 |         }
108 |       }
109 |     }]
110 |   }];
111 |   return createCardResponse(widgets);
112 | }
113 | 
114 | /**
115 |  * Responds to a CARD_CLICKED event triggered in Hangouts Chat.
116 |  * @param {object} event the event object from Hangouts Chat
117 |  * @return {object} JSON-formatted response
118 |  * @see https://developers.google.com/hangouts/chat/reference/message-formats/events
119 |  */
120 | function onCardClick(event) {
121 |   console.info(event);
122 |   var message = '';
123 |   var reason = event.action.parameters[0].value;
124 |   if (event.action.actionMethodName == 'turnOnAutoResponder') {
125 |     turnOnAutoResponder(reason);
126 |     message = 'Turned on vacation settings.';
127 |   } else if (event.action.actionMethodName == 'blockOutCalendar') {
128 |     blockOutCalendar(reason);
129 |     message = 'Blocked out your calendar for the day.';
130 |   } else {
131 |     message = "I'm sorry; I'm not sure which button you clicked.";
132 |   }
133 |   return { text: message };
134 | }
135 | 
136 | var ONE_DAY_MILLIS = 24 * 60 * 60 * 1000;
137 | /**
138 |  * Turns on the user's vacation response for today in Gmail.
139 |  * @param {string} reason the reason for vacation, either REASON.SICK or REASON.OTHER
140 |  */
141 | function turnOnAutoResponder(reason) {
142 |   var currentTime = (new Date()).getTime();
143 |   Gmail.Users.Settings.updateVacation({
144 |     enableAutoReply: true,
145 |     responseSubject: reason,
146 |     responseBodyHtml: "I'm out of the office today; will be back on the next business day.<br><br><i>Created by Attendance Bot!</i>",
147 |     restrictToContacts: true,
148 |     restrictToDomain: true,
149 |     startTime: currentTime,
150 |     endTime: currentTime + ONE_DAY_MILLIS
151 |   }, 'me');
152 | }
153 | 
154 | /**
155 |  * Places an all-day meeting on the user's Calendar.
156 |  * @param {string} reason the reason for vacation, either REASON.SICK or REASON.OTHER
157 |  */
158 | function blockOutCalendar(reason) {
159 |   CalendarApp.createAllDayEvent(reason, new Date(), new Date(Date.now() + ONE_DAY_MILLIS));
160 | }
161 | 


--------------------------------------------------------------------------------
/final/appsscript.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "timeZone": "America/Los_Angeles",
 3 |   "dependencies": {
 4 |     "enabledAdvancedServices": [{
 5 |       "userSymbol": "Gmail",
 6 |       "serviceId": "gmail",
 7 |       "version": "v1"
 8 |     }]
 9 |   },
10 |   "chat": {
11 |   }
12 | }


--------------------------------------------------------------------------------
/step-3/Code.gs:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Responds to an ADDED_TO_SPACE event
 3 |  * in Hangouts Chat.
 4 |  *
 5 |  * @param event the event object from Hangouts Chat
 6 |  * @return JSON-formatted response
 7 |  */
 8 | function onAddToSpace(event) {
 9 |   console.info(event);
10 | 
11 |   var message = "";
12 | 
13 |   if (event.space.type === "DM") {
14 |     message = "Thank you for adding me to a DM, " +
15 |       event.user.displayName + "!";
16 |   } else {
17 |     message = "Thank you for adding me to " +
18 |       event.space.displayName;
19 |   }
20 | 
21 |   return { "text": message };
22 | }
23 | 
24 | /**
25 |  * Responds to a REMOVED_FROM_SPACE event
26 |  * in Hangouts Chat.
27 |  *
28 |  * @param event the event object from Hangouts Chat
29 |  */
30 | function onRemoveFromSpace(event) {
31 |   console.info(event);
32 |   console.info("Bot removed from ", event.space.name);
33 | }
34 | 


--------------------------------------------------------------------------------
/step-3/appsscript.json:
--------------------------------------------------------------------------------
1 | {
2 |   "timeZone": "America/Los_Angeles",
3 |   "dependencies": {
4 |   },
5 |   "chat": {}
6 | }


--------------------------------------------------------------------------------
/step-4/Code.gs:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Responds to an ADDED_TO_SPACE event
 3 |  * in Hangouts Chat.
 4 |  *
 5 |  * @param event the event object from Hangouts Chat
 6 |  * @return JSON-formatted response
 7 |  */
 8 | function onAddToSpace(event) {
 9 |   console.info(event);
10 | 
11 |   var message = "";
12 | 
13 |   if (event.space.type === "DM") {
14 |     message = "Thank you for adding me to a DM, " +
15 |       event.user.displayName + "!";
16 |   } else {
17 |     message = "Thank you for adding me to " +
18 |       event.space.displayName;
19 |   }
20 | 
21 |   return { "text": message };
22 | }
23 | 
24 | /**
25 |  * Responds to a REMOVED_FROM_SPACE event
26 |  * in Hangouts Chat.
27 |  *
28 |  * @param event the event object from Hangouts Chat
29 |  */
30 | function onRemoveFromSpace(event) {
31 |   console.info(event);
32 |   console.info("Bot removed from ", event.space.name);
33 | }
34 | 


--------------------------------------------------------------------------------
/step-4/appsscript.json:
--------------------------------------------------------------------------------
1 | {
2 |   "timeZone": "America/Los_Angeles",
3 |   "dependencies": {
4 |   },
5 |   "chat": {}
6 | }


--------------------------------------------------------------------------------
/step-5/Code.gs:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Responds to an ADDED_TO_SPACE event
 3 |  * in Hangouts Chat.
 4 |  *
 5 |  * @param event the event object from Hangouts Chat
 6 |  * @return JSON-formatted response
 7 |  */
 8 | function onAddToSpace(event) {
 9 |   console.info(event);
10 | 
11 |   var message = "";
12 | 
13 |   if (event.space.type === "DM") {
14 |     message = "Thank you for adding me to a DM, " +
15 |       event.user.displayName + "!";
16 |   } else {
17 |     message = "Thank you for adding me to " +
18 |       event.space.displayName;
19 |   }
20 | 
21 |   return { "text": message };
22 | }
23 | 
24 | /**
25 |  * Responds to a REMOVED_FROM_SPACE event
26 |  * in Hangouts Chat.
27 |  *
28 |  * @param event the event object from Hangouts Chat
29 |  */
30 | function onRemoveFromSpace(event) {
31 |   console.info(event);
32 |   console.info("Bot removed from ", event.space.name);
33 | }
34 | 
35 | /**
36 |  * Creates a card-formatted response.
37 |  *
38 |  * @param widgets the UI components to send
39 |  * @return JSON-formatted response
40 |  */
41 | function createCardResponse(widgets) {
42 |   return {
43 |     "cards": [
44 |       header,
45 |       {
46 |         "sections": [{
47 |           "widgets": widgets
48 |         }]
49 |     }]
50 |   };
51 | }
52 | 
53 | /**
54 |  * Responds to a MESSAGE event triggered in Hangouts Chat.
55 |  *
56 |  * @param event the event object from Hangouts Chat
57 |  * @return JSON-formatted response
58 |  */
59 | function onMessage(event) {
60 |   var userMessage = event.message.text;
61 | 
62 |   var widgets = [{
63 |     "textParagraph": {
64 |       "text": "You said: " + userMessage
65 |     }
66 |   }];
67 | 
68 |   return createCardResponse(widgets);
69 | }


--------------------------------------------------------------------------------
/step-5/appsscript.json:
--------------------------------------------------------------------------------
1 | {
2 |   "timeZone": "America/Los_Angeles",
3 |   "dependencies": {
4 |   },
5 |   "chat": {}
6 | }


--------------------------------------------------------------------------------
/step-6/Code.gs:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * Responds to an ADDED_TO_SPACE event
  3 |  *  in Hangouts Chat.
  4 |  *
  5 |  * @param event the event object from Hangouts Chat
  6 |  * @return JSON-formatted response
  7 |  */
  8 | function onAddToSpace(event) {
  9 |   console.info(event);
 10 | 
 11 |   var message = "";
 12 | 
 13 |   if (event.space.type === "DM") {
 14 |     message = "Thank you for adding me to a DM, " +
 15 |       event.user.displayName + "!";
 16 |   } else {
 17 |     message = "Thank you for adding me to " +
 18 |       event.space.displayName;
 19 |   }
 20 | 
 21 |   return { "text": message };
 22 | }
 23 | 
 24 | /**
 25 |  * Responds to a REMOVED_FROM_SPACE event
 26 |  * in Hangouts Chat.
 27 |  *
 28 |  * @param event the event object from Hangouts Chat
 29 |  */
 30 | function onRemoveFromSpace(event) {
 31 |   console.info(event);
 32 |   console.info("Bot removed from ", event.space.name);
 33 | }
 34 | 
 35 | var DEFAULT_IMAGE_URL = "https://goo.gl/bMqzYS";
 36 | var header = {
 37 |   "header": {
 38 |     "title" : "Attendance Bot",
 39 |     "subtitle" : "Log your vacation time",
 40 |     "imageUrl" : DEFAULT_IMAGE_URL
 41 |   }
 42 | };
 43 | 
 44 | /**
 45 |  * Creates a card-formatted response.
 46 |  *
 47 |  * @param widgets the UI components to send
 48 |  * @return JSON-formatted response
 49 |  */
 50 | function createCardResponse(widgets) {
 51 |   return {
 52 |     "cards": [
 53 |       header,
 54 |       {
 55 |         "sections": [{
 56 |           "widgets": widgets
 57 |         }]
 58 |       }]
 59 |   };
 60 | }
 61 | 
 62 | var REASON_SICK = "Out sick";
 63 | var REASON_OTHER = "Out of office";
 64 | 
 65 | /**
 66 |  * Responds to a MESSAGE event triggered in Hangouts Chat.
 67 |  *
 68 |  * @param event the event object from Hangouts Chat
 69 |  * @return JSON-formatted response
 70 |  */
 71 | function onMessage(event) {
 72 |   console.info(event);
 73 | 
 74 |   var reason = REASON_OTHER;
 75 |   var name = event.user.displayName;
 76 |   var userMessage = event.message.text;
 77 | 
 78 |   // If the user said that they were "sick", adjust the image in the
 79 |   // header sent in response.
 80 |   if (userMessage.indexOf("sick") > -1) {
 81 | 
 82 |     // Hospital material icon
 83 |     header.header.imageUrl = "https://goo.gl/mnZ37b";
 84 |     reason = REASON_SICK;
 85 | 
 86 |   } else if (userMessage.indexOf("vacation") > -1) {
 87 | 
 88 |     // Spa material icon
 89 |     header.header.imageUrl = "https://goo.gl/EbgHuc";
 90 |   }
 91 | 
 92 |   var widgets = [{
 93 |       "textParagraph": {
 94 |         "text": "Hello, " + name +
 95 |           ".<br/>Are you taking time off today?"
 96 |       }
 97 |     }, {
 98 |       "buttons": [{
 99 |         "textButton": {
100 |           "text": "Set vacation in Gmail",
101 |           "onClick": {
102 |             "action": {
103 |               "actionMethodName": "turnOnAutoResponder",
104 |               "parameters": [{
105 |                 "key": "reason",
106 |                 "value": reason
107 |               }]
108 |             }
109 |           }
110 |         }
111 |       }, {
112 |         "textButton": {
113 |           "text": "Block out day in Calendar",
114 |           "onClick": {
115 |             "action": {
116 |               "actionMethodName": "blockOutCalendar",
117 |                 "parameters": [{
118 |                   "key": "reason",
119 |                   "value": reason
120 |                 }]
121 |             }
122 |           }
123 |         }
124 |       }]
125 |   }];
126 | 
127 |   return createCardResponse(widgets);
128 | }
129 | 
130 | /**
131 |  * Responds to a CARD_CLICKED event triggered in Hangouts Chat.
132 |  *
133 |  * @param event the event object from Hangouts Chat
134 |  * @return JSON-formatted response
135 |  */
136 | function onCardClick(event) {
137 |   console.info(event);
138 | 
139 |   var message = "";
140 |   var reason = event.action.parameters[0].value;
141 | 
142 |   if (event.action.actionMethodName == "turnOnAutoResponder") {
143 |     turnOnAutoResponder(reason);
144 |     message = "Turned on vacation settings.";
145 |   } else if (event.action.actionMethodName == "blockOutCalendar") {
146 |     blockOutCalendar(reason);
147 |     message = "Blocked out your calendar for the day.";
148 |   } else {
149 |     message = "I'm sorry; I'm not sure which button you clicked.";
150 |   }
151 | 
152 |   return { "text": message };
153 | }
154 | 
155 | var ONE_DAY_MILLIS = 24 * 60 * 60 * 1000;
156 | 
157 | /**
158 |  * Turns on the user's vacation response for today in Gmail.
159 |  *
160 |  * @param reason the reason for vacation, either REASON_SICK or REASON_OTHER
161 |  */
162 | function turnOnAutoResponder(reason) {
163 |   var currentTime = (new Date()).getTime();
164 | 
165 |   Gmail.Users.Settings.updateVacation({
166 |     "enableAutoReply": true,
167 |     "responseSubject": reason,
168 |     "responseBodyHtml": "I'm out of the office today; will be back on the next business day.<br><br><i>Created by Attendance Bot!</i>",
169 |     "restrictToContacts": true,
170 |     "restrictToDomain": true,
171 |     "startTime": currentTime,
172 |     "endTime": currentTime + ONE_DAY_MILLIS
173 |   }, "me");
174 | }
175 | 
176 | /**
177 |  * Places an all-day meeting on the user's Calendar.
178 |  *
179 |  * @param reason the reason for vacation, either REASON_SICK or REASON_OTHER
180 |  */
181 | function blockOutCalendar(reason) {
182 |   CalendarApp.createAllDayEvent(reason, new Date(), new Date(Date.now() + ONE_DAY_MILLIS));
183 | }
184 | 


--------------------------------------------------------------------------------
/step-6/appsscript.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "timeZone": "America/Los_Angeles",
 3 |   "dependencies": {
 4 |     "enabledAdvancedServices": [{
 5 |       "userSymbol": "Gmail",
 6 |       "serviceId": "gmail",
 7 |       "version": "v1"
 8 |     }]
 9 |   },
10 |   "chat": {
11 |   }
12 | }


--------------------------------------------------------------------------------