ruby_proctor 1.0.0

data/lib/ruby_proctor/interfaces/terminal.rb

@@ -0,0 +1,161 @@
+# main.rb
+#
+
+# includes
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ostruct'
+
+require 'ruby_proctor/constants.rb'
+require 'ruby_proctor/exam.rb'
+require 'ruby_proctor/question.rb'
+require 'ruby_proctor/logger'
+require 'ruby_proctor/processor.rb'
+require 'ruby_proctor/proctor.rb'
+require 'ruby_proctor/string_ext.rb'
+
+include Constants
+
+def ruby_proctor_terminal
+
+  # Print Pretty ASCII Logo
+  puts ''
+  puts '##################################################################'
+  puts '##  ______      _          ______               _               ##'
+  puts '##  | ___ \    | |         | ___ \             | |              ##'
+  puts '##  | |_/ /   _| |__  _   _| |_/ / __ ___   ___| |_ ___  _ __   ##'
+  puts "##  |    / | | | '_ \\| | | |  __/ '__/ _ \\ / __| __/ _ \\| '__|  ##"
+  puts '##  | |\ \ |_| | |_) | |_| | |  | | | (_) | (__| || (_) | |     ##'
+  puts '##  \_| \_\__,_|_.__/ \__, \_|  |_|  \___/ \___|\__\___/|_|     ##'
+  puts '##                     __/ |                                    ##'
+  puts '##                    |___/                                     ##'
+  puts '##################################################################'
+  puts ''
+
+  # Parse Options, POSIX Style
+  require 'optparse'
+
+  options = OpenStruct.new
+
+  begin
+    OptionParser.new do |opt|
+      opt.on('-f [FILE_PATH]', 'File Path to Quiz (Can be relative or absolute)') { |o| options.file_path = o }
+      opt.on('-q [NUM_QUESTIONS]', 'number of questions for quiz') { |o| options.num_questions = o }
+      opt.on('-t [TIME_LIMIT]', 'Sets a time limit by number of minutes') { |o| options.time_limit = o }
+      opt.on('-v', 'Provides a print out of all of your quiz attempts') { |o| options.view_quizzes = true }
+    end.parse!
+  rescue => e
+    puts "** Error Parsing Arguments: " + e.message + " **"
+    puts "Try Resolving the above error, and try running again\n\n"
+    puts "Exiting..."
+    exit # Exit Program, we can't use this Exam File
+  end
+
+  options_hash = options.to_h()
+
+  if options.view_quizzes && options_hash.length == 1
+    # Delegate Printing out All Quizzes for current PID
+    logger = Logger.new
+
+    begin
+      quiz_attempts = logger.read_from_log
+      logger.print_quiz_attempts(quiz_attempts)
+      puts "Exiting..."
+      exit
+    rescue => e
+      puts "** Error Reading Log File: " + e.message + " **"
+      puts "Try Resolving the above error, and try running again\n\n"
+      puts "Exiting..."
+      exit # Exit Program, we can't use this Exam File
+    end
+  elsif options.view_quizzes && options_hash.length > 1
+    puts "Invalid Arguments: No other Arguments can be used with -v for viewing the quizzes"
+    puts "Exiting..."
+    exit 
+  elsif options_hash.length == 0
+    puts "Not enough arguments to perform any action, run 'ruby_proctor -h' to get a list of available arguments and their function"
+    puts "Exiting..."
+    exit 
+  elsif !options.file_path
+    puts "No File name was specified with quiz configuration! Make sure you provide a filepath with the -f argument"
+    puts "Exiting..."
+    exit 
+  end
+  # # Check that only a filename is passed
+  # if ARGV.length < 1
+  #   puts "Too few arguments, arguments are as follows: ruby_proctor <file_path> <num_questions> <time_in_minutes> "
+  #   puts "Exiting..."
+  #   exit
+  # elsif ARGV.length > 3
+  #   puts "Too many arguments, arguments are as follows: ruby_proctor <file_path> <num_questions> <time_in_minutes> "
+  #   puts "Exiting..."
+  #   exit
+  #end
+  options.file_path.untaint()
+
+  filepath = options.file_path
+  max_questions = -1
+
+  if options.num_questions
+    if options.num_questions.is_integer?
+      if options.num_questions.to_i <= 0 || options.num_questions.to_i > Constants::QUIZ_MAX_QUESTIONS
+        puts "Can't pick zero, a negative number, or above 10000 questions for an exam, please pick a number above 0, but less than 10000 (Max supported questions)"
+        puts "NOTE: anything above the number of total questions in the exam will return the entire question set and no more"
+        puts "Exiting..."
+        exit
+      end
+      max_questions = options.num_questions.to_i
+    else
+      puts "Number of Questions Specified must be a number greater than 0"
+      puts "NOTE: anything above the number of total questions in the exam will return the entire question set and no more"
+      puts "Exiting..."
+      exit
+    end
+  end
+
+  time = -1
+  if options.time_limit
+    if options.time_limit.is_integer?
+      if options.time_limit.to_i <= 0
+        puts "Error: Can't pick zero or negative number of minutes, please pick a number above 0"
+        puts "NOTE: Omit the -t flag if you wish for an unlimited time test"
+        puts "Exiting..."
+        exit
+      end
+      time = options.time_limit.to_i
+    else
+      puts "Number of minutes must be a valid number greater than 0"
+      puts "NOTE: Omit the -t flag if you wish for an unlimited time test"
+      puts "Exiting..."
+      exit
+    end
+  end
+
+  # if(!File.exist?(filepath))
+  #   puts 'Questions File not found, exiting..'
+  #   exit
+  # end
+
+  #puts "Welcome to Ruby Proctor!\n"
+
+  puts "Beginning to Process Exam ...\n\n"
+  processor = Processor.new(filepath, max_questions)
+
+  # Try to Process, and cleanly display any exceptions
+  begin
+    exam = processor.process()
+    puts "Exam Processed Successfully"
+  rescue => e
+    puts "** Error Processing Exam File: " + e.message + " **"
+    puts "Try Resolving the above error, and try running again\n\n"
+    puts "Exiting..."
+    exit # Exit Program, we can't use this Exam File
+  end
+
+  # Start Officiating Exam
+  proctor = Proctor.new(exam, time)
+  proctor.officiate_exam
+
+  puts 'Exiting...'
+end

