Output the number of read threads by a user in social stats.

api/users.rb

@@ -95,14 +95,14 @@ get "#{APIPREFIX}/users/:user_id/social_stats" do |user_id|
 
     user_stats = {}
     thread_ids = {}
+    flat_thread_ids = []
 
     content_selector = {course_id: course_id, anonymous: false, anonymous_to_peers: false}
     if end_date
       content_selector[:created_at.lte] = end_date
     end
 
-    if user_id != '*'
-      content_selector["author_id"] = user_id
+    def set_template_result(user_id, user_stats, thread_ids)
       user_stats[user_id] = {
         "num_threads" => 0,
         "num_comments" => 0,
@@ -110,11 +110,18 @@ get "#{APIPREFIX}/users/:user_id/social_stats" do |user_id|
         "num_upvotes" => 0,
         "num_downvotes" => 0,
         "num_flagged" => 0,
-        "num_comments_generated" => 0
+        "num_comments_generated" => 0,
+        "num_thread_followers" => 0,
+        "num_threads_read" => 0,
       }
       thread_ids[user_id] = []
     end
 
+    if user_id != '*'
+      content_selector["author_id"] = user_id
+      set_template_result(user_id, user_stats, thread_ids)
+    end
+
     # get all metadata regarding forum content, but don't bother to fetch the body
     # as we don't need it and we shouldn't push all that data over the wire
     content = Content.where(content_selector).without(:body)
@@ -138,21 +145,13 @@ get "#{APIPREFIX}/users/:user_id/social_stats" do |user_id|
       user_id = item.author_id
 
       if user_stats.key?(user_id) == false then
-        user_stats[user_id] = {
-          "num_threads" => 0,
-          "num_comments" => 0,
-          "num_replies" => 0,
-          "num_upvotes" => 0,
-          "num_downvotes" => 0,
-          "num_flagged" => 0,
-          "num_comments_generated" => 0
-        }
-        thread_ids[user_id] = []
+        set_template_result(user_id, user_stats, thread_ids)
       end
 
       if item._type == "CommentThread" then
         user_stats[user_id]["num_threads"] += 1
         thread_ids[user_id].push(item._id)
+        flat_thread_ids.push(item._id)
         user_stats[user_id]["num_comments_generated"] += item.comment_count
       elsif item._type == "Comment" and item.parent_ids == [] then
         user_stats[user_id]["num_comments"] += 1
@@ -168,6 +167,7 @@ get "#{APIPREFIX}/users/:user_id/social_stats" do |user_id|
       user_stats[user_id]["num_downvotes"] += item.votes["down"].count
 
       user_stats[user_id]["num_flagged"] += item.abuse_flaggers.count
+
     end
 
     # with the array of objectId's for threads, get a count of number of other users who have a subscription on it
@@ -179,6 +179,15 @@ get "#{APIPREFIX}/users/:user_id/social_stats" do |user_id|
       end
     end
 
+    # Get the number of threads read by each user.
+    users = User.only([:_id, :read_states]).where("read_states.course_id" => course_id)
+    users.each do |user|
+      if user_stats.key?(user._id) == false then
+        set_template_result(user._id, user_stats, thread_ids)
+      end
+      user_stats[user._id]["num_threads_read"] = user.read_states.find_by(:course_id => course_id).last_read_times.length
+    end
+
     user_stats.to_json
   end
 end

spec/api/user_spec.rb

@@ -388,15 +388,16 @@ describe "app" do
         @user4 = create_test_user 4
       end
 
-      def check_social_stats(response, excpected)
-        excpected.each do |key, value|
+      def check_social_stats(response, expected)
+        expected.each do |key, value|
           response[key].should == value
         end
       end
 
       def make_social_stats(
         num_threads, num_comments, num_replies, num_upvotes,
-        num_downvotes, num_flagged, num_comments_generated, num_thread_followers
+        num_downvotes, num_flagged, num_comments_generated, num_thread_followers,
+        num_threads_read
       )
         {
           "num_threads" => num_threads,
@@ -406,7 +407,8 @@ describe "app" do
           "num_downvotes" => num_downvotes,
           "num_flagged" => num_flagged,
           "num_comments_generated" => num_comments_generated,
-          "num_thread_followers" => num_thread_followers
+          "num_thread_followers" => num_thread_followers,
+          "num_threads_read" => num_threads_read,
         }
       end
 
@@ -464,33 +466,33 @@ describe "app" do
 
       describe "single user" do
         it "returns zeroes for missing user" do
-          check_social_stats(make_request(10000, DFLT_COURSE_ID), {"10000" => make_social_stats(0,0,0,0,0,0,0,0)})
+          check_social_stats(make_request(10000, DFLT_COURSE_ID), {"10000" => make_social_stats(0,0,0,0,0,0,0,0,0)})
         end
 
         it "returns zeroes for existing user with no activity" do
           thread = make_thread(@user1, "irrelevant text", DFLT_COURSE_ID, "irrelevant commentable_id")
