ymdp 0.6.0 → 0.7.0

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/ymdp/configuration/config.rb

@@ -67,6 +67,8 @@ module YMDP
       
       attr_accessor :external_assets
       
+      attr_accessor :javascript_library
+      
       def initialize #:nodoc:
         @paths = {}
         @content_variables = {}
@@ -91,6 +93,14 @@ module YMDP
         path = "#{path}.yml"
         @content_variables = YAML.load_file(path)
       end
+      
+      def prototype
+        @javascript_library = "prototype"
+      end
+      
+      def jquery
+        @javascript_library = "jquery"
+      end
     end
     
     class Base

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

@@ -0,0 +1,130 @@
+
+  // 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 ABTesting;
+
+ABTesting = {
+  on: true,
+  languages: <%= english_languages.to_json %>,
+  
+  enable: function() {
+    ABTesting.on = true;
+  },
+  
+  disable: function() {
+    ABTesting.on = false;
+  },
+  
+  randomAB: function() {
+    return Math.floor(Math.random()*2) ? "a" : "b";
+  },
+  
+  get: function(content_id) {
+    var url, host;
+    
+    url = "ymdp/experiment";
+    
+    OIB.get(url, {
+      "domain": View.domain
+    }, function(response) {
+      ABTesting.success(content_id, response);
+    }, function(response) {
+      ABTesting.error(response);
+    });
+  },
+  
+  post: function(params) {
+    params = params || {};
+    OIB.post("ymdp/view", params, function(response) {
+      Debug.log("ABTesting.post success", response);
+    }, function(response) {
+      Debug.error("ABTesting.post error", response);
+    });
+  },
+  
+  postView: function(experimentId) {
+    var params;
+    
+    params = {
+      "var": ABTesting.variable
+    };
+    if (experimentId) {
+      params["experiment_id"] = experimentId;
+    }
+    Debug.log("ABTesting.postView: ", params);
+    ABTesting.post(params);
+  },
+  
+  setVariable: function(value) {
+    ABTesting.variable = value;
+  },
+ 
+  apply: function(content_id, language) {
+    try {
+      if (ABTesting.on && $.inArray(language, ABTesting.languages) >= 0) {
+        var index;
+      
+        index = ABTesting.randomAB();
+        ABTesting.setVariable(index);
+      
+        ABTesting.get(content_id);
+      } else {
+        YMDP.Init.showAndFinish();
+      }
+    }
+    catch(e) {
+      Debug.log(e);
+      YMDP.Init.showAndFinish();
+    }
+  },
+ 
+  error: function(data) {
+    Debug.log("applyError", data);
+    if (data.error !== 3002) {
+      Debug.error("Received body contents fetch error on page " + View.name + ": " + data.error + ' - ' + data.errorMsg);
+    }
+    YMDP.Init.showAndFinish();
+  },
+ 
+  success: function(content_id, response) {
+    try {
+      var content, experiment, experimentId;
+      Debug.log("ABTesting.success", response);
+      
+      experiment = response.experiment;
+      
+      if (experiment) {
+        content = ABTesting.content(experiment);
+        experimentId = response.experiment.id;
+
+        ABTesting.postView(experimentId);
+        ABTesting.replaceContents(content_id, content);        
+      } else {
+        Debug.log("No experiment running");
+      }
+      
+      YMDP.Init.showAndFinish();
+    } catch(e) {
+      Debug.log("ABTesting.success error" + e);
+    }
+  },
+  
+  replaceContents: function(content_id, content) {
+    openmail.Application.filterHTML({html: content}, function(response) {
+      if (response.html && response.html !== '') {
+        try {
+          $("#" + content_id).html(response.html);
+        } catch(omg) {
+          Debug.error(omg);
+        }
+      }
+      YMDP.Init.showAndFinish();
+    });
+  },
+  
+  content: function(experiment) {
+    return experiment["content_" + ABTesting.variable];
+  }
+};
+

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

