create single Credentials class (#1032)

Included redacted print methods for each credential type

Author: jacalata

tableauserverclient/models/__init__.py

@@ -22,16 +22,14 @@
 from .metric_item import MetricItem
 from .pagination_item import PaginationItem
 from .permissions_item import PermissionsRule, Permission
-from .personal_access_token_auth import PersonalAccessTokenAuth
-from .personal_access_token_auth import PersonalAccessTokenAuth
 from .project_item import ProjectItem
 from .revision_item import RevisionItem
 from .schedule_item import ScheduleItem
 from .server_info_item import ServerInfoItem
 from .site_item import SiteItem
 from .subscription_item import SubscriptionItem
 from .table_item import TableItem
-from .tableau_auth import TableauAuth
+from .tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth
 from .target import Target
 from .task_item import TaskItem
 from .user_item import UserItem

tableauserverclient/models/personal_access_token_auth.py

@@ -1,41 +1,70 @@
-class TableauAuth(object):
+class Credentials:
+    def __init__(self, site_id=None, user_id_to_impersonate=None):
+        self.site_id = site_id or ""
+        self.user_id_to_impersonate = user_id_to_impersonate or None
+
+    @property
+    def credentials(self):
+        credentials = "Credentials can be username/password, Personal Access Token, or JWT"
+        +"This method returns values to set as an attribute on the credentials element of the request"
+
+    def __repr__(self):
+        display = "All Credentials types must have a debug display that does not print secrets"
+
+
+def deprecate_site_attribute():
+    import warnings
+
+    warnings.warn(
+        "TableauAuth(..., site=...) is deprecated, " "please use TableauAuth(..., site_id=...) instead.",
+        DeprecationWarning,
+    )
+
+
+# The traditional auth type: username/password
+class TableauAuth(Credentials):
     def __init__(self, username, password, site=None, site_id=None, user_id_to_impersonate=None):
         if site is not None:
-            import warnings
-
-            warnings.warn(
-                "TableauAuth(..., site=...) is deprecated, " "please use TableauAuth(..., site_id=...) instead.",
-                DeprecationWarning,
-            )
+            deprecate_site_attribute()
             site_id = site
+        super().__init__(site_id, user_id_to_impersonate)
         if password is None:
             raise TabError("Must provide a password when using traditional authentication")
-
-        self.user_id_to_impersonate = user_id_to_impersonate
         self.password = password
-        self.site_id = site_id if site_id is not None else ""
         self.username = username
 
     @property
-    def site(self):
-        import warnings
+    def credentials(self):
+        return {"name": self.username, "password": self.password}
 
-        warnings.warn(
-            "TableauAuth.site is deprecated, use TableauAuth.site_id instead.",
-            DeprecationWarning,
-        )
+    def __repr__(self):
+        return "<Credentials username={} password={}>".format(self.username, "<redacted>")
+
+    @property
+    def site(self):
+        deprecate_site_attribute()
         return self.site_id
 
     @site.setter
     def site(self, value):
-        import warnings
-
-        warnings.warn(
-            "TableauAuth.site is deprecated, use TableauAuth.site_id instead.",
-            DeprecationWarning,
-        )
+        deprecate_site_attribute()
         self.site_id = value
 
+
+class PersonalAccessTokenAuth(Credentials):
+    def __init__(self, token_name, personal_access_token, site_id=None):
+        super().__init__(site_id=site_id)
+        self.token_name = token_name
+        self.personal_access_token = personal_access_token
+
     @property
     def credentials(self):
-        return {"name": self.username, "password": self.password}
+        return {
+            "personalAccessTokenName": self.token_name,
+            "personalAccessTokenSecret": self.personal_access_token,
+        }
+
+    def __repr__(self):
+        return "<PersonalAccessToken name={} token={} site={}>".format(
+            self.token_name, self.personal_access_token[:2] + "...", self.site_id
+        )