markify 0.1.0

data/README.md

@@ -0,0 +1,41 @@
+# Markify
+
+Markify is a ruby script to detect new marks in the
+Studierendeninformationssystem (SIS) of the University of Applied Sciences
+Bonn-Rhein-Sieg. If markify detects new marks, they will send you a xmpp
+message for every change.
+
+## Installation
+
+Install Markify via rubygems:
+
+    $ gem install markify
+
+## Usage
+
+To create the initial markify configuration run:
+
+    $ markify --init
+
+The default configuration path is ``/home/$user/markify/config.yml``. You have to add your SIS and xmpp login data.
+
+Possible options to run markify:
+
+    $ markify [options]
+
+    Optional options:
+        -s, --send                       Send xmpp messages
+        -n, --noop                       No operation, only stout output
+        -v, --[no-]verbose               Run verbosely
+
+        -f, --config-file FILE           Config file (default: ~/markify/config.yml)
+
+    Common options:
+            --init                       Create example configuration
+            --test                       Test configuration and accounts
+        -h, --help                       Show this message
+            --version                    Show version inforamtion
+
+## License
+
+Released under the GNU GENERAL PUBLIC LICENSE Version 3. © Daniel Meißner, 2013

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/bin/markify

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+begin
+  require 'markify'
+rescue LoadError
+  if File.symlink? __FILE__
+    require File.dirname(File.readlink(__FILE__)) + '/../lib/markify'
+  else
+    require File.dirname(__FILE__) + '/../lib/markify'
+  end
+end
+
+Markify.run!

data/examples/config.yml.example

@@ -0,0 +1,12 @@
+sis:
+  login_name:
+  password:
+
+xmpp:
+  bot_id:
+  bot_password:
+  recipients: ['']
+
+general:
+  verbose: false
+  database_file: "/home/foobaz/markify/hashes.txt"

data/examples/hashes.txt

@@ -0,0 +1,3 @@
+# markify hash database
+fb4dc538d57d3c34b7fed1b83372e5aa07b79ae78852e5a986b71fb3e29ef0a8
+5a523e24796c9ff3e5c664f2c54fa0e87fc34b5696ad0a25c7869b018b27db4a

data/lib/markify.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'date'
+require 'digest'
+require 'yaml'
+require 'pathname'
+
+require "markify/version"
+require "markify/scraper"
+require "markify/database"
+require "markify/bot"
+require "markify/settings"
+require "markify/optparser"
+require 'markify/mark'
+
+module Markify
+
+  def self.run!
+    @options      = Markify::OptParser.parse!
+    @config       = Markify::Settings.load!(@options[:config_file])
+
+    if @options[:test]
+      Markify::Settings.test_settings(@config)
+      exit
+    end
+
+    mark_database = Markify::Database.new(@config['general']['database_file'])
+
+    all_marks = Markify::Scraper.new(@config['sis']['login_name'], @config['sis']['login_password']).scrape!
+    new_marks = mark_database.check_for_new_marks(all_marks)
+
+    if new_marks.count == 0 && (@config['general']['verbose'] || @options[:noop])
+      puts "No new marks."
+      exit
+    end
+
+    bot = Markify::Bot.new(@config['xmpp']['bot_id'], @config['xmpp']['bot_password']) if @options[:send]
+
+    new_marks.sort_by{|mark| mark.date}.each do |mark|
+      unless @options[:noop]
+        mark_database.write_checksum(mark.hash)
+      end
+
+      bot.send_message(@config['xmpp']['recipients'], mark.to_s) if @options[:send]
+
+      puts mark.to_s if @config['general']['verbose'] || @options[:verbose]
+    end
+  end
+end

data/lib/markify/bot.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'xmpp4r/client'
+
+class Markify::Bot
+  def initialize(id, password)
+    @client = Jabber::Client.new(id)
+
+    @client.connect
+    @client.auth(password)
+  end
+
+  def send_message(receiver, message)
+    receiver.each do |r|
+      @client.send(Jabber::Message.new(r, message))
+    end
+  end
+end

