Source code for jira.resources

# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from __future__ import print_function
"""
This module implements the Resource classes that translate JSON from JIRA REST resources
into usable objects.
"""

import logging
import re
import time
try:  # Python 2.7+
    from logging import NullHandler
except ImportError:
    class NullHandler(logging.Handler):

        def emit(self, record):
            pass
import json

from six import iteritems
from six import string_types
from six import text_type

from jira.utils import CaseInsensitiveDict
from jira.utils import json_loads
from jira.utils import threaded_requests

__all__ = (
    'Resource',
    'Issue',
    'Comment',
    'Project',
    'Attachment',
    'Component',
    'Dashboard',
    'Filter',
    'Votes',
    'Watchers',
    'Worklog',
    'IssueLink',
    'IssueLinkType',
    'IssueType',
    'Priority',
    'Version',
    'Role',
    'Resolution',
    'SecurityLevel',
    'Status',
    'User',
    'Group',
    'CustomFieldOption',
    'RemoteLink',
    'Customer',
    'ServiceDesk',
    'RequestType',
)

logging.getLogger('jira').addHandler(NullHandler())


def get_error_list(r):
    error_list = []
    if r.status_code >= 400:
        if r.status_code == 403 and "x-authentication-denied-reason" in r.headers:
            error_list = [r.headers["x-authentication-denied-reason"]]
        elif r.text:
            try:
                response = json_loads(r)
                if 'message' in response:
                    # JIRA 5.1 errors
                    error_list = [response['message']]
                elif 'errorMessages' in response and len(response['errorMessages']) > 0:
                    # JIRA 5.0.x error messages sometimes come wrapped in this array
                    # Sometimes this is present but empty
                    errorMessages = response['errorMessages']
                    if isinstance(errorMessages, (list, tuple)):
                        error_list = errorMessages
                    else:
                        error_list = [errorMessages]
                elif 'errors' in response and len(response['errors']) > 0:
                    # JIRA 6.x error messages are found in this array.
                    error_list = response['errors'].values()
                else:
                    error_list = [r.text]
            except ValueError:
                error_list = [r.text]
    return error_list


