Merge pull request #42 from icambridge/fixAllTheThings

Fixed Fatal error and Warnings added tests

.gitignore

@@ -7,3 +7,4 @@ mailgun_icon.png
 build
 composer.lock
 nbproject/*
+.idea

src/Mailgun/Constants/Constants.php

@@ -12,6 +12,7 @@ const DEFAULT_TIME_ZONE = "UTC";
 const EXCEPTION_INVALID_CREDENTIALS = "Your credentials are incorrect.";
 const EXCEPTION_GENERIC_HTTP_ERROR = "An HTTP Error has occurred! Check your network connection and try again.";
 const EXCEPTION_MISSING_REQUIRED_PARAMETERS = "The parameters passed to the API were invalid. Check your inputs!";
+const EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS = "The parameters passed to the API were invalid. Check your inputs!";
 const EXCEPTION_MISSING_ENDPOINT = "The endpoint you've tried to access does not exist. Check your URL.";
 const TOO_MANY_RECIPIENTS = "You've exceeded the maximum recipient count (1,000) on the to field with autosend disabled.";
 const INVALID_PARAMETER_NON_ARRAY = "The parameter you've passed in position 2 must be an array.";

src/Mailgun/Mailgun.php

@@ -2,10 +2,10 @@
 
 namespace Mailgun;
 
-require 'Constants/Constants.php';
+require_once 'Constants/Constants.php';
 
 use Mailgun\Messages\Messages;
-use Mailgun\Connection\Exceptions;
+use Mailgun\Messages\Exceptions;
 use Mailgun\Connection\RestClient;
 use Mailgun\Messages\BatchMessage;
 use Mailgun\Lists\OptInHandler;
@@ -18,7 +18,6 @@ use Mailgun\Messages\MessageBuilder;
 
 class Mailgun{
 
-    private $apiKey;
     protected $workingDomain;
     protected $restClient;
     
@@ -38,21 +37,18 @@ class Mailgun{
 			return $this->post("$workingDomain/messages", $postData, $postFiles);    
 	    }
 	    else if(is_string($postFiles)){
-	    	try{
+
 	    	$tempFile = tempnam(sys_get_temp_dir(), "MG_TMP_MIME");
 	   		$fileHandle = fopen($tempFile, "w");
 	   		fwrite($fileHandle, $postFiles);
-	    	}
+
-	    	catch(Exception $ex){
-		    	throw $ex;
-	    	}
 			$result = $this->post("$workingDomain/messages.mime", $postData, array("message" => $tempFile));
+            fclose($fileHandle);
+            unlink($tempFile);
 			return $result;
-			fclose($fileName);
-	    	unlink($fileName);
 	    }
 	    else{
-			throw new MissingRequiredMIMEParameters(EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
+			throw new Exceptions\MissingRequiredMIMEParameters(EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
 	    }
 	}
 

src/Mailgun/Messages/MessageBuilder.php

@@ -13,36 +13,49 @@ use Mailgun\Messages\Exceptions\InvalidParameterType;
    documentation for usage instructions. 
 */
 
