Expertiza_Wiki - User contributions [en]

File:Timeline.png

2016-12-07T19:57:12Z

Pagrawa2: uploaded a new version of "File:Timeline.png"

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:51:03Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== UML Diagram:==
[[File:Class.jpg|center]]

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
[[File:View.JPG]]
[[File:Timeline.png]]

== Testing ==
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.

* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://github.com/piotrmurach/github

File:Timeline.png

2016-12-07T19:49:02Z

Pagrawa2:

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:37:04Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== UML Diagram:==
[[File:Class.jpg|center]]

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
[[File:View.JPG]]

== Testing ==
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.

* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:34:09Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== UML Diagram:==
[[File:Class.jpg|center]]

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
[[File:View.JPG]]

spec
* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

== Testing ==
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.

* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:29:04Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== UML Diagram:==
[[File:Class.jpg|center]]

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb

spec
* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

== Testing ==
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.
*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github
Doubts:
Significance of submission record table

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:15:40Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== UML Diagram:==
[[File:Class.jpg|center]]

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
+ <link rel="stylesheet" type="text/css" href="/assets/timeline.css" >
+
<div class="container">
+ <div class="row">
+ <div class="col-md-12">
+ <div class="page-header">
+ <h1>Submission History</h1>
+ </div>
+ <div style="display:inline-block;width:100%;overflow-y:auto;">
+ <ul class="timeline timeline-horizontal">
+ <% @timeline.sort.map do |key, timemark| %>
+ <%# Display timestamps from timeline hash! %>
+ <li class="timeline-item">
+ <div class="timeline-badge <%= timemark[:color] %>"><i class="glyphicon glyphicon-check"></i></div>
+ <div class="timeline-panel">
+ <div class="timeline-heading">
+ <h4 class="timeline-title"><%= timemark[:heading] %></h4>
+ <p><small class="text-muted"><i class="glyphicon glyphicon-time"></i> <%= key %></small></p>
+ </div>
+ <div class="timeline-body">
+ <p><%= timemark[:description] %></p>
+ </div>
+ </div>
+ </li>
+ <% end %>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>

spec
* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

'''Testing Plan:'''
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.
*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github
Doubts:
Significance of submission record table

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:11:53Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
+class SubmissionHistory < ActiveRecord::Base
+ belongs_to :team
+ validates_uniqueness_of :submitted_detail, scope: [:team_id, :submitted_at]
+
+ def self.create(team, link)
+ # for file, the link will be? - put this as default condition
+ # determine whether this is a file or a link
+ existing_submission = SubmissionHistory.where(["team_id = ? and submitted_detail = ?", team, link])
+ if existing_submission.size>0
+ action = "edit"
+ else
+ action = "add"
+ end
+
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, action)
+ else
+ history_obj = FileSubmissionHistory.create(link, team, action)
+ end
+ return history_obj
+ end
+
+ def self.delete_submission(team, link)
+ # just add a delete record
+ if link.start_with?("http")
+ history_obj = LinkSubmissionHistory.create(link, team, "delete")
+ else
+ history_obj = FileSubmissionHistory.create(link, team, "delete")
+ end
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ return Time.current
+ end
+
+end
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller
+ #create timeline for generalized map to just loop in the html
+ @timeline = Hash.new()
+ #Get timeline entries from submission_histories table
+ @submission_history = SubmissionHistory.where(team: @participant.team.id).order(:submitted_at)
+ #reviews
+ @review_maps = ResponseMap.where(reviewee_id: @participant.team.id)
+ @review_maps.each do |map|
+ if "ReviewResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'green'}
+ end
+ end
+ #feedbacks
+ @feedback_maps = ResponseMap.where(reviewer_id: @participant.id)
+ @feedback_maps.each do |map|
+ if "FeedbackResponseMap".eql?map.type
+ @response = Response.find_by(map_id: map.id)
+ @timeline[@response.updated_at]={:heading => map.type.chomp('ResponseMap') , :description => '', :color => 'info'}
+ end
+ end
+ @submission_history.each do |submission|
+ @timeline[submission.submitted_at]={:heading => submission.type+' '+submission.action, :description => submission.submitted_detail}
+ end
+ @assignment.due_dates.each do |due_date|
+ @timeline[due_date.due_at]={:heading => ' Due Date ', :description => due_date.deadline_type.name+' deadline', :color => 'danger'}
+ end

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
+ <link rel="stylesheet" type="text/css" href="/assets/timeline.css" >
+ <div class="container">
+ <div class="row">
+ <div class="col-md-12">
+ <div class="page-header">
+ <h1>Submission History</h1>
+ </div>
+ <div style="display:inline-block;width:100%;overflow-y:auto;">
+ <ul class="timeline timeline-horizontal">
+ <% @timeline.sort.map do |key, timemark| %>
+ <%# Display timestamps from timeline hash! %>
+ <li class="timeline-item">
+ <div class="timeline-badge <%= timemark[:color] %>"><i class="glyphicon glyphicon-check"></i></div>
+ <div class="timeline-panel">
+ <div class="timeline-heading">
+ <h4 class="timeline-title"><%= timemark[:heading] %></h4>
+ <p><small class="text-muted"><i class="glyphicon glyphicon-time"></i> <%= key %></small></p>
+ </div>
+ <div class="timeline-body">
+ <p><%= timemark[:description] %></p>
+ </div>
+ </div>
+ </li>
+ <% end %>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>

