Fix API for customer. Correct store creation.

Author: taz77

.travis.yml

@@ -48,7 +48,7 @@ install:
 - drupal-ti install
 before_script:
 - drupal-ti before_script
-- drupal-ti --include before.sh
+- drupal-ti --include tests/mailchimp-ecommerce-before.sh
 script:
 - drupal-ti script
 after_script:

README.txt

@@ -9,7 +9,7 @@ For more information about eCommerce 360, please see:
 http://kb.mailchimp.com/integrations/other-integrations/about-ecommerce360
 
 ## Dependencies
-  * MailChimp: http://drupal.org/project/mailchimp
+  * MailChimp: https://www.drupal.org/project/mailchimp
   * Commerce: https://www.drupal.org/project/commerce
 
 ## Installation Notes

includes/mailchimp_ecommerce.admin.inc

@@ -9,69 +9,93 @@
  * The MailChimp eCommerce settings form.
  */
 function mailchimp_ecommerce_admin_settings() {
-  $form['mailchimp_ecommerce_integration'] = array(
-    '#type' => 'radios',
-    '#title' => 'Enabled Integration',
-    '#options' => array(
-      '' => t('None'),
-    ),
-    '#default_value' => variable_get('mailchimp_ecommerce_integration', ''),
-  );
-  $form['mailchimp_ecommerce_notice'] = array(
+  $form['mailchimp_ecommerce_notice'] = [
     '#markup' => t('This page will allow you to create a store. Once created, you cannot change the list associated with the store.'),
-  );
-  $form['mailchimp_ecommerce_store_name'] = array(
+  ];
+  $form['mailchimp_ecommerce_store_name'] = [
     '#type' => 'textfield',
     '#title' => t('Store Name'),
     '#required' => TRUE,
     '#default_value' => variable_get('mailchimp_ecommerce_store_name', ''),
     '#description' => t('The name of your store as it should appear in your MailChimp account.'),
-  );
+  ];
 
   $mailchimp_lists = mailchimp_get_lists();
-  $list_options = array(
+  $list_options = [
     '' => '-- Select --',
-  );
+  ];
 
   foreach ($mailchimp_lists as $list_id => $list) {
     $list_options[$list_id] = $list->name;
   }
 
   if (!empty(variable_get('mailchimp_ecommerce_list_id', ''))) {
     $existing_store_id = variable_get('mailchimp_ecommerce_list_id');
-    $form['mailchimp_ecommerce_list_id_existing'] = array(
+    $form['mailchimp_ecommerce_list_id_existing'] = [
       '#markup' => t('Once created, the list cannot be changed for a given store. This store is connected to the list named') . ' ' . $list_options[$existing_store_id],
-    );
+    ];
   }
   else {
-    $form['mailchimp_ecommerce_list_id'] = array(
+    $form['mailchimp_ecommerce_list_id'] = [
       '#type' => 'select',
       '#title' => t('Store List'),
       '#required' => TRUE,
       '#options' => $list_options,
       '#default_value' => variable_get('mailchimp_ecommerce_list_id', ''),
-    );
+    ];
   }
 
-  // TODO: Can this be moved into the mailchimp_ecommerce_commerce module?
   if (module_exists('commerce')) {
-    $form['mailchimp_ecommere_commerce_default_currency'] = array(
+    $form['mailchimp_ecommere_commerce_default_currency'] = [
       '#type' => 'checkbox',
       '#title' => t('Use Commerce Default Currency'),
       '#description' => t('Drupal Commerce was detected as being installed. Check this box to use the default currency of Commerce'),
       '#default_value' => variable_get('mailchimp_ecommere_commerce_default_currency', ''),
-    );
+    ];
   }
 
   // @TODO Make this item go away with AJAX if the Drupal commerce box is checked.
-  $list_options_currency = array(
-    '' => '-- Select --',
-  ) + mailchimp_ecommerce_get_currency_codes();
-  $form['mailchimp_ecommerce_currency'] = array(
+  $list_options_currency = [
+      '' => '-- Select --',
+    ] + mailchimp_ecommerce_get_currency_codes();
+  $form['mailchimp_ecommerce_currency'] = [
     '#type' => 'select',
     '#options' => $list_options_currency,
     '#title' => t('Store Currency Code'),
-  );
+    '#description' => t('This is overridden if you have selected to use the default currency from Commerce.'),
+  ];
+
+  $list_options = [
+    '' => '-- Select --',
+    'TRUE' => 'Normal Subscriber',
+    'FALSE' => 'Transactional Subscriber',
+  ];
+
+  $form['mailchimp_ecommerce_opt_in'] = [
+    '#type' => 'fieldset',
+    '#title' => t('New User Opt-In Status'),
+    '#collapsible' => FALSE,
+  ];
+  $form['mailchimp_ecommerce_opt_in']['mailchimp_ecommerce_opt_in_status_markup'] = [
+    '#markup' => t('You must decide on the status of customers that entered into
+     the eCommerce API. By choosing "<b>Normal Subscriber</b>" in the option
+     below, users will added as normal subscribers.  If you choose
+     "Normal Subscriber", be certain your customers know they are subscribing
+     to an email list. If you choose "<b>Transactional Subscriber</b>" below,
+     the users will be added as "transactional" users. Transactional users
+     cannot be changed via the MailChimp UI. Changing the status of a 
+     "transactional" user call only be accomplished via the API. For additional
+     information, please read the') . ' ' . l('MailChimp Documentation.', 'http://developer.mailchimp.com/documentation/mailchimp/guides/getting-started-with-ecommerce/#about-subscribers-and-customers', ['external' => TRUE]),
+  ];
+
+  $form['mailchimp_ecommerce_opt_in']['mailchimp_ecommerce_opt_in_status'] = [
+    '#type' => 'select',
+    '#title' => t('Opt-In Status For Customers'),
+    '#required' => TRUE,
+    '#options' => $list_options,
+    '#default_value' => variable_get('mailchimp_ecommerce_opt_in_status', ''),
+    '#description' => t('Choose your opt-in status before using this module.'),
+  ];
 
   $settings_form = system_settings_form($form);
   $settings_form['#submit'][] = 'mailchimp_ecommerce_admin_settings_submit';
@@ -84,9 +108,11 @@ function mailchimp_ecommerce_admin_settings() {
  */
 function mailchimp_ecommerce_admin_settings_submit($form, &$form_state) {
   $store_id = variable_get('mailchimp_ecommerce_store_id', NULL);
+  if (variable_get('mailchimp_ecommerce_store_id', NULL) == NULL) {
+    $store_id = mailchimp_ecommerce_generate_store_id();
+    variable_set('mailchimp_ecommerce_store_id', $store_id);
+  }
 
-  // Add / update store only if an eCommerce integration is selected.
-  if (!empty($form_state['values']['mailchimp_ecommerce_integration'])) {
     if ($store_id != NULL) {
       // Detect if Commerce is installed and use the default currency.
       if (!empty($form_state['values']['mailchimp_ecommere_commerce_default_currency'])) {
@@ -114,8 +140,5 @@ function mailchimp_ecommerce_admin_settings_submit($form, &$form_state) {
           $currency);
       }
     }
-  }
-  else {
-    variable_del('mailchimp_ecommerce_integration');
-  }
+
 }

mailchimp_ecommerce.install

@@ -10,6 +10,6 @@
  */
 function mailchimp_ecommerce_uninstall() {
   variable_del('mailchimp_ecommerce_store_name');
-  variable_del('mailchimp_ecommerce_integration');
   variable_del('mailchimp_ecommerce_list_id');
+  variable_del('mailchimp_ecommerce_opt_in_status');
 }

modules/mailchimp_ecommerce_commerce/mailchimp_ecommerce_commerce.install

@@ -11,3 +11,10 @@
 function mailchimp_ecommerce_commerce_uninstall() {
   variable_del('mailchimp_ecommerce_store_id');
 }
+
+/**
+ * Delete unused variable
+ */
+function mailchimp_ecommerce_commerce_update_7001() {
+  variable_del('mailchimp_ecommerce_integration');
+}

modules/mailchimp_ecommerce_commerce/mailchimp_ecommerce_commerce.module

@@ -5,26 +5,6 @@
  * Integrates Drupal Commerce with MailChimp eCommerce.
  */
 
-/**
- * Implements hook_form_FORM_ID_alter().
- */
-function mailchimp_ecommerce_commerce_form_mailchimp_ecommerce_admin_settings_alter(&$form, &$form_state) {
-  $form['mailchimp_ecommerce_integration']['#options']['commerce'] = t('Drupal Commerce');
-
-  // Add submit handler as first element in submit array.
-  array_unshift($form['#submit'], 'mailchimp_ecommerce_commerce_integration_admin_settings_submit');
-}
-
-/**
- * Submit handler for the MailChimp eCommerce settings form.
- */
-function mailchimp_ecommerce_commerce_integration_admin_settings_submit($form, &$form_state) {
-  if (variable_get('mailchimp_ecommerce_store_id', NULL) == NULL) {
-    $store_id = mailchimp_ecommerce_generate_store_id();
-    variable_set('mailchimp_ecommerce_store_id', $store_id);
-  }
-}
-
 /**
  * Implements hook_commerce_customer_profile_insert().
  */
@@ -215,21 +195,21 @@ function mailchimp_ecommerce_commerce_batch_add_product($product_id, &$context)
  * Implements hook_default_rules_configuration().
  */
 function mailchimp_ecommerce_commerce_default_rules_configuration() {
-  $rules = array();
+  $rules = [];
 
   // Add a reaction rule to display the default Add to Cart message.
   $rule = rules_reaction_rule();
 
   $rule->label = t('Send cart to MailChimp');
-  $rule->tags = array('Commerce Cart');
+  $rule->tags = ['Commerce Cart'];
   $rule->active = TRUE;
 
   $rule
     ->event('commerce_cart_product_add')
     ->event('commerce_cart_product_remove')
-    ->action('mailchimp_ecommerce_commerce_send_cart', array(
+    ->action('mailchimp_ecommerce_commerce_send_cart', [
       'commerce_order:select' => 'commerce-order',
-    ));
+    ]);
 
   $rules['mailchimp_ecommerce_commerce_send_cart'] = $rule;
 
@@ -240,21 +220,21 @@ function mailchimp_ecommerce_commerce_default_rules_configuration() {
  * Implements hook_rules_action_info().
  */
 function mailchimp_ecommerce_commerce_rules_action_info() {
-  $actions = array();
+  $actions = [];
 
-  $actions['mailchimp_ecommerce_commerce_send_cart'] = array(
+  $actions['mailchimp_ecommerce_commerce_send_cart'] = [
     'label' => t('Send a cart to MailChimp'),
-    'parameter' => array(
-      'commerce_order' => array(
+    'parameter' => [
+      'commerce_order' => [
         'type' => 'commerce_order',
         'label' => t('Order to send'),
-      ),
-    ),
+      ],
+    ],
     'group' => t('Commerce Order'),
-    'callbacks' => array(
+    'callbacks' => [
       'execute' => '_mailchimp_ecommerce_commerce_send_cart',
-    ),
-  );
+    ],
+  ];
 
   return $actions;
 }
@@ -319,19 +299,21 @@ function mailchimp_ecommerce_commerce_parse_customer_profile_address($customer_p
  *
  * @return object
  *   Order object in a MailChimp-friendly format.
+ *
+ * @throws Exception
+ *   Throws an exception if Opt In Status is not set.
  */
 function _mailchimp_ecommerce_commerce_build_order($order_wrapper) {
   $user = user_load($order_wrapper->uid->raw());
-  $currency_code = '';
-  $order_total = '';
+  $customer = [];
   $billing_address = [];
   $lines = [];
 
   if (isset($order_wrapper->commerce_order_total->currency_code)) {
     $currency_code = $order_wrapper->commerce_order_total->currency_code->value();
   }
   if (isset($order_wrapper->commerce_order_total->amount)) {
-    $order_total =  commerce_currency_amount_to_decimal($order_wrapper->commerce_order_total->amount->value(), $currency_code);
+    $order_total = commerce_currency_amount_to_decimal($order_wrapper->commerce_order_total->amount->value(), $currency_code);
   }
   if (isset($order_wrapper->commerce_customer_billing->commerce_customer_address)) {
     $commerce_billing_address = $order_wrapper->commerce_customer_billing->commerce_customer_address->value();
@@ -359,16 +341,25 @@ function _mailchimp_ecommerce_commerce_build_order($order_wrapper) {
         'product_id' => $line_item_wrapper->commerce_product->raw(),
         'product_variant_id' => $line_item_wrapper->commerce_product->sku->value(),
         'quantity' => (int) $line_item_wrapper->quantity->value(),
-        'price' =>  commerce_currency_amount_to_decimal($line_item_wrapper->commerce_unit_price->amount->value(), $line_item_wrapper->commerce_unit_price->currency_code->value()),
+        'price' => commerce_currency_amount_to_decimal($line_item_wrapper->commerce_unit_price->amount->value(), $line_item_wrapper->commerce_unit_price->currency_code->value()),
       ];
       $lines[] = $line;
     }
   }
-
+  // Pull optin status
+  $optinstatus = variable_get('mailchimp_ecommerce_opt_in_status', NULL);
+  if (is_null($optinstatus) || empty($optinstatus)) {
+    watchdog('mailchimp_ecommerce', t('Optin Status has not been set. See admin/config/services/mailchimp/ecommerce.'), [], WATCHDOG_ERROR);
+    throw new Exception('Optin Status is not set in the MailChimp Ecommerce Module');
+  }
+  // Customer parameters used in the 'customer' portions of the API wrapper.
   $customer = [
     'id' => $user->uid,
+    'email_address' => $user->mail,
+    'opt_in_status' => $optinstatus,
   ];
 
+  // Order paramaters that are used as the 'cart' portions of the API wrapper.
   $order_data = [
     'currency_code' => $currency_code,
     'order_total' => $order_total,