Merge pull request wevote#1827 from DaleMcGrew/Dale_WVS_May19-2022

New API messageToFriendSend.

Author: DaleMcGrew

apis_v1/documentation_source/message_to_friend_send_doc.py

@@ -0,0 +1,72 @@
+# apis_v1/documentation_source/message_to_friend_send_doc.py
+# Brought to you by We Vote. Be good.
+# -*- coding: UTF-8 -*-
+
+
+def doc_template_values(url_root):
+    """
+    Show documentation about messageToFriendSend
+    """
+    required_query_parameter_list = [
+        {
+            'name':         'voter_device_id',
+            'value':        'string',  # boolean, integer, long, string
+            'description':  'An 88 character unique identifier linked to a voter record on the server',
+        },
+        {
+            'name':         'api_key',
+            'value':        'string (from post, cookie, or get (in that order))',  # boolean, integer, long, string
+            'description':  'The unique key provided to any organization using the WeVoteServer APIs',
+        },
+        {
+            'name':         'other_voter_we_vote_id',
+            'value':        'string',  # boolean, integer, long, string
+            'description':  'The voter to send the friend invitation to.',
+        },
+    ]
+    optional_query_parameter_list = [
+        {
+            'name':         'message_to_send',
+            'value':        'string',  # boolean, integer, long, string
+            'description':  'An optional message to send.',
+        },
+    ]
+
+    potential_status_codes_list = [
+        {
+            'code':         'VALID_VOTER_DEVICE_ID_MISSING',
+            'description':  'Cannot proceed. A valid voter_device_id parameter was not included.',
+        },
+        {
+            'code':         'VALID_VOTER_ID_MISSING',
+            'description':  'Cannot proceed. A valid voter_id was not found.',
+        },
+    ]
+
+    try_now_link_variables_dict = {
+        # 'organization_we_vote_id': 'wv85org1',
+    }
+
+    api_response = '{\n' \
+                   '  "status": string,\n' \
+                   '  "success": boolean,\n' \
+                   '  "description_of_send_status": string,\n' \
+                   '}'
+
+    template_values = {
+        'api_name': 'messageToFriendSend',
+        'api_slug': 'messageToFriendSend',
+        'api_introduction':
+            "Send a We Vote friend a message.",
+        'try_now_link': 'apis_v1:messageToFriendSendView',
+        'try_now_link_variables_dict': try_now_link_variables_dict,
+        'url_root': url_root,
+        'get_or_post': 'GET',
+        'required_query_parameter_list': required_query_parameter_list,
+        'optional_query_parameter_list': optional_query_parameter_list,
+        'api_response': api_response,
+        'api_response_notes':
+            "",
+        'potential_status_codes_list': potential_status_codes_list,
+    }
+    return template_values

apis_v1/urls.py

@@ -152,6 +152,7 @@
       re_path(r'^measureListForUpcomingElectionsRetrieve/',
               views_measure.measure_list_for_upcoming_elections_retrieve_api_view,
               name='measureListForUpcomingElectionsRetrieveView'),
