Creando su startup: Enviando recordatorios

Spanish (Español) translation by Elías Nicolás (you can also view the original English article)

Final product image — What You'll Be Creating

Este tutorial forma parte de la serie Creando su Startup con PHP en Envato Tuts +. En esta serie, te estoy guiando a través del lanzamiento de un inicio de concepto a realidad utilizando mi aplicación de Meeting Planner como un ejemplo de la vida real. Cada paso a lo largo del camino, voy a lanzar el código de Meeting Planner como ejemplo en código abierto del que puede aprender. También me ocuparé de asuntos relacionados de negocios con el startup a medida que surjan.

En este tutorial en dos partes, describo cómo construí la infraestructura para los recordatorios y su entrega. Hoy, voy a guiarlo a través de monitoreo cuando entregar recordatorios y cómo enviar los correos electrónicos.

Si aún no ha probado Meeting Planner, siga adelante y programe su primera reunión. Participo en los hilos del comentario abajo, así que ¡dígame lo que usted piensa! Me interesa especialmente si desea sugerir nuevas funciones o temas para futuros tutoriales.

Como recordatorio, todo el código para Meeting Planner está escrito en el Framework Yii2 para PHP. Si desea obtener más información acerca de Yii2, consulte nuestra serie paralela Programación con Yii2.

Tiempo de supervisión para recordatorios

A medida que pasa el tiempo, debemos vigilar la tabla MeetingReminder para saber cuándo entregar recordatorios. Idealmente, queremos que los recordatorios sean entregados exactamente a tiempo, ej. Al minuto.

Ejecución de tareas de fondo

La puntualidad depende de la periodicidad con que ejecutamos las tareas de fondo para el monitoreo. Actualmente, en nuestra etapa pre-alpha, los estoy ejecutando cada cinco minutos:

1	# m h dom mon dow command
2	/5 * * * wget -O /dev/null http://meetingplanner.io/daemon/frequent

Este script llama a MeetingReminder::check(), que encuentra los recordatorios de reunión que se deben y las solicitudes a process():

// frequent cron task will call to check on due reminders
public static function check() {
  $mrs = MeetingReminder::find()->where('due_at<='.time().' and status='.MeetingReminder::STATUS_PENDING)->all();
  foreach ($mrs as $mr) {
    // process each meeting reminder
    MeetingReminder::process($mr);
  }
}

Procesamiento de un recordatorio

MeetingReminder::process() reúne los detalles necesarios para crear un correo electrónico de recordatorio. Esto incluye el destinatario del recordatorio, los detalles de la reunión y la hora:

public static function process($mr) {
      // fetch the reminder
      // deliver the email or sms
      // send updates about recent meeting changes made by $user_id
      $user_id = $mr->user_id;
      $meeting_id = $mr->meeting_id;
      $mtg = Meeting::findOne($meeting_id);
      // only send reminders for meetings that are confirmed
      if ($mtg->status!=Meeting::STATUS_CONFIRMED) return false;
      // only send reminders that are less than a day late - to do - remove after testing period
      if ((time()-$mr->due_at)>(24*3600+1)) return false;
      $u = \common\models\User::findOne($user_id);
      // ensure there is an auth key for the recipient user
      if (empty($u->auth_key)) {
        return false;
      }
      // prepare data for the message
      // get time
      $chosen_time = Meeting::getChosenTime($meeting_id);
      $timezone = MiscHelpers::fetchUserTimezone($user_id);
      $display_time = Meeting::friendlyDateFromTimestamp($chosen_time->start,$timezone);
      // get place
      $chosen_place = Meeting::getChosenPlace($meeting_id);

      $a=['user_id'=>$user_id,
       'auth_key'=>$u->auth_key,
       'email'=>$u->email,
       'username'=>$u->username
     ];
       // check if email is okay and okay from this sender_id
      if (User::checkEmailDelivery($user_id,0)) {
          // Build the absolute links to the meeting and commands
          $links=[
            'home'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_HOME,0,$a['user_id'],$a['auth_key']),
            'view'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_VIEW,0,$a['user_id'],$a['auth_key']),
            'footer_email'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_EMAIL,0,$a['user_id'],$a['auth_key']),
            'footer_block'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_BLOCK,0,$a['user_id'],$a['auth_key']),
            'footer_block_all'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_BLOCK_ALL,0,$a['user_id'],$a['auth_key']),
            'running_late'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_RUNNING_LATE,0,$a['user_id'],$a['auth_key']),
            'view_map'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_VIEW_MAP,0,$a['user_id'],$a['auth_key'])
          ];
          // send the message
          $message = Yii::$app->mailer->compose([
            'html' => 'reminder-html',
            'text' => 'reminder-text'
          ],
          [
            'meeting_id' => $mtg->id,
            'sender_id'=> $user_id,
            'user_id' => $a['user_id'],
            'auth_key' => $a['auth_key'],
            'display_time' => $display_time,
            'chosen_place' => $chosen_place,
            'links' => $links,
            'meetingSettings' => $mtg->meetingSettings,
        ]);
          if (!empty($a['email'])) {
            $message->setFrom(['support@meetingplanner.com'=>'Meeting Planner']);
            $message->setTo($a['email'])
                ->setSubject(Yii::t('frontend','Meeting Reminder: ').$mtg->subject)
                ->send();
          }
       }
      $mr->status=MeetingReminder::STATUS_COMPLETE;
      $mr->update();
    }

