Mailgun EU Region Domains (#32)

* Added test for MAILGUN_BASEURL property
* FIXED var scoping of attachments variable
* Updated to make MAILGUN_APIURL optional

Added support for Mailgun EU region by making MAILGUN_APIURL an optional property with https://api.mailgun.net/v3/ as the default.

* Updated to handle a response that is not JSON

Mailgun returns only "Forbidden" when the wrong Base URL region is used.

Author: richardherbert

.env.template

@@ -1,3 +1,4 @@
 POSTMARK_API_KEY=
 MAILGUN_API_KEY=
 MAILGUN_DOMAIN=
+MAILGUN_BASEURL=

models/protocols/MailgunProtocol.cfc

@@ -8,6 +8,9 @@
  * - apikey : The mailgun secret api key
  * - domain : The mailgun domain to send the email through
  *
+ * An optional property, "baseURL" is required when using an EU region
+ * - baseURL : The mailgun region where the Mailgun domain was created
+ *
  * @author Scott Steinbeck <[email protected]>
  */
 component
@@ -24,7 +27,6 @@ component
 	MailgunProtocol function init( struct properties = {} ){
 		variables.name            = "Mailgun";
 		variables.DEFAULT_TIMEOUT = 30; // in seconds
-		variables.MAILGUN_APIURL  = "https://api.mailgun.net/v3/";
 		// super size it
 		super.init( argumentCollection = arguments );
 
@@ -40,6 +42,14 @@ component
 			throw( message = "ApiKey is Required", type = "MailgunProtocol.PropertyNotFound" );
 		}
 
+		// Check for Base URL property
+		if ( !propertyExists( "baseURL" ) ) {
+			// No baseURL key was found, so use the US default.
+			variables.MAILGUN_APIURL  = "https://api.mailgun.net/v3/";
+		} else {
+			variables.MAILGUN_APIURL = getProperty( "baseURL" );
+		}
+
 		return this;
 	}
 
@@ -101,7 +111,7 @@ component
 		data.delete( "bodyTokens" ); // cleanup payload
 
 		// Process the mail attachments and encode them how mailgun likes them
-		attachments = arguments.payload
+		var attachments = arguments.payload
 			.getMailParams()
 			.filter( function( thisParam ){
 				return structKeyExists( arguments.thisParam, "file" );
@@ -185,7 +195,14 @@ component
 			}
 
 			// Inflate HTTP Results
-			var mailgunResults = deserializeJSON( httpResults.fileContent.toString() );
+			if( isJSON( httpResults.fileContent.toString() ) ) {
+				var mailgunResults = deserializeJSON( httpResults.fileContent.toString() );
+			} else {
+				results.messages = [ 'Error sending mail. Mailgun returned "#httpResults.fileContent.toString()#".' ];
+
+				return results;
+			}
+
 			// Process Mailgun Results
 			if ( mailgunResults.message eq "Queued. Thank you." ) {
 				results.error     = false;

test-harness/tests/specs/protocols/MailgunProtocolTest.cfc

@@ -14,6 +14,7 @@ component extends="coldbox.system.testing.BaseTestCase" {
 		variables.mailservice = getInstance( "MailService@cbmailservices" );
 		variables.apikey      = getUtil().getSystemSetting( "MAILGUN_API_KEY", "MAILGUN_API_KEY" );
 		variables.domain      = getUtil().getSystemSetting( "MAILGUN_DOMAIN", "MAILGUN_DOMAIN" );
+		variables.baseURL     = getUtil().getSystemSetting( "MAILGUN_BASEURL", "MAILGUN_BASEURL" );
 	}
 
 	/*********************************** BDD SUITES ***********************************/
@@ -23,15 +24,17 @@ component extends="coldbox.system.testing.BaseTestCase" {
 		describe( "Mailgun Protocol", function(){
 			beforeEach( function( currentSpec ){
 				// Create a mock instance of the protocol.
-				variables.protocol = createMock( "cbmailservices.models.protocols.MailgunProtocol" ).init( { 
-					apiKey : variables.apikey, 
-					domain : variables.domain 
+				variables.protocol = createMock( "cbmailservices.models.protocols.MailgunProtocol" ).init( {
+					apiKey : variables.apikey,
+					domain : variables.domain,
+					baseURL : variables.baseURL
 				} );
 			} );
 
 			it( "can be inited correctly", function(){
 				expect( variables.protocol.propertyExists( "apiKey" ) ).toBeTrue();
 				expect( variables.protocol.propertyExists( "domain" ) ).toBeTrue();
+				expect( variables.protocol.propertyExists( "baseURL" ) ).toBeTrue();
 			} );
 
 			it( "data is formatted for sending to mailgun", function(){