+      re_path(r'^messageToFriendSend/', views_friend.message_to_friend_send_view, name='messageToFriendSendView'),
       re_path(r'^officeRetrieve/', views_misc.office_retrieve_view, name='officeRetrieveView'),
       re_path(r'^officesSyncOut/', offices_sync_out_view, name='officesSyncOutView'),
       re_path(r'^organizationAnalyticsByVoter/',
@@ -527,6 +528,8 @@
       re_path(r'^docs/measureListForUpcomingElectionsRetrieve/$',
               views_docs.measure_list_for_upcoming_elections_retrieve_doc_view,
               name='measureListForUpcomingElectionsRetrieveDocs'),
+      re_path(r'^docs/messageToFriendSend/$',
+              views_docs.message_to_friend_send_doc_view, name='messageToFriendSendDocs'),
       re_path(r'^docs/officeRetrieve/$', views_docs.office_retrieve_doc_view, name='officeRetrieveDocs'),
       re_path(r'^docs/officesSyncOut/$', views_docs.offices_sync_out_doc_view, name='officesSyncOutDocs'),
       re_path(r'^docs/organizationAnalyticsByVoter/$', views_docs.organization_analytics_by_voter_doc_view,

apis_v1/views/views_docs.py

@@ -25,7 +25,7 @@
     issues_followed_retrieve_doc, issues_retrieve_doc, issues_under_ballot_items_retrieve_doc, issues_sync_out_doc, \
     issues_linked_to_organization_doc, issues_to_link_to_for_organization_doc, \
     measure_retrieve_doc, measures_sync_out_doc, measure_list_for_upcoming_elections_retrieve_doc, \
-    office_retrieve_doc, offices_sync_out_doc, organization_analytics_by_voter_doc, \
+    message_to_friend_send_doc, office_retrieve_doc, offices_sync_out_doc, organization_analytics_by_voter_doc, \
     organization_count_doc, organization_daily_metrics_sync_out_doc, \
     organization_election_metrics_sync_out_doc, organizations_followed_retrieve_doc, \
     organization_follow_doc, organization_follow_ignore_doc, organization_index_doc, organizations_found_on_url_doc, \
@@ -78,13 +78,27 @@
     voter_update_doc, voter_verify_secret_code_doc, email_ballot_data_doc
 from config.base import get_environment_variable
 from django.contrib.messages import get_messages
+import importlib
 from django.shortcuts import render
 from voter.models import voter_setup
 from wevote_functions.functions import get_voter_api_device_id, set_voter_api_device_id, positive_value_exists
 
 WE_VOTE_SERVER_ROOT_URL = get_environment_variable("WE_VOTE_SERVER_ROOT_URL")
 
 
+# def api_doc_view(request, api_name=''):
+#     """
+#     TODO: I would like to figure this out so we don't have to have so many custom doc functions!
+#     """
+#     url_root = WE_VOTE_SERVER_ROOT_URL
+#     full_doc_file_name = "{api_name}_doc".format(api_name=api_name)
+#     doc_file = importlib.import_module(full_doc_file_name)
+#     from apis_v1.documentation_source import doc_file
+#     template_values = full_doc_file_name.doc_template_values(url_root)
+#     template_values['voter_api_device_id'] = get_voter_api_device_id(request)
+#     return render(request, 'apis_v1/api_doc_page.html', template_values)
+
+
 def activity_comment_save_doc_view(request):
     """
     Show documentation about activityCommentSave
@@ -650,6 +664,16 @@ def measure_list_for_upcoming_elections_retrieve_doc_view(request):
     return render(request, 'apis_v1/api_doc_page.html', template_values)
 
 
+def message_to_friend_send_doc_view(request):
+    """
+    Show documentation about messageToFriendSend
+    """
+    url_root = WE_VOTE_SERVER_ROOT_URL
+    template_values = message_to_friend_send_doc.doc_template_values(url_root)
+    template_values['voter_api_device_id'] = get_voter_api_device_id(request)
+    return render(request, 'apis_v1/api_doc_page.html', template_values)
+
+
 def office_retrieve_doc_view(request):
     """
     Show documentation about candidatesRetrieve

apis_v1/views/views_friend.py

@@ -6,16 +6,15 @@
 from friend.controllers import friend_invitation_by_email_send_for_api, friend_invitation_by_email_verify_for_api, \
     friend_invitation_by_we_vote_id_send_for_api, friend_invite_response_for_api, friend_list_for_api, \
     friend_lists_all_for_api, friend_invitation_by_facebook_send_for_api, \
-    friend_invitation_by_facebook_verify_for_api, friend_invitation_information_for_api
+    friend_invitation_by_facebook_verify_for_api, friend_invitation_information_for_api, message_to_friend_send_for_api
 from friend.models import ACCEPT_INVITATION, CURRENT_FRIENDS, DELETE_INVITATION_EMAIL_SENT_BY_ME, \
     DELETE_INVITATION_VOTER_SENT_BY_ME, \
     FRIENDS_IN_COMMON, FRIEND_INVITATIONS_PROCESSED, FRIEND_INVITATIONS_SENT_TO_ME, FRIEND_INVITATIONS_SENT_BY_ME, \
     FRIEND_INVITATIONS_WAITING_FOR_VERIFICATION, \
     IGNORED_FRIEND_INVITATIONS, IGNORE_INVITATION, IGNORE_SUGGESTION, \
     SUGGESTED_FRIEND_LIST, UNFRIEND_CURRENT_FRIEND
 import json
-import wevote_functions.admin
-from wevote_functions.functions import get_voter_device_id
+from wevote_functions.functions import get_voter_device_id, positive_value_exists, wevote_functions
 
 
 logger = wevote_functions.admin.get_logger(__name__)
@@ -249,3 +248,30 @@ def friend_lists_all_view(request):  # friendList
         'suggested_friends':                    results['suggested_friends'],
     }
     return HttpResponse(json.dumps(json_data), content_type='application/json')
+
+
+def message_to_friend_send_view(request):  # messageToFriendSend
+    """
+
+    :param request:
+    :return:
+    """
+    voter_device_id = get_voter_device_id(request)  # We standardize how we take in the voter_device_id
+    election_date_in_future_formatted = request.GET.get('election_date_in_future_formatted', "")
+    election_date_is_today = positive_value_exists(request.GET.get('election_date_is_today', False))
+    message_to_friend = request.GET.get('message_to_friend', "")
+    other_voter_we_vote_id = request.GET.get('other_voter_we_vote_id', "")
+    hostname = request.GET.get('hostname', "")
+    results = message_to_friend_send_for_api(
+        election_date_in_future_formatted=election_date_in_future_formatted,
+        election_date_is_today=election_date_is_today,
+        other_voter_we_vote_id=other_voter_we_vote_id,
+        message_to_friend=message_to_friend,
+        voter_device_id=voter_device_id,
+        web_app_root_url=hostname)
+    json_data = {
+        'status':                               results['status'],
+        'success':                              results['success'],
+        'voter_device_id':                      voter_device_id,
+    }
+    return HttpResponse(json.dumps(json_data), content_type='application/json')

email_outbound/functions.py

@@ -5,7 +5,7 @@
 from .models import CAMPAIGNX_FRIEND_HAS_SUPPORTED_TEMPLATE, CAMPAIGNX_NEWS_ITEM_TEMPLATE, \
     CAMPAIGNX_SUPER_SHARE_ITEM_TEMPLATE, CAMPAIGNX_SUPPORTER_INITIAL_RESPONSE_TEMPLATE, \
     FRIEND_ACCEPTED_INVITATION_TEMPLATE, FRIEND_INVITATION_TEMPLATE, LINK_TO_SIGN_IN_TEMPLATE, \
-    NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE, NOTICE_VOTER_DAILY_SUMMARY_TEMPLATE, \
+    MESSAGE_TO_FRIEND_TEMPLATE, NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE, NOTICE_VOTER_DAILY_SUMMARY_TEMPLATE, \
     SEND_BALLOT_TO_SELF, SEND_BALLOT_TO_FRIENDS, SIGN_IN_CODE_EMAIL_TEMPLATE, VERIFY_EMAIL_ADDRESS_TEMPLATE
 from django.template.loader import get_template
 from django.template import Context
@@ -53,6 +53,11 @@ def get_template_filename(kind_of_email_template, text_or_html):
             return "link_to_sign_in.html"
         else:
             return "link_to_sign_in.txt"
+    elif kind_of_email_template == MESSAGE_TO_FRIEND_TEMPLATE:
+        if text_or_html == "HTML":
+            return "message_to_friend.html"
+        else:
+            return "message_to_friend.txt"
     elif kind_of_email_template == NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE:
         if text_or_html == "HTML":
             return "notice_friend_endorsements.html"

email_outbound/models.py

@@ -18,6 +18,7 @@
 FRIEND_INVITATION_TEMPLATE = 'FRIEND_INVITATION_TEMPLATE'
 GENERIC_EMAIL_TEMPLATE = 'GENERIC_EMAIL_TEMPLATE'
 LINK_TO_SIGN_IN_TEMPLATE = 'LINK_TO_SIGN_IN_TEMPLATE'
+MESSAGE_TO_FRIEND_TEMPLATE = 'MESSAGE_TO_FRIEND_TEMPLATE'
 NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE = 'NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE'
 NOTICE_VOTER_DAILY_SUMMARY_TEMPLATE = 'NOTICE_VOTER_DAILY_SUMMARY_TEMPLATE'
 VERIFY_EMAIL_ADDRESS_TEMPLATE = 'VERIFY_EMAIL_ADDRESS_TEMPLATE'
@@ -29,6 +30,7 @@
     (FRIEND_ACCEPTED_INVITATION_TEMPLATE, 'Accept an invitation to be a Friend'),
     (FRIEND_INVITATION_TEMPLATE, 'Invite Friend'),
     (LINK_TO_SIGN_IN_TEMPLATE, 'Link to sign in.'),
+    (MESSAGE_TO_FRIEND_TEMPLATE, 'Message to friend'),
     (NOTICE_FRIEND_ENDORSEMENTS_TEMPLATE, 'New opinion from Friend.'),
     (NOTICE_VOTER_DAILY_SUMMARY_TEMPLATE, 'Daily summary of activity for the voter.'),
     (VERIFY_EMAIL_ADDRESS_TEMPLATE, 'Verify Senders Email Address'),