lanalytics-rails 0.2.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bccfc3e4db4ed376314e8f978c475749316f58dc
+  data.tar.gz: 5e311be19936df67cf1028f9ed4b15694d8fa90a
+SHA512:
+  metadata.gz: c5cde7057286068c228fd7bc03ebdb5a0ee09ab9672aab058fdadbe32b50c613820439fdaadfbd257f1bfce84ce9cff182d16fcacf4b91957cf80c61ceae10db
+  data.tar.gz: 218af978189ca12381fdc77a3f5d813aef704dd65a48a303f4df51e9d74d014e8a366c5ba1d5d2f8c45ffacd325e0f1a2c9e8861bf3a0c0c7cf4e2ebdbe268ff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,43 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'geminabox/rake'
+Geminabox::Rake.install host: 'https://gemuser:K6c1mcRWtrTQepS6aI8HRXc7DPoRYXbG@dev.xikolo.de/gems/',
+                        dir: '.',
+                        namespace: 'lanalytics-rails'
+                        
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lanalytics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+# require 'jasmine'
+# load 'jasmine/tasks/jasmine.rake'
+
+begin
+  require 'jasmine'
+    load 'jasmine/tasks/jasmine.rake'
+  rescue LoadError
+    task :jasmine do
+     abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/app/assets/javascripts/lanalytics.js

@@ -0,0 +1,17 @@
+// Including the files necessary for the Lanalytics service
+
+//= require jquery
+
+//= require ./lanalytics/model/lanalytics.model.stmt_component.js.coffee
+//= require ./lanalytics/model/lanalytics.model.stmt_resource.js.coffee
+//= require ./lanalytics/model/lanalytics.model.stmt_verb.js.coffee
+//= require ./lanalytics/model/lanalytics.model.stmt_user.js.coffee
+//= require ./lanalytics/model/lanalytics.model.exp_api_statement.js.coffee
+//= require ./lanalytics/lanalytics.framework.js.coffee
+//= require_directory ./lanalytics/plugins
+
+// Files that we do not want to release
+//= stub ./lanalytics/plugins/lanalytics.plugins.newplugintemplate.js.coffee
+//= stub ./lanalytics/plugins/lanalytics.plugins.example.html5videoplayer.js.coffee
+
+lanalytics = new Lanalytics.Framework();

data/app/assets/javascripts/lanalytics/lanalytics.framework.js.coffee

