Make plan attribute in authenticated user response optional

electrofelix · electrofelix · commit a89d49a29b75 · 2018-03-30T13:09:10.000+01:00
Github Enterprise instances <= 2.12.7 do not include the `plan` attribute in responses for authenticated user data. Allow this to be not set and include a note in the documentation that the corresponding attr may be set to `None`. Partially fixes sigmavirus24#794
diff --git a/github3/users.py b/github3/users.py
@@ -744,6 +744,14 @@ class AuthenticatedUser(User):
 
     .. attribute:: plan
 
+        .. note::
+
+            When used with a Github Enterprise instance <= 2.12.7, this
+            attribute will not be returned. To handle these situations
+            sensitively, the attribute will be set to ``None``.
+            Repositories may still have a license associated with them
+            in these cases.
+
         The name of the plan that you, the user, have purchased
     """
 
@@ -754,4 +762,6 @@ def _update_attributes(self, user):
         self.disk_usage = user['disk_usage']
         self.owned_private_repos_count = user['owned_private_repos']
         self.total_private_repos_count = user['total_private_repos']
-        self.plan = Plan(user['plan'], self)
+        self.plan = user.get('plan')
+        if self.plan is not None:
+            self.plan = Plan(self.plan, self)
diff --git a/tests/unit/json/authenticated_user_2_12_example b/tests/unit/json/authenticated_user_2_12_example
@@ -0,0 +1,37 @@
+{
+  "login": "octocat",
+  "id": 1,
+  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+  "gravatar_id": "",
+  "url": "https://api.github.com/users/octocat",
+  "html_url": "https://github.com/octocat",
+  "followers_url": "https://api.github.com/users/octocat/followers",
+  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+  "organizations_url": "https://api.github.com/users/octocat/orgs",
+  "repos_url": "https://api.github.com/users/octocat/repos",
+  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+  "received_events_url": "https://api.github.com/users/octocat/received_events",
+  "type": "User",
+  "site_admin": false,
+  "name": "monalisa octocat",
+  "company": "GitHub",
+  "blog": "https://github.com/blog",
+  "location": "San Francisco",
+  "email": "octocat@github.com",
+  "hireable": false,
+  "bio": "There once was...",
+  "public_repos": 2,
+  "public_gists": 1,
+  "followers": 20,
+  "following": 0,
+  "created_at": "2008-01-14T04:33:35Z",
+  "updated_at": "2008-01-14T04:33:35Z",
+  "total_private_repos": 100,
+  "owned_private_repos": 100,
+  "private_gists": 81,
+  "disk_usage": 10000,
+  "collaborators": 8
+}
diff --git a/tests/unit/test_users.py b/tests/unit/test_users.py
@@ -19,12 +19,18 @@
 get_authenticated_user_example_data = helper.create_example_data_helper(
     'authenticated_user_example'
 )
+get_authenticated_user_2_12_example_data = helper.create_example_data_helper(
+    'authenticated_user_2_12_example'
+)
 get_users_example_data = helper.create_example_data_helper('users_example')
 get_user_key_example_data = helper.create_example_data_helper(
     'user_key_example'
 )
 
 example_data = get_users_example_data()
+authenticated_user_2_12_example_data = (
+    get_authenticated_user_2_12_example_data()
+)
 
 
 class TestUser(helper.UnitHelper):
@@ -272,3 +278,15 @@ def test_str(self):
     def test_is_free(self):
         """Show that user can check if the plan is free."""
         assert self.instance.is_free() is False
+
+
+class TestAuthenticatedUserCompatibility_2_12(helper.UnitHelper):
+
+    """Test methods on AuthenticatedUser from Github Enterprise 2.12."""
+
+    described_class = github3.users.AuthenticatedUser
+    example_data = authenticated_user_2_12_example_data
+
+    def test_user(self):
+        """Test the ability to retrieve an AuthenticatedUser"""
+        assert str(self.instance) == 'octocat'
