moodleQuizDownloader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8c17d2cdd565630203b2eaacaaf27fe47fe3110
+  data.tar.gz: de31f285dd09c3cfd339c01a3761067169f08bbf
+SHA512:
+  metadata.gz: 5d2fa647058a7534f13518b88ab538d1a195a57090f8293b4803b4044b134e256d20a396c2ac8a85d1d130fdea9c3ca88eb64dd3ca2424966062dfd72855470f
+  data.tar.gz: b862718b20c6ae363765f1dae1d6ac1b97104375f87d20af8b471f46605a791f96f77fc6cae2c2f0565c5fdcfd76992820f84353fdde8cf49abe296bba71fb99

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+out

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in moodleQuizDownloader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dr Blinken
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# MoodleQuizDownloader
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'moodleQuizDownloader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moodleQuizDownloader
+
+## Usage
+
+for example, run
+
+    $ moodleQuizDownloader.rb -e 4711 -u drblinken -s http://moodle2.htw-berlin.de/ -p geheim --verbose
+
+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
+
+to download them.
+
+to see all options:
+
+    $ moodleQuizDownloader.rb help
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/moodleQuizDownloader.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/moodleQuizDownloader.rb'
+include MoodleQuizDownloader
+run_script(ARGV)

data/lib/moodleQuizDownloader.rb

@@ -0,0 +1,16 @@
+require_relative "moodleQuizDownloader/version.rb"
+require_relative "moodleQuizDownloader/option_handler.rb"
+require_relative "moodleQuizDownloader/quiz_downloader.rb"
+
+module MoodleQuizDownloader
+  def run_script(arguments)
+    options = OptionHandler.new(arguments).parse
+    if options.usage
+      puts options.usage
+      exit
+    end
+    QuizDownloader.new.run(options)
+  end
+end
+
+

data/lib/moodleQuizDownloader/file_name_creator.rb

@@ -0,0 +1,12 @@
+require 'asciify'
+
+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"))
+  end
+
+end

data/lib/moodleQuizDownloader/moodle_parser.rb

@@ -0,0 +1,61 @@
+module MoodleParser
+    @@user_view_regexp = Regexp.new('http://moodle2.htw-berlin.de/moodle/user/view.php')
+
+    def moodle_login_page(server)
+    "#{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="
+  end
+
+  def login(agent,moodle_login_page,moodle_username,moodle_password)
+    puts "++++#{moodle_login_page}"
+    page = agent.get(moodle_login_page)
+    form = page.forms[1]
+    form.username = moodle_username
+    form.password = moodle_password
+    page = form.submit
+  end
+
+  def selectReviewLinks(page)
+    page.links.select do |ll|
+      cls = ll.attributes.attributes['class']
+      cls && cls.value == 'reviewlink'
+    end
+  end
+
+  def extract_attempt_list(page)
+   i = 1
+   result_list = []
+   while page.at("//*[@id=\"attempts\"]/tbody/tr[#{i}]/td[3]/a[1]") do
+     student_name = page.at("//*[@id=\"attempts\"]/tbody/tr[#{i}]/td[3]/a[1]").text
+     attempt_url = page.at("//*[@id=\"attempts\"]/tbody/tr[#{i}]/td[3]/a[2]").attributes["href"].value
+     result_list << [student_name,attempt_url]
+     i += 1
+   end
+   result_list
+  end
+
+  def extractUserName(page)
+
+    l = page.links.select {|x| @@user_view_regexp.match(x.href)}
+    nutzerbild_string = "Nutzerbild "
+    nutzerbild = l.select{ |x| /Nutzerbild/.match(x.text)}
+    if nutzerbild.empty?
+      nutzerbild = l.select{ |x| /Picture of/.match(x.text)}
+      nutzerbild_string = "Picture of "
+    end
+    if nutzerbild.empty?
+      puts "## WARNING! ##"
+      puts "could not extract user name"
+      puts "## nutzerbild #{nutzerbild.inspect}"
+      puts "-- nutzerbild_string #{nutzerbild_string}"
+      return "Unknown Student"
+    end
+    nutzerbild.first.text.gsub(nutzerbild_string,"")
+  end
+
+end

data/lib/moodleQuizDownloader/option_handler.rb

