You are here

Home » API reference » Mandrill 8 » MandrillTestAPI.php

class MandrillTestAPI in Mandrill 8

Overrides functions in the Mandrill API service for testing.

Hierarchy

Expanded class hierarchy of MandrillTestAPI

1 string reference to 'MandrillTestAPI'
mandrill.services.yml in ./mandrill.services.yml
mandrill.services.yml
1 service uses MandrillTestAPI
mandrill.test.api in ./mandrill.services.yml
Drupal\mandrill\MandrillTestAPI

File

src/MandrillTestAPI.php, line 8

Namespace

Drupal\mandrill
View source 
class MandrillTestAPI extends MandrillAPI {

  /**
   * {@inheritdoc}
   */
  public function getMessages($email) {
    $matched_messages = array();
    $query_key = 'email';
    $query_value = $email;
    $messages = $this
      ->getTestMessagesData();
    foreach ($messages as $message) {
      if (isset($message[$query_key]) && $message[$query_key] == $query_value) {
        $matched_messages[] = $message;
      }
    }
    return $matched_messages;
  }

  /**
   * {@inheritdoc}
   */
  public function getTemplates() {
    return $this
      ->getTestTemplatesData();
  }

  /**
   * {@inheritdoc}
   */
  public function getSubAccounts() {
    $subaccounts = array();

    // Test Customer One
    $subaccount = array(
      'id' => 'test-customer-1',
      'name' => 'Test Customer One',
      'custom_quota' => 42,
      'status' => 'active',
      'reputation' => 42,
      'created_at' => '2013-01-01 15:30:27',
      'first_sent_at' => '2013-01-01 15:30:29',
      'sent_weekly' => 42,
      'sent_monthly' => 42,
      'sent_total' => 42,
    );
    $subaccounts[] = $subaccount;

    // Test Customer Two
    $subaccount = array(
      'id' => 'test-customer-2',
      'name' => 'Test Customer Two',
      'custom_quota' => 42,
      'status' => 'active',
      'reputation' => 42,
      'created_at' => '2013-01-01 15:30:27',
      'first_sent_at' => '2013-01-01 15:30:29',
      'sent_weekly' => 42,
      'sent_monthly' => 42,
      'sent_total' => 42,
    );
    $subaccounts[] = $subaccount;
    return $subaccounts;
  }

  /**
   * {@inheritdoc}
   */
  public function getUser() {
    return $this
      ->getUserTestData();
  }

  /**
   * {@inheritdoc}
   */
  public function getTags() {
    $tags = $this
      ->getTagsTestData();
    foreach ($tags as $tag) {
      unset($tag['reputation']);
      unset($tag['unique_opens']);
      unset($tag['unique_clicks']);
    }
    return $tags;
  }

  /**
   * {@inheritdoc}
   */
  public function getTagsAllTimeSeries() {
    $time_series = array();
    $tags = $this
      ->getTagsTestData();
    foreach ($tags as $tag) {
      $stats = $tag['stats']['last_30_days'];
      if (!isset($time_series_data)) {
        $time_series_data = $stats;
        $time_series_data['time'] = date('Y-m-d H:i:s', time());
      }
      else {
        $time_series_data['sent'] += $stats['sent'];
        $time_series_data['hard_bounces'] += $stats['hard_bounces'];
        $time_series_data['soft_bounces'] += $stats['soft_bounces'];
        $time_series_data['rejects'] += $stats['rejects'];
        $time_series_data['complaints'] += $stats['complaints'];
        $time_series_data['unsubs'] += $stats['unsubs'];
        $time_series_data['opens'] += $stats['opens'];
        $time_series_data['unique_opens'] += $stats['unique_opens'];
        $time_series_data['clicks'] += $stats['clicks'];
        $time_series_data['unique_clicks'] += $stats['unique_clicks'];
      }
      $time_series[] = $time_series_data;
    }
    return $time_series;
  }

  /**
   * {@inheritdoc}
   */
  public function getSenders() {
    return $this
      ->getSendersTestData();
  }

