Merge branch 'development'

Author: lmajano

.env.template

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

.github/workflows/ci.yml

@@ -28,18 +28,18 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.2.0
         with:
           fetch-depth: 0
 
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3.9.0
         with:
-          distribution: "adopt"
+          distribution: "temurin"
           java-version: "11"
 
       - name: Cache CommandBox Dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         if: ${{ true }}
         with:
           path: ~/.CommandBox/artifacts
@@ -72,7 +72,7 @@ jobs:
 
       - name: Upload Build Artifacts
         if: success()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3.1.1
         with:
           name: ${{ env.MODULE_ID }}
           path: |

.github/workflows/gh-release.yml

@@ -10,8 +10,8 @@ jobs:
   create-release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: taiki-e/create-gh-release-action@v1.5.0
+      - uses: actions/checkout@v3.2.0
+      - uses: taiki-e/create-gh-release-action@v1.6.1
         with:
           # Produced by the build/Build.cfc
           changelog: changelog.md

.github/workflows/pr.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.2.0
 
       - uses: Ortus-Solutions/[email protected]
         with:

.github/workflows/tests.yml

@@ -20,19 +20,19 @@ jobs:
         cfengine: [ "lucee@5", "adobe@2018", "adobe@2021" ]
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.2.0
 
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3.9.0
         with:
-          distribution: "adopt"
+          distribution: "temurin"
           java-version: "11"
 
       - name: Setup CommandBox CLI
         uses: Ortus-Solutions/[email protected]
 
       - name: Cache CommandBox Dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         if: ${{ true }}
         with:
           path: ~/.CommandBox/artifacts
@@ -67,15 +67,15 @@ jobs:
           box testbox run --verbose outputFile=test-harness/tests/results/test-results outputFormats=json,antjunit
 
       - name: Publish Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v1
+        uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()
         with:
-          files: test-harness/tests/results/**/*.xml
+          junit_files: test-harness/tests/results/**/*.xml
           check_name: "${{ matrix.cfengine }} Test Results"
 
       - name: Upload Test Results to Artifacts
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3.1.1
         with:
           name: test-results-${{ matrix.cfengine }}
           path: |
@@ -90,7 +90,7 @@ jobs:
 
       - name: Upload Debug Logs To Artifacts
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3.1.1
         with:
           name: Failure Debugging Info - ${{ matrix.cfengine }}
           path: |

box.json

@@ -1,6 +1,6 @@
 {
     "name":"ColdBox Mail Services",
-    "version":"2.6.2",
+    "version":"2.7.0",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbmailservices/@build.version@/[email protected]@.zip",
     "author":"Ortus Solutions.com <[email protected]",
     "slug":"cbmailservices",

changelog.md

@@ -8,6 +8,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ----
 
 
+## [v2.7.0] => 2023-JAN-16
+
+A big thanks to @richardherbert for all the updates in this release.
+
+### Fixed
+
+* FIXED var scoping of attachments variable
+* Updated to handle a response that is not JSON
+* 🐛 FIX: Update GHA to avoid deprecated syntax
+
+### Added
+
+* Added test for MAILGUN_BASEURL property
+* 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.
+
+### Changed
+
+* Updated all GHA actions to latest versions and moved to use `temurin` Java distributions from adopt due to deprecation of the service.
+
+----
+
+
 ## [v2.6.2] => 2022-DEC-20
 
 ### Fixed

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(){