diff options
Diffstat (limited to 'pygithub3')
29 files changed, 1359 insertions, 602 deletions
diff --git a/pygithub3/__init__.py b/pygithub3/__init__.py index 0841aec..1e9d3e1 100644 --- a/pygithub3/__init__.py +++ b/pygithub3/__init__.py @@ -7,3 +7,5 @@ __author__ = 'David Medina' __email__ = 'davidmedina9@gmail.com' __license__ = 'ISC' __copyright__ = 'Copyright 2012 David Medina' + +from github import Github diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py index a9e9ad4..ce6cf7c 100644 --- a/pygithub3/core/client.py +++ b/pygithub3/core/client.py @@ -15,12 +15,6 @@ class Client(object): """ Client to send configurated requests""" def __init__(self, **kwargs): - """ - It can be configurated - - :login, :password, :user, :repo, :token, :per_page, :base_url, :verbose - """ - self.requester = requests.session() self.config = { 'per_page': 100, diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py index 226d6ab..5a2aa80 100644 --- a/pygithub3/core/result.py +++ b/pygithub3/core/result.py @@ -135,10 +135,43 @@ class Page(object): class Result(object): - """ """ + """ + Result is a very lazy paginator. It only do a real request when is needed + + You have several ways to consume it + + #. Iterating over the result:: + + result = some_request() + for page in result: + for resource in page: + print resource + + #. With a generator:: + + result = some_request() + for resource in result.iterator(): + print resource + + #. As a list:: + + result = some_request() + print result.all() + + #. Also you can request some page manually + + .. autoattribute:: pygithub3.core.result.Result.pages + .. automethod:: pygithub3.core.result.Result.get_page + + Each ``Page`` is an iterator and contains resources:: + + result = some_request() + assert result.pages > 3 + page3 = result.get_page(3) + page3_resources = list(page3) + """ def __init__(self, client, request, **kwargs): - """ """ self.getter = Method(client.get, request, **kwargs) self.page = Page(self.getter) @@ -158,9 +191,14 @@ class Result(object): @property def pages(self): + """ Total number of pages in request """ return self.getter.last def get_page(self, page): + """ Get ``Page`` of resources + + :param int page: Page number + """ if page in xrange(1, self.pages + 1): return Page(self.getter, page) return None diff --git a/pygithub3/github.py b/pygithub3/github.py index 4941ffd..5b5353d 100644 --- a/pygithub3/github.py +++ b/pygithub3/github.py @@ -2,20 +2,33 @@ # -*- encoding: utf-8 -*- from pygithub3.services.users import User -from pygithub3.services.repos import Repo +from pygithub3.services.repos import Repos class Github(object): - """ Main entrance """ + """ + You can preconfigure all services globally with a ``config`` dict. See + :attr:`~pygithub3.services.base.Service` + + Example:: + + gh = Github(user='kennethreitz', token='ABC...', repo='requests') + """ def __init__(self, **config): self._users = User(**config) - self._repos = Repo(**config) + self._repos = Repos(**config) @property def users(self): + """ + :ref:`User service <User service>` + """ return self._users @property def repos(self): + """ + :ref:`Repos service <Repos service>` + """ return self._repos diff --git a/pygithub3/requests/__init__.py b/pygithub3/requests/__init__.py index b369565..dae354a 100644 --- a/pygithub3/requests/__init__.py +++ b/pygithub3/requests/__init__.py @@ -1,137 +1 @@ -#!/usr/bin/env python # -*- encoding: utf-8 -*- - -import re -from importlib import import_module -try: - import simplejson as json -except ImportError: - import json - -from pygithub3.exceptions import (DoesNotExists, UriInvalid, ValidationError, - InvalidBodySchema) -from pygithub3.resources.base import Raw - -ABS_IMPORT_PREFIX = 'pygithub3.requests' - - -class Body(object): - - def __init__(self, content, schema, required): - self.content = content - self.schema = schema - self.required = required - - def dumps(self): - if not self.schema: - return self.content or None - return json.dumps(self.parse()) - - def parse(self): - if not hasattr(self.content, 'items'): - raise ValidationError("'%s' needs a content dictionary" - % self.__class__.__name__) - parsed = {key: self.content[key] for key in self.schema - if key in self.content} - for attr_required in self.required: - if attr_required not in parsed: - raise ValidationError("'%s' attribute is required" % - attr_required) - if not parsed[attr_required]: - raise ValidationError("'%s' attribute can't be empty" % - attr_required) - return parsed - - -class Request(object): - """ """ - - uri = '' - resource = Raw - body_schema = {} - - def __init__(self, **kwargs): - """ """ - self.body = kwargs.pop('body', None) - self.args = kwargs - self.clean() - - def clean(self): - self.uri = self.clean_uri() or self.uri - self.body = Body(self.clean_body(), **self.clean_valid_body()) - - def clean_body(self): - return self.body - - def clean_uri(self): - return None - - def clean_valid_body(self): - schema = set(self.body_schema.get('schema', ())) - required = set(self.body_schema.get('required', ())) - if not required.issubset(schema): - raise InvalidBodySchema( - "'%s:valid_body' attribute is invalid. " - "'%s required' isn't a subset of '%s schema'" % ( - 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() - - -class Factory(object): - """ """ - - import_pattern = re.compile(r'^(\w+\.)+\w+$') - - def __validate(func): - """ """ - - def wrapper(self, request_uri, **kwargs): - if not Factory.import_pattern.match(request_uri): - raise UriInvalid("'%s' isn't valid form" % request_uri) - return func(self, request_uri.lower(), **kwargs) - return wrapper - - def __dispatch(func): - """ """ - - def wrapper(self, request_uri, **kwargs): - module_chunk, s, request_chunk = request_uri.rpartition('.') - try: - # TODO: CamelCase and under_score support, now only Class Name - module = import_module('%s.%s' - % (ABS_IMPORT_PREFIX, module_chunk)) - request = getattr(module, request_chunk.capitalize()) - except ImportError: - raise DoesNotExists("'%s' module does not exists" - % module_chunk) - except AttributeError: - raise DoesNotExists( - "'%s' request doesn't exists into '%s' module" - % (request_chunk.capitalize(), module_chunk)) - return func(self, request, **kwargs) - return wrapper - - @__validate - @__dispatch - def __call__(self, request='', **kwargs): - request = request(**kwargs) - assert isinstance(request, Request) - return request diff --git a/pygithub3/requests/base.py b/pygithub3/requests/base.py new file mode 100644 index 0000000..4b1aa9b --- /dev/null +++ b/pygithub3/requests/base.py @@ -0,0 +1,137 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import re +from importlib import import_module +try: + import simplejson as json +except ImportError: + import json + +from pygithub3.exceptions import (DoesNotExists, UriInvalid, ValidationError, + InvalidBodySchema) +from pygithub3.resources.base import Raw + +ABS_IMPORT_PREFIX = 'pygithub3.requests' + + +class Body(object): + + def __init__(self, content, schema, required): + self.content = content + self.schema = schema + self.required = required + + def dumps(self): + if not self.schema: + return self.content or None + return json.dumps(self.parse()) + + def parse(self): + if not hasattr(self.content, 'items'): + raise ValidationError("'%s' needs a content dictionary" + % self.__class__.__name__) + parsed = {key: self.content[key] for key in self.schema + if key in self.content} + for attr_required in self.required: + if attr_required not in parsed: + raise ValidationError("'%s' attribute is required" % + attr_required) + if not parsed[attr_required]: + raise ValidationError("'%s' attribute can't be empty" % + attr_required) + return parsed + + +class Request(object): + """ """ + + uri = '' + resource = Raw + body_schema = {} + + def __init__(self, **kwargs): + """ """ + self.body = kwargs.pop('body', None) + self.args = kwargs + self.clean() + + def clean(self): + self.uri = self.clean_uri() or self.uri + self.body = Body(self.clean_body(), **self.clean_valid_body()) + + def clean_body(self): + return self.body + + def clean_uri(self): + return None + + def clean_valid_body(self): + schema = set(self.body_schema.get('schema', ())) + required = set(self.body_schema.get('required', ())) + if not required.issubset(schema): + raise InvalidBodySchema( + "'%s:valid_body' attribute is invalid. " + "'%s required' isn't a subset of '%s schema'" % ( + 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() + + +class Factory(object): + """ """ + + import_pattern = re.compile(r'^(\w+\.)+\w+$') + + def validate(func): + """ """ + + def wrapper(self, request_uri, **kwargs): + if not Factory.import_pattern.match(request_uri): + raise UriInvalid("'%s' isn't valid form" % request_uri) + return func(self, request_uri.lower(), **kwargs) + return wrapper + + def dispatch(func): + """ """ + + def wrapper(self, request_uri, **kwargs): + module_chunk, s, request_chunk = request_uri.rpartition('.') + try: + # TODO: CamelCase and under_score support, now only Class Name + module = import_module('%s.%s' + % (ABS_IMPORT_PREFIX, module_chunk)) + request = getattr(module, request_chunk.capitalize()) + except ImportError: + raise DoesNotExists("'%s' module does not exists" + % module_chunk) + except AttributeError: + raise DoesNotExists( + "'%s' request doesn't exists into '%s' module" + % (request_chunk.capitalize(), module_chunk)) + return func(self, request, **kwargs) + return wrapper + + @validate + @dispatch + def __call__(self, request='', **kwargs): + request = request(**kwargs) + assert isinstance(request, Request) + return request diff --git a/pygithub3/requests/repos/__init__.py b/pygithub3/requests/repos/__init__.py index bb86dac..5c7785a 100644 --- a/pygithub3/requests/repos/__init__.py +++ b/pygithub3/requests/repos/__init__.py @@ -1,4 +1,80 @@ # -*- encoding: utf-8 -*- -from pygithub3.requests import Request, ValidationError -from repo import * +from ..base import Request, ValidationError +from pygithub3.resources.users import User +from pygithub3.resources.repos import Repo, Team, Tag, Branch + +class List(Request): + + uri = 'users/{user}/repos' + resource = Repo + + def clean_uri(self): + if not self.user: + return 'user/repos' + + +class List_by_org(Request): + + uri = 'orgs/{org}/repos' + resource = Repo + + +class Create(Request): + + uri = 'orgs/{org}/repos' + resource = Repo + body_schema = { + 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', + 'has_wiki', 'has_downloads', 'team_id'), + 'required': ('name', ) + } + + def clean_uri(self): + if not self.org: + return 'user/repos' + + +class Get(Request): + + uri = 'repos/{user}/{repo}' + resource = Repo + + +class Update(Request): + + uri = 'repos/{user}/{repo}' + resource = Repo + body_schema = { + 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', + 'has_wiki', 'has_downloads', 'team_id'), + 'required': ('name', ) + } + + +class List_contributors(Request): + + uri = 'repos/{user}/{repo}/contributors' + resource = User + + +class List_languages(Request): + + uri = 'repos/{user}/{repo}/languages' + + +class List_teams(Request): + + uri = 'repos/{user}/{repo}/teams' + resource = Team + + +class List_tags(Request): + + uri = 'repos/{user}/{repo}/tags' + resource = Tag + +class List_branches(Request): + + uri = 'repos/{user}/{repo}/branches' + resource = Branch diff --git a/pygithub3/requests/repos/collaborators.py b/pygithub3/requests/repos/collaborators.py index c4b5f79..068a9dc 100644 --- a/pygithub3/requests/repos/collaborators.py +++ b/pygithub3/requests/repos/collaborators.py @@ -4,6 +4,7 @@ from . import Request from pygithub3.resources.users import User + class List(Request): uri = 'repos/{user}/{repo}/collaborators' diff --git a/pygithub3/requests/repos/repo.py b/pygithub3/requests/repos/repo.py deleted file mode 100644 index 45375a9..0000000 --- a/pygithub3/requests/repos/repo.py +++ /dev/null @@ -1,86 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from . import Request -from pygithub3.resources.repos import Repo, Team, Tag, Branch -from pygithub3.resources.users import User - -__all__ = ('List', 'List_by_org', 'Create', 'Get', 'Update', - 'List_contributors', 'List_languages', 'List_teams', 'List_tags', - 'List_branches') - - -class List(Request): - - uri = 'users/{user}/repos' - resource = Repo - - def clean_uri(self): - if not self.user: - return 'user/repos' - - -class List_by_org(Request): - - uri = 'orgs/{org}/repos' - resource = Repo - - -class Create(Request): - - uri = 'orgs/{org}/repos' - resource = Repo - body_schema = { - 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', - 'has_wiki', 'has_downloads', 'team_id'), - 'required': ('name', ) - } - - def clean_uri(self): - if not self.org: - return 'user/repos' - - -class Get(Request): - - uri = 'repos/{user}/{repo}' - resource = Repo - - -class Update(Request): - - uri = 'repos/{user}/{repo}' - resource = Repo - body_schema = { - 'schema': ('name', 'description', 'homepage', 'private', 'has_issues', - 'has_wiki', 'has_downloads', 'team_id'), - 'required': ('name', ) - } - - -class List_contributors(Request): - - uri = 'repos/{user}/{repo}/contributors' - resource = User - - -class List_languages(Request): - - uri = 'repos/{user}/{repo}/languages' - - -class List_teams(Request): - - uri = 'repos/{user}/{repo}/teams' - resource = Team - - -class List_tags(Request): - - uri = 'repos/{user}/{repo}/tags' - resource = Tag - -class List_branches(Request): - - uri = 'repos/{user}/{repo}/branches' - resource = Branch diff --git a/pygithub3/requests/users/__init__.py b/pygithub3/requests/users/__init__.py index 11e6a39..d8df00d 100644 --- a/pygithub3/requests/users/__init__.py +++ b/pygithub3/requests/users/__init__.py @@ -1,4 +1,32 @@ # -*- encoding: utf-8 -*- -from pygithub3.requests import Request, ValidationError -from user import * +from ..base import Request, ValidationError +from pygithub3.resources.users import User + + +class Get(Request): + + resource = User + uri = 'users/{user}' + + def clean_uri(self): + if not self.user: + return 'user' + + +class Update(Request): + + resource = User + uri = 'user' + body_schema = { + 'schema': ('name', 'email', 'blog', 'company', 'location', 'hireable', + 'bio'), + 'required': (), + } + + def clean_body(self): + if not self.body: + raise ValidationError("'%s' request needs data. You can use " + "'%s' keys" % (self.__class__.__name__, + self.body_schema)) + return self.body diff --git a/pygithub3/requests/users/emails.py b/pygithub3/requests/users/emails.py index ae4d8b8..ff89b62 100644 --- a/pygithub3/requests/users/emails.py +++ b/pygithub3/requests/users/emails.py @@ -25,7 +25,7 @@ class Add(Request): def clean_body(self): def is_email(email): - return bool(email_re.match(email)) # TODO: email regex ;) + return bool(email_re.match(email)) if not self.body: raise ValidationError("'%s' request needs emails" % (self.__class__.__name__)) diff --git a/pygithub3/requests/users/user.py b/pygithub3/requests/users/user.py deleted file mode 100644 index 3267f76..0000000 --- a/pygithub3/requests/users/user.py +++ /dev/null @@ -1,35 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from . import Request, ValidationError -from pygithub3.resources.users import User - -__all__ = ('Get', 'Update') - - -class Get(Request): - - resource = User - uri = 'users/{user}' - - def clean_uri(self): - if not self.user: - return 'user' - - -class Update(Request): - - resource = User - uri = 'user' - body_schema = { - 'schema': ('name', 'email', 'blog', 'company', 'location', 'hireable', - 'bio'), - 'required': (), - } - - def clean_body(self): - if not self.body: - raise ValidationError("'%s' request needs data. You can use " - "'%s' keys" % (self.__class__.__name__, - self.body_schema)) - return self.body diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index 21b22eb..8602150 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -3,11 +3,39 @@ from pygithub3.core.client import Client from pygithub3.core.result import Result -from pygithub3.requests import Factory +from pygithub3.requests.base import Factory from pygithub3.core.errors import NotFound class Service(object): + """ + You can configure each service with this keyword variables: + + :param str login: Username to authenticate + :param str password: Username to authenticate + :param str user: Default username in requests + :param str repo: Default repository in requests + :param str token: Token to OAuth + :param int per_page: Items in each page of multiple returns + :param str base_url: To support another github-related API (untested) + :param stream verbose: Stream to write debug logs + + You can configure the **authentication** with BasicAuthentication (login + and password) and with `OAuth <http://developer.github.com/v3/oauth/>`_ ( + token). + If you include ``login``, ``password`` and ``token`` in config; Oauth has + precedence + + Some API requests need ``user`` and/or ``repo`` arguments (e.g + :ref:`repos service <config precedence>`). + You can configure the default value here to avoid repeating + + Some API requests return multiple resources with pagination. You can + configure how many items has each page. + + You can configure ``verbose`` logging like `requests library <http://docs. + python-requests.org/en/v0.10.6/user/advanced/#verbose-logging>`_ + """ def __init__(self, **config): self._client = Client(**config) @@ -17,18 +45,35 @@ class Service(object): return self._client.user def set_user(self, user): + """ Set user + + :param str user: Default username in requests + """ self._client.user = user def get_repo(self): return self._client.repo def set_repo(self, repo): + """ Set repository + + :param str repo: Default repository in requests + """ self._client.repo = repo def set_credentials(self, login, password): + """ Set Basic Authentication + + :param str login: Username to authenticate + :param str password: Username to authenticate + """ self._client.set_credentials(login, password) def set_token(self, token): + """ Set OAuth token + + :param str token: Token to OAuth + """ self._client.set_token(token) def make_request(self, request, **kwargs): @@ -90,6 +135,11 @@ class Service(object): class MimeTypeMixin(object): + """ + Mimetype support to Services + + Adds 4 public functions to service: + """ VERSION = 'beta' @@ -97,16 +147,21 @@ class MimeTypeMixin(object): self.mimetype = 'application/vnd.github.%s.%s+json' % ( self.VERSION, mimetype) - def set_raw_mimetype(self): + def set_raw(self): + """ Resource will have ``body`` attribute """ self.__set_mimetype('raw') - def set_text_mimetype(self): + def set_text(self): + """ Resource will have ``body_text`` attribute """ self.__set_mimetype('text') - def set_html_mimetype(self): + def set_html(self): + """ Resource will have ``body_html`` attribute """ self.__set_mimetype('html') - def set_full_mimetype(self): + def set_full(self): + """ Resource will have ``body`` ``body_text`` and ``body_html`` + attributes """ self.__set_mimetype('full') def _get_mimetype_as_header(self): diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py deleted file mode 100644 index b20d317..0000000 --- a/pygithub3/services/repos.py +++ /dev/null @@ -1,233 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -import requests - -from .base import Service, MimeTypeMixin - - -class Watchers(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.watchers.list', - user=user, repo=repo) - return self._get_result(request) - - def list_repos(self, user=None): - request = self.make_request('repos.watchers.list_repos', user=user) - return self._get_result(request) - - def is_watching(self, user=None, repo=None): - request = self.make_request('repos.watchers.is_watching', - user=user, repo=repo) - return self._bool(request) - - def watch(self, user=None, repo=None): - request = self.make_request('repos.watchers.watch', - user=user, repo=repo) - self._put(request) - - def unwatch(self, user=None, repo=None): - request = self.make_request('repos.watchers.unwatch', - user=user, repo=repo) - self._delete(request) - - -class Keys(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.keys.list', user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.keys.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.keys.create', - body=data, user=user, repo=repo) - return self._post(request) - - def update(self, id, data, user=None, repo=None): - request = self.make_request('repos.keys.update', - id=id, body=data, user=user, repo=repo) - return self._patch(request) - - def delete(self, id, user=None, repo=None): - request = self.make_request('repos.keys.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Forks(Service): - - def list(self, user=None, repo=None, sort='newest'): - request = self.make_request('repos.forks.list', user=user, repo=repo) - return self._get_result(request, sort=sort) - - def create(self, user=None, repo=None, org=None): - request = self.make_request('repos.forks.create', user=user, repo=repo) - org = {'org': org} if org else {} - return self._post(request, **org) - - -class Downloads(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.downloads.list', - user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.downloads.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.downloads.create', - body=data, user=user, repo=repo) - download = self._post(request) - - # TODO: improve it. e.g Manage all with file desc - def upload(file_path): - body = download.ball_to_upload() - body['file'] = (file_path, open(file_path, 'rb')) - return requests.post(download.s3_url, files=body) - - download.upload = upload - return download - - def delete(self, id=id, user=None, repo=None): - request = self.make_request('repos.downloads.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Commits(Service, MimeTypeMixin): - - """ TODO: Pagination structure differs from usual - def list(self, user=None, repo=None, sha='', path=''): - request = self.make_request('repos.commits.list', user=user, repo=repo) - return self._get_result(request, sha=sha, path=path) - """ - - def get(self, sha, user=None, repo=None): - request = self.make_request('repos.commits.get', - sha=sha, user=user, repo=repo) - return self._get(request) - - def list_comments(self, sha=None, user=None, repo=None): - request = self.make_request('repos.commits.list_comments', - sha=sha, user=user, repo=repo) - return self._get_result(request, **self._get_mimetype_as_header()) - - def create_comment(self, data, sha, user=None, repo=None): - request = self.make_request('repos.commits.create_comment', - sha=sha, user=user, repo=repo, body=data) - return self._post(request, **self._get_mimetype_as_header()) - - def get_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.get_comment', - comment_id=cid, user=user, repo=repo) - return self._get(request, **self._get_mimetype_as_header()) - - def update_comment(self, data, cid, user=None, repo=None): - request = self.make_request('repos.commits.update_comment', - comment_id=cid, user=user, repo=repo, body=data) - return self._patch(request, **self._get_mimetype_as_header()) - - def compare(self, base, head, user=None, repo=None): - request = self.make_request('repos.commits.compare', - base=base, head=head, user=user, repo=repo) - return self._get(request) - - def delete_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.delete_comment', - comment_id=cid, user=user, repo=repo) - self._delete(request) - - -class Collaborator(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.collaborators.list', - user=user, repo=repo) - return self._get_result(request) - - def add(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.add', - collaborator=collaborator, user=user, repo=repo) - return self._put(request) - - def is_collaborator(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.is_collaborator', - collaborator=collaborator, user=user, repo=repo) - return self._bool(request) - - def delete(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.delete', - collaborator=collaborator, user=user, repo=repo) - self._delete(request) - - -class Repo(Service): - - def __init__(self, **config): - self.collaborators = Collaborator(**config) - self.commits = Commits(**config) - self.downloads = Downloads(**config) - self.forks = Forks(**config) - self.keys = Keys(**config) - self.watchers = Watchers(**config) - super(Repo, self).__init__(**config) - - def list(self, user=None, type='all'): - request = self.make_request('repos.list', user=user) - return self._get_result(request, type=type) - - def list_by_org(self, org, type='all'): - request = self.make_request('repos.list_by_org', org=org) - return self._get_result(request, type=type) - - def create(self, data, in_org=None): - request = self.make_request('repos.create', org=in_org, body=data) - return self._post(request) - - def get(self, user=None, repo=None): - request = self.make_request('repos.get', user=user, repo=repo) - return self._get(request) - - def update(self, data, user=None, repo=None): - request = self.make_request('repos.update', body=data, - user=user, repo=repo) - return self._patch(request) - - def __list_contributors(self, user=None, repo=None, **kwargs): - request = self.make_request('repos.list_contributors', - user=user, repo=repo) - return self._get_result(request, **kwargs) - - def list_contributors(self, user=None, repo=None): - return self.__list_contributors(user, repo) - - def list_contributors_with_anonymous(self, user=None, repo=None): - return self.__list_contributors(user, repo, anom=True) - - def list_languages(self, user=None, repo=None): - request = self.make_request('repos.list_languages', - user=user, repo=repo) - return self._get(request) - - def list_teams(self, user=None, repo=None): - request = self.make_request('repos.list_teams', user=user, repo=repo) - return self._get_result(request) - - def list_tags(self, user=None, repo=None): - request = self.make_request('repos.list_tags', user=user, repo=repo) - return self._get_result(request) - - def list_branches(self, user=None, repo=None): - request = self.make_request('repos.list_branches', - user=user, repo=repo) - return self._get_result(request) diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py new file mode 100644 index 0000000..484dd49 --- /dev/null +++ b/pygithub3/services/repos/__init__.py @@ -0,0 +1,190 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service, MimeTypeMixin +from .collaborators import Collaborators +from .commits import Commits +from .downloads import Downloads +from .forks import Forks +from .keys import Keys +from .watchers import Watchers + + +class Repos(Service): + """ Consume `Repos API <http://developer.github.com/v3/repos>`_ """ + + def __init__(self, **config): + self.collaborators = Collaborators(**config) + self.commits = Commits(**config) + self.downloads = Downloads(**config) + self.forks = Forks(**config) + self.keys = Keys(**config) + self.watchers = Watchers(**config) + super(Repos, self).__init__(**config) + + def list(self, user=None, type='all'): + """ Get user's repositories + + :param str user: Username + :param str type: Filter by type (optional). See `github repos doc`_ + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's repositories + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + repo_service.list('copitux', type='owner') + repo_service.list(type='private') + """ + request = self.make_request('repos.list', user=user) + return self._get_result(request, type=type) + + def list_by_org(self, org, type='all'): + """ Get organization's repositories + + :param str org: Organization name + :param str type: Filter by type (optional). See `github repos doc`_ + :returns: A :doc:`result` + + :: + + repo_service.list_by_org('myorganization', type='member') + """ + request = self.make_request('repos.list_by_org', org=org) + return self._get_result(request, type=type) + + def create(self, data, in_org=None): + """ Create a new repository + + :param dict data: Input. See `github repos doc`_ + :param str in_org: Organization where create the repository (optional) + + .. warning:: + + You must be authenticated + + If you use ``in_org`` arg, the authenticated user must be a member + of <in_org> + + :: + + repo_service.create(dict(name='new_repo', description='desc')) + repo_service.create(dict(name='new_repo_in_org', team_id=2300), + in_org='myorganization') + """ + request = self.make_request('repos.create', org=in_org, body=data) + return self._post(request) + + def get(self, user=None, repo=None): + """ Get a single repo + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.get', user=user, repo=repo) + return self._get(request) + + def update(self, data, user=None, repo=None): + """ Update a single repository + + :param dict data: Input. See `github repos doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + + :: + + repo_service.update(dict(has_issues=True), user='octocat', + repo='oct_repo') + """ + request = self.make_request('repos.update', body=data, + user=user, repo=repo) + return self._patch(request) + + def __list_contributors(self, user=None, repo=None, **kwargs): + request = self.make_request('repos.list_contributors', + user=user, repo=repo) + return self._get_result(request, **kwargs) + + def list_contributors(self, user=None, repo=None): + """ Get repository's contributors + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + return self.__list_contributors(user, repo) + + def list_contributors_with_anonymous(self, user=None, repo=None): + """ Like :attr:`~pygithub3.services.repos.Repos.list_contributors` plus + anonymous """ + return self.__list_contributors(user, repo, anom=True) + + def list_languages(self, user=None, repo=None): + """ Get repository's languages + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_languages', + user=user, repo=repo) + return self._get(request) + + def list_teams(self, user=None, repo=None): + """ Get repository's teams + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_teams', user=user, repo=repo) + return self._get_result(request) + + def list_tags(self, user=None, repo=None): + """ Get repository's tags + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_tags', user=user, repo=repo) + return self._get_result(request) + + def list_branches(self, user=None, repo=None): + """ Get repository's branches + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_branches', + user=user, repo=repo) + return self._get_result(request) diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py new file mode 100644 index 0000000..f80a406 --- /dev/null +++ b/pygithub3/services/repos/collaborators.py @@ -0,0 +1,71 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Collaborators(Service): + """ Consume `Repo Collaborators API + <http://developer.github.com/v3/repos/collaborators>`_ """ + + def list(self, user=None, repo=None): + """ Get repository's collaborators + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.collaborators.list', + user=user, repo=repo) + return self._get_result(request) + + def add(self, collaborator, user=None, repo=None): + """ Add collaborator to a repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in repository + """ + request = self.make_request('repos.collaborators.add', + collaborator=collaborator, user=user, repo=repo) + return self._put(request) + + def is_collaborator(self, collaborator, user=None, repo=None): + """ Check if a user is collaborator on repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.collaborators.is_collaborator', + collaborator=collaborator, user=user, repo=repo) + return self._bool(request) + + def delete(self, collaborator, user=None, repo=None): + """ Remove collaborator from repository + + :param str collaborator: Collaborator's username + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in repository + """ + request = self.make_request('repos.collaborators.delete', + collaborator=collaborator, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py new file mode 100644 index 0000000..8eec3e7 --- /dev/null +++ b/pygithub3/services/repos/commits.py @@ -0,0 +1,156 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service, MimeTypeMixin + + +class Commits(Service, MimeTypeMixin): + """ Consume `Commits API + <http://developer.github.com/v3/repos/commits>`_ + + .. note:: + This service support :ref:`mimetypes` configuration + """ + + #TODO: Pagination structure differs from usual + #def list(self, user=None, repo=None, sha='', path=''): + #request = self.make_request('repos.commits.list', user=user, repo=repo) + #return self._get_result(request, sha=sha, path=path) + + def get(self, sha, user=None, repo=None): + """ Get a single commit + + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.commits.get', + sha=sha, user=user, repo=repo) + return self._get(request) + + def list_comments(self, sha=None, user=None, repo=None): + """ Get commit's comments + + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + + If you call it without ``sha``, get all commit's comments of a + repository + :: + + commits_service.list_comments('6dcb09', user='octocat', + repo='oct_repo') + commits_service.list_comments(user='octocat', repo='oct_repo') + """ + request = self.make_request('repos.commits.list_comments', + sha=sha, user=user, repo=repo) + return self._get_result(request, **self._get_mimetype_as_header()) + + def create_comment(self, data, sha, user=None, repo=None): + """ Create a commit comment + + :param dict data: Input. See `github commits doc`_ + :param str sha: Commit's sha + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + + :: + + data = { + "body": "Nice change", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "line": 1, + "path": "file1.txt", + "position": 4 + } + commits_service.create_comment(data, '6dcb09', user='octocat', + repo='oct_repo') + """ + request = self.make_request('repos.commits.create_comment', + sha=sha, user=user, repo=repo, body=data) + return self._post(request, **self._get_mimetype_as_header()) + + def get_comment(self, cid, user=None, repo=None): + """ Get a single commit comment + + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.commits.get_comment', + comment_id=cid, user=user, repo=repo) + return self._get(request, **self._get_mimetype_as_header()) + + def update_comment(self, data, cid, user=None, repo=None): + """ Update a single commit comment + + :param dict data: Input. See `github commits doc`_ + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + + :: + + commits_service.update_comment(dict(body='nice change'), 42, + user='octocat', repo='oct_repo') + """ + request = self.make_request('repos.commits.update_comment', + comment_id=cid, user=user, repo=repo, body=data) + return self._patch(request, **self._get_mimetype_as_header()) + + def compare(self, base, head, user=None, repo=None): + """ Compare two commits + + :param str base: Base commit sha + :param str head: Head commit sha + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + :: + + commits_service.compare('6dcb09', 'master', user='octocat', + repo='oct_repo') + """ + request = self.make_request('repos.commits.compare', + base=base, head=head, user=user, repo=repo) + return self._get(request) + + def delete_comment(self, cid, user=None, repo=None): + """ Delete a single commit comment + + :param int cid: Commit comment id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.commits.delete_comment', + comment_id=cid, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/downloads.py b/pygithub3/services/repos/downloads.py new file mode 100644 index 0000000..47c7785 --- /dev/null +++ b/pygithub3/services/repos/downloads.py @@ -0,0 +1,94 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import requests + +from . import Service + + +class Downloads(Service): + """ Consume `Downloads API + <http://developer.github.com/v3/repos/downloads>`_ """ + + def list(self, user=None, repo=None): + """ Get repository's downloads + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.downloads.list', + user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + """ Get a single download + + :param int id: Download id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.downloads.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + """ Create a new download + + :param dict data: Input. See `github downloads doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + It is a two step process. After you create the download, you must + call the ``upload`` function of ``Download`` resource with + ``file_path`` + + .. warning:: + In `alpha` state + + :: + + # Step 1 + download = downloads_service.create( + dict(name='new_download', size=1130), + user='octocat', repo='oct_repo') + + # Step 2 + download.upload('/home/user/file.ext') + """ + request = self.make_request('repos.downloads.create', + body=data, user=user, repo=repo) + download = self._post(request) + + # TODO: improve it. e.g Manage all with file desc + def upload(file_path): + """ """ + body = download.ball_to_upload() + body['file'] = (file_path, open(file_path, 'rb')) + return requests.post(download.s3_url, files=body) + + download.upload = upload + return download + + def delete(self, id, user=None, repo=None): + """ Delete a download + + :param int id: Download id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.downloads.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/forks.py b/pygithub3/services/repos/forks.py new file mode 100644 index 0000000..df51347 --- /dev/null +++ b/pygithub3/services/repos/forks.py @@ -0,0 +1,52 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Forks(Service): + """ Consume `Forks API + <http://developer.github.com/v3/repos/forks>`_ """ + + def list(self, user=None, repo=None, sort='newest'): + """ Get repository's forks + + :param str user: Username + :param str repo: Repository + :param str sort: Order resources (optional). See `github forks doc`_ + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + + :: + + forks_service.list(user='octocat', repo='oct_repo', sort='oldest') + """ + request = self.make_request('repos.forks.list', user=user, repo=repo) + return self._get_result(request, sort=sort) + + def create(self, user=None, repo=None, org=None): + """ Fork a repository + + :param str user: Username + :param str repo: Repository + :param str org: Organization name (optional) + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + + If you call it with ``org``, the repository will be forked into this + organization. + :: + + forks_service.create(user='octocat', repo='oct_repo') + forks_service.create(user='octocat', repo='oct_repo', + org='myorganization' + """ + request = self.make_request('repos.forks.create', user=user, repo=repo) + org = org and {'org': org} or {} + return self._post(request, **org) diff --git a/pygithub3/services/repos/keys.py b/pygithub3/services/repos/keys.py new file mode 100644 index 0000000..1ade8a1 --- /dev/null +++ b/pygithub3/services/repos/keys.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + """ Consume `Deploy keys API + <http://developer.github.com/v3/repos/keys>`_ """ + + def list(self, user=None, repo=None): + """ Get repository's keys + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.keys.list', user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + """ Get a single repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.keys.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + """ Create a repository key + + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.create(dict(title='new key', key='ssh-rsa AAA...'), + user='octocat', repo='oct_repo') + """ + request = self.make_request('repos.keys.create', + body=data, user=user, repo=repo) + return self._post(request) + + def update(self, id, data, user=None, repo=None): + """ Update a repository key + + :param int id: Repository key id + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.update(42, dict(title='new title'), + user='octocat', repo='oct_repo') + """ + request = self.make_request('repos.keys.update', + id=id, body=data, user=user, repo=repo) + return self._patch(request) + + def delete(self, id, user=None, repo=None): + """ Delete a repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.keys.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/watchers.py b/pygithub3/services/repos/watchers.py new file mode 100644 index 0000000..7bcede5 --- /dev/null +++ b/pygithub3/services/repos/watchers.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Watchers(Service): + """ Consume `Watching API + <http://developer.github.com/v3/repos/watching>`_ """ + + def list(self, user=None, repo=None): + """ Get repository's watchers + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.watchers.list', + user=user, repo=repo) + return self._get_result(request) + + def list_repos(self, user=None): + """ Get repositories being watched by a user + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + repositories being watched by the authenticated user. + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + watchers_service.list_repos('copitux') + watchers_service.list_repos() + """ + request = self.make_request('repos.watchers.list_repos', user=user) + return self._get_result(request) + + def is_watching(self, user=None, repo=None): + """ Check if authenticated user is watching a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ + request = self.make_request('repos.watchers.is_watching', + user=user, repo=repo) + return self._bool(request) + + def watch(self, user=None, repo=None): + """ Watch a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ + request = self.make_request('repos.watchers.watch', + user=user, repo=repo) + self._put(request) + + def unwatch(self, user=None, repo=None): + """ Stop watching a repository + + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated + """ + request = self.make_request('repos.watchers.unwatch', + user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py deleted file mode 100644 index 2bf4302..0000000 --- a/pygithub3/services/users.py +++ /dev/null @@ -1,86 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from .base import Service - - -class Keys(Service): - - def list(self): - request = self.make_request('users.keys.list') - return self._get_result(request) - - def get(self, key_id): - request = self.make_request('users.keys.get', - key_id=key_id) - return self._get(request) - - def add(self, data): - request = self.make_request('users.keys.add', - body=data) - return self._post(request) - - def update(self, key_id, data): - request = self.make_request('users.keys.update', - key_id=key_id, body=data) - return self._patch(request) - - def delete(self, key_id): - request = self.make_request('users.keys.delete', - key_id=key_id) - self._delete(request) - - -class Followers(Service): - - def list(self, user=None): - request = self.make_request('users.followers.list', user=user) - return self._get_result(request) - - def list_following(self, user=None): - request = self.make_request('users.followers.listfollowing', user=user) - return self._get_result(request) - - def is_following(self, user): - request = self.make_request('users.followers.isfollowing', user=user) - return self._bool(request) - - def follow(self, user): - request = self.make_request('users.followers.follow', user=user) - self._put(request) - - def unfollow(self, user): - request = self.make_request('users.followers.unfollow', user=user) - self._delete(request) - - -class Emails(Service): - - def list(self): - request = self.make_request('users.emails.list') - return self._get_result(request) - - def add(self, *emails): - request = self.make_request('users.emails.add', body=emails) - return self._post(request) - - def delete(self, *emails): - request = self.make_request('users.emails.delete', body=emails) - self._delete(request) - - -class User(Service): - - def __init__(self, **config): - self.keys = Keys(**config) - self.emails = Emails(**config) - self.followers = Followers(**config) - super(User, self).__init__(**config) - - def get(self, user=None): - request = self.make_request('users.get', user=user) - return self._get(request) - - def update(self, data): - request = self.make_request('users.update', body=data) - return self._patch(request) diff --git a/pygithub3/services/users/__init__.py b/pygithub3/services/users/__init__.py new file mode 100644 index 0000000..29a8e1c --- /dev/null +++ b/pygithub3/services/users/__init__.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service +from .keys import Keys +from .emails import Emails +from .followers import Followers + + +class User(Service): + """ Consume `Users API <http://developer.github.com/v3/users>`_ """ + + def __init__(self, **config): + self.keys = Keys(**config) + self.emails = Emails(**config) + self.followers = Followers(**config) + super(User, self).__init__(**config) + + def get(self, user=None): + """ Get a single user + + :param str user: Username + + If you call it without user and you are authenticated, get the + authenticated user. + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + user_service.get('copitux') + user_service.get() + """ + request = self.make_request('users.get', user=user) + return self._get(request) + + def update(self, data): + """ Update the authenticated user + + :param dict data: Input to update + + :: + + user_service.update(dict(name='new_name', bio='new_bio')) + """ + request = self.make_request('users.update', body=data) + return self._patch(request) diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py new file mode 100644 index 0000000..09f6683 --- /dev/null +++ b/pygithub3/services/users/emails.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Emails(Service): + """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_ + + .. warning:: + You must be authenticated for all requests + """ + + def list(self): + """ Get user's emails + + :returns: A :doc:`result` + """ + request = self.make_request('users.emails.list') + return self._get_result(request) + + def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + It rejects non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.add', body=emails) + return self._post(request) + + def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.delete', body=emails) + self._delete(request) diff --git a/pygithub3/services/users/followers.py b/pygithub3/services/users/followers.py new file mode 100644 index 0000000..5a8176d --- /dev/null +++ b/pygithub3/services/users/followers.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Followers(Service): + """ Consume `Followers API + <http://developer.github.com/v3/users/followers/>`_ + """ + + def list(self, user=None): + """ Get user's followers + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followers + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list() + followers_service.list('octocat') + """ + request = self.make_request('users.followers.list', user=user) + return self._get_result(request) + + def list_following(self, user=None): + """ Get who a user is following + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followings + + .. warning:: + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list_following() + followers_service.list_following('octocat') + """ + request = self.make_request('users.followers.listfollowing', user=user) + return self._get_result(request) + + def is_following(self, user): + """ Check if you are following a user + + :param str user: Username + """ + request = self.make_request('users.followers.isfollowing', user=user) + return self._bool(request) + + def follow(self, user): + """ Follow a user + + :param str user: Username + + .. warning:: + You must be authenticated + """ + request = self.make_request('users.followers.follow', user=user) + self._put(request) + + def unfollow(self, user): + """ Unfollow a user + + :param str user: Username + + .. warning:: + You must be authenticated + """ + request = self.make_request('users.followers.unfollow', user=user) + self._delete(request) diff --git a/pygithub3/services/users/keys.py b/pygithub3/services/users/keys.py new file mode 100644 index 0000000..2884881 --- /dev/null +++ b/pygithub3/services/users/keys.py @@ -0,0 +1,65 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + """ Consume `Keys API <http://developer.github.com/v3/users/keys/>`_ + + .. warning:: + You must be authenticated for all requests + """ + + def list(self): + """ Get public keys + + :returns: A :doc:`result` + """ + request = self.make_request('users.keys.list') + return self._get_result(request) + + def get(self, key_id): + """ Get a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.get', + key_id=key_id) + return self._get(request) + + def add(self, data): + """ Add a public key + + :param dict data: Key (title and key attributes required) + + :: + + key_service.add(dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.add', + body=data) + return self._post(request) + + def update(self, key_id, data): + """ Update a public key + + :param int key_id: Key id + :param dict data: Key (title and key attributes required) + + :: + + key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.update', + key_id=key_id, body=data) + return self._patch(request) + + def delete(self, key_id): + """ Delete a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.delete', + key_id=key_id) + self._delete(request) diff --git a/pygithub3/tests/requests/test_core.py b/pygithub3/tests/requests/test_core.py index 9e38763..3f2d615 100644 --- a/pygithub3/tests/requests/test_core.py +++ b/pygithub3/tests/requests/test_core.py @@ -4,7 +4,7 @@ from unittest import TestCase from mock import Mock -from pygithub3.requests import Factory, Body, json, Request +from pygithub3.requests.base import Factory, Body, json, Request from pygithub3.exceptions import (UriInvalid, DoesNotExists, ValidationError, InvalidBodySchema) from pygithub3.tests.utils.base import mock_json, DummyRequest diff --git a/pygithub3/tests/services/test_repos.py b/pygithub3/tests/services/test_repos.py index 6f4ed71..865c5df 100644 --- a/pygithub3/tests/services/test_repos.py +++ b/pygithub3/tests/services/test_repos.py @@ -6,7 +6,7 @@ from unittest import TestCase import requests from mock import patch, Mock -from pygithub3.services.repos import (Repo, Collaborator, Commits, Downloads, +from pygithub3.services.repos import (Repos, Collaborators, Commits, Downloads, Forks, Keys, Watchers) from pygithub3.resources.base import json from pygithub3.tests.utils.base import (mock_response, mock_response_result, @@ -21,7 +21,7 @@ json.loads = Mock(side_effect=mock_json) class TestRepoService(TestCase): def setUp(self): - self.rs = Repo() + self.rs = Repos() self.rs.set_user('octocat') self.rs.set_repo('octocat_repo') @@ -146,7 +146,7 @@ class TestRepoService(TestCase): class TestCollaboratorsService(TestCase): def setUp(self): - self.cs = Collaborator() + self.cs = Collaborators() self.cs.set_user('octocat') self.cs.set_repo('oc_repo') diff --git a/pygithub3/tests/utils/base.py b/pygithub3/tests/utils/base.py index d9049c9..49ea2b4 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 import Request +from pygithub3.requests.base import Request def mock_json(content): |