Add support for deployment statuses (#1588)

* Added DeploymentStatus class
* Added stubs for DeploymentStatus class
* Fixed headers for DeploymentStatus.py
* Added get/list/create deployment status methods
* Added DeploymentStatus repr
* Added attribute check tests for DeploymentStatus
* Added "create deployment status" test
* Added test for Deployment.get_statuses()
* Added Deployment.get_status() method

Fixes #1586

github/Consts.py

@@ -120,3 +120,6 @@ issueTimelineEventsPreview = "application/vnd.github.mockingbird-preview"
 
 # https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository
 teamRepositoryPermissions = "application/vnd.github.v3.repository+json"
+
+# https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/
+deploymentEnhancementsPreview = "application/vnd.github.ant-man-preview+json"

github/Deployment.py

@@ -3,6 +3,7 @@
 ############################ Copyrights and license ############################
 #                                                                              #
 # Copyright 2020 Steve Kowalik <steven@wedontsleep.org>                        #
+# Copyright 2020 Colby Gallup <colbygallup@gmail.com>                          #
 #                                                                              #
 # This file is part of PyGithub.                                               #
 # http://pygithub.readthedocs.io/                                              #
@@ -22,6 +23,8 @@
 #                                                                              #
 ################################################################################
 
+import github.Consts
+import github.DeploymentStatus
 import github.GithubObject
 
 
@@ -137,6 +140,66 @@ class Deployment(github.GithubObject.CompletableGithubObject):
         self._completeIfNotSet(self._repository_url)
         return self._repository_url.value
 
+    def get_statuses(self):
+        """
+        :calls: `GET /repos/:owner/deployments/:deployment_id/statuses <https://developer.github.com/v3/repos/deployments/#list-deployment-statuses>`_
+        :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.DeploymentStatus.DeploymentStatus`
+        """
+        return github.PaginatedList.PaginatedList(
+            github.DeploymentStatus.DeploymentStatus,
+            self._requester,
+            self.url + "/statuses",
+            None,
+        )
+
+    def get_status(self, id_):
+        """
+        :calls: `GET /repos/:owner/deployments/:deployment_id/statuses/:status_id  <https://developer.github.com/v3/repos/deployments/#get-a-deployment-status>`_
+        :param id_: int
+        :rtype: :class:`github.DeploymentStatus.DeploymentStatus`
+        """
+        assert isinstance(id_, int), id_
+        headers, data = self._requester.requestJsonAndCheck(
+            "GET",
+            self.url + "/statuses/" + str(id_),
+            headers={"Accept": github.Consts.deploymentEnhancementsPreview},
+        )
+        return github.DeploymentStatus.DeploymentStatus(
+            self._requester, headers, data, completed=True
+        )
+
+    def create_status(
+        self,
+        state,
+        target_url=github.GithubObject.NotSet,
+        description=github.GithubObject.NotSet,
+    ):
+        """
+        :calls: `POST /repos/:owner/:repo/deployments/:deployment_id/statuses <https://developer.github.com/v3/repos/deployments/#create-a-deployment-status>`_
+        :param: state: string
+        :param: target_url: string
+        :param: description: string
+        :rtype: :class:`github.DeploymentStatus.DeploymentStatus`
+        """
+        assert isinstance(state, str), state
+        assert target_url is github.GithubObject.NotSet or isinstance(
+            target_url, str
+        ), target_url
+        assert description is github.GithubObject.NotSet or isinstance(
+            description, str
+        ), target_url
+        post_parameters = {"state": state}
+        if target_url is not github.GithubObject.NotSet:
+            post_parameters["target_url"] = target_url
+        if description is not github.GithubObject.NotSet:
+            post_parameters["description"] = description
+        headers, data = self._requester.requestJsonAndCheck(
+            "POST", self.url + "/statuses", input=post_parameters,
+        )
+        return github.DeploymentStatus.DeploymentStatus(
+            self._requester, headers, data, completed=True
+        )
+
     def _initAttributes(self):
         self._id = github.GithubObject.NotSet
         self._url = github.GithubObject.NotSet

github/Deployment.pyi

@@ -1,13 +1,23 @@
 from datetime import datetime
-from typing import Any, Dict
+from typing import Any, Dict, Union
 
-from github.GithubObject import CompletableGithubObject
+from github.DeploymentStatus import DeploymentStatus
+from github.GithubObject import CompletableGithubObject, _NotSetType
 from github.NamedUser import NamedUser
+from github.PaginatedList import PaginatedList
 
 class Deployment(CompletableGithubObject):
     def __repr__(self) -> str: ...
     def _initAttributes(self) -> None: ...
     def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
+    def get_statuses(self) -> PaginatedList[DeploymentStatus]: ...
+    def get_status(self, id_: int) -> DeploymentStatus: ...
+    def create_status(
+        self,
+        state: str,
+        target_url: Union[str, _NotSetType] = ...,
+        description: Union[str, _NotSetType] = ...,
+    ) -> DeploymentStatus: ...
     @property
     def id(self) -> int: ...
     @property

github/DeploymentStatus.py

@@ -0,0 +1,176 @@
+# -*- coding: utf-8 -*-
+
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2020 Colby Gallup <colbygallup@gmail.com>                          #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+import github.GithubObject
+
+
+class DeploymentStatus(github.GithubObject.CompletableGithubObject):
+    """
+    This class represents Deployment Statuses. The reference can be found here https://developer.github.com/v3/repos/deployments/
+    """
+
+    def __repr__(self):
+        return self.get__repr__({"id": self._id.value, "url": self._url.value})
+
+    @property
+    def created_at(self):
+        """
+        :type: datetime.datetime
+        """
+        self._completeIfNotSet(self._created_at)
+        return self._created_at.value
+
+    @property
+    def creator(self):
+        """
+        :type: :class:`github.NamedUser.NamedUser`
+        """
+        self._completeIfNotSet(self._creator)
+        return self._creator.value
+
+    @property
+    def deployment_url(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._deployment_url)
+        return self._deployment_url.value
+
+    @property
+    def description(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._description)
+        return self._description.value
+
+    @property
+    def environment(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._environment)
+        return self._environment.value
+
+    @property
+    def repository_url(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._repository_url)
+        return self._repository_url.value
+
+    @property
+    def state(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._state)
+        return self._state.value
+
+    @property
+    def target_url(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._target_url)
+        return self._target_url.value
+
+    @property
+    def updated_at(self):
+        """
+        :type: datetime.datetime
+        """
+        self._completeIfNotSet(self._updated_at)
+        return self._updated_at.value
+
+    @property
+    def url(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._url)
+        return self._url.value
+
+    @property
+    def id(self):
+        """
+        :type: int
+        """
+        self._completeIfNotSet(self._id)
+        return self._id.value
+
+    @property
+    def node_id(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._node_id)
+        return self._node_id.value
+
+    def _initAttributes(self):
+        self._created_at = github.GithubObject.NotSet
+        self._creator = github.GithubObject.NotSet
+        self._deployment_url = github.GithubObject.NotSet
+        self._description = github.GithubObject.NotSet
+        self._environment = github.GithubObject.NotSet
+        self._repository_url = github.GithubObject.NotSet
+        self._state = github.GithubObject.NotSet
+        self._target_url = github.GithubObject.NotSet
+        self._updated_at = github.GithubObject.NotSet
+        self._url = github.GithubObject.NotSet
+        self._id = github.GithubObject.NotSet
+        self._node_id = github.GithubObject.NotSet
+
+    def _useAttributes(self, attributes):
+        if "url" in attributes:  # pragma no branch
+            self._url = self._makeStringAttribute(attributes["url"])
+        if "id" in attributes:  # pragma no branch
+            self._id = self._makeIntAttribute(attributes["id"])
+        if "node_id" in attributes:  # pragma no branch
+            self._node_id = self._makeStringAttribute(attributes["node_id"])
+        if "created_at" in attributes:  # pragma no branch
+            self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
+        if "creator" in attributes:  # pragma no branch
+            self._creator = self._makeClassAttribute(
+                github.NamedUser.NamedUser, attributes["creator"]
+            )
+        if "deployment_url" in attributes:  # pragma no branch
+            self._deployment_url = self._makeStringAttribute(
+                attributes["deployment_url"]
+            )
+        if "description" in attributes:  # pragma no branch
+            self._description = self._makeStringAttribute(attributes["description"])
+        if "environment" in attributes:  # pragma no branch
+            self._environment = self._makeStringAttribute(attributes["environment"])
+        if "repository_url" in attributes:  # pragma no branch
+            self._repository_url = self._makeStringAttribute(
+                attributes["repository_url"]
+            )
+        if "state" in attributes:  # pragma no branch
+            self._state = self._makeStringAttribute(attributes["state"])
+        if "target_url" in attributes:  # pragma no branch
+            self._target_url = self._makeStringAttribute(attributes["target_url"])
+        if "updated_at" in attributes:  # pragma no branch
+            self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])

github/DeploymentStatus.pyi

@@ -0,0 +1,35 @@
+from datetime import datetime
+from typing import Any, Dict
+
+from github.GithubObject import CompletableGithubObject
+from github.NamedUser import NamedUser
+
+
+class DeploymentStatus(CompletableGithubObject):
+    def __repr__(self) -> str: ...
+    def _initAttributes(self) -> None: ...
+    def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
+    @property
+    def created_at(self) -> datetime: ...
+    @property
+    def creator(self) -> NamedUser: ...
+    @property
+    def deployment_url(self) -> str: ...
+    @property
+    def description(self) -> str: ...
+    @property
+    def environment(self) -> str: ...
+    @property
+    def repository_url(self) -> str: ...
+    @property
+    def state(self) -> str: ...
+    @property
+    def target_url(self) -> str: ...
+    @property
+    def updated_at(self) -> datetime: ...
+    @property
+    def url(self) -> str: ...
+    @property
+    def id(self) -> int: ...
+    @property
+    def node_id(self) -> str: ...