Move email address related methods to GitHub

sigmavirus24 · sigmavirus24 · commit d4623a589401 · 2015-12-20T12:57:26.000-06:00
Add integration test for adding email addresses

Remove integration tests for User#email_addresses
diff --git a/github3/github.py b/github3/github.py
@@ -23,7 +23,7 @@
 from .search import (CodeSearchResult, IssueSearchResult,
                      RepositorySearchResult, UserSearchResult)
 from .structs import SearchIterator
-from .users import User, Key
+from . import users
 from .notifications import Thread
 from .licenses import License
 from uritemplate import URITemplate
@@ -67,6 +67,20 @@ def _repr(self):
             return '<GitHub [{0[0]}]>'.format(self.session.auth)
         return '<GitHub at 0x{0:x}>'.format(id(self))
 
+    @requires_auth
+    def add_email_addresses(self, addresses=[]):
+        """Add the email addresses in ``addresses`` to the authenticated
+        user's account.
+
+        :param list addresses: (optional), email addresses to be added
+        :returns: list of :class:`~github3.users.Email`
+        """
+        json = []
+        if addresses:
+            url = self._build_url('user', 'emails')
+            json = self._json(self._post(url, data=addresses), 201)
+        return [users.Email(email) for email in json]
+
     def all_events(self, number=-1, etag=None):
         """Iterate over public events.
 
@@ -134,7 +148,7 @@ def all_users(self, number=-1, etag=None, per_page=None, since=None):
         :returns: generator of :class:`User <github3.users.User>`
         """
         url = self._build_url('users')
