/
gsheets.go
229 lines (186 loc) · 6.05 KB
/
gsheets.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// Copyright (c) 2020, Adam Vakil-Kirchberger
// Licensed under the MIT license
package gsheets
import (
"context"
"errors"
"fmt"
"io/ioutil"
"strings"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
"google.golang.org/api/sheets/v4"
)
// SheetRows is for unpacking multiple rows from Gsheets based on a slice of maps
type SheetRows []map[string]interface{}
// SheetRow is for unpacking single rows from Gsheets based on a slice of maps
type SheetRow map[string]interface{}
// NewService is used to generate a Google Spreadsheets API service
func NewService(keyPath string) (*sheets.Service, error) {
b, err := ioutil.ReadFile(keyPath)
if err != nil {
return nil, fmt.Errorf("Unable to read key file: %v", err)
}
config, err := google.JWTConfigFromJSON(b, "https://www.googleapis.com/auth/spreadsheets")
if err != nil {
return nil, fmt.Errorf("Unable to parse key file to config: %v", err)
}
client := config.Client(oauth2.NoContext)
svc, err := sheets.New(client)
if err != nil {
return nil, fmt.Errorf("Unable to retrieve Sheets client: %v", err)
}
return svc, nil
}
// MapFromSheet is used to pull all records from a Gsheet and return SheetRows
func MapFromSheet(svc *sheets.Service, sheetID, worksheet string) (*SheetRows, error) {
resp, err := svc.Spreadsheets.Values.Get(sheetID, worksheet).Do()
if err != nil {
return nil, fmt.Errorf("Unable to retrieve data from sheet: %v", err)
}
data := make(SheetRows, 0)
if len(resp.Values) == 0 {
return nil, errors.New("No data found.")
}
for rowNum, row := range resp.Values[1:] {
n := make(SheetRow, 0)
n["ID"] = rowNum
for idx, col := range resp.Values[0] {
colLower := strings.ToLower(col.(string))
if idx < len(row) {
n[colLower] = row[idx]
}
}
data = append(data, n)
}
return &data, nil
}
// GetHeadersFromSheet will return the current headers present in a sheet
func GetHeadersFromSheet(svc *sheets.Service, sheetID, worksheet string) ([]string, error) {
resp, err := svc.Spreadsheets.Values.Get(sheetID, worksheet+"!1:1").Do()
if err != nil {
return nil, fmt.Errorf("Unable to retrieve data from sheet: %v", err)
}
data := make([]string, 0)
if len(resp.Values) == 0 {
return nil, errors.New("No data found.")
}
for _, col := range resp.Values[0] {
data = append(data, col.(string))
}
return data, nil
}
// GetWorksheetID will get the gid= value from a worksheet
func GetWorksheetID(svc *sheets.Service, sheetID, worksheet string) (int64, error) {
gid, err := svc.Spreadsheets.Get(sheetID).Ranges(worksheet).Do()
if err != nil {
return -1, err
}
return gid.Sheets[0].Properties.SheetId, nil
}
// GetWorksheetTotalRows will return the total rows worksheet
func GetWorksheetTotalRows(svc *sheets.Service, sheetID, worksheet string) (int64, error) {
gid, err := svc.Spreadsheets.Get(sheetID).Ranges(worksheet).Do()
if err != nil {
return -1, err
}
return gid.Sheets[0].Properties.GridProperties.RowCount, nil
}
// MakeWorksheet will check if a worksheet exists or make one
func MakeWorksheet(svc *sheets.Service, sheetID, worksheet string) error {
req := sheets.Request{
AddSheet: &sheets.AddSheetRequest{
Properties: &sheets.SheetProperties{
Title: worksheet,
GridProperties: &sheets.GridProperties{
RowCount: 2,
ColumnCount: 1,
},
},
},
}
br := &sheets.BatchUpdateSpreadsheetRequest{
Requests: []*sheets.Request{&req},
}
_, err := svc.Spreadsheets.BatchUpdate(sheetID, br).Context(context.Background()).Do()
if err != nil {
return err
}
return nil
}
// SetHeaders will set the supplied headers as the first row in sheet
func SetHeaders(svc *sheets.Service, sheetID, worksheet string, headers []string) error {
valRange := &sheets.ValueRange{}
valRange.MajorDimension = "COLUMNS"
if headers[0] != "TIMESTAMP" {
headers = append([]string{"TIMESTAMP"}, headers...)
}
for _, col := range headers {
valRange.Values = append(valRange.Values, []interface{}{col})
}
_, err := svc.Spreadsheets.Values.Update(sheetID, worksheet+"!A1", valRange).ValueInputOption("RAW").Do()
if err != nil {
return err
}
return nil
}
// AddLatestRow will add a row just after the header displaying the latest results
func AddLatestRow(svc *sheets.Service, sheetID, worksheet string) error {
valRange := &sheets.ValueRange{}
valRange.MajorDimension = "COLUMNS"
curr, _ := GetHeadersFromSheet(svc, sheetID, worksheet)
latestRow := make([]string, 0)
for idx, _ := range curr {
latestRow = append(latestRow, fmt.Sprintf("=index(OFFSET(A:A,0,%d),max(row(OFFSET(A3:A,0,%d))*(OFFSET(A3:A,0,%d)<>\"\")))", idx, idx, idx))
}
for _, col := range latestRow {
valRange.Values = append(valRange.Values, []interface{}{col})
}
_, err := svc.Spreadsheets.Values.Update(sheetID, worksheet+"!A2", valRange).ValueInputOption("USER_ENTERED").Do()
if err != nil {
return err
}
return nil
}
// AddRow will add a slice of strings as a new row
func AddRow(svc *sheets.Service, sheetID, worksheet string, row []interface{}) error {
valRange := &sheets.ValueRange{}
valRange.MajorDimension = "COLUMNS"
for _, cell := range row {
valRange.Values = append(valRange.Values, []interface{}{cell})
}
_, err := svc.Spreadsheets.Values.Append(sheetID, worksheet, valRange).ValueInputOption("USER_ENTERED").Do()
if err != nil {
return err
}
return nil
}
// DeleteLastRows will delete the oldest X rows based on count value
func DeleteLastRows(svc *sheets.Service, sheetID string, worksheetID int64, count int64) error {
req := sheets.Request{
// DeleteRange: &sheets.DeleteRangeRequest{
// Range: &sheets.GridRange{
// SheetId: worksheetID,
// StartRowIndex: 2,
// EndRowIndex: 2 + count,
// },
// ShiftDimension: "ROWS",
// },
DeleteDimension: &sheets.DeleteDimensionRequest{
Range: &sheets.DimensionRange{
SheetId: worksheetID,
StartIndex: 2,
EndIndex: 2 + count,
Dimension: "ROWS",
},
},
}
br := &sheets.BatchUpdateSpreadsheetRequest{
Requests: []*sheets.Request{&req},
}
_, err := svc.Spreadsheets.BatchUpdate(sheetID, br).Context(context.Background()).Do()
if err != nil {
return err
}
return nil
}