moodleQuizDownloader 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8c17d2cdd565630203b2eaacaaf27fe47fe3110
-  data.tar.gz: de31f285dd09c3cfd339c01a3761067169f08bbf
+  metadata.gz: a7e868ece8269a98c5a62ff40f9438412ed7f068
+  data.tar.gz: 5f9c904e12793af94eae0398fd24cbd3f8501e34
 SHA512:
-  metadata.gz: 5d2fa647058a7534f13518b88ab538d1a195a57090f8293b4803b4044b134e256d20a396c2ac8a85d1d130fdea9c3ca88eb64dd3ca2424966062dfd72855470f
-  data.tar.gz: b862718b20c6ae363765f1dae1d6ac1b97104375f87d20af8b471f46605a791f96f77fc6cae2c2f0565c5fdcfd76992820f84353fdde8cf49abe296bba71fb99
+  metadata.gz: 2c52ebce025f19243e3d224f2a3f1312f416585f6cf828b838626107f234f344e1e1a36ab584f90e58654f2ef4591a8aaf563acfb40cae731fdc5e6a0bdbaa10
+  data.tar.gz: 36d8382a844414c0ad59a5608d39f06c038d93882264173872b66bb85cd7eb8bc5bba6f1f728ab0ace98b9fe2f272306ec356eed9073ccffd1d82f20fdd6fce0

data/.ruby-gemset

@@ -0,0 +1 @@
+myrubystack

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.0

data/README.md

@@ -1,20 +1,25 @@
 # MoodleQuizDownloader
 
-TODO: Write a gem description
+Automatically downloads all attempts of a Moodle Quiz and stores them as PDF or HTML.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install moodleQuizDownloader
 
-    gem 'moodleQuizDownloader'
+## What it does
 
-And then execute:
+This script downloads all attempts of a moodle quiz and saves them in pdfs named with the student names.
+For this it logs into moodle via the http/html web site, goes to the quiz and scrapes all information like student names etc. from the html it finds.
 
-    $ bundle
+To get started, you first need the moodle id of the quiz you want to download. E.g. if the url shown in the browser was
 
-Or install it yourself as:
+https://moodle.htw-berlin.de/mod/quiz/report.php?id=4711&mode=overview
 
-    $ gem install moodleQuizDownloader
+If you view the quiz's attempts in the browser,
+
+     4711
+
+is the id.
 
 ## Usage
 
@@ -25,7 +30,7 @@ for example, run
 to see a list of all attempts in exam 4711 on the specified server,
 and
 
-    $ moodleQuizDownloader.rb -e 4711 -u drblinken -s http://moodle2.htw-berlin.de/ -p geheim --verbose download
+    $ moodleQuizDownloader.rb -e 4711 -u drblinken -s http://moodle.someschool.de/ -p geheim --verbose download
 
 to download them.
 
@@ -33,6 +38,26 @@ to see all options:
 
     $ moodleQuizDownloader.rb help
 
+## try it out in irb
+
+e.g.:
+
+     irb
+     load 'lib/moodleQuizDownloader.rb'
+
+     arguments = "-o /Users/kleinen/Documents/ss2013/exam-     ckup/info3/pz1/exam_a/raw -e 23843".split(" ")
+     options = OptionHandler.new(arguments).parse
+     q = QuizDownloader.new
+     agent = Mechanize.new
+     q.smoketest(options.moodle_server)
+     q.attemptlist(options,agent)
+     page = q.smoketest(options.moodle_server)
+     username_input = page.search('#username')
+
+## Todos / New Features
+
+* Add an option to be prompted for the password ( or just do it automatically if it is not provided)
+
 ## Contributing
 
 1. Fork it

data/lib/moodleQuizDownloader.rb

@@ -1,15 +1,28 @@
 require_relative "moodleQuizDownloader/version.rb"
 require_relative "moodleQuizDownloader/option_handler.rb"
 require_relative "moodleQuizDownloader/quiz_downloader.rb"
+require_relative "moodleQuizDownloader/attempt_selector.rb"
 
 module MoodleQuizDownloader
+
   def run_script(arguments)
