markify 0.1.0

data/lib/markify/settings.rb

@@ -0,0 +1,101 @@
+# 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
+
+module Markify::Settings
+
+  DEFAULT_CONFIG_PATH = Pathname(ENV['HOME'] + "/markify/config.yml")
+
+  attr_reader :config
+
+  def self.load!(file = nil)
+    config_file = file || DEFAULT_CONFIG_PATH
+
+    if config_file.exist?
+      config = YAML::load_file(config_file)
+      validate(config)
+    else
+      puts 'Config file does not exist. Please create it.'
+      puts "  $ #{$0} --init"
+      exit
+    end
+  end
+
+  def self.create_example_config(file = nil)
+    config_file = file || DEFAULT_CONFIG_PATH
+
+    if config_file.exist?
+      puts "Configuration file #{config_file} already exists."
+      exit
+    else
+      Dir.mkdir(config_file.dirname) unless config_file.dirname.exist?
+
+      File.open(config_file, 'a+', 0600) do |file|
+        file.puts <<CONTENT
+sis:
+  login_name: "foobaz2s"
+  login_password: "fnord2000"
+
+xmpp:
+  bot_id: "bot@foo.baz.er"
+  bot_password: "möpmöp"
+
+  recipients: [bla@jabber.foo.baz, müp@möp.blap.ba]
+
+general:
+  verbose: false
+  database_file: "#{ENV['HOME'] + '/markify/hashes.txt'}"
+CONTENT
+      end
+
+      puts "#{config_file} created."
+
+      exit
+    end
+  end
+
+  def self.test_settings(config)
+    Markify::Scraper.new(config['sis']['login_name'], config['sis']['login_password']).test_login
+
+    begin
+      Markify::Bot.new(config['xmpp']['bot_id'],
+                     config['xmpp']['bot_password']).send_message(config['xmpp']['recipients'],
+                                                                 "#{Markify::NAME} Test #{Time.now}")
+    rescue Jabber::ClientAuthenticationFailure
+      puts "XMPP: Bot authentication failed."
+    else
+      puts "XMPP: Bot works."
+    end
+  end
+
+  protected
+
+  def self.validate(config)
+    # convert recipients to an array
+    if config['xmpp']['recipients'].is_a?(String)
+      config['xmpp']['recipients'] = [ config['xmpp']['recipients'] ]
+    end
+
+    unless config['general']['database_file'].nil?
+      config['general']['database_file'] = Pathname(config['general']['database_file'])
+    end
+
+    config
+  end
+end

data/lib/markify/version.rb

@@ -0,0 +1,42 @@
+# 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
+
+module Markify
+
+  VERSION = '0.1.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.
+DESCRIPTION
+
+  LICENCE =<<LICENCE
+#{Markify::NAME.capitalize} - v#{Markify::VERSION}
+Released under the GNU GENERAL PUBLIC LICENSE Version 3. © Daniel Meißner, 2013
+LICENCE
+
+  SUMMARY =<<SUMMARY
+Mark notify script for the Studierendeninformationssystem (SIS) of the University of Applied Sciences Bonn-Rhein-Sieg.
+SUMMARY
+
+end

data/markify.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = Markify::NAME.downcase
+  spec.version       = Markify::VERSION
+  spec.authors       = ["Daniel Meißner"]
+  spec.email         = ["meise+markify@3st.be"]
+  spec.description   = Markify::DESCRIPTION
+  spec.summary       = Markify::SUMMARY
+  spec.homepage      = "https://github.com/meise/markify"
+  spec.license       = "GPL"
+
+  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency('xmpp4r', '~> 0.5')
+  spec.add_dependency('mechanize', '~> 2.5.1')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency('rspec', '~> 2.11.0')
+  spec.add_development_dependency('simplecov')
+end

data/spec/markify/database_spec.rb

