ymdp 0.8.4 → 0.8.5

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

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

@@ -0,0 +1,92 @@
+# 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.
+
+window.ABTesting = 
+  on: true
+
+  languages: <%= english_languages.to_json %>
+  
+  enable: ->
+    ABTesting.on = true
+  
+  disable: ->
+    ABTesting.on = false
+  
+  randomAB: ->
+    Math.floor(Math.random()*2) ? "a" : "b"
+
+  get: (content_id) ->
+    url = "ymdp/experiment"
+    
+    OIB.get url, 
+      "domain": View.domain
+    , (response) ->
+      ABTesting.success(content_id, response)
+    , (response) ->
+      ABTesting.error(response)
+
+  
+  post: (params) ->
+    params = params || {}
+    OIB.post "ymdp/view", params, (response) ->
+      Debug.log("ABTesting.post success", response)
+    , (response) ->
+      Debug.error("ABTesting.post error", response)
+
+  
+  postView: (experimentId) ->
+    params = 
+      "var": ABTesting.variable
+    
+    if typeof(experimentId) != 'undefined'
+      params["experiment_id"] = experimentId
+    
+    Debug.log("ABTesting.postView: ", params)
+    ABTesting.post(params)
+
+  
+  setVariable: (value) ->
+    ABTesting.variable = value
+
+  apply: (content_id, language) ->
+    if (ABTesting.on && $.inArray(language, ABTesting.languages) >= 0) 
+      index = ABTesting.randomAB()
+      ABTesting.setVariable(index)
+    
+      ABTesting.get(content_id)
+     else
+      YMDP.Init.showAndFinish()
+    
+  error: (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: (content_id, response) ->
+    Debug.log("ABTesting.success", response)
+    
+    experiment = response.experiment
+    
+    if typeof(experiment) != 'undefined'
+      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()
+  
+  replaceContents: (content_id, content) ->
+    openmail.Application.filterHTML
+      html: content, (response) ->
+        if typeof(response.html) != 'undefined' && response.html != ''
+          $("#" + content_id).html(response.html)
+      
+        YMDP.Init.showAndFinish()
+  
+  content: (experiment) ->
+    experiment["content_" + ABTesting.variable]

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

@@ -0,0 +1,134 @@
+###
+	  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
+
+window.OIB = 
+	get: (oib_path, params, success_function, error_function, base_url) ->
+		params.method = "GET"
+		OIB.call(oib_path, params, success_function, error_function, base_url)
+
+	post: (oib_path, params, success_function, error_function, base_url) ->
+		params.method = "POST"
+		OIB.call(oib_path, params, success_function, error_function, base_url)
+	
+	call: (oib_path, params, success_function, error_function, base_url) ->
+	  success = (response) ->
+      response = JSON.parse(response.data)
+      if (response.error)
+        if (error_function)
+          error_function(response)
+        else
+          YMDP.showError
+            "method": "OIB.call"
+            "description": "error callback"
+      else
+        if (success_function)
+          success_function(response) 
+        else
+          YMDP.showError
+              "method": "OIB.call"
+              "description": "success callback error"
+              
+	  OIB.request(oib_path, params, success, error_function, base_url)
+	
+	ajax_response: false
+	
+	ajax: (url, method, params, success_function, error_function) ->
+	  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
+    , (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"
+        # 
+      	success_function(response)
+	
+	request: (oib_path, params, success_function, error_function, base_url) ->
+    debug = !params["_hide_debug"]
+    Debug.log("inside OIB.request: ", {"oib_path": oib_path, "params": JSON.stringify(params)}) if debug
+  
+    oib_url = OIB.url_from_path(oib_path, params, base_url)
+    method = OIB.method_from_params(params)
+    
+    Debug.log("about to call OIB.ajax") if debug
+    OIB.ajax(oib_url, method, params, success_function, error_function)
+  
+  method_from_params: (params) ->
+    method = "GET"
+    if !params.format
+      params.format = 'json'
+    if params.method
+      method = params.method
+      delete params.method
+      
+    params.version = params.version || "<%= @version %>"
+    
+    method
+  
+  url_from_path: (oib_path, params, base_url) ->
+    oib_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_path
+
+  # overwrite this function locally if you need to
+  #
+	error: (url, params, response) ->
+	  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: (success_function, error_function) ->
+    OIB.post "ymdp/state", {}, (response) ->
+      Debug.log("Scanning.next success", response)
+      if (success_function)
+        success_function(response)
+    , (response) ->
+      Debug.error("Scanning.next error", response)
+      if (error_function)
+        error_function(response)

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

@@ -0,0 +1,86 @@
+###
+  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.
+
+###
+
+### 
+  GLOBAL CONSTANTS 
+###
+
+window.View = 
+  application: "<%= @application_name %>"
+  domain: "<%= @domain %>"
+  page_loaded: false
+  
+  authorized: (user) ->
+    return (user[View.application + "_user"])
+
+
+window.unixTimeToDate = (unixtime) ->
+  new Date(unixtime * 1000)
+
+window.formatUnixDate = (unixtime) ->
+  date = unixTimeToDate(unixtime)
+  date.toString("MMMM d, yyyy")
+
+String.prototype.capitalize = () ->
+  this.charAt(0).toUpperCase() + this.slice(1)
+
+
+
+window.YMDP = 
+  Constants: {}
+  
+  # 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.
+  #
+
+  showError: (options) ->
+    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 = 
+      "description": options["description"]
+      "method_name": options["method"]
+      "error": JSON.stringify(options["error"])
+      "page": View.name
+  
+    Reporter.error(YMDP.guid, params)
+    $('#main').hide()
+    $('#utility').show()
+    $('#loading').hide()
+    $('#error').show()
+
+  showLoading: () ->
+    $('#main').hide()
+    $('#utility').show()
+    $('#error').hide()
+    $('#loading').show()
+
+  setTimeoutInSeconds: (callback_function, interval) ->
+    setTimeout(callback_function, interval * 1000)
+
+  showTranslations: () ->
+    Debug.log("begin YMDP.showTranslations")
+    I18n.findAndTranslateAll()
+
+    # define I18n.localTranslations in the view template
+    I18n.localTranslations()
+  
+    Debug.log("end YMDP.showTranslations")

data/lib/ymdp/javascripts/jquery/authorization.js.coffee

@@ -0,0 +1,101 @@
+###
+  AUTHORIZE USER
+          
+  Authorize and sign in the user.
+###
+
+window.Authorize = 
+  init: (guid, default_state, params) ->
+    Debug.log("Authorize.init")
+    params = params || {}
+    if Params.get("invitation")
+      params["invitation"] = Params.get("invitation")
+      
+    params["application"] = View.application
+    Authorize.url = YMDP.Constants.controller_url + "/authorize/" + guid
+    Authorize.locale = params.locale
+    Authorize.default_state = default_state
+    
+    Authorize.params = params
+    Debug.log("end of Authorize.init")
+  
+  assignUrl: (url) ->
+    url = url || Authorize.url
+    url = url + "?" + $.param(Authorize.params)
+    
+    $("#get_started_1").attr("href", url).attr("target", "_blank")
+    $("#get_started_2").attr("href", url).attr("target", "_blank")
+    $(".get_started").attr("href", url).attr("target", "_blank")
+  
+  authorize: ->
+    Debug.log("Authorize.authorize")
+    User.getState (response) ->
+      if Authorize.authorized(response)
+        Authorize.confirm()
+      else
+        Debug.log("About to startScanning")
+        Authorize.startScanning()
+  
+  startScanning: ->
+    Debug.log("Authorize.startScanning", Authorize.scanner)
+    if !Authorize.scanner
+      Debug.log("Authorize.scanner doesnt exist", Authorize.scanner)
+      Authorize.scanner = window.setInterval(Authorize.scan, 5000)
+    else
+      Debug.log("Authorize.scanner does exist", Authorize.scanner)
+  
+  authorized: (response) ->
+    Debug.log("Authorize.authorized", response)
+    return !!(response.state != Authorize.default_state && View.authorized(response))
+  
+  confirm: User.confirm
+  
+  scan: ->
+    Debug.log("Authorize.scan")
+    if Authorize.stop_scanning
+      Debug.log("Authorize.stop_scanning is true", Authorize.stop_scanning)
+      window.clearInterval(Authorize.scanner)
+    else
+      Debug.log("Authorize.stop_scanning is not true", Authorize.stop_scanning)
+    
+    Debug.log("About to getUserState")
+    
+    User.getState Authorize.scanResponse, (response) ->
+      # error function
+      Debug.error("Error in Authorize.scan's getUserState", response)
+    
+      if Authorize.scanner
+        window.clearInterval(Authorize.scanner)
+  
+  scanResponse: (response) ->
+    Debug.log("inside Authorize.scan's getUserState callback", response)
+    if response.state != Authorize.default_state
+      Debug.log("not default state, about to Authorize.confirm()")
+      
+      Authorize.confirm()
+      if Authorize.scanner
+        window.clearInterval(Authorize.scanner)
+        
+      Authorize.scanner = undefined
+      Debug.log("just set Authorize.scanner to undefined")
+  
+  addBehaviors: ->
+    Debug.log("Authorize.addBehaviors")
+    $("#get_started_1").click(Authorize.authorize)
+    $("#get_started_2").click(Authorize.authorize)
+    $(".get_started").click(Authorize.authorize)
+  
+  verify: ->
+    # call /ymdp/verify and return data about the user
+    User.verify (user) ->
+      Debug.log("inside User.verify callback", user)
+      
+      YMDP.user = user
+      YMDP.login = user.login
+      YMDP.Init.switchOnState(user)
+    , (response) ->
+      # call to ymdp/verify was not a 200 response, show error
+      YMDP.showError
+        "method_name": "User.verify",
+        "description": "error response"
+

data/lib/ymdp/javascripts/jquery/browser.js.coffee

@@ -0,0 +1,25 @@
+window.Browser = 
+  version: (v) ->
+    app_version = navigator.appVersion
+    Debug.log("Browser app_version: ", app_version)
+  
+    if app_version.match("MSIE 6.0")
+      version = 6.0
+  
+    if v
+      version == v
+    else
+      version
+
+  ie: ->
+    navigator.appName.match("Internet Explorer")
+
+  ie6: ->
+    Browser.ie() && Browser.version(6.0)
+
+  ie7: ->
+    Browser.ie() && Browser.version(7.0)
+
+  ie8: ->
+    Browser.ie() && Browser.version(8.0)
+

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

@@ -0,0 +1,50 @@
+window.Data = 
+  # values cannot be longer than 255 chars
+  #
+  store: (data, success_function, error_function) ->
+    Debug.log("Data.store", data)
+    
+    keys = 
+      "keys": data
+      
+    openmail.Application.setData keys, (response) ->
+      Debug.log("openmail.Application.setData response", response)
+
+      if typeof(response.error) != 'undefined' && response.error != YAHOO.openmail.ERR_NONE
+        # storage error detected
+        Debug.error("Error saving data", response)
+        
+        if typeof(error_function) != 'undefined'
+          error_function(response)
+      else
+        if typeof(success_function) != 'undefined'
+          success_function(response)
+  
+  # keys must be an array
+  #
+  fetch: (keys, success_function, error_function) ->
+    Debug.log("Data.fetch", keys)
+    
+    keys = 
+      "keys": keys
+    
+    openmail.Application.getData keys, (response) ->
+      Debug.log("Inside openmail.Application.getData callback", response)
+    
+      if typeof(response.error) != 'undefined' && (response.error != YAHOO.openmail.ERR_NONE)
+        Debug.error("Error retrieving data", response)
+        if typeof(error_function) != 'undefined'
+          error_function(response)
+      else
+        Debug.log("success in openmail.Application.getData", response)
+        if typeof(success_function) != 'undefined'
+          success_function(response)
+  
+  clear: -> 
+    Data.store
+      "ymail_wssid": null
+    , (response) ->
+      YMDP.guid = null
+      YMDP.ymail_wssid = null
+      
+      

data/lib/ymdp/javascripts/jquery/debug.js.coffee

@@ -0,0 +1,76 @@
+
+  # 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.
+
+window.Debug = 
+  on: false
+  console: true
+  logs: false
+  
+  consoleOn: ->
+    typeof window['console'] != 'undefined' && this.console
+  
+  call: ->
+    args = [].slice.call(arguments,0)
+    level = args.shift()
+    
+    message = this.message.apply(Debug, args)
+
+    if this.consoleOn()
+      console[level](message)
+      
+    Logger.observe(message)
+  
+  log: ->
+    args = [].slice.call(arguments,0)
+    args.unshift("log")
+    this.call.apply(this, args)
+  
+  error: ->
+    args = [].slice.call(arguments,0)
+    args.unshift("error")
+    this.call.apply(this, args)
+  
+  message: ->
+    args = [].slice.call(arguments,0)
+    parts = []
+    
+    parts.push(this.timestamp())
+    parts.push(this.generalInfo())
+    
+    $(args).each (i, arg) ->
+      parts.push(Debug.object(arg))
+    
+    message = parts.join(" ")
+    
+    message
+  
+  object: (obj) ->
+    if (typeof obj == "string")
+      obj
+    else if (obj == undefined)
+      "undefined"
+    else if (obj == null)
+      "null"
+    else if (obj.inspect)
+      obj.inspect()
+    else
+      JSON.stringify(obj)
+    
+  checktime: (i) ->
+    if i<10
+      i="0" + i
+      
+    i
+  
+  timestamp: ->
+    time = new Date()
+    hour = this.checktime(time.getHours())
+    minute = this.checktime(time.getMinutes())
+    second = this.checktime(time.getSeconds())
+    
+    hour + ":" + minute + ":" + second
+  
+  generalInfo: ->
+    "[<%= @version %> <%= @sprint_name %>]"
+    

data/lib/ymdp/javascripts/jquery/init.js.coffee

@@ -0,0 +1,160 @@
+### 
+
+INITIALIZER CODE
+
+###
+
+# Adds behaviors/observers to elements on the page
+#
+
+YMDP.Init = {}
+
+YMDP.Init.addBehaviors = ->
+	# overwrite this function locally
+
+
+# hide the loading screen and show the main body of the summary
+YMDP.Init.show = ->
+  Debug.log("YMDP.Init.show")
+  $('#utility').hide()
+  $('#error').hide()
+  $('#loading').hide()
+  $('#main').show()
+
+
+# Local initializer.  When your page starts up, this method will be called after fetching the user's guid and ymail wssid.
+#
+YMDP.Init.local = ->
+  throw("This hasn't been overwritten.")
+	# overwrite this function locally
+
+
+# To be run before any other initializers have run.
+#
+YMDP.Init.before = ->
+	# overwrite this function locally
+
+# Main startup code. Overwrite this function to execute after YMDP.Init.before and before YMDP.Init.after.
+#
+YMDP.Init.startup = ->
+  Debug.log("init.startup")
+  # gets the user
+  User.getGuid (guid) ->
+	  Reporter.reportCurrentView(guid)
+	  callback = ->
+      try 
+        YMDP.Init.local()
+      catch omg
+        Debug.error("Error in YMDP.Init.local", omg)
+        YMDP.showError()
+      
+    User.getState(callback, callback)
+
+
+YMDP.Init.abTesting = ->
+  # to enable abTesting in your view, overwrite this file locally.
+  # 
+  # be sure to finish your post-Ajax callback with YMDP.Init.show()
+  #
+  YMDP.Init.show()
+  YMDP.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.
+#
+YMDP.Init.finish = ->
+  Debug.log("init.finish for view " + View.name)
+  YMDP.showTranslations()
+  YMDP.Init.addBehaviors()
+  YMDP.Init.abTesting()
+  View.page_loaded = true
+  Debug.log("finished init.finish for view " + View.name)
+
+
+# Post-initalizer. Very last thing that runs, after content has been shown.
+#
+YMDP.Init.after = ->
+	# overwrite this function locally
+
+
+YMDP.setJSON = ->
+  if typeof(JSON) != 'undefined'
+    true
+  
+  if typeof(YUI) != 'undefined'
+    YUI().use 'json', (Y) ->
+      window.JSON = Y.JSON
+      
+  else if typeof(YAHOO) != 'undefined' && typeof(YAHOO.lang) != 'undefined'
+    window.JSON = YAHOO.lang.JSON
+  
+
+# Execute the before, startup and after methods. Do not overwrite. (Change YMDP.Init.startup to create a custom initializer.)
+YMDP.init = ->
+  try 
+    YMDP.setJSON() # must set JSON first because Debug uses it
+    Debug.log("OIB.init for view " + View.name, "<%= @message %>")
+    Logger.init()
+    Tags.init()
+    YMDP.Init.browser()
+    YMDP.Init.resources()
+    I18n.addLanguageToBody()
+    I18n.translateLoading()
+    I18n.translateError()
+    YMDP.Init.before()
+    YMDP.Init.startup()
+  catch omg
+    Debug.error(omg.message)
+  
+
+
+YMDP.Init.browser = ->
+  if $.browser.webkit
+    $('body').addClass('webkit')
+  
+
+YMDP.Init.resources = ->
+  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.
+YMDP.Init.showAndFinish = ->
+  Debug.log("YMDP.Init.showAndFinish")
+  YMDP.Init.show()
+  YMDP.Init.after()
+
+YMDP.Init.upgradeCheck = (success_callback, failure_callback) ->
+  # test for Minty
+  #
+  openmail.Application.getParameters (response) ->
+    if response.version == "2"
+      # Minty-only code goes here
+
+      Debug.log("Minty found")
+      
+      success_callback()
+    else
+      # non-Minty
+      
+      if failure_callback
+        failure_callback()
+      else
+        YMDP.Init.upgrade()
+
+YMDP.Init.upgrade = () ->
+  YMDP.showTranslations()
+	
+  View.page_loaded = true
+  
+  $('#loading').hide()
+  $('#error').hide()
+  $('#upgrade').show()

data/lib/ymdp/javascripts/jquery/launcher.js.coffee

@@ -0,0 +1,112 @@
+###
+  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.
+
+###
+
+window.Launcher = {}
+
+Launcher.launch = (view, title, type) ->
+  openmail.Application.getParameters (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)
+
+Launcher.launchView = (launch_view) ->  
+  user = YMDP.user || {"state": "active"}
+  
+  switch user.state
+    when "scanning"
+      # formerly known as 'inspect'
+      Launcher.launchScanning()
+    when "summary" 
+      Launcher.launchSummary()
+    when "authorized" 
+      # authorized but not yet 'signed in'
+       YMDP.signInUser()
+    when "new_active", "processing", "active"
+       # activated but we have synced fewer than 80% of their messages
+      # active, launch the view this method was intended for
+      launch_view()
+    else
+      # other
+      Launcher.launchAuthorize()
+
+
+Launcher.launchTab = (view, title) ->
+  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
+#
+Launcher.launchActiveTab = (view, title) ->
+  Launcher.launchTab(view, title)
+
+
+Launcher.launchAuthorize = ->
+  Launcher.launchTab("authorize", "Authorize")
+
+Launcher.launchDeactivate = ->
+  Launcher.launchHidden("deactivate", "Deactivate")
+
+Launcher.launchHidden = (view, title) ->
+  Launcher.launch(view, title, "hidden")
+
+Launcher.l = (view) ->
+  view = "launch" + view.capitalize()
+  Launcher[view]()
+
+Launcher.launchGoodbye = ->
+  Launcher.launchTab("goodbye", "Goodbye")
+
+Launcher.relaunchAuthorize = Launcher.launchAuthorize
+
+Launcher.launchMaintenance = ->
+  Launcher.launchTab("maintenance", "Maintenance")
+
+Launcher.launchReauthorize = ->
+  Launcher.launchTab("reauthorize", "Reauthorize")
+
+Launcher.launchView = (launch_view) ->
+  # get Yahoo! user's guid and ymail_wssid
+  User.getGuidAndYmailWssid (guid, ymail_wssid) ->
+           
+    # call /ymdp/verify and return data about the user
+    User.verify (user) ->
+
+      YMDP.login = user.login
+    
+      switch user.state
+        when "scanning"
+          # formerly known as 'inspect'
+          Launcher.launchScanning()
+        when "summary"
+          Launcher.launchSummary()
+        when "authorized"
+          # authorized but not yet 'signed in'
+           YMDP.signInUser()
+        when "new_active", "processing", "active"
+           # no messages processed yet
+           # activated but we have synced fewer than 80% of their messages
+          # active, launch the view this method was intended for
+          launch_view()
+        else
+          # other
+          Launcher.launchAuthorize()
+
+Launcher.launchMain = ->
+  Launcher.launchView(Launcher.launchFolders)

data/lib/ymdp/javascripts/jquery/logger.js.coffee

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

data/lib/ymdp/javascripts/jquery/params.js.coffee

@@ -0,0 +1,22 @@
+window.Params = 
+  names: ["invitation", "page", "cc"]
+  parameters: {}
+  
+  init: (launchParams) ->
+    launchParams = launchParams || {}
+    Debug.log("Params.init", launchParams)
+    
+    if launchParams
+      Params.parameters = launchParams
+    else
+      Params.parameters = {}
+  
+  get: (name) ->
+    Debug.log("Params.get", name)
+
+    index = $.inArray(name, Params.names)
+  
+    if index >= 0
+      result = Params.parameters["param" + index]
+      
+    result

data/lib/ymdp/javascripts/jquery/reporter.js.coffee

@@ -0,0 +1,40 @@
+# 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.
+
+# 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)
+#
+window.Reporter = 
+  error: (guid, params) ->
+    # Debug.log("Reporter.error", params)
+    Reporter.report(guid, "error", params)
+  
+  reportCurrentView: (guid) ->
+    Reporter.report(guid, View.name)
+  
+  # Report the Ymail guid and page view name to OIB.
+  #
+  report: (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: (params) ->
+    params = params || {}
+    OIB.post "ymdp/report", params, 
+      (response) ->
+      # Debug.log("Reported page view", params)
+    , (response) ->
+      # Debug.error("Error reporting page view with params", response)

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

@@ -0,0 +1,178 @@
+window.User = 
+
+# gets user's state info from /ymdp/state
+# including the user's OIB login
+#
+  getState: (success_function, error_function) ->
+    Debug.log("User.getState")
+    
+    success = (response) ->
+      Debug.log("User.getState callback", response)
+      User.setVariables(response)
+
+      if success_function
+        Debug.log("User.getState: About to success function")
+        success_function(response)
+    error = ->
+      Debug.log("Failed to get user's state")
+      error_function() if error_function
+      
+    OIB.get "ymdp/state", {}, success, error
+  
+
+  setVariables: (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
+
+  ###
+      User.verify
+
+      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.
+  ###
+  
+  verify: (success_function, error_function) ->
+    Debug.log("User.verify")
+  
+    params = 
+      ymail_guid: YMDP.guid,
+      ymail_wssid: YMDP.ymail_wssid
+    success = (response) ->
+      YMDP.user = response
+      Debug.log("User.verify YMDP.user", YMDP.user)
+      if success_function
+        Debug.log("User.verify: About to success function")
+        success_function(YMDP.user)
+  
+    OIB.get "ymdp/verify", params, success, error_function
+
+
+  ###
+      AUTHENTICATION
+  ###
+
+  # Gets the ymail_wssid which is stored in the database on the remote server
+  # for the current user.
+  #
+  confirm: ->
+    Debug.log("User.confirm")
+    OIB.get "ymdp/signin", 
+      "ymail_guid": YMDP.guid
+    , User.confirmation
+
+  # Handle response from User.confirm
+  #
+  confirmation: (response) ->
+    Debug.log("inside ymdp/signin callback", response)
+  
+    if response.ymail_wssid      
+      Debug.log("YMDP.response wasn't false", response.ymail_wssid)
+      User.storeYmailWssid(response.ymail_wssid)
+
+      # now that we've got their ymail_wssid, we can sign them in:
+      User.verify(Launcher.launchMain)
+    else
+      # signin didn't work properly, display an error
+      Debug.log("YMDP.response was false")
+      YMDP.showError
+        "method": "User.confirm",
+        "description": "no ymail_wssid"
+
+  # Store ymail_wssid in permanent store.
+  #
+  storeYmailWssid: (ymail_wssid) -> 
+    raw_wssid = ymail_wssid || ""
+    sliced_wssid = raw_wssid.slice(0, 255)
+  
+    data = 
+      "ymail_wssid": sliced_wssid
+  
+    Debug.log("About to call Data.store", data)
+  
+    Data.store(data)
+    YMDP.ymail_wssid = ymail_wssid 
+
+  # gets both guid and ymail_wssid and stores them then runs the callback_function
+  #
+  # YMDP.ymail_wssid
+  # YMDP.guid
+  #
+  getGuidAndYmailWssid: (callback_function) ->
+    Debug.log("User.getGuidAndYmailWssid")
+    User.getGuid (guid) ->
+      User.getYmailWssid (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
+  #
+  getYmailWssid: (success_function, error_function) ->
+    Debug.log("User.getYmailWssid")
+  
+    # this function will show the error page if the ymail_wssid has not been set
+    #
+    show_error = ->
+      if !YMDP.ymail_wssid
+        Debug.log("No YMDP.ymail_wssid")
+      
+        YMDP.showError
+          "retry": "hide"
+  
+    # retrieve the user's ymail_wssid and store it in YMDP.ymail_wssid
+    #
+    Data.fetch ["ymail_wssid"], (response) ->
+      Debug.log("Inside Data.fetch callback")
+      YMDP.ymail_wssid = response.data.ymail_wssid
+    
+      Debug.log("YMDP.ymail_wssid is defined", YMDP.ymail_wssid)
+    
+      success_function(YMDP.ymail_wssid)
+
+  # 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
+  #
+  getGuid: (success_function, error_function) ->
+    Debug.log("User.getGuid")
+  
+    openmail.Application.getParameters (response) ->
+      Debug.log("getParameters callback")
+      YMDP.guid = response.user.guid
+    
+      Debug.log("User.getGuid getParameters response", response)
+    
+      params = {}
+      if response.data
+        params = response.data.launchParams
+    
+      Params.init(params)
+    
+      if YMDP.guid != undefined
+        success_function(YMDP.guid)
+      else
+        error_function()
+
+  deactivate: ->
+    User.getGuidAndYmailWssid (guid, ymail_wssid) ->
+      Data.clear()
+
+      params =
+        "ymail_guid": guid,
+        "ymail_wssid": ymail_wssid
+
+      OIB.post "/ymdp/deactivate", params, 
+      (response) ->
+        if View.name != "deactivate"
+          Launcher.launchGoodbye()

data/ymdp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ymdp}
-  s.version = "0.8.4"
+  s.version = "0.8.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Isaac Priestley"]
-  s.date = %q{2011-07-06}
+  s.date = %q{2011-07-11}
   s.description = %q{Framework for developing applications in the Yahoo! Mail Development Platform.}
   s.email = %q{progressions@gmail.com}
   s.extra_rdoc_files = [
@@ -55,23 +55,36 @@ Gem::Specification.new do |s|
     "lib/ymdp/generator/templates/translation.pres",
     "lib/ymdp/generator/templates/view.html.haml",
     "lib/ymdp/javascripts/jquery/ab_testing.js",
+    "lib/ymdp/javascripts/jquery/ab_testing.js.coffee",
     "lib/ymdp/javascripts/jquery/ajax.js",
+    "lib/ymdp/javascripts/jquery/ajax.js.coffee",
     "lib/ymdp/javascripts/jquery/application.js",
+    "lib/ymdp/javascripts/jquery/application.js.coffee",
     "lib/ymdp/javascripts/jquery/authorization.js",
+    "lib/ymdp/javascripts/jquery/authorization.js.coffee",
     "lib/ymdp/javascripts/jquery/browser.js",
+    "lib/ymdp/javascripts/jquery/browser.js.coffee",
     "lib/ymdp/javascripts/jquery/data.js",
+    "lib/ymdp/javascripts/jquery/data.js.coffee",
     "lib/ymdp/javascripts/jquery/debug.js",
+    "lib/ymdp/javascripts/jquery/debug.js.coffee",
     "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/init.js.coffee",
     "lib/ymdp/javascripts/jquery/launcher.js",
+    "lib/ymdp/javascripts/jquery/launcher.js.coffee",
     "lib/ymdp/javascripts/jquery/logger.js",
+    "lib/ymdp/javascripts/jquery/logger.js.coffee",
     "lib/ymdp/javascripts/jquery/params.js",
+    "lib/ymdp/javascripts/jquery/params.js.coffee",
     "lib/ymdp/javascripts/jquery/reporter.js",
+    "lib/ymdp/javascripts/jquery/reporter.js.coffee",
     "lib/ymdp/javascripts/jquery/tag_helper.js",
     "lib/ymdp/javascripts/jquery/user.js",
+    "lib/ymdp/javascripts/jquery/user.js.coffee",
     "lib/ymdp/javascripts/prototype/ab_testing.js",
     "lib/ymdp/javascripts/prototype/ajax.js",
     "lib/ymdp/javascripts/prototype/application.js",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ymdp
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Isaac Priestley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-06 00:00:00 -05:00
+date: 2011-07-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -588,23 +588,36 @@ files:
 - lib/ymdp/generator/templates/translation.pres
 - lib/ymdp/generator/templates/view.html.haml
 - lib/ymdp/javascripts/jquery/ab_testing.js
+- lib/ymdp/javascripts/jquery/ab_testing.js.coffee
 - lib/ymdp/javascripts/jquery/ajax.js
+- lib/ymdp/javascripts/jquery/ajax.js.coffee
 - lib/ymdp/javascripts/jquery/application.js
+- lib/ymdp/javascripts/jquery/application.js.coffee
 - lib/ymdp/javascripts/jquery/authorization.js
+- lib/ymdp/javascripts/jquery/authorization.js.coffee
 - lib/ymdp/javascripts/jquery/browser.js
+- lib/ymdp/javascripts/jquery/browser.js.coffee
 - lib/ymdp/javascripts/jquery/data.js
+- lib/ymdp/javascripts/jquery/data.js.coffee
 - lib/ymdp/javascripts/jquery/debug.js
+- lib/ymdp/javascripts/jquery/debug.js.coffee
 - 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/init.js.coffee
 - lib/ymdp/javascripts/jquery/launcher.js
+- lib/ymdp/javascripts/jquery/launcher.js.coffee
 - lib/ymdp/javascripts/jquery/logger.js
+- lib/ymdp/javascripts/jquery/logger.js.coffee
 - lib/ymdp/javascripts/jquery/params.js
+- lib/ymdp/javascripts/jquery/params.js.coffee
 - lib/ymdp/javascripts/jquery/reporter.js
+- lib/ymdp/javascripts/jquery/reporter.js.coffee
 - lib/ymdp/javascripts/jquery/tag_helper.js
 - lib/ymdp/javascripts/jquery/user.js
+- lib/ymdp/javascripts/jquery/user.js.coffee
 - lib/ymdp/javascripts/prototype/ab_testing.js
 - lib/ymdp/javascripts/prototype/ajax.js
 - lib/ymdp/javascripts/prototype/application.js