Merge pull request #171 from KiwiTechLLC/sprint4

financial learning section api

base/constants.py

@@ -76,6 +76,12 @@ GUARDIAN_CODE_STATUS = (
     ('2', 'exist guardian code'),
     ('3', 'request for guardian code')
 )
+# article status
+ARTICLE_STATUS = (
+    ('1', 'read'),
+    ('2', 'in_progress'),
+    ('3', 'completed')
+)
 # relationship
 RELATIONSHIP = (
     ('1', 'parent'),

base/messages.py

@@ -150,7 +150,13 @@ SUCCESS_CODE = {
     "3038": "Status has been changed successfully.",
     # notification read
     "3039": "Notification read successfully",
-    "3040": "Start article successfully"
+    "3040": "Start article successfully",
+    # complete article
+    "3041": "Article completed successfully",
+    # submit assessment successfully
+    "3042": "Assessment completed successfully",
+    "3043": "Read article card successfully"
+
 }
 """status code error"""
 STATUS_CODE_ERROR = {

guardian/serializers.py

@@ -387,8 +387,6 @@ class ApproveTaskSerializer(serializers.ModelSerializer):
                 # reject the task
                 instance.task_status = str(NUMBER['three'])
                 instance.is_approved = False
-                # update total task point
-                junior_data.total_points = junior_data.total_points - instance.points
                 # update reject time of task
                 # instance.rejected_on = real_time()
                 instance.rejected_on = timezone.now().astimezone(pytz.utc)

junior/admin.py

@@ -2,8 +2,26 @@
 """Third party Django app"""
 from django.contrib import admin
 """Import Django app"""
-from .models import Junior, JuniorPoints, JuniorGuardianRelationship, JuniorArticlePoints
+from .models import (Junior, JuniorPoints, JuniorGuardianRelationship, JuniorArticlePoints, JuniorArticle,
+                     JuniorArticleCard)
 # Register your models here.
+@admin.register(JuniorArticle)
+class JuniorArticleAdmin(admin.ModelAdmin):
+    """Junior Admin"""
+    list_display = ['junior', 'article', 'status', 'is_completed']
+
+    def __str__(self):
+        """Return email id"""
+        return self.junior__auth__email
+
+@admin.register(JuniorArticleCard)
+class JuniorArticleCardAdmin(admin.ModelAdmin):
+    """Junior Admin"""
+    list_display = ['junior', 'article', 'article_card', 'is_read']
+
+    def __str__(self):
+        """Return email id"""
+        return self.junior__auth__email
 @admin.register(Junior)
 class JuniorAdmin(admin.ModelAdmin):
     """Junior Admin"""
@@ -30,4 +48,4 @@ class JuniorGuardianRelationshipAdmin(admin.ModelAdmin):
 @admin.register(JuniorArticlePoints)
 class JuniorArticlePointsAdmin(admin.ModelAdmin):
     """Junior Admin"""
-    list_display = ['junior', 'article', 'question', 'submitted_answer']
+    list_display = ['junior', 'article', 'question', 'submitted_answer', 'is_answer_correct']

junior/migrations/0022_juniorarticle.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.2 on 2023-08-09 09:34
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('web_admin', '0004_alter_surveyoption_survey'),
+        ('junior', '0021_alter_juniorarticlepoints_submitted_answer'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='JuniorArticle',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_completed', models.BooleanField(default=False)),
+                ('status', models.CharField(blank=True, choices=[('1', 'read'), ('2', 'in_progress'), ('3', 'completed')], default='1', max_length=10, null=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='junior_articles_details', to='web_admin.article')),
+                ('junior', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='juniors_article', to='junior.junior', verbose_name='Junior')),
+            ],
+        ),
+    ]

junior/migrations/0023_juniorarticlecard.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.2 on 2023-08-09 10:47
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('web_admin', '0004_alter_surveyoption_survey'),
+        ('junior', '0022_juniorarticle'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='JuniorArticleCard',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_read', models.BooleanField(default=False)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='junior_articles_detail', to='web_admin.article')),
+                ('article_card', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='junior_article_card', to='web_admin.articlecard')),
+                ('junior', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='juniors_article_card', to='junior.junior', verbose_name='Junior')),
+            ],
+        ),
+    ]

junior/models.py

@@ -6,11 +6,11 @@ from django.contrib.auth import get_user_model
 """Import ArrayField"""
 from django.contrib.postgres.fields import ArrayField
 """Import django app"""
-from base.constants import GENDERS, SIGNUP_METHODS, RELATIONSHIP, GUARDIAN_CODE_STATUS
+from base.constants import GENDERS, SIGNUP_METHODS, RELATIONSHIP, GUARDIAN_CODE_STATUS, ARTICLE_STATUS
 # Import guardian's model
 from guardian.models import Guardian
 # Import web admin's model
