Merge pull request atlassian-api#283 from andreas-j-hauser/issue-280

issue 280: implement the new method confluence.attach_content()

Author: gonchik

atlassian/confluence.py

@@ -390,7 +390,7 @@ def add_comment(self, page_id, text):
                 'body': self._create_body(text, 'storage')}
         return self.post('rest/api/content/', data=data)
 
-    def attach_file(self, filename, page_id=None, title=None, space=None, comment=None):
+    def attach_content(self, content, name, content_type='application/binary', page_id=None, title=None, space=None, comment=None):
         """
         Attach (upload) a file to a page, if it exists it will update the
         automatically version the new file and keep the old one.
@@ -400,22 +400,22 @@ def attach_file(self, filename, page_id=None, title=None, space=None, comment=No
         :type  space: ``str``
         :param page_id: The page id to which we would like to upload the file
         :type  page_id: ``str``
-        :param filename: The file to upload
-        :type  filename: ``str``
+        :param name: The name of the attachment
+        :type  name: ``str``
+        :param content: Contains the content which should be uplaoded
+        :type  content: ``binary``
+        :param content_type: Specify the HTTP content type. The default is
+        :type  content_type: ``str``
         :param comment: A comment describing this upload/file
         :type  comment: ``str``
         """
         page_id = self.get_page_id(space=space, title=title) if page_id is None else page_id
         type = 'attachment'
         if page_id is not None:
-            # get base name of the file to get the attachment from confluence.
-            file_base_name = os.path.basename(filename)
-            extension = os.path.splitext(filename)[-1]
-            content_type = self.content_types.get(extension, "application/binary")
-            comment = comment if comment else "Uploaded {filename}.".format(filename=filename)
+            comment = comment if comment else "Uploaded {filename}.".format(filename=name)
             data = {
                 'type': type,
-                "fileName": file_base_name,
+                "fileName": name,
                 "contentType": content_type,
                 "comment": comment,
                 "minorEdit": "true"}
@@ -424,16 +424,38 @@ def attach_file(self, filename, page_id=None, title=None, space=None, comment=No
                 'Accept': 'application/json'}
             path = 'rest/api/content/{page_id}/child/attachment'.format(page_id=page_id)
             # Check if there is already a file with the same name
-            attachments = self.get(path=path, headers=headers, params={'filename': file_base_name})
+            attachments = self.get(path=path, headers=headers, params={'filename': name})
             if attachments['size']:
                 path = path + '/' + attachments['results'][0]['id'] + '/data'
-            with open(filename, 'rb') as infile:
-                return self.post(path=path, data=data, headers=headers,
-                                 files={'file': (file_base_name, infile, content_type)})
+            return self.post(path=path, data=data, headers=headers,
+                             files={'file': (name, content, content_type)})
         else:
             log.warning("No 'page_id' found, not uploading attachments")
             return None
 
+    def attach_file(self, filename, page_id=None, title=None, space=None, comment=None):
+        """
+        Attach (upload) a file to a page, if it exists it will update the
+        automatically version the new file and keep the old one.
+        :param title: The page name
+        :type  title: ``str``
+        :param space: The space name
+        :type  space: ``str``
+        :param page_id: The page id to which we would like to upload the file
+        :type  page_id: ``str``
+        :param filename: The file to upload
+        :type  filename: ``str``
+        :param comment: A comment describing this upload/file
+        :type  comment: ``str``
+        """
+        # get base name of the file to get the attachment from confluence.
+        name = os.path.basename(filename)
+        extension = os.path.splitext(filename)[-1]
+        content_type = self.content_types.get(extension, "application/binary")
+        with open(filename, 'rb') as infile:
+            content = infile.read()
+        return self.attach_content( content, name, content_type, page_id=page_id, title=title, space=space, comment=comment )
+
     def delete_attachment(self, page_id, filename, version=None):
         """
         Remove completely a file if version is None or delete version

docs/confluence.rst

@@ -92,6 +92,10 @@ Page actions
     # automatically version the new file and keep the old one
     confluence.attach_file(filename, page_id=None, title=None, space=None, comment=None)
 
+    # Attach (upload) a content to a page, if it exists it will update the
+    # automatically version the new file and keep the old one
+    confluence.attach_content(content, name=None, content_type=None, page_id=None, title=None, space=None, comment=None)
+
     # Export page as PDF
     # api_version needs to be set to 'cloud' when exporting from Confluence Cloud. 
     confluence.export_page(page_id)

tests/test-confluence-attach.py

@@ -5,28 +5,28 @@
 from atlassian import Confluence
 
 
-class TestConfluenceAuth(unittest.TestCase):
+class TestConfluenceAttach(unittest.TestCase):
+    secret_file = '../credentials.secret'
 
-    def test_confluence_auth(self):
+    '''
+        Keep the credentials private, the file is excluded. There is an example for credentials.secret
+        See also: http://www.blacktechdiva.com/hide-api-keys/
+
+        {
+          "host" : "https://localhost:8080",
+          "username" : "john_doe",
+          "password" : "12345678"
+        }        
+    '''
+
+    def test_confluence_attach(self):
         credentials = None
-        secret_file = '../credentials.secret'
-
-        '''
-            Keep the credentials private, the file is excluded. There is an example for credentials.secret
-            See also: http://www.blacktechdiva.com/hide-api-keys/
-            
-            {
-              "host" : "https://localhost:8080",
-              "username" : "john_doe",
-              "password" : "12345678"
-            }        
-        '''
 
         try:
-            with open(secret_file) as json_file:
+            with open(self.secret_file) as json_file:
                 credentials = json.load(json_file)
         except Exception as err:
-            self.fail('[{0}]: {1}'.format(secret_file, err))
+            self.fail('[{0}]: {1}'.format(self.secret_file, err))
 
         confluence = Confluence(
             url=credentials['host'],
@@ -60,6 +60,41 @@ def test_confluence_auth(self):
         os.close(fd)
         os.remove(filename)
 
+    def test_confluence_attach_data(self):
+        credentials = None
+
+        try:
+            with open(self.secret_file) as json_file:
+                credentials = json.load(json_file)
+        except Exception as err:
+            self.fail('[{0}]: {1}'.format(self.secret_file, err))
+
+        confluence = Confluence(
+            url=credentials['host'],
+            username=credentials['username'],
+            password=credentials['password'])
+
+        # individual configuration
+        space = 'SAN'
+        title = 'atlassian-python-rest-api-wrapper'
+
+        attachment_name = os.path.basename(tempfile.mktemp())
+
+        # upload a new file
+        content = b'Hello World - Version 1'
+        result = confluence.attach_content( content, attachment_name, 'text/plain', title=title, space=space, comment='upload from unittest')
+
+        # attach_file() returns: {'results': [{'id': 'att144005326', 'type': 'attachment', ...
+        self.assertTrue('results' in result)
+        self.assertFalse('statusCode' in result)
+
+        # upload a new version of an existing file
+        content = b'Hello Universe - Version 2'
+        result = confluence.attach_content( content, attachment_name, 'text/plain', title=title, space=space, comment='upload from unittest')
+
+        # attach_file() returns: {'id': 'att144005326', 'type': 'attachment', ...
+        self.assertTrue('id' in result)
+        self.assertFalse('statusCode' in result)
 
 if __name__ == '__main__':
     unittest.main()