spec
* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

'''Factory Pattern'''
We are planning to use factory pattern for the type of link submitted. We will create an interface Type then we will create individual concrete classes like GitHubLink, GoogleDocLink, WikiLink which will implement our Type interface. To use factory pattern we will define TypeFactory class which will have static getType method that returns a Type that depends on the criteria that has been supplied.

'''UML Diagram:'''
[[File:Class.jpg|center]]

'''Testing Plan:'''
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.
*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github
Doubts:
Significance of submission record table

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:07:43Z

Pagrawa2: /* Files Added/Modified */

== Problem Statement ==

In this project, We will keep track of timestamp records for students' submissions and updates of artifacts (links to google doc/wikipedia/github), reviewers' submissions and edits of peer-reviews and author feedbacks.We will also create a timeline view for each artifact, showing when it was submitted/resubmitted and when it was reviewed. With our work, users (students and instructors) can see:
* when do the authors submit and update their artifacts.
* when do reviewers submit peer-reviews.
* when do reviewees send author feedback.
* when do reviewers update their peer reviews.
== Approach ==
[[File:appraoch.JPG|center]]
From a perspective (both instructors and students), users should be able to see such a timeline with all the events for each submission of an assignment. The events can be -
*add/edit events of various submission links/files
*Reviews
*author feedbacks
*peer reviews
Each of these artifacts can be edited and updated multiple times. Because we want to track when these artifacts are updated, we have to store their information in the database. We use the table suggested in the problem description “submission_histories”-
*Id :: integer- primary key for this table.
*team_id :: integer ← foreign key to the teams table
*submitted_detail :: string ← details of the event. This can be one of x values.
**Link - if it is a assignment submission link. This can further be of 4 types -
**Google Docs
**Wikipedia
**Github repository
**Any other web link
*Review ids - if the event is a review submission
*Author feedback id - if the event is an add or edit operation on author feedback.
*Peer review id - if the event is an add or edit operation on peer review.
*Submitted_at :: datetime ← to store the timestamp of the event
*Type :: string ← field which distinguish between different types of events - to be used for polymorphism.
*Action :: string - add / edit / delete based on the event.
These are the common components under which each component in the timeline can be classified. Each of these components are explained in detail on how it fits into the timeline and its significance and types listed.