La función User::checkEmailDelivery() verifica que el usuario no ha bloqueado los correos electrónicos del sistema (o de personas en particular). Se asegura de que está bien enviar el recordatorio:

// check if email is okay and okay from this sender_id
      if (User::checkEmailDelivery($user_id,0)) {
          // Build the absolute links to the meeting and commands
          $links=[
            'home'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_HOME,0,$a['user_id'],$a['auth_key']),
            'view'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_VIEW,0,$a['user_id'],$a['auth_key']),
            'footer_email'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_EMAIL,0,$a['user_id'],$a['auth_key']),
            'footer_block'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_BLOCK,0,$a['user_id'],$a['auth_key']),
            'footer_block_all'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_FOOTER_BLOCK_ALL,0,$a['user_id'],$a['auth_key']),
            'running_late'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_RUNNING_LATE,0,$a['user_id'],$a['auth_key']),
            'view_map'=>MiscHelpers::buildCommand($mtg->id,Meeting::COMMAND_VIEW_MAP,0,$a['user_id'],$a['auth_key'])
          ];
      

Aquí tiene el método User::checkEmailDelivery. En primer lugar, comprueba si el usuario ha bloqueado completamente el correo electrónico (o no) o si el mensaje se envía desde un usuario bloqueado:

    public static function checkEmailDelivery($user_id,$sender_id) {
      // check if this user_id receives email and if sender_id not blocked
      // check if all email is turned off
      $us = UserSetting::safeGet($user_id);
      if ($us->no_email != UserSetting::EMAIL_OK) {
        return false;
      }
      // check if no sender i.e. system notification
      if ($sender_id==0) {
        return true;
      }
      // check if sender is blocked
      $ub = UserBlock::find()->where(['user_id'=>$user_id,'blocked_user_id'=>$sender_id])->one();
      if (!is_null($ub)) {
        return false;
      }
      return true;
    }

La nueva plantilla de correo electrónico de recordatorio

En el episodio Entregando tu invitación de la reunión, escribí sobre el envío de mensajes de correo electrónico dentro del marco Yii. En refinando plantillas de correo electronico, describí la actualización de las plantillas para nuestras nuevas plantillas de respuesta basadas en oxígeno.

Aquí está la nueva plantilla de correo electrónico reminder_html.php:

<?php
use yii\helpers\Html;
use yii\helpers\Url;
use common\components\MiscHelpers;
use frontend\models\Meeting;
use frontend\models\UserContact;
/* @var $this \yii\web\View view component instance */
/* @var $message \yii\mail\BaseMessage instance of newly created mail message */
?>
<tr>
  <td align="center" valign="top" width="100%" style="background-color: #f7f7f7;" class="content-padding">
    <center>
      <table cellspacing="0" cellpadding="0" width="600" class="w320">
        <tr>
          <td class="header-lg">
            Reminder of Your Meeting
          </td>
        </tr>
        <tr>
          <td class="free-text">
            Just a reminder about your upcoming meeting <?php echo $display_time; ?>
            <?php
            // this code is similar to code in finalize-html
            if ($chosen_place!==false) {
            ?>
            &nbsp;at <?php echo $chosen_place->place->name; ?>&nbsp;
              (<?php echo $chosen_place->place->vicinity; ?>, <?php echo HTML::a(Yii::t('frontend','map'),$links['view_map']); ?>)
              <?php
            } else {
            ?>
            &nbsp;via phone or video conference.
            <?php
              }
            ?>
            <br />
            Click below to view more details to view the meeting page.
          </td>
        </tr>
      <tr>
        <td class="button">
          <div><!--[if mso]>
            <v:roundrect xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w="urn:schemas-microsoft-com:office:word" href="http://" style="height:45px;v-text-anchor:middle;width:155px;" arcsize="15%" strokecolor="#ffffff" fillcolor="#ff6f6f">
              <w:anchorlock/>
              <center style="color:#ffffff;font-family:Helvetica, Arial, sans-serif;font-size:14px;font-weight:regular;">My Account</center>
            </v:roundrect>
          <![endif]--><a class="button-mobile" href="<?php echo $links['view'] ?>"
          style="background-color:#ff6f6f;border-radius:5px;color:#ffffff;display:inline-block;font-family:'Cabin', Helvetica, Arial, sans-serif;font-size:14px;font-weight:regular;line-height:45px;text-align:center;text-decoration:none;width:155px;-webkit-text-size-adjust:none;mso-hide:all;">Visit Meeting Page</a></div>
        </td>
      </tr>
      <tr>
        <td class="mini-large-block-container">
          <table cellspacing="0" cellpadding="0" width="100%"  style="border-collapse:separate !important;">
            <tr>
              <td class="mini-large-block">
                <table cellpadding="0" cellspacing="0" width="100%">
                  <tr>
                    <td style="text-align:left; padding-bottom: 30px;">
                      <strong>Helpful options:</strong>
                      <p>
                        <?php
                          echo HTML::a(Yii::t('frontend','Inform them I\'m running late.'),$links['running_late']);
                        ?>
                      </p>
                    </td>
                  </tr>
                </table>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </center>
  </td>
</tr>
<?php echo \Yii::$app->view->renderFile('@common/mail/section-footer-dynamic.php',['links'=>$links]) ?>

Incluye la fecha, la hora y la ubicación elegida (con una dirección y un enlace de mapa). También he agregado los principios de un área de opciones útil con un comando inicial, "Informales que estoy llegando tarde":

Meeting Planner - Reminder of Your Meeting Email

Al hacer clic en él, enviaremos por correo electrónico o SMS a los otros participantes que podrían tardar entre cinco y diez minutos. No hay nada más que hacer o escribir mientras tiene prisa.

Tal vez una eventual versión móvil de Meeting Planner conocerá su ubicación GPS y hacerles saber aproximadamente cuán lejos está usted. He empezado a seguir ideas como esta en Asana para la planificación de productos—preguntaré a las diosas editoriales de Envato Tuts+ (mostradas a continuación) si puedo escribir sobre la implementación de seguimiento de características y emisiones en un futuro tutorial.

Meeting Planner Reminders - Game of Thrones Daenerys Targaryen and Dragon our editorial goddess

Mejoras en los recordatorios

El correo electrónico de recordatorio puede utilizar algunas funciones mejoradas:

Completar la implementación de correo electrónico que se ejecuta tarde.
Visualización de la información de contacto de otros participantes, como números de teléfono y direcciones de correo electrónico. El correo electrónico que se ejecuta tarde puede mostrar sólo la información de contacto de la persona que llega tarde.
Muestra un mapa de Google estático que muestra la ubicación de la reunión.
Enlace a una función para solicitar o requerir una reprogramación de la reunión.
Enlace a no sólo el mapa, sino las direcciones de la ubicación.
Enlace para ajustar los recordatorios.

Resulta que la mayoría de estas características requieren más trabajo del que hay espacio para este tutorial.

Por ejemplo, la idea de enviar un correo electrónico de ejecución tarde parece una característica simple, ¿verdad? Es un buen ejemplo del reto que los frameworks MVC a veces imponen a los desarrolladores. La implementación de una función de correo electrónico de última ejecución requería código a través de varios archivos, incluida una nueva plantilla de correo electrónico.

Implementación de la función de ejecución tardía

Meeting Planner Reminders - Late Notice Email

En lugar de compartir todos los cambios de código necesarios para esta función, resumiré los lugares en los que era necesario cambiar el entorno:

El correo electrónico de recordatorio necesitaba un enlace con un nuevo comando
El COMMAND_RUNNING_LATE tenía que ser definido en el modelo y controlador de la reunión, y tenía que mostrar un mensaje de confirmación.