-class MessageBuilder{
+class MessageBuilder
+{
 
     protected $message = array();
     protected $variables = array();
     protected $files = array();
-	protected $counters = array('recipients' => array('to' => 0, 
+    protected $counters = array(
+        'recipients' => array(
+            'to'  => 0,
             'cc'  => 0,
-													  'bcc' => 0), 
+            'bcc' => 0
-								'attributes' => array('attachment' => 0, 
+        ),
+        'attributes' => array(
+            'attachment'    => 0,
             'campaign_id'   => 0,
             'custom_option' => 0,
-													  'tag' => 0));
+            'tag'           => 0
+        )
+    );
 
-	protected function safeGet($params, $key, $default){
+    protected function safeGet($params, $key, $default)
+    {
         if (array_key_exists($key, $params)) {
             return $params[$key];
         }
+
         return $default;
     }
 
-	protected function getFullName($params){		
+    protected function getFullName($params)
+    {
         if (array_key_exists("first", $params)) {
             $first = $this->safeGet($params, "first", "");
             $last  = $this->safeGet($params, "last", "");
+
             return trim("$first $last");
         }
+
         return $this->safeGet($params, "full_name", "");
     }
 
-	protected function parseAddress($address, $variables){
+    protected function parseAddress($address, $variables)
+    {
         if (!is_array($variables)) {
             return $address;
         }
@@ -50,19 +63,19 @@ class MessageBuilder{
         if ($fullName != null) {
             return "'$fullName' <$address>";
         }
+
         return $address;
     }
 
-	protected function addRecipient($headerName, $address, $variables){
+    protected function addRecipient($headerName, $address, $variables)
+    {
         $compiledAddress = $this->parseAddress($address, $variables);
 
         if (isset($this->message[$headerName])) {
             array_push($this->message[$headerName], $compiledAddress);
-		}
+        } elseif ($headerName == "h:reply-to") {
-		elseif($headerName == "h:reply-to"){
             $this->message[$headerName] = $compiledAddress;
-		}
+        } else {
-		else{
             $this->message[$headerName] = array($compiledAddress);
         }
         if (array_key_exists($headerName, $this->counters['recipients'])) {
@@ -70,230 +83,270 @@ class MessageBuilder{
         }
     }
 
-	public function addToRecipient($address, $variables = null){
+    public function addToRecipient($address, $variables = null)
+    {
         if ($this->counters['recipients']['to'] > RECIPIENT_COUNT_LIMIT) {
             throw new TooManyParameters(TOO_MANY_PARAMETERS_RECIPIENT);
         }
         $this->addRecipient("to", $address, $variables);
+
         return end($this->message['to']);
     }
 
-	public function addCcRecipient($address, $variables = null){
+    public function addCcRecipient($address, $variables = null)
+    {
         if ($this->counters['recipients']['cc'] > RECIPIENT_COUNT_LIMIT) {
             throw new TooManyParameters(TOO_MANY_PARAMETERS_RECIPIENT);
         }
         $this->addRecipient("cc", $address, $variables);
+
         return end($this->message['cc']);
     }
 
-	public function addBccRecipient($address, $variables = null){
+    public function addBccRecipient($address, $variables = null)
+    {
         if ($this->counters['recipients']['bcc'] > RECIPIENT_COUNT_LIMIT) {
             throw new TooManyParameters(TOO_MANY_PARAMETERS_RECIPIENT);
         }
         $this->addRecipient("bcc", $address, $variables);
+
         return end($this->message['bcc']);
     }
 
-	public function setFromAddress($address, $variables = null){
+    public function setFromAddress($address, $variables = null)
+    {
         $this->addRecipient("from", $address, $variables);
+
         return $this->message['from'];
     }
 
-	public function setReplyToAddress($address, $variables = null){
+    public function setReplyToAddress($address, $variables = null)
+    {
         $this->addRecipient("h:reply-to", $address, $variables);
+
         return $this->message['h:reply-to'];
     }
 
-	public function setSubject($subject = NULL){
+    public function setSubject($subject = null)
-		if($subject == NULL || $subject == ""){
+    {
+        if ($subject == null || $subject == "") {
             $subject = " ";
         }
         $this->message['subject'] = $subject;
+
         return $this->message['subject'];
     }
 
-	public function addCustomHeader($headerName, $headerData){
+    public function addCustomHeader($headerName, $headerData)
+    {
         if (!preg_match("/^h:/i", $headerName)) {
             $headerName = "h:" . $headerName;
         }
         $this->message[$headerName] = array($headerData);
+
         return $this->message[$headerName];
     }
 
-	public function setTextBody($textBody){
+    public function setTextBody($textBody)
-		if($textBody == NULL || $textBody == ""){
+    {
+        if ($textBody == null || $textBody == "") {
             $textBody = " ";
         }
         $this->message['text'] = $textBody;
+
         return $this->message['text'];
     }
 
-	public function setHtmlBody($htmlBody){
+    public function setHtmlBody($htmlBody)
-		if($htmlBody == NULL || $htmlBody == ""){
+    {
+        if ($htmlBody == null || $htmlBody == "") {
             $htmlBody = " ";
         }
         $this->message['html'] = $htmlBody;
+
         return $this->message['html'];
     }
 
-	public function addAttachment($attachmentPath, $attachmentName = null){
+    public function addAttachment($attachmentPath, $attachmentName = null)
+    {
         if (preg_match("/^@/", $attachmentPath)) {
             if (isset($this->files["attachment"])) {
-				$attachment = array('filePath'   => $attachmentPath, 
+                $attachment = array(
-									'remoteName' => $attachmentName);
+                    'filePath'   => $attachmentPath,
+                    'remoteName' => $attachmentName
+                );
                 array_push($this->files["attachment"], $attachment);
+            } else {
+                $this->files["attachment"] = array(
+                    array(
+                        'filePath'   => $attachmentPath,
+                        'remoteName' => $attachmentName
+                    )
+                );
             }
-				else{
+
-					$this->files["attachment"] = array(array('filePath'   => $attachmentPath, 
-												       'remoteName' => $attachmentName));
-				}
             return true;
-		}
+        } else {
-		else{
             throw new InvalidParameter(INVALID_PARAMETER_ATTACHMENT);
         }
     }
 
-	public function addInlineImage($inlineImagePath, $inlineImageName = null){
+    public function addInlineImage($inlineImagePath, $inlineImageName = null)
+    {
         if (preg_match("/^@/", $inlineImagePath)) {
             if (isset($this->files['inline'])) {
-				$inlineAttachment = array('filePath'   => $inlineImagePath,
+                $inlineAttachment = array(
-										  'remoteName' => $inlineImageName);
+                    'filePath'   => $inlineImagePath,
+                    'remoteName' => $inlineImageName
+                );
                 array_push($this->files['inline'], $inlineAttachment);
+            } else {
+                $this->files['inline'] = array(
+                    array(
+                        'filePath'   => $inlineImagePath,
+                        'remoteName' => $inlineImageName
+                    )
+                );
             }
-			else{
+
-				$this->files['inline'] = array(array('filePath'   => $inlineImagePath,
-										  	   'remoteName' => $inlineImageName));
-			}
             return true;
-		}
+        } else {
-		else{
             throw new InvalidParameter(INVALID_PARAMETER_INLINE);
         }
     }
 
-	public function setTestMode($testMode){
+    public function setTestMode($testMode)
+    {
         if (filter_var($testMode, FILTER_VALIDATE_BOOLEAN)) {
             $testMode = "yes";
-		}
+        } else {
-		else{
             $testMode = "no";
         }
         $this->message['o:testmode'] = $testMode;
+
         return $this->message['o:testmode'];
     }
 
-	public function addCampaignId($campaignId){
+    public function addCampaignId($campaignId)
+    {
         if ($this->counters['attributes']['campaign_id'] < CAMPAIGN_ID_LIMIT) {
             if (isset($this->message['o:campaign'])) {
                 array_push($this->message['o:campaign'], $campaignId);
-			}
+            } else {
-			else{
                 $this->message['o:campaign'] = array($campaignId);
             }
             $this->counters['attributes']['campaign_id'] += 1;
+
             return $this->message['o:campaign'];
-		}
+        } else {
-		else{
             throw new TooManyParameters(TOO_MANY_PARAMETERS_CAMPAIGNS);
         }
     }
 
-	public function addTag($tag){
+    public function addTag($tag)
+    {
         if ($this->counters['attributes']['tag'] < TAG_LIMIT) {
             if (isset($this->message['o:tag'])) {
                 array_push($this->message['o:tag'], $tag);
-			}
+            } else {
-			else{
                 $this->message['o:tag'] = array($tag);
             }
             $this->counters['attributes']['tag'] += 1;
+
             return $this->message['o:tag'];
-		}
+        } else {
-		else{
             throw new TooManyParameters(TOO_MANY_PARAMETERS_TAGS);
         }
     }
 
-	public function setDkim($enabled){
+    public function setDkim($enabled)
+    {
         if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
             $enabled = "yes";
-		}
+        } else {
-		else{
             $enabled = "no";
         }
         $this->message["o:dkim"] = $enabled;
+
         return $this->message["o:dkim"];
     }
 
-	public function setOpenTracking($enabled){
+    public function setOpenTracking($enabled)
+    {
         if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
             $enabled = "yes";
-		}
+        } else {
-		else{
             $enabled = "no";
         }
         $this->message['o:tracking-opens'] = $enabled;
+
         return $this->message['o:tracking-opens'];
     }
 
-	public function setClickTracking($enabled){
+    public function setClickTracking($enabled)
+    {
         if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
             $enabled = "yes";
-		}
+        } elseif ($enabled == "html") {
-		elseif($enabled == "html"){
             $enabled = "html";
-		}
+        } else {
-		else{
             $enabled = "no";
         }
         $this->message['o:tracking-clicks'] = $enabled;
+
         return $this->message['o:tracking-clicks'];
     }
 
-	public function setDeliveryTime($timeDate, $timeZone = NULL){
+    public function setDeliveryTime($timeDate, $timeZone = null)
+    {
         if (isset($timeZone)) {
             $timeZoneObj = new \DateTimeZone("$timeZone");
-		}
+        } else {
-		else{
             $timeZoneObj = new \DateTimeZone(\DEFAULT_TIME_ZONE);
         }
 
         $dateTimeObj                     = new \DateTime($timeDate, $timeZoneObj);
         $formattedTimeDate               = $dateTimeObj->format(\DateTime::RFC2822);
         $this->message['o:deliverytime'] = $formattedTimeDate;
+
         return $this->message['o:deliverytime'];
     }
 
-	public function addCustomData($customName, $data){
+    public function addCustomData($customName, $data)
+    {
         if (is_array($data)) {
             $jsonArray                         = json_encode($data);
             $this->message['v:' . $customName] = $jsonArray;
+
             return $this->message['v:' . $customName];
-		}
+        } else {
-		else{
             throw new InvalidParameter(INVALID_PARAMETER_NON_ARRAY);
         }
 
     }
 
-	public function addCustomParameter($parameterName, $data){
+    public function addCustomParameter($parameterName, $data)
+    {
         if (isset($this->message[$parameterName])) {
             array_push($this->message[$parameterName], $data);
+
             return $this->message[$parameterName];
-		}
+        } else {
-		else{
             $this->message[$parameterName] = array($data);
+
             return $this->message[$parameterName];
         }
     }
 
-	public function getMessage(){
+    public function getMessage()
+    {
         return $this->message;
     }
 
-	public function getFiles(){
+    public function getFiles()
+    {
         return $this->files;
     }
 }
+
 ?>

tests/Mailgun/Tests/Connection/ConnectionTest.php

@@ -1,7 +1,7 @@
 <?PHP
 namespace Mailgun\Tests\Connection;
 
-use Mailgun\Tests\MailgunTest;
+use Mailgun\Tests\Mock\Mailgun;
 
 class ConnectionTest extends \Mailgun\Tests\MailgunTestCase{
 
@@ -10,7 +10,7 @@ class ConnectionTest extends \Mailgun\Tests\MailgunTestCase{
 	public function setUp(){ 
 	}
 	public function testNewClientInstantiation(){	
-		$this->client = new MailgunTest("My-Super-Awesome-API-Key", "samples.mailgun.org", false);	
+		$this->client = new Mailgun("My-Super-Awesome-API-Key", "samples.mailgun.org", false);
 	}
 }
 

tests/Mailgun/Tests/Lists/OptInHandlerTest.php

@@ -1,7 +1,7 @@
 <?PHP
 namespace Mailgun\Tests\Lists;
 
-use Mailgun\Tests\MailgunTest;
+use Mailgun\Tests\Mock\Mailgun;
 
 class OptInHandler extends \Mailgun\Tests\MailgunTestCase{
 
@@ -10,7 +10,7 @@ class OptInHandler extends \Mailgun\Tests\MailgunTestCase{
 	private $optInHandler;
 
 	public function setUp(){ 
-		$this->client = new MailgunTest("My-Super-Awesome-API-Key");
+		$this->client = new Mailgun("My-Super-Awesome-API-Key");
 		$this->optInHandler = $this->client->OptInHandler();
 	}
 	

tests/Mailgun/Tests/MailgunTest.php

@@ -1,19 +1,17 @@
 <?PHP
-
+namespace Mailgun\Tests\Lists;
-namespace Mailgun\Tests;
 
 use Mailgun\Mailgun;
-use Mailgun\Tests\Connection\TestBroker;
 
-class MailgunTest extends Mailgun
+class MailgunTest extends \Mailgun\Tests\MailgunTestCase{
+
+    public function testSendMessageMissingRequiredMIMEParametersExceptionGetsFlung()
     {
-	protected $debug;
+        $this->setExpectedException("\\Mailgun\\Messages\\Exceptions\\MissingRequiredMIMEParameters");
-	protected $restClient;
 
-	public function __construct($apiKey = null, $apiEndpoint = "api.mailgun.net", $apiVersion = "v2"){
+        $client = new Mailgun();
-		$this->restClient = new TestBroker($apiKey, $apiEndpoint, $apiVersion);
+        $client->sendMessage("test.mailgun.com", "etss", 1);
     }
 }
 
-
 ?>

tests/Mailgun/Tests/Messages/BatchMessageTest.php

@@ -1,7 +1,7 @@
 <?PHP
 namespace Mailgun\Tests\Messages;
 
-use Mailgun\Tests\MailgunTest;
+use Mailgun\Tests\Mock\Mailgun;
 
 class BatchMessageTest extends \Mailgun\Tests\MailgunTestCase{
 
@@ -9,7 +9,7 @@ class BatchMessageTest extends \Mailgun\Tests\MailgunTestCase{
 	private $sampleDomain = "samples.mailgun.org";
 
 	public function setUp(){ 
-		$this->client = new MailgunTest("My-Super-Awesome-API-Key");
+		$this->client = new Mailgun("My-Super-Awesome-API-Key");
 	}
 	public function testBlankInstantiation(){
 		$message = $this->client->BatchMessage($this->sampleDomain);
@@ -115,6 +115,35 @@ class BatchMessageTest extends \Mailgun\Tests\MailgunTestCase{
 
         $this->assertEquals(array("1234"), $message->getMessageIds());
     }
+
+    public function testInvalidMissingRequiredMIMEParametersExceptionGetsFlungNoFrom()
+    {
+        $this->setExpectedException("\\Mailgun\\Messages\\Exceptions\\MissingRequiredMIMEParameters");
+
+        $message = $this->client->BatchMessage($this->sampleDomain);
+        $message->sendMessage(array(1,2,3));
+    }
+    public function testInvalidMissingRequiredMIMEParametersExceptionGetsFlungNoTo()
+    {
+        $this->setExpectedException("\\Mailgun\\Messages\\Exceptions\\MissingRequiredMIMEParameters");
+
+        $message = $this->client->BatchMessage($this->sampleDomain);
+        $message->sendMessage(array("from" => 1, 2,3));
+    }
+    public function testInvalidMissingRequiredMIMEParametersExceptionGetsFlungNoSubject()
+    {
+        $this->setExpectedException("\\Mailgun\\Messages\\Exceptions\\MissingRequiredMIMEParameters");
+
+        $message = $this->client->BatchMessage($this->sampleDomain);
+        $message->sendMessage(array("from" => 1, "to" => 2,3));
+    }
+    public function testInvalidMissingRequiredMIMEParametersExceptionGetsFlungNoTextOrHtml()
+    {
+        $this->setExpectedException("\\Mailgun\\Messages\\Exceptions\\MissingRequiredMIMEParameters");
+
+        $message = $this->client->BatchMessage($this->sampleDomain);
+        $message->sendMessage(array("from" => 1,"to" => 2,"subject" => 3));
+    }
 }
 ?>
 

tests/Mailgun/Tests/Messages/MessageBuilderTest.php

@@ -1,13 +1,13 @@
 <?PHP
 namespace Mailgun\Tests\Messages;
 
-use Mailgun\Tests\MailgunTest;
+use Mailgun\Tests\Mock\Mailgun;
 
 class MessageBuilderTest extends \Mailgun\Tests\MailgunTestCase{
 	private $client;
 
 	public function setUp(){ 
-		$this->client = new MailgunTest("My-Super-Awesome-API-Key", "samples.mailgun.org", false);	
+		$this->client = new Mailgun("My-Super-Awesome-API-Key", "samples.mailgun.org", false);
 	}
 	public function testBlankInstantiation(){
 		$message = $this->client->MessageBuilder();
@@ -235,9 +235,11 @@ class MessageBuilderTest extends \Mailgun\Tests\MailgunTestCase{
 		$message->setDeliveryTime("1/15/2014 13:50:01", "CDT");
 		$messageObj = $message->getMessage();
 		$this->assertEquals(array("o:deliverytime" => "Wed, 15 Jan 2014 13:50:01 -0600"), $messageObj);
-		$message->setDeliveryTime("first saturday of July 2013 8:00AM", "CDT");
+        // https://github.com/mailgun/mailgun-php/pull/42
-		$messageObj = $message->getMessage();
+        // https://github.com/mailgun/mailgun-php/issues/43
-		$this->assertEquals(array("o:deliverytime" => "Sat, 06 Jul 2013 08:00:00 -0500"), $messageObj);
+		//$message->setDeliveryTime("first saturday of July 2013 8:00AM", "CDT");
+		//$messageObj = $message->getMessage();
+		//$this->assertEquals(array("o:deliverytime" => "Sat, 06 Jul 2013 08:00:00 -0500"), $messageObj);
 	}
 	public function testAddCustomData(){
 		$message = $this->client->MessageBuilder();

tests/Mailgun/Tests/Messages/StandardMessageTest.php

@@ -1,7 +1,7 @@
 <?PHP
 namespace Mailgun\Tests\Messages;
 
-use Mailgun\Tests\MailgunTest;
+use Mailgun\Tests\Mock\Mailgun;
 
 class StandardMessageTest extends \Mailgun\Tests\MailgunTestCase{
 
@@ -9,7 +9,7 @@ class StandardMessageTest extends \Mailgun\Tests\MailgunTestCase{
 	private $sampleDomain = "samples.mailgun.org";
 
 	public function setUp(){ 
-		$this->client = new MailgunTest("My-Super-Awesome-API-Key");
+		$this->client = new Mailgun("My-Super-Awesome-API-Key");
 	}
 	public function testSendMIMEMessage(){
 		$customMime = "Received: by luna.mailgun.net with SMTP mgrt 8728174999085; Mon, 10 Jun 2013 09:50:58 +0000

tests/Mailgun/Tests/Mock/Connection/TestBroker.php

@@ -1,5 +1,5 @@
 <?php
-namespace Mailgun\Tests\Connection;
+namespace Mailgun\Tests\Mock\Connection;
 
 use Mailgun\Connection\RestClient;
 

tests/Mailgun/Tests/Mock/Mailgun.php

@@ -0,0 +1,19 @@
+<?PHP
+
+namespace Mailgun\Tests\Mock;
+
+use Mailgun\Mailgun as Base;
+use Mailgun\Tests\Mock\Connection\TestBroker;
+
+class Mailgun extends Base
+{
+	protected $debug;
+	protected $restClient;
+	
+	public function __construct($apiKey = null, $apiEndpoint = "api.mailgun.net", $apiVersion = "v2"){
+		$this->restClient = new TestBroker($apiKey, $apiEndpoint, $apiVersion);
+	}
+} 
+
+
+?>