videojs_user_track 0.1

data/README.markdown

@@ -0,0 +1,36 @@
+在video-js框架里，记录用户重复播放视频里各部分的频度。
+==================================================================
+
+### 需求
+判断教学视频如何被用户观看的效果，最简单的是看用户如何重复播放或跳过播放。
+
+### 技术详解
+初始化一个长度为要播放视频的以秒为单位长度的数组，各元素初始为零。如果视频正在播放，则给该秒加一; 重复播放，则继续加一。
+
+### 使用
+1.   添加videojs_user_tracks数据库表，bundle exec rake db:migrate
+2.   实现VideojsUserTrack_Rails::Auth#auth方法
+3.   在js里引用//= require videojs_user_track.js
+4.   配置js参数，比如 _V_.user_track(eoe.video_player, section_id, eoe.uid, {uhash: eoe.uhash})
+5.   播放一个视频，看看Rails log或数据库里是否出现了更新
+
+### 用户认证
+在config/initializers/videojs_user_track_rails.rb添加如下代码，并实现你的auth方法
+
+```ruby
+module VideojsUserTrack_Rails
+  module Auth
+    def auth
+      # your auth code, it can acces the scope in videojs controller
+    end
+  end
+end
+```
+
+### TODO
+1. 支持其他浏览器内视频播放框架，去video-js化
+2. 管理页面
+
+
+### License
+MIT

data/app/assets/javascripts/videojs_user_track.js

@@ -0,0 +1,84 @@
+/*
+ * VideoJS视频播放秒数监控
+ * 两个setInterval对播放数组做　浏览器本地　和　服务器　同步。
+ *
+ * 附加 断点播放时间记录(为了重复利用setInterval事件以节省资源)
+ *
+*/
+window.videojs_user_track = function(videojs, video_id, uid, auth_data_hash) {
+  if (!window.jQuery) { throw("Please require jQuery first"); }
+  if (!window._V_) { throw("Please require videojs first"); }
+
+  var local_a = [];
+  var last_second; // 用于排重，因为实际执行的setInterval一秒很可能超过一秒，所以和上一个读取值比较即可。
+  var video_length = 0;
+  auth_data_hash = (auth_data_hash || {});
+
+  var store_to_local = function(idx) {
+    if (idx != last_second) {
+      local_a.push(idx);
+      last_second = idx;
+      // 记录断点播放
+      if (idx > 5) { auth_data_hash.last_played_at = last_second; }
+    }
+  };
+  var sync_to_server = function() {
+    // save tmp length, to avoid another function modify it.
+    var _l = local_a.length;
+    if (video_length === 0) { video_length = Math.round(videojs.duration()); }
+
+    if (_l !== 0) {
+      var remote_a = local_a.splice(0, _l);
+      // TODO unshift if failure
+      $.ajax({
+        type: 'PUT',
+        url: '/videojs.json',
+        data: $.extend(auth_data_hash, {
+          video_length: video_length,
+          seconds: remote_a,
+          video_id: video_id,
+          uid: uid
+        })
+      }).done(function (data, textStatus) {
+        if ((data.result + '').match(/fail/)) {
+          clearInterval(intevals.local);
+          clearInterval(intevals.server);
+          console.log(data, "Stoped two setIntevals");
+        }
+      });
+    }
+  };
+  var inspect = function() {
+    console.log((new Date()), ' current seconds is ', local_a);
+  };
+
+  var intevals = {};
+  // TODO 优化，为了避免循环，只在播放时执行，也可以考虑缓存videojs.paused()
+  // 存储播放时间到浏览器本地
+  intevals.local = setInterval(function() {
+    if (!videojs.paused()) {
+      // NOTICE 有时可能因为浏览器资源竞争而导致部分秒没有获取
+      var time_idx = Math.round(videojs.currentTime());
+      store_to_local(time_idx);
+    }
+  }, 333);
+
+  // 同步播放时间到服务器
+  // 不和存储同步是会因为函数阻塞而错过部分时间段
+  setTimeout(function() {
+    intevals.server = setInterval(function() {
+      sync_to_server();
+    }, 3000);
+
+    // 在关闭窗口或离开页面前同步
+    // 得允许多个beforeunload事件
+    $(window).bind('beforeunload', function(event) {
+      console.log("send watching data before close the window...");
+      sync_to_server();
+    });
+  }, 5000); // 需观看5秒以上才考虑同步服务器
+
+};
+
+// 测试对浏览器内存和CPU基本无影响。视频播放完后，内存稳定在130.64MB，即使是重复播放。
+// TODO 整理成videojs plugin，但目前videojs master似乎有bug，编译的js运行出错，有时间改下。

data/app/controllers/videojs_controller.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+class VideojsController < ApplicationController
+  include VideojsUserTrack_Rails::Auth
+
+  def update
+    @result = if auth
+      ut = VideojsUserTrack.find_or_create_by_video_id_and_uid(params[:video_id], params[:uid])
+      ut.update_attributes(:video_second_length => params[:video_length]) if ut.video_second_length.to_i.zero?
+      ut.inc_seconds(params[:seconds], params[:last_played_at])
+      'success'
+    else
+      'auth failure'
+    end
+
+    respond_to do |format|
+      format.json { render :json => {:result => @result}, :status => 200 }
+    end
+  end
+end

