-3.3

-pypy

before_script:pip install -r dev-requirements.txt

script:make travis

notifications:

on_success:change

History/Changelog

0.8.0: 2013-xx-xx

- Use Betamax to start recording integration tests

- Add support for Releases API

- Add support for Feeds API

- Add support for Two-Factor Authentication via the API

- Switch to requests >= 2.0

0.7.1: 2013-09-30

requests==1.2.3

requests>=2.0.0,<=3.0.0

uritemplate.py==0.2.0

#coverage==3.5.2

mock==1.0.1

pytest==2.3.5

wheel==0.21.0

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

returnKey(json,self)ifjsonelseNone

deflogin(self,username=None,password=None,token=None):

deflogin(self,username=None,password=None,token=None,

two_factor_callback=None):

eliftoken:

self._session.token_auth(token)

self._session.two_factor_auth_callback(two_factor_callback)

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

__url_cache__= {}

__logs__=getLogger(__package__)

defrequires_2fa(response):

if (response.status_code==401and'X-GitHub-OTP'inresponse.headers

and'required'inresponse.headers['X-GitHub-OTP']):

classGitHubSession(requests.Session):

def__init__(self):

super(GitHubSession,self).__init__()

'User-Agent':'github3.py/{0}'.format(__version__),

})

self.base_url='https://api.github.com'

self.two_factor_auth_cb=None

defbasic_auth(self,username,password):

__url_cache__[key]='/'.join(parts)

return__url_cache__[key]

defhandle_two_factor_auth(self,args,kwargs):

headers=kwargs.pop('headers', {})

headers.update({

'X-GitHub-OTP':str(self.two_factor_auth_cb())

})

kwargs.update(headers=headers)

returnsuper(GitHubSession,self).request(*args,**kwargs)

defoauth2_auth(self,client_id,client_secret):

raiseNotImplementedError('These features are not implemented yet')

defrequest(self,*args,**kwargs):

response=super(GitHubSession,self).request(*args,**kwargs)

ifrequires_2fa(response)andself.two_factor_auth_cb:

new_response=self.handle_two_factor_auth(args,kwargs)

new_response.history.append(response)

deftwo_factor_auth_callback(self,callback):

ifnotcallback:

ifnotisinstance(callback,Callable):

raiseValueError('Your callback should be callable')

self.two_factor_auth_cb=callback

deftoken_auth(self,token):

self.headers.update({

'Authorization':'token {0}'.format(token)

})

defoauth2_auth(self,client_id,client_secret):

raiseNotImplementedError('These features are not implemented yet')

"github3.issues",

]

kwargs['tests_require']= ['mock==1.0.1','betamax==0.1.5','pytest']

kwargs['tests_require']= ['mock==1.0.1','betamax','pytest']

ifsys.version_info< (3,0):

kwargs['tests_require'].append('unittest2==0.5.1')

packages.append('tests')

os.system("python setup.py bdist_wheel sdist upload")

sys.exit()

requires.extend(["requests >=1.2.3","uritemplate.py >= 0.2.0"])

requires.extend(["requests >=2.0","uritemplate.py >= 0.2.0"])

withopen('github3/__init__.py','r')asfd:

{"http_interactions": [{"request": {"body": "", "headers": {"Accept-Encoding": "gzip, deflate, compress", "Accept": "application/vnd.github.v3.full+json", "User-Agent": "github3.py/0.8.0", "Accept-Charset": "utf-8", "Content-Type": "application/json", "Authorization": "Basic <BASIC_AUTH>"}, "method": "GET", "uri": "https://api.github.com/users/sigmavirus24"}, "response": {"body": {"string": "{\"message\":\"Must specify two-factor authentication OTP code.\",\"documentation_url\":\"http://developer.github.com/v3/auth#working-with-two-factor-authentication\"}", "encoding": "utf-8"}, "headers": {"status": "401 Unauthorized", "x-ratelimit-remaining": "57", "x-github-media-type": "github.v3; param=full; format=json", "x-content-type-options": "nosniff", "access-control-expose-headers": "ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes", "x-github-request-id": "48A0B729:5402:3028482:52969FEC", "x-github-otp": "required; app", "content-length": "159", "server": "GitHub.com", "x-ratelimit-limit": "60", "access-control-allow-credentials": "true", "date": "Thu, 28 Nov 2013 01:44:12 GMT", "access-control-allow-origin": "*", "content-type": "application/json; charset=utf-8", "x-ratelimit-reset": "1385606471"}, "url": "https://api.github.com/users/sigmavirus24", "status_code": 401}, "recorded_at": "2013-11-28T01:44:13"}, {"request": {"body": "", "headers": {"Accept-Encoding": "gzip, deflate, compress", "X-GitHub-OTP": "862478", "Accept": "application/vnd.github.v3.full+json", "User-Agent": "github3.py/0.8.0", "Accept-Charset": "utf-8", "Content-Type": "application/json", "Authorization": "Basic <BASIC_AUTH>"}, "method": "GET", "uri": "https://api.github.com/users/sigmavirus24"}, "response": {"body": {"base64_string": "H4sIAAAAAAAAA51UXWvbMBT9K8XQPSWRvxI7hrIvGPRhbx2DvYRrSXZEFctIcrIsdL99R07ataFQUgjE2Pece+65H4dIm1Z1URU51W5oq+zg0jyaREpEVZrHZRZPItqSJ7sarEbc2vveVYwls9YeP8y42bDjI+NJXmbzhSiXzTKdy8UyTYqyljIRy4x4U3wUNyPBdfb5Ov2GnxKy84qbzs1a5ddDHdjwPqciKRZ5nOVckCyLIi/zWhZpkZQ1zdPFrO/aD/bmN6Q+6lgFzdFbCgB4WQj16llqNjhpHTtzY+03+qz+/2rPgxujtdmB5QzxZiL2hITI47Pq2neyAHlgxq8lGoeSHoJRyvnLRY2oAwt/cDjwOEyDleJiYSccZO06KDowK3szEg6141b1XmEOLqd9jgabsS116g+9jw1oB5Ig7XIpIwpoucVUXw4/wg6st2pLfB+ssZJLtYXZ76Q8w4PR73uJPfmBoQjWKy9XJDbhBjSknZxEHW1CwC11V1+NFeS4QSDWsqdujw9fZCf2O2PvQ6U17sfpKuAo7HY77G+r1bjG7C8WeyRgY9gEx4aPbQHiOwnlTDe5+nkbDNuQCtcFu9w05LnRUNSa7SccJaUDGYLWykqqNcSdlNbKRFU3aD2J+qHWiq+ODajm5eMCYQ2jaoEj9rRPuGsLlAMqD1vJI2saJ/E0zqdJfBfnVVxUWfoL+YZevIjJpkkyTYu7NKnyrMrmIcYbT3o1NgxGntIjXRhx8cp7FH2PhaQWVWS4Y3lwVmuqjSVvgliAe02w6PDYicZKGVrVEw+ouEhjBL0CO1Px8PAP0MDI0N8FAAA=", "encoding": "utf-8"}, "headers": {"status": "200 OK", "x-ratelimit-remaining": "4930", "x-github-media-type": "github.v3; param=full; format=json", "x-content-type-options": "nosniff", "access-control-expose-headers": "ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes", "transfer-encoding": "chunked", "x-github-request-id": "48A0B729:5402:3028B0A:52969FEC", "content-encoding": "gzip", "vary": "Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding", "server": "GitHub.com", "cache-control": "private, max-age=60, s-maxage=60", "last-modified": "Wed, 27 Nov 2013 21:43:35 GMT", "x-ratelimit-limit": "5000", "etag": "\"678c237081785fa8c850d78a6779b7aa\"", "access-control-allow-credentials": "true", "date": "Thu, 28 Nov 2013 01:44:16 GMT", "access-control-allow-origin": "*", "content-type": "application/json; charset=utf-8", "x-ratelimit-reset": "1385603853"}, "url": "https://api.github.com/users/sigmavirus24", "status_code": 200}, "recorded_at": "2013-11-28T01:44:16"}], "recorded_with": "betamax"}

