ymdp 0.3.1 → 0.4.0

data/lib/ymdp/javascripts/logger.js

@@ -0,0 +1,64 @@
+/*
+	  YMDP LOGGER
+
+		Send logging messages to OIB. 
+		
+		Messages are saved in log/ymdp.log
+
+
+  // DO NOT USE the @view instance variable in any files in /app/javascripts/base.
+  // The way they are cached makes it not safe to do so.
+
+*/
+
+
+/* set asset version */
+
+var LOGGER, Logger;
+
+LOGGER = {
+  VERSION: "<%= @hash %>",
+  MESSAGE: "<%= @message %>",
+  DEPLOYED: <%= Time.now.to_i %>,
+  DEPLOYED_STRING: "<%= Time.now.to_s %>"
+};
+
+	YAHOO.namespace("logger");
+
+	YAHOO.logger.write = function(level, message) {
+		if (YAHOO.oib.login) {
+			message = "[login: " + YAHOO.oib.login + "] " + message;
+		}
+		if (YAHOO.oib.guid) {
+			message = "[guid: " + YAHOO.oib.guid + "] " + message;
+		}
+	  OIB.post("ymdp/log",
+	    {
+	      level: level,
+	      message: message
+	    },
+	    function(response) {
+	      // log message written successfully
+	  });
+	};
+	
+	YAHOO.logger.debug = function(message) {
+	  YAHOO.logger.write("debug", message);
+	};
+	YAHOO.logger.info = function(message) {
+	  YAHOO.logger.write("info", message);
+	};
+	YAHOO.logger.warn = function(message) {
+	  YAHOO.logger.write("warn", message);
+	};
+	YAHOO.logger.error = function(message) {
+	  YAHOO.logger.write("warn", message);
+	};
+	YAHOO.logger.fatal = function(message) {
+	  YAHOO.logger.write("fatal", message);
+	};
+	
+
+Logger = YAHOO.logger;	
+
+// END YMDP LOGGER

data/lib/ymdp/javascripts/params.js

@@ -0,0 +1,35 @@
+var Params = {
+  names: ["invitation", "page"],
+  parameters: {},
+  
+  init: function(launchParams) {
+    launchParams = launchParams || {};
+    Debug.log("Params.init", launchParams);
+    
+    try {
+      if (launchParams) {
+        Params.parameters = launchParams;
+      } else {
+        Params.parameters = {};
+      }
+    } catch(wtf) {
+      Debug.error(wtf);
+    }
+  },
+  
+  get: function(name) {
+    Debug.log("Params.get", name);
+    var index, result;
+    
+    try {
+      index = Params.names.indexOf(name);
+    
+      if (index >= 0) {
+        result = Params.parameters["param" + index];
+      }
+    } catch(wtf) {
+      Debug.error(wtf);
+    }
+    return result;
+  }
+};

data/lib/ymdp/javascripts/reporter.js

@@ -0,0 +1,47 @@
+// DO NOT USE the @view instance variable in any files in /app/javascripts/base.
+// The way they are cached makes it not safe to do so.
+
+var Reporter;
+
+// Reports pageviews to OIB for tracking counts of each pageview.
+//
+// The main interface to this class is located in "header.js" where it can
+// make use of the current view name.
+//
+// == Usage
+//
+//   Reporter.reportCurrentView(guid);
+//
+Reporter = {
+  error: function(guid, params) {
+    Debug.log("Reporter.error", params);
+    Reporter.report(guid, "error", params);
+  },
+  
+  reportCurrentView: function(guid) {
+    Reporter.report(guid, View.name);
+  },
+  
+  // Report the Ymail guid and page view name to OIB.
+  //
+  report: function(guid, view, params) {
+    params = params || {};
+    
+    params["ymail_guid"] = guid;
+    params["view"] = view;
+    
+    Debug.log("Reporting guid " + guid + ", view " + view);
+    // Reporter.post(params);
+  },
+  
+  // Post data back to OIB, to the URL /ymdp/report.
+  //
+  post: function(params) {
+    params = params || {};
+    OIB.post("ymdp/report", params, function(response) {
+      Debug.log("Reported page view", params);
+    }, function(response) {
+      Debug.error("Error reporting page view with params", response);
+    });
+  },
+};

