initialize the journey builder custom hello world repo

Author: creatovisguru

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+*.swp
+*.swo
+*.log

README.md

@@ -0,0 +1,9 @@
+# Journey Builder
+## Custom Interaction
+###Hello World
+
+**NOTE:** You won't be able to run this locally. It is intended to be ran on a publicly available web server/cloud only.
+
+**NOTE:** This app and the associated code is NOT production quality, its pure purpose is to demonstrate the full flow of custom interactions in Journey Builder
+
+

app.js

@@ -0,0 +1,176 @@
+'use strict';
+// Module Dependencies
+// -------------------
+//require('newrelic');
+var express     = require('express');
+var fs          = require('fs');
+var http        = require('http');
+var JWT         = require('./lib/jwtDecoder');
+var path        = require('path');
+var request     = require('request');
+var routes      = require('./routes');
+var activity    = require('./routes/activity');
+var trigger     = require('./routes/trigger');
+
+var app = express();
+
+// Register configs for the environments where the app functions
+// , these can be stored in a separate file using a module like config
+var APIKeys = {
+    appId           : '__insert_your_app_id__',
+    clientId        : '__insert_your_app_client_id__',
+    clientSecret    : '__insert_your_app_client_secret__',
+    appSignature    : '__insert_your_app_signature__',
+    authUrl         : 'https://auth.exacttargetapis.com/v1/requestToken?legacy=1'
+};
+
+// Simple custom middleware
+function tokenFromJWT( req, res, next ) {
+    // Setup the signature for decoding the JWT
+    var jwt = new JWT({appSignature: APIKeys.appSignature});
+    
+    // Object representing the data in the JWT
+    var jwtData = jwt.decode( req );
+
+    // Bolt the data we need to make this call onto the session.
+    // Since the UI for this app is only used as a management console,
+    // we can get away with this. Otherwise, you should use a
+    // persistent storage system and manage tokens properly with
+    // node-fuel
+    req.session.token = jwtData.token;
+    next();
+}
+
+/**
+THIS IS A WORKAROUND FOR A KNOWN BUG, DO NOT USE THIS CODE IN PRODUCTION
+**/
+function workaround( req, res, next ) {
+	if( 'POST' !== req.method ) {
+		next();
+	}
+
+	if( '/login' === req.url || '/fireEvent/helloWorld' === req.url ) {
+		next();
+	}
+	
+	if( 
+		'/ixn/activities/hello-world/save/'		=== req.url ||
+		'/ixn/activities/hello-world/execute/'	=== req.url ||
+		'/ixn/activities/hello-world/publish/'	=== req.url ||
+		'/ixn/activities/hello-world/validate/' === req.url
+	){
+		var buf = '';
+		req.on('data', function(chunk){
+			buf += chunk;
+		});
+
+		req.on('end', function(){
+			try{
+				var faultyJSON = /"", *}/;
+				// Cleanup Jira: JB-5249
+				if( buf.match( faultyJSON ) ) {
+					req.body = buf.replace( faultyJSON, '""}' );
+				}
+				next();
+			} catch( err ){
+				console.error( 'ERROR: ', err );
+				next( err );
+			}
+			next();
+		});
+	}
+}
+
+// Use the cookie-based session  middleware
+app.use(express.cookieParser());
+
+// TODO: MaxAge for cookie based on token exp?
+app.use(express.cookieSession({secret: "HelloWorld-CookieSecret"}));
+
+// Configure Express
+app.set('port', process.env.PORT || 3000);
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', 'jade');
+app.use(express.logger('dev'));
+app.use(workaround);
+app.use(express.json());
+app.use(express.urlencoded());
+app.use(express.methodOverride());
+app.use(express.favicon());
+app.use(app.router);
+app.use(express.static(path.join(__dirname, 'public')));
+
+// Express in Development Mode
+if ('development' == app.get('env')) {
+  app.use(express.errorHandler());
+}
+
+// HubExchange Routes
+app.get('/', routes.index );
+app.post('/login', tokenFromJWT, routes.login );
+app.post('/logout', routes.logout );
+
+// Custom Hello World Activity Routes
+app.post('/ixn/activities/hello-world/save/', activity.save );
+app.post('/ixn/activities/hello-world/validate/', activity.validate );
+app.post('/ixn/activities/hello-world/publish/', activity.publish );
+app.post('/ixn/activities/hello-world/execute/', activity.execute );
+
+// Custom Hello World Trigger Route
+app.post('/ixn/triggers/hello-world/', trigger.edit );
+
+// Abstract Event Handler
+app.post('/fireEvent/:type', function( req, res ) {
+    var data = req.body;
+    var triggerIdFromAppExtensionInAppCenter = 'helloWorldNTO';
+    var JB_EVENT_API = 'https://www.exacttargetapis.com/interaction-experimental/v1/events';
+    var reqOpts = {};
+
+    if( 'helloWorld' !== req.params.type ) {
+        res.send( 400, 'Unknown route param: "' + req.params.type +'"' );
+    } else {
+        // Hydrate the request
+        reqOpts = {
+            url: JB_EVENT_API,
+            method: 'POST',
+            headers: {
+                'Authorization': 'Bearer ' + req.session.token
+            },
+            body: JSON.stringify({
+                ContactKey: data.alternativeEmail,
+                EventDefinitionKey: triggerIdFromAppExtensionInAppCenter,
+                Data: data
+            })
+        };
+
+        request( reqOpts, function( error, response, body ) {
+            if( error ) {
+                console.error( 'ERROR: ', error );
+                res.send( response, 400, error );
+            } else {
+                res.send( body, 200, response);
+            }
+        }.bind( this ) );
+    }
+});
+
+app.get('/clearList', function( req, res ) {
+	// The client makes this request to get the data
+	activity.logExecuteData = [];
+	res.send( 200 );
+});
+
+
+// WORKAROUND FOR ACTIVITY COMMA BUG
+app.get('/getActivityData', function( req, res ) {
+	// The client makes this request to get the data
+	if( !activity.logExecuteData.length ) {
+		res.send( 200, {data: null} );
+	} else {
+		res.send( 200, {data: activity.logExecuteData} );
+	}
+});
+
+http.createServer(app).listen(app.get('port'), function(){
+  console.log('Express server listening on port ' + app.get('port'));
+});

