Merge #12 'services/issues'

5 files changed, 546 insertions, 0 deletions

diff --git a/pygithub3/services/issues/__init__.py b/pygithub3/services/issues/__init__.py
new file mode 100644
index 0000000..7851e6f
--- /dev/null
+++ b/pygithub3/services/issues/__init__.py
@@ -0,0 +1,121 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service, MimeTypeMixin
+from .comments import Comments
+from .events import Events
+from .labels import Labels
+from .milestones import Milestones
+
+
+class Issue(Service, MimeTypeMixin):
+    """ Consume `Issues API <http://developer.github.com/v3/issues>`_ """
+
+    def __init__(self, **config):
+        self.comments = Comments(**config)
+        self.events = Events(**config)
+        self.labels = Labels(**config)
+        self.milestones = Milestones(**config)
+        super(Issue, self).__init__(**config)
+
+    def list(self, filter='assigned', state='open', labels='', sort='created',
+            direction='desc', since=None):
+        """ List your issues
+
+        :param str filter: 'assigned', 'created', 'mentioned' or 'subscribed'
+        :param str state: 'open' or 'closed'
+        :param str labels: List of comma separated Label names. e.g: bug,ui,
+                           @high
+        :param str sort: 'created', 'updated' or 'comments'
+        :param str direction: 'asc' or 'desc'
+        :param datetime since: Date filter (datetime or str in ISO 8601)
+        :returns: A :doc:`result`
+
+        .. warning::
+            You must be authenticated
+        """
+        params = dict(filter=filter, state=state, labels=labels, sort=sort,
+            direction=direction)
+        self._normalize_date('since', params)
+        request = self.request_builder('issues.list')
+        return self._get_result(request, **params)
+
+    def list_by_repo(self, user=None, repo=None, milestone='*', state='open',
+            assignee='*', mentioned='', labels='', sort='created',
+            direction='desc', since=None):
+        """ List issues for a repo
+
+        :param str milestone: Milestone ID, 'none' or '*'
+        :param str state: 'open' or 'closed'
+        :param str assignee: Username, 'none' or '*'
+        :param str mentioned: Username
+        :param str labels: List of comma separated Label names. e.g: bug,ui,
+                           @high
+        :param str sort: 'created', 'updated' or 'comments'
+        :param str direction: 'asc' or 'desc'
+        :param datetime since: Date filter (datetime or str in ISO 8601)
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        params = dict(milestone=milestone, state=state, assignee=assignee,
+            mentioned=mentioned, labels=labels, sort=sort, direction=direction)
+        self._normalize_date('since', params)
+        request = self.make_request('issues.list_by_repo', user=user,
+            repo=repo)
+        return self._get_result(request, **params)
+
+    def get(self, number, user=None, repo=None):
+        """ Get a single issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.get', user=user, repo=repo,
+            number=number)
+        return self._get(request)
+
+    def create(self, data, user=None, repo=None):
+        """ Create an issue
+
+        :param dict data: Input. See `github issues doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+
+        ::
+
+            issues_service.create(dict(title='My test issue',
+                body='This needs to be fixed ASAP.',
+                assignee='copitux'))
+        """
+        request = self.make_request('issues.create', user=user, repo=repo,
+            body=data)
+        return self._post(request)
+
+    def update(self, number, data, user=None, repo=None):
+        """ Update an issue
+
+        :param int number: Issue number
+        :param dict data: Input. See `github issues doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.update', user=user, repo=repo,
+            number=number, body=data)
+        return self._patch(request)
diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py
new file mode 100644
index 0000000..54d4287
--- /dev/null
+++ b/pygithub3/services/issues/comments.py
@@ -0,0 +1,90 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service, MimeTypeMixin
+
+class Comments(Service, MimeTypeMixin):
+    """ Consume `Comments API
+    <http://developer.github.com/v3/issues/comments>`_ """
+
+    def list(self, number, user=None, repo=None):
+        """ List comments for an issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.comments.list', user=user,
+            repo=repo, number=number)
+        return self._get_result(request)
+
+    def get(self, id, user=None, repo=None):
+        """ Get a single comment
+
+        :param int id: Comment id
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.comments.get', user=user,
+            repo=repo, id=id)
+        return self._get(request)
+
+    def create(self, number, message, user=None, repo=None):
+        """ Create a comment on an issue
+
+        :param int number: Issue number
+        :param str message: Comment message
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.comments.create', user=user,
+            repo=repo, number=number, body={'body': message})
+        return self._post(request)
+
+    def update(self, id, message, user=None, repo=None):
+        """ Update a comment on an issue
+
+        :param int id: Issue id
+        :param str message: Comment message
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.comments.edit', user=user,
+            repo=repo, id=id, body={'body': message})
+        return self._patch(request)
+
+    def delete(self, id, user=None, repo=None):
+        """ Delete a single comment
+
+        :param int id: Comment id
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.comments.delete', user=user,
+            repo=repo, id=id)
+        self._delete(request)
diff --git a/pygithub3/services/issues/events.py b/pygithub3/services/issues/events.py
new file mode 100644
index 0000000..92bb332
--- /dev/null
+++ b/pygithub3/services/issues/events.py
@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+
+class Events(Service):
+    """ Consume `Events API
+    <http://developer.github.com/v3/issues/events>`_ """
+
+    def list_by_issue(self, number, user=None, repo=None):
+        """ List events for an issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+        """
+        request = self.make_request('issues.events.list_by_issue',
+            user=user, repo=repo, number=number)
+        return self._get_result(request)
+
+    def list_by_repo(self, user=None, repo=None):
+        """ List events for a repository
+
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+        """
+        request = self.make_request('issues.events.list_by_repo',
+            user=user, repo=repo)
+        return self._get_result(request)
+
+    def get(self, id, user=None, repo=None):
+        """ Get a single event
+
+        :param int id: Comment id
+        :param str user: Username
+        :param str repo: Repo name
+        """
+        request = self.make_request('issues.events.get', user=user,
+            repo=repo, id=id)
+        return self._get(request)
diff --git a/pygithub3/services/issues/labels.py b/pygithub3/services/issues/labels.py
new file mode 100644
index 0000000..d1119d3
--- /dev/null
+++ b/pygithub3/services/issues/labels.py
@@ -0,0 +1,197 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+
+
+class Labels(Service):
+    """ Consume `Labels API
+    <http://developer.github.com/v3/issues/labels>`_ """
+
+    def list(self, user=None, repo=None):
+        """ Get repository's labels
+
+        :param str user: Username
+        :param str repo: Repository
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.list', user=user, repo=repo)
+        return self._get_result(request)
+
+    def get(self, name, user=None, repo=None):
+        """ Get a single label
+
+        :param str name: Label name
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.get', user=user,
+            repo=repo, name=name)
+        return self._get(request)
+
+    def create(self, data, user=None, repo=None):
+        """ Create a label on an repo
+
+        :param dict data: Input. See `github labels doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.create', user=user,
+            repo=repo, body=data)
+        return self._post(request)
+
+    def update(self, name, data, user=None, repo=None):
+        """ Update a label on an repo
+
+        :param str name: Label name
+        :param dict data: Input. See `github labels doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.update', user=user,
+            repo=repo, name=name, body=data)
+        return self._patch(request)
+
+    def delete(self, name, user=None, repo=None):
+        """ Delete a label on an repo
+
+        :param str name: Label name
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.delete', user=user,
+            repo=repo, name=name)
+        return self._delete(request)
+
+    def list_by_issue(self, number, user=None, repo=None):
+        """ List labels for an issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.list_by_issue', user=user,
+            repo=repo, number=number)
+        return self._get(request)
+
+    def add_to_issue(self, number, labels, user=None, repo=None):
+        """ Add labels to issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+        :param list labels: Label names
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+
+        ::
+
+            labels_service.add_to_issue(2, user='github', repo='github',
+                'label1', 'label2', 'label3')
+        """
+        request = self.make_request('issues.labels.add_to_issue', user=user,
+            repo=repo, number=number, body=map(str, labels))
+        return self._post(request)
+
+    def remove_from_issue(self, number, label, user=None, repo=None):
+        """ Remove a label from an issue
+
+        :param int number: Issue number
+        :param str label: Label name
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.remove_from_issue',
+                                       user=user,
+                                       repo=repo,
+                                       number=number,
+                                       name=label)
+        return self._delete(request)
+
+    def replace_all(self, number, labels, user=None, repo=None):
+        """ Replace all labels for a issue
+
+        :param int number: Issue number
+        :param list labels: New labels
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            If labels weren't especified, it'd remove all labels from the issue
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.replace_all',
+                                       user=user,
+                                       repo=repo,
+                                       number=number,
+                                       body=map(str, labels))
+        return self._put(request)
+
+    def remove_all(self, number, user=None, repo=None):
+        """ Remove all labels from a issue
+
+        :param int number: Issue number
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.remove_all',
+                                       user=user,
+                                       repo=repo,
+                                       number=number,)
+        return self._delete(request)
+
+    def list_by_milestone(self, number, user=None, repo=None):
+        """ Get labels for every issue in a milestone
+
+        :param int number: Milestone ID
+        :param str user: Username
+        :param str repo: Repo name
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.labels.list_by_milestone',
+            user=user, repo=repo, number=number)
+        return self._get_result(request)
diff --git a/pygithub3/services/issues/milestones.py b/pygithub3/services/issues/milestones.py
new file mode 100644
index 0000000..ac43a0c
--- /dev/null
+++ b/pygithub3/services/issues/milestones.py
@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+
+
+class Milestones(Service):
+    """ Consume `Milestones API
+    <http://developer.github.com/v3/issues/milestones>`_ """
+
+    def list(self, user=None, repo=None, state='open', sort='due_date',
+            direction='desc'):
+        """ List milestones for a repo
+
+        :param str user: Username
+        :param str repo: Repo name
+        :param str state: 'open' or 'closed'
+        :param str sort: 'due_date' or 'completeness'
+        :param str direction: 'asc' or 'desc'
+        :returns: A :doc:`result`
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.milestones.list', user=user,
+            repo=repo)
+        return self._get_result(request, state=state, sort=sort,
+            direction=direction)
+
+    def get(self, number, user=None, repo=None):
+        """ Get a single milestone
+
+        :param int number: Milestone number
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.milestones.get', user=user,
+            repo=repo, number=number)
+        return self._get(request)
+
+    def create(self, data, user=None, repo=None):
+        """ Create a milestone
+
+        :param dict data: Input. See `github milestones doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        self._normalize_date('due_on', data)
+        request = self.make_request('issues.milestones.create', user=user,
+            repo=repo, body=data)
+        return self._post(request)
+
+    def update(self, number, data, user=None, repo=None):
+        """ Update a milestone
+
+        :param int number: Milestone number
+        :param dict data: Input. See `github milestones doc`_
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        self._normalize_date('due_on', data)
+        request = self.make_request('issues.milestones.update', user=user,
+            repo=repo, number=number, body=data)
+        return self._patch(request)
+
+    def delete(self, number, user=None, repo=None):
+        """ Delete a milestone
+
+        :param int number: Milestone number
+        :param str user: Username
+        :param str repo: Repo name
+
+        .. warning::
+            You must be authenticated
+
+        .. note::
+            Remember :ref:`config precedence`
+        """
+        request = self.make_request('issues.milestones.delete', user=user,
+            repo=repo, number=number)
+        self._delete(request)