  /**
   * {@inheritdoc}
   */
  public function getURLs() {
    return $this
      ->getUrlsTestData();
  }

  /**
   * {@inheritdoc}
   */
  public function sendTemplate($message, $template_id, $template_content) {
    if (!isset($message['to']) || empty($message['to'])) {
      return $this
        ->getErrorResponse(12, 'ValidationError', 'No recipients defined.');
    }
    $response = array();
    $templates = $this
      ->getTemplates();
    $matched_template = NULL;
    foreach ($templates as $template) {
      if ($template['name'] == $template_id) {
        $matched_template = $template;
        continue;
      }
    }
    if ($matched_template == NULL) {
      return $this
        ->getErrorResponse(12, 'Unknown_Template', 'No template with name: ' . $template_id);
    }
    $recipients = mandrill_get_to($message['to']);
    foreach ($recipients as $recipient) {
      $recipient_response = array(
        'email' => $recipient['email'],
        'status' => 'sent',
        'reject_reason' => '',
        '_id' => uniqid(),
      );
      $response[] = $recipient_response;
    }
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function send(array $message) {
    if (!isset($message['to']) || empty($message['to'])) {
      return $this
        ->getErrorResponse(12, 'ValidationError', 'No recipients defined.');
    }
    $response = array();
    foreach ($message['to'] as $recipient) {
      $recipient_response = array(
        'email' => $recipient['email'],
        'status' => '',
        'reject_reason' => '',
        '_id' => uniqid(),
      );
      if (\Drupal::service('email.validator')
        ->isValid($recipient['email'])) {
        $recipient_response['status'] = 'sent';
      }
      else {
        $recipient_response['status'] = 'invalid';
      }
      $response[] = $recipient_response;
    }
    return $response;
  }

  /**
   * Gets a Mandrill-style formatted error response.
   *
   * @param int $code
   *   The Mandrill error code.
   * @param string $name
   *   The name of the Mandrill error type (ValidationError, etc.)
   * @param $message
   *   The error message.
   *
   * @return array
   *   Formatted error response.
   */
  protected function getErrorResponse($code, $name, $message) {
    $response = array(
      'status' => 'error',
      'code' => $code,
      'name' => $name,
      'message' => $message,
    );
    return $response;
  }

  /**
   * Gets an array of messages used in tests.
   */
  protected function getTestMessagesData() {
    $messages = array();
    $message = array(
      'ts' => 1365190000,
      '_id' => 'abc123abc123abc123abc123',
      'sender' => 'sender@example.com',
      'template' => 'test-template',
      'subject' => 'Test Subject',
      'email' => 'recipient@example.com',
      'tags' => array(
        'test-tag',
      ),
      'opens' => 42,
      'opens_detail' => array(
        'ts' => 1365190001,
        'ip' => '55.55.55.55',
        'location' => 'Georgia, US',
        'ua' => 'Linux/Ubuntu/Chrome/Chrome 28.0.1500.53',
      ),
      'clicks' => 42,
      'clicks_detail' => array(
        'ts' => 1365190001,
        'url' => 'http://www.example.com',
        'ip' => '55.55.55.55',
        'location' => 'Georgia, US',
        'ua' => 'Linux/Ubuntu/Chrome/Chrome 28.0.1500.53',
      ),
      'state' => 'sent',
      'metadata' => array(
        'user_id' => 123,
        'website' => 'www.example.com',
      ),
    );
    $messages[] = $message;
    return $messages;
  }

  /**
   * Gets an array of templates used in tests.
   */
  protected function getTestTemplatesData() {
    $templates = array();
    $template = array(
      'slug' => 'test-template',
      'name' => 'Test Template',
      'labels' => array(
        'test-label',
      ),
      'code' => '<div>editable content</div>',
      'subject' => 'Test Subject',
      'from_email' => 'admin@example.com',
      'from_name' => 'Admin',
      'text' => 'Test text',
      'publish_name' => 'Test Template',
      'publish_code' => '<div>different than draft content</div>',
      'publish_subject' => 'Test Publish Subject',
      'publish_from_email' => 'admin@example.com',
      'publish_from_name' => 'Test Publish Name',
      'publish_text' => 'Test publish text',
      'published_at' => '2013-01-01 15:30:40',
      'created_at' => '2013-01-01 15:30:27',
      'updated_at' => '2013-01-01 15:30:49',
    );
    $templates[] = $template;
    return $templates;
  }

  /**
   * Gets user data used in tests.
   */
  protected function getUserTestData() {
    $stats_data = array(
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'unique_opens' => 42,
      'clicks' => 42,
      'unique_clicks' => 42,
    );
    $stats = array(
      'today' => $stats_data,
      'last_7_days' => $stats_data,
      'last_30_days' => $stats_data,
      'last_60_days' => $stats_data,
      'last_90_days' => $stats_data,
      'all_time' => $stats_data,
    );
    $user = array(
      'username' => 'testuser',
      'created_at' => '2013-01-01 15:30:27',
      'public_id' => 'aaabbbccc112233',
      'reputation' => 42,
      'hourly_quota' => 42,
      'backlog' => 42,
      'stats' => $stats,
    );
    return $user;
  }

  /**
   * Gets an array of tags used in tests.
   */
  protected function getTagsTestData() {
    $tags = array();
    $stats_data = array(
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'unique_opens' => 42,
      'clicks' => 42,
      'unique_clicks' => 42,
    );
    $stats = array(
      'today' => $stats_data,
      'last_7_days' => $stats_data,
      'last_30_days' => $stats_data,
      'last_60_days' => $stats_data,
      'last_90_days' => $stats_data,
    );

    // Test Tag One
    $tag = array(
      'tag' => 'test-tag-one',
      'reputation' => 42,
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'clicks' => 42,
      'unique_opens' => 42,
      'unique_clicks' => 42,
      'stats' => $stats,
    );
    $tags[] = $tag;

    // Test Tag Two
    $tag = array(
      'tag' => 'test-tag-two',
      'reputation' => 42,
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'clicks' => 42,
      'unique_opens' => 42,
      'unique_clicks' => 42,
      'stats' => $stats,
    );
    $tags[] = $tag;
    return $tags;
  }

  /**
   * Gets an array of sender data used in tests.
   */
  protected function getSendersTestData() {
    $senders = array();
    $stats_data = array(
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'unique_opens' => 42,
      'clicks' => 42,
      'unique_clicks' => 42,
    );
    $stats = array(
      'today' => $stats_data,
      'last_7_days' => $stats_data,
      'last_30_days' => $stats_data,
      'last_60_days' => $stats_data,
      'last_90_days' => $stats_data,
    );

    // Sender One
    $sender = array(
      'address' => 'sender.one@mandrillapp.com',
      'created_at' => '2013-01-01 15:30:27',
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'clicks' => 42,
      'unique_opens' => 42,
      'unique_clicks' => 42,
      'stats' => $stats,
    );
    $senders[] = $sender;

    // Sender Two
    $sender = array(
      'address' => 'sender.two@mandrillapp.com',
      'created_at' => '2013-01-01 15:30:27',
      'sent' => 42,
      'hard_bounces' => 42,
      'soft_bounces' => 42,
      'rejects' => 42,
      'complaints' => 42,
      'unsubs' => 42,
      'opens' => 42,
      'clicks' => 42,
      'unique_opens' => 42,
      'unique_clicks' => 42,
      'stats' => $stats,
    );
    $senders[] = $sender;
    return $senders;
  }

  /**
   * Gets an array of URLs data used in tests.
   */
  protected function getUrlsTestData() {
    $urls = array();

    // URL One
    $url = array(
      'url' => 'http://example.com/example-page-one',
      'sent' => 42,
      'clicks' => 42,
      'unique_clicks' => 42,
    );
    $urls[] = $url;

    // URL Two
    $url = array(
      'url' => 'http://example.com/example-page-two',
      'sent' => 42,
      'clicks' => 42,
      'unique_clicks' => 42,
    );
    $urls[] = $url;
    return $urls;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MandrillAPI::$config protected property The Config Factory service.
MandrillAPI::$log protected property The Logger Factory service.
MandrillAPI::addInboundDomain public function Creates a new inbound domain. Overrides MandrillAPIInterface::addInboundDomain
MandrillAPI::addInboundRoute public function Adds a new inbound route for a domain. Overrides MandrillAPIInterface::addInboundRoute
MandrillAPI::addWebhook public function Creates a new webhook. Overrides MandrillAPIInterface::addWebhook
MandrillAPI::deleteInboundDomain public function Deletes an inbound domain. Overrides MandrillAPIInterface::deleteInboundDomain
MandrillAPI::getAPIObject private function Return Mandrill API object for communication with the mandrill server.
MandrillAPI::getInboundDomains public function Gets a list of inbound domains. Overrides MandrillAPIInterface::getInboundDomains
MandrillAPI::getInboundRoutes public function Gets a list of inbound routes. Overrides MandrillAPIInterface::getInboundRoutes
MandrillAPI::getSender public function Gets a single sender. Overrides MandrillAPIInterface::getSender
MandrillAPI::getSenderTimeSeries public function Gets recent history for a sender. Overrides MandrillAPIInterface::getSenderTimeSeries
MandrillAPI::getTag public function Gets a single tag. Overrides MandrillAPIInterface::getTag
MandrillAPI::getTagTimeSeries public function Gets recent history for a tag. Overrides MandrillAPIInterface::getTagTimeSeries
MandrillAPI::getURLTimeSeries public function Gets recent history for a URL. Overrides MandrillAPIInterface::getURLTimeSeries
MandrillAPI::getWebhooks public function Gets a list of webhooks. Overrides MandrillAPIInterface::getWebhooks
MandrillAPI::isLibraryInstalled public function Check if the Mandrill PHP library is available. Overrides MandrillAPIInterface::isLibraryInstalled
MandrillAPI::__construct public function Constructs the service.
MandrillTestAPI::getErrorResponse protected function Gets a Mandrill-style formatted error response.
MandrillTestAPI::getMessages public function Gets messages received by an email address. Overrides MandrillAPI::getMessages
MandrillTestAPI::getSenders public function Gets a list of senders. Overrides MandrillAPI::getSenders
MandrillTestAPI::getSendersTestData protected function Gets an array of sender data used in tests.
MandrillTestAPI::getSubAccounts public function Gets a list of sub accounts. Overrides MandrillAPI::getSubAccounts
MandrillTestAPI::getTags public function Gets a list of tags. Overrides MandrillAPI::getTags
MandrillTestAPI::getTagsAllTimeSeries public function Gets recent history for all tags. Overrides MandrillAPI::getTagsAllTimeSeries
MandrillTestAPI::getTagsTestData protected function Gets an array of tags used in tests.
MandrillTestAPI::getTemplates public function Gets a list of mandrill template objects. Overrides MandrillAPI::getTemplates
MandrillTestAPI::getTestMessagesData protected function Gets an array of messages used in tests.
MandrillTestAPI::getTestTemplatesData protected function Gets an array of templates used in tests.
MandrillTestAPI::getURLs public function Gets the 100 most-clicked URLs. Overrides MandrillAPI::getURLs
MandrillTestAPI::getUrlsTestData protected function Gets an array of URLs data used in tests.
MandrillTestAPI::getUser public function Gets current API user information. Overrides MandrillAPI::getUser
MandrillTestAPI::getUserTestData protected function Gets user data used in tests.
MandrillTestAPI::send public function The function that calls the API send message. Overrides MandrillAPI::send
MandrillTestAPI::sendTemplate public function Sends a templated Mandrill message. Overrides MandrillAPI::sendTemplate