Skip to content

Commit a44a6ff

Browse files
tanaikechtanaikech
committed
1st commit
0 parents  commit a44a6ff

20 files changed

+4343
-0
lines changed

‎LICENCE

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2017 Kanshi TANAIKE
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
6+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7+
8+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+1,453
Large diffs are not rendered by default.

‎doc.go

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/*
2+
Package main (doc.go) :
3+
This is a CLI tool to execute Google Apps Script (GAS) on a terminal.
4+
5+
Will you want to develop GAS on your local PC? Generally, when we develop GAS, we have to login to Google using own browser and develop it on the Script Editor. Recently, I have wanted to have more convenient local-environment for developing GAS. So I created this "ggsrun". The main work is to execute GAS on local terminal and retrieve the results from Google.
6+
7+
# Features of "ggsrun" are as follows.
8+
9+
1. Develops GAS using your terminal and text editor which got accustomed to using.
10+
11+
2. Executes GAS by giving values to your script.
12+
13+
3. Executes GAS made of CoffeeScript.
14+
15+
4. Downloads spreadsheet, document and presentation, while executes GAS, simultaneously.
16+
17+
5. Creates, updates and backs up project with GAS.
18+
19+
6. Downloads files from Google Drive and Uploads files to Google Drive.
20+
21+
You can see the release page https://github.com/tanaikech/ggsrun/releases
22+
23+
# Google API
24+
25+
ggsrun uses Execution API, Web Apps and Drive API on Google. About how to install ggsrun, please check my github repository.
26+
27+
https://github.com/tanaikech/ggsrun/
28+
29+
You can read the detail information there.
30+
31+
32+
---------------------------------------------------------------
33+
34+
# How to Execute Google Apps Script Using ggsrun
35+
When you have the configure file `ggsrun.cfg`, you can execute GAS. If you cannot find it, please download `client_secret.json` and run
36+
37+
$ ggsrun auth
38+
39+
In the case of using Execution API,
40+
41+
$ ggsrun e1 -s sample.gs
42+
43+
If you want to execute a function except for `main()` of default, you can use an option like `-f foo`. This command `exe1` can be used to execute a function on project.
44+
45+
$ ggsrun e1 -f foo
46+
47+
$ ggsrun e2 -s sample.gs
48+
49+
At `e2`, you cannot select the executing function except for `main()` of default.
50+
51+
`e1`, `e2` and `-s` mean using Execution API and GAS script file name, respectively. Sample codes which are shown here will be used Execution API. At this time, the executing function is `main()`, which is a default, in the script.
52+
53+
In the case of using Web Apps,
54+
55+
$ ggsrun w -s sample.gs -p password -u [ WebApps URL ]
56+
57+
`w` and `-p` mean using Web Apps and password you set at the server side, respectively. Using `-u` it imports Web Apps URL like `-u https://script.google.com/macros/s/#####/exec`.
58+
59+
60+
---------------------------------------------------------------
61+
*/
62+
package main

‎ggsrun.go