from .helperimportIntegrationHelper

classTestGitHubSession(IntegrationHelper):

deftest_two_factor_authentication_works(self):

two_factor_auth=lambda:'862478'

self.basic_login()

self.gh.login(two_factor_callback=two_factor_auth)

cassette_name=self.cassette_name('two_factor_authentication')

assertisinstance(self.session,github3.session.GitHubSession)

match= ['method','uri','headers']

withself.recorder.use_cassette(cassette_name,

match_requests_on=match):

r=self.session.get('https://api.github.com/users/sigmavirus24')

assertr.status_code==200

defsetUp(self):

self.session=self.create_session_mock()

self.instance=self.described_class(self.example_data,self.session)

ifself.example_data:

self.instance=self.described_class(self.example_data,

self.session)

else:

self.instance=self.described_class()

self.instance._session=self.session

fromgithub3.githubimportGitHub

from .helperimportUnitHelper

classTestGitHub(UnitHelper):

deftest_two_factor_login(self):

self.instance.login('username','password',

two_factor_callback=lambda*args:'foo')

deftest_can_login_without_two_factor_callback(self):

self.instance.login('username','password')

self.instance.login(token='token')

frommockimportpatch,Mock

classTestGitHubSession:

s.basic_auth('username','password')

asserts.auth== ('username','password')

deftest_handle_two_factor_auth(self,request_mock):

s=self.build_session()

s.two_factor_auth_callback(lambda:'fake')

args= ('GET','http://example.com')

s.handle_two_factor_auth(args, {})

request_mock.assert_called_once_with(

*args,

headers={'X-GitHub-OTP':'fake'}

)

deftest_request_ignores_responses_that_do_not_require_2fa(self,

request_mock):

response=Mock()

response.configure_mock(status_code=200,headers={})

request_mock.return_value=response

s=self.build_session()

s.two_factor_auth_callback(lambda:'fake')

r=s.get('http://example.com')

request_mock.assert_called_once_with(

'GET','http://example.com',allow_redirects=True

)

deftest_creates_history_while_handling_2fa(self,request_mock):

response=Mock()

response.configure_mock(

status_code=401,

headers={'X-GitHub-OTP':'required;2fa'},

history=[]

)

request_mock.return_value=response

s=self.build_session()

s.two_factor_auth_callback(lambda:'fake')

r=s.get('http://example.com')

assertlen(r.history)!=0

assertrequest_mock.call_count==2

deftest_token_auth(self):

s=self.build_session()

s.token_auth(token)

assert'Authorization'notins.headers

deftest_two_factor_auth_callback_handles_None(self):

s=self.build_session()

asserts.two_factor_auth_cbisNone

s.two_factor_auth_callback(None)

asserts.two_factor_auth_cbisNone

deftest_two_factor_auth_callback_checks_for_Callable(self):

s=self.build_session()

asserts.two_factor_auth_cbisNone

withpytest.raises(ValueError):

s.two_factor_auth_callback(1)

deftest_two_factor_auth_callback_accepts_a_Callable(self):

s=self.build_session()

asserts.two_factor_auth_cbisNone

not_so_anonymous=lambda*args:'foo'

s.two_factor_auth_callback(not_so_anonymous)

asserts.two_factor_auth_cbisnot_so_anonymous

deftest_oauth2_auth(self):