data/lib/ruby_proctor/logger.rb

@@ -0,0 +1,109 @@
+
+require 'ruby_proctor/constants'
+require 'ruby_proctor/question'
+require 'ruby_proctor/exam'
+require 'ruby_proctor/string_ext'
+require 'ostruct'
+
+require 'yaml'
+
+require 'os'
+
+include Process::UID
+include Constants
+
+class Logger
+
+  attr_accessor :file_path, :real_uid
+
+  #YAML.load_stream(File.read('test.yml'))
+  class LoggingError < StandardError
+    def initialize(msg="Error Occurred During Logging")
+      super
+    end
+  end
+
+  def initialize()
+
+    if OS.windows?
+      @file_path = ENV['ALLUSERSPROFILE'] + "/Ruby Proctor/quizlog.dat"
+      @real_uid  = ENV['USERNAME']
+    else
+      @file_path = '/var/log/' + QUIZ_FILE_NAME
+      @real_uid = Process.uid
+    end
+
+    #@effective_uid = Process.euid
+
+    #if (Process::UID.sid_available?)
+    #  @saved_uid = `ps -p #{Process.pid} -o svuid=`.strip
+    #else
+    #  @saved_uid = ''
+    #end
+
+    #puts @saved_uid
+    #puts @real_uid
+    #puts @effective_uid
+  end
+
+  def write_to_log(exam)
+    exam.results.uid = @real_uid
+
+    open(@file_path, 'a+') { |f|
+      f.puts exam.results.to_hash.to_yaml
+    }
+  end
+
+  def read_from_log
+    quiz_attempts = Array.new
+
+    begin
+      YAML.load_stream(File.read(@file_path)) do |document|
+        #puts document
+        if document.key?("uid") && document["uid"] == @real_uid
+          quiz_attempts.push(OpenStruct.new(document))
+        end
+      end
+      quiz_attempts 
+    rescue => e 
+      raise LoggingError.new "Error Opening File: File doesn't exist or permissions are incorrect!"
+    end
+  end
+
+
+  def print_quiz_attempts(quiz_attempts)
+
+    quiz_num = 1;
+
+
+    if (quiz_attempts.length > 0)
+
+      for attempt in quiz_attempts do
+
+        puts "| Quiz # " + quiz_num.to_s + " |"
+        puts "---------------------------"
+
+        puts 'Number of Questions Answered Correctly: ' + attempt.num_correct.to_s + ' / ' + attempt.total_questions.to_s
+        puts 'Grade (Percentage): ' + attempt.grade.to_s
+        puts 'Letter Grade: ' + attempt.letter_grade
+        
+        if (attempt.quiz_name)
+          puts 'Quiz Name: ' + attempt.quiz_name
+        end
+        puts 'Time Started: ' + attempt.time_started
+        puts 'Time Completed: ' + attempt.time_completed
+        puts 'Time Elapsed: ' + attempt.time_elapsed
+
+        if (attempt.time_elapsed && attempt.time_left)
+          puts 'Time Left: ' + attempt.time_left
+          puts ""
+        end
+        puts ""
+        #puts "---------------------------\n\n\n"
+        quiz_num += 1
+      end
+    else # Why is this useless? 
+      puts "No Quiz Results to Display!"
+    end
+  end
+end