-    options = OptionHandler.new(arguments).parse
+    option_handler = OptionHandler.new(arguments)
+    options = option_handler.options
     if options.usage
       puts options.usage
       exit
     end
-    QuizDownloader.new.run(options)
+    options.moodle_password ||= prompt_for_password
+    begin
+      QuizDownloader.new(options).run
+    rescue PageException => e 
+      puts "#{e.message}"
+    end
+  end
+
+  def prompt_for_password(prompt="Enter Password")
+    require 'highline/import'
+    ask(prompt) {|q| q.echo = false}
   end
 end
 

data/lib/moodleQuizDownloader/attempt_selector.rb

@@ -0,0 +1,37 @@
+#<select id="id_attempts" name="attempts">
+#
+#    <option selected="selected" value="enrolled_with"><#/option>
+#    <option value="enrolled_without"></option>
+#    <option value="enrolled_any"></option>
+#    <option value="all_with"></option>
+#
+#</select>
+#
+#
+#    <input id="id_submitbutton" type="submit" #value="Bericht anzeigen" name="submitbutton"></input#>
+#
+#
+
+
+# moodle selecty "students who take the quiz and are enrolled"
+# as default -
+# to archive quizzes later on, this Module selects
+# all attempts.
+
+
+# form
+#mform1
+module MoodleAttemptSelector
+
+  def select_all_attempts_done(page)
+    form = page.form_with(id: 'mform1')
+    selectlist = form.field_with(id: 'id_attempts')
+    selectlist.value="all_with"
+    page = form.submit
+  end
+
+
+
+end
+
+

data/lib/moodleQuizDownloader/file_name_creator.rb

@@ -5,8 +5,8 @@ class FileNameCreator
   @@regexp = /(\w*)( (\w*))? (\w*)/
   @@map = Asciify::Mapping.new(:default)
 
-  def self.fileNameFor(outputdir,name)
-    File.join(outputdir,name.asciify(@@map).gsub(@@regexp,"\\1\\3\\4.pdf"))
+  def self.file_name_for(outputdir,name,extension = 'pdf')
+    name = name.gsub("-","")
+    File.join(outputdir,name.asciify(@@map).gsub(@@regexp,"\\1\\3\\4.#{extension}"))
   end
-
 end

data/lib/moodleQuizDownloader/moodle_parser.rb

@@ -1,17 +1,29 @@
+
+# This file contains Moodle settings
+# like urls and xml paths
+# decided against putting them in a config file,
+# as they can be adapted here.
+require_relative 'attempt_selector.rb'
 module MoodleParser
+  include MoodleAttemptSelector
     @@user_view_regexp = Regexp.new('http://moodle2.htw-berlin.de/moodle/user/view.php')
 
-    def moodle_login_page(server)
-    "#{server}/moodle/login/index.php"
+  def moodle_login_page(server)
+    "#{server}"
+    # oder vielleicht besser:
+    #https://moodle.htw-berlin.de/login/index.php
+    # "#{server}/moodle/login/index.php"
   end
   def moodle_item(server)
     "#{server}/moodle/mod/quiz/view.php?id="
   end
   def moodle_quiz_report(server)
-    "#{server}/moodle/mod/quiz/report.php?mode=overview&id="
+  #   https://moodle.htw-berlin.de/mod/quiz/report.php?id=46982&mode=overview
+    "#{server}/mod/quiz/report.php?mode=overview&id="
   end
 
   def login(agent,moodle_login_page,moodle_username,moodle_password)
+    chatter "connecting to moodle"
     puts "++++#{moodle_login_page}"
     page = agent.get(moodle_login_page)
     form = page.forms[1]
@@ -22,11 +34,22 @@ module MoodleParser
 
   def selectReviewLinks(page)
     page.links.select do |ll|
-      cls = ll.attributes.attributes['class']
-      cls && cls.value == 'reviewlink'
+      css_class = ll.attributes.attributes['class']
+      css_class && css_class.value == 'reviewlink'
     end
   end
 
