ymdp 0.3.1 → 0.4.0

data/lib/ymdp/javascripts/i18n.js

@@ -0,0 +1,242 @@
+
+  // 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.
+
+/*
+	  I18N
+  
+	  global to every view.  
+	
+	  Methods and constants dealing with internationalization.
+*/
+
+var I18N, I18n;
+
+/* set asset version */
+
+I18N = {
+  VERSION: "<%= @hash %>",
+  MESSAGE: "<%= @message %>",
+  DEPLOYED: <%= Time.now.to_i %>,
+  DEPLOYED_STRING: "<%= Time.now.to_s %>"
+};
+
+
+I18n = {};
+
+I18n.setResources = function() {
+  var scope, asset_path;
+  
+  Debug.log("begin I18n.setResources for language " + I18n.currentLanguage);
+  try {
+	  asset_path = "<%= @assets_directory %>/yrb/";
+		I18n.keys = I18n.keys || OpenMailIntl.getResources(asset_path, "keys", I18n.currentLanguage);
+	  if (I18n.currentLanguage !== "en-US") {
+  		I18n.default_keys = OpenMailIntl.getResources(asset_path, "keys", "en-US");
+		} else {
+		  I18n.default_keys = I18n.keys;
+		}
+	} catch(err) {
+	  Debug.error("error in I18n.setResources: " + err);
+	}
+	I18n.scope = "keys";
+};
+
+I18n.english = function() {
+  return I18n.currentLanguage.match(/^en/);
+};
+
+
+// I18n.translate(key, [args])
+// I18n.t(key, [args])
+//
+// Using .translate with a single key argument will return the simple translated string for that key
+//
+// Using a key argument with values after it will insert the values into the placeholders in
+// the returned translated string
+//
+I18n.translate = function(key, args) {
+	var m;
+
+	key = key.toUpperCase();
+	key = key.replace(" ", "_");
+
+	if (args) {
+		m = I18n.translate_sentence(key, args);
+	} else
+	{
+		m = I18n.translate_phrase(key);
+		if (!m) {
+			m = I18n.default_keys[key];
+		}
+	}
+	return m;
+};
+I18n.t = I18n.translate;
+
+I18n.translate_phrase = function(key) {
+	return I18n["keys"][key];
+};
+
+I18n.translate_sentence = function(key, args) {
+  return OpenMailIntl.formatMessage(I18n.keys[key], args, I18n.currentLanguage);
+};
+
+// I18n.update(id, scope, key, args)
+//
+// updates an element with the given _id_ with the
+// translation from scope, key and optional args
+//
+// only updates the element if the translation is not blank
+//
+I18n.update = function(id, key, args) {
+  Try.these(function() {
+    var message;
+    message = I18n.t(key, args);
+    if (message) {
+      $(id).update(message);
+    }
+  }, function() {
+    Debug.error("Error in i18n.update: " + Object.toJSON({
+      id: id,
+      key: key,
+      args: args
+    }));
+  });
+};		
+
+// I18n.u(id, args)
+//
+// updates an element with a local YRB key of the same name
+//
+// given an id of "messages" it will look for a YRB key named "MESSAGES"
+// within the local scope of the current view, and update the element with
+// that translation
+//
+I18n.u = function(id, args) {
+  Try.these(
+	function() {
+	  id.each(I18n.u);
+	},
+	function() {
+    var key;
+    key = id.toUpperCase();
+    I18n.update(id, key, args);
+  },
+  function() {
+    Debug.error("Error in i18n.u: " + Object.toJSON({
+      id: id,
+      args: args
+    }));
+  });
+};
+
+		
+// I18n.updateValue(id, key, args)
+//
+// updates an element with the given _id_ with the
+// translation from scope, key and optional args
+//
+// only updates the element if the translation is not blank
+//
+I18n.updateValue = function(id, key, args) {
+  Try.these(function() {
+    var message;
+    message = I18n.t(key, args);
+    if (message) {
+      $(id).value = message;
+    }
+  }, function() {
+    Debug.error("Error in i18n.updateValue: " + Object.toJSON({
+      id: id,
+      key: key,
+      args: args
+    }));
+  });
+};		
+
+		
+// I18n.v(id, args)
+//
+// updates the value of an element with a local YRB key of the same name
+//
+// given an id of "messages" it will look for a YRB key named "MESSAGES"
+// within the local scope of the current view, and update the element's value with
+// that translation
+//
+I18n.v = function(id, args) {
+  Try.these(
+	function() {
+		id.each(I18n.v);
+	},
+	function() {
+    var key;
+    key = id.toUpperCase();
+    I18n.updateValue(id, key, args);
+  },
+  function() {
+    Debug.error("Error in i18n.v: " + Object.toJSON({
+      id: id,
+      args: args
+    }));
+  });
+};
+
+I18n.translateError = function() {
+  I18n.update('error_1', 'ERROR_1');
+  I18n.update('error_2', 'ERROR_2');
+  I18n.update('retry', 'RETRY');
+};
+
+I18n.translateLoading = function() {
+  I18n.update('loading_subhead', 'LOADING_SUBHEAD');
+  I18n.update('loading_paragraph_1', 'LOADING_PARAGRAPH_1');
+};
+
+I18n.addLanguageToBody = function() {
+  Try.these(function() {
+    $$('body').first().addClassName(I18n.currentLanguage);
+  });
+};
+
+I18n.findAndTranslateAll = function() {
+  Debug.log("I18n.findAndTranslateAll");
+  Element.addMethods({
+    translate: function(element) {
+      element = $(element);
+      
+      var e;
+      e = element.inspect();
+      if (e.match(/<input/)) {
+        I18n.v(element.identify());
+      } else {
+        if (e.match(/<img/)) {
+          I18n.src(element.identify());
+        } else {
+    			I18n.u(element.identify());
+  			}
+			}
+    }
+  });
+  
+	$$('.t').each(function(element) {
+	  try {
+     element.translate();
+    } catch(e) {
+      Debug.error("Translation error for element: " + e);
+    }
+	});
+};
+
+I18n.translateSidebar = function() {
+	I18n.u('faq_q1');
+	var link;
+	link = Tags.a(I18n.t('faq_link1'), {"href": 'http://go.otherinbox.com/q-custom-sender', "target": "_blank"});
+	I18n.u('faq_a1', [link]);
+	
+	I18n.u('faq_q2');
+	link = Tags.a(I18n.t('faq_link2'), {"href": 'http://go.otherinbox.com/q-stop-sender', "target": "_blank"});
+	I18n.u('faq_a2', [link]);
+};
+
+