'''Data stored in submission_histories table'''
*Google Document, Wikipedia article, Github repository url : All of these are types of links given by the team during their submission. Through the url, we will identify which type of a submission is this, and then create an object of the particular class using the factory pattern. Each of these classes will implement their own “getLastUpdatedTimestamp” method, using the suggested APIs, through which we can get the required timestamp.
*File path and any other web link - These are also a part of main submissions, but since there is no way of tracking changes to these artifacts, we just take the time of the system when the link is added or removed.
*Peer Reviews, Author feedback: Peer reviews and author feedbacks are updated into the submission history table for every edit that takes place. The “updated_at” field acts as the current timestamp for edits in the Peer Reviews and Author feedbacks and the “created_at” field marks the start of these Events.
'''Data retrieved from existing tables'''
*Reviews: Timestamp for assignment reviews are taken from “responses” and “response_maps” table. The responses table contains round field and when “is_submitted” flag is true, the submission appears on the reviewee timeline where the “reviewee_id” retrieved from response_maps table. The reviews attached to the respective reviewee are collected and updated_at field gives the submission timestamp which is used on the timeline. Each review is collected and is added to the single Event map.
*Timeline Parameters: Values corresponding to an assignment which are common for a given Assignment are retrieved from the assignments table. And the timeline parameters are obtained by calculating from the created_at which is the start date for the assignment and the field rounds_of_reviews determines the deadline by adding up the value stored in days_between_submission field of the same table. The Events - Start Date, Submission Deadline and Revision Deadline and Final assignment deadline exists for each assignment.
All the components are then added into one single map - Event -> Timestamp which is sorted on timestamp values and is displayed on screen.

== Files Added/Modified ==
Models
* assignment
require 'rufus-scheduler'
after_save :record_submission

+private
+ def record_submission
+ # whenever a new assignment is added, add a job on each of its deadlines, to update the
+ # timestamps of teams' submissions.
+ scheduler = Rufus::Scheduler.singleton
+
+ self.due_dates.each do |due_date|
+ if due_date.deadline_type.name == 'submission'
+ scheduler.at(due_date.due_at.to_s, "assignment"=>self) do |job, time, arg|
+ LinkSubmissionHistory.add_submission(job.opts['assignment'].id)
+ end
+ end
+ end
+ end
* files_submission_history
+class FileSubmissionHistory < SubmissionHistory
+ def self.create(link, team, action)
+ history_obj = FileSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* github_pull_request_submission_history
+class GithubPullRequestSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubPullRequestSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.pulls.get git_user_details[1], git_user_details[2], git_user_details[4]
+ return a.updated_at
+ end
+end
* github_repo_submission_history
+class GithubRepoSubmissionHistory < GithubSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GithubRepoSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ link_path = uri.path
+ git_user_details = link_path.split("/")
+ github = Github.new
+ a = github.repos.get git_user_details[1], git_user_details[2]
+ return a.pushed_at
+ end
+end
* github_submission_history
+class GithubSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ if link.include? "pull"
+ history_obj = GithubPullRequestSubmissionHistory.create(link, team, action)
+ else
+ history_obj = GithubRepoSubmissionHistory.create(link, team, action)
+ return history_obj
+ end
+ end
+end
* googledoc_submission_history
+class GoogledocSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = GoogledocSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+end
* link_submission_history
+class LinkSubmissionHistory < SubmissionHistory
+
+ def self.create(link, team, action)
+ # lets assume link of type http://docs.google.com or http://wiki.expertiza.ncsu.edu or http://github.com/goeltanmay/
+ if link.include? "docs.google.com"
+ history_obj = GoogledocSubmissionHistory.create(link, team, action)
+ elsif link.include? "wiki.expertiza.ncsu.edu"
+ history_obj = WikipediaSubmissionHistory.create(link, team, action)
+ elsif link.include? "github.com"
+ history_obj = GithubSubmissionHistory.create(link, team, action)
+ else
+ # some random link has been given
+ history_obj = LinkSubmissionHistory.new
+ history_obj.team = team
+ history_obj.submitted_detail = link
+ history_obj.action = action
+ end
+ return history_obj
+ end
+
+ def self.add_submission(assignment_id)
+ @assignment = Assignment.find_by_id(assignment_id)
+ teams = @assignment.teams
+ teams.each do |team|
+ submitted_links = team.hyperlinks
+ submitted_links.each do |link|
+ submission_history = SubmissionHistory.create(team, link)
+ timestamp = submission_history.get_submitted_at_time(link)
+ submission_history.submitted_at = timestamp
+ begin
+ submission_history.save
+ rescue
+ @error_message = "No new updates"
+ end
+ end
+ end
+ end
+end
* submission_history
* wikipedia_submission_history
+class WikipediaSubmissionHistory < LinkSubmissionHistory
+ def self.create(link, team, action)
+ history_obj = WikipediaSubmissionHistory.new
+ history_obj.submitted_detail = link
+ history_obj.team = team
+ history_obj.action = action
+ return history_obj
+ end
+
+ def get_submitted_at_time(link)
+ uri = URI(link)
+ wiki_title = uri.path
+ wiki_title.slice! "/index.php/"
+ url = URI.parse('http://wiki.expertiza.ncsu.edu/api.php?action=query&prop=info&titles='+ wiki_title +'&format=json')
+ req = Net::HTTP::Get.new(url.to_s)
+ res = Net::HTTP.start(url.host, url.port) {|http|
+ http.request(req)
+ }
+ hash= JSON.parse res.body
+ id = hash["query"]["pages"].keys
+ return hash["query"]["pages"][id[0]]["touched"]
+ end
+end