He aquí un ejemplo de lo que ves después de pedir que se envíe un aviso tardío:

Meeting Planner Reminders - Late Notice Confirmation

El método sendLateNotice() tuvo que ser construido en Meeting.php
La plantilla de correo electrónico de late-html.php tenían que ser construida. Esto incluye una opción para que el otro participante anuncie que están "tarde también".
El método UserContact::buildContactString() tuvo que completarse para incluir información de contacto para la persona que se está ejecutando tarde.
El ACTION_SENT_RUNNING_LATE tuvo que ser creado para registrar el envío de un aviso tardío en nombre de esta persona en el MeetingLog.
El método sendLateNotice() tuvo que comprobar el registro y mostrar un error si el aviso tardío ya se había enviado una vez.

Esto es lo que muestra el aviso tardío enviado:

Meeting Planner Reminders - Error message - Late Notice Already Sent

Era un montón de código para implementar lo que parecía una simple adición.

Esperé a probar la función hasta que todos los cambios anteriores se habían hecho, y me sorprendió gratamente que todos trabajaron exactamente como se pretende. Sólo tuve que hacer algunos cambios cosméticos en el texto.

Implementación de la información de contacto del participante

Si bien esta función ya existía para los archivos iCal, necesitaba completar esta función para las invitaciones de reunión basadas en correo electrónico. Así que extendí UserContact::buildContactString($user_id,$mode) para $mode = 'html'.

Aquí está el código actualizado:

public static function buildContactString($user_id,$mode='ical') {
    // to do - create a view for this that can be rendered
    $contacts = UserContact::getUserContactList($user_id);
    if (count($contacts)==0) return '';
    if ($mode=='ical') {
        $str='';
    } else if ($mode =='html') {
        $str='<p>';
    }
    $str = \common\components\MiscHelpers::getDisplayName($user_id).': ';
    if ($mode=='ical') {
        $str.=' \\n';
    } else if ($mode =='html') {
        $str.='<br />';
    }
    foreach ($contacts as $c) {
      if ($mode=='ical') {
        $str.=$c->friendly_type.': '.$c->info.' ('.$c->details.')\\n';
      } else if ($mode =='html') {
        $str.=$c->friendly_type.': '.$c->info.'<br />'.$c->details.'<br />';
      }
    }
    if ($mode=='ical') {
        $str.=' \\n';
    } else if ($mode =='html') {
        $str.='</p>';
    }
    return $str;
  }
}

Estoy seguro de que necesitará un poco de pulido a medida que avanzamos en las pruebas alfa y beta, pero la funcionalidad ya está ahí.

Puede ver los detalles de contacto mostrados en el aviso completo anterior, pero aquí está el segmento que genera:

Meeting Planner Reminder - Contact Details

Pulido de Recordatorios

Las cosas fueron tan bien en general con estas últimas mini-características que he añadido el enlace para ajustar sus recordatorios para el correo electrónico de recordatorio original también.

Con todo este nuevo código, estoy seguro de que estaré puliendo la función de recordatorios y mejorándola regularmente durante las próximas semanas. Sin embargo, como planificador de reuniones se ha unido, más funcionalidad es a menudo posible—a menudo con poco trabajo porque hay un framework y una base. El modelo de datos limpios y el framework MVC hacen regularmente mejoras incrementales relativamente sencillas.

Todo esto es lo que hace que la construcción de un startup tanto divertido y desafiante. Y trabajando con dragones (algunos días no puedo creer que me pagan para hacer esto).

¿Que sigue?

Meeting Planner ha hecho un tremendo progreso en los últimos meses. Estoy empezando a experimentar con WeFunder basado en la implementación de las nuevas reglas de crowdfunding de la SEC. Por favor considere seguir nuestro perfil. Espero escribir sobre esto más en un futuro tutorial.

Y, sin duda, la aplicación todavía tiene un montón de deficiencias—por favor asegúrese de publicar sus comentarios en los comentarios o abrir un ticket de soporte.

Espero que hayas disfrutado este episodio. Vea los próximos tutoriales en nuestra serie Creando su Startup Con PHP, todavía hay trabajo polaco por delante, pero también funciones más grandes.

Por favor, siéntase libre de añadir sus preguntas y comentarios a continuación; Generalmente participo en las discusiones. También puede contactarme directamente en Twitter @reifman.