Feature/versions (#34)

Feature/versions

Author: uilianries

bintray/bintray.py

@@ -3,7 +3,6 @@
 
     https://bintray.com/docs/api
 """
-import json
 import os
 
 from bintray.requester import Requester
@@ -1066,3 +1065,130 @@ def delete_ip_restrictions(self, subject, repo):
         response = self._requester.delete(url)
         self._logger.info("Update successfully")
         return response
+
+    # Versions
+
+    def get_version(self, subject, repo, package, version="_latest", attribute_values=True):
+        """ Get general information about a specified version, or query for the latest version that
+            has at least one file published to it.
+
+        :param subject: repository owner
+        :param repo: repository name
+        :param package: package name
+        :param version: package version
+        :param attribute_values: show attributes
+        :return: request response + package version information
+        """
+        url = "{}/packages/{}/{}/{}/versions/{}".format(Bintray.BINTRAY_URL, subject, repo,
+                                                        package, version)
+        params = {"attribute_values": bool_to_number(attribute_values)}
+        response = self._requester.get(url, params=params)
+        self._logger.info("Get successfully")
+        return response
+
+    def create_version(self, subject, repo, package, version, description=None,
+                       released=None, github_release_notes_file=None,
+                       github_use_tag_release_notes=None, vcs_tag=None):
+        """ Creates a new version in the specified package (user has to be owner of the package)
+
+            Security: Authenticated user with 'publish' permission, or package read/write
+                      entitlement.
+
+        :param subject: repository owner
+        :param repo: repository name
+        :param package: package name
+        :param version: version name
+        :param description: version description
+        :param released: release date ISO8601
+        :param github_release_notes_file: file path for release notes e.g. RELEASE.txt
+        :param github_use_tag_release_notes: True when contain release notes file
+        :param vcs_tag: tag name in VCS
+        :return: request response
+        """
+        url = "{}/packages/{}/{}/{}/versions".format(Bintray.BINTRAY_URL, subject, repo, package)
+        json_data = {'name': version}
+        if isinstance(description, str):
+            json_data["desc"] = description
+        if isinstance(released, str):
+            json_data["released"] = released
+        if isinstance(github_release_notes_file, str):
+            json_data["github_release_notes_file"] = github_release_notes_file
+        if isinstance(github_use_tag_release_notes, bool):
+            json_data["github_use_tag_release_notes"] = github_use_tag_release_notes
+        if isinstance(vcs_tag, str):
+            json_data["vcs_tag"] = vcs_tag
+
+        response = self._requester.post(url, json=json_data)
+        self._logger.info("Create successfully")
+        return response
+
+    def delete_version(self, subject, repo, package, version):
+        """ Delete the specified version
+
+            Security: Authenticated user with 'publish' permission, or package read/write
+                      entitlement.
+
+        param subject: repository owner
+        :param repo: repository name
+        :param package: package name
+        :param version: version to be deleted
+        :return: request response
+        """
+        url = "{}/packages/{}/{}/{}/versions/{}".format(Bintray.BINTRAY_URL, subject, repo, package,
+                                                        version)
+
+        response = self._requester.delete(url)
+        self._logger.info("Delete successfully")
+        return response
+
+    def update_version(self, subject, repo, package, version, description=None,
+                        github_release_notes_file=None, github_use_tag_release_notes=None,
+                        vcs_tag=None):
+        """ Update the information of the specified version
+
+            Security: Authenticated user with 'publish' permission, or package read/write
+                      entitlement.
+
+        :param subject: repository owner
+        :param repo: repository name
+        :param package: package name
+        :param version: version name to be updated
+        :param description: version description
+        :param github_release_notes_file: file path for release notes e.g. RELEASE.txt
+        :param github_use_tag_release_notes: True when contain release notes file
+        :param vcs_tag: tag name in VCS
+        :return: request response
+        """
+        url = "{}/packages/{}/{}/{}/versions/{}".format(Bintray.BINTRAY_URL, subject, repo,
+                                                        package, version)
+        json_data = {}
+        if isinstance(description, str):
+            json_data["desc"] = description
+        if isinstance(github_release_notes_file, str):
+            json_data["github_release_notes_file"] = github_release_notes_file
+        if isinstance(github_use_tag_release_notes, bool):
+            json_data["github_use_tag_release_notes"] = github_use_tag_release_notes
+        if isinstance(vcs_tag, str):
+            json_data["vcs_tag"] = vcs_tag
+
+        if not json_data:
+            raise ValueError("At lease one parameter must be filled.")
+
+        response = self._requester.patch(url, json=json_data)
+        self._logger.info("Create successfully")
+        return response
+
+    def version_for_file(self, subject, repo, file_path):
+        """ Get general information about the version a repository file is associated with.
+
+            Security: Non-authenticated user.
+
+        :param subject: repository owner
+        :param repo: repository name
+        :param file_path: associated file path
+        :return: request response
+        """
+        url = "{}/file_version/{}/{}/{}".format(Bintray.BINTRAY_URL, subject, repo, file_path)
+        response = self._requester.get(url)
+        self._logger.info("Get successfully")
+        return response

bintray/utils.py

@@ -7,4 +7,4 @@ def bool_to_number(value):
     :param value: Any boolean value
     :return: "1" when True. Otherwise, "0"
     """
-    return "1" if value else "0"
+    return 1 if value else 0

tests/test_versions.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+import datetime
+import pytest
+from bintray.bintray import Bintray
+
+
+PACKAGE_VERSION = None
+
+@pytest.fixture
+def create_version():
+    global PACKAGE_VERSION
+    bintray = Bintray()
+    now = datetime.datetime.now()
+    PACKAGE_VERSION = now.strftime("%Y%m%d%H%M%S%f")
+    released = now.strftime("%Y-%m-%d")
+
+    return bintray.create_version("uilianries", "generic", "statistics", version=PACKAGE_VERSION,
+                                  released=released, vcs_tag="0.1.0")
+
+
+def test_get_version():
+    bintray = Bintray()
+    response = bintray.get_version("uilianries", "generic", "statistics", version="_latest")
+    assert response.get("error") == False
+    assert response.get("name") == "test"
+    assert response.get("statusCode") == 200
+
+
+def test_create_version(create_version):
+    assert create_version.get("error") == False
+    assert create_version.get("name") == PACKAGE_VERSION
+    assert create_version.get("statusCode") == 201
+
+
+def test_delete_version(create_version):
+    bintray = Bintray()
+    response = bintray.delete_version("uilianries", "generic", "statistics",
+                                      version=PACKAGE_VERSION)
+    assert {'error': False, 'message': 'success', 'statusCode': 200} == response
+
+
+def test_update_version(create_version):
+    bintray = Bintray()
+    response = bintray.update_version("uilianries", "generic", "statistics",
+                                      version=PACKAGE_VERSION, description="foobar",
+                                      vcs_tag="0.1.1")
+    assert {'error': False, 'message': 'success', 'statusCode': 200} == response
+
+
+def test_version_for_file():
+    bintray = Bintray()
+    response = bintray.version_for_file("uilianries", "generic", "packages.json")
+    assert response.get("error") == False
+    assert response.get("statusCode") == 200