Merge pull request #67 from shellfly/feature/votemixin

shellfly · web-flow · commit 79e278ef27ce · 2020-05-17T23:29:21.000+08:00
Add VoteMixin &amp; Django 3.0 test
diff --git a/.travis.yml b/.travis.yml
@@ -1,24 +1,14 @@
 language: python
 python:
-  - "2.7"
-  - "3.5"
+  - "3.7"
 env:
-  - DJANGO_VERSION=1.7
-  - DJANGO_VERSION=1.8
-  - DJANGO_VERSION=1.9
-  - DJANGO_VERSION=1.10
   - DJANGO_VERSION=2.0
+  - DJANGO_VERSION=3.0
 install:
-  - pip install -q Django==$DJANGO_VERSION flake8 coverage
+  - pip install -q Django==$DJANGO_VERSION flake8 coverage djangorestframework
 script:
   - flake8 --exclude vote/migrations/* vote
   - coverage run runtests.py
-matrix:
-  exclude:
-    - python: "3.5"
-      env: DJANGO_VERSION=1.7
-    - python: "2.7"
-      env: DJANGO_VERSION=2.0
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -71,4 +71,16 @@ Review.votes.all(user_id)
 
 ```
 
-``django-vote`` now requires Django 1.7 or greater. (for Django < 1.7, please install previous release `django-vote==1.1.3`)
+#### Use `VoteMixin` for REST API
+
+``` python
+class CommentViewSet(ModelViewSet, VoteMixin):
+    queryset = Comment.objects.all()
+    serializer_class = CommentSerializer
+```
+
+```sh
+POST /api/comments/{id}/vote/
+POST /api/comments/{id}/vote/ {"action":"down"}
+DELETE /api/comments/{id}/vote/
+```
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,16 @@
 Changelog
 =========
 
+2.2.0 (2020.05.20)
+------------------
+* Add post_vote signal
+* Add VoteMixin for easily write vote api
+* Drop support for Django < 2.0
+* Add Django 3.0 test
+
+2.1.7(2018.05.08)
+-----------------
+* fix template tag error on Django 2.0
 
 2.1.6(2017.12.20)
 ------------------
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,7 +41,7 @@
 
 # General information about the project.
 project = u'django-vote'
-copyright = u'2014, shellfly'
+copyright = u'2014-2020, shellfly'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -195,25 +195,25 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 
-# Latex figure (float) alignment
-#'figure_align': 'htbp',
+    # Latex figure (float) alignment
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'django-vote.tex', u'django-vote Documentation',
-   u'shellfly', 'manual'),
+    ('index', 'django-vote.tex', u'django-vote Documentation',
+     u'shellfly', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -256,9 +256,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'django-vote', u'django-vote Documentation',
-   u'shellfly', 'django-vote', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'django-vote', u'django-vote Documentation',
+     u'shellfly', 'django-vote', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ Welcome to django-vote's documentation!
 
    getting_started
    api
+   rest api
    changelog
 
 
diff --git a/docs/rest api.rst b/docs/rest api.rst
@@ -0,0 +1,9 @@
+REST API
+========
+
+There is a `VoteMixin` for you to easily add rest api to conduct vote::
+
+    from vote.views import VoteMixin
+
+    class CommentViewSet(VoteMixin,ModelViewSet):
+        # ... fields here
diff --git a/runtests.py b/runtests.py
@@ -19,11 +19,15 @@
             'test',
         ],
         ROOT_URLCONF="test.urls",
-        MIDDLEWARE_CLASSES = [
+        MIDDLEWARE_CLASSES=[  # Deprecated in Django 1.10 https://docs.djangoproject.com/en/1.11/ref/settings/#middleware-classes
             'django.contrib.sessions.middleware.SessionMiddleware',
             'django.contrib.auth.middleware.AuthenticationMiddleware',
         ],
-        TEMPLATES = [
+        MIDDLEWARE=[
+            'django.contrib.sessions.middleware.SessionMiddleware',
+            'django.contrib.auth.middleware.AuthenticationMiddleware',
+        ],
+        TEMPLATES=[
             {
                 'BACKEND': 'django.template.backends.django.DjangoTemplates',
                 'APP_DIRS': True,
@@ -32,10 +36,10 @@
                         'django.template.context_processors.request',
                         'django.contrib.auth.context_processors.auth',
                     ],
-                    
+
                 },
             },
-            
+
         ]
     )
 
@@ -44,5 +48,6 @@ def runtests():
     argv = sys.argv[:1] + ['test'] + sys.argv[1:]
     execute_from_command_line(argv)
 
+
 if __name__ == '__main__':
     runtests()
diff --git a/setup.py b/setup.py
@@ -18,21 +18,22 @@
     license='BSD License',
     description='A simple Django app to conduct vote.',
     long_description=README,
-    url='https://github.com/Beeblio/django-vote',
+    url='https://github.com/shellfly/django-vote',
     author='shellfly',
     author_email='shell0fly@gmail.com',
     classifiers=[
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Environment :: Web Environment',
         'Framework :: Django',
         'Framework :: Django :: 1.7',
         'Framework :: Django :: 1.8',
         'Framework :: Django :: 1.9',
         'Framework :: Django :: 1.10',
         'Framework :: Django :: 2.0',
+        'Framework :: Django :: 3.0',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
         'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.8',
     ],
 )
diff --git a/test/serializers.py b/test/serializers.py
@@ -0,0 +1,8 @@
+from .models import Comment
+from rest_framework import serializers
+
+
+class CommentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Comment
+        fields = '__all__'
diff --git a/test/templates/test/comments.html b/test/templates/test/comments.html
@@ -1,4 +1,4 @@
 {% load vote %}
 {% for comment in comments %}
 {{comment.content}} {% vote_exists comment user %}
-{% endfor %}
+{% endfor %}
diff --git a/test/tests.py b/test/tests.py
@@ -17,6 +17,9 @@ def setUp(self):
                                               '111111')
         self.user3 = User.objects.create_user("test3", "test3@test.com",
                                               '111111')
+        print('\n%s.%s.%s' % (self.__class__.__module__,
+                              self.__class__.__name__,
+                              self._testMethodName))
 
     def tearDown(self):
         self.model.objects.all().delete()
@@ -113,7 +116,7 @@ def test_vote_annotate(self):
             self.model(
                 user_id=self.user1.pk,
                 content="I'm a comment, sequence %s" % i) for i in range(10)
-            ]
+        ]
 
         self.model.objects.bulk_create(comments)
         comments = list(self.model.objects.all())
@@ -159,7 +162,7 @@ def test_objects_with_status(self):
             self.model(
                 user_id=self.user1.pk,
                 content="I'm a comment, sequence %s" % i) for i in range(10)
-            ]
+        ]
 
         self.model.objects.bulk_create(comments)
         comments = list(self.model.objects.all())
@@ -191,7 +194,6 @@ def test_objects_with_status(self):
             self.assertTrue(hasattr(comment, 'is_voted_up'))
             self.assertTrue(hasattr(comment, 'is_voted_down'))
 
-
         comments = votes.vote_by(self.user2.pk, queryset=Comment.objects.all())
         for comment in comments:
             self.assertTrue(hasattr(comment, 'is_voted_up'))
@@ -204,13 +206,44 @@ def test_vote_templatetag(self):
             self.model(
                 user_id=self.user1.pk,
                 content="I'm a comment, sequence %s" % i) for i in range(5)
-            ]
+        ]
 
         self.model.objects.bulk_create(comments)
         comments = list(self.model.objects.all())
 
         comment1 = comments[0]
         self.call_api('up', comment1, self.user1.pk)
-        res = self.client.get('/comments/')
+        # test with anonymous user
+        self.client.get('/comments/')
+        # test with authenticated user
         self.client.login(username=self.user1.username, password='111111')
         self.client.get('/comments/')
+
+    def test_votemixin_api(self):
+        comment = self.model(
+            user_id=self.user1.pk,
+            content="I'm a comment")
+        comment.save()
+        self.assertEqual(comment.num_vote_up, 0)
+        self.client.login(
+            username=self.user1.username, password='111111')
+
+        res = self.client.post('/api/comments/%s/vote/' % comment.id)
+        self.assertEqual(res.status_code, 200)
+        res = self.client.post('/api/comments/%s/vote/' % comment.id)
+        self.assertEqual(res.status_code, 409)
+        comment = Comment.objects.get(id=comment.id)
+        self.assertEqual(comment.num_vote_up, 1)
+
+        res = self.client.post('/api/comments/%s/vote/' %
+                               comment.id, {"action": "down"})
+        self.assertEqual(res.status_code, 200)
+        comment = Comment.objects.get(id=comment.id)
+        self.assertEqual(comment.num_vote_up, 0)
+        self.assertEqual(comment.num_vote_down, 1)
+
+        res = self.client.delete('/api/comments/%s/vote/' % comment.id)
+        comment = Comment.objects.get(id=comment.id)
+        self.assertEqual(res.status_code, 200)
+        self.assertEqual(comment.num_vote_up, 0)
+        self.assertEqual(comment.num_vote_down, 0)
diff --git a/test/urls.py b/test/urls.py
@@ -1,7 +1,11 @@
-from django.conf.urls import url
-
 from . import views
+from django.urls import path, include
+from rest_framework.routers import DefaultRouter
+
+router = DefaultRouter()
+router.register(r'comments', views.CommentViewSet)
 
 urlpatterns = [
-        url(r'^comments/$', views.comments),
+    path('comments/', views.comments),
+    path('api/', include(router.urls)),
 ]
diff --git a/test/views.py b/test/views.py
diff --git a/vote/signals/__init__.py b/vote/signals/__init__.py
diff --git a/vote/templatetags/vote.py b/vote/templatetags/vote.py
diff --git a/vote/views.py b/vote/views.py
