FilesExpand file tree

 develop

/

deployment.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

125 lines (92 loc) · 4.47 KB

 develop

/

deployment.py

Copy path

Top

File metadata and controls

• Code
• Blame

125 lines (92 loc) · 4.47 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

# -*- coding: utf-8 -*-

from __future__ import unicode_literals

from ..models import GitHubCore

from ..users import User

class Deployment(GitHubCore):

def _update_attributes(self, deployment):

self._api = deployment.get('url')

#: GitHub's id of this deployment

self.id = deployment.get('id')

#: SHA of the branch on GitHub

self.sha = deployment.get('sha')

#: The reference used to create the Deployment, e.g.,

#: `deploy-20140526`

self.ref = deployment.get('ref')

#: User object representing the creator of the deployment

self.creator = deployment.get('creator')

if self.creator:

self.creator = User(self.creator, self)

#: JSON string payload of the Deployment

self.payload = deployment.get('payload')

#: Date the Deployment was created

self.created_at = self._strptime(deployment.get('created_at'))

#: Date the Deployment was updated

self.updated_at = self._strptime(deployment.get('updated_at'))

#: Description of the deployment

self.description = deployment.get('description')

#: Target for the deployment, e.g., 'production', 'staging'

self.environment = deployment.get('environment')

#: URL to get the statuses of this deployment

self.statuses_url = deployment.get('statuses_url')

def _repr(self):

return '<Deployment [{0} @ {1}]>'.format(self.id, self.sha)

def create_status(self, state, target_url=None, description=None):

"""Create a new deployment status for this deployment.

:param str state: (required), The state of the status. Can be one of

``pending``, ``success``, ``error``, or ``failure``.

:param str target_url: The target URL to associate with this status.

This URL should contain output to keep the user updated while the

task is running or serve as historical information for what

happened in the deployment. Default: ''.

:param str description: A short description of the status. Default: ''.

:return: partial :class:`DeploymentStatus <DeploymentStatus>`

"""

json = None

if state in ('pending', 'success', 'error', 'failure'):

data = {'state': state, 'target_url': target_url,

'description': description}

self._remove_none(data)

response = self._post(self.statuses_url, data=data)

json = self._json(response, 201)

return self._instance_or_null(DeploymentStatus, json)

def statuses(self, number=-1, etag=None):

"""Iterate over the deployment statuses for this deployment.

:param int number: (optional), the number of statuses to return.

Default: -1, returns all statuses.

:param str etag: (optional), the ETag header value from the last time

you iterated over the statuses.

:returns: generator of :class:`DeploymentStatus`\ es

"""

i = self._iter(int(number), self.statuses_url, DeploymentStatus,

etag=etag)

return i

class DeploymentStatus(GitHubCore):

def _update_attributes(self, status):

self._api = status.get('url')

#: GitHub's id for this deployment status

self.id = status.get('id')

#: State of the deployment status

self.state = status.get('state')

#: Creater of the deployment status

self.creator = status.get('creator')

if self.creator:

self.creator = User(self.creator, self)

#: JSON payload as a string

self.payload = status.get('payload', {})

#: Target URL of the deployment

self.target_url = status.get('target_url')

#: Date the deployment status was created

self.created_at = self._strptime(status.get('created_at'))

#: Date the deployment status was updated

self.updated_at = self._strptime(status.get('updated_at'))

#: Description of the deployment

self.description = status.get('description')

#: :class:`Deployment` representing the deployment this status is

#: associated with

self.deployment = status.get('deployment')

if self.deployment:

self.deployment = Deployment(self.deployment, self)

#: URL for the deployment this status is associated with

self.deployment_url = status.get('deployment_url')

def _repr(self):

return '<DeploymentStatus [{0}]>'.format(self.id)