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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464import httplib2
from oauth2client import client
from oauth2client import file
from oauth2client.client import flow_from_clientsecrets
from oauth2client.file import Storage
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
import base64
from datetime import datetime
from datetime import timedelta
from apiclient.discovery import build
from apiclient.http import MediaIoBaseUpload
import io
import csv
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaFileUpload
import sys
import json
from pathlib import Path
class bjfGoogle:
def __init__(self, api_key=None):
self.api_key=api_key
# client seret file is the file you can download from the Credentials screen in Developer Console
# credential_storage is a file, created if nexist
# scopes are ['',''] array
def Authenticate(self, client_secret_file, credential_store, scopeRequired):
# FIRST - the client_secret_file HAs to exist!
if not Path(client_secret_file).is_file():
print(client_secret_file)
print("client secret file must exist! Download from Google Developer Console")
return False;
# https://developers.google.com/api-client-library/python/guide/aaa_oauth
authStorage=Storage(credential_store)
self.cachedAuthorisation=authStorage.get()
if self.cachedAuthorisation is None or self.cachedAuthorisation.invalid or not self.cachedAuthorisation.has_scopes(scopeRequired):
flow = client.flow_from_clientsecrets(client_secret_file,
scopeRequired,
redirect_uri='urn:ietf:wg:oauth:2.0:oob')
auth_uri = flow.step1_get_authorize_url()
print ("Please visit the following URL and authenticate:")
print
print (self.ShortenUrl(auth_uri))
print
auth_code = input('Enter the auth code: ')
self.cachedAuthorisation = flow.step2_exchange(auth_code)
#if (self.cachedAuthorisation.token_expiry - datetime.utcnow()) < timedelta(minutes=5):
# http = self.cachedAuthorisation.authorize(httplib2.Http())
# self.cachedAuthorisation.refresh(http)
# create an authorised http
http=httplib2.Http()
self.HTTPauthed=self.cachedAuthorisation.authorize(http)
authStorage.put(self.cachedAuthorisation)
return True;
def AuthorisedHTTP(self):
#http=httplib2.Http()
#http = self.cachedAuthorisation.authorize(http)
# if we haven't expired, return the http, otherwise, refresh it
if (self.cachedAuthorisation.token_expiry - datetime.utcnow()) < timedelta(minutes=5):
self.HTTPauthed = self.cachedAuthorisation.authorize(httplib2.Http())
self.cachedAuthorisation.refresh(self.HTTPauthed)
return self.HTTPauthed
# scope='https://www.googleapis.com/auth/photos https://www.googleapis.com/auth/userinfo.profile',
def GetPhotoService(self,access_token):
user_agent='bjfapp'
gd_client = gdata.photos.service.PhotosService(source=user_agent,
email="default",
additional_headers={'Authorization' : 'Bearer %s' % access_token})
return gd_client
# sheets - RO - "https://www.googleapis.com/auth/spreadsheets.readonly"
# sheets - RW - https://www.googleapis.com/auth/spreadsheets
def GetSheetsService(self):
discoveryUrl = ('https://sheets.googleapis.com/$discovery/rest?'
'version=v4')
service=build('sheets', 'v4', http=self.AuthorisedHTTP(),discoveryServiceUrl=discoveryUrl)
return service
# ='https://www.googleapis.com/auth/fusiontables'
# https://developers.google.com/api-client-library/python/guide/aaa_oauth
def GetFusionService(self):
service=build("fusiontables","v2",http=self.AuthorisedHTTP())
return service
# service deprecated by Google
def ShortenUrl(self, longUrl):
# quick check
if self.api_key is None:
return longUrl
try:
service=build('urlshortener', 'v1', developerKey=self.api_key)
url=service.url()
body={'longUrl':longUrl}
resp=url.insert(body=body).execute()
return resp['id']
except HttpError:
return longUrl
except:
print ("Exception occurred ",sys.exc_info()[0])
return longUrl
# https://www.googleapis.com/auth/drive.metadata.readonly
# https://www.googleapis.com/auth/drive
# https://www.googleapis.com/auth/drive.file
# remember to enable the Drive API in DevConsole
class bjfDriveService:
def __init__(self, bjfGoogleInstance):
self.bjfGinstance=bjfGoogleInstance
self.service=build('drive', 'v3',http=self.bjfGinstance.AuthorisedHTTP())
def ListAllFiles(self):
results=self.service.files().list(fields="nextPageToken, files(id, name, mimeType)").execute()
items = results.get('files', [])
return items
def ListAllFolders(self):
results=self.service.files().list(q="mimeType='application/vnd.google-apps.folder'", fields="nextPageToken, files(id, name)").execute()
items = results.get('files', [])
return items
def ListAllFilesInFolder(self, folderId):
results=self.service.files().list(q="{} in parents".format(folderId), fields="nextPageToken, files(id, name)").execute()
items = results.get('files', [])
return items
def AddFile(self, sourceFileOnDisk, destFileName, mimeType, destinationFolderId=None):
metaData={'name':destFileName}
if destinationFolderId is not None:
metaData['parents']=[destinationFolderId]
upload=MediaFileUpload(sourceFileOnDisk,mimeType)
fileInfo=self.service.files().create(body=metaData, media_body=upload,fields="id").execute()
fileInfo['name']=destFileName
return fileInfo
def AddJPG(self, sourceFileOnDisk, destFileName, mimeType, destinationFolderId):
return AddFile(self, sourceFileOnDisk, destFileName, "image/jpeg", destinationFolderId)
def AddBinary(self, sourceFileOnDisk, destFileName, mimeType, destinationFolderId):
return AddFile(self, sourceFileOnDisk, destFileName, "application/octet-stream", destinationFolderId)
class bjfTeamDriveService(bjfDriveService):
def __init__(self, bjfGoogleInstance):
bjfDriveService.__init__(self, bjfGoogleInstance)
def ListAllTeamDrives(self):
results=self.service.drives().list().execute()
items=results.get('drives', [])
return items
def ListAllFilesInFolder(self, folderId):
results=self.service.files().list(q="{} in parents".format(folderId), fields="nextPageToken, files(id, name)", includeItemsFromAllDrives=True, supportsAllDrives=True).execute()
items = results.get('files', [])
return items
class bjfSheetsService:
class bjfSheetHandler:
def __init__(self, sheetProps):
self.sheetProps=sheetProps
def resolveRangeName(self, a1Notation):
return self.Title()+"!"+a1Notation
def FullRange(self):
grid=self.sheetProps["gridProperties"]
full="R1C1:R{}C{}".format(self.NumRows(),self.NumCols())
return self.resolveRangeName(full)
def NumRows(self):
grid=self.sheetProps["gridProperties"]
return grid["rowCount"]
def NumCols(self):
grid=self.sheetProps["gridProperties"]
return grid["columnCount"]
def RangeR1C1(self, tl=[1,1],br=[1,1]):
r1c1="R{}C{}:R{}C{}".format(tl[0],tl[1],br[0],br[1]);
return self.resolveRangeName(r1c1)
def Title(self):
return self.sheetProps["title"]
def Id(self):
return self.sheetProps["sheetId"]
def __init__(self, bjfGoogleInstance):
self.bjfGinstance=bjfGoogleInstance
self.service=build('sheets', 'v4',http=self.bjfGinstance.AuthorisedHTTP())
def AppendSheetRange(self,ssid, rowValues, rangeName, valInputOption="USER_ENTERED", insertOption="OVERWRITE"):
body={ 'values':rowValues }
result=self.service.spreadsheets().values().append(spreadsheetId=ssid, range=rangeName, body=body, valueInputOption=valInputOption,insertDataOption=insertOption).execute()
return result
def UpdateSheetRange(self, ssid, rowValues, rangeName, valInputOption="USER_ENTERED"):
body={ 'values':rowValues }
self.service.spreadsheets().values().update(spreadsheetId=ssid, range=rangeName, body=body, valueInputOption=valInputOption).execute()
def ClearSheet(self, ssid, bjfSheetHandler):
result=self.service.spreadsheets().values().clear( spreadsheetId=ssid, range= bjfSheetHandler.FullRange() ).execute()
def CreateSpreadSheet(self, titleOfSheet):
spreadsheet_body = {
"properties": {
"title": titleOfSheet
}
}
result=self.service.spreadsheets().create(body=spreadsheet_body).execute()
# now we only have one sheet
return result['spreadsheetId']
def GetSheetRanges(self, ssid):
# list all sheets in the spreadsheet
ret=self._GetSpreadSheetMeta(ssid)
if ret is not None:
bjfSheets=[]
for sheet in ret['sheets']:
bjfSheets.append(self.bjfSheetHandler(sheet["properties"]))
return bjfSheets
return None
def GetSpreadSheetTitle(self, ssid):
result=self._GetSpreadSheetMeta(ssid)
if result is not None:
return result['properties']['title']
return None
def GetSpreadSheetURL(self, ssid):
result=self._GetSpreadSheetMeta(ssid)
if result is not None:
return result['spreadsheetUrl']
return None
def _GetSpreadSheetMeta(self, ssid):
# ostensibly an exists check
ret=None
try:
ret=self.service.spreadsheets().get(spreadsheetId=ssid).execute()
except Exception:
return None
return ret
# add one, optionally, if it exists, return it
def AddSheetToSpreadSheet(self, ssid, sheetname, failIfExists=False):
# see if it's there
currentSheets=self.GetSheetRanges(ssid)
#print "Found {} sheets".format(len(currentSheets))
for sheet in currentSheets:
#print sheet.Title()
if sheet.Title()==sheetname:
if failIfExists:
return None
else:
return sheet
# doesnt exist - create it
newSheetMeta={ "requests": [ { "addSheet":{ "properties": { "title":sheetname } } } ] }
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=newSheetMeta).execute()
return self.bjfSheetHandler(result["replies"][0]["addSheet"]["properties"])
def FreezeView(self, ssid, sheetRange, numberOfRows):
freezeMeta={ "requests":[ { "updateSheetProperties": { "properties": { "sheetId": sheetRange.Id(), "gridProperties": { "frozenRowCount":numberOfRows } }, "fields":"gridProperties.frozenRowCount" } } ] }
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=freezeMeta).execute()
def CreateTitleRow(self, ssid, sheetRange, freezeRows=1, textColour={"red":1.0,"green":1.0,"blue":1.0}, backColour={"red":0.0,"green":0.0,"blue":0.0}):
titleMeta={ "requests":[ {"repeatCell": {"range": {"sheetId": sheetRange.Id(),"startRowIndex": 0,"endRowIndex": 1},"cell": {"userEnteredFormat": {"backgroundColor": backColour,"horizontalAlignment" : "CENTER","textFormat": {"foregroundColor": textColour,"fontSize": 12,"bold": True}}},"fields": "userEnteredFormat(backgroundColor,textFormat,horizontalAlignment)"}}, { "updateSheetProperties": { "properties": { "sheetId": sheetRange.Id(), "gridProperties": { "frozenRowCount":freezeRows } }, "fields":"gridProperties.frozenRowCount" } } ] }
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=titleMeta).execute()
def ImportData(self, ssid, sheetRange, file, delim=","):
lines=0
with open(file,"r") as f:
lineData=f.readline()
importMeta={ "requests":[ ]}
while lineData:
importMeta["requests"].append({ "pasteData": { "coordinate": { "sheetId":sheetRange.Id(), "rowIndex":lines, "columnIndex":0 }, "data": lineData, "type": "PASTE_NORMAL", "delimiter":delim } })
lineData=f.readline()
lines+=1
f.close()
# sheets have a default size of 1000 rows, so if we exceed that, add more
if lines>2:
print "Adding more rows"
addRowsMeta={"requests":[ ]}
addRowsMeta["requests"].append({"insertDimension":{"range":{ "sheetId":sheetRange.Id(),"dimension": "ROWS", "startIndex":0, "endIndex":lines},"inheritFromBefore":False}})
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=addRowsMeta).execute()
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=importMeta).execute()
return lines
def _AddChart(self, ssid, theTitle, chartType, chartSpec):
chartSpec={ "title": theTitle, chartType:chartSpec }
chartMeta={ "spec": chartSpec, "position": { "newSheet": True } }
request={ "requests":[ {"addChart": { "chart": chartMeta } } ] }
result=self.service.spreadsheets().batchUpdate(spreadsheetId=ssid, body=request).execute()
def AddBasicChart(self, ssid, theTitle, sheet):
domainSource={ "sourceRange":{ "sources":[ { "sheetId": sheet.Id(), "startRowIndex":0, "endRowIndex":10, "startColumnIndex": 0, "endColumnIndex": 1 } ] } }
series1={ "sheetId": sheet.Id(), "startRowIndex":0, "endRowIndex":10, "startColumnIndex": 8, "endColumnIndex": 9 }
series2={ "sheetId": sheet.Id(), "startRowIndex":0, "endRowIndex":10, "startColumnIndex": 9, "endColumnIndex": 10 }
s1range={ "sourceRange":{ "sources":[ series1 ] } }
s2range={ "sourceRange":{ "sources":[ series2 ] } }
seriesSource={ "sourceRange":{ "sources":[ series1 ] } }
chartSpec={ "chartType": "COLUMN", "domains": [ { "domain": domainSource } ], "series":[ { "series": s1range }, { "series": s2range } ] }
return self._AddChart(ssid, theTitle, "basicChart", chartSpec)
# ??
# https://www.googleapis.com/auth/gmail.readonly
# https://www.googleapis.com/auth/gmail
# to send emails
# https://www.googleapis.com/auth/gmail.compose
class bjfGmailService:
def __init__(self, bjfGoogleInstance):
self.bjfGinstance=bjfGoogleInstance
self.service=build("gmail","v1",http=self.bjfGinstance.AuthorisedHTTP())
def send(self, recipient, subject, message_text,message_text_html=None):
try:
message = self.buildMessageMime(recipient, subject, message_text, message_text_html)
messageDetails=self.service.users().messages().send(userId='me', body=message).execute()
print ('Message Id: %s' % messageDetails['id'])
return messageDetails
except HttpError as error:
print ('An error occurred: %s') % error
def buildMessageMime(self, recipient, subject, message_text, message_text_html=None):
try:
if message_text_html is None:
message = MIMEText(message_text)
else:
message=MIMEMultipart('alternative')
message.attach(MIMEText(message_text, 'plain'))
message.attach(MIMEText(message_text_html, 'html'))
message['to'] = recipient
message['from'] = "bf@g.com"
message['subject'] = subject
# py2
# return {'raw': base64.urlsafe_b64encode(message.as_string())}
# py3
return {'raw': base64.urlsafe_b64encode(message.as_string().encode()).decode()}
except HttpError as error:
print ('An error occurred: %s') % error
# ='https://www.googleapis.com/auth/fusiontables'
# https://developers.google.com/api-client-library/python/guide/aaa_oauth
class bjfFusionService:
def __init__(self, bjfGoogleInstance):
self.bjfGinstance=bjfGoogleInstance
self.service=build("fusiontables","v2",http=self.bjfGinstance.AuthorisedHTTP())
def GetTableByName(self,name):
# list all tables
found=self.service.table().list().execute()
while "items" in found:
for each in found["items"]:
if each["name"]==name:
return self.OpenTable(each["tableId"])
if not "nextPageToken" in found:
break
found=self.service.table().list(pageToken=found["nextPageToken"]).execute()
return None
def CreateTable(self,body):
return self.service.table().insert(body=body).execute();
def OpenTable(self,tableid):
return self.service.table().get(tableId=tableid).execute();
def InsertRowData(self,tableObject, rowDictionary):
sump=io.StringIO()
w=csv.writer(sump, quoting=csv.QUOTE_ALL)
w.writerows(rowDictionary)
mu=MediaIoBaseUpload(sump,mimetype="application/octet-stream")
return self.service.table().importRows(tableId=tableObject["tableId"], media_body=mu).execute()