# -*- coding: utf-8 -*-

"""

github3.github

==============

This module contains the main GitHub session object.

"""

from __future__ import unicode_literals

from github3.auths import Authorization

from github3.decorators import (requires_auth, requires_basic_auth,

requires_app_credentials)

from github3.events import Event

from github3.gists import Gist

from github3.issues import Issue, issue_params

from github3.models import GitHubCore

from github3.orgs import Organization, Team

from github3.repos import Repository

from github3.search import (CodeSearchResult, IssueSearchResult,

RepositorySearchResult, UserSearchResult)

from github3.structs import SearchIterator

from github3.users import User, Key

from github3.notifications import Thread

from uritemplate import URITemplate

class GitHub(GitHubCore):

"""Stores all the session information.

There are two ways to log into the GitHub API

::

from github3 import login

g = login(user, password)

g = login(token=token)

g = login(user, token=token)

or

::

from github3 import GitHub

g = GitHub(user, password)

g = GitHub(token=token)

g = GitHub(user, token=token)

This is simple backward compatibility since originally there was no way to

call the GitHub object with authentication parameters.

"""

def __init__(self, login='', password='', token=''):

super(GitHub, self).__init__({})

if token:

self.login(login, token=token)

elif login and password:

self.login(login, password)

def _repr(self):

if self._session.auth:

return '<GitHub [{0[0]}]>'.format(self._session.auth)

return '<GitHub at 0x{0:x}>'.format(id(self))

def __enter__(self):

return self

def __exit__(self, *args):

pass

@requires_auth

def _iter_follow(self, which, number, etag):

url = self._build_url('user', which)

return self._iter(number, url, User, etag=etag)

@requires_basic_auth

def authorization(self, id_num):

"""Get information about authorization ``id``.

:param int id_num: (required), unique id of the authorization

:returns: :class:`Authorization <Authorization>`

"""

json = None

if int(id_num) > 0:

url = self._build_url('authorizations', str(id_num))

json = self._json(self._get(url), 200)

return Authorization(json, self) if json else None

def authorize(self, login, password, scopes=None, note='', note_url='',

client_id='', client_secret=''):

"""Obtain an authorization token from the GitHub API for the GitHub

API.

:param str login: (required)

:param str password: (required)

:param list scopes: (optional), areas you want this token to apply to,

i.e., 'gist', 'user'

:param str note: (optional), note about the authorization

:param str note_url: (optional), url for the application

:param str client_id: (optional), 20 character OAuth client key for

which to create a token

:param str client_secret: (optional), 40 character OAuth client secret

for which to create the token

:returns: :class:`Authorization <Authorization>`

"""

json = None

# TODO: Break this behaviour in 1.0 (Don't rely on self._session.auth)

auth = None

if self._session.auth:

auth = self._session.auth

elif login and password:

auth = (login, password)

if auth:

url = self._build_url('authorizations')

data = {'note': note, 'note_url': note_url,

'client_id': client_id, 'client_secret': client_secret}

if scopes:

data['scopes'] = scopes

with self._session.temporary_basic_auth(*auth):

json = self._json(self._post(url, data=data), 201)

return Authorization(json, self) if json else None

def check_authorization(self, access_token):

"""OAuth applications can use this method to check token validity

without hitting normal rate limits because of failed login attempts.

If the token is valid, it will return True, otherwise it will return

False.

:returns: bool

"""

p = self._session.params

auth = (p.get('client_id'), p.get('client_secret'))

if access_token and auth:

url = self._build_url('applications', str(auth[0]), 'tokens',

str(access_token))

resp = self._get(url, auth=auth, params={

'client_id': None, 'client_secret': None

})

return self._boolean(resp, 200, 404)

return False

def create_gist(self, description, files, public=True):

"""Create a new gist.

If no login was provided, it will be anonymous.

:param str description: (required), description of gist

:param dict files: (required), file names with associated dictionaries

for content, e.g. ``{'spam.txt': {'content': 'File contents

...'}}``

:param bool public: (optional), make the gist public if True

:returns: :class:`Gist <github3.gists.Gist>`

"""

new_gist = {'description': description, 'public': public,

'files': files}

url = self._build_url('gists')

json = self._json(self._post(url, data=new_gist), 201)

return Gist(json, self) if json else None

@requires_auth

def create_issue(self,

owner,

repository,

title,

body=None,

assignee=None,

milestone=None,

labels=[]):