@@ -0,0 +1,87 @@
+# 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 'spec_helper'
+
+describe Markify::Database do
+  before(:each) do
+    File.open(Pathname('/tmp/markify_hashes.txt'), "a+") do |file|
+      file.puts <<HASHES
+# markify hash database
+19189e4668008cd48265538054282379c38bc7422811e4402a7f1e693138a579
+0482652650dc959dbaa199f7f08d60b1184c4329a41152479ecec7835cd2c9c5
+HASHES
+    end
+
+    @database = Markify::Database.new(Pathname('/tmp/markify_hashes.txt'))
+  end
+
+  after(:each) do
+    @database.file_path.delete
+  end
+
+  it "should set default database path" do
+    @database.file_path.should_not eq(nil)
+  end
+
+  it "should set database path" do
+    @database.file_path.should eq(Pathname('/tmp/markify_hashes.txt'))
+  end
+
+  describe "#check_for_new_marks" do
+    it "should return a array with only new marks" do
+      mark1 = Markify::Mark.new('Peter Lustig', '2342', '3.0', 'BE', '2', '23.02.1942')
+      mark2 = Markify::Mark.new('Peter Lustig', '4223', '1.7', 'BE', '3', '23.02.1923')
+      mark3 = Markify::Mark.new('Peter Lustig', '2323', '5.0', 'NB', '1', '24.09.1923')
+
+      @database.check_for_new_marks([mark1, mark2, mark3]).should eq([mark3])
+    end
+  end
+
+  describe "#checksums" do
+    it "should return all checksums in database" do
+      @database.checksums.should eq(['19189e4668008cd48265538054282379c38bc7422811e4402a7f1e693138a579',
+                                     '0482652650dc959dbaa199f7f08d60b1184c4329a41152479ecec7835cd2c9c5'])
+    end
+  end
+
+  describe "#read_checksums" do
+    it "should be protected" do
+      @database.protected_methods.include?(:read_checksum_file).should eq(true)
+    end
+
+    it "should hash file and return array for each line" do
+      @database.send(:read_checksum_file,
+                     *Markify::Database.protected_methods).should eq(['# markify hash database',
+                                                                      '19189e4668008cd48265538054282379c38bc7422811e4402a7f1e693138a579',
+                                                                      '0482652650dc959dbaa199f7f08d60b1184c4329a41152479ecec7835cd2c9c5'])
+    end
+  end
+
+  describe "#create_checksum_file" do
+    it "should be protected" do
+      @database.protected_methods.include?(:create_checksum_file).should eq(true)
+    end
+
+    it "should create new hash database if no exist" do
+      # TODO
+    end
+  end
+end

data/spec/markify/mark_spec.rb

@@ -0,0 +1,68 @@
+# 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 'spec_helper'
+
+describe Markify::Mark do
+  before do
+    @mark = Markify::Mark.new('Peter Lustig', '2342', '3.0', 'BE', '2', '23.02.1942')
+  end
+
+  it "should be a string" do
+    @mark.name.should == "Peter Lustig"
+  end
+
+  it "should be a integer" do
+    @mark.id.should == 2342
+  end
+
+  it "should be a float" do
+    @mark.mark.should == 3.0
+  end
+
+  it "should be a string" do
+    @mark.passed.should == "BE"
+  end
+
+  it "should be a date" do
+    @mark.date.should == Date.strptime("23.02.1942", '%d.%m.%Y')
+  end
+
+  it "should be a integer" do
+    @mark.try.should == 2
+  end
+
+  describe "#to_s" do
+    it "should return a string" do
+      @mark.to_s.is_a?(String).should == true
+    end
+  end
+
+  describe "#to_sha256"  do
+    it "should return sha256 object" do
+      @mark.to_sha256.is_a?(Digest::SHA256).should == true
+    end
+
+    it "should be generate a hash with the right order" do
+      @hash = Digest::SHA256.new << "Peter Lustig2342#{Date.strptime("23.02.1942", '%d.%m.%Y')}3.02BE"
+      @mark.to_sha256.should eq(@hash)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+# 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 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require 'pathname'
+require 'rspec'
+require 'markify'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.color_enabled = true
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: markify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Meißner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '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.
+
+'
+email:
+- meise+markify@3st.be
+executables:
+- markify
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/markify
+- examples/config.yml.example
+- examples/hashes.txt
+- lib/markify.rb
+- lib/markify/bot.rb
+- lib/markify/database.rb
+- lib/markify/mark.rb
+- lib/markify/optparser.rb
+- lib/markify/scraper.rb
+- lib/markify/settings.rb
+- lib/markify/version.rb
+- markify.gemspec
+- spec/markify/database_spec.rb
+- spec/markify/mark_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/meise/markify
+licenses:
+- GPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -198789376526089427
+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.
+test_files:
+- spec/markify/database_spec.rb
+- spec/markify/mark_spec.rb
+- spec/spec_helper.rb