data/lib/ymdp/javascripts/init.js

@@ -0,0 +1,159 @@
+/* 
+
+INITIALIZER CODE
+
+*/
+
+// Adds behaviors/observers to elements on the page
+//
+YAHOO.init.addBehaviors = function() {
+	// overwrite this function locally
+};
+
+// hide the loading screen and show the main body of the summary
+YAHOO.init.show = function() {
+  Debug.log("YAHOO.init.show");
+  try {
+    $('utility').hide();
+    $('error').hide();
+  	$('loading').hide();
+    $('main').show();
+  } catch(e) {
+    Debug.error("Error in YAHOO.init.show", e);
+  }
+};
+
+
+// Local initializer.  When your page starts up, this method will be called after fetching the user's guid and ymail wssid.
+//
+YAHOO.init.local = function() {
+  throw("This hasn't been overwritten.");
+	// overwrite this function locally
+};
+
+// To be run before any other initializers have run.
+//
+YAHOO.init.before = function() {
+	// overwrite this function locally
+};
+
+// Main startup code. Overwrite this function to execute after YAHOO.init.before and before YAHOO.init.after.
+//
+YAHOO.init.startup = function() {
+  Debug.log("init.startup");
+	// gets the user
+	YAHOO.oib.getGuid(function(guid) {
+	  try {
+  	  Reporter.reportCurrentView(guid);
+	  } catch(omg) {
+	    Debug.error(omg);
+	  }
+    YAHOO.init.local();
+  });
+};
+
+YAHOO.init.abTesting = function() {
+  // to enable abTesting in your view, overwrite this file locally.
+  // 
+  // be sure to finish your post-Ajax callback with YAHOO.init.show()
+  //
+  Try.these(YAHOO.init.show);
+	Try.these(YAHOO.init.after);
+};
+
+// Finishing code. Runs after startup, executes translations and behaviors.  Shows the page and then 
+// runs the A/B testing callback, which in turn will execute the last callbacks.
+//
+YAHOO.init.finish = function() {
+  try {
+    Debug.log("init.finish for view " + View.name);
+  	Try.these(YAHOO.oib.showTranslations);
+  	Try.these(YAHOO.init.addBehaviors);
+    Try.these(YAHOO.init.abTesting);
+    YAHOO.oib.page_loaded = true;
+    Debug.log("finished init.finish for view " + View.name);
+  } catch(omg) {
+    Debug.error("Error in YAHOO.init.finish", omg);
+    YAHOO.oib.showError({
+      "method": "YAHOO.init.finish",
+      "description": "exception caught in YAHOO.init.finish",
+      "error": omg
+    });
+  }
+};
+
+// Post-initalizer. Very last thing that runs, after content has been shown.
+//
+YAHOO.init.after = function() {
+	// overwrite this function locally
+};
+
+// Execute the before, startup and after methods. Do not overwrite. (Change YAHOO.init.startup to create a custom initializer.)
+YAHOO.oib.init = function() {
+  Debug.log("OIB.init for view " + View.name, "<%= @message %>");
+  try {
+    YAHOO.init.browser();
+    YAHOO.init.resources();
+    I18n.addLanguageToBody();
+    I18n.translateLoading();
+    I18n.translateError();
+    YAHOO.init.before();
+    YAHOO.init.startup();
+  } catch(err_f) {
+    YAHOO.oib.showError({
+      "method": "YAHOO.oib.init",
+      "description": "exception caught in YAHOO.oib.init",
+      "error": err_f
+    });
+    Debug.error("Error in YAHOO.oib.init", err_f);
+  }
+};
+
+YAHOO.init.browser = function() {
+  if (Prototype.Browser.WebKit) {
+    $$('body').first().addClassName('webkit');
+  }
+};
+
+YAHOO.init.resources = function() {
+  Debug.log("about to call I18n.setResources");
+
+  I18n.availableLanguages = <%= supported_languages.to_json %>;
+
+  I18n.currentLanguage = OpenMailIntl.findBestLanguage(I18n.availableLanguages);
+  
+  I18n.setResources();
+
+  Debug.log("finished calling I18n.setResources");
+};
+
+// Contains the last two callbacks, to show the page contents and run post-show function.  Do not overwrite.
+YAHOO.init.showAndFinish = function() {
+  Debug.log("YAHOO.init.showAndFinish");
+  YAHOO.init.show();
+  YAHOO.init.after();
+};
+
+YAHOO.init.translateToolbar = function() {
+  Debug.log("begin YAHOO.init.translateToolbar");
+  // will we have a toolbar?
+  Debug.log("end YAHOO.init.translateToolbar");
+};
+
+YAHOO.init.translateGreeting = function() {
+  Debug.log("begin YAHOO.init.translateGreeting");
+};
+
+YAHOO.init.translateSubhead = function() {
+  Debug.log("YAHOO.init.translateSubhead");
+};
+
+
+YAHOO.init.translateFooter = function() {
+  I18n.update('copyright', 'COPYRIGHT');
+  I18n.update('about_link', 'ABOUT');
+  I18n.update('support_link', 'SUPPORT');
+  I18n.update('contact_link', 'CONTACT');
+  I18n.update('privacy_link', 'PRIVACY');
+  I18n.update('terms_and_conditions_link', 'TERMS_AND_CONDITIONS');
+};