-          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0)})
+          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0,0)})
         end
 
         [1,2].each do |thread_count|
           [0,3].each do |comment_count|
             [2,0,4].each do |reply_count|
               it "returns correct thread, comment, reply and comments generated count (#{thread_count}, #{comment_count}, #{reply_count})" do
-                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0)})
+                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0,0)})
 
                 fixed_thread = make_thread(@user2, "Fixed thread", DFLT_COURSE_ID, "fixed_thread")
                 fixed_comment = make_comment(@user2, fixed_thread, "fixed comemnt text")
 
-                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(1,1,0,0,0,0,1,0)})
+                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(1,1,0,0,0,0,1,0,0)})
 
                 thread_count.times {|i| make_thread(@user1, "text#{i}", DFLT_COURSE_ID, "commentable_id#{i}") }
                 comment_count.times {|i|  make_comment(@user1, fixed_thread, "comment#{i}") }
                 reply_count.times {|i| make_comment(@user1, fixed_comment, "response#{i}")}
 
                 # precondition - checking that user2 has only one thread and one comment - the fixed ones
-                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(1,1,0,0,0,0,comment_count+reply_count+1,0)})
+                check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(1,1,0,0,0,0,comment_count+reply_count+1,0,0)})
 
-                check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(thread_count,comment_count,reply_count,0,0,0,0,0)})
+                check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(thread_count,comment_count,reply_count,0,0,0,0,0,0)})
               end
             end
           end
@@ -501,7 +503,7 @@ describe "app" do
           comment = make_comment(@user1, thread, "Comment1-1")
           reply = make_comment(@user1, comment, "Reply1-1-1")
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0,0)})
         end
 
         it "returns correct upvotes and downvotes count" do
@@ -516,7 +518,7 @@ describe "app" do
           set_votes(@user1, "down", [thread2, comment1])
           set_flags(@user1, [thread1, thread2, comment1, reply2])
 
-          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(2,2,2,3,2,4,4,0)})
+          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(2,2,2,3,2,4,4,0,0)})
         end
 
         it "ignores self-upvotes and self-downvotes" do
@@ -527,7 +529,7 @@ describe "app" do
           set_votes(@user1, "up", [thread, comment, reply])
           set_votes(@user1, "down", [thread, comment, reply])
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0,0)})
         end
 
         it "returns correct follower count" do
@@ -535,7 +537,7 @@ describe "app" do
 
           subscribe(thread, [@user2, @user3])
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,0,0,0,0,0,0,2)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,0,0,0,0,0,0,2,0)})
         end
 
         it "ignores self-subscriptions" do
@@ -543,7 +545,7 @@ describe "app" do
 
           subscribe(thread, [@user1])
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,0,0,0,0,0,0,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,0,0,0,0,0,0,0,0)})
         end
 
         it "ignores subscriptions to comments and replies" do
@@ -554,7 +556,18 @@ describe "app" do
           subscribe(comment, [@user2])
           subscribe(reply, [@user2])
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0,0)})
+        end
+
+        it "returns a count of how many threads have been read" do
+          thread = make_thread(@user1, "Some thread", DFLT_COURSE_ID, "Thread 1")
+          thread2 = make_thread(@user1, "Some other thread", DFLT_COURSE_ID, "Thread 2")
+          @user2.mark_as_read(thread)
+          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0,1)})
+          @user2.mark_as_read(thread2)
+          check_social_stats(make_request(@user2.id, DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0,2)})
+          # Make sure it also works when selecting all.
+          check_social_stats(make_request("*", DFLT_COURSE_ID), {@user2.id => make_social_stats(0,0,0,0,0,0,0,0,2)})
         end
 
         it "respects end_date parameter when calculating thread, comment, reply and comments generated counts" do