"""Create an issue on the project 'repository' owned by 'owner'

with title 'title'.

body, assignee, milestone, labels are all optional.

:param str owner: (required), login of the owner

:param str repository: (required), repository name

:param str title: (required), Title of issue to be created

:param str body: (optional), The text of the issue, markdown

formatted

:param str assignee: (optional), Login of person to assign

the issue to

:param int milestone: (optional), id number of the milestone to

attribute this issue to (e.g. ``m`` is a :class:`Milestone

<github3.issues.Milestone>` object, ``m.number`` is what you pass

here.)

:param list labels: (optional), List of label names.

:returns: :class:`Issue <github3.issues.Issue>` if successful, else

None

"""

repo = None

if owner and repository and title:

repo = self.repository(owner, repository)

if repo:

return repo.create_issue(title, body, assignee, milestone, labels)

# Regardless, something went wrong. We were unable to create the

# issue

return None

@requires_auth

def create_key(self, title, key):

"""Create a new key for the authenticated user.

:param str title: (required), key title

:param key: (required), actual key contents, accepts path as a string

or file-like object

:returns: :class:`Key <github3.users.Key>`

"""

created = None

if title and key:

url = self._build_url('user', 'keys')

req = self._post(url, data={'title': title, 'key': key})

json = self._json(req, 201)

if json:

created = Key(json, self)

return created

@requires_auth

def create_repo(self,

name,

description='',

homepage='',

private=False,

has_issues=True,

has_wiki=True,

has_downloads=True,

auto_init=False,

gitignore_template=''):

"""Create a repository for the authenticated user.

:param str name: (required), name of the repository

:param str description: (optional)

:param str homepage: (optional)

:param str private: (optional), If ``True``, create a

private repository. API default: ``False``

:param bool has_issues: (optional), If ``True``, enable

issues for this repository. API default: ``True``

:param bool has_wiki: (optional), If ``True``, enable the

wiki for this repository. API default: ``True``

:param bool has_downloads: (optional), If ``True``, enable

downloads for this repository. API default: ``True``

:param bool auto_init: (optional), auto initialize the repository

:param str gitignore_template: (optional), name of the git template to

use; ignored if auto_init = False.

:returns: :class:`Repository <github3.repos.Repository>`

.. warning: ``name`` should be no longer than 100 characters

"""

url = self._build_url('user', 'repos')

data = {'name': name, 'description': description,

'homepage': homepage, 'private': private,

'has_issues': has_issues, 'has_wiki': has_wiki,

'has_downloads': has_downloads, 'auto_init': auto_init,

'gitignore_template': gitignore_template}

json = self._json(self._post(url, data=data), 201)

return Repository(json, self) if json else None

@requires_auth

def delete_key(self, key_id):

"""Delete user key pointed to by ``key_id``.

:param int key_id: (required), unique id used by Github

:returns: bool

"""

key = self.key(key_id)

if key:

return key.delete()

return False # (No coverage)

def emojis(self):

"""Retrieves a dictionary of all of the emojis that GitHub supports.

:returns: dictionary where the key is what would be in between the

colons and the value is the URL to the image, e.g., ::

{

'+1': 'https://github.global.ssl.fastly.net/images/...',

# ...

}

"""

url = self._build_url('emojis')

return self._json(self._get(url), 200)

@requires_basic_auth

def feeds(self):

"""List GitHub's timeline resources in Atom format.

:returns: dictionary parsed to include URITemplates

"""

url = self._build_url('feeds')

json = self._json(self._get(url), 200)

del json['ETag']

del json['Last-Modified']

urls = [

'timeline_url', 'user_url', 'current_user_public_url',

'current_user_url', 'current_user_actor_url',

'current_user_organization_url',

]

for url in urls:

json[url] = URITemplate(json[url])

links = json.get('_links', {})

for d in links.values():

d['href'] = URITemplate(d['href'])

return json

@requires_auth

def follow(self, login):

"""Make the authenticated user follow login.

:param str login: (required), user to follow

:returns: bool

"""

resp = False

if login:

url = self._build_url('user', 'following', login)

resp = self._boolean(self._put(url), 204, 404)

return resp

def gist(self, id_num):

"""Gets the gist using the specified id number.

:param int id_num: (required), unique id of the gist

:returns: :class:`Gist <github3.gists.Gist>`

"""

url = self._build_url('gists', str(id_num))

json = self._json(self._get(url), 200)

