Merge pull request #6495 from DFurnes/at-email-sync

Fix syncing `@email` users.

Author: DFurnes

lib/modules/dosomething/dosomething_northstar/dosomething_northstar.module

@@ -158,7 +158,7 @@ function dosomething_northstar_update_user($user, $payload) {
 
   // Add to request log if enabled.
   dosomething_northstar_log_request('update_user', $user, $payload, $response);
-  
+
   if ($response->code === '200' && module_exists('stathat')) {
     stathat_send_ez_count('drupal - Northstar - user updated - count', 1);
   }
@@ -205,12 +205,12 @@ function dosomething_northstar_get_northstar_user($drupal_id) {
 }
 
 /**
- * Build a user JSON object in the format that Northstar expects.
+ * Transform Drupal user fields into the appropriate schema for Northstar.
  *
  * @param $user - Drupal user object
  * @return array
  */
-function dosomething_northstar_build_ns_user($user, $form_state) {
+function dosomething_northstar_transform_user($user) {
   // Optional fields
   $optional = [
     'mobile' => 'field_mobile',
@@ -229,42 +229,61 @@ function dosomething_northstar_build_ns_user($user, $form_state) {
     'addr_zip' => 'postal_code',
   ];
 
-  $ns_user = [
+  $northstar_user = [
     'email'         => $user->mail,
     'drupal_id'     => $user->uid,
     'language'      => $user->language,
   ];
 
   // Set values in ns_user if they are set.
   foreach ($optional as $ns_key => $drupal_key) {
-   $field = $user->$drupal_key;
+    $field = $user->$drupal_key;
     if (isset($field[LANGUAGE_NONE][0]['value'])) {
-      $ns_user[$ns_key] = $field[LANGUAGE_NONE][0]['value'];
+      $northstar_user[$ns_key] = $field[LANGUAGE_NONE][0]['value'];
     }
   }
   foreach ($address as $ns_key => $drupal_key) {
     $field = $user->field_address[LANGUAGE_NONE][0];
 
     if ($drupal_key == 'country') {
-      $ns_user[$ns_key] = $field[$drupal_key];
+      $northstar_user[$ns_key] = $field[$drupal_key];
     } else if (isset($field[$drupal_key]['value'])) {
-      $ns_user[$ns_key] = $field[$drupal_key]['value'];
+      $northstar_user[$ns_key] = $field[$drupal_key]['value'];
     }
   }
 
-  // Don't send blank passwords from the user update screen.
-  if (!empty($form_state['values']['pass'])) {
-    $ns_user['password'] = $form_state['values']['pass'];
+  // If user has a "1234565555@mobile" placeholder email, don't send
+  // that to Northstar (since it will cause a validation error and Northstar
+  // doesn't require every account to have an email like Drupal does).
+  if(preg_match('/^[0-9]+@mobile$/', $northstar_user['email'])) {
+    unset($northstar_user['email']);
   }
 
   // Set the "source" for this user to Phoenix if they weren't
   // programmatically created through the API.
-  if(empty($ns_user['source'])) {
-    $ns_user['source'] = 'phoenix';
+  if(empty($northstar_user['source'])) {
+    $northstar_user['source'] = 'phoenix';
+  }
+
+  return $northstar_user;
+}
+
+/**
+ * Build a Northstar user from a Drupal form submission.
+ *
+ * @param $user - Drupal user object
+ * @param $form_state - Form fields from registration/profile form.
+ * @return array
+ */
+function dosomething_northstar_build_ns_user($user, $form_state) {
+  $northstar_user = dosomething_northstar_transform_user($user);
+
+  // Don't send blank passwords from the user update screen.
+  if (!empty($form_state['values']['pass'])) {
+    $northstar_user['password'] = $form_state['values']['pass'];
   }
 
-  // Return fully built northstar user object.
-  return $ns_user;
+  return $northstar_user;
 }
 
 /**

scripts/export-users-to-northstar.php

@@ -55,60 +55,13 @@
  * Build a Northstar request from the $user global variable.
  */
 function build_northstar_user($user) {
-  // Optional fields
-  $optional = [
-    'mobile'       => 'field_mobile',
-    'birthdate'    => 'field_birthdate',
-    'first_name'   => 'field_first_name',
-    'last_name'    => 'field_last_name',
-    'source'       => 'field_user_registration_source',
-    'school_id'    => 'field_school_id',
-  ];
+  $northstar_user = dosomething_northstar_transform_user($user);
 
-  // Address fields
-  $address = [
-    'country'        => 'country',
-    'addr_street1'   => 'thoroughfare',
-    'addr_street2'   => 'premise',
-    'addr_city'      => 'locality',
-    'addr_state'     => 'administrative_area',
-    'addr_zip'       => 'postal_code',
-  ];
+  // Since we're sending an existing user, we'll also attach their hashed password
+  // (which Northstar can understand thanks to it's DrupalPasswordHash class), and
+  // the created_at timestamp on the original account.
+  $northstar_user['drupal_password'] = $user->pass;
+  $northstar_user['created_at'] = $user->created;
 
-  $ns_user = [
-    'email'            => $user->mail,
-    'drupal_id'        => $user->uid,
-    'drupal_password'  => $user->pass,
-    'created_at'       => $user->created,
-  ];
-
-  // Set values in ns_user if they are set.
-  foreach ($optional as $ns_key => $drupal_key) {
-   $field = $user->$drupal_key;
-    if (!empty($field[LANGUAGE_NONE][0]['value'])) {
-      $ns_user[$ns_key] = $field[LANGUAGE_NONE][0]['value'];
-    }
-  }
-  // Set address values.
-  foreach ($address as $ns_key => $drupal_key) {
-    $field = $user->field_address[LANGUAGE_NONE][0];
-    if (!empty($field[$drupal_key]['value'])) {
-      $ns_user[$ns_key] = $field[$drupal_key]['value'];
-    }
-  }
-
-  // If user has a "1234565555@mobile" placeholder username, don't send
-  // that to Northstar (since it will cause a validation error and Northstar
-  // doesn't require every account to have an email like Drupal does).
-  if(preg_match('/^[0-9]+@mobile$/', $ns_user['email'])) {
-    unset($ns_user['email']);
-  }
-
-  // Set the "source" for this user to Phoenix if they weren't
-  // programmatically created through the API.
-  if(empty($ns_user['source'])) {
-    $ns_user['source'] = 'phoenix';
-  }
-
-  return $ns_user;
+  return $northstar_user;
 }