@@ -0,0 +1,104 @@
+require 'optparse'
+require 'ostruct'
+
+class OptionHandler
+  def valid_commands
+    [:list, :download, :connect]
+  end
+  attr_reader :options, :optionparser
+  def initialize(arguments = [])
+    @arguments = arguments
+    @options, @optionparser = parse(arguments)
+  end
+  def usage
+    @options.usage
+  end
+
+  def validate(options,optionparser)
+    options.usage = optionparser.help unless valid?(options)
+  end
+  def valid?(options)
+    options.valid &&
+    options.moodle_username &&
+    options.moodle_password &&
+    options.moodle_server &&
+    options.exam_id != 0
+  end
+
+  def parse(args = @arguments)
+    # The options specified on the command line will be collected in *options*.
+    # We set default values here.
+    options = OpenStruct.new
+    options.valid = true
+    options.verbose = false
+    options.moodle_username = ENV['MOODLE_USERNAME']
+    options.moodle_password = ENV['MOODLE_PASSWORD']
+    options.moodle_server = ENV['MOODLE_SERVER']
+    options.outputdir = "out"
+    options.exam_id = 0
+    options.command = :list
+    options.usage = nil
+
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = <<DELIM
+Usage: moodleQuizDownloader [options] <command>
+Where <command> is one of the following: #{valid_commands.join(", ")}
+DELIM
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("-e", "--exam EXAM_ID",
+              "The ID of the Exam to be downloaded") do | id |
+        options.exam_id = id
+      end
+      opts.on("-o", "--outputdir DIR",
+              "Output Dir (defaults to . )") do | dir |
+        options.outputdir = dir
+      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]",
+              "Your Moodle Password",
+              "(can also be set via MOODLE_PASSWORD environment variable)") do |password|
+        options.moodle_password = password
+      end
+
+      opts.on("-s", "--server SERVER]",
+              "Your Moodle Server",
+              "(can also be set via MOODLE_SERVER environment variable)") do |server|
+        options.moodle_server = server
+      end
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("-v", "--version", "Show version") do
+        options.command = :version
+      end
+      opts.on("-b", "--[no-]verbose", "Run verbosely") do |v|
+        options.verbose = v
+      end
+
+    end
+    opt_parser.order(args) do | command |
+      command = command.to_sym
+      if valid_commands.include?(command)
+        options.command = command
+      else
+        options.valid=false
+      end
+    end
+    validate(options,opt_parser)
+    options
+  end  # parse()
+end

data/lib/moodleQuizDownloader/quiz_downloader.rb

@@ -0,0 +1,78 @@
+require 'mechanize'
+require 'pdfkit'
+require 'asciify'
+require "bundler/setup"
+require 'fileutils'
+require_relative 'file_name_creator'
+
+require_relative 'moodle_parser'
+
+
+
+class QuizDownloader
+  include MoodleParser
+
+  def smoketest(server)
+    begin
+      agent = Mechanize.new
+      page = login(agent,moodle_login_page(server),"xxx","xxx")
+      if page.nil?
+        puts "could not connect to server #{server}"
+      else
+        puts "connection to server seems to be working"
+      end
+    rescue Exception => e
+        puts "could not connect to server #{server}"
+        #puts e.message
+    end
+  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)
+    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)
+  end
+
+  def download(attempt_list,options,agent)
+    FileUtils.mkdir_p(options.outputdir)
+    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
+      #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
+
+
+  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)
+      else
+        puts "command #{options.command} not recognized"
+    end
+  end
+
+
+end
+

data/lib/moodleQuizDownloader/version.rb

@@ -0,0 +1,3 @@
+module MoodleQuizDownloader
+  VERSION = "0.0.1"
+end

data/moodleQuizDownloader.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moodleQuizDownloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "moodleQuizDownloader"
+  spec.version       = MoodleQuizDownloader::VERSION
+  spec.authors       = ["Dr Blinken"]
+  spec.email         = ["drblinken@gmail.com"]
+  spec.description   = %q{Downloads Quizzes from Moodle as PDF}
+  spec.summary       = %q{This is a little ruby command line tool that hooks to a moodle server and downloads all attempts for an exam as pdfs.}
+  spec.homepage      = "https://github.com/drblinken/moodleQuizDownloader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "asciify"
+  spec.add_dependency "iconv" #this is a dependency of asciify
+  spec.add_dependency 'mechanize'
+  spec.add_dependency 'pdfkit'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+end

data/spec/api/asciify_spec.rb

@@ -0,0 +1,8 @@
+# Encoding: utf-8
+require 'asciify'
+describe "using asciify" do
+  it "converts umlaute" do
+     map = Asciify::Mapping.new(:default)
+    "ÄÖÜßäöü".asciify(map).should == "AeOeUessaeoeue"
+  end
+end

data/spec/api/pdfkit_spec.rb

@@ -0,0 +1,21 @@
+#
+# rspec to test usage of pdfkit in this script
+#
+# installation
+# gem 'pdfkit'
+# brew install wkhtmltopdf
+# don't just install the gem, this didn't work as described in
+# https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF
+# https://github.com/pdfkit/pdfkit/wiki/
+# http://code.google.com/p/wkhtmltopdf/
+# https://github.com/pdfkit/pdfkit
+require 'pdfkit'
+describe 'pdfkit api' do
+  it "should convert a html page to pdf" do
+     html = '<body>Hallu</body>'
+     kit = PDFKit.new(html)
+#     >> k.to_file('simple.pdf')
+     pdf = kit.to_pdf
+     pdf.should match /^%PDF-/
+   end
+end