@@ -0,0 +1,128 @@
+# Turning on debug mode for development
+# DEBUG = true  if typeof DEBUG is "undefined"
+# Turning off debug mode for development
+DEBUG = false  if typeof DEBUG is "undefined"
+
+window.Lanalytics or= {};
+
+class window.Lanalytics.Framework
+
+  constructor: ->
+    @eventQueue = [];
+    @plugins = []
+
+  addPlugin: (plugin) ->
+#    if plugin instanceof  throw "Plugin is not a Lanalytics.Plugin
+    @plugins.push(plugin)
+
+  currentUser: ->
+    if gon?.lanalytics?.current_user?
+      return new Lanalytics.Model.StmtUser(gon.lanalytics.current_user.id)
+    else
+      return new Lanalytics.Model.AnonymousUser()
+
+  track: (user, verb, resource, withResult = {}, inContext = {}) ->
+
+    # If a verb is key, we will replace it with the verb that we need to transmit
+    verb = Lanalytics.VerbDictionary.getVerb(verb) if typeof verb is "string"
+    now = new Date()
+
+    experienceStmt = new Lanalytics.Model.ExpApiStatement(user, verb, resource, now, withResult, inContext)
+
+    @eventQueue.push(experienceStmt)
+
+    @processEventQueue()
+
+    console.debug("New event was tracked:", experienceStmt) if (DEBUG)
+
+  # Verb can a key or an js object
+  # Resource should be an object that contains the resource type and the resource key
+  trackCurrentUserDoing: (verb, resource, withResult = {}, inContext = {}) ->
+
+    user = @currentUser()
+    @track(user, verb, resource, withResult, inContext)
+
+  processEventQueue: ->
+
+#    if eventQueue < 10
+
+    experienceStatement = @eventQueue.shift()
+
+    $.ajax("/lanalytics/log", {
+      type: 'POST',
+      cache: false,
+      dataType: 'JSON',
+      data: experienceStatement.params() ,
+      success: (response_data, text_status, jqXHR) ->
+        # Do nothing for now
+      error: (jqXHR, textStatus, errorThrown) =>
+        @eventQueue.push(experienceStatement)
+    })
+
+
+class window.Lanalytics.VerbDictionary
+
+  @_verbDict = {
+    "video-play": {
+      verb_key: "video_play",
+      verb_id: "http://lanalytics.open.hpi.de/expapi/verbs/video-play"
+    },
+    "video-pause": {
+      verb_key: "video_pause",
+      verb_id: "http://lanalytics.open.hpi.de/expapi/verbs/video-stop"
+    },
+    "video-seek": {
+      verb_key: "video_seek",
+      verb_id: 'http://lanalytics.open.hpi.de/expapi/verbs/quiz-submitted'
+    },
+    "video-change-speed": {
+      verb_key: "video_change_speed",
+      verb_id: 'http://lanalytics.open.hpi.de/expapi/verbs/video-change-speed'
+    },
+    "quiz-submitted": {
+      verb_key: "quiz_submitted",
+      verb_id: 'http://lanalytics.open.hpi.de/expapi/verbs/quiz-submitted'
+    },
+    "video-change-size": {
+      verb_key: "video_change_size",
+      verb_id: 'http://lanalytics.open.hpi.de/expapi/verbs/video-change-size'
+    },
+    "video-fullscreen": {
+      verb_key: "video_fullscreen",
+      verb_id: 'http://lanalytics.open.hpi.de/expapi/verbs/video-fullscreen'
+    }
+
+  }
+
+  @_undefinedVerbTemplate = {
+    verb_key: "undefined",
+    id: "http://lanalytics.open.hpi.de/expapi/verbs/undefined"
+  }
+
+  @getVerb: (id) ->
+
+    if VerbDictionary._verbDict[id]?
+      return new Lanalytics.Model.StmtVerb(VerbDictionary._verbDict[id].verb_key)
+    else
+      return new Lanalytics.Model.StmtVerb(id)
+
+
+
+class window.Lanalytics.Plugin
+  constructor: (@lanalytics) ->
+
+  @newInstance: (lanalyticsTracker) ->
+    throw "This function has to be implemented in the subclass."
+
+# The plugin are supposed to be defined under this namesspace
+window.Lanalytics.Plugins or= {};
+
+$ ->
+  for pluginClassName in Object.keys(Lanalytics.Plugins)
+    try
+      plugin = Lanalytics.Plugins[pluginClassName].newInstance(lanalytics)
+      lanalytics.addPlugin(plugin)
+      console.log("Lanalytics.Plugins.#{pluginClassName} found, created and added") if (DEBUG)
+    catch error
+      console.log("Lanalytics.Plugins.#{pluginClassName} found, but could not be instantiated") if (DEBUG)
+      console.log(error.stack) if (DEBUG)

data/app/assets/javascripts/lanalytics/model/lanalytics.model.exp_api_statement.js.coffee

@@ -0,0 +1,41 @@
+window.Lanalytics or= {};
+window.Lanalytics.Model or= {};
+
+class window.Lanalytics.Model.ExpApiStatement
+
+  constructor: (user, verb, resource, timestamp = new Date(), @with_result = {}, @in_context = {}) ->
+    #  ::TODO Some assertions to ensure the datamodel
+    throw "'user' argument cannot be nil and should be Lanalytics::Model::StmtUser" unless user instanceof Lanalytics.Model.StmtUser
+    @user = user
+
+    throw "'verb' argument cannot be nil and should be Lanalytics::Model::StmtVerb" unless verb instanceof Lanalytics.Model.StmtVerb
+    @verb = verb
+
+    throw "'resource' argument cannot be nil and should be Lanalytics::Model::StmtResource" unless resource instanceof Lanalytics.Model.StmtResource
+    @resource = resource
+
+    timestamp ||= DateTime.now
+    throw "'timestamp' argument should be DateTime or String" unless timestamp instanceof Date or timestamp instanceof String
+    timestamp = new Date(timestamp) if timestamp instanceof String
+    @timestamp = timestamp
+
+
+  # This is the serialization  
+  serialize: ->
+    return JSON.stringify(@params)
+
+  params: ->
+    return {
+      user: @user.params(),
+      verb: @verb.params(),
+      resource: @resource.params(),
+      timestamp: @timestamp,
+      with_result: @with_result,
+      in_context: @in_context
+    }
+
+    
+    
+
+
+