return Gist(json, self) if json else None

def gitignore_template(self, language):

"""Returns the template for language.

:returns: str

"""

url = self._build_url('gitignore', 'templates', language)

json = self._json(self._get(url), 200)

if not json:

return ''

return json.get('source', '')

def gitignore_templates(self):

"""Returns the list of available templates.

:returns: list of template names

"""

url = self._build_url('gitignore', 'templates')

return self._json(self._get(url), 200) or []

@requires_auth

def is_following(self, login):

"""Check if the authenticated user is following login.

:param str login: (required), login of the user to check if the

authenticated user is checking

:returns: bool

"""

json = False

if login:

url = self._build_url('user', 'following', login)

json = self._boolean(self._get(url), 204, 404)

return json

@requires_auth

def is_starred(self, login, repo):

"""Check if the authenticated user starred login/repo.

:param str login: (required), owner of repository

:param str repo: (required), name of repository

:returns: bool

"""

json = False

if login and repo:

url = self._build_url('user', 'starred', login, repo)

json = self._boolean(self._get(url), 204, 404)

return json

@requires_auth

def is_subscribed(self, login, repo):

"""Check if the authenticated user is subscribed to login/repo.

:param str login: (required), owner of repository

:param str repo: (required), name of repository

:returns: bool

"""

json = False

if login and repo:

url = self._build_url('user', 'subscriptions', login, repo)

json = self._boolean(self._get(url), 204, 404)

return json

def issue(self, owner, repository, number):

"""Fetch issue #:number: from https://github.com/:owner:/:repository:

:param str owner: (required), owner of the repository

:param str repository: (required), name of the repository

:param int number: (required), issue number

:return: :class:`Issue <github3.issues.Issue>`

"""

repo = self.repository(owner, repository)

if repo:

return repo.issue(number)

return None

def iter_all_repos(self, number=-1, since=None, etag=None, per_page=None):

"""Iterate over every repository in the order they were created.

:param int number: (optional), number of repositories to return.

Default: -1, returns all of them

:param int since: (optional), last repository id seen (allows

restarting this iteration)

:param str etag: (optional), ETag from a previous request to the same

endpoint

:param int per_page: (optional), number of repositories to list per

request

:returns: generator of :class:`Repository <github3.repos.Repository>`

"""

url = self._build_url('repositories')

return self._iter(int(number), url, Repository,

params={'since': since, 'per_page': per_page},

etag=etag)

def iter_all_users(self, number=-1, etag=None, per_page=None):

"""Iterate over every user in the order they signed up for GitHub.

:param int number: (optional), number of users to return. Default: -1,

returns all of them

:param str etag: (optional), ETag from a previous request to the same

endpoint

:param int per_page: (optional), number of users to list per request

:returns: generator of :class:`User <github3.users.User>`

"""

url = self._build_url('users')

return self._iter(int(number), url, User,

params={'per_page': per_page}, etag=etag)

@requires_basic_auth

def iter_authorizations(self, number=-1, etag=None):

"""Iterate over authorizations for the authenticated user. This will

return a 404 if you are using a token for authentication.

:param int number: (optional), number of authorizations to return.

Default: -1 returns all available authorizations

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Authorization <Authorization>`\ s

"""

url = self._build_url('authorizations')

return self._iter(int(number), url, Authorization, etag=etag)

@requires_auth

def iter_emails(self, number=-1, etag=None):

"""Iterate over email addresses for the authenticated user.

:param int number: (optional), number of email addresses to return.

Default: -1 returns all available email addresses

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of dicts

"""

url = self._build_url('user', 'emails')

return self._iter(int(number), url, dict, etag=etag)

def iter_events(self, number=-1, etag=None):

"""Iterate over public events.

:param int number: (optional), number of events to return. Default: -1

returns all available events

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Event <github3.events.Event>`\ s

"""

url = self._build_url('events')

return self._iter(int(number), url, Event, etag=etag)

def iter_followers(self, login=None, number=-1, etag=None):

"""If login is provided, iterate over a generator of followers of that

login name; otherwise return a generator of followers of the

authenticated user.

:param str login: (optional), login of the user to check

:param int number: (optional), number of followers to return. Default:

-1 returns all followers

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`User <github3.users.User>`\ s

"""

if login:

return self.user(login).iter_followers()

return self._iter_follow('followers', int(number), etag=etag)

def iter_following(self, login=None, number=-1, etag=None):