@@ -0,0 +1,185 @@
+/*
+	  CALL OIB
+
+	  global to every view.  sends Ajax call to OtherInbox.
+*/
+
+	// send an Ajax call to OtherInbox.
+	// takes as parameters:
+	// - the path to call
+	// - any additional query string params
+	// - a callback function to run when the Ajax call is a success
+	// - an optional error function
+	// - a base URL to use, if you don't want this call going to YMDP.Constants.base_url
+	// TODO refactor this function to take a second params hash where we could stick success_function, error_function, and base_url
+
+OIB = {
+	get: function(oib_path, params, success_function, error_function, base_url) {
+		params.method = "GET";
+		OIB.call(oib_path, params, success_function, error_function, base_url);
+	},
+
+	post: function(oib_path, params, success_function, error_function, base_url) {
+		params.method = "POST";
+		OIB.call(oib_path, params, success_function, error_function, base_url);
+	},
+	
+	call: function(oib_path, params, success_function, error_function, base_url) {
+	  var success;
+	  
+	  success = function(response) {
+      response = JSON.parse(response.data);
+      if (response.error) {
+        if (error_function) {
+          error_function(response);
+        } else {
+          YMDP.showError(
+            {
+              "method": "OIB.call",
+              "description": "error callback"
+            }
+          ); // OIB.call response: error
+        }
+      } else {
+        if (success_function) {
+          success_function(response); 
+        } else {
+          YMDP.showError(
+            {
+              "method": "OIB.call",
+              "description": "success callback error"
+            }
+          ); // OIB.call response: success error
+        }
+      }
+    };
+	  OIB.request(oib_path, params, success, error_function, base_url);
+	},
+	
+	ajax_response: false,
+	
+	ajax: function(url, method, params, success_function, error_function) {
+	  var debug;
+	  
+	  params = params || {};
+	  params["application"] = View.application;
+	  
+	  debug = !params["_hide_debug"];
+	  
+	  if (debug) {
+      Debug.log("OIB.ajax: About to call openmail.Application.callWebService: ", {
+        "method": method,
+        "url": url + "?" + $.param(params)
+      });
+    }
+    
+    openmail.Application.callWebService(
+    {
+    	url: url,
+    	method: method,
+    	parameters: params
+    },
+    function(response) {
+      // response from Ajax call was a 200 response
+      //
+      if (debug) {
+        Debug.log("inside response from openMail.Application.callWebService", response);
+      }
+      if (response.error) {
+        // response has a parameter called "error"
+        //
+        if (error_function) {
+    		  error_function(response);
+    		} else {
+    		  if (debug) {
+            OIB.error(url, params, response);
+          }
+        }
+      } else {
+        // SUCCESSFUL RESPONSE
+        //
+        // response doesn't have a parameter called "error"
+        // 
+    		try {
+        	success_function(response);
+    		} catch(e) {
+    		  if (debug) {
+      		  Debug.log("Error in OIB.request success function", e);
+    		  }
+    		  YMDP.showError({
+    		    "method": "OIB.request",
+    		    "description": "exception caught in OIB.request success callback",
+    		    "error": e
+    		  });
+    		}
+      }
+    });  
+	},
+	
+	request: function(oib_path, params, success_function, error_function, base_url) {
+    var oib_url, method, debug;
+	  
+	  debug = !params["_hide_debug"];
+	  
+	  if (debug) {
+      Debug.log("inside OIB.request: ", {
+        "oib_path": oib_path,
+        "params": JSON.stringify(params)
+      });
+    }
+  
+    oib_url = base_url ? base_url : YMDP.Constants.base_url;
+  
+    if (!(oib_path && typeof(oib_path) === "string")) {
+      throw("OIB.request must define oib_path");
+    }
+    if (!(params && typeof(params) === "object")) {
+      throw("OIB.request must define params");
+    }
+  
+   	oib_url = oib_url + oib_path;
+    method = "GET";
+    if (!params.format) {
+      params.format = 'json';
+    }
+    if (params.method) {
+      method = params.method;
+      delete params.method;
+    }
+    params.version = params.version || <%= @version %>;
+  
+    if (debug) {
+      Debug.log("about to call OIB.ajax");
+    }
+    
+    OIB.ajax(oib_url, method, params, success_function, error_function);
+  },
+	
+  // overwrite this function locally if you need to
+	error: function(url, params, response) {
+	  var message, debug;
+	  
+	  debug = !params["_hide_debug"];
+	  
+	  if (debug) {
+	    message = "OIB.error: " + JSON.stringify(response) + " calling url: " + url + "?" + $.param(params);
+  	  Debug.error(message);
+	  }
+	},
+	
+	// advance the user to the next state in the signup process
+	//
+  advance: function(success_function, error_function) {
+    OIB.post("ymdp/state", {}, function(response) {
+      Debug.log("Scanning.next success", response);
+      if (success_function) {
+        success_function(response);
+      }
+    }, function(response) {
+      Debug.error("Scanning.next error", response);
+      if (error_function) {
+        error_function(response);
+      }
+    });
+  }
+};

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