-from web_admin.models import SurveyOption, ArticleSurvey, Article
+from web_admin.models import SurveyOption, ArticleSurvey, Article, ArticleCard
 """Define User model"""
 User = get_user_model()
 # Create your models here.
@@ -161,3 +161,38 @@ class JuniorArticlePoints(models.Model):
     def __str__(self):
         """Return title"""
         return f'{self.id} | {self.question}'
+
+class JuniorArticle(models.Model):
+    """
+    Survey Options model
+    """
+    # associated junior with the task
+    junior = models.OneToOneField(Junior, on_delete=models.CASCADE, related_name='juniors_article', verbose_name='Junior')
+    article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name='junior_articles_details')
+    # article completed"""
+    is_completed = models.BooleanField(default=False)
+    status = models.CharField(max_length=10, choices=ARTICLE_STATUS, null=True, blank=True, default='1')
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        """Return title"""
+        return f'{self.id} | {self.article}'
+
+class JuniorArticleCard(models.Model):
+    """
+    Survey Options model
+    """
+    # associated junior with the task
+    junior = models.ForeignKey(Junior, on_delete=models.CASCADE, related_name='juniors_article_card', verbose_name='Junior')
+    article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name='junior_articles_detail')
+    article_card = models.ForeignKey(ArticleCard, on_delete=models.CASCADE, related_name='junior_article_card')
+
+    # article card read"""
+    is_read = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        """Return title"""
+        return f'{self.id} | {self.article}'

junior/serializers.py

@@ -12,7 +12,7 @@ from rest_framework_simplejwt.tokens import RefreshToken
 
 # local imports
 from account.utils import send_otp_email, generate_code
-from junior.models import Junior, JuniorPoints, JuniorGuardianRelationship
+from junior.models import Junior, JuniorPoints, JuniorGuardianRelationship, JuniorArticlePoints
 from guardian.tasks import generate_otp
 from base.messages import ERROR_CODE, SUCCESS_CODE
 from base.constants import (PENDING, IN_PROGRESS, REJECTED, REQUESTED, COMPLETED, NUMBER, JUN, ZOD, EXPIRED,

junior/urls.py

@@ -5,7 +5,8 @@ from .views import (UpdateJuniorProfile, ValidateGuardianCode, JuniorListAPIView
                     InvitedJuniorAPIView, FilterJuniorAPIView, RemoveJuniorAPIView, JuniorTaskListAPIView,
                     CompleteJuniorTaskAPIView, JuniorPointsListAPIView, ValidateReferralCode,
                     InviteGuardianAPIView, StartTaskAPIView, ReAssignJuniorTaskAPIView, StartArticleAPIView,
-                    StartAssessmentAPIView, CheckAnswerAPIView)
+                    StartAssessmentAPIView, CheckAnswerAPIView, CompleteArticleAPIView, ReadArticleCardAPIView,
+                    CreateArticleCardAPIView)
 """Third party import"""
 from rest_framework import routers
 
@@ -48,6 +49,8 @@ router.register('start-article', StartArticleAPIView, basename='start-article')
 router.register('start-assessment', StartAssessmentAPIView, basename='start-assessment')
 # check answer api"""
 router.register('check-answer', CheckAnswerAPIView, basename='check-answer')
+# start article"""
+router.register('create-article-card', CreateArticleCardAPIView, basename='create-article-card')
 # Define url pattern"""
 urlpatterns = [
     path('api/v1/', include(router.urls)),
@@ -55,4 +58,6 @@ urlpatterns = [
     path('api/v1/complete-task/', CompleteJuniorTaskAPIView.as_view()),
     path('api/v1/start-task/', StartTaskAPIView.as_view()),
     path('api/v1/reassign-task/', ReAssignJuniorTaskAPIView.as_view()),
+    path('api/v1/complete-article/', CompleteArticleAPIView.as_view()),
+    path('api/v1/read-article-card/', ReadArticleCardAPIView.as_view()),
 ]

junior/views.py

@@ -28,20 +28,23 @@ import requests
 # Import upload_image_to_alibaba
 # Import custom_response, custom_error_response
 # Import constants
-from junior.models import Junior, JuniorPoints, JuniorGuardianRelationship, JuniorArticlePoints
+from django.db.models import Sum
+from junior.models import (Junior, JuniorPoints, JuniorGuardianRelationship, JuniorArticlePoints, JuniorArticle,
+                           JuniorArticleCard)
 from .serializers import (CreateJuniorSerializer, JuniorDetailListSerializer, AddJuniorSerializer,
                           RemoveJuniorSerializer, CompleteTaskSerializer, JuniorPointsSerializer,
-                          AddGuardianSerializer, StartTaskSerializer, ReAssignTaskSerializer)
+                          AddGuardianSerializer, StartTaskSerializer, ReAssignTaskSerializer
+                          )
 from guardian.models import Guardian, JuniorTask
 from guardian.serializers import TaskDetailsSerializer, TaskDetailsjuniorSerializer
 from base.messages import ERROR_CODE, SUCCESS_CODE
