From 2ca15bb8e847735f566ee0cb896f071b3b5ca056 Mon Sep 17 00:00:00 2001 From: Nat Williams Date: Tue, 17 Apr 2012 14:39:12 -0500 Subject: let request objects specify custom body validations --- pygithub3/tests/utils/base.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'pygithub3/tests/utils') diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py index 49ea2b4..fb519e9 100644 --- a/pygithub3/tests/utils/base.py +++ b/pygithub3/tests/utils/base.py @@ -4,7 +4,7 @@ from mock import Mock from pygithub3.resources.base import Resource -from pygithub3.requests.base import Request +from pygithub3.requests.base import Request, ValidationError def mock_json(content): @@ -37,3 +37,14 @@ DummyResource.loads = Mock(side_effect=loads_mock) class DummyRequest(Request): uri = 'dummyrequest' resource = DummyResource + + +class DummyRequestValidation(DummyRequest): + body_schema = { + 'schema': ('foo', 'error'), + 'required': ('foo',) + } + + def validate_body(self, body): + if body.get('error') == 'yes': + raise ValidationError('yes') -- cgit v1.2.3-59-g8ed1b From 4539f80aa44e500422c5071d8e3d74de321b6225 Mon Sep 17 00:00:00 2001 From: Nat Williams Date: Tue, 17 Apr 2012 17:35:31 -0500 Subject: add pull request API there are a few little issues remaining. Mostly regarding handling meaningful non-20x response codes --- pygithub3/core/client.py | 2 +- pygithub3/exceptions.py | 2 +- pygithub3/github.py | 9 ++ pygithub3/requests/pull_requests/__init__.py | 62 ++++++++ pygithub3/requests/pull_requests/comments.py | 43 ++++++ pygithub3/resources/pull_requests.py | 20 +++ pygithub3/services/pull_requests/__init__.py | 129 ++++++++++++++++ pygithub3/services/pull_requests/comments.py | 73 +++++++++ pygithub3/tests/services/test_pull_requests.py | 201 +++++++++++++++++++++++++ pygithub3/tests/utils/base.py | 2 +- 10 files changed, 540 insertions(+), 3 deletions(-) create mode 100644 pygithub3/requests/pull_requests/__init__.py create mode 100644 pygithub3/requests/pull_requests/comments.py create mode 100644 pygithub3/resources/pull_requests.py create mode 100644 pygithub3/services/pull_requests/__init__.py create mode 100644 pygithub3/services/pull_requests/comments.py create mode 100644 pygithub3/tests/services/test_pull_requests.py (limited to 'pygithub3/tests/utils') diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py index ee7c97f..eadb18e 100644 --- a/pygithub3/core/client.py +++ b/pygithub3/core/client.py @@ -81,7 +81,7 @@ class Client(object): def get(self, request, **kwargs): response = self.request('get', request, **kwargs) - assert response.status_code == 200 + # there are valid GET responses that != 200 return response def post(self, request, **kwargs): diff --git a/pygithub3/exceptions.py b/pygithub3/exceptions.py index 20cf058..9ee2597 100644 --- a/pygithub3/exceptions.py +++ b/pygithub3/exceptions.py @@ -37,6 +37,6 @@ class UnprocessableEntity(Exception): class NotFound(Exception): """ Raised when server response is 404 - Catched with a pygithub3-exception to `services.base.Service._bool` method + Caught with a pygithub3-exception to `services.base.Service._bool` method """ pass diff --git a/pygithub3/github.py b/pygithub3/github.py index 0b302a1..0f15adf 100644 --- a/pygithub3/github.py +++ b/pygithub3/github.py @@ -17,9 +17,11 @@ class Github(object): from pygithub3.services.users import User from pygithub3.services.repos import Repo from pygithub3.services.gists import Gist + from pygithub3.services.pull_requests import PullRequests self._users = User(**config) self._repos = Repo(**config) self._gists = Gist(**config) + self._pull_requests = PullRequests(**config) @property def remaining_requests(self): @@ -47,3 +49,10 @@ class Github(object): :ref:`Gists service ` """ return self._gists + + @property + def pull_requests(self): + """ + :ref:`Pull Requests service ' % getattr(self, 'title', '') + + +class File(Resource): + def __str__(self): + return '' % getattr(self, 'filename', '') + + +class Comment(Resource): + _dates = ('created_at', 'updated_at') + + def __str__(self): + return '' % getattr(self, 'id', '') diff --git a/pygithub3/services/pull_requests/__init__.py b/pygithub3/services/pull_requests/__init__.py new file mode 100644 index 0000000..2197f60 --- /dev/null +++ b/pygithub3/services/pull_requests/__init__.py @@ -0,0 +1,129 @@ +from pygithub3.exceptions import BadRequest, NotFound +from pygithub3.services.base import Service, MimeTypeMixin +from .comments import Comments + + +class PullRequests(Service, MimeTypeMixin): + """Consume `Pull Request API `_""" + + def __init__(self, **config): + self.comments = Comments(**config) + super(PullRequests, self).__init__(**config) + + def list(self, user=None, repo=None): + """List all of the pull requests for a repo + + :param str user: Username + :param str repo: Repository + + """ + return self._get_result( + self.make_request('pull_requests.list', user=user, repo=repo) + ) + + def get(self, number, user=None, repo=None): + """Get a single pull request + + :param str number: The number of the pull request to get + :param str user: Username + :param str repo: Repository + + """ + return self._get( + self.make_request('pull_requests.get', number=number, user=user, + repo=repo) + ) + + def create(self, body, user=None, repo=None): + """Create a pull request + + :param dict body: Data for the new pull request + :param str user: Username + :param str repo: Repository + + """ + return self._post( + self.make_request('pull_requests.create', body=body, user=user, + repo=repo) + ) + + def update(self, number, body, user=None, repo=None): + """Update a pull request + + :param str number: The number of the the pull request to update + :param dict body: The data to update the pull request with + :param str user: Username + :param str repo: Repository + + """ + return self._patch( + self.make_request('pull_requests.update', number=number, + body=body, user=user, repo=repo) + ) + + def list_commits(self, number, user=None, repo=None): + """List the commits for a pull request + + :param str number: The number of the pull request to list commits for + :param str user: Username + :param str repo: Repository + + """ + return self._get_result( + self.make_request('pull_requests.list_commits', number=number, + user=user, repo=repo) + ) + + def list_files(self, number, user=None, repo=None): + """List the files for a pull request + + :param str number: The number of the pull request to list files for + :param str user: Username + :param str repo: Repository + + """ + return self._get_result( + self.make_request('pull_requests.list_files', number=number, + user=user, repo=repo) + ) + + def merge_status(self, number, user=None, repo=None): + """Gets whether a pull request has been merged or not. + + :param str number: The pull request to check + :param str user: Username + :param str repo: Repository + + """ + # for this to work with a proper Resource, we would need to pass the + # response's status code to the Resource constructor, and that's kind + # of scary + try: + resp = self._client.get( + self.make_request('pull_requests.merge_status', number=number, + user=user, repo=repo) + ) + except NotFound: + return False + code = resp.status_code + if code == 204: + return True + # TODO: more flexible way to return arbitrary objects based on + # response. Probably something on Request + raise BadRequest('got code %s: %s' % (code, resp.content)) + # again, I'm sorry. + + def merge(self, number, message='', user=None, repo=None): + """Merge a pull request. + + :param str number: The pull request to merge + :param str user: Username + :param str repo: Repository + + """ + # so, the API docs don't actually say what the status code will be in + # the case of a merge failure. I hope it's not a 404. + return self._put( + self.make_request('pull_requests.merge', number=number, + message=message, user=user, repo=repo) + ) diff --git a/pygithub3/services/pull_requests/comments.py b/pygithub3/services/pull_requests/comments.py new file mode 100644 index 0000000..3aa6d0e --- /dev/null +++ b/pygithub3/services/pull_requests/comments.py @@ -0,0 +1,73 @@ +from pygithub3.services.base import Service, MimeTypeMixin + + +class Comments(Service, MimeTypeMixin): + """Consume `Review Comments API + `_ + + """ + + def list(self, number, user=None, repo=None): + """List all the comments for a pull request + + :param str number: The number of the pull request + :param str user: Username + :param str repo: Repository + + """ + return self._get_result( + self.make_request('pull_requests.comments.list', number=number, + user=user, repo=repo) + ) + + def get(self, number, user=None, repo=None): + """Get a single comment + + :param str number: The comment to get + :param str user: Username + :param str repo: Repository + + """ + return self._get( + self.make_request('pull_requests.comments.get', number=number, + user=user, repo=repo) + ) + + def create(self, number, body, user=None, repo=None): + """Create a comment + + :param str number: the pull request to comment on + :param str user: Username + :param str repo: Repository + + """ + return self._post( + self.make_request('pull_requests.comments.create', number=number, + body=body, user=user, repo=repo) + ) + + def edit(self, number, body, user=None, repo=None): + """Edit a comment + + :param str number: The id of the comment to edit + :param str user: Username + :param str repo: Repository + + """ + return self._patch( + self.make_request('pull_requests.comments.edit', number=number, + body=body, user=user, repo=repo) + ) + + def delete(self, number, user=None, repo=None): + """Delete a comment + + :param str number: The comment to delete + :param str user: Username + :param str repo: Repository + + """ + return self._delete( + self.make_request('pull_requests.comments.delete', number=number, + user=user, repo=repo) + ) diff --git a/pygithub3/tests/services/test_pull_requests.py b/pygithub3/tests/services/test_pull_requests.py new file mode 100644 index 0000000..8071b09 --- /dev/null +++ b/pygithub3/tests/services/test_pull_requests.py @@ -0,0 +1,201 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import requests +from mock import patch, Mock +from nose.tools import raises + +from pygithub3.tests.utils.core import TestCase +from pygithub3.services.pull_requests import PullRequests, Comments +from pygithub3.resources.base import json +from pygithub3.requests.base import ValidationError +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 TestPullRequestsService(TestCase): + def setUp(self): + self.service = PullRequests(user='user', repo='repo') + + def test_LIST(self, reqm): + reqm.return_value = mock_response_result() + self.service.list().all() + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls')) + ) + + def test_GET(self, reqm): + reqm.return_value = mock_response() + self.service.get(123) + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123')) + ) + + def test_CREATE_with_title_and_body(self, reqm): + reqm.return_value = mock_response('post') + data = { + 'title': 'this is a pull request', + 'body': 'merge me!', + 'head': 'octocat:some-feature', + 'base': 'master', + } + self.service.create(data) + self.assertEqual( + reqm.call_args[0], + ('post', _('repos/user/repo/pulls')) + ) + + def test_CREATE_with_issue(self, reqm): + reqm.return_value = mock_response('post') + data = { + 'issue': 1, + 'head': 'octocat:some-feature', + 'base': 'master', + } + self.service.create(data) + self.assertEqual( + reqm.call_args[0], + ('post', _('repos/user/repo/pulls')) + ) + + @raises(ValidationError) + def test_CREATE_with_no_title(self, reqm): + reqm.return_value = mock_response('post') + data = { + 'body': 'merge me!', + 'head': 'octocat:some-feature', + 'base': 'master', + } + self.service.create(data) + + def test_UPDATE(self, reqm): + reqm.return_value = mock_response('patch') + data = {} + self.service.update(123, data) + self.assertEqual( + reqm.call_args[0], + ('patch', _('repos/user/repo/pulls/123')) + ) + + @raises(ValidationError) + def test_UPDATE_with_invalid_state(self, reqm): + reqm.return_value = mock_response('patch') + data = {'state': 'Illinois'} + self.service.update(123, data) + + def test_LIST_COMMITS(self, reqm): + reqm.return_value = mock_response_result('get') + self.service.list_commits(123).all() + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123/commits')) + ) + + def test_LIST_FILES(self, reqm): + reqm.return_value = mock_response_result('get') + self.service.list_files(123).all() + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123/files')) + ) + + def test_MERGE_STATUS_true(self, reqm): + reqm.return_value = mock_response(204) + resp = self.service.merge_status(123) + self.assertEqual(True, resp) + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123/merge')) + ) + + def test_MERGE_STATUS_false(self, reqm): + reqm.return_value = mock_response(404) + resp = self.service.merge_status(123) + self.assertEqual(False, resp) + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123/merge')) + ) + + def test_MERGE(self, reqm): + reqm.return_value = mock_response(200) + self.service.merge(123, 'merging this') + self.assertEqual( + reqm.call_args[0], + ('put', _('repos/user/repo/pulls/123/merge')) + ) + + +@patch.object(requests.sessions.Session, 'request') +class TestPullRequestCommentsService(TestCase): + def setUp(self): + self.service = Comments(user='user', repo='repo') + + def test_LIST(self, reqm): + reqm.return_value = mock_response_result(200) + self.service.list(123).all() + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/123/comments')) + ) + + def test_GET(self, reqm): + reqm.return_value = mock_response(200) + self.service.get(1) + self.assertEqual( + reqm.call_args[0], + ('get', _('repos/user/repo/pulls/comments/1')) + ) + + def test_CREATE(self, reqm): + reqm.return_value = mock_response(201) + data = { + 'body': ':sparkles:', + 'commit_id': 'abc123', + 'path': 'foo.txt', + 'position': '2', + } + self.service.create(1, data) + self.assertEqual( + reqm.call_args[0], + ('post', _('repos/user/repo/pulls/1/comments')) + ) + + def test_CREATE_in_reply_to(self, reqm): + reqm.return_value = mock_response(201) + data = { + 'body': ':sparkles:', + 'in_reply_to': '5', + } + self.service.create(1, data) + self.assertEqual( + reqm.call_args[0], + ('post', _('repos/user/repo/pulls/1/comments')) + ) + + def test_EDIT(self, reqm): + reqm.return_value = mock_response(200) + data = { + 'body': 'something completely different', + } + self.service.edit(1, data) + self.assertEqual( + reqm.call_args[0], + ('patch', _('repos/user/repo/pulls/comments/1')) + ) + + def test_DELETE(self, reqm): + reqm.return_value = mock_response(204) + self.service.delete(1) + self.assertEqual( + reqm.call_args[0], + ('delete', _('repos/user/repo/pulls/comments/1')) + ) diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py index fb519e9..b3c3b76 100644 --- a/pygithub3/tests/utils/base.py +++ b/pygithub3/tests/utils/base.py @@ -14,7 +14,7 @@ def mock_json(content): def mock_response(status_code='get', content={}): CODES = dict(get=200, patch=200, post=201, delete=204) response = Mock(name='response') - response.status_code = CODES[str(status_code).lower()] or status_code + response.status_code = CODES.get(str(status_code).lower(), status_code) response.content = content return response -- cgit v1.2.3-59-g8ed1b From cd7e1b88c9dfa5eaa126ece0a5529e224ae297d4 Mon Sep 17 00:00:00 2001 From: David Medina Date: Sat, 12 May 2012 17:30:05 +0200 Subject: Deleted 'validate_body' behaviour 'clean_body' had been developed to that functionality --- pygithub3/requests/base.py | 52 ++++++++++++++++------------------- pygithub3/tests/requests/test_core.py | 17 ++---------- pygithub3/tests/utils/base.py | 13 +-------- 3 files changed, 26 insertions(+), 56 deletions(-) (limited to 'pygithub3/tests/utils') diff --git a/pygithub3/requests/base.py b/pygithub3/requests/base.py index 13472b0..f49a7a9 100644 --- a/pygithub3/requests/base.py +++ b/pygithub3/requests/base.py @@ -12,12 +12,12 @@ ABS_IMPORT_PREFIX = 'pygithub3.requests' class Body(object): + """ Input's request handler """ - def __init__(self, content, valid_body, validate_body=None): + def __init__(self, content, schema, required): self.content = content - self.schema = valid_body['schema'] - self.required = valid_body['required'] - self.validate_body = validate_body or (lambda x: None) + self.schema = schema + self.required = required def dumps(self): if not self.schema: @@ -25,12 +25,12 @@ class Body(object): return json.dumps(self.parse()) def parse(self): + """ Parse body with schema-required rules """ if not hasattr(self.content, 'items'): raise ValidationError("'%s' needs a content dictionary" % self.__class__.__name__) parsed = dict([(key, self.content[key]) for key in self.schema if key in self.content]) - self.validate_body(parsed) for attr_required in self.required: if attr_required not in parsed: raise ValidationError("'%s' attribute is required" % @@ -42,22 +42,34 @@ class Body(object): class Request(object): - """ """ uri = '' resource = Raw body_schema = {} def __init__(self, **kwargs): - """ """ - self.body = kwargs.pop('body', None) + self.body = kwargs.pop('body', {}) self.args = kwargs self.clean() + def __getattr__(self, name): + return self.args.get(name) + + def __str__(self): + return self.populate_uri() + + def populate_uri(self): + try: + populated_uri = self.uri.format(**self.args) + except KeyError: + raise ValidationError( + "'%s' request wasn't be able to populate the uri '%s' with " + "'%s' args" % (self.__class__.__name__, self.uri, self.args)) + return str(populated_uri).strip('/') + def clean(self): self.uri = self.clean_uri() or self.uri - self.body = Body(self.clean_body(), self.clean_valid_body(), - self.validate_body) + self.body = Body(self.clean_body(), **self._clean_valid_body()) def clean_body(self): return self.body @@ -65,7 +77,7 @@ class Request(object): def clean_uri(self): return None - def clean_valid_body(self): + def _clean_valid_body(self): schema = set(self.body_schema.get('schema', ())) required = set(self.body_schema.get('required', ())) if not required.issubset(schema): @@ -75,27 +87,9 @@ class Request(object): self.__class__.__name__, required, schema)) return dict(schema=schema, required=required) - def __getattr__(self, name): - return self.args.get(name) - - def __str__(self): - return self.populate_uri() - - def populate_uri(self): - try: - populated_uri = self.uri.format(**self.args) - except KeyError: - raise ValidationError( - "'%s' request wasn't be able to populate the uri '%s' with " - "'%s' args" % (self.__class__.__name__, self.uri, self.args)) - return str(populated_uri).strip('/') - def get_body(self): return self.body.dumps() - def validate_body(self, *args): - pass - class Factory(object): """ Request builder """ diff --git a/pygithub3/tests/requests/test_core.py b/pygithub3/tests/requests/test_core.py index 4632056..110f00e 100644 --- a/pygithub3/tests/requests/test_core.py +++ b/pygithub3/tests/requests/test_core.py @@ -2,14 +2,12 @@ # -*- encoding: utf-8 -*- from mock import Mock -from nose.tools import raises from pygithub3.tests.utils.core import TestCase from pygithub3.requests.base import Factory, Body, json, Request from pygithub3.exceptions import (UriInvalid, RequestDoesNotExist, ValidationError, InvalidBodySchema) -from pygithub3.tests.utils.base import (mock_json, DummyRequest, - DummyRequestValidation) +from pygithub3.tests.utils.base import mock_json, DummyRequest from pygithub3.tests.utils.requests import ( RequestWithArgs, RequestCleanedUri, RequestBodyInvalidSchema, RequestCleanedBody) @@ -76,7 +74,7 @@ class TestRequestBodyWithSchema(TestCase): def setUp(self): valid_body = dict(schema=('arg1', 'arg2'), required=('arg1', )) - self.b = Body({}, valid_body) + self.b = Body({}, **valid_body) def test_with_body_empty_and_schema_permissive(self): self.b.schema = ('arg1', 'arg2', '...') @@ -102,14 +100,3 @@ class TestRequestBodyWithSchema(TestCase): def test_only_valid_keys(self): self.b.content = dict(arg1='arg1', arg2='arg2', fake='test') self.assertEqual(self.b.dumps(), dict(arg1='arg1', arg2='arg2')) - - -class TestBodyValidation(TestCase): - @raises(ValidationError) - def test_with_error(self): - req = DummyRequestValidation( - body={'foo': 'bar', 'error': 'yes'}, - ) - req.body_schema = {'schema': ('foo',), - 'required': ('foo',)} - req.get_body() diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py index b3c3b76..f90b5d3 100644 --- a/pygithub3/tests/utils/base.py +++ b/pygithub3/tests/utils/base.py @@ -4,7 +4,7 @@ from mock import Mock from pygithub3.resources.base import Resource -from pygithub3.requests.base import Request, ValidationError +from pygithub3.requests.base import Request def mock_json(content): @@ -37,14 +37,3 @@ DummyResource.loads = Mock(side_effect=loads_mock) class DummyRequest(Request): uri = 'dummyrequest' resource = DummyResource - - -class DummyRequestValidation(DummyRequest): - body_schema = { - 'schema': ('foo', 'error'), - 'required': ('foo',) - } - - def validate_body(self, body): - if body.get('error') == 'yes': - raise ValidationError('yes') -- cgit v1.2.3-59-g8ed1b