word_2_quiz 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc35826919146c5dc8eaabf3d02691f0bb5d316f
-  data.tar.gz: 774847c6a92cd29628882cff7a30bf13438bc693
+  metadata.gz: edc0535cb4aca7b0a501350715ddd9cdd9d3335b
+  data.tar.gz: d99a2def739f76cd868b82d67803de996339afac
 SHA512:
-  metadata.gz: 857514a6a2306390ca732332838dec3f4e550b0ca34edf8092b1e20a12f24f6d753951d754d33b23573481d8cd690a2e9c2d8363f51c7e0df23b044d729878ca
-  data.tar.gz: 76a0822f024e1e717a81841663b0f10085de535b475475d78a34544dea2b6c73d983efd18733af3f8f805618a0561a54127896de3a2b654a4c7f4481f5768a77
+  metadata.gz: 2603438d795c7feb575ff070522ec9663c79b6d1303afd41d0b66460dce8db91478c782e65db1626aac9d22bb48a94e06e6a0c26014b55d0dc35230482daafe3
+  data.tar.gz: bbeaf617acb589856ef2d93f84f99e430b8387cec8c29dfa0c31c3f9faf24ea49000f3a101c334bf29fe0a346b6989d37e2cde54a665304d1ceff2ac4427d315

data/lib/word_2_quiz.rb

@@ -1,5 +1,6 @@
 require "word_2_quiz/version"
 require "word_2_quiz/quiz_parser"
+require "word_2_quiz/errors"
 
 module Word2Quiz
 end

data/lib/word_2_quiz/errors.rb

@@ -0,0 +1,7 @@
+module Word2Quiz
+  class InvalidAnswerKey < RuntimeError
+  end
+
+  class InvalidQuiz < RuntimeError
+  end
+end

data/lib/word_2_quiz/helpers.rb

@@ -100,5 +100,12 @@ module Word2Quiz
       t.pop while t.last.text.chomp.empty?
       t
     end
+
+    ##
+    # Checks for if the quiz is a valid quiz we can process
+    ##
+    def self.valid_quiz?(text)
+      text.include?("Course Examination") && text.include?("Multiple Choice")
+    end
   end
 end

data/lib/word_2_quiz/question.rb

@@ -1,4 +1,5 @@
 require "word_2_quiz/helpers"
+require "word_2_quiz/errors"
 
 module Word2Quiz
   ##
@@ -22,6 +23,13 @@ module Word2Quiz
     # solution: a string containing which answer(a,b,c,d) is correct
     ##
     def self.from_paragraphs(paragraphs, solution)
+      if solution.nil? || solution.empty?
+        raise InvalidAnswerKey.new(
+          "Question #{Helpers.get_question_number(paragraphs)} does not have" +
+          " an answer.",
+        )
+      end
+
       answers = []
 
       answer_start_indexes = paragraphs.each_index.select do |i|

data/lib/word_2_quiz/quiz.rb

@@ -72,6 +72,7 @@ module Word2Quiz
       {
         title: @title,
         question_count: @questions.count,
+        points_possible: @questions.count * Question::POINTS_POSSIBLE,
         quiz_type: "assignment",
         description: @description,
         allowed_attempts: ALLOWED_ATTEMPTS,

data/lib/word_2_quiz/quiz_parser.rb

@@ -2,14 +2,22 @@ require "docx"
 require "word_2_quiz/quiz"
 require "word_2_quiz/helpers"
 require "word_2_quiz/quiz_solutions_parser"
+require "word_2_quiz/errors"
 
 module Word2Quiz
   def self.parse_quiz(quiz_path, answer_key_path)
     doc = Docx::Document.open(quiz_path)
     paragraphs = doc.paragraphs
+    text = doc.text
+
+    unless Helpers.valid_quiz?(text)
+      raise InvalidQuiz.new("The quiz uploaded is not a valid quiz.")
+    end
 
     answers = Word2Quiz.parse_answers(answer_key_path)
 
     Quiz.from_paragraphs(paragraphs, answers)
+  rescue Zip::Error
+    raise InvalidQuiz.new "The quiz was not a docx file."
   end
 end

data/lib/word_2_quiz/quiz_solutions_parser.rb

@@ -1,14 +1,24 @@
 require "yomu"
 require "docx"
 require "strscan"
+require "word_2_quiz/errors"
 
 module Word2Quiz
   def self.parse_answers(file_path)
     yomu = Yomu.new file_path
     text = yomu.text
+    answers = {}
 
     scanner = StringScanner.new(text)
-    answers = {}
+
+    # Quizzes accidentally uploaded as an answer key don't fail as they match
+    # the regex pattern for the answer key in the questions themselves, so we
+    # check that the file is actually an answer key by looking for the text that
+    # shows up at the top of the columns in the answer key.
+
+    unless text.include?("QUES ANS") && text.include?("---- ---")
+      raise InvalidAnswerKey.new "The uploaded answer key is not valid."
+    end
 
     while scanner.scan_until(/\d+\.\s+[A-Z]/)
       solution_text = scanner.matched.split(".").map(&:strip)

data/lib/word_2_quiz/version.rb

@@ -1,3 +1,3 @@
 module Word2Quiz
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.1".freeze
 end

data/word_2_quiz.gemspec

@@ -6,8 +6,7 @@ require "word_2_quiz/version"
 Gem::Specification.new do |spec|
   spec.name          = "word_2_quiz"
   spec.version       = Word2Quiz::VERSION
-  spec.authors       = ["Atomic Jolt", "David Spencer"]
-  spec.email         = ["david.spencer@atomicjolt.com"]
+  spec.authors       = ["Atomic Jolt"]
 
   spec.summary       = "Read in word doc quizzes and return a hash of questions with answers"
   spec.description   = "Read in word doc quizzes and return a hash of questions with answers"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: word_2_quiz
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Atomic Jolt
-- David Spencer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,8 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 description: Read in word doc quizzes and return a hash of questions with answers
-email:
-- david.spencer@atomicjolt.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -158,6 +156,7 @@ files:
 - bin/setup
 - lib/word_2_quiz.rb
 - lib/word_2_quiz/answer.rb
+- lib/word_2_quiz/errors.rb
 - lib/word_2_quiz/helpers.rb
 - lib/word_2_quiz/question.rb
 - lib/word_2_quiz/quiz.rb