-from base.constants import NUMBER
+from base.constants import NUMBER, ARTICLE_STATUS
 from account.utils import custom_response, custom_error_response
 from guardian.utils import upload_image_to_alibaba
 from .utils import update_positions_based_on_points
 from notifications.utils import send_notification
 from notifications.constants import REMOVE_JUNIOR
-from web_admin.models import Article, ArticleSurvey, SurveyOption
+from web_admin.models import Article, ArticleSurvey, SurveyOption, ArticleCard
 from web_admin.serializers.article_serializer import (ArticleSerializer, ArticleListSerializer,
                                                       StartAssessmentSerializer)
 """ Define APIs """
@@ -479,6 +482,8 @@ class StartArticleAPIView(viewsets.ModelViewSet):
             junior_instance = Junior.objects.filter(auth=self.request.user).last()
             article_id = request.data.get('article_id')
             article_data = Article.objects.filter(id=article_id).last()
+            if not JuniorArticle.objects.filter(junior=junior_instance, article=article_data).last():
+                JuniorArticle.objects.create(junior=junior_instance, article=article_data, status=str(NUMBER['two']))
             if article_data:
                 question_query = ArticleSurvey.objects.filter(article=article_id)
                 for question in question_query:
@@ -545,3 +550,74 @@ class CheckAnswerAPIView(viewsets.ModelViewSet):
             return custom_response(None, response_status=status.HTTP_200_OK)
         except Exception as e:
             return custom_error_response(str(e), response_status=status.HTTP_400_BAD_REQUEST)
+
+class CompleteArticleAPIView(views.APIView):
+    """Remove junior API"""
+    permission_classes = [IsAuthenticated]
+    http_method_names = ('put', 'get',)
+    def put(self, request, format=None):
+        try:
+            article_id = self.request.data.get('article_id')
+            JuniorArticle.objects.filter(junior__auth=request.user, article__id=article_id).update(
+                is_completed=True, status=str(NUMBER['three'])
+            )
+            return custom_response(SUCCESS_CODE['3041'], response_status=status.HTTP_200_OK)
+        except Exception as e:
+            return custom_error_response(str(e), response_status=status.HTTP_400_BAD_REQUEST)
+
+    def get(self, request, *args, **kwargs):
+        """ junior list"""
+        try:
+            article_id = self.request.GET.get('article_id')
+            total_earn_points = JuniorArticlePoints.objects.filter(junior__auth=request.user,
+                                                       article__id=article_id,
+                                                       is_answer_correct=True).aggregate(
+                total_earn_points=Sum('earn_points'))['total_earn_points']
+            data = {"total_earn_points":total_earn_points}
+            return custom_response(SUCCESS_CODE['3042'], data, response_status=status.HTTP_200_OK)
+        except Exception as e:
+            return custom_error_response(str(e), response_status=status.HTTP_400_BAD_REQUEST)
+
+
+class ReadArticleCardAPIView(views.APIView):
+    """Remove junior API"""
+    permission_classes = [IsAuthenticated]
+    http_method_names = ('put',)
+
+    def put(self, request, *args, **kwargs):
+        """ junior list"""
+        try:
+            junior_instance = Junior.objects.filter(auth=self.request.user).last()
+            article = self.request.data.get('article_id')
+            article_card = self.request.data.get('article_card')
+            JuniorArticleCard.objects.filter(junior=junior_instance,
+                                             article__id=article,
+                                             article_card__id=article_card).update(is_read=True)
+            return custom_response(SUCCESS_CODE['3043'], response_status=status.HTTP_200_OK)
+        except Exception as e:
+            return custom_error_response(str(e), response_status=status.HTTP_400_BAD_REQUEST)
+
+
+class CreateArticleCardAPIView(viewsets.ModelViewSet):
+    """Start article"""
+    permission_classes = [IsAuthenticated]
+    http_method_names = ('post',)
+
+    def create(self, request, *args, **kwargs):
+        """ junior list"""
+        try:
+            junior_instance = Junior.objects.filter(auth=self.request.user).last()
+            article_id = request.data.get('article_id')
+            article_data = Article.objects.filter(id=article_id).last()
+            if article_data:
+                article_cards = ArticleCard.objects.filter(article=article_id)
+                for article_card in article_cards:
+                    if not JuniorArticleCard.objects.filter(junior=junior_instance,
+                                                            article=article_data,
+                                                            article_card=article_card):
+                        JuniorArticleCard.objects.create(junior=junior_instance,
+                                                         article=article_data,
+                                                         article_card=article_card)
+            return custom_response(None, response_status=status.HTTP_200_OK)
+        except Exception as e:
+            return custom_error_response(str(e), response_status=status.HTTP_400_BAD_REQUEST)