Merge branch 'mattchung-pr449' into develop

sigmavirus24 · sigmavirus24 · commit 0ce9a935dffb · 2015-10-23T23:58:50.000-05:00
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -104,3 +104,5 @@ Contributors
 - Noel Lee (@noellee)
 
 - Sourav Singh(@souravsingh)
+
+- Matt Chung (@itsmemattchung)
diff --git a/tests/test_notifications.py b/tests/test_notifications.py
@@ -1,5 +1,4 @@
 import github3
-import datetime
 from tests.utils import BaseCase, load
 
 
@@ -9,49 +8,6 @@ def __init__(self, methodName='runTest'):
         self.thread = github3.notifications.Thread(load('notification'))
         self.api = ("https://api.github.com/notifications/threads/6169361")
 
-    def test_equality(self):
-        t = github3.notifications.Thread(load('notification'))
-        assert self.thread == t
-        t._uniq = 1
-        assert self.thread != t
-
-    def test_last_read_at(self):
-        json = self.thread.as_dict().copy()
-        json['last_read_at'] = '2013-12-31T23:59:59Z'
-        t = github3.notifications.Thread(json)
-        assert isinstance(t.last_read_at, datetime.datetime)
-
-    def test_repr(self):
-        assert repr(self.thread) == '<Thread [{0}]>'.format(
-            self.thread.subject.get('title'))
-
-    def test_delete_subscription(self):
-        self.response('', 204)
-        self.delete(self.api + '/subscription')
-
-        assert self.thread.delete_subscription()
-        self.mock_assertions()
-
-    def test_is_unread(self):
-        assert self.thread.is_unread() == self.thread.unread
-
-    def test_mark(self):
-        self.response('', 205)
-        self.patch(self.api)
-        self.conf = {}
-
-        assert self.thread.mark()
-        self.mock_assertions()
-
-    def test_set_subscription(self):
-        self.response('subscription')
-        self.put(self.api + '/subscription')
-        self.conf = {'data': {'subscribed': True, 'ignored': False}}
-
-        assert isinstance(self.thread.set_subscription(True, False),
-                          github3.notifications.Subscription)
-        self.mock_assertions()
-
     def test_subscription(self):
         self.response('subscription')
         self.get(self.api + '/subscription')
@@ -69,23 +25,6 @@ def __init__(self, methodName='runTest'):
         self.api = ("https://api.github.com/notifications/threads/5864188/"
                     "subscription")
 
-    def test_repr(self):
-        assert isinstance(repr(self.subscription), str)
-
-    def test_delete(self):
-        self.response('', 204)
-        self.delete(self.api)
-
-        assert self.subscription.delete()
-        self.mock_assertions()
-
-    def test_is_ignored(self):
-        assert self.subscription.is_ignored() == self.subscription.ignored
-
-    def test_is_subscription(self):
-        subbed = self.subscription.is_subscribed()
-        assert subbed == self.subscription.subscribed
-
     def test_set(self):
         self.response('subscription')
         self.put(self.api)
diff --git a/tests/unit/helper.py b/tests/unit/helper.py
@@ -87,10 +87,11 @@ def create_instance_of_described_class(self):
 
         return instance
 
-    def patch_called_with(self, *args, **kwargs):
-        """Use to assert patch was called with JSON."""
-        assert self.session.patch.called is True
-        call_args, call_kwargs = self.session.patch.call_args
+    def method_called_with(self, method_name, args, kwargs):
+        """Assert that a method was called on a session with JSON."""
+        mock_method = getattr(self.session, method_name)
+        assert mock_method.called is True
+        call_args, call_kwargs = mock_method.call_args
 
         # Data passed to assertion
         data = kwargs.pop('data', None)
@@ -108,6 +109,10 @@ def patch_called_with(self, *args, **kwargs):
         assert data == call_data
         assert kwargs == call_kwargs
 
+    def patch_called_with(self, *args, **kwargs):
+        """Use to assert patch was called with JSON."""
+        self.method_called_with('patch', args, kwargs)
+
     def post_called_with(self, *args, **kwargs):
         """Use to assert post was called with JSON."""
         assert self.session.post.called is True
@@ -126,6 +131,10 @@ def post_called_with(self, *args, **kwargs):
         assert data == call_data
         assert kwargs == call_kwargs
 
+    def put_called_with(self, *args, **kwargs):
+        """Use to assert put was called with JSON."""
+        self.method_called_with('put', args, kwargs)
+
     def setUp(self):
         """Use to set up attributes on self before each test."""
         self.session = self.create_session_mock()