data/app/models/videojs_user_track.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+class VideojsUserTrack < ActiveRecord::Base
+  attr_accessible :video_id, :uid, :video_second_length, :status, :mark_watched
+
+  # like array index in Ruby, idx begins with 0
+  def inc_seconds seconds, last_played_at = nil
+    return false if seconds.blank?
+    seconds = seconds.map(&:to_i).uniq
+    return false if seconds.detect {|second| (second > ut.video_second_length) || (second < 0)} # 大于video_second_length的秒一定不合法
+
+    seconds.each do |second|
+      data[second] ||= 0
+      data[second] +=  1
+      data[second] = 9 if data[second] >= 10 # 最多只记录9次
+    end
+    self.last_played_at = last_played_at if not last_played_at.to_i.zero?
+
+    resave!
+  end
+
+  # 返回未看的 最大连续区域的首个索引
+  def max_unwatched_range_begin_at
+    data_str = data.join
+    # 区分零和非零区域
+    flags = data_str.scan(/[1-9]+|0+/)
+    flag_zero_max = flags.select {|i| i.to_i.zero? }.max {|i| i.length }
+    return 0 if flag_zero_max.nil?
+    data_str.index(flag_zero_max) + 1
+  end
+
+  def played_percents
+    return 0.0 if data.size.zero?
+    data.reject {|i| i.to_i.zero? }.size / data.size.to_f
+  end
+
+  def finished?
+    # 避免视频没有初始化
+    (video_second_length > 10) &&
+    # 总时长误差不超过5秒
+    ((data.length - video_second_length).abs <= 5) &&
+    (
+      # 判断中断次数是否超过总秒数的二十分之一，否则就算看完。
+      # 比如60秒的视频，里面没看的只有3秒，不管连续还是不连续，就算看完了。
+      (played_percents >= 0.95) ||
+      # 或者强制标记看完
+      self.mark_watched
+    )
+  end
+
+  def data
+    @data ||= (begin
+      a = JSON.parse(ut.status.to_s) rescue []
+      (a[ut.video_second_length - 1] ||= 0) if not ut.video_second_length.zero?
+      a.map(&:to_i)
+    end)
+  end
+
+  # alias user_track
+  def ut; self end
+  def resave!
+    ut.status = data.to_json
+    ut.save!
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match 'videojs'=> "videojs#update", :via => :put
+end

data/db/migrate/20130401075529_create_videojs_user_track.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+class CreateVideojsUserTrack < ActiveRecord::Migration
+  def up
+    create_table :videojs_user_tracks, :options => 'ENGINE=Innodb DEFAULT CHARSET=utf8', :comment => "每个用户的播放视频小节的时间频度" do |t|
+      t.string  :video_id, :default => 0, :comment => "视频ID"
+      t.integer :uid, :default => 0, :comment => "用户ID"
+      t.integer :video_second_length, :default => 0
+      t.text    :status, :comment => "初始化一个长度为要播放视频的以秒为单位长度的数组，各元素初始为零。如果视频正在播放，则给该秒加一; 重复播放，则继续加一。示例格式为" # copied from README
+      t.timestamps
+    end
+    add_index :videojs_user_tracks, [:video_id, :uid]
+  end
+
+  def down
+  end
+
+end

data/db/migrate/20130530085750_add_last_played_at_to_videojs_user_track.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+class AddLastPlayedAtToVideojsUserTrack < ActiveRecord::Migration
+  def change
+    add_column :videojs_user_tracks, :last_played_at, :integer, :comment => "上次播放时间"
+  end
+end

data/db/migrate/20130607080640_add_mark_watched_to_videojs_user_track.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+class AddMarkWatchedToVideojsUserTrack < ActiveRecord::Migration
+  def change
+    add_column :videojs_user_tracks, :mark_watched, :boolean, :default => false, :comment => "手工标记看完"
+  end
+end

data/lib/rails_engine.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module VideojsUserTrack_Rails
+  module Auth
+  end
+ 
+  class Engine < Rails::Engine
+    initializer "videojs_user_track.load_app_instance_data" do |app|
+      app.class.configure do
+        ['db/migrate', 'app/models', 'app/controllers'].each do |path|
+          config.paths[path] += VideojsUserTrack_Rails::Engine.paths[path].existent
+        end
+      end
+    end
+  end
+end

data/lib/videojs_user_track.rb

@@ -0,0 +1,3 @@
+# encoding: UTF-8
+
+require File.expand_path('../rails_engine.rb', __FILE__)

data/videojs_user_track.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'videojs_user_track'
+  s.version     = '0.1'
+  s.date        = '2013-04-01'
+  s.summary     = File.read("README.markdown").split(/===+/)[0].strip
+  s.description = s.summary
+  s.authors     = ["David Chen"]
+  s.email       = 'mvjome@gmail.com'
+  s.homepage    = 'https://github.com/eoecn/videojs_user_track'
+
+  s.files = `git ls-files`.split("\n")
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: videojs_user_track
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- David Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies: []
+description: 在video-js框架里，记录用户重复播放视频里各部分的频度。
+email: mvjome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- app/assets/javascripts/videojs_user_track.js
+- app/controllers/videojs_controller.rb
+- app/models/videojs_user_track.rb
+- config/routes.rb
+- db/migrate/20130401075529_create_videojs_user_track.rb
+- db/migrate/20130530085750_add_last_played_at_to_videojs_user_track.rb
+- db/migrate/20130607080640_add_mark_watched_to_videojs_user_track.rb
+- lib/rails_engine.rb
+- lib/videojs_user_track.rb
+- videojs_user_track.gemspec
+homepage: https://github.com/eoecn/videojs_user_track
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: 在video-js框架里，记录用户重复播放视频里各部分的频度。
+test_files: []