#!/usr/bin/env python
# -*- coding: utf-8 -*-
###############################################################################
# The MIT License
#
# Copyright (c) 2016 Grigory Chernyshev
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
###############################################################################
import json
from yagocd.resources import Base, BaseManager
from yagocd.util import since
@since('15.2.0')
[docs]class UserManager(BaseManager):
"""
The users API allows users with administrator role to manage users.
`Official documentation. <https://api.go.cd/current/#users>`_
:versionadded: 15.2.0.
"""
RESOURCE_PATH = '{base_api}/users'
CURRENT_USER_PATH = '{base_api}/current_user'
def __iter__(self):
"""
Method add iterator protocol for the manager.
:return: an array of user objects :class:`yagocd.resources.user.UserEntity`.
:rtype: list of yagocd.resources.user.UserEntity
"""
return iter(self.list())
def __getitem__(self, login):
"""
Method add possibility to get plugin info by the name using dictionary like syntax.
:param login: login name.
:return: a user object :class:`yagocd.resources.user.UserEntity`.
:rtype: yagocd.resources.user.UserEntity
"""
return self.get(login=login)
[docs] def list(self):
"""
Lists all available users.
:versionadded: 15.2.0.
:return: an array of user objects :class:`yagocd.resources.user.UserEntity`.
:rtype: list of yagocd.resources.user.UserEntity
"""
response = self._session.get(
path=self.RESOURCE_PATH.format(base_api=self.base_api),
)
users = list()
for data in response.json().get('_embedded', {}).get('users', {}):
users.append(UserEntity(session=self._session, data=data))
return users
[docs] def get(self, login):
"""
Gets a user by its login name.
:versionadded: 15.2.0.
:param login: login name.
:return: a user object :class:`yagocd.resources.user.UserEntity`.
:rtype: yagocd.resources.user.UserEntity
"""
response = self._session.get(
path=self._session.urljoin(self.RESOURCE_PATH, login).format(base_api=self.base_api)
)
return UserEntity(session=self._session, data=response.json())
@since('17.5.0')
[docs] def current(self):
"""
Gets the current user.
:versionadded: 17.5.0.
:return: a current user object :class:`yagocd.resources.user.UserEntity`.
:rtype: yagocd.resources.user.UserEntity
"""
response = self._session.get(
path=self.CURRENT_USER_PATH.format(base_api=self.base_api)
)
return UserEntity(session=self._session, data=response.json())
@since('15.3.0')
[docs] def create(self, options):
"""
Creates a user.
:versionadded: 15.3.0.
TODO: can't make this one work: returns 404 all the time.
:param options: dictionary of parameters for creating a user.
:return: a user object :class:`yagocd.resources.user.UserEntity`.
:rtype: yagocd.resources.user.UserEntity
"""
response = self._session.post(
path=self.RESOURCE_PATH.format(
base_api=self.base_api
),
data=json.dumps(options),
headers={
'Content-Type': 'application/json'
}
)
return UserEntity(session=self._session, data=response.json())
[docs] def update(self, login, options):
"""
Update some attributes of a user.
:versionadded: 15.2.0.
:param login: login name.
:param options: dictionary of parameters for updating a user.
:return: the updated user object :class:`yagocd.resources.user.UserEntity`.
:rtype: yagocd.resources.user.UserEntity
"""
response = self._session.patch(
path=self._session.urljoin(self.RESOURCE_PATH, login).format(base_api=self.base_api),
data=json.dumps(options),
headers={
'Content-Type': 'application/json'
}
)
return UserEntity(session=self._session, data=response.json())
@since('17.5.0')
[docs] def update_current(self, options):
"""
Update some attributes of the current user.
:versionadded: 17.5.0.
:param options:
:return:
"""
response = self._session.patch(
path=self.CURRENT_USER_PATH.format(base_api=self.base_api),
data=json.dumps(options),
headers={
'Content-Type': 'application/json'
}
)
return UserEntity(session=self._session, data=response.json())
[docs] def delete(self, login):
"""
Deletes a user.
:versionadded: 15.2.0.
:param login: login name.
:return: a message confirmation if the user was deleted.
"""
response = self._session.delete(
path=self._session.urljoin(self.RESOURCE_PATH, login).format(base_api=self.base_api)
)
return response.json().get('message')
[docs]class UserEntity(Base):
"""
The user object.
"""
pass