data/lib/ymdp/javascripts/tag_helper.js

@@ -0,0 +1,182 @@
+/* TAG HELPERS */
+
+
+  // DO NOT USE the @view instance variable in any files in /app/javascripts/base.
+  // The way they are cached makes it not safe to do so.
+
+var Tags;
+
+function tagHelper(tag_name, text, options) {
+  var m, opts;
+  
+  m = "";
+  opts = "";
+  
+  Object.keys(options).each(function(key) {
+    opts = opts + " " + key + "='" + options[key] + "'";
+  });
+  
+  m = m + "<" + tag_name + " " + opts + ">";
+  m = m + text;
+  m = m + "<\/" + tag_name + ">";
+  return m;
+}
+
+function optionTag(text, options) {
+  return tagHelper("option", text, options);
+}
+
+function selectTag(text, options) {
+  return tagHelper("select", text, options);
+}
+
+function spanTag(text, options) {
+  return tagHelper("span", text, options);
+}
+
+function liTag(text, options) {
+	return tagHelper("li", text, options);
+}
+
+function divTag(text, options) {
+  return tagHelper("div", text, options);
+}
+
+function tdTag(text, options) {
+  return tagHelper("td", text, options);
+}
+
+function inputTag(value, options) {
+  options['value'] = value;
+  return tagHelper("input", "", options);
+}
+
+function textField(value, options) {
+  return inputTag(value, options);
+}
+
+function submitTag(value, options) {
+  options['type'] = 'submit';
+  return inputTag(value, options);
+}
+
+function optionsForSelect(options, selected) {
+  var m;
+  m = "";
+  options.each(function(option) {
+    var key, value, opts;
+    
+    if (Object.isArray(option)) {
+      key = option[0];
+      value = option[1];
+    } else {
+      key = option;
+      value = option;
+    }
+    
+    opts = {
+      value: value
+    };
+    
+    if (key === selected) {
+      opts.selected = 'selected';
+    }
+    
+    m = m + optionTag(key, opts);
+  });
+  return m;
+}
+
+Tags = {
+	create: function(tag_name, text, options) {
+		options = options || {};
+		var m, opts;
+		
+		m = "";
+	  opts = "";
+  
+		Object.keys(options).each(function(key) {
+			if (options[key]) {
+		    opts = opts + " " + key + "='" + options[key] + "'";
+			}
+	  });
+  
+	  m = m + "<" + tag_name + " " + opts + ">";
+	  m = m + text;
+	  m = m + "<\/" + tag_name + ">";
+	  return m;
+	},
+	
+	input: function(value, options) {
+		options = options || {};
+		options["value"] = value;
+		options["name"] = options["name"] || "";
+		options["id"] = options["id"] || options["name"];
+				
+		return Tags.create("input", "", options);
+	},
+	
+	hiddenInput: function(value, options) {
+		options = options || {};
+		options["type"] = "hidden";
+		return Tags.input(value, options);
+	},
+	
+	checkBox: function(name, options) {
+		options = options || {};
+		var check_box, hidden_options, hidden_check_box;
+		
+		options["type"] = "checkbox";
+		options["name"] = name;
+		
+		if (options["checked"]) {
+			options["checked"] = "checked";
+		} else {
+			options["checked"] = undefined;
+		}
+		
+		check_box = Tags.input("1", options);
+		
+		hidden_options = {
+			"name": name
+		};
+		hidden_check_box = Tags.hiddenInput("0", hidden_options);
+		
+		return check_box + " " + hidden_check_box;
+	},
+	
+	submit: function(value, options) {
+	  options = options || {};
+	  options["value"] = value;
+	  options["id"] = options["id"] || options["name"];
+	  options["type"] = "submit";
+	  return Tags.input(value, options);
+	},
+	
+	linkToFunction: function(value, onclick, options) {
+	  options = options || {};
+	  var jv;
+	  
+	  jv = "#";
+    options["href"] = options["href"] || jv;
+	  options["onclick"] = onclick;
+	  return Tags.a(value, options);
+	},
+	
+	div: function(text, options) {
+	  return new Element('div', options).update(text);
+	},
+	
+	init: function() {
+		$w("li ol ul span div p a option select strong table th tr td").each(function(tag_name) {
+			Tags[tag_name] = function(text, options) {
+				options = options || {};
+				return Tags.create(tag_name, text, options);
+			};
+		});		
+	}
+};
+
+Tags.init();
+
+/* END TAG HELPERS */