@@ -575,10 +588,10 @@ describe "app" do
             content.save!
           end
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(2,2,2,0,0,0,4,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID), {@user1.id => make_social_stats(2,2,2,0,0,0,4,0,0)})
           # TODO: looks like a bug, but preserving it for now; comments generated should probably be 2, as comment1 and reply1 were created after end_date
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, DateTime.new(2015, 03, 01)), {@user1.id => make_social_stats(1,1,1,0,0,0,4,0)})
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, DateTime.new(2015, 02, 01)), {@user1.id => make_social_stats(0,0,0,0,0,0,0,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, DateTime.new(2015, 03, 01)), {@user1.id => make_social_stats(1,1,1,0,0,0,4,0,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, DateTime.new(2015, 02, 01)), {@user1.id => make_social_stats(0,0,0,0,0,0,0,0,0)})
         end
 
         it "respects thread_type parameter when calculating thread, comment, reply and comments generated counts" do
@@ -590,9 +603,9 @@ describe "app" do
           reply1 = make_comment(@user1, comment1, "Reply1-1-1")
           reply2 = make_comment(@user1, comment2, "Reply1-2-1")
 
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil), {@user1.id => make_social_stats(2,3,2,0,0,0,5,0)})
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil, :discussion), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0)})
-          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil, :question), {@user1.id => make_social_stats(1,2,1,0,0,0,3,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil), {@user1.id => make_social_stats(2,3,2,0,0,0,5,0,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil, :discussion), {@user1.id => make_social_stats(1,1,1,0,0,0,2,0,0)})
+          check_social_stats(make_request(@user1.id, DFLT_COURSE_ID, nil, :question), {@user1.id => make_social_stats(1,2,1,0,0,0,3,0,0)})
         end
       end
 
@@ -624,8 +637,8 @@ describe "app" do
 
         it "returns correct stats for all users" do
           check_social_stats(make_request('*', DFLT_COURSE_ID), {
-            @user1.id => make_social_stats(1,1,2,3,0,4,5,1),
-            @user2.id => make_social_stats(2,3,1,5,0,3,2,3),
+            @user1.id => make_social_stats(1,1,2,3,0,4,5,1,0),
+            @user2.id => make_social_stats(2,3,1,5,0,3,2,3,0),
           })
         end
 
@@ -646,42 +659,42 @@ describe "app" do
           end
 
           check_social_stats(make_request('*', DFLT_COURSE_ID), {
-            @user1.id => make_social_stats(1,1,2,3,0,4,5,1),
-            @user2.id => make_social_stats(2,3,1,5,0,3,2,3),
+            @user1.id => make_social_stats(1,1,2,3,0,4,5,1,0),
+            @user2.id => make_social_stats(2,3,1,5,0,3,2,3,0),
           })
 
           make_request('*', DFLT_COURSE_ID, DateTime.new(2015, 02, 01)).should == {}
 
           check_social_stats(make_request('*', DFLT_COURSE_ID, DateTime.new(2015, 03, 01)), {
-            @user1.id => make_social_stats(1,0,1,3,0,3,5,0),
-            @user2.id => make_social_stats(0,1,0,0,0,1,0,0),
+            @user1.id => make_social_stats(1,0,1,3,0,3,5,0,0),
+            @user2.id => make_social_stats(0,1,0,0,0,1,0,0,0),
           })
 
           check_social_stats(make_request('*', DFLT_COURSE_ID, DateTime.new(2015, 03, 13)), {
-            @user1.id => make_social_stats(1,0,1,3,0,3,5,1),
-            @user2.id => make_social_stats(1,2,1,3,0,3,1,2),
+            @user1.id => make_social_stats(1,0,1,3,0,3,5,1,0),
+            @user2.id => make_social_stats(1,2,1,3,0,3,1,2,0),
           })
 
           check_social_stats(make_request('*', DFLT_COURSE_ID, DateTime.new(2015, 03, 25)), {
-            @user1.id => make_social_stats(1,1,2,3,0,4,5,1),
-            @user2.id => make_social_stats(2,3,1,5,0,3,2,3),
+            @user1.id => make_social_stats(1,1,2,3,0,4,5,1,0),
+            @user2.id => make_social_stats(2,3,1,5,0,3,2,3,0),
           })
         end
 
         it "filters by thread_type" do
           check_social_stats(make_request('*', DFLT_COURSE_ID, nil), {
-            @user1.id => make_social_stats(1,1,2,3,0,4,5,1),
-            @user2.id => make_social_stats(2,3,1,5,0,3,2,3),
+            @user1.id => make_social_stats(1,1,2,3,0,4,5,1,0),
+            @user2.id => make_social_stats(2,3,1,5,0,3,2,3,0),
           })
 
           check_social_stats(make_request('*', DFLT_COURSE_ID, nil, :discussion), {
-            @user1.id => make_social_stats(1,0,2,3,0,3,5,1),
-            @user2.id => make_social_stats(1,3,1,4,0,3,1,2),
+            @user1.id => make_social_stats(1,0,2,3,0,3,5,1,0),
+            @user2.id => make_social_stats(1,3,1,4,0,3,1,2,0),
           })
 
           check_social_stats(make_request('*', DFLT_COURSE_ID, nil, :question), {
-            @user1.id => make_social_stats(0,1,0,0,0,1,0,0),
-            @user2.id => make_social_stats(1,0,0,1,0,0,1,1),
+            @user1.id => make_social_stats(0,1,0,0,0,1,0,0,0),
+            @user2.id => make_social_stats(1,0,0,1,0,0,1,1,0),
           })
         end
       end