markify 0.1.0 → 0.2.0

data/README.md

@@ -1,9 +1,26 @@
 # 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.
+Markify is a ruby script to detect new marks or course assessments in the student information system of your university.
+Supported universities are:
+
+* [University of Applied Sciences Bonn-Rhein-Sieg](http://h-brs.de)
+
+If new marks are detected, Markify will send you a [XMPP](http://xmpp.org/) message for every change.
+
+The main reason for creating Markify is some kind of disappointing. Our university is able to publish the results of
+exams online, but the web based student information system is not able to send notifications if something is changed.
+That is very annoying especially in the time when you have to write exams, but you also waiting for results.
+
+What Markify does is to do the same procedure which would you do to look for new marks.
+
+1. Go to the student information system login page.
+2. Login with your 	user data.
+3. Go to your performance record.
+4. Scrape the page.
+5. Recognize changes.
+6. Send notifications.
+
+The benefit of Markify against your manual interaction is, that you can run Markify automatically per cron.
 
 ## Installation
 
@@ -13,11 +30,25 @@ Install Markify via rubygems:
 
 ## Usage
 
-To create the initial markify configuration run:
+1. Create the initial Markify configuration.
+
+        $ markify --init
+
+2. Add your student information system and XMPP login data to your configuration. Default path ``$HOME/markify/config.yml``.
+
+3. Test your configuration.
 
-    $ markify --init
+        $ markify --test
 
-The default configuration path is ``/home/$user/markify/config.yml``. You have to add your SIS and xmpp login data.
+4. Run Markify to create hash database and insert all known marks.
+
+        $ markify -v
+
+5. Configure cron job to run Markify every hour.
+
+        $ crontab -e
+
+        @hourly /usr/local/bin/bash -c "/usr/local/bin/markify -s"
 
 Possible options to run markify:
 
@@ -25,7 +56,7 @@ Possible options to run markify:
 
     Optional options:
         -s, --send                       Send xmpp messages
-        -n, --noop                       No operation, only stout output
+        -n, --noop                       No operation, only stdout output
         -v, --[no-]verbose               Run verbosely
 
         -f, --config-file FILE           Config file (default: ~/markify/config.yml)
@@ -34,7 +65,22 @@ Possible options to run markify:
             --init                       Create example configuration
             --test                       Test configuration and accounts
         -h, --help                       Show this message
-            --version                    Show version inforamtion
+            --version                    Show version information
+
+## Notification example
+
+    exam:   BCS-3-SPEZ Transportnetze und Hochgeschwindigkeitsnetze
+    mark:   1.7
+    passed: BE
+    try:    3
+    date:   2042-01-23
+
+    hash:   05d48ced524708314d4ff2e628f7200b06f02ed2e40a36efd92bbf449f474cce
+
+## Contribution
+
+The Markify source code is [hosted on GitHub](https://github.com/meise/markify). Please use the
+[issue tracker](https://github.com/meise/markify/issues) and let me know about errors or ideas to improve this software.
 
 ## License
 

data/examples/config.yml.example

@@ -1,4 +1,5 @@
-sis:
+university:
+  acronym:
   login_name:
   password:
 

data/lib/markify.rb

@@ -24,32 +24,43 @@ 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'
+require 'markify/scraper/base'
+require 'markify/scraper/hbrs'
 
 module Markify
 
   def self.run!
     @options      = Markify::OptParser.parse!
     @config       = Markify::Settings.load!(@options[:config_file])
+    @scraper      = nil
+
+    mark_database = Markify::Database.new(@config['general']['database_file'])
+
+    case @config['university']['acronym'].downcase
+      when /hbrs/
+        @scraper = Markify::Scraper::Hbrs.new(@config['university']['login_name'],
+                                              @config['university']['login_password'])
+      else
+        puts 'No support for your university.'
+        exit
+    end
 
     if @options[:test]
-      Markify::Settings.test_settings(@config)
+      Markify::Settings.test_settings(@config, @scraper)
       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!
+    all_marks = @scraper.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
+      exit 0
     end
 
     bot = Markify::Bot.new(@config['xmpp']['bot_id'], @config['xmpp']['bot_password']) if @options[:send]

data/lib/markify/optparser.rb

@@ -37,11 +37,11 @@ module Markify::OptParser
       opts.separator ""
       opts.separator "Optional options:"
 
-      opts.on('-s', '--send', 'Send xmpp messages') do |s|
+      opts.on('-s', '--send', 'Send XMPP messages') do |s|
         options[:send] = s
       end
 
-      opts.on('-n', '--noop', 'No operation, only stout output') do |n|
+      opts.on('-n', '--noop', 'No operation, only stdout output') do |n|
         options[:noop] = n
       end
 
@@ -75,7 +75,7 @@ module Markify::OptParser
         exit
       end
 
-      opts.on_tail('--version', 'Show version inforamtion') do
+      opts.on_tail('--version', 'Show version information') do
         puts Markify::LICENCE
         exit
       end

data/lib/markify/scraper/base.rb

@@ -0,0 +1,50 @@
+# 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'
+
+module Markify::Scraper
+  class Base
+
+    attr_reader :marks
+
+    def initialize(login_name, login_password, sis_login_page)
+      @agent = Mechanize.new
+      original, library = */(.*) \(.*\)$/.match(@agent.user_agent)
+      @agent.user_agent =
+          "#{Markify::NAME.capitalize}/#{Markify::VERSION} #{library} (https://github.com/meise/markify)"
+
+      @data                  = {}
+      @data[:login_page]     = sis_login_page
+      @data[:login_name]     = login_name
+      @data[:login_password] = login_password
+
+      @marks = []
+    end
+
+    def scrape!
+      scrape
+    end
+
+    def test_login
+      puts 'Scraper: Nothing to test.'
+    end
+  end
+end

data/lib/markify/{scraper.rb → scraper/hbrs.rb}

@@ -18,45 +18,33 @@ 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::Hbrs < Markify::Scraper::Base
 
-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
+  def initialize(login_name, login_password)
+    super(login_name,
+          login_password,
+          'https://dias.fh-bonn-rhein-sieg.de/d3/SISEgo.asp?UserAcc=Gast&DokID=DiasSWeb&ADias2Dction=Login'
+    )
   end
 
   def test_login
-    login_page = @agent.get(@sis[:login_page])
-    error_page = sis_login(@sis[:login_name], @sis[:login_password], login_page)
+    login_page = @agent.get(@data[:login_page])
+    error_page = sis_login(@data[:login_name], @data[: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."
+      puts "Scraper: Username and password wrong."
     else
-      puts "SIS: Login works."
+      puts "Scraper: Login works."
     end
   end
 
   protected
 
   def scrape
-    login_page = @agent.get(@sis[:login_page])
+    login_page = @agent.get(@data[:login_page])
 
-    first_sis_page = sis_login(@sis[:login_name], @sis[:login_password], login_page)
+    first_sis_page = sis_login(@data[:login_name], @data[:login_password], login_page)
     marks_table    = get_marks_table(first_sis_page)
 
     get_marks(marks_table)
@@ -71,6 +59,10 @@ class Markify::Scraper
         next
       end
 
+      if mark[7].text =~ /AN/
+        next
+      end
+
       @marks << Markify::Mark.new(
           mark[1].text, # curse name
           mark[0].text, # id

data/lib/markify/settings.rb

@@ -48,7 +48,8 @@ module Markify::Settings
 
       File.open(config_file, 'a+', 0600) do |file|
         file.puts <<CONTENT
-sis:
+university:
+  acronym: hbrs
   login_name: "foobaz2s"
   login_password: "fnord2000"
 
@@ -70,8 +71,8 @@ CONTENT
     end
   end
 
-  def self.test_settings(config)
-    Markify::Scraper.new(config['sis']['login_name'], config['sis']['login_password']).test_login
+  def self.test_settings(config, scraper)
+    scraper.test_login
 
     begin
       Markify::Bot.new(config['xmpp']['bot_id'],

data/lib/markify/version.rb

@@ -20,14 +20,13 @@ along with Markify. If not, see <http://www.gnu.org/licenses/>.
 
 module Markify
 
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   NAME    = 'markify'
 
   DESCRIPTION =<<DESCRIPTION
-#{Markify::NAME.capitalize} is a ruby script to detect new marks in the
-Studierendeninformationssystem (SIS) of the University of Applied Sciences
-Bonn-Rhein-Sieg. If #{Markify::NAME} detects new marks, they will send you a xmpp
-message for every change.
+#{Markify::NAME.capitalize} is a ruby script to detect new marks or course assessments in the student
+information system of your university. If #{Markify::NAME} detects new marks, they will send you a XMPP message for
+every change. Supported universities: University of Applied Sciences Bonn-Rhein-Sieg.
 DESCRIPTION
 
   LICENCE =<<LICENCE
@@ -36,7 +35,7 @@ Released under the GNU GENERAL PUBLIC LICENSE Version 3. © Daniel Meißner, 201
 LICENCE
 
   SUMMARY =<<SUMMARY
-Mark notify script for the Studierendeninformationssystem (SIS) of the University of Applied Sciences Bonn-Rhein-Sieg.
+Mark notify script for different universities.
 SUMMARY
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xmpp4r
@@ -123,13 +123,13 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Markify is a ruby script to detect new marks in the
+description: ! 'Markify is a ruby script to detect new marks or course assessments
+  in the student
 
-  Studierendeninformationssystem (SIS) of the University of Applied Sciences
+  information system of your university. If markify detects new marks, they will send
+  you a XMPP message for
 
-  Bonn-Rhein-Sieg. If markify detects new marks, they will send you a xmpp
-
-  message for every change.
+  every change. Supported universities: University of Applied Sciences Bonn-Rhein-Sieg.
 
 '
 email:
@@ -153,7 +153,8 @@ files:
 - lib/markify/database.rb
 - lib/markify/mark.rb
 - lib/markify/optparser.rb
-- lib/markify/scraper.rb
+- lib/markify/scraper/base.rb
+- lib/markify/scraper/hbrs.rb
 - lib/markify/settings.rb
 - lib/markify/version.rb
 - markify.gemspec
@@ -181,14 +182,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -198789376526089427
+      hash: 3264874439132320863
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Mark notify script for the Studierendeninformationssystem (SIS) of the University
-  of Applied Sciences Bonn-Rhein-Sieg.
+summary: Mark notify script for different universities.
 test_files:
 - spec/markify/database_spec.rb
 - spec/markify/mark_spec.rb