Suggestion for Workbook Update Connection (#149)

Per #148, an option for updating workbook connections. 

Includes documentation updates and support for username, port, address, password, and embedded.

Patch by @cmtoomey

Author: cmtoomey

docs/docs/api-ref.md

@@ -180,6 +180,14 @@ Modifies a workbook. The workbook item object must include the workbook ID and o
 Workbooks.update(wb_item_object)
 ```
 
+### Update workbook connection
+
+Updates a workbook connection string. The workbook connections must be populated before they strings can be updated. 
+
+```py
+Workbooks.update_conn(workbook, workbook.connections[0])
+```
+
 ### Delete Workbook
 
 Deletes a workbook with the given ID.

docs/docs/populate-connections-views.md

@@ -34,6 +34,19 @@ server.workbooks.populate_connections(workbook)
 print([connection.datasource_name for connection in workbook.connections])
 ```
 
+## Update connections for workbooks
+
+```py
+server.workbooks.populate_connections(workbook)
+conn_to_update = workbook.connections[0]
+conn_to_update.server_address = 'new_address'
+conn_to_update.server_port = 1234
+conn_to_update.username = 'username'
+conn_to_update.password = 'password'
+conn_to_update.embed_password = True/False
+server.workbooks.update_conn(workbook, conn_to_update)
+```
+
 ## Populate connections for data sources
 
 ```py

tableauserverclient/server/endpoint/workbooks_endpoint.py

@@ -74,6 +74,13 @@ def update(self, workbook_item):
         updated_workbook = copy.copy(workbook_item)
         return updated_workbook._parse_common_tags(server_response.content)
 
+    # Update workbook_connection
+    def update_conn(self, workbook_item, connection_item):
+        url = "{0}/{1}/connections/{2}".format(self.baseurl, workbook_item.id, connection_item.id)
+        update_req = RequestFactory.WorkbookConnection.update_req(connection_item)
+        server_response = self.put_request(url, update_req)
+        logger.info('Updated workbook item (ID: {0} & connection item {1}'.format(workbook_item.id, connection_item.id))
+
     # Download workbook contents with option of passing in filepath
     @api(version="2.0")
     @parameter_added_in(no_extract='2.5')

tableauserverclient/server/request_factory.py

@@ -314,6 +314,23 @@ def publish_req_chunked(self, workbook_item, connection_credentials=None):
         return _add_multipart(parts)
 
 
+class WorkbookConnection(object):
+    def update_req(self, connection_item):
+        xml_request = ET.Element('tsRequest')
+        connection_element = ET.SubElement(xml_request, 'connection')
+        if connection_item.server_address:
+            connection_element.attrib['serverAddress'] = connection_item.server_address.lower()
+        if connection_item.server_port:
+            connection_element.attrib['port'] = str(connection_item.server_port)
+        if connection_item.username:
+            connection_element.attrib['userName'] = connection_item.username
+        if connection_item.password:
+            connection_element.attrib['password'] = connection_item.password
+        if connection_item.embed_password:
+            connection_element.attrib['embedPassword'] = connection_item.embed_password
+        return ET.tostring(xml_request)
+
+
 class RequestFactory(object):
     Auth = AuthRequest()
     Datasource = DatasourceRequest()
@@ -326,3 +343,4 @@ class RequestFactory(object):
     Tag = TagRequest()
     User = UserRequest()
     Workbook = WorkbookRequest()
+    WorkbookConnection = WorkbookConnection()