Merge pull request #648 from unfoldingWord-dev/develop

Develop

Author: vleong2332

td/gl_tracking/views.py

@@ -1,3 +1,4 @@
+from django.contrib import messages
 from django.shortcuts import render
 from django.views.generic import TemplateView, DetailView, CreateView
 from django.views.generic.edit import FormView, UpdateView
@@ -122,6 +123,14 @@ def form_valid(self, form):
 class PartnerListView(LoginRequiredMixin, TemplateView):
     template_name = "gl_tracking/partner_list.html"
 
+    def get(self, request, *args, **kwargs):
+        print "Something"
+        messages.warning(request, "The ability to create and update Languages, WA Regions, Countries, Charters, Events,"
+                                  " and Partners will be suspended for all users starting on Monday, Jan. 9, 2017."
+                                  " These functions will be made available in the new system, which is launching in"
+                                  " a couple of weeks. Please retain the information you want to enter until then.")
+        return super(PartnerListView, self).get(request, *args, **kwargs)
+
 
 class PartnerDetailView(LoginRequiredMixin, DetailView):
     model = Partner

td/models.py

@@ -430,7 +430,7 @@ def codes_text(cls):
     @classmethod
     def names_text(cls):
         return "\n".join([
-            "{}\t{}".format(x.code, x.name.encode("utf-8"))
+            "{}\t{}".format(x.code.encode("utf-8"), x.name.encode("utf-8"))
             for x in cls.objects.all().order_by("code")
         ])
 

td/receivers.py

@@ -10,7 +10,7 @@
 from pinax.eventlog.models import log
 
 from .models import Country, Language, LanguageAltName, AdditionalLanguage, TempLanguage, WARegion
-from .tasks import reset_langnames_cache, update_alt_names, create_comment_tag, delete_comment_tag
+from .tasks import reset_langnames_cache, update_alt_names, create_comment_tag, delete_comment_tag, notify_external_apps
 from .signals import languages_integrated
 from td.resources.tasks import notify_templanguage_created
 
@@ -60,39 +60,50 @@ def handle_additionallanguage_delete(sender, instance, **kwargs):
 
 @receiver(post_save, sender=Language)
 def handle_language_save(sender, instance=None, created=False, **kwargs):
-    (instance and "code" in instance.tracker.changed().keys()) and create_comment_tag(instance)
+    if instance is not None:
+        notify_external_apps("CREATE" if created else "UPDATE", instance)
+        if "code" in instance.tracker.changed().keys():
+            create_comment_tag(instance)
     reset_langnames_cache.delay()
     cache.set("map_gateway_refresh", True)
 
 
 @receiver(post_delete, sender=Language)
 def handle_language_delete(sender, instance=None, **kwargs):
-    instance and delete_comment_tag(instance)
+    if instance is not None:
+        # notify_external_apps("DELETE", instance)
+        delete_comment_tag(instance)
     reset_langnames_cache.delay()
     cache.set("map_gateway_refresh", True)
 
 
 @receiver(post_save, sender=LanguageAltName)
-def handle_alt_name_save(sender, instance=None, **kwargs):
+def handle_alt_name_save(sender, instance=None, created=False, **kwargs):
     if instance is not None:
+        # notify_external_apps("CREATE" if created else "UPDATE", instance)
         update_alt_names(instance.code)
 
 
 @receiver(post_delete, sender=LanguageAltName)
 def handle_alt_name_delete(sender, instance=None, **kwargs):
     if instance is not None:
+        # notify_external_apps("DELETE", instance)
         update_alt_names(instance.code)
 
 
 @receiver(post_save, sender=Country)
 def handle_country_save(sender, instance=None, created=False, **kwargs):
-    "code" in instance.tracker.changed().keys() and create_comment_tag(instance)
+    if instance is not None:
+        # notify_external_apps("CREATE" if created else "UPDATE", instance)
+        "code" in instance.tracker.changed().keys() and create_comment_tag(instance)
     cache.set("map_gateway_refresh", True)
 
 
 @receiver(post_delete, sender=Country)
 def handle_country_delete(sender, instance=None, **kwargs):
-    instance and delete_comment_tag(instance)
+    if instance is not None:
+        # notify_external_apps("DELETE", instance)
+        delete_comment_tag(instance)
     cache.set("map_gateway_refresh", True)
 
 

td/resources/tests/test_models.py

@@ -1,6 +1,8 @@
 from django.test import TestCase
+
 from ..models import Resource, Media, Title, Publisher, Questionnaire
 from td.models import Language
+from td.tests.models import NoSignalTestCase
 
 
 class MediaTestCase(TestCase):
@@ -21,21 +23,20 @@ def test_string_representation(self):
         self.assertEquals(str(publisher), "Test Publisher")
 
 