class Resource(object):
    """Models a URL-addressable resource in the JIRA REST API.

    All Resource objects provide the following:
    ``find()`` -- get a resource from the server and load it into the current object
    (though clients should use the methods in the JIRA class instead of this method directly)
    ``update()`` -- changes the value of this resource on the server and returns a new resource object for it
    ``delete()`` -- deletes this resource from the server
    ``self`` -- the URL of this resource on the server
    ``raw`` -- dict of properties parsed out of the JSON response from the server

    Subclasses will implement ``update()`` and ``delete()`` as appropriate for the specific resource.

    All Resources have a resource path of the form:

    * ``issue``
    * ``project/{0}``
    * ``issue/{0}/votes``
    * ``issue/{0}/comment/{1}``

    where the bracketed numerals are placeholders for ID values that are filled in from the
    ``ids`` parameter to ``find()``.
    """

    JIRA_BASE_URL = '{server}/rest/{rest_path}/{rest_api_version}/{path}'

    # A prioritized list of the keys in self.raw most likely to contain a human
    # readable name or identifier, or that offer other key information.
    _READABLE_IDS = ('displayName', 'key', 'name', 'filename', 'value',
                     'scope', 'votes', 'id', 'mimeType', 'closed')

    def __init__(self, resource, options, session, base_url=JIRA_BASE_URL):
        """Initializes a generic resource.
        :param resource: The name of the resource.
        :type resource: str
        :param options: Options for the new resource
        :type options: Dict[str,str]
        :param session: Session used for the resource.
        :type session: ResilientSession
        :param base_url: The Base JIRA url.
        :type base_url: Optional[str]

        """
        self._resource = resource
        self._options = options
        self._session = session
        self._base_url = base_url

        # Explicitly define as None so we know when a resource has actually
        # been loaded
        self.raw = None

    def __str__(self):
        """Return the first value we find that is likely to be human readable.

        :rtype: str
        """
        if self.raw:
            for name in self._READABLE_IDS:
                if name in self.raw:
                    pretty_name = text_type(self.raw[name])
                    # Include any child to support nested select fields.
                    if hasattr(self, 'child'):
                        pretty_name += ' - ' + text_type(self.child)
                    return pretty_name

        # If all else fails, use repr to make sure we get something.
        return repr(self)

    def __repr__(self):
        """Identify the class and include any and all relevant values.

        :rtype: str
        """
        names = []
        if self.raw:
            for name in self._READABLE_IDS:
                if name in self.raw:
                    names.append(name + '=' + repr(self.raw[name]))
        if not names:
            return '<JIRA %s at %s>' % (self.__class__.__name__,
                                        id(self))
        return '<JIRA %s: %s>' % (self.__class__.__name__, ', '.join(names))

    def __getattr__(self, item):
        """Allow access of attributes via names.

        :param item: Attribute name
        :type item: str

        :rtype: Any

        :raises KeyError: When the attribute does not exist.
        :raises AttributeError: When attribute does not exist.

        """
        try:
            return self[item]
        except Exception as e:
            # Make sure pickling doesn't break
            #   *MORE INFO*: This conditional wouldn't be necessary if __getattr__ wasn't used. But
            #                since it is in use (no worries), we need to give the pickle.dump*
            #                methods what they expect back. They expect to either get a KeyError
            #                exception or a tuple of args to be passed to the __new__ method upon
            #                unpickling (i.e. pickle.load* methods).
            #   *NOTE*: if the __new__ method were to be implemented in this class, this may have
            #           to be removed or changed.
            if item == '__getnewargs__':
                raise KeyError(item)

            if hasattr(self, 'raw') and item in self.raw:
                return self.raw[item]
            else:
                raise AttributeError("%r object has no attribute %r (%s)" % (self.__class__, item, e))
    # def __getstate__(self):
    #     """
    #     Pickling the resource; using the raw dict
    #     """
    #     return self.raw
    #
    # def __setstate__(self, raw_pickled):
    #     """
    #     Unpickling of the resource
    #     """
    #     self._parse_raw(raw_pickled)
    #

    def find(self,
             id,
             params=None,
             ):
        """Finds a resource based on the input parameters.

        :type id: Union[Tuple[str, str], int, str]
        :type params: Optional[Dict[str, str]]

        """

        if params is None:
            params = {}

        if isinstance(id, tuple):
            path = self._resource.format(*id)
        else:
            path = self._resource.format(id)
        url = self._get_url(path)
        self._load(url, params=params)

    def _get_url(self, path):
        """ Gets the url for the specified path.

        :type path: str

        :rtype: str

        """
        options = self._options.copy()
        options.update({'path': path})
        return self._base_url.format(**options)

    def update(self, fields=None, async_=None, jira=None, notify=True, **kwargs):
        """Update this resource on the server.

        Keyword arguments are marshalled into a dict before being sent. If this
        resource doesn't support ``PUT``, a :py:exc:`.JIRAError` will be raised; subclasses that specialize this method
        will only raise errors in case of user error.

        :param fields: Fields which should be updated for the object.
        :type fields: Optional[Dict[str, Any]]
        :param async_: If true the request will be added to the queue so it can be executed later using async_run()
        :type async_: bool
        :param jira: Instance of JIRA Client
        :type jira: jira.JIRA
        :param notify: Whether or not to notify users about the update. (Default: True)
        :type notify: bool
        :type kwargs: **Any
        """
        if async_ is None:
            async_ = self._options['async']

        data = {}
        if fields is not None:
            data.update(fields)
        data.update(kwargs)

        data = json.dumps(data)

        if not notify:
            querystring = "?notifyUsers=false"
        else:
            querystring = ""

        r = self._session.put(
            self.self + querystring, data=data)
        if 'autofix' in self._options and \
                r.status_code == 400:
            user = None
            error_list = get_error_list(r)
            logging.error(error_list)
            if "The reporter specified is not a user." in error_list:
                if 'reporter' not in data['fields']:
                    logging.warning(
                        "autofix: setting reporter to '%s' and retrying the update." % self._options['autofix'])
                    data['fields']['reporter'] = {
                        'name': self._options['autofix']}

            if "Issues must be assigned." in error_list:
                if 'assignee' not in data['fields']:
                    logging.warning("autofix: setting assignee to '%s' for %s and retrying the update." % (
                        self._options['autofix'], self.key))
                    data['fields']['assignee'] = {
                        'name': self._options['autofix']}
                    # for some reason the above approach fails on Jira 5.2.11
                    # so we need to change the assignee before

            if "Issue type is a sub-task but parent issue key or id not specified." in error_list:
                logging.warning(
                    "autofix: trying to fix sub-task without parent by converting to it to bug")
                data['fields']['issuetype'] = {"name": "Bug"}
            if "The summary is invalid because it contains newline characters." in error_list:
                logging.warning("autofix: trying to fix newline in summary")
                data['fields'][
                    'summary'] = self.fields.summary.replace("/n", "")
            for error in error_list:
                if re.search(u"^User '(.*)' was not found in the system\.", error, re.U):
                    m = re.search(
                        u"^User '(.*)' was not found in the system\.", error, re.U)
                    if m:
                        user = m.groups()[0]
                    else:
                        raise NotImplemented()
                if re.search("^User '(.*)' does not exist\.", error):
                    m = re.search("^User '(.*)' does not exist\.", error)
                    if m:
                        user = m.groups()[0]
                    else:
                        raise NotImplemented()

            if user:
                logging.warning(
                    "Trying to add missing orphan user '%s' in order to complete the previous failed operation." % user)
                jira.add_user(user, 'noreply@example.com', 10100, active=False)
                # if 'assignee' not in data['fields']:
                #    logging.warning("autofix: setting assignee to '%s' and retrying the update." % self._options['autofix'])
                #    data['fields']['assignee'] = {'name': self._options['autofix']}
            # EXPERIMENTAL --->
            if async_:
                if not hasattr(self._session, '_async_jobs'):
                    self._session._async_jobs = set()
                self._session._async_jobs.add(threaded_requests.put(
                    self.self, data=json.dumps(data)))
            else:
                r = self._session.put(
                    self.self, data=json.dumps(data))

        time.sleep(self._options['delay_reload'])
        self._load(self.self)

    def delete(self, params=None):
        """Delete this resource from the server, passing the specified query parameters.

        If this resource doesn't support ``DELETE``, a :py:exc:`.JIRAError`
        will be raised; subclasses that specialize this method will only raise errors
        in case of user error.

        :param params: Parameters for the delete request.
        :type params: Optional[Dict[str, Any]]

        :rtype: Response
        """
        if self._options['async']:
            if not hasattr(self._session, '_async_jobs'):
                self._session._async_jobs = set()
            self._session._async_jobs.add(
                threaded_requests.delete(url=self.self, params=params))
        else:
            return self._session.delete(url=self.self, params=params)

    def _load(self,
              url,
              headers=CaseInsensitiveDict(),
              params=None,
              path=None,
              ):
        """ Load a resource.

        :type url: str
        :type headers: CaseInsensitiveDict
        :type params: Optional[Dict[str,str]]
        :type path: Optional[str]

        """
        r = self._session.get(url, headers=headers, params=params)
        try:
            j = json_loads(r)
        except ValueError as e:
            logging.error("%s:\n%s" % (e, r.text))
            raise e
        if path:
            j = j[path]
        self._parse_raw(j)

    def _parse_raw(self, raw):
        """Parse a raw dictionary to create a resource.

        :type raw: Dict[str, Any]
        """
        self.raw = raw
        if not raw:
            raise NotImplementedError("We cannot instantiate empty resources: %s" % raw)
        dict2resource(raw, self, self._options, self._session)

    def _default_headers(self, user_headers):
        # result = dict(user_headers)
        # result['accept'] = 'application/json'
        return CaseInsensitiveDict(self._options['headers'].items() + user_headers.items())