-        return self._iter(int(number), url, User, etag=etag,
+        return self._iter(int(number), url, users.User, etag=etag,
                           params={'per_page': per_page, 'since': since})
 
     @requires_basic_auth
@@ -298,7 +312,7 @@ def create_key(self, title, key):
             url = self._build_url('user', 'keys')
             req = self._post(url, data={'title': title, 'key': key})
             json = self._json(req, 201)
-        return self._instance_or_null(Key, json)
+        return self._instance_or_null(users.Key, json)
 
     @requires_auth
     def create_repository(self, name, description='', homepage='',
@@ -331,6 +345,18 @@ def create_repository(self, name, description='', homepage='',
         json = self._json(self._post(url, data=data), 201)
         return self._instance_or_null(Repository, json)
 
+    @requires_auth
+    def delete_email_addresses(self, addresses=[]):
+        """Delete the email addresses in ``addresses`` from the
+        authenticated user's account.
+
+        :param list addresses: (optional), email addresses to be removed
+        :returns: bool
+        """
+        url = self._build_url('user', 'emails')
+        return self._boolean(self._delete(url, data=json.dumps(addresses)),
+                             204, 404)
+
     @requires_auth
     def emails(self, number=-1, etag=None):
         """Iterate over email addresses for the authenticated user.
@@ -342,7 +368,7 @@ def emails(self, number=-1, etag=None):
         :returns: generator of dicts
         """
         url = self._build_url('user', 'emails')
-        return self._iter(int(number), url, dict, etag=etag)
+        return self._iter(int(number), url, users.Email, etag=etag)
 
     def emojis(self):
         """Retrieves a dictionary of all of the emojis that GitHub supports.
@@ -440,7 +466,7 @@ def followed_by(self, username, number=-1, etag=None):
         :returns: generator of :class:`User <github3.users.User>`\ s
         """
         url = self._build_url('users', username, 'following')
-        return self._iter(int(number), url, User, etag=etag)
+        return self._iter(int(number), url, users.User, etag=etag)
 
     @requires_auth
     def followers(self, number=-1, etag=None):
@@ -457,7 +483,7 @@ def followers(self, number=-1, etag=None):
         :returns: generator of :class:`User <github3.users.User>`\ s
         """
         url = self._build_url('user', 'followers')
-        return self._iter(int(number), url, User, etag=etag)
+        return self._iter(int(number), url, users.User, etag=etag)
 
     def followers_of(self, username, number=-1, etag=None):
         """Iterate over followers of ``username``.
@@ -474,7 +500,7 @@ def followers_of(self, username, number=-1, etag=None):
         :returns: generator of :class:`User <github3.users.User>`\ s
         """
         url = self._build_url('users', username, 'followers')
-        return self._iter(int(number), url, User, etag=etag)
+        return self._iter(int(number), url, users.User, etag=etag)
 
     @requires_auth
     def following(self, number=-1, etag=None):
@@ -491,7 +517,7 @@ def following(self, number=-1, etag=None):
         :returns: generator of :class:`User <github3.users.User>`\ s
         """
         url = self._build_url('user', 'following')
-        return self._iter(int(number), url, User, etag=etag)
+        return self._iter(int(number), url, users.User, etag=etag)
 
     def gist(self, id_num):
         """Retrieve the gist using the specified id number.
@@ -685,7 +711,7 @@ def key(self, id_num):
         if int(id_num) > 0:
             url = self._build_url('user', 'keys', str(id_num))
             json = self._json(self._get(url), 200)
-        return self._instance_or_null(Key, json)
+        return self._instance_or_null(users.Key, json)
 
     @requires_auth
     def keys(self, number=-1, etag=None):
@@ -698,7 +724,7 @@ def keys(self, number=-1, etag=None):
         :returns: generator of :class:`Key <github3.users.Key>`\ s
         """
         url = self._build_url('user', 'keys')
-        return self._iter(int(number), url, Key, etag=etag)
+        return self._iter(int(number), url, users.Key, etag=etag)
 
     def license(self, name):
         """Retrieve the license specified by the name.
@@ -790,7 +816,7 @@ def me(self):
         """
         url = self._build_url('user')
         json = self._json(self._get(url), 200)
-        return self._instance_or_null(User, json)
+        return self._instance_or_null(users.User, json)
 
     @requires_auth
     def membership_in(self, organization):
@@ -1569,7 +1595,7 @@ def user(self, username):
         """
         url = self._build_url('users', username)
         json = self._json(self._get(url), 200)
-        return self._instance_or_null(User, json)
+        return self._instance_or_null(users.User, json)
 
     @requires_auth
     def user_issues(self, filter='', state='', labels='', sort='',
@@ -1638,7 +1664,7 @@ def user_with_id(self, number):
         if number > 0:
             url = self._build_url('user', str(number))
             json = self._json(self._get(url), 200)
-        return self._instance_or_null(User, json)
+        return self._instance_or_null(users.User, json)
 
     def zen(self):
         """Returns a quote from the Zen of GitHub. Yet another API Easter Egg
@@ -1684,7 +1710,7 @@ def create_user(self, login, email):
         url = self._build_url('admin', 'users')
         payload = {'login': login, 'email': email}
         json_data = self._json(self._post(url, data=payload), 201)
-        return self._instance_or_null(User, json_data)
+        return self._instance_or_null(users.User, json_data)
 
     @requires_auth
     def admin_stats(self, option):
diff --git a/github3/users.py b/github3/users.py
@@ -217,62 +217,6 @@ def _update_attributes(self, user):
     def __str__(self):
         return self.login
 
-    @requires_auth
-    def add_email_address(self, address):
-        """Add the single email address to the authenticated user's
-        account.
-
-        :param str address: (required), email address to add
-        :returns: list of email addresses
-        """
-        return self.add_email_addresses([address])
-
-    @requires_auth
-    def add_email_addresses(self, addresses=[]):
-        """Add the email addresses in ``addresses`` to the authenticated
-        user's account.
-
-        :param list addresses: (optional), email addresses to be added
-        :returns: list of email addresses
-        """
-        json = []
-        if addresses:
-            url = self._build_url('user', 'emails')
-            json = self._json(self._post(url, data=addresses), 201)
-        return json
-
-    @requires_auth
-    def delete_email_address(self, address):
-        """Delete the email address from the user's account.
-
-        :param str address: (required), email address to delete
-        :returns: bool
-        """
-        return self.delete_email_addresses([address])
-
-    @requires_auth
-    def delete_email_addresses(self, addresses=[]):
-        """Delete the email addresses in ``addresses`` from the
-        authenticated user's account.
-
-        :param list addresses: (optional), email addresses to be removed
-        :returns: bool
-        """
-        url = self._build_url('user', 'emails')
-        return self._boolean(self._delete(url, data=dumps(addresses)),
-                             204, 404)
-
-    @requires_auth
-    def email_addresses(self, number=-1):
-        """Iterate over each email address in the authenticated user's account.
-
-        :param int number: (optional), number of email addresses to return.
-            Default: -1, returns all of them
-        :returns: generator of :class:`Email <github3.users.Email>`
-        """
-        url = self._build_url('user', 'emails')
-        return self._iter(int(number), url, Email)
-
     def is_assignee_on(self, username, repository):
         """Check if this user can be assigned to issues on username/repository.
 
diff --git a/tests/cassettes/GitHub_add_email_addresses.json b/tests/cassettes/GitHub_add_email_addresses.json
@@ -0,0 +1 @@
+{"recorded_with": "betamax/0.5.1", "http_interactions": [{"recorded_at": "2015-12-20T18:56:05", "response": {"url": "https://api.github.com/user/emails", "status": {"code": 201, "message": "Created"}, "headers": {"Server": "GitHub.com", "Date": "Sun, 20 Dec 2015 18:56:05 GMT", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "ETag": "\"b4fdbf10626c0cffe2eb8fe3ad230ec1\"", "X-Content-Type-Options": "nosniff", "X-RateLimit-Limit": "5000", "Content-Security-Policy": "default-src 'none'", "Content-Type": "application/json; charset=utf-8", "X-GitHub-Request-Id": "451DE1EB:14B57:380B98F:5676F9C5", "Content-Length": "206", "Access-Control-Allow-Credentials": "true", "X-RateLimit-Remaining": "4997", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Cache-Control": "private, max-age=60, s-maxage=60", "Access-Control-Allow-Origin": "*", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP", "X-RateLimit-Reset": "1450639603", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "X-Served-By": "2c18a09f3ac5e4dd1e004af7c5a94769", "X-Frame-Options": "deny", "X-XSS-Protection": "1; mode=block", "Status": "201 Created"}, "body": {"encoding": "utf-8", "string": "[{\"email\":\"gr.aff.at.colmingov@gmail.com\",\"primary\":true,\"verified\":true},{\"email\":\"example1@example.com\",\"primary\":false,\"verified\":false},{\"email\":\"example2@example.com\",\"primary\":false,\"verified\":false}]"}}, "request": {"method": "POST", "uri": "https://api.github.com/user/emails", "headers": {"Authorization": "Basic <BASIC_AUTH>", "Content-Type": "application/json", "Accept": "application/vnd.github.v3.full+json", "Content-Length": "48", "Accept-Charset": "utf-8", "Accept-Encoding": "gzip, deflate", "User-Agent": "github3.py/1.0.0a2", "Connection": "keep-alive"}, "body": {"encoding": "utf-8", "string": "[\"example1@example.com\", \"example2@example.com\"]"}}}]}
diff --git a/tests/cassettes/User_email_addresses.json b/tests/cassettes/User_email_addresses.json
diff --git a/tests/integration/test_github.py b/tests/integration/test_github.py
@@ -36,6 +36,18 @@ def test_authorize(self):
 
         assert isinstance(auth, github3.auths.Authorization)
 
+    def test_add_email_addresses(self):
+        """Add email addresses to the authorized user's account."""
+        self.basic_login()
+        cassette_name = self.cassette_name('add_email_addresses')
+        with self.recorder.use_cassette(cassette_name):
+            emails = self.gh.add_email_addresses(
+                ['example1@example.com', 'example2@example.com']
+            )
+
+        for email in emails:
+            assert isinstance(email, github3.users.Email)
+
     def test_create_gist(self):
         """Test the ability of a GitHub instance to create a new gist."""
         self.token_login()
diff --git a/tests/integration/test_users.py b/tests/integration/test_users.py
@@ -40,17 +40,6 @@ class TestUser(IntegrationHelper):
 
     """Integration tests for methods on the User class."""
 
-    def test_email_addresses(self):
-        """Test the ability to retrieve the email addresses of the
-        authenticated user."""
-        self.token_login()
-        cassette_name = self.cassette_name('email_addresses')
-        with self.recorder.use_cassette(cassette_name):
-            user = self.gh.me()
-            assert user is not None
-            for address in user.email_addresses():
-                assert isinstance(address, github3.users.Email)
-
     def test_events(self):
         """Show that a user can retrieve a events performed by a user."""
         cassette_name = self.cassette_name('events')
diff --git a/tests/unit/test_users.py b/tests/unit/test_users.py
@@ -86,17 +86,6 @@ class TestUserIterators(UnitIteratorHelper):
     described_class = github3.users.User
     example_data = example_data.copy()
 
-    def test_email_addresses(self):
-        """Verify the request to retrive a user's email addresses."""
-        i = self.instance.email_addresses()
-        self.get_next(i)
-
-        self.session.get.assert_called_once_with(
-            url_for('user/emails'),
-            params={'per_page': 100},
-            headers={}
-        )
-
     def test_events(self):
         """Test the request to retrieve a user's events."""
         i = self.instance.events()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+{"recorded_with": "betamax/0.5.1", "http_interactions": [{"recorded_at": "2015-12-20T18:56:05", "response": {"url": "https://api.github.com/user/emails", "status": {"code": 201, "message": "Created"}, "headers": {"Server": "GitHub.com", "Date": "Sun, 20 Dec 2015 18:56:05 GMT", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "ETag": "\"b4fdbf10626c0cffe2eb8fe3ad230ec1\"", "X-Content-Type-Options": "nosniff", "X-RateLimit-Limit": "5000", "Content-Security-Policy": "default-src 'none'", "Content-Type": "application/json; charset=utf-8", "X-GitHub-Request-Id": "451DE1EB:14B57:380B98F:5676F9C5", "Content-Length": "206", "Access-Control-Allow-Credentials": "true", "X-RateLimit-Remaining": "4997", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Cache-Control": "private, max-age=60, s-maxage=60", "Access-Control-Allow-Origin": "*", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP", "X-RateLimit-Reset": "1450639603", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "X-Served-By": "2c18a09f3ac5e4dd1e004af7c5a94769", "X-Frame-Options": "deny", "X-XSS-Protection": "1; mode=block", "Status": "201 Created"}, "body": {"encoding": "utf-8", "string": "[{\"email\":\"gr.aff.at.colmingov@gmail.com\",\"primary\":true,\"verified\":true},{\"email\":\"example1@example.com\",\"primary\":false,\"verified\":false},{\"email\":\"example2@example.com\",\"primary\":false,\"verified\":false}]"}}, "request": {"method": "POST", "uri": "https://api.github.com/user/emails", "headers": {"Authorization": "Basic <BASIC_AUTH>", "Content-Type": "application/json", "Accept": "application/vnd.github.v3.full+json", "Content-Length": "48", "Accept-Charset": "utf-8", "Accept-Encoding": "gzip, deflate", "User-Agent": "github3.py/1.0.0a2", "Connection": "keep-alive"}, "body": {"encoding": "utf-8", "string": "[\"example1@example.com\", \"example2@example.com\"]"}}}]}