"""If login is provided, iterate over a generator of users being

followed by login; otherwise return a generator of people followed by

the authenticated user.

:param str login: (optional), login of the user to check

:param int number: (optional), number of people to return. Default: -1

returns all people you follow

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`User <github3.users.User>`\ s

"""

if login:

return self.user(login).iter_following()

return self._iter_follow('following', int(number), etag=etag)

def iter_gists(self, username=None, number=-1, etag=None):

"""If no username is specified, GET /gists, otherwise GET

/users/:username/gists

:param str login: (optional), login of the user to check

:param int number: (optional), number of gists to return. Default: -1

returns all available gists

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Gist <github3.gists.Gist>`\ s

"""

if username:

url = self._build_url('users', username, 'gists')

else:

url = self._build_url('gists')

return self._iter(int(number), url, Gist, etag=etag)

@requires_auth

def iter_notifications(self, all=False, participating=False, number=-1,

etag=None):

"""Iterate over the user's notification.

:param bool all: (optional), iterate over all notifications

:param bool participating: (optional), only iterate over notifications

in which the user is participating

:param int number: (optional), how many notifications to return

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`Thread <github3.notifications.Thread>`

"""

params = None

if all:

params = {'all': all}

elif participating:

params = {'participating': participating}

url = self._build_url('notifications')

return self._iter(int(number), url, Thread, params, etag=etag)

@requires_auth

def iter_org_issues(self, name, filter='', state='', labels='', sort='',

direction='', since=None, number=-1, etag=None):

"""Iterate over the organnization's issues if the authenticated user

belongs to it.

:param str name: (required), name of the organization

:param str filter: accepted values:

('assigned', 'created', 'mentioned', 'subscribed')

api-default: 'assigned'

:param str state: accepted values: ('open', 'closed')

api-default: 'open'

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return. Default:

-1, returns all available issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Issue <github3.issues.Issue>`

"""

url = self._build_url('orgs', name, 'issues')

# issue_params will handle the since parameter

params = issue_params(filter, state, labels, sort, direction, since)

return self._iter(int(number), url, Issue, params, etag)

@requires_auth

def iter_issues(self, filter='', state='', labels='', sort='',

direction='', since=None, number=-1, etag=None):

"""List all of the authenticated user's (and organization's) issues.

.. versionchanged:: 0.9.0

- The ``state`` parameter now accepts 'all' in addition to 'open'

and 'closed'.

:param str filter: accepted values:

('assigned', 'created', 'mentioned', 'subscribed')

api-default: 'assigned'

:param str state: accepted values: ('all', 'open', 'closed')

api-default: 'open'

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return.

Default: -1 returns all issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Issue <github3.issues.Issue>`

"""

url = self._build_url('issues')

# issue_params will handle the since parameter

params = issue_params(filter, state, labels, sort, direction, since)

return self._iter(int(number), url, Issue, params, etag)

@requires_auth

def iter_user_issues(self, filter='', state='', labels='', sort='',

direction='', since=None, number=-1, etag=None):

"""List only the authenticated user's issues. Will not list

organization's issues

.. versionchanged:: 0.9.0

- The ``state`` parameter now accepts 'all' in addition to 'open'

and 'closed'.

:param str filter: accepted values:

('assigned', 'created', 'mentioned', 'subscribed')

api-default: 'assigned'

:param str state: accepted values: ('all', 'open', 'closed')

api-default: 'open'

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return.

Default: -1 returns all issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Issue <github3.issues.Issue>`

"""

url = self._build_url('user', 'issues')

# issue_params will handle the since parameter

params = issue_params(filter, state, labels, sort, direction, since)

return self._iter(int(number), url, Issue, params, etag)

def iter_repo_issues(self, owner, repository, milestone=None,

state=None, assignee=None, mentioned=None,

labels=None, sort=None, direction=None, since=None,

number=-1, etag=None):

"""List issues on owner/repository. Only owner and repository are

required.

.. versionchanged:: 0.9.0

- The ``state`` parameter now accepts 'all' in addition to 'open'

and 'closed'.

:param str owner: login of the owner of the repository

:param str repository: name of the repository

:param int milestone: None, '*', or ID of milestone

:param str state: accepted values: ('all', 'open', 'closed')

api-default: 'open'

:param str assignee: '*' or login of the user

:param str mentioned: login of the user

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return.

Default: -1 returns all issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Issue <github3.issues.Issue>`\ s

"""