Controllers
* submitted_content_controller

Views
* submitted_content/_main.html.erb
+ <%if !@timeline.nil? %>
+ <%= render partial: 'submitted_content/submission_history', locals: {timeline: @timeline, origin: ''} %>
+ <%end%>
+
* submitted_content/_submission_history.html.erb
+<link rel="stylesheet" type="text/css" href="/assets/timeline.css" >
+ <div class="container">
+ <div class="row">
+ <div class="col-md-12">
+ <div class="page-header">
+ <h1>Submission History</h1>
+ </div>
+ <div style="display:inline-block;width:100%;overflow-y:auto;">
+ <ul class="timeline timeline-horizontal">
+ <% @timeline.sort.map do |key, timemark| %>
+ <%# Display timestamps from timeline hash! %>
+ <li class="timeline-item">
+ <div class="timeline-badge <%= timemark[:color] %>"><i class="glyphicon glyphicon-check"></i></div>
+ <div class="timeline-panel">
+ <div class="timeline-heading">
+ <h4 class="timeline-title"><%= timemark[:heading] %></h4>
+ <p><small class="text-muted"><i class="glyphicon glyphicon-time"></i> <%= key %></small></p>
+ </div>
+ <div class="timeline-body">
+ <p><%= timemark[:description] %></p>
+ </div>
+ </div>
+ </li>
+ <% end %>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>

