#73 finished Hoth & BLHQ integration examples & tests

Author: Adam Tuttle

bonus/ILogAdapter.cfc

@@ -2,6 +2,7 @@
 
 	<cffunction name="init" hint="I accept a configuration structure to setup and return myself">
 		<cfargument name="config" />
+		<cfargument name="tracker" />
 	</cffunction>
 	<cffunction name="log" hint="I log or otherwise notify you of an exception">
 		<cfargument name="exception" />

bonus/LogToBugLogHQ.cfc

@@ -2,12 +2,31 @@
 
 	<cffunction name="init">
 		<cfargument name="config" />
+		<cfargument name="tracker" default="#createObject("component", "bugLog.client.bugLogService")#" />
+	
+		<cfset variables.blhq = arguments.tracker />
+		<cfset variables.blhq.init(
+			argumentCollection=arguments.config
+		) />
+	
+		<cfparam name="arguments.config.message" default="Exception trapped in API" />
+		<cfset variables.message = arguments.config.message />
+	
 		<cfreturn this />
 	</cffunction>
 
 	<cffunction name="log">
 		<cfargument name="exception" />
-		<!--- TODO --->
+	
+		<cfset var msg = '' />
+	
+		<cfif structKeyExists(exception, "message")>
+			<cfset msg = exception.message />
+		<cfelse>
+			<cfset msg = variables.message />
+		</cfif>
+	
+		<cfset variables.blhq.notifyService(msg, arguments.exception) />
 	</cffunction>
 
 </cfcomponent>

bonus/LogToEmail.cfc

@@ -2,15 +2,19 @@
 
 	<cffunction name="init">
 		<cfargument name="config" />
-		<cfset structAppend( variables, arguments.config, true ) /><!--- copy settings into adapter instance data --->
+		<cfargument name="tracker" hint="unused" default="" />
+
+		<!--- copy settings into adapter instance data --->
+		<cfset structAppend( variables, arguments.config, true ) />
+		
 		<cfreturn this />
 	</cffunction>
 
 	<cffunction name="log">
 		<cfargument name="exception" />
 		<!---
-			TODO: this adapter does not currently support authentication-required email, supplying a specific server, etc.
-			That would be a great and relatively easy thing for a 3rd party contributor to add! :)
+			TODO: This adapter does not currently support authentication-required email, supplying a specific server, etc.
+			That would be a great and relatively easy thing for you to contribute back! :)
 		--->
 		<cfmail
 			from="#variables.emailFrom#"

bonus/LogToHoth.cfc

@@ -2,7 +2,9 @@
 
 	<cffunction name="init">
 		<cfargument name="config" />
-		<cfset variables.hothtracker = createObject("component", "Hoth.HothTracker").init(
+		<cfargument name="tracker" default="#createObject("component", "Hoth.HothTracker")#" />
+		<cfset variables.hothtracker = arguments.tracker />
+		<cfset variables.hothtracker.init(
 			createObject("component", arguments.config)
 		) />
 		<cfreturn this />

examples/api/Application.cfc

@@ -8,6 +8,7 @@
 		variables.framework.reloadKey = "reload";
 		variables.framework.reloadPassword = "true";
 		variables.framework.defaultRepresentationClass = "taffy.core.genericRepresentation";
+		variables.framework.returnExceptionsAsJson = true;
 
 		// do your onApplicationStart stuff here
 		function applicationStartEvent(){}

examples/api_BugLogHQ/Application.cfc

@@ -0,0 +1,18 @@
+<cfcomponent extends="taffy.core.api">
+	<cfscript>
+		
+		this.name = hash(getCurrentTemplatePath());
+
+		variables.framework = {};
+
+		variables.framework.defaultExceptionLogAdapter = "taffy.bonus.LogToBugLogHQ";
+
+		variables.framework.exceptionLogAdapterConfig = StructNew();
+		variables.framework.exceptionLogAdapterConfig.bugLogListener = "bugLog.listeners.bugLogListenerWS";
+		variables.framework.exceptionLogAdapterConfig.bugEmailRecipients = "[email protected]";
+		variables.framework.exceptionLogAdapterConfig.bugEmailSender = "[email protected]";
+		variables.framework.exceptionLogAdapterConfig.hostname = "Taffy_DEV_Examples";
+		variables.framework.exceptionLogAdapterConfig.apikey = "";
+
+	</cfscript>
+</cfcomponent>

examples/api_BugLogHQ/index.cfm

@@ -0,0 +1,7 @@
+<cfcomponent extends="taffy.core.resource" taffy_uri="/foo">
+
+	<cffunction name="get" access="public" output="false">
+		<cfthrow message="this is the message" detail="this is the detail" />
+	</cffunction>
+
+</cfcomponent>

examples/api_BugLogHQ/resources/throwsException.cfc

@@ -2,11 +2,9 @@
 	<cfscript>
 		this.name = hash(getCurrentTemplatePath());
 
-		variables.framework = {
-			returnExceptionsAsJson = true
-			,defaultExceptionLogAdapter = "taffy.bonus.LogToHoth"
-			,exceptionLogAdapterConfig = "taffy.examples.api_hoth.resources.HothConfig"
-		};
+		variables.framework = {};
+		variables.framework.defaultExceptionLogAdapter = "taffy.bonus.LogToHoth";
+		variables.framework.exceptionLogAdapterConfig = "taffy.examples.api_hoth.resources.HothConfig";
 
 	</cfscript>
 </cfcomponent>

examples/api_Hoth/Application.cfc

@@ -0,0 +1,48 @@
+<cfcomponent extends="base">
+	<cfscript>
+
+		function test_hoth(){
+			var mockHoth = mock();
+			var hothAdapter = '';
+			var fakeError = {};
+
+			//setup the behaviors we're expecting the adapter to run
+			mockHoth.track('{struct}');
+
+			//create hoth adapter to test
+			hothAdapter = createObject("component", "taffy.bonus.LogToHoth").init(
+				"taffy.examples.api_hoth.resources.HothConfig",
+				mockHoth
+			);
+
+			//fake error
+			fakeError.message = "This is a test error";
+			fakeError.detail = "Rubber Baby Buggy Bumper";
+			hothAdapter.log(fakeError);
+
+			mockHoth.verify().track('{struct}');
+		}
+
+		function test_BugLogHQ(){
+			var mockBLHQ = mock();
+			var blhqAdapter = '';
+			var blhqSettings = {};
+			var fakeError = {};
+
+			mockBLHQ.notifyService('{string}', '{struct}');
+
+			blhqAdapter = createObject("component", "taffy.bonus.LogToBugLogHQ").init(
+				blhqSettings,
+				mockBLHQ
+			);
+
+			//fake error
+			fakeError.message = "This is a test error";
+			fakeError.detail = "Rubber Baby Buggy Bumper";
+			blhqAdapter.log(fakeError);
+
+			mockBLHQ.verify().notifyService('{string}', '{struct}');
+		}
+
+	</cfscript>
+</cfcomponent>