data/app/assets/javascripts/lanalytics/model/lanalytics.model.stmt_component.js.coffee

@@ -0,0 +1,8 @@
+window.Lanalytics or= {};
+window.Lanalytics.Model or= {};
+
+class window.Lanalytics.Model.StmtComponent
+
+  constructor: (type) ->
+    throw "'type' argument cannot be nil and or empty" if !type? || !type.trim().length
+    @type = type.toString()

data/app/assets/javascripts/lanalytics/model/lanalytics.model.stmt_resource.js.coffee

@@ -0,0 +1,16 @@
+window.Lanalytics or= {};
+window.Lanalytics.Model or= {};
+
+class window.Lanalytics.Model.StmtResource extends Lanalytics.Model.StmtComponent
+
+  constructor: (type, uuid) ->
+    super(type)
+
+    throw "'uuid' argument cannot be nil or empty" if !uuid? || !uuid.trim().length
+    @uuid = uuid.toString()
+
+  params: ->
+    return {
+      type: @type,
+      uuid: @uuid
+    }

data/app/assets/javascripts/lanalytics/model/lanalytics.model.stmt_user.js.coffee

@@ -0,0 +1,14 @@
+window.Lanalytics or= {};
+window.Lanalytics.Model or= {};
+
+class window.Lanalytics.Model.StmtUser extends window.Lanalytics.Model.StmtResource
+
+  constructor: (uuid) ->
+    super("User", uuid)
+
+
+
+class window.Lanalytics.Model.AnonymousUser extends window.Lanalytics.Model.StmtUser
+
+  constructor: ->
+    super("User", "ANONYMOUS")

data/app/assets/javascripts/lanalytics/model/lanalytics.model.stmt_verb.js.coffee

@@ -0,0 +1,12 @@
+window.Lanalytics or= {};
+window.Lanalytics.Model or= {};
+
+class window.Lanalytics.Model.StmtVerb extends window.Lanalytics.Model.StmtComponent
+
+  constructor: (type) ->
+    super(type)
+
+  params: ->
+    return {
+      type: @type,
+    }

data/app/assets/javascripts/lanalytics/plugins/lanalytics.plugins.example.html5videoplayer.js.coffee

@@ -0,0 +1,25 @@
+# This plugin was created for the xikolo-web application in order to track the events from the (custom) video player
+# This is exactly the situation for which a olugin is designed for ...
+class window.Lanalytics.Plugins.Html5VideoPlayerTracker extends Lanalytics.Plugin
+
+  # This is the interface method expected by Lanalytics
+  # Should return a valid instance of the plugin
+  @newInstance: (lanalytics) ->
+    return new Lanalytics.Plugins.Html5VideoPlayerTracker(lanalytics)
+
+  constructor: (lanalytics) ->
+    super(lanalytics)
+    this._init()
+
+  _init: ->
+    $(document).on("video-play", @trackVideoPlay)
+    $(document).on("video-pause", @trackVideoPause)
+
+  # It is important to use '=>' because then 'this' will be binded to StaticHtmlEventTracker instance (in order to access lanalytics)
+  trackVideoPlay: (event, videoPlayerData) =>
+    stmtResource = new Lanalytics.Model.StmtResource("Item", videoPlayerData.resource)
+    @lanalytics.track("video-play", stmtResource)
+
+  trackVideoPause: (event, videoPlayerData) =>
+    stmtResource = new Lanalytics.Model.StmtResource("Item", videoPlayerData.resource)
+    @lanalytics.trackCurrentUserDoing("video-pause", stmtResource)

data/app/assets/javascripts/lanalytics/plugins/lanalytics.plugins.newplugintemplate.js.coffee