-class ResourceTestCase(TestCase):
-    @classmethod
-    def setUpClass(cls):
-        super(ResourceTestCase, cls).setUpClass()
-        cls.publisher = Publisher(name="Test Publisher 1")
-        cls.publisher.save()
-        cls.publisher2 = Publisher(name="Test Publisher 2")
-        cls.publisher2.save()
-        cls.title = Title(name="Test Title", slug="test-title")
-        cls.title.publisher = cls.publisher
-        cls.title.save()
-        cls.media = Media(name="Media Title", slug="test-media")
-        cls.media.save()
-        cls.language = Language(code="ztest", name="Z Language")
-        cls.language.save()
+class ResourceTestCase(NoSignalTestCase):
+    def setUp(self):
+        super(ResourceTestCase, self).setUp()
+        self.publisher = Publisher(name="Test Publisher 1")
+        self.publisher.save()
+        self.publisher2 = Publisher(name="Test Publisher 2")
+        self.publisher2.save()
+        self.title = Title(name="Test Title", slug="test-title")
+        self.title.publisher = self.publisher
+        self.title.save()
+        self.media = Media(name="Media Title", slug="test-media")
+        self.media.save()
+        self.language = Language(code="ztest", name="Z Language")
+        self.language.save()
 
     def test_string_representation(self):
         resource = Resource(language=self.language, title=self.title)

td/settings.py

@@ -267,3 +267,16 @@
 }
 
 JP_API_KEY = os.environ.get("JP_API_KEY")
+
+EXT_APP_PUSH = [
+    {
+        "name": "wa_ops_crm",
+        "url": "http://wa-td-integration.azurewebsites.net/api/crm/update",
+        "key": os.environ.get("CRM_API_KEY"),
+    }
+]
+
+HOMEPAGE_MESSAGE = "The ability to create and update Languages, WA Regions, Countries, Charters, Events, and Partners " \
+                   "will be suspended for all users starting on Monday, Jan. 9, 2017. These functions will be made " \
+                   "available in the new system, which is launching in a couple of weeks. Please retain the " \
+                   "information you want to enter until then."

td/tasks.py

@@ -1,14 +1,19 @@
 from __future__ import absolute_import
 
 import logging
+import json
+import requests
+import types
 
 from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
-from django.db import connection, IntegrityError
+from django.core.mail import send_mail
+from django.db import connection, IntegrityError, models
 
 from celery import task
 from pinax.eventlog.models import log
 
