aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3
diff options
context:
space:
mode:
Diffstat (limited to 'pygithub3')
-rw-r--r--pygithub3/github.py11
-rw-r--r--pygithub3/requests/issues/__init__.py51
-rw-r--r--pygithub3/requests/issues/comments.py42
-rw-r--r--pygithub3/requests/issues/events.py22
-rw-r--r--pygithub3/requests/issues/labels.py85
-rw-r--r--pygithub3/requests/issues/milestones.py38
-rw-r--r--pygithub3/requests/repos/__init__.py15
-rw-r--r--pygithub3/resources/issues.py65
-rw-r--r--pygithub3/services/issues/__init__.py85
-rw-r--r--pygithub3/services/issues/comments.py75
-rw-r--r--pygithub3/services/issues/events.py42
-rw-r--r--pygithub3/services/issues/labels.py160
-rw-r--r--pygithub3/services/issues/milestones.py105
-rw-r--r--pygithub3/services/repos/__init__.py30
-rw-r--r--pygithub3/tests/resources/test_issues.py17
-rw-r--r--pygithub3/tests/services/test_issues.py240
-rw-r--r--pygithub3/tests/services/test_repos.py12
17 files changed, 1095 insertions, 0 deletions
diff --git a/pygithub3/github.py b/pygithub3/github.py
index d135865..1d00d79 100644
--- a/pygithub3/github.py
+++ b/pygithub3/github.py
@@ -20,12 +20,17 @@ class Github(object):
from pygithub3.services.git_data import GitData
from pygithub3.services.pull_requests import PullRequests
from pygithub3.services.orgs import Org
+ from pygithub3.services.issues import Issue
self._users = User(**config)
self._repos = Repo(**config)
self._gists = Gist(**config)
self._git_data = GitData(**config)
self._pull_requests = PullRequests(**config)
self._orgs = Org(**config)
+ self._users = User(**config)
+ self._repos = Repo(**config)
+ self._gists = Gist(**config)
+ self._issues = Issue(**config)
@property
def remaining_requests(self):
@@ -73,3 +78,9 @@ class Github(object):
:ref:`Orgs service <Orgs service>`
"""
return self._orgs
+
+ def issues(self):
+ """
+ :ref:`Issues service <Issues service>`
+ """
+ return self._issues
diff --git a/pygithub3/requests/issues/__init__.py b/pygithub3/requests/issues/__init__.py
new file mode 100644
index 0000000..ca8afb1
--- /dev/null
+++ b/pygithub3/requests/issues/__init__.py
@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request, ValidationError
+from pygithub3.resources.issues import Issue
+
+class List(Request):
+
+ uri = 'issues'
+ resource = Issue
+ body_schema = {
+ 'schema': ('filter', 'state', 'labels', 'sort', 'direction', 'since'),
+ 'required': ()
+ }
+
+
+class List_by_repo(Request):
+
+ uri = 'repos/{user}/{repo}/issues'
+ resource = Issue
+ body_schema = {
+ 'schema': ('milestone', 'state', 'assignee', 'mentioned', 'labels',
+ 'sort', 'direction', 'since'),
+ 'required': ()
+ }
+
+
+class Get(Request):
+
+ uri = 'repos/{user}/{repo}/issues/{number}'
+ resource = Issue
+
+
+class Create(Request):
+
+ uri = 'repos/{user}/{repo}/issues'
+ resource = Issue
+ body_schema = {
+ 'schema': ('title', 'body', 'assignee', 'milestone', 'labels'),
+ 'required': ('title', )
+ }
+
+
+class Edit(Request):
+
+ uri = 'repos/{user}/{repo}/issues/{number}'
+ resource = Issue
+ body_schema = {
+ 'schema': ('title', 'body', 'assignee', 'state', 'milestone', 'lables'),
+ 'required': ()
+ } \ No newline at end of file
diff --git a/pygithub3/requests/issues/comments.py b/pygithub3/requests/issues/comments.py
new file mode 100644
index 0000000..638c9cf
--- /dev/null
+++ b/pygithub3/requests/issues/comments.py
@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request, ValidationError
+from pygithub3.resources.issues import Comment
+
+class List(Request):
+
+ uri = 'repos/{user}/{repo}/issues/{number}/comments'
+ resource = Comment
+
+
+class Get(Request):
+
+ uri = 'repos/{user}/{repo}/issues/comments/{id}'
+ resource = Comment
+
+
+class Create(Request):
+
+ uri = 'repos/{user}/{repo}/issues/{number}/comments'
+ resource = Comment
+ body_schema = {
+ 'schema': ('body', ),
+ 'required': ('body', )
+ }
+
+
+class Edit(Request):
+
+ uri = 'repos/{user}/{repo}/issues/comments/{id}'
+ resource = Comment
+ body_schema = {
+ 'schema': ('body', ),
+ 'required': ('body', )
+ }
+
+
+class Delete(Request):
+
+ uri = 'repos/{user}/{repo}/issues/comments/{id}'
+ resource = Comment
diff --git a/pygithub3/requests/issues/events.py b/pygithub3/requests/issues/events.py
new file mode 100644
index 0000000..dfefe7e
--- /dev/null
+++ b/pygithub3/requests/issues/events.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request, ValidationError
+from pygithub3.resources.issues import Event
+
+class List_by_issue(Request):
+
+ uri = 'repos/{user}/{repo}/issues/{number}/events'
+ resource = Event
+
+
+class List_by_repo(Request):
+
+ uri = 'repos/{user}/{repo}/issues/events'
+ resource = Event
+
+
+class Get(Request):
+
+ uri = 'repos/{user}/{repo}/issues/events/{id}'
+ resource = Event
diff --git a/pygithub3/requests/issues/labels.py b/pygithub3/requests/issues/labels.py
new file mode 100644
index 0000000..75e11e4
--- /dev/null
+++ b/pygithub3/requests/issues/labels.py
@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request, ValidationError
+from pygithub3.resources.issues import Label
+
+
+
+class Get(Request):
+ uri = 'repos/{user}/{repo}/labels/{name}'
+ resource = Label
+
+
+class Create(Request):
+ uri = 'repos/{user}/{repo}/labels'
+ resource = Label
+ body_schema = {
+ 'schema': ('name', 'color'),
+ 'required': ('name', 'color' )
+ }
+
+ def clean_body(self):
+ color = self.body.get('color', '')
+ if not Label.is_valid_color(color):
+ raise ValidationError('colors must have 6 hexadecimal characters, '
+ 'without # in the beggining')
+ else:
+ return self.body
+
+
+class Update(Request):
+
+ uri = 'repos/{user}/{repo}/labels/{name}'
+ resource = Label
+ body_schema = {
+ 'schema': ('name', 'color'),
+ 'required': ('name', 'color' )
+ }
+ def clean_body(self):
+ color = self.body.get('color', '')
+ if not Label.is_valid_color(color):
+ raise ValidationError('colors must have 6 hexadecimal characters, '
+ 'without # in the beggining')
+ else:
+ return self.body
+
+
+class Delete(Request):
+ uri = 'repos/{user}/{repo}/labels/{name}'
+ resource = Label
+
+
+class List_by_repo(Request):
+ uri = 'repos/{user}/{repo}/labels'
+ resource = Label
+
+
+
+class List_by_issue(Request):
+ uri = 'repos/{user}/{repo}/issues/{number}/labels'
+ resource = Label
+
+
+class Add_to_issue(Request):
+ uri = 'repos/{user}/{repo}/issues/{number}/labels'
+ resource = Label
+
+
+class Remove_from_issue(Request):
+ uri = 'repos/{user}/{repo}/issues/{number}/labels/{name}'
+ resource = Label
+
+
+class Replace_all(Request):
+ uri = 'repos/{user}/{repo}/issues/{number}/labels'
+ resource = Label
+
+
+class Remove_all(Request):
+ uri = 'repos/{user}/{repo}/issues/{number}/labels'
+ resource = Label
+
+
+class List_by_milestone(Request):
+ uri = 'repos/{user}/{repo}/milestones/{number}/labels'
+ resource = Label
diff --git a/pygithub3/requests/issues/milestones.py b/pygithub3/requests/issues/milestones.py
new file mode 100644
index 0000000..355c3b0
--- /dev/null
+++ b/pygithub3/requests/issues/milestones.py
@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request
+from pygithub3.resources.issues import Milestone
+
+
+class List(Request):
+ uri = 'repos/{user}/{repo}/milestones'
+ resource = Milestone
+
+
+class Get(Request):
+ uri = 'repos/{user}/{repo}/milestones/{number}'
+ resource = Milestone
+
+
+class Create(Request):
+ uri = 'repos/{user}/{repo}/milestones'
+ resource = Milestone
+ body_schema = {
+ 'schema': ('title', 'state', 'description', 'due_on'),
+ 'required': ('title',)
+ }
+
+
+class Update(Request):
+
+ uri = 'repos/{user}/{repo}/milestones/{number}'
+ resource = Milestone
+ body_schema = {
+ 'schema': ('title', 'state', 'description', 'due_on'),
+ 'required': ('title',)
+ }
+
+
+class Delete(Request):
+ uri = 'repos/{user}/{repo}/milestones/{number}'
+ resource = Milestone
diff --git a/pygithub3/requests/repos/__init__.py b/pygithub3/requests/repos/__init__.py
index 7bbcf3e..e7594d7 100644
--- a/pygithub3/requests/repos/__init__.py
+++ b/pygithub3/requests/repos/__init__.py
@@ -4,6 +4,7 @@ from pygithub3.requests.base import Request, ValidationError
from pygithub3.resources.orgs import Team
from pygithub3.resources.repos import Repo, Tag, Branch
from pygithub3.resources.users import User
+from pygithub3.resources.issues import Label, Milestone
class List(Request):
@@ -79,3 +80,17 @@ class List_branches(Request):
uri = 'repos/{user}/{repo}/branches'
resource = Branch
+
+class List_labels(Request):
+
+ uri = 'repos/{user}/{repo}/labels'
+ resource = Label
+
+class List_milestones(Request):
+
+ uri = 'repos/{user}/{repo}/milestones'
+ resource = Milestone
+ body_schema = {
+ 'schema': ('state', 'sort', 'direction'),
+ 'required': ()
+ }
diff --git a/pygithub3/resources/issues.py b/pygithub3/resources/issues.py
new file mode 100644
index 0000000..69f905a
--- /dev/null
+++ b/pygithub3/resources/issues.py
@@ -0,0 +1,65 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+import re
+
+from .base import Resource
+from .users import User
+from .pull_requests import PullRequest
+
+
+class Label(Resource):
+
+ @staticmethod
+ def is_valid_color(color):
+ valid_color = re.compile(r'[0-9abcdefABCDEF]{6}')
+ match = valid_color.match(color)
+ if match is None:
+ return False
+ return match.start() == 0 and match.end() == len(color)
+
+ def __str__(self):
+ return '<Label (%s)>' % getattr(self, 'name', '')
+
+
+class Milestone(Resource):
+
+ _dates = ('created_at', 'due_on')
+ _maps = {'creator': User}
+
+ def __str__(self):
+ return '<Milestone (%s)>' % getattr(self, 'title', '')
+
+
+class Issue(Resource):
+
+ _dates = ('created_at', 'updated_at', 'closed_at')
+ _maps = {
+ 'assignee': User,
+ 'user': User,
+ 'milestone': Milestone,
+ 'pull_request': PullRequest
+ }
+
+ _collection_maps = {'labels': Label}
+
+ def __str__(self):
+ return '<Issue (%s)>' % getattr(self, 'number', '')
+
+
+class Comment(Resource):
+
+ _dates = ('created_at', 'updated_at')
+ _maps = {'user': User}
+
+ def __str__(self):
+ return '<Comment (%s)>' % (getattr(self, 'user', ''))
+
+
+class Event(Resource):
+
+ _dates = ('created_at', )
+ _maps = {'actor': User, 'issue': Issue}
+
+ def __str__(self):
+ return '<Event (%s)>' % (getattr(self, 'commit_id', ''))
diff --git a/pygithub3/services/issues/__init__.py b/pygithub3/services/issues/__init__.py
new file mode 100644
index 0000000..e8e3493
--- /dev/null
+++ b/pygithub3/services/issues/__init__.py
@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+from .comments import Comments
+from .events import Events
+from .labels import Labels
+from .milestones import Milestones
+
+class Issue(Service):
+ """ 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, data={}):
+ """ List your issues
+
+ :param dict data: Input. See `github issues doc`_
+ :returns: A :doc:`result`
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.list', body=data)
+ return self._get_result(request)
+
+ def list_by_repo(self, user, repo, data={}):
+ """ List issues for a repo
+
+ :param dict data: Input. See `github issues doc`_
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.list_by_repo', user=user,
+ repo=repo, body=data)
+ return self._get_result(request)
+
+ def get(self, user, repo, number):
+ """ Get a single issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ """
+ request = self.request_builder('issues.get', user=user, repo=repo,
+ number=number)
+ return self._get(request)
+
+ def create(self, user, repo, data):
+ """ Create an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param dict data: Input. See `github issues doc`_
+
+ .. warning::
+ You must be authenticated
+
+ ::
+
+ issues_service.create(dict(title='My test issue',
+ body='This needs to be fixed ASAP.',
+ assignee='copitux'))
+ """
+ request = self.request_builder('issues.create', user=user, repo=repo,
+ body=data)
+ return self._post(request)
+
+ def update(self, user, repo, number, data):
+ """ Update an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :param dict data: Input. See `github issues doc`_
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.edit', 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..d007286
--- /dev/null
+++ b/pygithub3/services/issues/comments.py
@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+
+class Comments(Service):
+ """ Consume `Comments API
+ <http://developer.github.com/v3/issues/comments>`_ """
+
+ def list(self, user, repo, number):
+ """ List comments for an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.comments.list', user=user,
+ repo=repo, number=number)
+ return self._get_result(request)
+
+ def get(self, user, repo, id):
+ """ Get a single comment
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int id: Comment id
+ """
+ request = self.request_builder('issues.comments.get', user=user,
+ repo=repo, id=id)
+ return self._get(request)
+
+ def create(self, user, repo, number, message):
+ """ Create a comment on an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :param str message: Comment message
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.comments.create', user=user,
+ repo=repo, number=number, body={'body': message})
+ return self._post(request)
+
+ def update(self, user, repo, id, message):
+ """ Update a comment on an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int id: Issue id
+ :param str message: Comment message
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.comments.edit', user=user,
+ repo=repo, id=id, body={'body': message})
+ return self._patch(request)
+
+ def delete(self, user, repo, id):
+ """ Delete a single comment
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int id: Comment id
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('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..8eb35e4
--- /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, user, repo, number):
+ """ List events for an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.events.list_by_issue',
+ user=user, repo=repo, number=number)
+ return self._get_result(request)
+
+ def list_by_repo(self, user, repo):
+ """ List events for a repository
+
+ :param str user: Username
+ :param str repo: Repo name
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.events.list_by_repo',
+ user=user, repo=repo)
+ return self._get_result(request)
+
+ def get(self, user, repo, id):
+ """ Get a single event
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int id: Comment id
+ """
+ request = self.request_builder('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..6aea6e7
--- /dev/null
+++ b/pygithub3/services/issues/labels.py
@@ -0,0 +1,160 @@
+#!/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 get(self, user, repo, name):
+ """ Get a single label
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param str name: Label name
+ """
+ request = self.request_builder('issues.labels.get', user=user,
+ repo=repo, name=name)
+ return self._get(request)
+
+ def create(self, user, repo, name, color):
+ """ Create a label on an repo
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param str name: Label name
+ :param str color: Label color
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.labels.create',
+ user=user,
+ repo=repo,
+ body={'name': name,
+ 'color': color,})
+ return self._post(request)
+
+ def update(self, user, repo, name, new_name, color):
+ """ Update a label on an repo
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param str name: Label name
+ :param str name: Label new name
+ :param str color: Label color
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.labels.update',
+ user=user,
+ repo=repo,
+ name=name,
+ body={'name': new_name,
+ 'color': color,})
+ return self._patch(request)
+
+ def delete(self, user, repo, name):
+ """ Delete a label on an repo
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param str name: Label name
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.labels.delete',
+ user=user,
+ repo=repo,
+ name=name)
+ return self._delete(request)
+
+ def list_by_repo(self, user, repo):
+ """ List all labels for a repo
+
+ :param str user: Username
+ :param str repo: Repo name
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.list_by_repo',
+ user=user,
+ repo=repo,)
+ return self._get(request)
+
+ def list_by_issue(self, user, repo, number):
+ """ List labels for an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.list_by_issue', user=user,
+ repo=repo, number=number)
+ return self._get(request)
+
+ def add_to_issue(self, user, repo, number, labels):
+ """ Add labels to issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :param list labels: List of label names
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.add_to_issue',
+ user=user,
+ repo=repo,
+ number=number,
+ body=labels)
+ return self._post(request)
+
+ def remove_from_issue(self, user, repo, number, label):
+ """ Remove a label from an issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :param str label: Label name
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.remove_from_issue',
+ user=user,
+ repo=repo,
+ number=number,
+ name=label)
+ return self._delete(request)
+
+ def replace_all(self, user, repo, number, labels):
+ """ Replace all labels of a issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :param list labels: New labels
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.replace_all',
+ user=user,
+ repo=repo,
+ number=number,
+ body=labels,)
+ return self._put(request)
+
+ def remove_all(self, user, repo, number):
+ """ Remove all labels from a issue
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Issue number
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.labels.remove_all',
+ user=user,
+ repo=repo,
+ number=number,)
+ return self._delete(request)
diff --git a/pygithub3/services/issues/milestones.py b/pygithub3/services/issues/milestones.py
new file mode 100644
index 0000000..851e9f2
--- /dev/null
+++ b/pygithub3/services/issues/milestones.py
@@ -0,0 +1,105 @@
+#!/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, repo):
+ """ List milestones for a repo
+
+ :param str user: Username
+ :param str repo: Repo name
+ :returns: A :doc:`result`
+ """
+ request = self.request_builder('issues.milestones.list',
+ user=user,
+ repo=repo)
+ return self._get_result(request)
+
+ def get(self, user, repo, number):
+ """ Get a single milestone
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Milestone number
+ """
+ request = self.request_builder('issues.milestones.get', user=user,
+ repo=repo, number=number)
+ return self._get(request)
+
+ def create(self,
+ user,
+ repo,
+ title,
+ state=None,
+ description=None,
+ due_on=None):
+ """ Create a milestone
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param str title: Milestone title
+ :param str state: Milestone state
+ :param str description: Milestone description
+ :param date due_on: Milestone due date
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.milestones.create',
+ user=user,
+ repo=repo,
+ body={'title': title,
+ 'state': state,
+ 'due_on': due_on})
+ return self._post(request)
+
+ def update(self,
+ user,
+ repo,
+ number,
+ title,
+ state=None,
+ description=None,
+ due_on=None):
+ """ Update a milestone
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Milestone number
+ :param str title: Milestone title
+ :param str state: Milestone state
+ :param str description: Milestone description
+ :param date due_on: Milestone due date
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.milestones.update',
+ user=user,
+ repo=repo,
+ number=number,
+ body={'title': title,
+ 'state': state,
+ 'description': description,
+ 'due_on': due_on, })
+ return self._patch(request)
+
+ def delete(self, user, repo, number):
+ """ Delete a milestone
+
+ :param str user: Username
+ :param str repo: Repo name
+ :param int number: Milestone number
+
+ .. warning::
+ You must be authenticated
+ """
+ request = self.request_builder('issues.milestones.delete',
+ user=user,
+ repo=repo,
+ number=number)
+ self._delete(request)
diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py
index 628e9d6..a7e61fc 100644
--- a/pygithub3/services/repos/__init__.py
+++ b/pygithub3/services/repos/__init__.py
@@ -190,3 +190,33 @@ class Repo(Service):
request = self.make_request('repos.list_branches',
user=user, repo=repo)
return self._get_result(request)
+
+ def list_labels(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('repos.list_labels',
+ user=user,
+ repo=repo)
+ return self._get_result(request)
+
+ def list_milestones(self, user=None, repo=None):
+ """ Get repository's milestones
+
+ :param str user: Username
+ :param str repo: Repository
+ :returns: A :doc:`result`
+
+ .. note::
+ Remember :ref:`config precedence`
+ """
+ request = self.make_request('repos.list_milestones',
+ user=user,
+ repo=repo)
+ return self._get_result(request)
diff --git a/pygithub3/tests/resources/test_issues.py b/pygithub3/tests/resources/test_issues.py
new file mode 100644
index 0000000..ae572af
--- /dev/null
+++ b/pygithub3/tests/resources/test_issues.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from unittest import TestCase
+
+from pygithub3.resources.issues import Label
+
+
+class TestLabel(TestCase):
+ def test_is_valid_color(self):
+ valid_colors = ['BADa55', 'FF42FF', '45DFCA']
+ for color in valid_colors:
+ self.assertTrue(Label.is_valid_color(color))
+
+ invalid_colors = ['BDA55', '#FFAABB', 'FFf']
+ for color in invalid_colors:
+ self.assertFalse(Label.is_valid_color(color))
diff --git a/pygithub3/tests/services/test_issues.py b/pygithub3/tests/services/test_issues.py
new file mode 100644
index 0000000..4672bdb
--- /dev/null
+++ b/pygithub3/tests/services/test_issues.py
@@ -0,0 +1,240 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+import requests
+from mock import patch, Mock
+
+from pygithub3.exceptions import ValidationError
+from pygithub3.tests.utils.core import TestCase
+from pygithub3.resources.base import json
+from pygithub3.services.issues import Issue, Comments, Events, Labels, Milestones
+from pygithub3.tests.utils.base import (mock_response, mock_response_result,
+ mock_json)
+from pygithub3.tests.utils.services import _
+
+json.dumps = Mock(side_effect=mock_json)
+json.loads = Mock(side_effect=mock_json)
+
+
+@patch.object(requests.sessions.Session, 'request')
+class TestIssuesService(TestCase):
+
+ def setUp(self):
+ self.isu = Issue()
+
+ def test_LIST_without_user(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.isu.list().all()
+ self.assertEqual(request_method.call_args[0], ('get', _('issues')))
+
+ def test_LIST_by_repo(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.isu.list_by_repo('octocat', 'Hello-World').all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues')))
+
+ def test_GET(self, request_method):
+ request_method.return_value = mock_response()
+ self.isu.get('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/1')))
+
+ def test_CREATE(self, request_method):
+ request_method.return_value = mock_response('post')
+ self.isu.create('octocat', 'Hello-World',
+ dict(title='My issue', body='Fix this issue'))
+ self.assertEqual(request_method.call_args[0],
+ ('post', _('repos/octocat/Hello-World/issues')))
+
+ def test_UPDATE(self, request_method):
+ request_method.return_value = mock_response('patch')
+ self.isu.update('octocat', 'Hello-World', 1,
+ {'body': 'edited'})
+ self.assertEqual(request_method.call_args[0],
+ ('patch', _('repos/octocat/Hello-World/issues/1')))
+
+
+@patch.object(requests.sessions.Session, 'request')
+class TestCommentService(TestCase):
+
+ def setUp(self):
+ self.cs = Comments()
+
+ def test_LIST(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.cs.list('octocat', 'Hello-World', 1).all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/1/comments')))
+
+ def test_GET(self, request_method):
+ request_method.return_value = mock_response()
+ self.cs.get('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/comments/1')))
+
+ def test_CREATE(self, request_method):
+ request_method.return_value = mock_response('post')
+ self.cs.create('octocat', 'Hello-World', 1, 'comment')
+ self.assertEqual(request_method.call_args[0],
+ ('post', _('repos/octocat/Hello-World/issues/1/comments')))
+
+ def test_UPDATE(self, request_method):
+ request_method.return_value = mock_response('patch')
+ self.cs.update('octocat', 'Hello-World', 1, 'new comment')
+ self.assertEqual(request_method.call_args[0],
+ ('patch', _('repos/octocat/Hello-World/issues/comments/1')))
+
+ def test_DELETE(self, request_method):
+ request_method.return_value = mock_response('delete')
+ self.cs.delete('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('delete', _('repos/octocat/Hello-World/issues/comments/1')))
+
+
+@patch.object(requests.sessions.Session, 'request')
+class TestEventsService(TestCase):
+
+ def setUp(self):
+ self.ev = Events()
+
+ def test_LIST_by_issue(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.ev.list_by_issue('octocat', 'Hello-World', 1).all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/1/events')))
+
+ def test_LIST_by_repo(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.ev.list_by_repo('octocat', 'Hello-World').all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/events')))
+
+ def test_GET(self, request_method):
+ request_method.return_value = mock_response()
+ self.ev.get('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/events/1')))
+
+
+@patch.object(requests.sessions.Session, 'request')
+class TestLabelsService(TestCase):
+
+ def setUp(self):
+ self.lb = Labels()
+
+ def test_GET(self, request_method):
+ request_method.return_value = mock_response()
+ self.lb.get('octocat', 'Hello-World', 'bug')
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/labels/bug')))
+
+ def test_CREATE(self, request_method):
+ request_method.return_value = mock_response('post')
+ self.lb.create('octocat', 'Hello-World', 'bug', 'FF0000')
+ self.assertEqual(request_method.call_args[0],
+ ('post', _('repos/octocat/Hello-World/labels')))
+
+ def test_CREATE_with_invalid_color(self, request_method):
+ request_method.return_value = mock_response('post')
+ # invalid color
+ with self.assertRaises(ValidationError):
+ args={'user': 'octocat',
+ 'repo': 'Hello-world',
+ 'name': 'bug',
+ 'color': 'FF00',}
+ self.lb.create(**args)
+
+ def test_UPDATE(self, request_method):
+ request_method.return_value = mock_response('patch')
+ self.lb.update('octocat', 'Hello-World', 'bug', 'critical', 'FF0000')
+ self.assertEqual(request_method.call_args[0],
+ ('patch', _('repos/octocat/Hello-World/labels/bug')))
+
+ def test_UPDATE_with_invalid_color(self, request_method):
+ request_method.return_value = mock_response('post')
+ # invalid color
+ with self.assertRaises(ValidationError):
+ args={'user': 'octocat',
+ 'repo': 'Hello-world',
+ 'name': 'bug',
+ 'new_name': 'critical',
+ 'color': 'FF00',}
+ self.lb.update(**args)
+
+ def test_DELETE(self, request_method):
+ request_method.return_value = mock_response('delete')
+ self.lb.delete('octocat', 'Hello-World', 'bug')
+ self.assertEqual(request_method.call_args[0],
+ ('delete', _('repos/octocat/Hello-World/labels/bug')))
+
+ def test_LIST_by_repo(self, request_method):
+ request_method.return_value = mock_response()
+ self.lb.list_by_repo('octocat', 'Hello-World')
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/labels')))
+
+ def test_LIST_by_issue(self, request_method):
+ request_method.return_value = mock_response()
+ self.lb.list_by_issue('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/issues/1/labels')))
+
+ def test_ADD_to_issue(self, request_method):
+ request_method.return_value = mock_response('post')
+ self.lb.add_to_issue('octocat', 'Hello-World', 1, ['bug', 'critical'])
+ self.assertEqual(request_method.call_args[0],
+ ('post', _('repos/octocat/Hello-World/issues/1/labels')))
+
+ def test_REMOVE_from_issue(self, request_method):
+ request_method.return_value = mock_response('delete')
+ self.lb.remove_from_issue('octocat', 'Hello-World', 1, 'bug')
+ self.assertEqual(request_method.call_args[0],
+ ('delete', _('repos/octocat/Hello-World/issues/1/labels/bug')))
+
+ def test_REPLACE_all(self, request_method):
+ self.lb.replace_all('octocat', 'Hello-World', 1, ['bug', 'critical'])
+ self.assertEqual(request_method.call_args[0],
+ ('put', _('repos/octocat/Hello-World/issues/1/labels')))
+
+ def test_REMOVE_all(self, request_method):
+ request_method.return_value = mock_response('delete')
+ self.lb.remove_all('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('delete', _('repos/octocat/Hello-World/issues/1/labels')))
+
+
+@patch.object(requests.sessions.Session, 'request')
+class TestMilestonesService(TestCase):
+
+ def setUp(self):
+ self.mi = Milestones()
+
+ def test_LIST_by_repo(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.mi.list('octocat', 'Hello-World').all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/milestones')))
+
+ def test_GET(self, request_method):
+ request_method.return_value = mock_response()
+ self.mi.get('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/Hello-World/milestones/1')))
+
+ def test_CREATE(self, request_method):
+ request_method.return_value = mock_response('post')
+ self.mi.create('octocat', 'Hello-World', 'title')
+ self.assertEqual(request_method.call_args[0],
+ ('post', _('repos/octocat/Hello-World/milestones')))
+
+ def test_UPDATE(self, request_method):
+ request_method.return_value = mock_response('patch')
+ self.mi.update('octocat', 'Hello-World', 1, 'critical')
+ self.assertEqual(request_method.call_args[0],
+ ('patch', _('repos/octocat/Hello-World/milestones/1')))
+
+ def test_DELETE(self, request_method):
+ request_method.return_value = mock_response('delete')
+ self.mi.delete('octocat', 'Hello-World', 1)
+ self.assertEqual(request_method.call_args[0],
+ ('delete', _('repos/octocat/Hello-World/milestones/1')))
diff --git a/pygithub3/tests/services/test_repos.py b/pygithub3/tests/services/test_repos.py
index e21d474..a07635a 100644
--- a/pygithub3/tests/services/test_repos.py
+++ b/pygithub3/tests/services/test_repos.py
@@ -134,6 +134,18 @@ class TestRepoService(TestCase):
self.assertEqual(request_method.call_args[0],
('get', _('repos/octocat/octocat_repo/branches')))
+ def test_LIST_labels(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.rs.list_labels().all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/octocat_repo/labels')))
+
+ def test_LIST_milestones(self, request_method):
+ request_method.return_value = mock_response_result()
+ self.rs.list_milestones().all()
+ self.assertEqual(request_method.call_args[0],
+ ('get', _('repos/octocat/octocat_repo/milestones')))
+
@patch.object(requests.sessions.Session, 'request')
class TestCollaboratorsService(TestCase):
Copyright © 1996 – 2023 Jason A. Donenfeld. All Rights Reverse Engineered.