class Attachment(Resource):
    """An issue attachment."""

    def __init__(self, options, session, raw=None):
        Resource.__init__(self, 'attachment/{0}', options, session)
        if raw:
            self._parse_raw(raw)

    def get(self):
        """Return the file content as a string."""
        r = self._session.get(self.content, headers={'Accept': '*/*'})
        return r.content

    def iter_content(self, chunk_size=1024):
        """Return the file content as an iterable stream."""
        r = self._session.get(self.content, stream=True)
        return r.iter_content(chunk_size)


class Component(Resource):
    """A project component."""

    def __init__(self, options, session, raw=None):
        Resource.__init__(self, 'component/{0}', options, session)
        if raw:
            self._parse_raw(raw)

    def delete(self, moveIssuesTo=None):
        """Delete this component from the server.

        :param moveIssuesTo: the name of the component to which to move any issues this component is applied
        """
        params = {}
        if moveIssuesTo is not None:
            params['moveIssuesTo'] = moveIssuesTo

        super(Component, self).delete(params)


class CustomFieldOption(Resource):
    """An existing option for a custom issue field."""

    def __init__(self, options, session, raw=None):
        Resource.__init__(self, 'customFieldOption/{0}', options, session)
        if raw:
            self._parse_raw(raw)


class Dashboard(Resource):
    """A JIRA dashboard."""

    def __init__(self, options, session, raw=None):
        Resource.__init__(self, 'dashboard/{0}', options, session)
        if raw:
            self._parse_raw(raw)