@@ -0,0 +1,23 @@
+
+class window.Lanalytics.Plugins.NewLanalyticsPlugin extends Lanalytics.Plugin
+
+  # This is the interface method expected by Lanalytics
+  # Should return a valid instance of the plugin
+  @newInstance: (lanalytics) ->
+    return new Lanalytics.Plugins.NewLanalyticsPlugin(lanalytics)
+
+  constructor: (lanalytics) ->
+    super(lanalytics)
+    this._init()
+
+  _init: ->
+    # Do something
+    # Register to some events in the DOM, e.g. $(document).on("video-play", @trackVideoPlay)
+    $(document).on("video-pause", @trackVideoPause)
+
+  # Handler for the event in the DOM
+  # It is important to use '=>' because then 'this' will be binded to NewLanalyticsPlugin instance (in order to access lanalytics)
+  # trackVideoPlay: (event, videoPlayerData) =>
+  #   @lanalytics.trackCurrentUserDoing("video-play", {
+  #     resource_id: videoPlayerData.resource
+  #   })

data/app/assets/javascripts/lanalytics/plugins/lanalytics.plugins.pageviewplugin.js.coffee

@@ -0,0 +1,42 @@
+
+class window.Lanalytics.Plugins.PageViewPlugin extends Lanalytics.Plugin
+
+  # This is the interface method expected by Lanalytics
+  # Should return a valid instance of the plugin
+  @newInstance: (lanalytics) ->
+    return new Lanalytics.Plugins.PageViewPlugin(lanalytics)
+
+  constructor: (lanalytics) ->
+    super(lanalytics)
+    this._init()
+    @windowLoadTimestamp = undefined
+
+  _init: ->
+    $(window).load(@enterPage);
+
+    # $(window).unload(@leavePage);
+
+  enterPage: (event, data) =>
+    @windowLoadTimestamp = @currentTime()
+
+    # Do nothing if there is no user logged in
+    return if @lanalytics.currentUser() instanceof Lanalytics.Model.AnonymousUser
+
+    inContext =
+      user_os: navigator?.platform
+      user_agent: navigator?.userAgent
+      user_app_version: navigator?.appVersion
+
+    urlPathLocation = window?.location?.pathname
+    stmtResource = new Lanalytics.Model.StmtResource("PAGE", urlPathLocation)
+    @lanalytics.trackCurrentUserDoing("viewed_page", stmtResource, {}, inContext)
+
+
+  # leavePage: (event, videoPlayerData) =>
+  #   @windowLoadTimestamp
+  #   timeOnPage = @currentTime() - @windowLoadTimestamp
+  #   console.log(data)
+  #   @lanalytics.trackCurrentUserDoing("observed", stmtResource)
+
+  currentTime: ->
+    return new Date().getTime()

data/app/assets/javascripts/lanalytics/plugins/lanalytics.plugins.statichtmlevent.js.coffee

@@ -0,0 +1,31 @@
+
+
+class window.Lanalytics.Plugins.StaticHtmlEventTracker extends Lanalytics.Plugin
+
+  # This is the interface method expected by Lanalytics
+  # Should return a valid instance of the plugin
+  @newInstance: (lanalytics) ->
+    return new Lanalytics.Plugins.StaticHtmlEventTracker(lanalytics)
+
+  constructor: (lanalytics) ->
+    super(lanalytics)
+    this._init()
+
+  _init: ->
+    $("*[data-lanalytics-event]").on("click", @processStaticHtmlEvent)
+
+  # It is important to use '=>' because then 'this' will be binded to StaticHtmlEventTracker instance (in order to access lanalytics)
+  processStaticHtmlEvent: (event) =>
+    
+    clickedElement = event.target
+    lanalyticsParentsOfElement = $(clickedElement).parents("[data-lanalytics-resource]")
+    if lanalyticsParentsOfElement.length == 0
+      throw "No 'data-lanalytics-resource' field could be found in the parents of #{$(clickedElement).html().trim()}."
+
+    eventData = $(clickedElement).data("lanalytics-event")
+    stmtVerb = new Lanalytics.Model.StmtVerb(eventData['verb'])
+
+    eventResourceData = lanalyticsParentsOfElement.first().data("lanalytics-resource");
+    stmtResource = new Lanalytics.Model.StmtResource(eventResourceData['type'], eventResourceData['uuid'])
+
+    @lanalytics.trackCurrentUserDoing(stmtVerb, stmtResource)