data/lib/ymdp/javascripts/launcher.js

@@ -0,0 +1,131 @@
+/*
+  LAUNCHING
+ 
+  global to every view.  launches new views and closes the current one.
+
+  // 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 LAUNCHER, Launcher;
+
+LAUNCHER = {
+  VERSION: "<%= @hash %>",
+  MESSAGE: "<%= @message %>",
+  DEPLOYED: <%= Time.now.to_i %>,
+  DEPLOYED_STRING: "<%= Time.now.to_s %>"
+};
+
+YAHOO.namespace("launcher");
+
+
+YAHOO.launcher.launch = function(view, title, type) {
+  openmail.Application.getParameters(function(response) {
+  	title = I18n.t("APPLICATION_NAME");
+		// don't try to relaunch current tab
+		if (response.data === null || response.data.view !== view) {
+			openmail.Application.openView(
+			{
+				id: view, 
+				view: view, 
+				target: type, 
+				title: title,
+				parameters: {
+				  launchParams: Params.parameters,
+				  view: view
+				}
+			});
+			openmail.Application.closeView(null);
+		}
+	});
+};
+
+
+YAHOO.launcher.launchTab = function(view, title) {
+	YAHOO.launcher.launch(view, title, "tab");
+};
+
+// User must be signed in for this page, we'll 
+// sign them in if they don't have an OIB cookie
+//
+YAHOO.launcher.launchActiveTab = function(view, title) {
+ YAHOO.launcher.launchView(function() {
+   YAHOO.launcher.launchTab(view, title);
+  });
+};
+
+	
+YAHOO.launcher.launchView = function(launch_view) {
+  // get Yahoo! user's guid and ymail_wssid
+  YAHOO.oib.getGuidAndYmailWssid(function(guid, ymail_wssid) {
+	 				
+    // call /ymdp/verify and return data about the user
+    YAHOO.oib.verifyUser(function(user) {
+
+      YAHOO.oib.login = user.login;
+	  
+  	  switch(user.state) {
+  	    case "scanning":
+  	      // formerly known as 'inspect'
+          YAHOO.launcher.launchMain();
+          break;
+   	    case "authorized":
+  	      // authorized but not yet 'signed in'
+           YAHOO.oib.signInUser();
+           break;
+         case "new_active":
+           // no messages processed yet
+         case "processing":
+           // activated but we have synced fewer than 80% of their messages
+  	    case "active":
+  	      // active, launch the view this method was intended for
+  	      if (View.authorized(user)) {
+    	      launch_view();
+  	      } else {
+  	        YAHOO.launcher.launchAuthorize();
+  	      }
+  	      break;
+  	    default:
+  	      // other
+  	      YAHOO.launcher.launchAuthorize();
+  	  }
+    });
+  });
+};
+
+
+YAHOO.launcher.launchAuthorize = function() {
+  YAHOO.launcher.launchTab("authorize", "Authorize");
+};
+
+YAHOO.launcher.launchDeactivate = function() {
+  YAHOO.launcher.launchHidden("deactivate", "Deactivate");
+};
+
+YAHOO.launcher.launchHidden = function(view, title) {
+	YAHOO.launcher.launch(view, title, "hidden");
+};
+
+YAHOO.launcher.l = function(view) {
+	view = "launch" + view.capitalize();
+	YAHOO.launcher[view]();
+};
+
+YAHOO.launcher.launchGoodbye = function() {
+  YAHOO.launcher.launchTab("goodbye", "Goodbye");
+};
+
+YAHOO.launcher.relaunchAuthorize = YAHOO.launcher.launchAuthorize;
+
+YAHOO.launcher.launchMaintenance = function() {
+  YAHOO.launcher.launchTab("maintenance", "Maintenance");
+};
+
+YAHOO.launcher.launchReauthorize = function() {
+  YAHOO.launcher.launchTab("reauthorize", "Reauthorize");
+};
+
+Launcher = YAHOO.launcher;