ymdp 0.6.0 → 0.7.0

data/lib/ymdp/javascripts/jquery/user.js

@@ -0,0 +1,210 @@
+// gets user's state info from /ymdp/state
+// including the user's OIB login
+//
+YMDP.getUserState = function(success_function, error_function) {
+  Debug.log("YMDP.getUserState");
+	OIB.get("ymdp/state", {}, function(response) {
+	  Debug.log("YMDP.getUserState callback", response);
+    YMDP.setUserVariables(response);
+
+	  if (success_function) {
+	    Debug.log("YMDP.getUserState: About to success function")
+	    success_function(response);
+	  }
+	},
+	function() {
+    Debug.log("Failed to get user's state");
+    if (error_function) {
+      error_function();
+    }
+	});
+};
+
+YMDP.setUserVariables = function(response) {
+  YMDP.response = response;
+  try {
+    YMDP.since_date = formatUnixDate(YMDP.response.since_date.s);
+  } catch(omg) {
+    YMDP.since_date = 1294869484;
+  }
+  YMDP.login = response.login;
+  YMDP.state = response.state;
+};
+
+/*
+	  YMDP.verifyUser
+
+	  global to all views.  calls the 'verify' action on ymdp controller and executes
+	  a function with the result.
+	  
+	  Sends the server the user's guid and 'ymail_wssid', which signs the user in if the
+	  values match what we have in the database.
+*/
+YMDP.verifyUser = function(success_function, error_function) {
+  Debug.log("YMDP.verifyUser");
+  
+  OIB.get("ymdp/verify", {
+    ymail_guid: YMDP.guid,
+    ymail_wssid: YMDP.ymail_wssid
+  }, function(response) {
+    YMDP.user = response;
+    Debug.log("YMDP.verifyUser YMDP.user", YMDP.user);
+    if (success_function) {
+      Debug.log("YMDP.verifyUser: About to success function");
+      success_function(YMDP.user);
+    }
+  }, error_function);
+};
+
+
+/*
+		AUTHENTICATION
+*/
+
+// Gets the ymail_wssid which is stored in the database on the remote server
+// for the current user.
+//
+YMDP.confirm = function() {
+  Debug.log("YMDP.confirm");
+  OIB.get("ymdp/signin", {
+    "ymail_guid": YMDP.guid
+  }, function(response) {
+    Debug.log("inside ymdp/signin callback", response);
+    
+    if (response.ymail_wssid) {
+      Debug.log("YMDP.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.store", data);
+      
+      Data.store(data);
+      YMDP.ymail_wssid = response.ymail_wssid;
+  
+      // now that we've got their ymail_wssid, we can sign them in:
+      YMDP.verifyUser(Launcher.launchMain);
+      // Launcher.launchMain();
+    } else {
+      // signin didn't work properly, display an error
+      Debug.log("YMDP.response was false");
+      YMDP.showError({
+        "method": "YMDP.confirm",
+        "description": "no ymail_wssid"
+      });
+    }
+ });
+};
+
+// gets both guid and ymail_wssid and stores them then runs the callback_function
+//
+// YMDP.ymail_wssid
+// YMDP.guid
+//
+YMDP.getGuidAndYmailWssid = function(callback_function) {
+  Debug.log("YMDP.getGuidAndYmailWssid");
+  YMDP.getGuid(function(guid) {
+   YMDP.getYmailWssid(function(ymail_wssid) {
+     callback_function(guid, ymail_wssid);
+   });
+  });
+};
+
+// 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
+//
+// YMDP.ymail_wssid
+//
+YMDP.getYmailWssid = function(success_function, error_function) {
+  Debug.log("YMDP.getYmailWssid");
+  
+  // this function will show the error page if the ymail_wssid has not been set
+  //
+  var show_error = function() {
+    if (!YMDP.ymail_wssid) {
+      Debug.log("No YMDP.ymail_wssid");
+      
+      YMDP.showError({
+        "retry": "hide"
+      });
+    }
+  };
+  
+  // run the show_error function after 5 seconds
+  //
+  // Debug.log("Set timeout for error function to 10 seconds");
+  // YMDP.setTimeoutInSeconds(show_error, 10);
+  // Debug.log("About to call Data.fetch");
+  
+  // retrieve the user's ymail_wssid and store it in YMDP.ymail_wssid
+  //
+	Data.fetch(["ymail_wssid"], function(response) {
+	  Debug.log("Inside Data.fetch callback");
+    YMDP.ymail_wssid = response.data.ymail_wssid;
+    
+	  Debug.log("YMDP.ymail_wssid is defined", YMDP.ymail_wssid);
+	  
+	  try {
+      success_function(YMDP.ymail_wssid);
+	  } catch(omg) {
+	    Debug.error("Error in YMDP.getYmailWssid getData callback", omg);
+	  }
+	});
+};
+
+// 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
+//
+// YMDP.guid
+//
+YMDP.getGuid = function(success_function, error_function) {
+  Debug.log("YMDP.getGuid");
+  
+  openmail.Application.getParameters(function(response) {
+    Debug.log("getParameters callback");
+    YMDP.guid = response.user.guid;
+    try {
+      Debug.log("YMDP.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 (YMDP.guid !== undefined) {
+      success_function(YMDP.guid);
+		}
+		else {
+			error_function();
+		}
+  });
+};
+
+YMDP.deactivateUser = function() {
+	YMDP.getGuidAndYmailWssid(function() {
+	  var guid, ymail_wssid;
+	  
+	  guid = YMDP.guid;
+	  ymail_wssid = YMDP.ymail_wssid;
+
+    Data.clear();
+
+	  OIB.post("/ymdp/deactivate", {
+			"ymail_guid": guid,
+			"ymail_wssid": ymail_wssid
+		}, 
+		function(response) {
+		  if (View.name !== "deactivate") {
+			  Launcher.launchGoodbye();
+		  }
+		});
+	});
+};	

data/lib/ymdp/javascripts/prototype/browser.js

@@ -0,0 +1,36 @@
+var Browser;
+
+Browser = {
+  version: function(v) {
+    var version, app_version;
+    app_version = navigator.appVersion;
+    Debug.log("Browser app_version: ", app_version);
+  
+    if (app_version.match("MSIE 6.0")) {
+      version = 6.0;
+    }
+  
+    if (v) {
+      return (version === v);
+    } else {
+      return version;
+    }
+  },
+
+  ie: function() {
+    return navigator.appName.match("Internet Explorer");
+  },
+
+  ie6: function() {
+    return (Browser.ie() && Browser.version(6.0));
+  },
+
+  ie7: function() {
+    return (Browser.ie() && Browser.version(7.0));
+  },
+
+  ie8: function() {
+    return (Browser.ie() && Browser.version(8.0));
+  }
+};
+

data/lib/ymdp/javascripts/prototype/logger.js

@@ -0,0 +1,27 @@
+var Logger;
+
+Logger = {
+  on: false,
+  
+  init: function() {
+    OIB.get("ymdp/state", {}, function(response) {
+      Logger.on = response.observe;
+    });
+  },
+  
+  observe: function(message) {
+    if (this.on) {
+      this.log(message);
+    }
+  },
+  
+  log: function(message) {
+    // console.log("LOGGING " + message);
+    OIB.post("ymdp/logs", {
+      "_hide_debug": true,
+      "log": message
+    }, function() {
+      
+    });
+  }
+};

data/lib/ymdp/javascripts/prototype/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/prototype/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/view/application_view.rb

@@ -251,10 +251,14 @@ module YMDP
     end
     
     def render_default_javascripts(options={})
+      library_path = options[:library] || configuration.javascript_library || "jquery"
+      
+      # Javascripts need to be loaded in a certain order, this is why we don't just load everything at once
+      #
       default_javascripts = ['application', 'params', 'browser', 'data', 'ajax', 'user', 'init', 'reporter', 'debug', 'tag_helper', 'launcher', 'logger', 'i18n', 'flash', 'ab_testing', 'education', 'authorization']
       
       filenames = default_javascripts.map do |filename|
-        File.join(File.dirname(__FILE__), "..", "javascripts", "#{filename}.js")
+        File.join(File.dirname(__FILE__), "..", "javascripts", library_path, "#{filename}.js")
       end
       
       filenames = filter_filenames(filenames, options)

data/ymdp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ymdp}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Isaac Priestley"]
-  s.date = %q{2011-05-06}
+  s.date = %q{2011-05-13}
   s.description = %q{Framework for developing applications in the Yahoo! Mail Development Platform.}
   s.email = %q{progressions@gmail.com}
   s.extra_rdoc_files = [
@@ -54,24 +54,42 @@ Gem::Specification.new do |s|
     "lib/ymdp/generator/templates/stylesheet.css",
     "lib/ymdp/generator/templates/translation.pres",
     "lib/ymdp/generator/templates/view.html.haml",
-    "lib/ymdp/javascripts/ab_testing.js",
-    "lib/ymdp/javascripts/ajax.js",
-    "lib/ymdp/javascripts/application.js",
-    "lib/ymdp/javascripts/authorization.js",
-    "lib/ymdp/javascripts/browser.js",
-    "lib/ymdp/javascripts/data.js",
-    "lib/ymdp/javascripts/debug.js",
-    "lib/ymdp/javascripts/education.js",
-    "lib/ymdp/javascripts/flash.js",
-    "lib/ymdp/javascripts/help.js",
-    "lib/ymdp/javascripts/i18n.js",
-    "lib/ymdp/javascripts/init.js",
-    "lib/ymdp/javascripts/launcher.js",
-    "lib/ymdp/javascripts/logger.js",
-    "lib/ymdp/javascripts/params.js",
-    "lib/ymdp/javascripts/reporter.js",
-    "lib/ymdp/javascripts/tag_helper.js",
-    "lib/ymdp/javascripts/user.js",
+    "lib/ymdp/javascripts/jquery/ab_testing.js",
+    "lib/ymdp/javascripts/jquery/ajax.js",
+    "lib/ymdp/javascripts/jquery/application.js",
+    "lib/ymdp/javascripts/jquery/authorization.js",
+    "lib/ymdp/javascripts/jquery/browser.js",
+    "lib/ymdp/javascripts/jquery/data.js",
+    "lib/ymdp/javascripts/jquery/debug.js",
+    "lib/ymdp/javascripts/jquery/education.js",
+    "lib/ymdp/javascripts/jquery/flash.js",
+    "lib/ymdp/javascripts/jquery/help.js",
+    "lib/ymdp/javascripts/jquery/i18n.js",
+    "lib/ymdp/javascripts/jquery/init.js",
+    "lib/ymdp/javascripts/jquery/launcher.js",
+    "lib/ymdp/javascripts/jquery/logger.js",
+    "lib/ymdp/javascripts/jquery/params.js",
+    "lib/ymdp/javascripts/jquery/reporter.js",
+    "lib/ymdp/javascripts/jquery/tag_helper.js",
+    "lib/ymdp/javascripts/jquery/user.js",
+    "lib/ymdp/javascripts/prototype/ab_testing.js",
+    "lib/ymdp/javascripts/prototype/ajax.js",
+    "lib/ymdp/javascripts/prototype/application.js",
+    "lib/ymdp/javascripts/prototype/authorization.js",
+    "lib/ymdp/javascripts/prototype/browser.js",
+    "lib/ymdp/javascripts/prototype/data.js",
+    "lib/ymdp/javascripts/prototype/debug.js",
+    "lib/ymdp/javascripts/prototype/education.js",
+    "lib/ymdp/javascripts/prototype/flash.js",
+    "lib/ymdp/javascripts/prototype/help.js",
+    "lib/ymdp/javascripts/prototype/i18n.js",
+    "lib/ymdp/javascripts/prototype/init.js",
+    "lib/ymdp/javascripts/prototype/launcher.js",
+    "lib/ymdp/javascripts/prototype/logger.js",
+    "lib/ymdp/javascripts/prototype/params.js",
+    "lib/ymdp/javascripts/prototype/reporter.js",
+    "lib/ymdp/javascripts/prototype/tag_helper.js",
+    "lib/ymdp/javascripts/prototype/user.js",
     "lib/ymdp/tasks/build.rake",
     "lib/ymdp/tasks/keys.rake",
     "lib/ymdp/tasks/ymdp.rake",