Skip to content

Users endpoint favorites #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
t8y8 merged 1 commit into from
Aug 11, 2020
Merged

Users endpoint favorites #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tableauserverclient/server/endpoint/users_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ def _get_wbs_for_user(self, user_item, req_options=None):
return workbook_item, pagination_item

def populate_favorites(self, user_item):
raise NotImplementedError('REST API currently does not support the ability to query favorites')
self.parent_srv.favorites.get(user_item)
27 changes: 26 additions & 1 deletion test/test_user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
UPDATE_XML = os.path.join(TEST_ASSET_DIR, 'user_update.xml')
ADD_XML = os.path.join(TEST_ASSET_DIR, 'user_add.xml')
POPULATE_WORKBOOKS_XML = os.path.join(TEST_ASSET_DIR, 'user_populate_workbooks.xml')
ADD_FAVORITE_XML = os.path.join(TEST_ASSET_DIR, 'user_add_favorite.xml')
GET_FAVORITES_XML = os.path.join(TEST_ASSET_DIR, 'favorites_get.xml')


class UserTests(unittest.TestCase):
Expand Down Expand Up @@ -146,3 +146,28 @@ def test_populate_workbooks(self):
def test_populate_workbooks_missing_id(self):
single_user = TSC.UserItem('test', 'Interactor')
self.assertRaises(TSC.MissingRequiredFieldError, self.server.users.populate_workbooks, single_user)

def test_populate_favorites(self):
self.server.version = '2.5'
baseurl = self.server.favorites.baseurl
single_user = TSC.UserItem('test', 'Interactor')
with open(GET_FAVORITES_XML, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get('{0}/{1}'.format(baseurl, single_user.id), text=response_xml)
self.server.users.populate_favorites(single_user)
self.assertIsNotNone(single_user._favorites)
self.assertEqual(len(single_user.favorites['workbooks']), 1)
self.assertEqual(len(single_user.favorites['views']), 1)
self.assertEqual(len(single_user.favorites['projects']), 1)
self.assertEqual(len(single_user.favorites['datasources']), 1)

workbook = single_user.favorites['workbooks'][0]
view = single_user.favorites['views'][0]
datasource = single_user.favorites['datasources'][0]
project = single_user.favorites['projects'][0]

self.assertEqual(workbook.id, '6d13b0ca-043d-4d42-8c9d-3f3313ea3a00')
self.assertEqual(view.id, 'd79634e1-6063-4ec9-95ff-50acbf609ff5')
self.assertEqual(datasource.id, 'e76a1461-3b1d-4588-bf1b-17551a879ad9')
self.assertEqual(project.id, '1d0304cd-3796-429f-b815-7258370b9b74')