data/lib/ruby_proctor/logging/quiz_log.rb

@@ -0,0 +1,4 @@
+class Configuration
+
+    attr_accessor :filepath, :num_questions, :time_limit
+  

data/lib/ruby_proctor/processor.rb

@@ -0,0 +1,126 @@
+require 'ruby_proctor/constants'
+require 'ruby_proctor/question'
+require 'ruby_proctor/exam'
+require 'ruby_proctor/string_ext'
+
+include Constants
+
+class Processor
+
+  @@_NOT_COMMENT_PATTERN = '^\s*[^\\' + Constants::COMMENT + ']'
+  @@_QUESTION_PATTERN = '^\s*' + Constants::Q_START
+  @@_ANSWERS_START_PATTERN = '^\s*' + Constants::A_START
+  @@_ANSWERS_END_PATTERN = '^\s*' + Constants::A_END
+
+  class ProcessingError < StandardError
+    def initialize(msg="Error Occurred During Processing")
+      super
+    end
+  end
+
+  def initialize(file, max_questions)
+    @file = file
+    @max_questions = max_questions
+  end
+
+  def process
+    questions = Array.new
+
+    last_symbol = ''
+    line_count = 0
+    last_question = Question.new(-1) # Dummy to define type? Weak Types are weird in OO
+    last_answer_set = nil
+
+    question_count = 0;
+
+    line_num = 0
+
+    begin 
+      IO.foreach(@file) do |l|
+        line_num += 1
+        line = l.strip
+
+        if line.match(@@_NOT_COMMENT_PATTERN) && !line.empty? # Check first character isn't *, nor all whitespace/empty
+          if line.upcase.match(@@_QUESTION_PATTERN)
+            if last_symbol == Constants::A_START
+              raise ProcessingError, "Answer Key for previous question was not closed - Line #" + line_num.to_s
+            else
+                last_symbol = Constants::Q_START
+                last_question = Question.new(question_count + 1)
+                question_count += 1
+            end
+          elsif line.upcase.match(@@_ANSWERS_START_PATTERN)
+            if !last_question.question.empty?
+              if last_symbol == Constants::Q_START
+                last_symbol = Constants::A_START
+              elsif last_symbol == Constants::A_START
+                raise ProcessingError, "Duplicate answer key start symbol - Line #" + line_num.to_s
+              elsif last_symbol == Constants::A_END
+                raise ProcessingError, "Cannot Have multiple sets of answer keys for one Question - Line #" + line_num.to_s
+              else
+                raise ProcessingError, "Cannot attribute answer tag to question (orphaned answer key), check file syntax - Line #" + line_num.to_s
+              end
+            else
+              raise ProcessingError, "Question is empty - Line #" + line_num.to_s
+            end
+          elsif line.upcase.match(@@_ANSWERS_END_PATTERN)
+            if (last_question.answers.empty?)
+              raise ProcessingError, "Answer Key is empty - Line #" + line_num.to_s
+            else
+              last_symbol = Constants::A_END
+              questions.push(last_question)
+              line_count = 0
+            end
+          else
+            if last_symbol == Constants::Q_START # Start Processing Question Lines
+              last_question.question += l # Keep Formatting
+            elsif last_symbol == Constants::A_START # Get Correct Answer
+              if line_count == 0
+                if line.is_integer?
+                  last_question.correct_answer = line.to_i
+                else
+                  raise ProcessingError, "Correct answer not an integer - Line #" + line_num.to_s
+                end
+              else
+                last_question.answers.push(line)
+              end
+              line_count += 1
+            elsif last_symbol == Constants::A_END
+              raise ProcessingError, "Free text outside of Question or Answer Key, Add * to beginning if intended to be a comment - Line #" + line_num.to_s
+            else
+              raise ProcessingError, "Free text before first Question Symbol Add * to beginning if intended to be a comment - Line #" + line_num.to_s
+            end
+          end
+        end
+        # process the line of text here
+      end
+    rescue => e
+      raise ProcessingError, "Quiz File doesn't exist or cannot be read due to permissions"
+    end
+    create_exam(File.basename(@file), questions)
+  end
+
+  def create_exam(filename, questions)
+    exam_questions = Array.new
+
+    questions.shuffle! # Shuffles original array by Ruby's internal randomization algorithm
+
+    count = 0
+    questions.each do |question|
+
+      # If Max Questions is Specified, Check Limit
+      if (@max_questions != -1 && count >= @max_questions)
+        break
+      end
+
+      exam_questions.push(question)
+      count += 1 # Ruby doesnt have incrementation syntax!
+    end
+
+    if exam_questions.length == 0
+      raise ProcessingError.new "No Questions were processed from the exam file, probably an empty file"
+    end
+
+    Exam.new(filename, exam_questions)
+  end
+end