lib/jwtDecoder.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var jwtLib = require('jwt-simple');
+var packageJson = require('../package.json');
+
+var VERSION = packageJson.version;
+
+var JwtDecoder = module.exports = function JwtDecoder( options ) {
+    this.options = options || {};
+};
+
+JwtDecoder.VERSION = VERSION;
+
+JwtDecoder.prototype.decode = function( req ) {
+    var jwtObj = {};
+    var jwt = req.body.jwt;
+
+    try {
+        var decoded         = jwtLib.decode( jwt, this.options.appSignature );
+        jwtObj.full         = decoded;
+        jwtObj.token        = decoded.request.user.oauthToken;
+        jwtObj.refreshToken = decoded.request.user.refreshToken;
+        jwtObj.casToken     = decoded.request.user.internalOauthToken;
+        jwtObj.culture      = decoded.request.user.culture;
+        jwtObj.timezone     = decoded.request.user.timezone; //OBJECT
+        jwtObj.expires      = ( decoded.request.user.expiresIn * 1000 ) - 60000;
+    } catch( ex ) {
+        console.error( 'Decoding failed for jwt: ' + jwt );
+        console.error( 'Exception: ' + ex );
+    }
+
+    return jwtObj;
+};

newrelic.js

@@ -0,0 +1,24 @@
+/**
+ * New Relic agent configuration.
+ *
+ * See lib/config.defaults.js in the agent distribution for a more complete
+ * description of configuration variables and their potential values.
+ */
+exports.config = {
+  /**
+   * Array of application names.
+   */
+  app_name : ['__insert_name_of_your_app__'],
+  /**
+   * Your New Relic license key.
+   */
+  license_key : '__insert_newrelic_key_here__',
+  logging : {
+    /**
+     * Level at which to log. 'trace' is most useful to New Relic when diagnosing
+     * issues with the agent, 'info' and higher will impose the least overhead on
+     * production applications.
+     */
+    level : 'info'
+  }
+};

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "helloWorldInteractionExample",
+  "version": "0.0.3",
+  "private": true,
+  "scripts": {
+    "start": "node app.js"
+  },
+  "dependencies": {
+    "express": "3.4.8",
+    "jade": "*",
+    "fuel": "~0.4.1",
+    "require": "~0.5.0",
+    "jwt-simple": "~0.1.0",
+    "newrelic": "~1.3.1",
+    "request": "~2.33.0"
+  },
+  "engines": {
+    "node": "0.10.7"
+  }
+}

public/ixn/activities/hello-world/config.js

@@ -0,0 +1,57 @@
+define([], function(){      
+    return {
+        "icon": "images/jb-icon.jpg",
+        "iconSmall": "images/jb-icon.jpg", 
+        "key": "insert_your_custom_app_extension_activity_name",
+        "partnerApiObjectTypeId": "IXN.CustomActivity.REST",
+        "lang": {
+            "en-US": {        
+                "name": "Hello World",
+                "description": "Activity simply posts the data into an array for display on the App's home page."
+            }
+        },
+        "category": "messaging",
+        "version": "1.0",
+        "apiVersion": "1.0",
+       "execute": {
+            "uri": "https://__insert_your_custom_activity_endpoint__/ixn/activities/hello-world/execute/",
+			"inArguments": [],
+			"outArguments": [],
+            "verb": "POST",
+			"body": "",
+            "format": "json",
+            "useJwt": false,
+            "timeout": 3000
+		},
+        "save": {
+            "uri": "https://__insert_your_custom_activity_endpoint__/ixn/activities/hello-world/save/",
+			"verb": "POST",
+			"body": "",
+            "format": "json",
+            "useJwt": false,
+            "timeout": 3000
+        },
+        "publish": {
+            "uri": "https://__insert_your_custom_activity_endpoint__/ixn/activities/hello-world/publish/",
+            "verb": "POST",
+			"body": "",
+            "format": "json",
+            "useJwt": false,
+            "timeout": 3000
+        },
+        "validate": {
+            "uri": "https://__insert_your_custom_activity_endpoint__/ixn/activities/hello-world/validate/",
+            "verb": "POST",
+			"body": "",
+            "format": "json",
+            "useJwt": false,
+            "timeout": 3000
+        },
+
+        "edit": {
+            "uri": "https://__insert_your_custom_activity_endpoint__/ixn/activities/hello-world/",
+            "height": 400,
+            "width": 500
+        }
+};
+});

public/ixn/activities/hello-world/css/styles.css

@@ -0,0 +1,8 @@
+body {
+    margin: 0px;
+    padding: 0px;
+}
+
+#container {
+    margin: 30px;
+}