+  def extract_complete_attempt_list(page)
+    page = select_all_attempts_done(page)
+    attempt_list = extract_attempt_list(page)
+    if (announced = extract_attempt_count(page)) != attempt_list.size
+      puts "#### WARNING: There was a different number of "
+      puts "####          attempts announced on the page - #{announced}"
+      puts "####          but only #{attempt_list.size} could be downloaded"
+    end
+    attempt_list
+  end
+
   def extract_attempt_list(page)
    i = 1
    result_list = []
@@ -39,6 +62,20 @@ module MoodleParser
    result_list
   end
 
+  def extract_attempt_count(page)
+    ##class: quizattemptcounts
+    quizattemptcounts_div = page.at('.quizattemptcounts')
+    m = quizattemptcounts_div.content.match(/Attempts: (\d+)/)
+    m[1].to_i
+  end
+
+  def all_attempts_shown(page,number_of_attempts_shown = nil)
+    unless number_of_attempts_shown
+      number_of_attempts_shown = extract_attempt_list(page).size
+    end
+    number_of_attempts_shown == extract_attempt_count(page)
+  end
+
   def extractUserName(page)
 
     l = page.links.select {|x| @@user_view_regexp.match(x.href)}

data/lib/moodleQuizDownloader/option_handler.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 
 class OptionHandler
   def valid_commands
-    [:list, :download, :connect]
+    [:list, :download, :connect, :options]
   end
   attr_reader :options, :optionparser
   def initialize(arguments = [])
@@ -20,7 +20,7 @@ class OptionHandler
   def valid?(options)
     options.valid &&
     options.moodle_username &&
-    options.moodle_password &&
+    #options.moodle_password &&
     options.moodle_server &&
     options.exam_id != 0
   end
@@ -38,6 +38,7 @@ class OptionHandler
     options.exam_id = 0
     options.command = :list
     options.usage = nil
+    options.html = false
 
 
     opt_parser = OptionParser.new do |opts|
@@ -57,18 +58,23 @@ DELIM
               "Output Dir (defaults to . )") do | dir |
         options.outputdir = dir
       end
+      opts.on("-h", "--html",
+              "Save Exams in HTML instead as PDFs") do | html |
+        options.html = html
+      end
+
       opts.on("-u", "--user USERNAME",
               "Your Moodle User Name",
               "(can also be set via MOODLE_USERNAME environment variable)") do |username|
         options.moodle_username = username
       end