+246
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
// Package main (ggsrun.go) :
2+
// This file is included all commands and options.
3+
package main
4+
5+
import (
6+
"os"
7+
8+
"github.com/urfave/cli"
9+
)
10+
11+
// main : main function
12+
func main() {
13+
app := cli.NewApp()
14+
app.Name = appname
15+
app.Author = "tanaike [ https://github.com/tanaikech/ggsrun ] "
16+
app.Email = "tanaike@hotmail.com"
17+
app.Usage = "Executes Google Apps Script (GAS) on Google and Feeds Back Results."
18+
app.Version = "1.0.0"
19+
app.Commands = []cli.Command{
20+
{
21+
Name: "exe1",
22+
Aliases: []string{"e1"},
23+
Usage: "Updates project and Executes the function in the project.",
24+
Description: "In this mode, an access token is required.",
25+
Action: exeAPIWithout,
26+
Flags: []cli.Flag{
27+
cli.StringFlag{
28+
Name: "scriptid, i",
29+
Usage: "Script ID of project on Google Drive",
30+
},
31+
cli.StringFlag{
32+
Name: "scriptfile, s",
33+
Usage: "GAS file (.gs, .gas, .js, .coffee) on local PC",
34+
},
35+
cli.StringFlag{
36+
Name: "function, f",
37+
Usage: "Function name which is executed. Default is '" + deffuncwithout + "'.",
38+
},
39+
cli.StringFlag{
40+
Name: "value, v",
41+
Usage: "Give a value to the function which is executed.",
42+
},
43+
cli.BoolFlag{
44+
Name: "backup, b",
45+
Usage: "Backup project with script ID you set as a file.",
46+
},
47+
cli.BoolFlag{
48+
Name: "onlyresult, r",
49+
Usage: "Display only 'result' in JSON results",
50+
},
51+
cli.BoolFlag{
52+
Name: "jsonparser, j",
53+
Usage: "Display results by JSON parser",
54+
},
55+
},
56+
},
57+
{
58+
Name: "exe2",
59+
Aliases: []string{"e2"},
60+
Usage: "Uploads GAS and Executes the script using Execution API.",
61+
Description: "In this mode, an access token is required.",
62+
Action: exeAPIWith,
63+
Flags: []cli.Flag{
64+
cli.StringFlag{
65+
Name: "scriptid, i",
66+
Usage: "Script ID of project on Google Drive",
67+
},
68+
cli.StringFlag{
69+
Name: "scriptfile, s",
70+
Usage: "GAS file (.gs, .gas, .js, .coffee) on local PC",
71+
},
72+
cli.StringFlag{
73+
Name: "function, f",
74+
Usage: "Function name of server for executing GAS. Default is '" + deffuncserv + "'. If you change the server, use this.",
75+
},
76+
cli.StringFlag{
77+
Name: "value, v",
78+
Usage: "Give a value to the function of GAS script which is executed.",
79+
},
80+
cli.StringFlag{
81+
Name: "stringscript, ss",
82+
Usage: "GAS script as strings.",
83+
},
84+
cli.BoolFlag{
85+
Name: "foldertree, t",
86+
Usage: "Display a folder tree on Google Drive as an array.",
87+
},
88+
cli.BoolFlag{
89+
Name: "convert, conv",
90+
Usage: "[Experiment] Download file using byte slice data. Use with '-v [File ID]'.",
91+
},
92+
cli.BoolFlag{
93+
Name: "log, l",
94+
Usage: "Record access log.",
95+
},
96+
cli.BoolFlag{
97+
Name: "onlyresult, r",
98+
Usage: "Display only 'result' in JSON results",
99+
},
100+
cli.BoolFlag{
101+
Name: "jsonparser, j",
102+
Usage: "Display results by JSON parser",
103+
},
104+
},
105+
},
106+
{
107+
Name: "webapps",
108+
Aliases: []string{"w"},
109+
Usage: "Uploads GAS and Executes the script without OAuth using Web Apps.",
110+
Description: "In this mode, an access token is NOT required.",
111+
Action: webAppsWith,
112+
Flags: []cli.Flag{
113+
cli.StringFlag{
114+
Name: "url, u",
115+
Usage: "URL for using Web Apps.",
116+
},
117+
cli.StringFlag{
118+
Name: "scriptfile, s",
119+
Usage: "GAS file (.gs, .gas, .js, .coffee) on local PC",
120+
},
121+
cli.StringFlag{
122+
Name: "value, v",
123+
Usage: "Give a value to the function of GAS script which is executed.",
124+
},
125+
cli.StringFlag{
126+
Name: "password, p",
127+
Usage: "Password to use Web Apps (if you have set)",
128+
},
129+
cli.BoolFlag{
130+
Name: "log, l",
131+
Usage: "Not record access log. No this option means 'Record log'.",
132+
},
133+
cli.BoolFlag{
134+
Name: "onlyresult, r",
135+
Usage: "Display only 'result' in JSON results",
136+
},
137+
cli.BoolFlag{
138+
Name: "jsonparser, j",
139+
Usage: "Display results by JSON parser",
140+
},
141+
},
142+
},
143+
{
144+
Name: "download",
145+
Aliases: []string{"d"},
146+
Usage: "Downloads files from Google Drive.",
147+
Description: "In this mode, an access token is required.",
148+
Action: downloadFiles,
149+
Flags: []cli.Flag{
150+
cli.StringFlag{
151+
Name: "fileid, i",
152+
Usage: "File ID on Google Drive",
153+
},
154+
cli.StringFlag{
155+
Name: "filename, f",
156+
Usage: "File Name on Google Drive",
157+
},
158+
cli.StringFlag{
159+
Name: "extension, e",
160+
Usage: "Extension (File format of downloaded file)",
161+
},
162+
cli.BoolFlag{
163+
Name: "rawdata, r",
164+
Usage: "Save a project with GAS scripts as raw data (JSON data).",
165+
},
166+
cli.BoolFlag{
167+
Name: "jsonparser, j",
168+
Usage: "Display results by JSON parser",
169+
},
170+
},
171+
},
172+
{
173+
Name: "upload",
174+
Aliases: []string{"u"},
175+
Usage: "Uploads files to Google Drive.",
176+
Description: "In this mode, an access token is required.",
177+
Action: uploadFiles,
178+
Flags: []cli.Flag{
179+
cli.StringFlag{
180+
Name: "filename, f",
181+
Usage: "File Name on local PC",
182+
},
183+
cli.StringFlag{
184+
Name: "parentfolderid, p",
185+
Usage: "Folder ID of parent folder on Google Drive",
186+
},
187+
cli.StringFlag{
188+
Name: "projectname, pn",
189+
Usage: "Upload several GAS scripts as a project.",
190+
},
191+
cli.BoolFlag{
192+
Name: "noconvert, nc",
193+
Usage: "If you don't want to convert file to Google Apps format.",
194+
},
195+
cli.BoolFlag{
196+
Name: "jsonparser, j",
197+
Usage: "Display results by JSON parser",
198+
},
199+
},
200+
},
201+
{
202+
Name: "filelist",
203+
Aliases: []string{"ls"},
204+
Usage: "Outputs a file list on Google Drive.",
205+
Description: "In this mode, an access token is required.",
206+
Action: showFileList,
207+
Flags: []cli.Flag{
208+
cli.StringFlag{
209+
Name: "searchbyname, sn",
210+
Usage: "Search file using File Name. Output File ID.",
211+
},
212+
cli.StringFlag{
213+
Name: "searchbyid, si",
214+
Usage: "Search file using File ID. Output File Name.",
215+
},
216+
cli.BoolFlag{
217+
Name: "stdout, s",
218+
Usage: "Output all file list to standard output.",
219+
},
220+
cli.BoolFlag{
221+
Name: "file, f",
222+
Usage: "Output all file list to a JSON file.",
223+
},
224+
cli.BoolFlag{
225+
Name: "jsonparser, j",
226+
Usage: "Display results by JSON parser",
227+
},
228+
},
229+
},
230+
{
231+
Name: "auth",
232+
Usage: "Retrieve access and refresh tokens. If you changed scopes, please use this.",
233+
Description: "In this mode, 'client_secret.json' and Scopes are required.",
234+
Action: reAuth,
235+
Flags: []cli.Flag{
236+
cli.IntFlag{
237+
Name: "port, p",
238+
Usage: "Port number of temporal web server for retrieving authorization code.",
239+
Value: 8080,
240+
},
241+
},
242+
},
243+
}
244+
app.CommandNotFound = commandNotFound
245+
app.Run(os.Args)
246+
}

0 commit comments

Comments
 (0)