if owner and repository:

repo = self.repository(owner, repository)

return repo.iter_issues(milestone, state, assignee, mentioned,

labels, sort, direction, since, number,

etag)

return iter([])

@requires_auth

def iter_keys(self, number=-1, etag=None):

"""Iterate over public keys for the authenticated user.

:param int number: (optional), number of keys to return. Default: -1

returns all your keys

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Key <github3.users.Key>`\ s

"""

url = self._build_url('user', 'keys')

return self._iter(int(number), url, Key, etag=etag)

def iter_orgs(self, login=None, number=-1, etag=None):

"""Iterate over public organizations for login if provided; otherwise

iterate over public and private organizations for the authenticated

user.

:param str login: (optional), user whose orgs you wish to list

:param int number: (optional), number of organizations to return.

Default: -1 returns all available organizations

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`Organization <github3.orgs.Organization>`\ s

"""

if login:

url = self._build_url('users', login, 'orgs')

else:

url = self._build_url('user', 'orgs')

return self._iter(int(number), url, Organization, etag=etag)

@requires_auth

def iter_repos(self, type=None, sort=None, direction=None, number=-1,

etag=None):

"""List public repositories for the authenticated user.

.. versionchanged:: 0.6

Removed the login parameter for correctness. Use iter_user_repos

instead

:param str type: (optional), accepted values:

('all', 'owner', 'public', 'private', 'member')

API default: 'all'

:param str sort: (optional), accepted values:

('created', 'updated', 'pushed', 'full_name')

API default: 'created'

:param str direction: (optional), accepted values:

('asc', 'desc'), API default: 'asc' when using 'full_name',

'desc' otherwise

:param int number: (optional), number of repositories to return.

Default: -1 returns all repositories

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Repository <github3.repos.Repository>`

objects

"""

url = self._build_url('user', 'repos')

params = {}

if type in ('all', 'owner', 'public', 'private', 'member'):

params.update(type=type)

if sort in ('created', 'updated', 'pushed', 'full_name'):

params.update(sort=sort)

if direction in ('asc', 'desc'):

params.update(direction=direction)

return self._iter(int(number), url, Repository, params, etag)

def iter_starred(self, login=None, sort=None, direction=None, number=-1,

etag=None):

"""Iterate over repositories starred by ``login`` or the authenticated

user.

.. versionchanged:: 0.5

Added sort and direction parameters (optional) as per the change in

GitHub's API.

:param str login: (optional), name of user whose stars you want to see

:param str sort: (optional), either 'created' (when the star was

created) or 'updated' (when the repository was last pushed to)

:param str direction: (optional), either 'asc' or 'desc'. Default:

'desc'

:param int number: (optional), number of repositories to return.

Default: -1 returns all repositories

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Repository <github3.repos.Repository>`

"""

if login:

return self.user(login).iter_starred(sort, direction)

params = {'sort': sort, 'direction': direction}

self._remove_none(params)

url = self._build_url('user', 'starred')

return self._iter(int(number), url, Repository, params, etag)

def iter_subscriptions(self, login=None, number=-1, etag=None):

"""Iterate over repositories subscribed to by ``login`` or the

authenticated user.

:param str login: (optional), name of user whose subscriptions you want

to see

:param int number: (optional), number of repositories to return.

Default: -1 returns all repositories

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Repository <github3.repos.Repository>`

"""

if login:

return self.user(login).iter_subscriptions()

url = self._build_url('user', 'subscriptions')

return self._iter(int(number), url, Repository, etag=etag)

def iter_user_repos(self, login, type=None, sort=None, direction=None,

number=-1, etag=None):

"""List public repositories for the specified ``login``.

.. versionadded:: 0.6

:param str login: (required), username

:param str type: (optional), accepted values:

('all', 'owner', 'member')

API default: 'all'

:param str sort: (optional), accepted values:

('created', 'updated', 'pushed', 'full_name')

API default: 'created'

:param str direction: (optional), accepted values:

('asc', 'desc'), API default: 'asc' when using 'full_name',

'desc' otherwise

:param int number: (optional), number of repositories to return.

Default: -1 returns all repositories

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Repository <github3.repos.Repository>`

objects

"""

url = self._build_url('users', login, 'repos')

params = {}

if type in ('all', 'owner', 'member'):

params.update(type=type)

if sort in ('created', 'updated', 'pushed', 'full_name'):

params.update(sort=sort)