class Filter(Resource):
    """An issue navigator filter."""

    def __init__(self, options, session, raw=None):
        Resource.__init__(self, 'filter/{0}', options, session)
        if raw:
            self._parse_raw(raw)


[docs]class Issue(Resource): """A JIRA issue.""" class _IssueFields(object): def __init__(self): self.attachment = None """ :type : list[Attachment] """ self.description = None """ :type : str """ self.project = None """ :type : Project """ self.comment = None """ :type : list[Comment] """ self.issuelinks = None """ :type : list[IssueLink] """ self.worklog = None """ :type : list[Worklog] """ def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}', options, session) self.fields = None """ :type: :class:`~Issue._IssueFields` """ self.id = None """ :type: int """ self.key = None """ :type: str """ if raw: self._parse_raw(raw)
[docs] def update(self, fields=None, update=None, async_=None, jira=None, notify=True, **fieldargs): """Update this issue on the server. Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value is treated as the intended value for that field -- if the fields argument is used, all other keyword arguments will be ignored. JIRA projects may contain many different issue types. Some issue screens have different requirements for fields in an issue. This information is available through the :py:meth:`.JIRA.editmeta` method. Further examples are available here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Edit+issues :param fields: a dict containing field names and the values to use :param update: a dict containing update operations to apply :param notify: query parameter notifyUsers. If true send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification. :param fieldargs: keyword arguments will generally be merged into fields, except lists, which will be merged into updates :type fields: dict :type update: dict """ data = {} if fields is not None: fields_dict = fields else: fields_dict = {} data['fields'] = fields_dict if update is not None: update_dict = update else: update_dict = {} data['update'] = update_dict for field in sorted(fieldargs.keys()): value = fieldargs[field] # apply some heuristics to make certain changes easier if isinstance(value, string_types): if field == 'assignee' or field == 'reporter': fields_dict['assignee'] = {'name': value} elif field == 'comment': if 'comment' not in update_dict: update_dict['comment'] = [] update_dict['comment'].append({ 'add': {'body': value}}) else: fields_dict[field] = value elif isinstance(value, list): if field not in update_dict: update_dict[field] = [] update_dict[field].extend(value) else: fields_dict[field] = value super(Issue, self).update(async_=async_, jira=jira, notify=notify, fields=data)
[docs] def add_field_value(self, field, value): """Add a value to a field that supports multiple values, without resetting the existing values. This should work with: labels, multiple checkbox lists, multiple select :param field: The field name :param value: The field's value :type field: str """ super(Issue, self).update(fields={"update": {field: [{"add": value}]}})
[docs] def delete(self, deleteSubtasks=False): """Delete this issue from the server. :param deleteSubtasks: if the issue has subtasks, this argument must be set to true for the call to succeed. :type deleteSubtasks: bool """ super(Issue, self).delete(params={'deleteSubtasks': deleteSubtasks})
def __eq__(self, other): """Comparison method.""" return other is not None and self.id == other.id
[docs]class Comment(Resource): """An issue comment.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/comment/{1}', options, session) if raw: self._parse_raw(raw)
[docs] def update(self, fields=None, async_=None, jira=None, body='', visibility=None): data = {} if body: data['body'] = body if visibility: data['visibility'] = visibility super(Comment, self).update(data)
class RemoteLink(Resource): """A link to a remote application from an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/remotelink/{1}', options, session) if raw: self._parse_raw(raw) def update(self, object, globalId=None, application=None, relationship=None): """Update a RemoteLink. 'object' is required. For definitions of the allowable fields for 'object' and the keyword arguments 'globalId', 'application' and 'relationship', see https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+for+Remote+Issue+Links. :param object: the link details to add (see the above link for details) :param globalId: unique ID for the link (see the above link for details) :param application: application information for the link (see the above link for details) :param relationship: relationship description for the link (see the above link for details) """ data = { 'object': object} if globalId is not None: data['globalId'] = globalId if application is not None: data['application'] = application if relationship is not None: data['relationship'] = relationship super(RemoteLink, self).update(**data) class Votes(Resource): """Vote information on an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/votes', options, session) if raw: self._parse_raw(raw)
[docs]class Watchers(Resource): """Watcher information on an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/watchers', options, session) if raw: self._parse_raw(raw)
[docs] def delete(self, username): """Remove the specified user from the watchers list.""" super(Watchers, self).delete(params={'username': username})
class TimeTracking(Resource): def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/worklog/{1}', options, session) self.remainingEstimate = None if raw: self._parse_raw(raw)
[docs]class Worklog(Resource): """Worklog on an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issue/{0}/worklog/{1}', options, session) if raw: self._parse_raw(raw)
[docs] def delete(self, adjustEstimate=None, newEstimate=None, increaseBy=None): """Delete this worklog entry from its associated issue. :param adjustEstimate: one of ``new``, ``leave``, ``manual`` or ``auto``. ``auto`` is the default and adjusts the estimate automatically. ``leave`` leaves the estimate unchanged by this deletion. :param newEstimate: combined with ``adjustEstimate=new``, set the estimate to this value :param increaseBy: combined with ``adjustEstimate=manual``, increase the remaining estimate by this amount """ params = {} if adjustEstimate is not None: params['adjustEstimate'] = adjustEstimate if newEstimate is not None: params['newEstimate'] = newEstimate if increaseBy is not None: params['increaseBy'] = increaseBy super(Worklog, self).delete(params)
class IssueLink(Resource): """Link between two issues.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issueLink/{0}', options, session) if raw: self._parse_raw(raw) class IssueLinkType(Resource): """Type of link between two issues.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issueLinkType/{0}', options, session) if raw: self._parse_raw(raw) class IssueType(Resource): """Type of an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'issuetype/{0}', options, session) if raw: self._parse_raw(raw)
[docs]class Priority(Resource): """Priority that can be set on an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'priority/{0}', options, session) if raw: self._parse_raw(raw)
class Project(Resource): """A JIRA project.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'project/{0}', options, session) if raw: self._parse_raw(raw) class Role(Resource): """A role inside a project.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'project/{0}/role/{1}', options, session) if raw: self._parse_raw(raw) def update(self, users=None, groups=None): """Add the specified users or groups to this project role. One of ``users`` or ``groups`` must be specified. :param users: a user or users to add to the role :type users: string, list or tuple :param groups: a group or groups to add to the role :type groups: string, list or tuple """ if users is not None and isinstance(users, string_types): users = (users,) if groups is not None and isinstance(groups, string_types): groups = (groups,) data = { 'id': self.id, 'categorisedActors': { 'atlassian-user-role-actor': users, 'atlassian-group-role-actor': groups}} super(Role, self).update(**data) def add_user(self, users=None, groups=None): """Add the specified users or groups to this project role. One of ``users`` or ``groups`` must be specified. :param users: a user or users to add to the role :type users: string, list or tuple :param groups: a group or groups to add to the role :type groups: string, list or tuple """ if users is not None and isinstance(users, string_types): users = (users,) if groups is not None and isinstance(groups, string_types): groups = (groups,) data = { 'user': users} self._session.post(self.self, data=json.dumps(data)) class Resolution(Resource): """A resolution for an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'resolution/{0}', options, session) if raw: self._parse_raw(raw) class SecurityLevel(Resource): """A security level for an issue or project.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'securitylevel/{0}', options, session) if raw: self._parse_raw(raw) class Status(Resource): """Status for an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'status/{0}', options, session) if raw: self._parse_raw(raw) class StatusCategory(Resource): """StatusCategory for an issue.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'statuscategory/{0}', options, session) if raw: self._parse_raw(raw) class User(Resource): """A JIRA user.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'user?username={0}', options, session) if raw: self._parse_raw(raw) def __hash__(self): """Hash calculation.""" return hash(str(self.name)) def __eq__(self, other): """Comparison.""" return str(self.name) == str(other.name) class Group(Resource): """A JIRA user group.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'group?groupname={0}', options, session) if raw: self._parse_raw(raw) def __hash__(self): """Hash calculation.""" return hash(str(self.name)) def __eq__(self, other): """Equality by name.""" return str(self.name) == str(other.name) class Version(Resource): """A version of a project.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'version/{0}', options, session) if raw: self._parse_raw(raw) def delete(self, moveFixIssuesTo=None, moveAffectedIssuesTo=None): """Delete this project version from the server. If neither of the arguments are specified, the version is removed from all issues it is attached to. :param moveFixIssuesTo: in issues for which this version is a fix version, add this argument version to the fix version list :param moveAffectedIssuesTo: in issues for which this version is an affected version, add this argument version to the affected version list """ params = {} if moveFixIssuesTo is not None: params['moveFixIssuesTo'] = moveFixIssuesTo if moveAffectedIssuesTo is not None: params['moveAffectedIssuesTo'] = moveAffectedIssuesTo return super(Version, self).delete(params) def update(self, **args): """Update this project version from the server. It is prior used to archive versions.""" data = {} for field in args: data[field] = args[field] super(Version, self).update(**data) def __eq__(self, other): """Comparison.""" return self.id == other.id and self.name == other.name # GreenHopper class GreenHopperResource(Resource): """A generic GreenHopper resource.""" AGILE_BASE_URL = '{server}/rest/{agile_rest_path}/{agile_rest_api_version}/{path}' GREENHOPPER_REST_PATH = "greenhopper" """ Old, private API. Deprecated and will be removed from JIRA on the 1st February 2016. """ AGILE_EXPERIMENTAL_REST_PATH = "greenhopper/experimental-api" """ Experimental API available in JIRA Agile 6.7.3 - 6.7.6, basically the same as Public API """ AGILE_BASE_REST_PATH = "agile" """ Public API introduced in JIRA Agile 6.7.7. """ def __init__(self, path, options, session, raw): self.self = None Resource.__init__(self, path, options, session, self.AGILE_BASE_URL) if raw: self._parse_raw(raw) # Old GreenHopper API did not contain self - create it for backward compatibility. if not self.self: self.self = self._get_url(path.format(raw['id'])) class Sprint(GreenHopperResource): """A GreenHopper sprint.""" def __init__(self, options, session, raw=None): GreenHopperResource.__init__(self, 'sprint/{0}', options, session, raw) def find(self, id, params=None): if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH: Resource.find(self, id, params) else: # Old, private GreenHopper API had non-standard way of loading Sprint url = self._get_url('sprint/%s/edit/model' % id) self._load(url, params=params, path='sprint') class Board(GreenHopperResource): """A GreenHopper board.""" def __init__(self, options, session, raw=None): path = 'rapidview/{0}' if options['agile_rest_path'] == self.GREENHOPPER_REST_PATH else 'board/{id}' GreenHopperResource.__init__(self, path, options, session, raw) def delete(self, params=None): if self._options['agile_rest_path'] != GreenHopperResource.GREENHOPPER_REST_PATH: raise NotImplementedError('JIRA Agile Public API does not support Board removal') Resource.delete(self, params) # Service Desk class Customer(Resource): """A Service Desk customer.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'customer', options, session, '{server}/rest/servicedeskapi/{path}') if raw: self._parse_raw(raw) class ServiceDesk(Resource): """A Service Desk.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'servicedesk/{0}', options, session, '{server}/rest/servicedeskapi/{path}') if raw: self._parse_raw(raw) class RequestType(Resource): """A Service Desk Request Type.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'servicedesk/{0}/requesttype', options, session, '{server}/rest/servicedeskapi/{path}') if raw: self._parse_raw(raw) # Utilities def dict2resource(raw, top=None, options=None, session=None): """Convert a dictionary into a Jira Resource object. Recursively walks a dict structure, transforming the properties into attributes on a new ``Resource`` object of the appropriate type (if a ``self`` link is present) or a ``PropertyHolder`` object (if no ``self`` link is present). """ if top is None: top = PropertyHolder(raw) seqs = tuple, list, set, frozenset for i, j in iteritems(raw): if isinstance(j, dict): if 'self' in j: resource = cls_for_resource(j['self'])(options, session, j) setattr(top, i, resource) elif i == 'timetracking': setattr(top, 'timetracking', TimeTracking(options, session, j)) else: setattr( top, i, dict2resource(j, options=options, session=session)) elif isinstance(j, seqs): seq_list = [] for seq_elem in j: if isinstance(seq_elem, dict): if 'self' in seq_elem: resource = cls_for_resource(seq_elem['self'])( options, session, seq_elem) seq_list.append(resource) else: seq_list.append( dict2resource(seq_elem, options=options, session=session)) else: seq_list.append(seq_elem) setattr(top, i, seq_list) else: setattr(top, i, j) return top resource_class_map = { # JIRA specific resources r'attachment/[^/]+$': Attachment, r'component/[^/]+$': Component, r'customFieldOption/[^/]+$': CustomFieldOption, r'dashboard/[^/]+$': Dashboard, r'filter/[^/]$': Filter, r'issue/[^/]+$': Issue, r'issue/[^/]+/comment/[^/]+$': Comment, r'issue/[^/]+/votes$': Votes, r'issue/[^/]+/watchers$': Watchers, r'issue/[^/]+/worklog/[^/]+$': Worklog, r'issueLink/[^/]+$': IssueLink, r'issueLinkType/[^/]+$': IssueLinkType, r'issuetype/[^/]+$': IssueType, r'priority/[^/]+$': Priority, r'project/[^/]+$': Project, r'project/[^/]+/role/[^/]+$': Role, r'resolution/[^/]+$': Resolution, r'securitylevel/[^/]+$': SecurityLevel, r'status/[^/]+$': Status, r'statuscategory/[^/]+$': StatusCategory, r'user\?(username|accountId).+$': User, r'group\?groupname.+$': Group, r'version/[^/]+$': Version, # GreenHopper specific resources r'sprints/[^/]+$': Sprint, r'views/[^/]+$': Board} class UnknownResource(Resource): """A Resource from JIRA that is not (yet) supported.""" def __init__(self, options, session, raw=None): Resource.__init__(self, 'unknown{0}', options, session) if raw: self._parse_raw(raw) def cls_for_resource(resource_literal): for resource in resource_class_map: if re.search(resource, resource_literal): return resource_class_map[resource] else: # Generic Resource cannot directly be used b/c of different constructor signature return UnknownResource class PropertyHolder(object): def __init__(self, raw): __bases__ = raw # noqa