Merge pull request #848 from scieloorg/beta

Incorporação de códigos estáveis

Author: gustavofonseca

scielomanager/api/tests.py

@@ -1169,6 +1169,7 @@ def test_api_v1_data_checkin(self):
                 u'article',
                 u'attempt_ref',
                 u'created_at',
+                u'expiration_at',
                 u'id',
                 u'package_name',
                 u'rejected_at',

scielomanager/articletrack/migrations/0010_auto__add_field_checkin_expiration_at.py

@@ -15,7 +15,8 @@ def all(self, get_all_collections=user_request_context.get_current_user_collecti
 
     def active(self, get_active_collection=user_request_context.get_current_user_active_collection):
         return self.filter(
-            article__journals__collections=get_active_collection()).distinct()
+            article__journals__collections=get_active_collection()
+            ).exclude(status='expired').distinct()
 
     def accepted(self):
         return self.filter(status='accepted')
@@ -29,6 +30,9 @@ def rejected(self):
     def review(self):
         return self.filter(status='review')
 
+    def expired(self):
+        return self.filter(status='expired')
+
 
 class CheckinManager(UserObjectManager):
 

scielomanager/articletrack/modelmanagers.py

@@ -1,4 +1,4 @@
-#coding: utf-8
+# coding: utf-8
 import caching.base
 import datetime
 import logging
@@ -9,6 +9,7 @@
 from django.utils.translation import ugettext_lazy as _
 from django.contrib.auth.models import User
 from django.core.exceptions import SuspiciousOperation, ValidationError
+from django.conf import settings
 
 from articletrack import modelmanagers
 from journalmanager.models import Journal
@@ -20,6 +21,7 @@
 MSG_WORKFLOW_REVIEWED = 'Checkin Reviewed'
 MSG_WORKFLOW_SENT_TO_PENDING = 'Checkin Sent to Pending'
 MSG_WORKFLOW_SENT_TO_REVIEW = 'Checkin Sent to Review'
+MSG_WORKFLOW_EXPIRED = 'Checkin Expired'
 
 
 class Notice(caching.base.CachingMixin, models.Model):
@@ -45,6 +47,7 @@ def __unicode__(self):
     ('review', _('Review')),
     ('accepted', _('Accepted')),
     ('rejected', _('Rejected')),
+    ('expired', _('Expired')),
 )
 
 
@@ -57,7 +60,7 @@ def decorated(*args, **kwargs):
             log.checkin = args[0]
             log.status = args[0].status
             log.created_at = datetime.datetime.now()
-            log.user = args[1]
+            log.user = args[1] if len(args) >= 2 else None
             log.description = message + (" - Reason: %s" % args[0].rejected_cause if getattr(args[0], 'rejected_cause') else '')
             log.save()
 
@@ -91,6 +94,8 @@ class Checkin(caching.base.CachingMixin, models.Model):
 
     submitted_by = models.ForeignKey(User, related_name='checkins_submitted_by', null=True, blank=True)
 
+    expiration_at = models.DateTimeField(_(u'Expiration Date'), null=True, blank=True)
+
     class Meta:
         ordering = ['-created_at']
         permissions = (("list_checkin", "Can list Checkin"),)
@@ -118,6 +123,14 @@ def is_newest_checkin(self):
         """
         return self.pk == self.get_newest_checkin.pk
 
+    @property
+    def is_expirable(self):
+        """
+        Return True if the expiration_at's date is equal to datetime.date.today()
+        Compared with <= to catch possibly unprocessed checkins
+        """
+        return self.status == 'pending' and self.expiration_at.date() <= datetime.date.today()
+
     def is_accepted(self):
         """
         Checks if this checkin has been accepted
@@ -270,7 +283,6 @@ def do_review(self, responsible):
         else:
             raise ValueError('This checkin does not comply with the conditions to be reviewed')
 