@@ -0,0 +1,139 @@
+/*
+	APPLICATION
+
+  // 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 OIB, YMDP;
+
+/* 
+	GLOBAL CONSTANTS 
+*/
+
+var View = {
+  application: "<%= @application_name %>",
+  domain: "<%= @domain %>",
+  page_loaded: false,
+  
+  authorized: function(user) {
+    return (user[View.application + "_user"]);
+  }
+};
+
+var YMDP = {
+  Constants: {},
+  Init: {}
+};
+
+function unixTimeToDate(unixtime) {
+  return new Date(unixtime * 1000);
+}
+
+function formatUnixDate(unixtime) {
+  var date;
+  date = unixTimeToDate(unixtime);
+  return date.toString("MMMM d, yyyy");
+}
+
+// Shows the error view.
+//
+// YMDP.showError({
+//   heading: "optional heading text can overwrite the error view's heading",
+//   message: "optional message can overwrite the view's first paragraph",
+//   retry: "hide"
+// });
+// 
+// Set the "retry" option to "hide" to hide the Retry button.
+//
+
+YMDP.showError = function(options) {
+  var params;
+  
+  options = options || {};
+  
+  if (options["heading"]) {
+    $("#error_1").html(options["heading"]);
+  }
+  if (options["message"]) {
+    $("#error_2").html(options["message"]);
+  }
+  if (options["retry"] && options["retry"] === "hide") {
+    $("#retry_button_container").hide();
+  }
+  
+  params = {};
+  params["description"] = options["description"];
+  params["method_name"] = options["method"];
+  params["error"] = JSON.stringify(options["error"]);
+  params["page"] = View.name;
+  
+  Reporter.error(YMDP.guid, params);
+  $('#main').hide();
+  $('#utility').show();
+	$('#loading').hide();
+	$('#error').show();
+};
+
+YMDP.showLoading = function() {
+  $('#main').hide();
+  $('#utility').show();
+  $('#error').hide();
+  $('#loading').show();
+};
+
+YMDP.Init.upgradeCheck = function(success_callback, failure_callback) {
+  // test for Minty
+  //
+  openmail.Application.getParameters(function(response) {
+    if (response.version === "2") {
+
+      // Minty-only code goes here
+
+      try {
+        Debug.log("Minty found");
+        
+        success_callback();
+      } catch(wtf) {
+        Debug.error(wtf);
+      }
+    } else {
+      // non-Minty
+      
+      if (failure_callback) {
+        failure_callback();
+      } else {
+        YMDP.Init.upgrade();
+      }
+    }
+  });  
+};
+
+YMDP.Init.upgrade = function() {
+  YMDP.showTranslations();
+	
+  View.page_loaded = true;
+  
+  $('#loading').hide();
+  $('#error').hide();
+  $('#upgrade').show();
+};
+
+YMDP.setTimeoutInSeconds = function(callback_function, interval) {
+	setTimeout(callback_function, interval * 1000);
+};
+
+YMDP.showTranslations = function() {
+  Debug.log("begin YMDP.showTranslations");
+	I18n.findAndTranslateAll();
+
+	// define I18n.localTranslations in the view template
+	I18n.localTranslations();
+	
+  Debug.log("end YMDP.showTranslations");
+};
+
+String.prototype.capitalize = function() {
+    return this.charAt(0).toUpperCase() + this.slice(1);
+}