data/lib/ymdp/javascripts/user.js

@@ -0,0 +1,207 @@
+// gets both guid and ymail_wssid and stores them then runs the callback_function
+//
+// YAHOO.oib.ymail_wssid
+// YAHOO.oib.guid
+//
+YAHOO.oib.getGuidAndYmailWssid = function(callback_function) {
+  Debug.log("YAHOO.oib.getGuidAndYmailWssid");
+	YAHOO.oib.getGuid(function(guid) {
+		YAHOO.oib.getYmailWssid(function(ymail_wssid) {
+			callback_function(guid, ymail_wssid);
+		});
+	});
+};
+
+// gets user's state info from /ymdp/state
+// including the user's OIB login
+//
+YAHOO.oib.getUserState = function(success_function) {
+  Debug.log("YAHOO.oib.getUserState");
+	OIB.get("ymdp/state", {}, function(response) {
+	  Debug.log("YAHOO.oib.getUserState callback", response);
+	  YAHOO.oib.response = response;
+    try {
+          YAHOO.oib.since_date = formatUnixDate(YAHOO.oib.response.since_date.s);
+        } catch(omg) {
+          YAHOO.oib.since_date = 1294869484;
+        }
+	  YAHOO.oib.login = response.login;
+	  YAHOO.oib.state = response.state;
+
+	  if (success_function) {
+	    Debug.log("YAHOO.oib.getUserState: About to success function")
+	    success_function(response);
+	  }
+	},
+	function() {
+	  YAHOO.logger.error("Failed to get user's state");
+	});
+};
+
+
+
+/*
+	  YAHOO.oib.verifyUser
+
+	  global to all views.  calls the 'verify' action on ymdp controller and executes
+	  a function with the result.
+*/
+YAHOO.oib.verifyUser = function(success_function, error_function) {
+  Debug.log("YAHOO.oib.verifyUser");
+  
+  OIB.get("ymdp/verify", {
+    ymail_guid: YAHOO.oib.guid,
+    ymail_wssid: YAHOO.oib.ymail_wssid,
+    application: View.application
+  }, function(response) {
+    YAHOO.oib.user = response;
+    Debug.log("YAHOO.oib.verifyUser YAHOO.oib.user", YAHOO.oib.user);
+    if (success_function) {
+      Debug.log("YAHOO.oib.verifyUser: About to success function");
+      success_function(YAHOO.oib.user);
+    }
+  }, error_function);
+};
+
+
+/*
+		AUTHENTICATION
+*/
+
+YAHOO.oib.signInUser = function() {
+  Debug.log("YAHOO.oib.signInUser");
+	OIB.get("ymdp/signin", {}, function(response) {  
+	  Debug.log("inside ymdp/signin callback", response);
+	  Debug.log("YAHOO.oib.response", YAHOO.oib.response);
+    if (response.ymail_wssid === "false") {
+      // signin didn't work properly, display an error
+      Debug.log("YAHOO.oib.response was false");
+      YAHOO.oib.showError({
+        "method": "YAHOO.oib.signInUser",
+        "description": "no ymail_wssid"
+      });
+    } else {
+      Debug.log("YAHOO.oib.response wasn't false");
+      // store ymail_wssid in permanent store
+      
+      var raw_wssid = response.ymail_wssid || "";
+      var sliced_wssid = raw_wssid.slice(0, 255);
+      
+      var data = {
+        "ymail_wssid": sliced_wssid
+      };
+      
+      Debug.log("About to call Data.sore", data);
+      
+      Data.store(data);
+      YAHOO.oib.ymail_wssid = response.ymail_wssid;
+  
+      YAHOO.oib.verifyUser(YAHOO.launcher.launchMain);
+    }
+	});
+};
+
+
+// gets the guid from the Yahoo! environment and executes the success callback
+// if there is a guid, and the error callback if it's undefined
+//
+// YAHOO.oib.guid
+//
+YAHOO.oib.getGuid = function(success_function, error_function) {
+  Debug.log("YAHOO.oib.getGuid");
+  
+  openmail.Application.getParameters(function(response) {
+    YAHOO.oib.guid = response.user.guid;
+    try {
+      Debug.log("YAHOO.oib.getGuid getParameters response", response);
+      
+      var params = {};
+      if (response.data) {
+        params = response.data.launchParams;
+      }
+      Params.init(params);
+    } catch(omg) {
+      Debug.error("error getting parameters: " + omg);
+    }
+		if (YAHOO.oib.guid !== undefined) {
+    	Try.these(
+				function() { success_function(YAHOO.oib.guid); }
+			);
+		}
+		else {
+			Try.these(error_function);
+		}
+  });
+};
+
+
+// gets the ymail_wssid from the permanent store and executes the callback function
+// if there is a ymail_wssid, and the error callback if it's undefined
+//
+// YAHOO.oib.ymail_wssid
+//
+YAHOO.oib.getYmailWssid = function(success_function, error_function) {
+  Debug.log("YAHOO.oib.getYmailWssid");
+  
+  // this function will show the error page if the ymail_wssid has not been set
+  //
+  var show_error = function() {
+    if (YAHOO.oib.ymail_wssid === undefined) {
+      Debug.log("No YAHOO.oib.ymail_wssid");
+      
+      YAHOO.oib.showError({
+        "retry": "hide"
+      });
+    } else {
+      Debug.log("YAHOO.oib.ymail_wssid does exist", YAHOO.oib.ymail_wssid);
+    }
+  };
+  
+  // run the show_error function after 5 seconds
+  //
+  Debug.log("Set timeout for error function to 5 seconds");
+  YAHOO.oib.setTimeoutInSeconds(show_error, 5);
+  Debug.log("About to call Data.fetch");
+  
+  // retrieve the user's ymail_wssid and store it in YAHOO.oib.ymail_wssid
+  //
+	Data.fetch(["ymail_wssid"], function(response) {
+	  Debug.log("Inside Data.fetch callback");
+    YAHOO.oib.ymail_wssid = response.data.ymail_wssid;
+		if (YAHOO.oib.ymail_wssid !== undefined) {
+		  Debug.log("YAHOO.oib.ymail_wssid is defined", YAHOO.oib.ymail_wssid);
+		  
+		  try {
+        success_function(YAHOO.oib.ymail_wssid);
+		  } catch(omg) {
+		    Debug.error("Error in YAHOO.oib.getYmailWssid getData callback", omg);
+		  }
+		  
+		}
+		else {
+			Try.these(error_function);
+		}
+	});
+};
+
+YAHOO.oib.deactivateUser = function() {
+	YAHOO.oib.getGuidAndYmailWssid(function() {
+	  var guid, ymail_wssid;
+	  
+	  guid = YAHOO.oib.guid;
+	  ymail_wssid = YAHOO.oib.ymail_wssid;
+
+    Data.clear();
+
+	  OIB.post("/ymdp/deactivate", {
+			"ymail_guid": guid,
+			"ymail_wssid": ymail_wssid
+		}, 
+		function(response) {
+      // YAHOO.logger.info("Finished deactivating user");
+		  if (View.name !== "deactivate") {
+			  YAHOO.launcher.launchGoodbye();
+		  }
+		});
+	});
+};