if direction in ('asc', 'desc'):

params.update(direction=direction)

return self._iter(int(number), url, Repository, params, etag)

@requires_auth

def iter_user_teams(self, number=-1, etag=None):

"""Gets the authenticated user's teams across all of organizations.

List all of the teams across all of the organizations to which the

authenticated user belongs. This method requires user or repo scope

when authenticating via OAuth.

:returns: generator of :class:`Team <github3.orgs.Team>` objects

"""

url = self._build_url('user', 'teams')

return self._iter(int(number), url, Team, etag=etag)

@requires_auth

def key(self, id_num):

"""Gets the authenticated user's key specified by id_num.

:param int id_num: (required), unique id of the key

:returns: :class:`Key <github3.users.Key>`

"""

json = None

if int(id_num) > 0:

url = self._build_url('user', 'keys', str(id_num))

json = self._json(self._get(url), 200)

return Key(json, self) if json else None

def login(self, username=None, password=None, token=None,

two_factor_callback=None):

"""Logs the user into GitHub for protected API calls.

:param str username: login name

:param str password: password for the login

:param str token: OAuth token

:param func two_factor_callback: (optional), function you implement to

provide the Two Factor Authentication code to GitHub when necessary

"""

if username and password:

self._session.basic_auth(username, password)

elif token:

self._session.token_auth(token)

# The Session method handles None for free.

self._session.two_factor_auth_callback(two_factor_callback)

def markdown(self, text, mode='', context='', raw=False):

"""Render an arbitrary markdown document.

:param str text: (required), the text of the document to render

:param str mode: (optional), 'markdown' or 'gfm'

:param str context: (optional), only important when using mode 'gfm',

this is the repository to use as the context for the rendering

:param bool raw: (optional), renders a document like a README.md, no

gfm, no context

:returns: str -- HTML formatted text

"""

data = None

json = False

headers = {}

if raw:

url = self._build_url('markdown', 'raw')

data = text

headers['content-type'] = 'text/plain'

else:

url = self._build_url('markdown')

data = {}

if text:

data['text'] = text

if mode in ('markdown', 'gfm'):

data['mode'] = mode

if context:

data['context'] = context

json = True

if data:

req = self._post(url, data=data, json=json, headers=headers)

if req.ok:

return req.content

return '' # (No coverage)

def meta(self):

"""Returns a dictionary with arrays of addresses in CIDR format

specifying theaddresses that the incoming service hooks will originate

from.

.. versionadded:: 0.5

"""

url = self._build_url('meta')

return self._json(self._get(url), 200)

def octocat(self, say=None):

"""Returns an easter egg of the API.

:params str say: (optional), pass in what you'd like Octocat to say

:returns: ascii art of Octocat

"""

url = self._build_url('octocat')

req = self._get(url, params={'s': say})

return req.content if req.ok else ''

# TODO: Switch to req.text. Unicode is better.

def organization(self, login):

"""Returns a Organization object for the login name

:param str login: (required), login name of the org

:returns: :class:`Organization <github3.orgs.Organization>`

"""

url = self._build_url('orgs', login)

json = self._json(self._get(url), 200)

return Organization(json, self) if json else None

@requires_auth

def pubsubhubbub(self, mode, topic, callback, secret=''):

"""Create/update a pubsubhubbub hook.

:param str mode: (required), accepted values: ('subscribe',

'unsubscribe')

:param str topic: (required), form:

https://github.com/:user/:repo/events/:event

:param str callback: (required), the URI that receives the updates

:param str secret: (optional), shared secret key that generates a

SHA1 HMAC of the payload content.

:returns: bool

"""

from re import match

m = match('https://[\w\d\-\.\:]+/\w+/[\w\._-]+/events/\w+', topic)

status = False

if mode and topic and callback and m:

data = [('hub.mode', mode), ('hub.topic', topic),

('hub.callback', callback)]

if secret:

data.append(('hub.secret', secret))

url = self._build_url('hub')

# This is not JSON data. It is meant to be form data

# application/x-www-form-urlencoded works fine here, no need for

# multipart/form-data

status = self._boolean(self._post(url, data=data, json=False), 204,

404)

return status

def pull_request(self, owner, repository, number):

"""Fetch pull_request #:number: from :owner:/:repository

:param str owner: (required), owner of the repository

:param str repository: (required), name of the repository

:param int number: (required), issue number

:return: :class:`Issue <github3.issues.Issue>`