data/lib/ruby_proctor/proctor.rb

@@ -0,0 +1,206 @@
+require 'ruby_proctor/question'
+require 'ruby_proctor/exam'
+require 'ruby_proctor/string_ext'
+require 'ruby_proctor/logger'
+
+require 'timeout'
+
+class Proctor
+
+  attr_accessor :exam
+
+  def initialize(exam, time)
+    @exam = exam
+    @time = time
+    @logger = Logger.new
+  end
+
+  def officiate_exam
+    start_time = Time.now
+
+    puts "\n" + 'This is a ' + exam.questions.length.to_s + ' question exam'
+
+    if (@time <= 0)
+      puts "You have unlimited time to complete, good luck!"
+    elsif (@time == 1)
+      puts 'you have ' + @time.to_s + ' minute to complete, good luck!'
+    else
+      puts 'you have ' + @time.to_s + ' minutes to complete, good luck!'
+    end
+    puts 'Starting Exam....' + "\n\n"
+
+    question_number = 1
+    exam.questions.each do |question|
+      puts "Question #" + question_number.to_s + ": \n"  + question.question
+
+      answer_num = 1
+
+      puts "\nChoices:"
+      question.answers.each do |answer|
+        puts answer_num.to_s + ' - ' + answer
+        answer_num += 1
+      end
+
+      begin
+        answer = get_answer(question.answers.length, start_time)
+      rescue => e
+        print e
+        print "Time is Up!\n\n"
+        break
+      end
+        puts ''
+
+      question.selected_answer = answer
+      question_number += 1
+    end
+    puts "Exam is Over!\n\n"
+
+    print_exam_results(start_time)
+
+      # Try to Process, and cleanly display any exceptions
+  begin
+    @logger.write_to_log(@exam)
+  rescue => e
+    puts "** Error Writing to Log File: " + e.message + " **"
+  end
+
+  end
+
+
+  def print_exam_results(start_time)
+    puts '################'
+    puts '# Quiz Results #'
+    puts '################'
+    puts ''
+
+    # Calculate Percentage
+    grade = grade_exam(start_time)
+
+    puts 'Number of Questions Answered Correctly: ' + @exam.results.num_correct.to_s + ' / ' + @exam.results.total_questions.to_s
+    puts 'Grade (Percentage): ' + @exam.results.grade.to_s
+    puts 'Letter Grade: ' + @exam.results.letter_grade
+    puts 'Time Started: ' + @exam.results.time_started
+    puts 'Time Completed: ' + @exam.results.time_completed
+    puts 'Time Elapsed: ' + @exam.results.time_elapsed
+
+    if (@time > 0)
+      puts 'Time Left: ' + @exam.results.time_left
+      puts ""
+    end
+  end
+
+  def grade_exam(start_time)
+    num_correct = 0
+    grade = 0
+    exam.questions.each do |question|
+      if question.correct_answer.eql?(question.selected_answer)
+        num_correct += 1
+      end
+    end
+
+    # Calculate Percentage
+    grade = (num_correct.to_f / exam.questions.length.to_f) * 100
+
+    #puts 'Number of Questions Answered Correctly: ' + num_correct.to_s + ' / ' + exam.questions.length.to_s
+    @exam.results.num_correct = num_correct
+    @exam.results.total_questions = exam.questions.length
+    @exam.results.grade = grade.to_s + '%'
+    @exam.results.letter_grade = get_letter_grade(grade)
+    @exam.results.time_started = start_time.strftime("%m/%d/%Y %I:%M %p")
+    @exam.results.time_completed = Time.now.strftime("%m/%d/%Y %I:%M %p")
+
+    time_elapsed = calc_time_elapsed(start_time).round
+
+    time_elapsed_hours = time_elapsed / (60*60)
+    time_elapsed_minutes = (time_elapsed / 60) % 60
+    time_elapsed_seconds = time_elapsed % 60
+
+    @exam.results.time_elapsed = time_elapsed_hours.to_s + ':' + time_elapsed_minutes.to_s + ':' + time_elapsed_seconds.to_s
+
+    if (@time > 0)
+      # Calculate Time Left
+      time_left = calc_time_left(start_time).round
+
+      time_left_hours = time_left / (60*60)
+      time_left_minutes = (time_left / 60) % 60
+      time_left_seconds = time_left % 60
+
+      @exam.results.time_left =  time_left_hours.to_s + ':' + time_left_minutes.to_s + ':' + time_left_seconds.to_s
+      puts ""
+    end
+    grade
+  end
+
+  def get_letter_grade(grade)
+    letter_grade = 'F'
+    if grade >= 90
+      letter_grade = 'A'
+    elsif grade >= 80
+      letter_grade = 'B'
+    elsif grade >= 70
+      letter_grade = 'C'
+    elsif grade >= 60
+      letter_grade = 'D'
+    end
+    letter_grade
+  end
+
+  def get_answer(num_questions, start_time)
+    answer = -1
+
+    # Timeout is in seconds, so divide by 1000 to get correct units in float point
+    if (@time > 0)
+      # Calculate Time Left for Timeout
+      time_left = calc_time_left(start_time)
+
+      Timeout::timeout(time_left) do
+        answer = answer_loop(num_questions)
+      end
+    else
+      answer = answer_loop(num_questions)
+    end
+    answer
+  end
+
+  def calc_time_elapsed(start_time)
+    time_elapsed = (Time.now.to_f - start_time.to_f)
+    time_elapsed
+  end
+
+  def calc_time_left(start_time)
+    time_left = (@time * 60).to_f - calc_time_elapsed(start_time)
+
+    # Deal with potential negative number, I never experienced it, but I could see heavy CPU usage or some other
+    # Waiting or thread starvation create a problem.
+    if time_left < 0
+      time_left = 0
+    end
+
+    time_left # Return
+  end
+
+  def answer_loop(num_questions)
+    valid_answer = false
+
+    print 'Select an answer (1-' + num_questions.to_s + '): '
+    while !valid_answer do
+      answer_string = STDIN.gets.chomp
+
+      if answer_string.is_integer?
+        answer = answer_string.to_i
+        if answer < 1 || answer > num_questions
+          print "out of selection range, pick between 1-" + num_questions.to_s + ": "
+        else
+          valid_answer = true
+        end
+      else
+        print "not a valid number, pick between 1-" + num_questions.to_s + ": "
+      end
+
+    end
+    answer # Force this as last assignment for return, don't need to run reassignment interestingly
+  end
+end
+
+
+

data/lib/ruby_proctor/question.rb

@@ -0,0 +1,17 @@
+class Question
+
+  attr_accessor :id, :question, :answers, :correct_answer, :selected_answer
+
+  def initialize(id)
+    @id = id
+    @question = ''
+    @answers = Array.new()
+    @correct_answer = nil
+    @selected_answer = -1
+  end
+
+  def isCorrect()
+    @correct_answer == @selected_answer
+  end
+
+end

data/lib/ruby_proctor/string_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def is_integer?
+    self.to_i.to_s == self
+  end
+end

data/lib/ruby_proctor.rb

@@ -0,0 +1,16 @@
+#$LOAD_PATH.unshift File.dirname($0)
+
+require 'rubygems'
+require 'bundler/setup' # IS unable to find os-1.1.4 on OCRA windows, lots of chicken/egg problems.
+
+require 'os'
+
+def ruby_proctor()
+  if OS.posix?
+    require 'ruby_proctor/interfaces/terminal.rb'
+    ruby_proctor_terminal()
+  elsif OS.windows?
+    require 'ruby_proctor/interfaces/gui.rb'
+    ruby_proctor_gui()
+  end
+end