-
     @log_workflow_status(MSG_WORKFLOW_REJECTED)
     def do_reject(self, responsible, reason):
         """
@@ -295,6 +307,18 @@ def do_reject(self, responsible, reason):
         else:
             raise ValueError('This checkin does not comply with the conditions to change status to "rejected"')
 
+    @log_workflow_status(MSG_WORKFLOW_EXPIRED)
+    def do_expires(self, responsible=None):
+        """
+        Change self.status to 'expired'.
+        Change self.expiration_at to now()
+        This action generates a ``CheckinWorkflowLog`` entry.
+        """
+        if self.status != 'expired':
+            self.status = 'expired'
+            self.expiration_at = datetime.datetime.now()
+            self.save()
+
     def clean(self):
         # validation for status "accepted"
         if self.status == 'accepted' and not bool(self.accepted_by and self.accepted_at and self.reviewed_by and self.reviewed_at):
@@ -307,6 +331,12 @@ def clean(self):
 
     def save(self, *args, **kwargs):
         if self.status == 'pending':
+            if self.expiration_at is None:
+                # update expiration info
+                now = datetime.datetime.now()
+                time_span = settings.CHECKIN_EXPIRATION_TIME_SPAN
+                delta_next = datetime.timedelta(days=time_span)
+                self.expiration_at = now + delta_next
             # clear 'review' fields
             self.reviewed_by = None
             self.reviewed_at = None
@@ -318,6 +348,8 @@ def save(self, *args, **kwargs):
             self.rejected_at = None
             self.rejected_cause = None
         elif self.status == 'review':
+            # update expiration info
+            self.expiration_at = None
             # clear 'accepted' fields
             self.accepted_by = None
             self.accepted_at = None
@@ -326,12 +358,17 @@ def save(self, *args, **kwargs):
             self.rejected_at = None
             self.rejected_cause = None
         elif self.status == 'rejected':
+            # update expiration info
+            self.expiration_at = None
             # clear 'review' fields
             self.reviewed_by = None
             self.reviewed_at = None
             # clear 'accepted' fields
             self.accepted_by = None
             self.accepted_at = None
+        else:
+            # update expiration info
+            self.expiration_at = None
         super(Checkin, self).save(*args, **kwargs)
 
     def __unicode__(self):

scielomanager/articletrack/models.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+import datetime
+import logging
+from xmlrpclib import Fault, ProtocolError
+
+from .balaio import BalaioRPC
+from .models import Checkin
+from scielomanager.celery import app
+
+logger = logging.getLogger(__name__)
+
+
+@app.task(bind=True)
+def do_expires_checkin(self, checkin):
+    """
+    For this checkin:
+    - call do_expires() that change status and create workflow logs.
+    - call BalaioRPC.expire_attempt API method to trigger action on Balaio's side.
+    if API is down or RPC call raise exception -> task will be retried
+    """
+    rpc_client = BalaioRPC()
+    logger.debug('[do_expires_checkin] START process to expire checkin (pk=%s) at %s' % (checkin.pk, datetime.datetime.now()))
+    checkin.do_expires()
+    logger.info('[do_expires_checkin] EXPIRED checkin pk: %s' % checkin.pk)
+    if rpc_client.is_up():
+        try:
+            rpc_response = rpc_client.call('expire_attempt', [checkin.attempt_ref, ])
+        except (Fault, ProtocolError, ValuerError) as e:
+            logger.debug('[do_expires_checkin] FAIL, retrying: exception' % e)
+            raise self.retry(exc=e)
+        logger.info('[do_expires_checkin] BALAIO RPC method call success!.')
+    else:
+        raise self.retry(exc=Exception("Balaio is down!"))
+        logger.error('[do_expires_checkin] BALAIO RPC is Down. Could not call "expire_attempt" method.')
+    logger.debug('[do_expires_checkin] FINISH process at %s' % datetime.datetime.now())
+
+
+@app.task(bind=True)
+def process_expirable_checkins(self):
+    """
+    RUN: daily!
+    For each checkin that is "expirable":
+        call the task: do_expires_checkin to change the checkins as expired
+    """
+    logger.debug('[process_expirable_checkins] START process at %s' % datetime.datetime.now())
+    checkins = Checkin.objects.filter(status='pending', expiration_at__isnull=False)
+    logger.info('[process_expirable_checkins] Found %s checkins matching conditions' % checkins.count())
+    for checkin in checkins:
+        logger.info('[process_expirable_checkins] Processing checkin (pk=%s)' % checkin.pk)
+        if checkin.is_expirable:
+            do_expires_checkin.apply_async(args=[checkin, ])
+
+    logger.debug('[process_expirable_checkins] FINISH process at %s' % datetime.datetime.now())

scielomanager/articletrack/tasks.py

@@ -82,6 +82,15 @@ <h4>{% trans "Check-in Information" %}:</h4>
 
           {% endif %}
 
+          {% if checkin.status == "pending" and checkin.expiration_at %}
+              <dt>{% trans "Will Expire at" %}:</dt>
+              <dd>
+                <span class="label label-important">
+                  {{ checkin.expiration_at|date:"d/m/Y - H:i" }}
+                </span>
+              </dd>
+          {% endif %}
+
         </dl>
       </div>
     </div>

scielomanager/articletrack/templates/articletrack/includes/article_and_checkin_information.html

@@ -33,4 +33,32 @@ <h4><i class="icon-ok-circle"></i> {% trans "ACCEPTED" %}:</h4>
     </div>
   </div>
 
+{% elif checkin.is_expirable %}
+
+    <div class="row-fluid show-grid">
+    <div class="span12">
+      <div class="alert alert-error alert-block">
+        <h4><i class="icon-ok-circle"></i> {% trans "THIS CHECKIN WILL EXPIRE TODAY" %}:</h4>
+        <p>
+          {% trans "This checkin will expire at: " %} 
+          {% trans "at" %} {{ checkin.expiration_at|date:"d/m/Y - H:i" }}
+        </p>
+        <p>
+          {% trans "Before that date, the checkin will be unreachable." %}
+        </p>
+      </div>
+    </div>
+  </div>
+
+{% elif checkin.status == "expired"  %}
+
+  <div class="row-fluid show-grid">
+    <div class="span12">
+      <div class="alert alert-success alert-block">
+        <h4><i class="icon-ok-circle"></i>{% trans "THIS CHECKIN IS EXPIRED!" %}</h4>
+      </div>
+    </div>
+  </div>
+
+
 {% endif %}

scielomanager/articletrack/templates/articletrack/includes/checkin_status_notice_block.html

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 from os import path
-from articletrack.balaio import BalaioAPI
+from articletrack.balaio import BalaioAPI, BalaioRPC
 from django.conf import settings
 from urllib2 import urlopen
 
@@ -47,3 +47,12 @@ def is_up(self):
 
     def list_files_members_by_attempt(self, attempt_id):
         raise ValueError
+
+
+class BalaioRPCDouble(BalaioRPC):
+
+    def is_up(self):
+        return True
+
+    def call(self, method, args=()):
+        return None

scielomanager/articletrack/tests/doubles.py

@@ -2,7 +2,7 @@
 import datetime
 from django.test import TestCase
 from django_factory_boy import auth
-
+from django.conf import settings
 from articletrack import models
 from . import modelfactories
 
@@ -185,6 +185,24 @@ def test_is_newest_checkin(self):
         self.assertTrue(checkin2.is_newest_checkin)
         self.assertFalse(checkin1.is_newest_checkin)
 
+    def test_new_checkin_has_correct_expiration_date_and_is_not_expirable(self):
+        checkin = modelfactories.CheckinFactory()
+
+        now = datetime.datetime.now()
+        days_delta = datetime.timedelta(days=settings.CHECKIN_EXPIRATION_TIME_SPAN)
+        next_week_date = now + days_delta
+
+        self.assertEqual(checkin.expiration_at.date(), next_week_date.date())
+        self.assertFalse(checkin.is_expirable)
+
+    def test_if_expiration_date_is_today_then_checkin_is_expirable(self):
+        now = datetime.datetime.now()
+
+        checkin = modelfactories.CheckinFactory(expiration_at=now)
+
+        self.assertEqual(checkin.expiration_at.date(), now.date())
+        self.assertTrue(checkin.is_expirable)
+
 
 class ArticleTests(TestCase):
 
@@ -329,3 +347,16 @@ def test_checkin_send_to_pending_log(self):
         self.assertEqual(logs.count(), 1)
         self.assertEqual(logs[0].user, user2_send_to_review)
         self.assertEqual(logs[0].description, models.MSG_WORKFLOW_SENT_TO_PENDING)
+
+    def test_do_expires_generate_log_entry(self):
+        checkin = modelfactories.CheckinFactory()
+
+        # do_expires
+        checkin.do_expires()
+
+        logs = models.CheckinWorkflowLog.objects.filter(checkin=checkin, status=checkin.status)
+
+        self.assertEqual(logs.count(), 1)
+        self.assertIsNone(logs[0].user)
+        self.assertEqual(logs[0].status, 'expired')
+        self.assertEqual(logs[0].description, models.MSG_WORKFLOW_EXPIRED)