Rename Favorite FavoriteItem and encapsulate

Author: jorwoods

tableauserverclient/models/__init__.py

@@ -5,7 +5,7 @@
 from .datasource_item import DatasourceItem
 from .database_item import DatabaseItem
 from .exceptions import UnpopulatedPropertyError
-from .favorites_item import Favorite, get_favorites
+from .favorites_item import FavoriteItem
 from .group_item import GroupItem
 from .flow_item import FlowItem
 from .interval_item import IntervalItem, DailyInterval, WeeklyInterval, MonthlyInterval, HourlyInterval

tableauserverclient/models/favorites_item.py

@@ -8,41 +8,42 @@
 logger = logging.getLogger('tableau.models.favorites_item')
 
 
-class Favorite:
-    Workbook = 'workbook'
-    Datasource = 'datasource'
-    View = 'view'
-    Project = 'project'
+class FavoriteItem:
+    class Type:
+        Workbook = 'workbook'
+        Datasource = 'datasource'
+        View = 'view'
+        Project = 'project'
 
+    @classmethod
+    def from_response(cls, xml, namespace):
+        favorites = {
+            'datasources': [],
+            'projects':    [],
+            'views':       [],
+            'workbooks':   [],
+        }
 
-def get_favorites(server_response, namespace):
-    favorites = {
-        'datasources': [],
-        'projects':    [],
-        'views':       [],
-        'workbooks':   [],
-    }
+        parsed_response = ET.fromstring(xml)
+        for workbook in parsed_response.findall('.//t:favorite/t:workbook', namespace):
+            fav_workbook = WorkbookItem('')
+            fav_workbook._set_values(*fav_workbook._parse_element(workbook, namespace))
+            if fav_workbook:
+                favorites['workbooks'].append(fav_workbook)
+        for view in parsed_response.findall('.//t:favorite[t:view]', namespace):
+            fav_views = ViewItem.from_xml_element(view, namespace)
+            if fav_views:
+                for fav_view in fav_views:
+                    favorites['views'].append(fav_view)
+        for datasource in parsed_response.findall('.//t:favorite/t:datasource', namespace):
+            fav_datasource = DatasourceItem('')
+            fav_datasource._set_values(*fav_datasource._parse_element(datasource, namespace))
+            if fav_datasource:
+                favorites['datasources'].append(fav_datasource)
+        for project in parsed_response.findall('.//t:favorite/t:project', namespace):
+            fav_project = ProjectItem('p')
+            fav_project._set_values(*fav_project._parse_element(project))
+            if fav_project:
+                favorites['projects'].append(fav_project)
 
-    parsed_response = ET.fromstring(server_response.content)
-    for workbook in parsed_response.findall('.//t:favorite/t:workbook', namespace):
-        fav_workbook = WorkbookItem('')
-        fav_workbook._set_values(*fav_workbook._parse_element(workbook, namespace))
-        if fav_workbook:
-            favorites['workbooks'].append(fav_workbook)
-    for view in parsed_response.findall('.//t:favorite[t:view]', namespace):
-        fav_views = ViewItem.from_xml_element(view, namespace)
-        if fav_views:
-            for fav_view in fav_views:
-                favorites['views'].append(fav_view)
-    for datasource in parsed_response.findall('.//t:favorite/t:datasource', namespace):
-        fav_datasource = DatasourceItem('')
-        fav_datasource._set_values(*fav_datasource._parse_element(datasource, namespace))
-        if fav_datasource:
-            favorites['datasources'].append(fav_datasource)
-    for project in parsed_response.findall('.//t:favorite/t:project', namespace):
-        fav_project = ProjectItem('p')
-        fav_project._set_values(*fav_project._parse_element(project))
-        if fav_project:
-            favorites['projects'].append(fav_project)
-
-    return favorites
+        return favorites

tableauserverclient/server/endpoint/favorites_endpoint.py

@@ -1,7 +1,7 @@
 from .endpoint import Endpoint, api
 from .exceptions import MissingRequiredFieldError
 from .. import RequestFactory
-from ...models import get_favorites
+from ...models import FavoriteItem
 from ..pager import Pager
 import xml.etree.ElementTree as ET
 import logging
@@ -22,7 +22,8 @@ def get(self, user_item, req_options=None):
         url = '{0}/{1}'.format(self.baseurl, user_item.id)
         server_response = self.get_request(url, req_options)
 
-        user_item._favorites = get_favorites(server_response, self.parent_srv.namespace)
+        user_item._favorites = FavoriteItem.from_response(server_response.content, 
+                                             self.parent_srv.namespace)
 
     @api(version="2.0")
     def add_favorite_workbook(self, user_item, workbook_item):

tableauserverclient/server/request_factory.py

@@ -3,7 +3,7 @@
 from requests.packages.urllib3.fields import RequestField
 from requests.packages.urllib3.filepost import encode_multipart_formdata
 
-from ..models import TaskItem, UserItem, GroupItem, PermissionsRule, Favorite
+from ..models import TaskItem, UserItem, GroupItem, PermissionsRule, FavoriteItem
 
 
 def _add_multipart(parts):
@@ -165,16 +165,16 @@ def _add_to_req(self, id_, target_type, label):
         return ET.tostring(xml_request)
 
     def add_datasource_req(self, id_, name):
-        return self._add_to_req(id_, Favorite.Datasource, name)
+        return self._add_to_req(id_, FavoriteItem.Type.Datasource, name)
 
     def add_project_req(self, id_, name):
-        return self._add_to_req(id_, Favorite.Project, name)
+        return self._add_to_req(id_, FavoriteItem.Type.Project, name)
 
     def add_view_req(self, id_, name):
-        return self._add_to_req(id_, Favorite.View, name)
+        return self._add_to_req(id_, FavoriteItem.Type.View, name)
 
     def add_workbook_req(self, id_, name):
-        return self._add_to_req(id_, Favorite.Workbook, name)
+        return self._add_to_req(id_, FavoriteItem.Type.Workbook, name)
 
 
 class FileuploadRequest(object):