+from td import settings
 from td.commenting.models import CommentTag
 from td.imports.models import (
     EthnologueLanguageCode,
@@ -27,6 +32,12 @@
 logger = logging.getLogger(__name__)
 
 
+class TaskStatus(object):
+    def __init__(self, success=False):
+        self.success = success
+        self.message = []
+
+
 @task()
 def create_comment_tag(instance):
     try:
@@ -191,3 +202,87 @@ def integrate_imb_language_data():
                 language.country = country
                 language.source = imb
                 language.save()
+
+
+@task()
+def notify_external_apps(action="", instance=None):
+    """ Make a POST request based on action types to urls registered in EXT_APP_PUSH under settings """
+
+    task_status = TaskStatus()
+
+    if not isinstance(instance, models.Model):
+        task_status.message.append("function is called with invalid 'instance'")
+        return task_status
+    if not isinstance(action, (str, unicode)) or action.strip() == "":
+        task_status.message.append("function is called with invalid 'action'")
+        return task_status
+    if not isinstance(settings.EXT_APP_PUSH, types.ListType):
+        task_status.message.append("settings.EXT_APP_PUSH is not a list")
+        return task_status
+
+    data = None
+
+    if action == "CREATE":
+        # If instance is created, serialize all concrete fields and assign them as data
+        # serialized_instances = serializers.serialize('json', [instance])
+        # serialized_data = json.loads(serialized_instances)[0]
+        # data = serialized_data
+        # data.update({"code": instance.code})
+        task_status.message.append("%s is not supported at this moment" % action)
+        return task_status
+    elif action == "UPDATE":
+        # If instance is edited, only pass the changed fields as data
+        data = {
+            "pk": instance.id,
+            "code": instance.tracker.previous("code") if instance.tracker.has_changed("code") else instance.code,
+            "fields": {key.replace("_id", ""): getattr(instance, key, "") for key in instance.tracker.changed().keys()}
+        }
+    elif action == "DELETE":
+        # If instance is deleted, just pass the id
+        # data = {
+        #     "pk": instance.id,
+        #     "code": instance.code,
+        # }
+        task_status.message.append("%s is not supported at this moment" % action)
+        return task_status
+    else:
+        task_status.message.append("%s is not a valid option for 'action'" % action)
+        return task_status
+
+    # Include model name and action type in data to meet the spec. If action is 'CREATE', 'model' will be overridden by
+    #    class name instead of what the serializer sets.
+    # Also include (previous) code to help identify records, especially the ones created by outside apps.
+    data.update({
+        "model": instance.__class__.__name__,
+        "action": action,
+    })
+
+    data = [data]
+
+    # NOTE: Maybe this can be abstracted into a function for easier testing
+    for app in settings.EXT_APP_PUSH:
+        url = app.get("url")
+        if "key" in app:
+            key = app.get("key")
+            url += "?key=" + key if key is not None else ""
+        headers = {'Content-Type': 'application/json'}
+
+        post_to_ext_apps.delay(url, json.dumps(data), headers)
+
+    task_status.success = True
+    return task_status
+
+
+@task()
+def post_to_ext_apps(url, data, headers):
+    response = requests.post(url, data=data, headers=headers)
+    if response.status_code == 202 and response.content == "":
+        return
+    else:
+        message = "POST to %s has failed with code: %s and message: %s" % (url, response.status_code, response.content)
+        send_mail(
+            "Ops CRM shim rejects POST",
+            message,
+            "admin@unfoldingword.org",
+            ["vleong2332@gmail.com"],
+        )

td/templates/gl_tracking/partner_list.html

@@ -10,9 +10,9 @@
             <h1>{% blocktrans %}Translation Partners{% endblocktrans %}</h1>
             {% url "gl:partner_create_view" as partner_create %}
             {% if user.is_authenticated %}
-                {% blocktrans %}
-                    <a href="{{ partner_create }}" class="btn btn-primary large">Add a Partner</a>
-                {% endblocktrans %}
+{#                {% blocktrans %}#}
+{#                    <a href="{{ partner_create }}" class="btn btn-primary large">Add a Partner</a>#}
+{#                {% endblocktrans %}#}
             {% endif %}
         </div>
     </section>

td/templates/resources/_empty_div_overlay.html

@@ -2,7 +2,7 @@
     <h3 class="empty-div-msg">{{ msg }}</h3>
     {% if action %}
         {% if user.is_authenticated %}
-            <a class="btn btn-primary btn-empty-div" href="{{ action_url }}">{{ action }}</a>
+{#            <a class="btn btn-primary btn-empty-div" href="{{ action_url }}">{{ action }}</a>#}
         {% else %}
             <a class="btn btn-primary btn-empty-div" href="">Login</a>
         {% endif %}

td/templates/resources/_project_detail.html

@@ -6,7 +6,7 @@
             <h4 class="section-header-title">Charter</h4>
             <div class="section-header-line"></div>
             <div class="section-header-actions">
-                <a class="btn btn-icon" href="{% url "tracking:charter_update" charter.pk %}" title="Edit Charter"><i class="fa fa-pencil"></i></a>
+{#                <a class="btn btn-icon" href="{% url "tracking:charter_update" charter.pk %}" title="Edit Charter"><i class="fa fa-pencil"></i></a>#}
                 <button class="btn btn-icon" data-toggle="collapse" data-target=".charter-section"><i class="fa fa-compress"></i></button>
             </div>
         </div>
@@ -32,7 +32,7 @@ <h4 class="section-header-title">Charter</h4>
                 </div>
                 <div class="col-md-6">
                     {% include "comments/custom_lists.html" with object=data prefix="ch" %}
-                    {% render_comment_form for data %}
+{#                    {% render_comment_form for data %}#}
                 </div>
             </div>
         </div>
@@ -43,7 +43,7 @@ <h4 class="section-header-title">Charter</h4>
             <h4 class="section-header-title">Events</h4>
             <div class="section-header-line"></div>
             <div class="section-header-actions">
-                <a class="btn btn-icon" href="{% url "tracking:event_add_specific" charter.pk %}"><i class="fa fa-plus"></i></a>
+{#                <a class="btn btn-icon" href="{% url "tracking:event_add_specific" charter.pk %}"><i class="fa fa-plus"></i></a>#}
                 <button class="btn btn-icon" data-toggle="collapse" data-target=".event-section"><i class="fa fa-compress"></i></button>
             </div>
         </div>

td/templates/resources/country_detail.html

@@ -126,7 +126,7 @@ <h2>Event Count</h2>
             <!-- COMMENTS VIEW -->
             <div id="comments-view" class="row tab-pane">
                 <div class="col-md-12">
-                    {% render_comment_form for country %}
+{#                    {% render_comment_form for country %}#}
                     {% include "comments/custom_lists.html" with object=country %}
                 </div>
             </div>