data/lib/markify/database.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+class Markify::Database
+
+  attr_reader :file_path
+
+  def initialize(path = nil)
+    @file_path = path || Pathname(ENV['HOME'] + '/markify/hashes.txt')
+    @checksums = read_checksum_file
+  end
+
+  def check_for_new_marks(marks)
+    new_marks = marks.clone
+
+    read_checksum_file.each do |line|
+      marks.each do |mark|
+        if mark.hash.match(line)
+          new_marks.delete(mark)
+        end
+      end
+    end
+
+    new_marks
+  end
+
+  def write_checksum(checksum)
+    File.open(@file_path, 'a+') do |file|
+      file.puts checksum
+    end
+  end
+
+  def checksums
+    checksums = read_checksum_file
+
+    checksums.each do |checksum|
+      if checksum.match(/#/)
+        checksums.delete(checksum)
+      end
+    end
+  end
+
+  protected
+
+  def create_checksum_file
+    unless @file_path.dirname.exist?
+      @file_path.dirname.mkdir
+    end
+
+    File.open(@file_path, 'a+') do |file|
+      file.puts "# markify hash database"
+    end
+  end
+
+  def read_checksum_file
+    hashes = []
+
+    if @file_path.exist?
+      hashes = File.open(@file_path, 'r').read.split(/\n/)
+    else
+      create_checksum_file
+    end
+
+    hashes
+  end
+end

data/lib/markify/mark.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+class Markify::Mark
+
+  attr_reader :name, :id, :date, :mark, :passed, :try, :hash
+
+  def initialize(name, id, mark, passed, try, date)
+    @name   = name
+    @id     = id.to_i
+    @mark   = mark.to_f
+    @passed = passed
+    @try    = try.to_i
+    @date   = Date.strptime(date, '%d.%m.%Y')
+    @hash   = self.to_sha256.to_s
+  end
+
+  def to_s
+    message =<<MESSAGE
+exam:   #{@name}
+mark:   #{@mark}
+passed: #{@passed}
+try:    #{@try}
+date:   #{@date}
+
+hash:   #{@hash}
+
+MESSAGE
+  end
+
+  def to_sha256
+    Digest::SHA256.new << "#{@name}#{@id}#{@date}#{@mark}#{@try}#{@passed}"
+  end
+end

data/lib/markify/optparser.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'optparse'
+
+module Markify::OptParser
+
+  def self.parse!
+    parse
+  end
+
+  protected
+
+  def self.parse
+    options = {}
+
+    oparser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{$0} [options]"
+
+      opts.separator ""
+      opts.separator "Optional options:"
+
+      opts.on('-s', '--send', 'Send xmpp messages') do |s|
+        options[:send] = s
+      end
+
+      opts.on('-n', '--noop', 'No operation, only stout output') do |n|
+        options[:noop] = n
+      end
+
+      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options[:verbose] = v
+      end
+
+      opts.separator ""
+
+      opts.on("-f", "--config-file FILE", "Config file (default: ~/markify/config.yml)") do |file|
+        options[:config_file] = Pathname(file)
+      end
+
+      opts.separator ''
+      opts.separator 'Common options:'
+
+      opts.on_tail('--init', 'Create example configuration') do
+        if options[:config_file]
+          Markify::Settings.create_exmple_config(options[:config_file])
+        else
+          Markify::Settings.create_example_config
+        end
+      end
+
+      opts.on_tail('--test', 'Test configuration and accounts') do
+        options[:test] = true
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('--version', 'Show version inforamtion') do
+        puts Markify::LICENCE
+        exit
+      end
+
+      if ARGV.size == 0
+        puts Markify::DESCRIPTION
+        puts
+        puts opts
+        puts
+        puts Markify::LICENCE
+
+        exit
+      end
+    end.parse!
+
+    options
+  end
+end

data/lib/markify/scraper.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+=begin
+Copyright Daniel Meißner <meise+markify@3st.be>, 2013
+
+This file is part of Markify.
+
+Markify is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Markify is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Markify. If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'mechanize'
+
+class Markify::Scraper
+
+  attr_reader :marks
+
+  def initialize(login_name, login_password, sis_login_page = nil)
+    @agent = Mechanize.new
+
+    @sis                  = {}
+    @sis[:login_page]     = sis_login_page || 'https://dias.fh-bonn-rhein-sieg.de/d3/SISEgo.asp?UserAcc=Gast&DokID=DiasSWeb&ADias2Dction=Login'
+    @sis[:login_name]     = login_name
+    @sis[:login_password] = login_password
+
+    @marks = []
+  end
+
+  def scrape!
+    scrape
+  end
+
+  def test_login
+    login_page = @agent.get(@sis[:login_page])
+    error_page = sis_login(@sis[:login_name], @sis[:login_password], login_page)
+
+    if error_page.search(".//*[@id='inhalt']/table/tbody/tr/td/form/center/table/tr[3]/td").text =~
+        /Benutzername unbekannt oder falsches Kennwort eingegeben!/
+      puts "SIS: Username and password wrong."
+    else
+      puts "SIS: Login works."
+    end
+  end
+
+  protected
+
+  def scrape
+    login_page = @agent.get(@sis[:login_page])
+
+    first_sis_page = sis_login(@sis[:login_name], @sis[:login_password], login_page)
+    marks_table    = get_marks_table(first_sis_page)
+
+    get_marks(marks_table)
+  end
+
+  def get_marks(marks_table)
+    marks_table.each do |m|
+      mark = m.search('./td')
+
+      # use only lines with a id
+      unless mark[0].text =~ /\d{4,5}/
+        next
+      end
+
+      @marks << Markify::Mark.new(
+          mark[1].text, # curse name
+          mark[0].text, # id
+          mark[4].text, # mark
+          mark[7].text, # passed
+          mark[8].text, # try
+          mark[12].text # date
+      )
+    end
+
+    @marks
+  end
+
+  def get_marks_table(page_after_login)
+    marks_table = nil
+
+    if link = page_after_login.link_with(text: "Notenspiegel (vollständig)")
+      mark_page   = link.click
+      marks_table = mark_page.search(".//*[@id='inhalt']/table/tbody/tr/td/center/table/tr")
+    else
+      puts "Page after login not available."
+      exit
+    end
+
+    marks_table
+  end
+
+  def sis_login(name, password, login_page)
+    page_after_login = login_page.form_with(action: '/d3/SISEgo.asp?formact=Login') do |form|
+      form.txtBName    = name
+      form.txtKennwort = password
+    end.click_button
+  end
+end