-      opts.on("-p", "--password PASSWORD]",
+      opts.on("-p", "--password PASSWORD",
               "Your Moodle Password",
               "(can also be set via MOODLE_PASSWORD environment variable)") do |password|
         options.moodle_password = password
       end
 
-      opts.on("-s", "--server SERVER]",
+      opts.on("-s", "--server SERVER",
               "Your Moodle Server",
               "(can also be set via MOODLE_SERVER environment variable)") do |server|
         options.moodle_server = server
@@ -101,4 +107,5 @@ DELIM
     validate(options,opt_parser)
     options
   end  # parse()
+
 end

data/lib/moodleQuizDownloader/quiz_downloader.rb

@@ -3,76 +3,124 @@ require 'pdfkit'
 require 'asciify'
 require "bundler/setup"
 require 'fileutils'
-require_relative 'file_name_creator'
 
+require_relative 'file_name_creator'
 require_relative 'moodle_parser'
 
-
+  class PageException < Exception
+  end
 
 class QuizDownloader
+
   include MoodleParser
 
-  def smoketest(server)
+  attr_reader :options
+  def initialize(options)
+    @options = options
+  end
+
+  def run
+    agent = Mechanize.new
+    case options.command
+      when :connect
+        smoketest(options.moodle_server, options.moodle_username, options.moodle_password)
+      when :list
+        attempt_list = attemptlist(agent)
+        puts "found #{attempt_list.length} attempts:"
+        puts attempt_list.map{|a,b| a}
+      when :download
+        chatter "options #{options.inspect}"
+        attempt_list = attemptlist(agent)
+        download(attempt_list,agent)
+      when :options
+        puts "#{options.inspect}"
+
+      else
+        puts "command #{options.command} not recognized"
+    end
+  end
+
+  def chatter(message)
+    puts "==== #{message}" if options.verbose
+  end
+
+  def smoketest(server, username = "xxx", password ="xxx")
     begin
       agent = Mechanize.new
-      page = login(agent,moodle_login_page(server),"xxx","xxx")
-      if page.nil?
-        puts "could not connect to server #{server}"
+      page = login(agent,moodle_login_page(server),username,password)
+      unless server_reachable?(page)
+        puts "Could not connect to server #{server}"
       else
-        puts "connection to server seems to be working"
+        puts "Connection to server seems to be working..."
+        if login_successful?(page)
+          puts "and login has been successful."
+        else
+          puts "but could not login with the given credentials."
+        end
       end
     rescue Exception => e
         puts "could not connect to server #{server}"
         #puts e.message
     end
+    page
   end
-  def attemptlist(options,agent)
-    puts "connecting to moodle" if options.verbose
-    page = login(agent,moodle_login_page(options.moodle_server),options.moodle_username,options.moodle_password)
+
+  def login_successful?(page)
+    page.search('#username').empty?
+  end
+  def server_reachable?(page)
+    !page.nil?
+  end
+
+  def attemptlist(agent)
+
+    login(agent,moodle_login_page(options.moodle_server),options.moodle_username,options.moodle_password)
+
     moodle_overview_url = moodle_quiz_report(options.moodle_server)+options.exam_id.to_s
-    puts "==== downloading overview" if options.verbose
-    puts moodle_overview_url if options.verbose
-    page = agent.get(moodle_overview_url)
-    #attempts = selectReviewLinks(page)
-    attempt_list = extract_attempt_list(page)
+    chatter "downloading overview"
+    chatter "url:#{moodle_overview_url}"
+    begin
+      page = agent.get(moodle_overview_url)
+      attempt_list = extract_attempt_list(page)
+    rescue Mechanize::ResponseCodeError => e 
+      raise e unless (e.response_code == "404") 
+      raise PageException, "Exam not found - maybe the wrong id: #{options.exam_id} ?\n(while trying to access: #{moodle_overview_url})"
+    end 
+  
   end
 
-  def download(attempt_list,options,agent)
+  def download(attempt_list,agent)
     FileUtils.mkdir_p(options.outputdir)
+    count = 0
     attempt_list.each do | attempt|
       student_name, attempt_url = attempt
 
       attempt_url = attempt_url+"&showall=1"
       page = agent.get(attempt_url)
-      puts "==== downloading attempt" if options.verbose
-      puts attempt_url if options.verbose
+      chatter "downloading attempt"
+      chatter "url  #{attempt_url}"
+      chatter attempt_url
       #student = extractUserName(page)
       student = student_name
-      outputfile = FileNameCreator.fileNameFor(options.outputdir,student)
-      puts "Loading: #{student}"
-      kit = PDFKit.new(page.body)
-      kit.to_file(outputfile)
-    end
-  end
 
+      puts "Loading: #{student}"
 
-  def run(options)
-    agent = Mechanize.new
-    case options.command
-      when :connect
-        smoketest(options.moodle_server)
-      when :list
-        attempt_list = attemptlist(options,agent)
-        puts "found #{attempt_list.length} attempts:"
-        puts attempt_list.map{|a,b| a}
-      when :download
-        attempt_list = attemptlist(options,agent)
-        download(attempt_list,options,agent)
+      chatter "downloading overview"
+      chatter "outputfile:#{options.outputdir}"
+      kit = PDFKit.new(page.body)
+      if options.html
+        chatter "save html"
+        outputfile_html = FileNameCreator.file_name_for(options.outputdir,student,'html')
+        File.open(outputfile_html, 'w') { |file| file.write(page.body) }
       else
-        puts "command #{options.command} not recognized"
+        chatter "kit to file"
+        outputfile = FileNameCreator.file_name_for(options.outputdir,student)
+        kit.to_file(outputfile)
+        chatter "x"
+      end
+      count += 1
     end
+    puts "downloaded #{count} attempts"
   end
-
-
 end