-
Notifications
You must be signed in to change notification settings - Fork 87
/
tableau_rest_api_connection.py
2202 lines (1972 loc) · 87.7 KB
/
tableau_rest_api_connection.py
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
import os
from ..tableau_base import *
from ..tableau_documents.tableau_file import TableauFile
from ..tableau_documents.tableau_workbook import TableauWorkbook
from ..tableau_documents.tableau_datasource import TableauDatasource
from ..tableau_exceptions import *
from rest_xml_request import RestXmlRequest
from published_content import Project20, Project21, Project28, Workbook, Datasource
import urllib
class TableauRestApiConnection(TableauBase):
# Defines a class that represents a RESTful connection to Tableau Server. Use full URL (http:// or https://)
def __init__(self, server, username, password, site_content_url=""):
"""
:type server: unicode
:type username: unicode
:type password: unicode
:type site_content_url: unicode
"""
TableauBase.__init__(self)
if server.find(u'http') == -1:
raise InvalidOptionException(u'Server URL must include http:// or https://')
etree.register_namespace(u't', self.ns_map[u't'])
self.server = server
self.site_content_url = site_content_url
self.username = username
self._password = password
self.token = None # Holds the login token from the Sign In call
self.site_luid = ""
self.user_luid = ""
self._login_as_user_id = None
self._last_error = None
self.logger = None
self._last_response_content_type = None
self._request_obj = None # type: RestXmlRequest
# All defined in TableauBase superclass
self._site_roles = self.site_roles
self._permissionable_objects = self.permissionable_objects
self._server_to_rest_capability_map = self.server_to_rest_capability_map
# Lookup caches to minimize calls
self.username_luid_cache = {}
self.group_name_luid_cache = {}
# For working around SSL issues
self.verify_ssl_cert = True
def enable_logging(self, logger_obj):
"""
:type logger_obj: Logger
:return:
"""
if isinstance(logger_obj, Logger):
self.logger = logger_obj
if self._request_obj is not None:
self._request_obj.enable_logging(logger_obj)
#
# Object helpers and setter/getters
#
def get_last_error(self):
self.log(self._last_error)
return self._last_error
def set_last_error(self, error):
self._last_error = error
#
# REST API Helper Methods
#
def build_api_url(self, call, server_level=False):
if server_level is True:
return u"{}/api/{}/{}".format(self.server, self.api_version, call)
else:
return u"{}/api/{}/sites/{}/{}".format(self.server, self.api_version, self.site_luid, call)
#
# Internal REST API Helpers (mostly XML definitions that are reused between methods)
#
@staticmethod
def build_site_request_xml(site_name=None, content_url=None, admin_mode=None, user_quota=None,
storage_quota=None, disable_subscriptions=None, state=None):
"""
:type site_name: unicode
:type content_url: unicode
:type admin_mode: unicode
:type user_quota: unicode
:type storage_quota: unicode
:type disable_subscriptions: bool
:type state: unicode
:rtype: unicode
"""
tsr = etree.Element(u"tsRequest")
s = etree.Element(u'site')
if site_name is not None:
s.set(u'name', site_name)
if content_url is not None:
s.set(u'contentUrl', content_url)
if admin_mode is not None:
s.set(u'adminMode', admin_mode)
if user_quota is not None:
s.set(u'userQuota', unicode(user_quota))
if state is not None:
s.set(u'state', state)
if storage_quota is not None:
s.set(u'storageQuota', unicode(storage_quota))
if disable_subscriptions is not None:
s.set(u'disableSubscriptions', unicode(disable_subscriptions).lower())
tsr.append(s)
return tsr
@staticmethod
def __build_connection_update_xml(new_server_address=None, new_server_port=None,
new_connection_username=None, new_connection_password=None):
"""
:type new_server_address: unicode
:type new_server_port: unicode
:type new_connection_username: unicode
:type new_connection_password: unicode
:rtype:
"""
tsr = etree.Element(u'tsRequest')
c = etree.Element(u"connection")
if new_server_address is not None:
c.set(u'serverAddress', new_server_address)
if new_server_port is not None:
c.set(u'serverPort', new_server_port)
if new_connection_username is not None:
c.set(u'userName', new_connection_username)
if new_connection_username is not None:
c.set(u'password', new_connection_password)
tsr.append(c)
return tsr
#
# Factory methods for PublishedContent and Permissions objects
#
def get_published_project_object(self, project_name_or_luid, project_xml_obj=None):
"""
:type project_name_or_luid: unicode
:type project_xml_obj: etree.Element
:rtype: proj_obj:Project
"""
if self.is_luid(project_name_or_luid):
luid = project_name_or_luid
else:
luid = self.query_project_luid(project_name_or_luid)
proj_obj = Project20(luid, self, self.version, self.logger, project_xml_obj)
return proj_obj
def get_published_workbook_object(self, workbook_name_or_luid, project_name_or_luid=None):
"""
:type project_name_or_luid: unicode
:type workbook_name_or_luid: unicode
:rtype: wb_obj:Workbook
"""
if self.is_luid(workbook_name_or_luid):
luid = workbook_name_or_luid
else:
luid = self.query_workbook_luid(workbook_name_or_luid, project_name_or_luid)
wb_obj = Workbook(luid, self, tableau_server_version=self.version, default=False, logger_obj=self.logger)
return wb_obj
def get_published_datasource_object(self, datasource_name_or_luid, project_name_or_luid=None):
"""
:param project_name_or_luid:
:param datasource_name_or_luid:
:type datasource_name_or_luid: unicode
:rtype: ds_obj:Datasource
"""
if self.is_luid(datasource_name_or_luid):
luid = datasource_name_or_luid
else:
luid = self.query_datasource_luid(datasource_name_or_luid, project_name_or_luid)
ds_obj = Datasource(luid, self, tableau_server_version=self.version, default=False, logger_obj=self.logger)
return ds_obj
#
# Sign-in and Sign-out
#
def signin(self, user_luid_to_impersonate=None):
"""
:type user_luid_to_impersonate: unicode
:rtype:
"""
self.start_log_block()
tsr = etree.Element(u"tsRequest")
c = etree.Element(u"credentials")
c.set(u"name", self.username)
c.set(u"password", self._password)
s = etree.Element(u"site")
if self.site_content_url.lower() not in ['default', '']:
s.set(u"contentUrl", self.site_content_url)
c.append(s)
if user_luid_to_impersonate is not None:
u = etree.Element(u'user')
u.set(u'id', user_luid_to_impersonate)
c.append(u)
tsr.append(c)
url = self.build_api_url(u"auth/signin", server_level=True)
self.log(u'Logging in via: {}'.format(url))
# Create the RestXmlRequest to be used throughout
self._request_obj = RestXmlRequest(url, self.token, self.logger, ns_map_url=self.ns_map['t'],
verify_ssl_cert=self.verify_ssl_cert)
self._request_obj.xml_request = tsr
self._request_obj.http_verb = u'post'
self.log(u'Login payload is\n {}'.format(etree.tostring(tsr)))
self._request_obj.request_from_api(0)
# self.log(api.get_raw_response())
xml = self._request_obj.get_response()
credentials_element = xml.findall(u'.//t:credentials', self.ns_map)
self.token = credentials_element[0].get(u"token")
self.log(u"Token is " + self.token)
self._request_obj.token = self.token
self.site_luid = credentials_element[0].findall(u".//t:site", self.ns_map)[0].get(u"id")
self.user_luid = credentials_element[0].findall(u".//t:user", self.ns_map)[0].get(u"id")
self.log(u"Site ID is " + self.site_luid)
self._request_obj.url = None
self._request_obj.xml_request = None
self.end_log_block()
def signout(self, session_token=None):
"""
:type session_token: unicode
:rtype:
"""
self.start_log_block()
url = self.build_api_url(u"auth/signout", server_level=True)
self.log(u'Logging out via: {}'.format(url))
self._request_obj.url = url
# This allows for signout when using the older session token style
if session_token is not None:
self._request_obj.token = session_token
self._request_obj.http_verb = u'post'
self._request_obj.request_from_api()
# Reset the main object to the original token for other requests
self._request_obj.token = self.token
self._request_obj.url = None
self.log(u'Signed out successfully')
self.end_log_block()
#
# HTTP "verb" methods. These actually communicate with the RestXmlRequest object to place the requests
#
# baseline method for any get request. appends to base url
def query_resource(self, url_ending, server_level=False):
"""
:type url_ending: unicode
:type server_level: bool
:rtype: etree.Element
"""
self.start_log_block()
api_call = self.build_api_url(url_ending, server_level)
self._request_obj.set_response_type(u'xml')
self._request_obj.http_verb = u'get'
self._request_obj.url = api_call
self._request_obj.request_from_api()
xml = self._request_obj.get_response() # return Element rather than ElementTree
self._request_obj.url = None
self.end_log_block()
return xml
def query_single_element_from_endpoint(self, element_name, name_or_luid, server_level=False):
"""
:type element_name: unicode
:type name_or_luid: unicode
:type server_level: bool
:rtype: etree.Element
"""
self.start_log_block()
# A few elements have singular endpoints
singular_endpoints = [u'workbook', u'user', u'datasource', u'site']
if element_name in singular_endpoints and self.is_luid(name_or_luid):
element = self.query_resource(u"{}s/{}".format(element_name, name_or_luid))
self.end_log_block()
return element
else:
elements = self.query_resource(u"{}s".format(element_name), server_level=server_level)
if self.is_luid(name_or_luid):
luid = name_or_luid
else:
luid = self.query_single_element_luid_by_name_from_endpoint(element_name, name_or_luid)
element = elements.findall(u'.//t:{}[@id="{}"]'.format(element_name, luid), self.ns_map)
if len(element) == 1:
self.end_log_block()
return element[0]
else:
self.end_log_block()
raise NoMatchFoundException(u"No {} found with name or luid {}".format(element_name, name_or_luid))
def query_single_element_luid_by_name_from_endpoint(self, element_name, name, server_level=False):
self.start_log_block()
elements = self.query_resource(u"{}s".format(element_name), server_level=server_level)
if element_name == u'group':
for e in elements:
self.group_name_luid_cache[e.get(u'name')] = e.get(u'id')
element = elements.findall(u'.//t:{}[@name="{}"]'.format(element_name, name), self.ns_map)
if len(element) == 1:
self.end_log_block()
return element[0].get(u"id")
else:
self.end_log_block()
raise NoMatchFoundException(u"No {} found with name {}".format(element_name, name))
def send_post_request(self, url):
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.http_verb = u'post'
self._request_obj.request_from_api(0)
xml = self._request_obj.get_response() # return Element rather than ElementTree
self._request_obj.url = None
self.end_log_block()
return xml
def send_add_request(self, url, request):
"""
:type url: unicode
:type request: etree.Element
:rtype:
"""
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.xml_request = request
self._request_obj.http_verb = u'post'
self._request_obj.request_from_api(0) # Zero disables paging, for all non queries
xml = self._request_obj.get_response() # return Element rather than ElementTree
# Clean up after request made
self._request_obj.url = None
self._request_obj.xml_request = None
self.end_log_block()
return xml
def send_update_request(self, url, request):
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.xml_request = request
self._request_obj.http_verb = u'put'
self._request_obj.request_from_api(0) # Zero disables paging, for all non queries
self.end_log_block()
self._request_obj.url = None
self._request_obj.xml_request = None
return self._request_obj.get_response()
def send_delete_request(self, url):
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.http_verb = u'delete'
try:
self._request_obj.request_from_api(0) # Zero disables paging, for all non queries
self._request_obj.url = None
self.end_log_block()
# Return for counter
return 1
except RecoverableHTTPException as e:
self.log(u'Non fatal HTTP Exception Response {}, Tableau Code {}'.format(e.http_code, e.tableau_error_code))
if e.tableau_error_code in [404003, 404002]:
self.log(u'Delete action did not find the resource. Consider successful, keep going')
self._request_obj.url = None
self.end_log_block()
except:
raise
def send_publish_request(self, url, xml_request, content, boundary_string):
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.set_publish_content(content, boundary_string)
self._request_obj.xml_request = xml_request
self._request_obj.http_verb = u'post'
self._request_obj.request_from_api(0)
xml = self._request_obj.get_response() # return Element rather than ElementTree
# Cleanup
self._request_obj.set_publish_content(None, None)
self._request_obj.xml_request = None
self._request_obj.url = None
self.end_log_block()
return xml
def send_append_request(self, url, request, boundary_string):
self.start_log_block()
self._request_obj.set_response_type(u'xml')
self._request_obj.url = url
self._request_obj.set_publish_content(request, boundary_string)
self._request_obj.http_verb = u'put'
self._request_obj.request_from_api(0)
xml = self._request_obj.get_response() # return Element rather than ElementTree
# Cleanup
self._request_obj.set_publish_content(None, None)
self._request_obj.url = None
self.end_log_block()
return xml
# Used when the result is not going to be XML and you want to save the raw response as binary
def send_binary_get_request(self, url):
self.start_log_block()
self._request_obj.url = url
self._request_obj.http_verb = u'get'
self._request_obj.set_response_type(u'binary')
self._request_obj.request_from_api(0)
# Set this content type so we can set the file extension
self._last_response_content_type = self._request_obj.get_last_response_content_type()
# Cleanup
self._request_obj.url = None
self.end_log_block()
return self._request_obj.get_response()
#
# Basic Querying / Get Methods
#
#
# Begin Datasource Querying Methods
#
def query_datasources(self, project_name_or_luid=None):
"""
:type project_name_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
datasources = self.query_resource(u"datasources")
if project_name_or_luid is not None:
if self.is_luid(project_name_or_luid):
project_luid = project_name_or_luid
else:
project_luid = self.query_project_luid(project_name_or_luid)
ds = datasources.findall(u'.//t:project[@id="{}"]/..'.format(project_luid), self.ns_map)
else:
ds = datasources
self.end_log_block()
return ds
# Tries to guess name or LUID, hope there is only one
def query_datasource(self, ds_name_or_luid, proj_name_or_luid=None):
"""
:type ds_name_or_luid: unicode
:type proj_name_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
# LUID
if self.is_luid(ds_name_or_luid):
ds = self.query_resource(u"datasources/{}".format(ds_name_or_luid))
# Name
else:
ds_luid = self.query_datasource_luid(ds_name_or_luid, proj_name_or_luid)
ds = self.query_resource(u"datasources/{}".format(ds_luid))
self.end_log_block()
return ds
# Datasources in different projects can have the same 'pretty name'.
def query_datasource_luid(self, datasource_name, project_name_or_luid=None, content_url=None):
"""
:type datasource_name: unicode
:type project_name_or_luid: unicode
:type content_url: unicode
:rtype: unicode
"""
self.start_log_block()
datasources = self.query_datasources()
if content_url is not None:
datasources_with_name = datasources.findall(u'.//t:datasource[@contentUrl="{}"]'.format(content_url), self.ns_map)
else:
datasources_with_name = datasources.findall(u'.//t:datasource[@name="{}"]'.format(datasource_name), self.ns_map)
if len(datasources_with_name) == 0:
self.end_log_block()
raise NoMatchFoundException(u"No datasource found with name {} in any project".format(datasource_name))
elif project_name_or_luid is None:
if len(datasources_with_name) == 1:
self.end_log_block()
return datasources_with_name[0].get(u"id")
# If no project is declared, and
else:
raise MultipleMatchesFoundException(u'More than one datasource found by name {} without a project specified'.format(datasource_name))
else:
if self.is_luid(project_name_or_luid):
ds_in_proj = datasources.findall(u'.//t:project[@id="{}"]/..'.format(project_name_or_luid), self.ns_map)
else:
ds_in_proj = datasources.findall(u'.//t:project[@name="{}"]/..'.format(project_name_or_luid), self.ns_map)
if len(ds_in_proj) == 0:
self.end_log_block()
raise NoMatchFoundException(u"No datasource found with name {} in project {}".format(datasource_name, project_name_or_luid))
return ds_in_proj[0].get(u"id")
def query_datasource_content_url(self, datasource_name_or_luid, project_name_or_luid=None):
"""
:type datasource_name_or_luid: unicode
:type project_name_or_luid: unicode
:rtype: unicode
"""
self.start_log_block()
ds = self.query_datasource(datasource_name_or_luid, project_name_or_luid)
content_url = ds.get(u'contentUrl')
self.end_log_block()
return content_url
#
# End Datasource Query Methods
#
#
# Start Group Query Methods
#
def query_groups(self):
"""
:rtype: etree.Element
"""
self.start_log_block()
groups = self.query_resource(u"groups")
for group in groups:
# Add to group-name : luid cache
group_luid = group.get(u"id")
group_name = group.get(u'name')
self.group_name_luid_cache[group_name] = group_luid
self.end_log_block()
return groups
# # No basic verb for querying a single group, so run a query_groups
def query_group(self, group_name_or_luid):
"""
:type group_name_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
group = self.query_single_element_from_endpoint(u'group', group_name_or_luid)
# Add to group_name : luid cache
group_luid = group.get(u"id")
group_name = group.get(u'name')
self.group_name_luid_cache[group_name] = group_luid
self.end_log_block()
return group
# Groups luckily cannot have the same 'pretty name' on one site
def query_group_luid(self, group_name):
"""
:type group_name: unicode
:rtype: unicode
"""
self.start_log_block()
if group_name in self.group_name_luid_cache:
group_luid = self.group_name_luid_cache[group_name]
self.log(u'Found group name {} in cache with luid {}'.format(group_name, group_luid))
else:
group_luid = self.query_single_element_luid_by_name_from_endpoint(u'group', group_name)
self.group_name_luid_cache[group_name] = group_luid
self.end_log_block()
return group_luid
def query_group_name(self, group_luid):
"""
:type group_luid: unicode
:rtype: unicode
"""
self.start_log_block()
for name, luid in self.group_name_luid_cache.items():
if luid == group_luid:
group_name = name
self.log(u'Found group name {} in cache with luid {}'.format(group_name, group_luid))
return group_name
# If match is found
group = self.query_single_element_from_endpoint(u'group', group_luid)
group_luid = group.get(u"id")
group_name = group.get(u'name')
self.log(u'Loading the Group: LUID cache')
self.group_name_luid_cache[group_name] = group_luid
self.end_log_block()
return group_name
#
# End Group Querying methods
#
#
# Start Project Querying methods
#
def query_projects(self):
"""
:rtype: etree.Element
"""
self.start_log_block()
projects = self.query_resource(u"projects")
self.end_log_block()
return projects
def query_project(self, project_name_or_luid):
"""
:type project_name_or_luid: unicode
:rtype: Project20
"""
self.start_log_block()
if self.is_luid(project_name_or_luid):
luid = project_name_or_luid
else:
luid = self.query_project_luid(project_name_or_luid)
proj = self.get_published_project_object(luid, self.query_single_element_from_endpoint(u'project', luid))
self.end_log_block()
return proj
def query_project_luid(self, project_name):
"""
:type project_name: unicode
:rtype: unicode
"""
self.start_log_block()
project_luid = self.query_single_element_luid_by_name_from_endpoint(u'project', project_name)
self.end_log_block()
return project_luid
#
# End Project Querying Methods
#
#
# Start Site Querying Methods
#
# Site queries don't have the site portion of the URL, so login option gets correct format
def query_sites(self):
"""
:rtype: etree.Element
"""
self.start_log_block()
sites = self.query_resource(u"sites/", server_level=True)
self.end_log_block()
return sites
# Methods for getting info about the sites, since you can only query a site when you are signed into it
# Return list of all site contentUrls
def query_all_site_content_urls(self):
"""
:rtype: list[unicode]
"""
self.start_log_block()
sites = self.query_sites()
site_content_urls = []
for site in sites:
site_content_urls.append(site.get(u"contentUrl"))
self.end_log_block()
return site_content_urls
# You can only query a site you have logged into this way. Better to use methods that run through query_sites
def query_current_site(self):
"""
:rtype: etree.Element
"""
self.start_log_block()
site = self.query_resource(u"sites/{}".format(self.site_luid), server_level=True)
self.end_log_block()
return site
#
# End Site Querying Methods
#
#
# Start User Querying Methods
#
# The reference has this name, so for consistency adding an alias
def get_users(self):
"""
:rtype: etree.Element
"""
return self.query_users()
def query_users(self):
"""
:rtype: etree.Element
"""
self.start_log_block()
users = self.query_resource(u"users")
self.log(u'Found {} users'.format(unicode(len(users))))
self.end_log_block()
return users
def query_user(self, username_or_luid):
"""
:type username_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
user = self.query_single_element_from_endpoint(u"user", username_or_luid)
# Add to username : luid cache
user_luid = user.get(u"id")
username = user.get(u'name')
self.username_luid_cache[username] = user_luid
self.end_log_block()
return user
def query_user_luid(self, username):
"""
:type username: unicode
:rtype: unicode
"""
self.start_log_block()
if username in self.username_luid_cache:
user_luid = self.username_luid_cache[username]
self.log(u'Found username {} in cache with luid {}'.format(username, user_luid))
else:
user_luid = self.query_single_element_luid_by_name_from_endpoint(u"user", username)
self.username_luid_cache[username] = user_luid
self.end_log_block()
return user_luid
def query_username(self, user_luid):
"""
:type user_luid: unicode
:rtype: unicode
"""
self.start_log_block()
try:
luid_index = self.username_luid_cache.values().index(user_luid)
username = self.username_luid_cache.keys()[luid_index]
except ValueError as e:
user = self.query_user(user_luid)
username = user.get(u'name')
self.end_log_block()
return username
def query_users_in_group(self, group_name_or_luid):
"""
:type group_name_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
if self.is_luid(group_name_or_luid):
luid = group_name_or_luid
else:
luid = self.query_group_luid(group_name_or_luid)
users = self.query_resource(u"groups/{}/users".format(luid))
self.end_log_block()
return users
#
# End User Querying Methods
#
#
# Start Workbook Querying Methods
#
# This uses the logged in username for convenience by default
def query_workbooks(self, username_or_luid=None):
"""
:type username_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
if username_or_luid is None:
user_luid = self.user_luid
elif self.is_luid(username_or_luid):
user_luid = username_or_luid
else:
user_luid = self.query_user_luid(username_or_luid)
wbs = self.query_resource(u"users/{}/workbooks".format(user_luid))
self.end_log_block()
return wbs
# Because a workbook can have the same pretty name in two projects, requires more logic
# Maybe reduce down the xpath here into simpler ElementTree iteration, to remove lxml???
def query_workbook(self, wb_name_or_luid, p_name_or_luid=None, username_or_luid=None):
"""
:type wb_name_or_luid: unicode
:type p_name_or_luid: unicode
:type username_or_luid: unicode
:rtype: etree.Element
"""
self.start_log_block()
workbooks = self.query_workbooks(username_or_luid)
if self.is_luid(wb_name_or_luid):
workbooks_with_name = self.query_resource(u"workbooks/{}".format(wb_name_or_luid))
else:
workbooks_with_name = workbooks.findall(u'.//t:workbook[@name="{}"]'.format(wb_name_or_luid), self.ns_map)
if len(workbooks_with_name) == 0:
self.end_log_block()
raise NoMatchFoundException(u"No workbook found for username '{}' named {}".format(username_or_luid, wb_name_or_luid))
elif p_name_or_luid is None:
if len(workbooks_with_name) == 1:
wb_luid = workbooks_with_name[0].get("id")
wb = self.query_resource(u"workbooks/{}".format(wb_luid))
self.end_log_block()
return wb
else:
self.end_log_block()
raise MultipleMatchesFoundException(u'More than one workbook found by name {} without a project specified').format(wb_name_or_luid)
else:
if self.is_luid(p_name_or_luid):
wb_in_proj = workbooks.findall(u'.//t:workbook[@name="{}"]/:project[@id="{}"]/..'.format(wbp_name_or_luid), self.ns_map)
else:
wb_in_proj = workbooks.findall(u'.//t:workbook[@name="{}"]/t:project[@name="{}"]/..'.format(p_name_or_luid), self.ns_map)
if len(wb_in_proj) == 0:
self.end_log_block()
raise NoMatchFoundException(u'No workbook found with name {} in project {}').format(wb_name_or_luid, p_name_or_luid)
wb_luid = wb_in_proj[0].get("id")
wb = self.query_resource(u"workbooks/{}".format(wb_luid))
self.end_log_block()
return wb
def query_workbook_luid(self, wb_name, p_name_or_luid=None, username_or_luid=None):
"""
:type username_or_luid: unicode
:type wb_name: unicode
:type p_name_or_luid: unicode
:rtype:
"""
self.start_log_block()
if username_or_luid is None:
username_or_luid = self.user_luid
workbooks = self.query_workbooks(username_or_luid)
workbooks_with_name = workbooks.findall(u'.//t:workbook[@name="{}"]'.format(wb_name), self.ns_map)
if len(workbooks_with_name) == 0:
self.end_log_block()
raise NoMatchFoundException(u"No workbook found for username '{}' named {}".format(username_or_luid, wb_name))
elif len(workbooks_with_name) == 1:
wb_luid = workbooks_with_name[0].get("id")
self.end_log_block()
return wb_luid
elif len(workbooks_with_name) > 1 and p_name_or_luid is not False:
if self.is_luid(p_name_or_luid):
wb_in_proj = workbooks.findall(u'.//t:workbook[@name="{}"]/t:project[@id="{}"]/..'.format(wb_name, p_name_or_luid), self.ns_map)
else:
wb_in_proj = workbooks.findall(u'.//t:workbook[@name="{}"]/t:project[@name="{}"]/..'.format(wb_name, p_name_or_luid), self.ns_map)
if len(wb_in_proj) == 0:
self.end_log_block()
raise NoMatchFoundException(u'No workbook found with name {} in project {}').format(wb_name, p_name_or_luid)
wb_luid = wb_in_proj[0].get("id")
self.end_log_block()
return wb_luid
else:
self.end_log_block()
raise MultipleMatchesFoundException(u'More than one workbook found by name {} without a project specified').format(wb_name)
def query_workbooks_in_project(self, project_name_or_luid, username_or_luid=None):
self.start_log_block()
if self.is_luid(project_name_or_luid):
project_luid = project_name_or_luid
else:
project_luid = self.query_project_luid(project_name_or_luid)
if username_or_luid is None:
user_luid = self.user_luid
elif self.is_luid(username_or_luid):
user_luid = username_or_luid
else:
user_luid = self.query_user_luid(username_or_luid)
workbooks = self.query_workbooks(user_luid)
# This brings back the workbook itself
wbs_in_project = workbooks.findall(u'.//t:project[@id="{}"]/..'.format(project_luid), self.ns_map)
self.end_log_block()
return wbs_in_project
def query_workbook_views(self, wb_name_or_luid, p_name_or_luid=None, username_or_luid=None, usage=False):
"""
:type wb_name_or_luid: unicode
:type p_name_or_luid: unicode
:type username_or_luid: unicode
:type usage: bool
:rtype: etree.Element
"""
self.start_log_block()
if usage not in [True, False]:
raise InvalidOptionException(u'Usage can only be set to True or False')
if self.is_luid(wb_name_or_luid):
wb_luid = wb_name_or_luid
else:
wb_luid = self.query_workbook_luid(wb_name_or_luid, p_name_or_luid, username_or_luid)
vws = self.query_resource(u"workbooks/{}/views?includeUsageStatistics={}".format(wb_luid, str(usage).lower()))
self.end_log_block()
return vws
def query_workbook_view(self, wb_name_or_luid, view_name_or_luid=None, view_content_url=None, p_name_or_luid=None, username_or_luid=None,
usage=False):
"""
:type wb_name_or_luid: unicode
:type p_name_or_luid: unicode
:type username_or_luid: unicode
:type view_name_or_luid: unicode
:type view_content_url: unicode
:type usage: bool
:rtype: etree.Element
"""
self.start_log_block()
if usage not in [True, False]:
raise InvalidOptionException(u'Usage can only be set to True or False')
if self.is_luid(wb_name_or_luid):
wb_luid = wb_name_or_luid
else:
wb_luid = self.query_workbook_luid(wb_name_or_luid, p_name_or_luid, username_or_luid)
vws = self.query_resource(u"workbooks/{}/views?includeUsageStatistics={}".format(wb_luid, str(usage).lower()))
if view_content_url is not None:
views_with_name = vws.findall(u'.//t:view[@contentUrl="{}"]'.format(view_content_url), self.ns_map)
elif self.is_luid(view_name_or_luid):
views_with_name = vws.findall(u'.//t:view[@id="{}"]'.format(view_name_or_luid), self.ns_map)
else:
views_with_name = vws.findall(u'.//t:view[@name="{}"]'.format(view_name_or_luid), self.ns_map)
if len(views_with_name) == 0:
self.end_log_block()
raise NoMatchFoundException(u'No view found with name {} in workbook {}').format(view_name_or_luid, wb_name_or_luid)
elif len(views_with_name) > 1:
self.end_log_block()
raise MultipleMatchesFoundException(
u'More than one view found by name {} in workbook {}. Use view_content_url parameter').format(view_name_or_luid, wb_name_or_luid)
self.end_log_block()
return views_with_name
def query_workbook_view_luid(self, wb_name_or_luid, view_name=None, view_content_url=None, p_name_or_luid=None,
username_or_luid=None, usage=False):
"""
:type wb_name_or_luid: unicode
:type p_name_or_luid: unicode
:type username_or_luid: unicode
:type view_name: unicode
:type view_content_url: unicode
:type usage: bool
:rtype: unicode
"""
self.start_log_block()
if usage not in [True, False]:
raise InvalidOptionException(u'Usage can only be set to True or False')
if self.is_luid(wb_name_or_luid):
wb_luid = wb_name_or_luid
else:
wb_luid = self.query_workbook_luid(wb_name_or_luid, p_name_or_luid, username_or_luid)
vws = self.query_resource(u"workbooks/{}/views?includeUsageStatistics={}".format(wb_luid, str(usage).lower()))
if view_content_url is not None:
views_with_name = vws.findall(u'.//t:view[@contentUrl="{}"]'.format(view_content_url), self.ns_map)
else:
views_with_name = vws.findall(u'.//t:view[@name="{}"]'.format(view_name), self.ns_map)
if len(views_with_name) == 0:
self.end_log_block()
raise NoMatchFoundException(u'No view found with name {} or content_url {} in workbook {}').format(view_name, view_content_url, wb_name_or_luid)
elif len(views_with_name) > 1:
self.end_log_block()
raise MultipleMatchesFoundException(
u'More than one view found by name {} in workbook {}. Use view_content_url parameter').format(view_name, view_content_url, wb_name_or_luid)
view_luid = views_with_name[0].get(u'id')
self.end_log_block()
return view_luid
# This should be the key to updating the connections in a workbook. Seems to return
# LUIDs for connections and the datatypes, but no way to distinguish them
def query_workbook_connections(self, wb_name_or_luid, p_name_or_luid=None, username_or_luid=None):
self.start_log_block()
if self.is_luid(wb_name_or_luid):
wb_luid = wb_name_or_luid
else:
wb_luid = self.query_workbook_luid(wb_name_or_luid, p_name_or_luid, username_or_luid)
conns = self.query_resource(u"workbooks/{}/connections".format(wb_luid))
self.end_log_block()
return conns