diff --git a/tests/unit/notification_example b/tests/unit/notification_example
@@ -0,0 +1,43 @@
+{
+"id": "1",
+"repository": {
+  "id": 1296269,
+  "owner": {
+    "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": "Hello-World",
+  "full_name": "octocat/Hello-World",
+  "description": "This your first repo!",
+  "private": false,
+  "fork": false,
+  "url": "https://api.github.com/repos/octocat/Hello-World",
+  "html_url": "https://github.com/octocat/Hello-World"
+},
+"subject": {
+  "title": "Greetings",
+  "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123",
+  "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123",
+  "type": "Issue"
+},
+"reason": "subscribed",
+"unread": true,
+"updated_at": "2014-11-07T22:01:45Z",
+"last_read_at": "2014-11-07T22:01:45Z",
+"url": "https://api.github.com/notifications/threads/1"
+}
diff --git a/tests/unit/subscription_example b/tests/unit/subscription_example
@@ -0,0 +1,8 @@
+{
+  "subscribed": true,
+  "ignored": false,
+  "reason": null,
+  "created_at": "2012-10-06T21:34:12Z",
+  "url": "https://api.github.com/notifications/threads/1/subscription",
+  "thread_url": "https://api.github.com/notifications/threads/1"
+}
diff --git a/tests/unit/test_notifications.py b/tests/unit/test_notifications.py
@@ -0,0 +1,60 @@
+import github3
+
+from .helper import (UnitHelper, create_example_data_helper, create_url_helper)
+
+get_example_data = create_example_data_helper('notification_example')
+url_for = create_url_helper(
+    'https://api.github.com/notifications/threads/1'
+)
+
+
+class TestThread(UnitHelper):
+    """Notification unit tests."""
+
+    described_class = github3.notifications.Thread
+    example_data = get_example_data()
+
+    def test_equality(self):
+        """Test equality/inequality between two instances."""
+        thread = github3.notifications.Thread(get_example_data())
+        assert self.instance == thread
+        thread._uniq = 1
+        assert self.instance != thread
+
+    def test_is_unread(self):
+        """Show that is_unread() equals unread property."""
+        assert self.instance.is_unread() == self.instance.unread
+
+    def test_repr(self):
+        """Show instance string is formatted correctly."""
+        assert repr(self.instance) == '<Thread [{0}]>'.format(
+            self.instance.subject.get('title'))
+
+    def test_delete_description(self):
+        """Show that a user can delete a subscription."""
+        self.instance.delete_subscription()
+
+        self.session.delete.assert_called_once_with(url_for('subscription'))
+
+    def test_mark(self):
+        """Show that a user can mark the subscription."""
+        self.instance.mark()
+
+        self.session.patch.assert_called_once_with(url_for())
+
+    def test_set_subscription(self):
+        """Show that a user can subscribe to notification."""
+        self.instance.set_subscription(True, False)
+
+        self.put_called_with(
+            url_for('subscription'),
+            data={"ignored": False, "subscribed": True},
+        )
+
+    def test_subscription(self):
+        """Show that a user can retrieve a subscription."""
+        self.instance.subscription()
+
+        self.session.get.assert_called_once_with(
+            url_for('subscription'),
+        )
diff --git a/tests/unit/test_subscription.py b/tests/unit/test_subscription.py
@@ -0,0 +1,45 @@
+import github3
+
+from .helper import (UnitHelper, create_url_helper, create_example_data_helper)
+
+get_example_data = create_example_data_helper('subscription_example')
+url_for = create_url_helper(
+    'https://api.github.com/notifications/threads/1/subscription'
+)
+
+
+class TestSubscription(UnitHelper):
+    """Subscription unit tests."""
+
+    described_class = github3.notifications.Subscription
+    example_data = get_example_data()
+
+    def test_repr(self):
+        """Show that instance is formatted as a string when printed."""
+        assert isinstance(repr(self.instance), str)
+
+    def test_delete(self):
+        """Show that a user can delete a subscription."""
+        self.instance.delete()
+
+        self.session.delete.assert_called_once_with(
+            url_for()
+        )
+
+    def test_is_ignored(self):
+        """Show that subscription is ignored."""
+        self.instance.is_ignored() == self.instance.ignored
+
+    def test_is_subscription(self):
+        """Show that subscription is subscribed."""
+        self.instance.is_subscribed() == self.instance.subscribed
+
+    def test_set(self):
+        """Show that a user can set a subscription."""
+        self.instance._update_attributes = lambda *args: None
+        self.instance.set(True, False)
+
+        self.put_called_with(
+            url_for(),
+            data={"ignored": False, "subscribed": True},
+        )