spec
* models/github_pull_request_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubPullRequestSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github pull request was updated" do
+ history_object = GithubPullRequestSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/pull/1")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/github_repo_submission_history_spec.rb
+require "rails_helper"
+
+describe GithubRepoSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a github repo was pushed" do
+ history_object = GithubRepoSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("https://github.com/prerit2803/expertiza/")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end
* models/link_submission_history_spec.rb
+require 'rails_helper'
+
+describe LinkSubmissionHistory do
+ describe "add submission" do
+ it "should add GithubRepoSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza")
+ assignment_team.save
+ expect_any_instance_of(GithubRepoSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add GithubPullRequestSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("https://github.com/prerit2803/expertiza/pull/1")
+ assignment_team.save
+ expect_any_instance_of(GithubPullRequestSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+
+ it "should add WikipediaSubmissionHistory" do
+ assignment = build(Assignment)
+ assignment.save
+ assignment_team = build(AssignmentTeam)
+ assignment_team.parent_id = assignment.id
+ assignment_team.submit_hyperlink("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ assignment_team.save
+ expect_any_instance_of(WikipediaSubmissionHistory).to receive(:get_submitted_at_time)
+ LinkSubmissionHistory.add_submission(assignment.id)
+ end
+ end
+end
* models/submission_history_spec.rb
+require 'rails_helper'
+
+describe SubmissionHistory do
+ describe "create method" do
+ it "should create link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://www.youtube.com/watch?v=dQw4w9WgXcQ&ab_channel=RickAstleyVEVO"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(LinkSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubRepoSubmissionHistory)
+ end
+
+ it "should create github link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://github.com/prerit2803/expertiza/pull/1"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GithubPullRequestSubmissionHistory)
+ end
+
+ it "should create wikipedia link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(WikipediaSubmissionHistory)
+ end
+
+ it "should create google doc link submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(GoogledocSubmissionHistory)
+ end
+
+ it "should create file submission history" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ expect(submission_history).to be_a(FileSubmissionHistory)
+ end
+ end
+
+ describe "delete method" do
+ it "should add a row to submission history table with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a link submission history with action as delete" do
+ assignment_team = build(AssignmentTeam)
+ link = "https://docs.google.com/document/d/1fI5KbPXCJ8dSUyLynnqC__A3MtZ47enNfMcki3Vf3uk/edit"
+ submission_history = SubmissionHistory.delete_submission(assignment_team, link)
+ expect(submission_history.action).to eq("delete")
+ end
+
+ it "should add a row to submission history table with action as edit" do
+ assignment_team = build(AssignmentTeam)
+ link = "/user/home/Expertiza_gemfile"
+ submission_history = SubmissionHistory.create(assignment_team, link)
+ submission_history.submitted_at = Time.current
+ submission_history.save
+
+ submission_history2 = SubmissionHistory.create(assignment_team, link)
+ submission_history2.submitted_at = Time.current
+ submission_history2.save
+ expect(submission_history2.action).to eq("edit")
+ end
+ end
+end
* models/wikipedia_submission_history_spec.rb
+require "rails_helper"
+
+describe WikipediaSubmissionHistory do
+ describe "get_submitted_at_time" do
+ it "should return the last time a wiki page was updated" do
+ history_object = WikipediaSubmissionHistory.new
+ time_stamp = history_object.get_submitted_at_time("http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/oss_E1663")
+ expect(time_stamp).not_to be_empty
+ end
+ end
+end

'''Factory Pattern'''
We are planning to use factory pattern for the type of link submitted. We will create an interface Type then we will create individual concrete classes like GitHubLink, GoogleDocLink, WikiLink which will implement our Type interface. To use factory pattern we will define TypeFactory class which will have static getType method that returns a Type that depends on the criteria that has been supplied.

'''UML Diagram:'''
[[File:Class.jpg|center]]

'''Testing Plan:'''
*Unit Testing of controllers
This involves unit testing of following controllers: TeamsController, because we will have to change some methods.
*Unit Testing of Models
This involves writing rspec test for all the newly created models like submission_history, google_doc_submission_history, etc. Tests for team model are already written.
*UI Testing
**Login as student/instructor.
**Go to Assignments Home Page.
**Here you will find a timeline with several tags like submission, review, resubmission, rereview.
**Also, There will be a tags for the authors submitting and updating their artifacts, reviewers submitting peer-reviews, reviewees sending author feedback and reviewers updating their peer reviews.
**As UI would be modified a lot, more testing part would be added after the implementation.

== References ==

*https://www.tutorialspoint.com/design_pattern/factory_pattern.htm
*https://developers.google.com/drive/v3/web/quickstart/ruby
*https://www.mediawiki.org/wiki/API:Main_page
*https://github.com/octokit/octokit.rb
*https://github.com/piotrmurach/github
Doubts:
Significance of submission record table

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:04:42Z

Pagrawa2: /* Files Added/Modified */

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:03:08Z

Pagrawa2: /* Files Added/Modified */

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T19:02:00Z

Pagrawa2: /* Files Added/Modified */

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T18:59:24Z

Pagrawa2: /* Design Patterns */

CSC/ECE 517 Fall 2016/E1686-Timestamps for students' submissions

2016-12-07T18:34:25Z

Pagrawa2: /* Concerns */

CSC/ECE 517 Fall 2016/oss E1663

2016-11-04T20:21:47Z

Pagrawa2:

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like,

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

With :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

RSpec Testing

There were no existing test cases for the course controller. We have added some related to the functionality which we have worked on.
The following test verifies mapping between TA and course:

it "is able to create mapping between TA and the course" do
ta = build(User)
ta.save
course = build(Course)
course.save
taMapping = TaMapping.create(ta.id,course.id)
expect(taMapping).to be_kind_of(TaMapping)
end

Below test verifies whether error message is displayed or not when TA does not exist:

it "displays error message if TA does not exist" do
ta = build(User)
ta.ta_id=nil
ta.save
expect(ta.nil?).to be true
end

The test below verifies whether TA is removed from the course or not:
it "is able to delete TA from the course" do
ta = build(User)
taMapping = TaMapping.find(ta.id)
taMapping.destroy
expect(response).to redirect_to action: 'view_teaching_assistants'
end
UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.
* To test add questionnaire, switch to questionnaire tab from courses tab and click on add questionnaire.
* As you add questions, page would not refresh and questions would be added as expected.
* If you try to delete any question, delete action would also not refresh the page and perform the required action.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T05:44:30Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T05:00:44Z

Pagrawa2: /* Testing Details */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like,

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

With :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

RSpec Testing

There were no existing test cases for the course controller. We have added some related to the functionality which we have worked on.
The following test verifies mapping between TA and course:

it "is able to create mapping between TA and the course" do
ta = build(User)
ta.save
course = build(Course)
course.save
taMapping = TaMapping.create(ta.id,course.id)
expect(taMapping).to be_kind_of(TaMapping)
end

Below test verifies whether error message is displayed or not when TA does not exist:

it "displays error message if TA does not exist" do
ta = build(User)
ta.ta_id=nil
ta.save
expect(ta.nil?).to be true
end

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T04:58:45Z

Pagrawa2: /* Testing Details */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like,

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

With :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

RSpec Testing

There were no existing test cases for the course controller. We have added some related to the functionality which we have worked on.

it "is able to create mapping between TA and the course" do
ta = build(User)
ta.save
course = build(Course)
course.save
taMapping = TaMapping.create(ta.id,course.id)
expect(taMapping).to be_kind_of(TaMapping)
end

it "displays error message if TA does not exist" do
ta = build(User)
ta.ta_id=nil
ta.save
expect(ta.nil??).to be true
end

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T04:58:16Z

Pagrawa2: /* Testing Details */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like,

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

With :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

RSpec Testing

There were no existing test cases for the course controller. We have added some related to the functionality which we have worked on.

it "is able to create mapping between TA and the course" do
ta = build(User)
ta.save
course = build(Course)
course.save
taMapping = TaMapping.create(ta.id,course.id)
expect(taMapping).to be_kind_of(TaMapping)
end

it "displays error message if TA does not exist" do
ta = build(User)
ta.ta_id=nil
ta.save
expect(ta.nil??).to be true
end

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T04:53:12Z

Pagrawa2: /* _add_individual.html.erb/_ta_list.html.erb */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like,

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

With :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T04:52:43Z

Pagrawa2: /* _add_individual.html.erb/_ta_list.html.erb */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like

<%= form_tag("/course/add_ta", :method => 'post', :remote => true) do %>

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

with :remote => true, rails will not automatically switch views, which allows the JQuery to be run instead. This can be used with a form_tag, a link_tag, or other types of tags.

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-11-03T04:50:28Z

Pagrawa2:

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== _add_individual.html.erb/_ta_list.html.erb ==
We have put the :remote => true flag on the link or form tag in our .html.erb files (view) for the element where we wanted to trigger the AJAX call, like

<%= link_to "Delete", { :action => 'remove_ta', :controller =>'course', :id => ta.id, :course_id => ta.course_id }, method: :post,
:remote => true, :class => 'delete_ta' %>

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-10-30T19:55:38Z

Pagrawa2: /* Files Created/Changed in the project */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
*** list.html.erb
** shared_scripts
*** add_individual.html.erb
*** _user_list.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-10-30T19:51:35Z

Pagrawa2: /* Description of the current project */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add/Delete TA (Teaching Assistants): Once a course has been created, an instructor can Add/Delete TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
** shared_scripts
*** add_individual.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-10-30T19:49:59Z

Pagrawa2: /* Participants Controller/ Course Controller */

This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:

* Instructor login: username -> instructor6, password -> password

== Expertiza Background ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The current project deals with addition of AJAX whenever we add a new record or modify an existing record. In the current scenario, we submit the entire page to save a record and reload the entire page back again. Using Ajax, we should only submit the newly added record information to server instead of submitting the entire page. This project takes care of below scenarios:

* Add Participants: Once an assignment has been created, an instructor can Add Participants to the assignment.
* Add TA (Teaching Assistants): Once a course has been created, an instructor can Add TAs to the course.
* Edit Questionnaire: Modify the Edit Questionnaire screen to use ajax while adding new questions to the questionnaires.
* Un-submit reviews: Instructor should be able to un-submit a review.

== Files Created/Changed in the project ==

* Controllers
** participants_controller.rb
** course_controller.rb
** questionnaires_controller.rb

* Views
** course
*** _add_individual.html.erb
*** _ta_list.html.erb
*** add_ta.js.erb
*** remove_ta.js.erb
*** view_teaching_assistants.html.erb
** participants
*** add.js.erb
** shared_scripts
*** add_individual.html.erb
** questionnaires
*** _ajax_partial.html.erb
*** add_new_questions.js.erb
*** edit.js.erb

== Participants Controller/ Course Controller ==

We have added respond_to method in add method of participants controller and add_ta/remove_ta methods of course controller, which will allow us to render both javascript and html requests from these methods.

In course controller the function looked something like this:

respond_to do |format|
format.html { redirect_to action: 'view_teaching_assistants', id: @course.id }
format.js
end

== Questionnaire Controller ==

The same methods added in participants were added in questionnaire controller, the difference being in the action the controller takes after receiving a JS request.

In the partial _questionnaire.html.erb, the attribute remote was set to true. This is rendered as the attribute "data-remote" being set to true in HTML, which allows the rails UJS (unobtrusive JS) to make AJAX calls without needing any jQuery statements.

To implement the functionality, the controller renders a JavaScript file in place of the usual .html.erb. The JavaScript file then takes action on the webpage it is called on. In the case of adding new questions, the page is updated with the new questions by the JavaScript file that is called. This is achieved by rendering a partial in the JavaScript file and then using jQuery to update the page with the rendered HTML. This seemed like a good approach as we are reusing the render method. Although new partials had to be created, the JavaScript functionality is easy to understand. Additional divs were added in the HTML to serve as hooks for the jQuery statements to update HTML on the page.

Additionally, saving questions in the edit questionnaire section also works on AJAX, and flashes the standard rails success message without refreshing the page.

== Testing Details ==

UI Testing

Following steps needs to be performed to test this code from UI:

* Login as an instructor.
* You will land on Manage Content page with list of courses and related actions to it.
* Under action column try to Add TA for any course.
* It will take you to Teaching Assistants page.
* Try to add a valid TA for eg. teaching_assistant5549. As soon as you press Add TA button, list will get updated with the newly added TA without refreshing the page.
* If you try to delete any TA, a popup will open to confirm your action, press ok and you will see that particular TA is deleted in the background.
* Similarly, for perform these actions for Add participant action for any course. Table will be updated with newly added participant without refreshing the page.

CSC/ECE 517 Fall 2016/oss E1663

2016-10-30T18:54:03Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-29T04:43:12Z

Pagrawa2: /* Participants Controller */

CSC/ECE 517 Fall 2016/oss E1663

2016-10-29T02:31:47Z

Pagrawa2: /* participants_controller */

CSC/ECE 517 Fall 2016/oss E1663

2016-10-29T02:10:26Z

Pagrawa2: /* Peer Review Information */

CSC/ECE 517 Fall 2016/oss E1663

2016-10-29T01:08:12Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T23:05:48Z

Pagrawa2: /* Files Created/Changed in the project */

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T19:34:49Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T19:31:31Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T19:23:05Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T19:20:20Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T19:19:13Z

Pagrawa2:

CSC/ECE 517 Fall 2016/oss E1663

2016-10-28T18:50:25Z

Pagrawa2: Created page with "This wiki page is for the description of changes made under E1663 OSS assignment for Fall 2016, CSC/ECE 517. == Peer Review Information == For users intending to view the depl..."