initial commit

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

Gemfile

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

LICENSE.md

@@ -0,0 +1,161 @@
+## creative commons
+
+# Attribution 4.0 International
+
+Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
+
+### Using Creative Commons Public Licenses
+
+Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
+
+* __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors).
+
+* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees).
+
+## Creative Commons Attribution 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+### Section 1 – Definitions.
+
+a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+
+b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+
+c. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+
+d. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+
+e. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+
+f. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+
+g. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+
+h. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License.
+
+i. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+
+j. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+
+k. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+### Section 2 – Scope.
+
+a. ___License grant.___
+
+    1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+
+        A. reproduce and Share the Licensed Material, in whole or in part; and
+
+        B. produce, reproduce, and Share Adapted Material.
+
+    2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+
+    3. __Term.__ The term of this Public License is specified in Section 6(a).
+
+    4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+
+    5. __Downstream recipients.__
+
+        A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+
+        B. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+
+    6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+b. ___Other rights.___
+
+    1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+
+    2. Patent and trademark rights are not licensed under this Public License.
+
+    3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+### Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+a. ___Attribution.___
+
+    1. If You Share the Licensed Material (including in modified form), You must:
+
+        A. retain the following if it is supplied by the Licensor with the Licensed Material:
+
+            i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+
+            ii. a copyright notice;
+
+            iii. a notice that refers to this Public License;
+
+            iv. a notice that refers to the disclaimer of warranties;
+
+            v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+
+        B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+
+        C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+
+    2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+
+    3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+
+    4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
+
+### Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
+
+b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
+
+c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+### Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__
+
+b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__
+
+c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+### Section 6 – Term and Termination.
+
+a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+
+    1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+
+    2. upon express reinstatement by the Licensor.
+
+    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+
+c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+
+d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+### Section 7 – Other Terms and Conditions.
+
+a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+
+b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+### Section 8 – Interpretation.
+
+*a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+
+b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+
+c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+
+d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
+
+```
+Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
+
+Creative Commons may be contacted at creativecommons.org
+```

README.md

@@ -0,0 +1,137 @@
+# schild
+
+[Schild-NRW](http://www.svws.nrw.de/index.php?id=schildnrw) ist die offizielle Schulverwaltungssoftware in NRW, `schild` ein Ruby-Gem, das als API zwischen der Schild-NRW-Datenbank und eigenen Skripten fungieren kann. `schild` ermöglicht es, direkt und ohne die Schild-Oberfläche auf Daten zuzugreifen und für eigene Zwecke weiterzuverarbeiten, z.B. um eigene Dokumente (Reports/Berichte in Schild-Sprech genannt) zu erstellen.
+
+Mit `schild` kann man eigenen Skripte schreiben und komfortabel auf die Datenbank zugreifen. Lediglich ein paar Kenntnisse in der Programmiersprache Ruby werden erwartet. Mit Hilfe der [Prawn-Bibliothek](http://prawnpdf.org/) lassen sich sehr schöne und v.a. genau beschriebene PDF-Dokumente erstellen, die ganz ohne grafische Oberfläche auskommen und vollständig programmiert werden.
+
+Um `schild` nutzen zu können muss es zuerst installiert werden:
+
+```sh
+gem install schild
+```
+
+Dazu muss ein Datenbankadapter installiert werden. Da in den meisten Fällen MySQL/MariaDB verwendet wird, kann dies so gemacht werden:
+
+```sh
+gem install mysql2
+```
+
+Jetzt kann `schild` in einem Skript aufgerufen werden:
+
+```ruby
+require 'schild'
+```
+Da `schild` eine Datenbankverbindung zur Schild-Datenbank herstellen muss, werden noch ein paar Angaben gebraucht. `schild`verwendet dafür sog. Environment-Variablen. Unter Linux sehen die so aus:
+
+```sh
+export S_USER=schild
+```
+
+Mit Hilfe dieser Environment-Variablen teilen wir `schild` mit, wie es sich mit der Datenbank verbinden soll. Es bietet sich an, eine Konfigurationsdatei zu verwenden:
+
+```yaml
+#./config/env.yml
+local_test:
+    S_ADAPTER: mysql2
+    S_HOST: localhost
+    S_USER: schild
+    S_PASSWORD: schild
+    S_DB: schild-test
+```        
+
+Die angegebenen Variablen müssen angegeben werden, damit `schild` überhaupt eine Verbindung zur Datenbank aufbauen kann. Ob sie mit Hilfe eines weiteren Gems (siehe unten) oder direkt vom System aus festgelegt werden, ist gleich.
+
+Die oben angegebene Datei wird nun verwendet, um auf die `schild-test`-Datenbank zuzugreifen:
+
+```ruby
+require 'envyable'
+Envyable.load('./config/env.yml', 'local_test')
+require 'schild'
+```
+
+Hier ist es wichtig, dass zuerst die Variablen geladen werden und erst im Anschluss daran `schild`, denn `schild` versucht direkt beim ersten Laden die Verbindung zur Datenbank herzustellen.
+        
+Nun sollte noch das `Schild`-Modul geladen werden, das die Verwendung von  `schild` vereinfacht:
+        
+```ruby
+require 'envyable'
+Envyable.load('./config/env.yml', 'local_test')
+require 'schild'
+include Schild
+```
+
+Jetzt können praktisch alle Tabellen abgerufen und Daten ausgelesen werden. Dabei ist das DB-Objekt die Datenbank:
+
+```ruby
+DB[:eigeneschule][SchulNr]
+=> "123456"
+```
+
+Das ist wenig komfortabel, auch wenn es seinen Zweck erfüllt. Schild hat viele Tabellen mit vielen Verbindungen untereinander. `schild` bietet die Möglichkeit diese Abhängigkeiten komfortabel anzusteuern:
+
+```ruby
+Schule.schulnummer
+```
+
+oder:
+
+```ruby
+s = Schueler.where(:Klasse => 'B13B').first
+s.skt_halbjahr.noten.map{ |n| "#{n.fach.Bezeichnung}: #{n.NotenKrz}"}
+ => ["Deutsch/ Kommunikation: 3", "Englisch: 3", "Religionslehre: ", "Mathematik: 4-", "Sport/ Gesundheitsförderung: 2", "Wirtschafts- und Betriebslehre: 3", "Datenverarbeitung: ", "Fachpraxis Textil/ Bekleidung: 2", "Gestaltungslehre: 3", "Politik/ Gesellschaftslehre: 2", "Technologie Bekleidung: 5", "Technisches Zeichnen Bekleidung: 4"] 
+```
+
+In diesem Beispiel wurde der erste Schüler der klasse B13B aus dem Datensatz `Schueler` gewählt und Daten aus verschiedenen Tabellen abgerufen:
+
+* Das aktuelle Halbjahr aus Abschnitte
+* Die Notenliste aus Noten
+* Die Fachbezeichnung aus Faecher
+
+`schild` vereinfacht an dieser Stelle einige Probleme von Schild. So sind z.B. Daten zur Schule unter `Schule` erreichbar, während die Tabelle unter Schild direkt nur über DB[:eigeneschule] anzusteuern wäre. Da viele Namen im Schema der Schild-Datenbank uneinheitlich sind, versucht `schild` soweit es geht, eine einheitliche Form zu verwenden. 
+
+Alle zur Verfügung stehenden Hilfsmethoden werden in den API-Docs erläutert.
+
+Ziel von `schild` ist es, möglichst viele Daten aus der Datenbank komfortabel zur Verfügung zu stellen.
+
+## Das sollte beachtet werden
+`schild` läuft nur unter Ruby. Es ist wahrscheinlich möglich auch über JRuby andere Sprachen zu verwenden, die auf der JVM laufen. Also Java zum Beispiel. Gleiches gilt für Python. Leider nicht getestet.
+
+Die Schild-Datenbank muss einigermaßen aktuell sein, ältere Datenbanken haben offensichtlich noch Großbuchstaben in den Tabellennamen verwendet. Das bereitet `schild` Schwierigkeiten. Bei neueren Versionen von Schild (2015) werden Kleinbuchstaben verwendet.
+
+Es kann nicht garantiert werden, dass `schild` mit jeder Version von Schild funktioniert. `schild` hat keinerlei Einfluß auf die Entwicklung von Schild und kann bei jeder Änderung am Schema der Datenbank zu fehlerhaftem Verhalten veranlasst werden.
+
+`schild` verändert keine Daten an der Schild-Datenbank. Es ist aber möglich, dass mit Hilfe von `schild` auf Daten zugegriffen und verändert wird. `schild` verwendet zum Ansteuern der Datenbank `sequel`, ein weiterer Gem zum komfortablen Bearbeiten von relationalen Datenbanken. Um sicherzugehen, dass keine Schreibzugriffe auf die Schild-Datenbank vorgenommen werden, muss der Datenbankbenutzer auf Lesezugriff beschränkt werden.
+
+## Tests
+`schild` verwendet Tests, um sicherzustellen, dass alle Funktionen über den gesamten Entwicklungsprozess reibungslos funktionieren. Dazu wird die Testdatenbank verwendet, die von der ribeka GmbH auf ihrer Dropbox zur Verfügung gestellt wurde. Leider ist dies eine ältere Version, die an die neue Schild-Version angepasst werden musste. Die neue Version steht als [Download](https://www.dropbox.com/s/tyswqh1burf4ijo/schild-test.sql.gz?dl=0) zur Verfügung und kann in MySQL importiert werden.
+
+Zum Ausführen der Tests reicht es nicht, `schild` als Gem zu installieren, es muss als vollständiger Klon in ein Arbeitsverzeichnis kopiert werden. Dazu wird im Besten Fall git verwendet:
+
+```sh
+git clone git@github.com:hmt/schild.git
+cd schild
+```
+
+Um die Tests bei installierter Datenbank durchführen zu können müssen die nötigen Abhängigkeiten installiert sein. Dies wird über `bundler` organisiert:
+
+```sh
+bundle install
+```
+
+Die Tests können nun mit `rake` gestartet werden:
+
+```sh
+rake
+```
+
+## Mitmachen
+Hilfe bei der Mitarbeit von `schild` wird gerne angenommen. Bitte Pull Requests und Issues bei Github nutzen. Alle Änderungen sollten mit Tests eingereicht werden.
+
+## Lizenz
+[![Creative Commons Lizenzvertrag](https://i.creativecommons.org/l/by/4.0/88x31.png)]("http://creativecommons.org/licenses/by/4.0/")
+[schild](https://github.com/hmt/schild) von [HMT](https://github.com/hmt) ist lizenziert unter einer [Creative Commons Namensnennung 4.0 International Lizenz](http://creativecommons.org/licenses/by/4.0/).
+
+
+
+
+

Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['specs/*_spec.rb']
+  t.verbose = false
+end
+

config/env.yml

@@ -0,0 +1,7 @@
+local_test:
+  S_ADAPTER: mysql2
+  S_HOST: localhost
+  S_USER: schild
+  S_PASSWORD: schild
+  S_DB: schild-test
+

lib/schild.rb

@@ -0,0 +1,176 @@
+require "schild/version"
+require 'sequel'
+
+# Das Schild Modul, das alle Klassen für die Datenbankanbindung bereitstellt
+module Schild
+
+  # ist die Datenbank-Verbindung. Alle Daten können über diese Konstante abgerufen werden
+  DB = Sequel.connect(:adapter=>ENV['S_ADAPTER'], :host=>ENV['S_HOST'], :user=>ENV['S_USER'], :password=>ENV['S_PASSWORD'], :database=>ENV['S_DB'])
+
+  # Stellt eine Verbindung zu einem Schild-Server her. Sollte nur aufgerufen werden, wenn wechselnde Verbindungen nötig sind.
+  def self.connect
+    Sequel.connect(:adapter=>ENV['S_ADAPTER'], :host=>ENV['S_HOST'], :user=>ENV['S_USER'], :password=>ENV['S_PASSWORD'], :database=>ENV['S_DB'])
+  end
+
+  # Stellt die Schüler-Tabelle samt Assoziationen bereit.
+  class Schueler < Sequel::Model(:schueler)
+    many_to_one :fachklasse, :class => :Fachklasse, :key => :Fachklasse_ID
+    one_to_many :abschnitte, :class => :Abschnitt
+
+    # gibt das z.Zt. aktuelle Halbjahr zurück.
+    def akt_halbjahr
+      abschnitte.last
+    end
+
+    # gibt das erste Halbjahr von +jahr+ zurück.
+    def erstes_halbjahr(jahr)
+      halbjahr(jahr, 1)
+    end
+
+    # gibt das zweite Halbjahr von +jahr+ zurück.
+    def zweites_halbjahr(jahr)
+      halbjahr(jahr, 2)
+    end
+
+    # gibt aus +jahr+ das Halbjahr +1+ oder +2+ zurück.
+    def halbjahr(jahr, abschnitt)
+      abschnitte_dataset.where(:jahr => jahr, :abschnitt => abschnitt).first
+    end
+
+    # gibt +Herr+ oder +Frau+ als Anrede für Schüler zurück.
+    def anrede
+      if self.Geschlecht == 3
+        return "Herr"
+      elsif self.Geschlecht == 4
+        return "Frau"
+      end
+    end
+
+    # gibt +true+ zurück, wenn Schüler volljährig.
+    def volljaehrig?
+      self.Volljaehrig == "+"
+    end
+
+    # gibt das aktuelle Schuljahr als String im Format "2014/15" zurück.
+    def schuljahr
+      jahr = self.AktSchuljahr
+      "#{jahr}/#{jahr-1999}"
+    end
+  end
+
+  # Dient als Assoziation für Schüler und deren Klassenbezeichnung etc.
+  class Fachklasse < Sequel::Model(:eigeneschule_fachklassen)
+    one_to_one :schueler
+  end
+
+  # Assoziation für Lehrer, hauptsächlich für Klassenlehrer
+  class Klassenlehrer < Sequel::Model(:k_lehrer)
+    one_to_one :abschnitt, :primary_key=>:Kuerzel, :key=>:KlassenLehrer
+  end
+
+  # Ist die Assoziation, die Halbjahre, sog. Abschnitte zurückgibt.
+  class Abschnitt < Sequel::Model(:schuelerlernabschnittsdaten)
+    many_to_one :schueler, :class => :Schueler, :key => :Schueler_ID
+    one_to_many :noten, :class => :Noten
+    many_to_one :klassenlehrer, :class => :Klassenlehrer, :primary_key=>:Kuerzel, :key=>:KlassenLehrer
+
+    dataset_module do
+      # filtert den Datensatz nach Jahr
+      def jahr(i)
+        where(:Jahr => i)
+      end
+
+      # filtert den Datensatz nach Halbjahr
+      def halbjahr(i,j)
+        jahr(i).where(:Abschnitt => j)
+      end
+
+      # filtert und gibt den Datensatz als Abschnitt des aktuellen Halbjahrs zurück
+      def akt_halbjahr
+        halbjahr(Time.new.year-1, 1).first
+      end
+    end
+
+    # wählt alle berufsbezogenen Fächer des gewählten Schülers in angegeben Halbjahr.
+    def berufsbezogen
+      noten.select{ |n| n.fach.Fachgruppe_ID == 20 && !n.NotenKrz.nil? }
+    end
+
+    # wählt alle berufsübergreifenden Fächer des gewählten Schülers in angegeben Halbjahr.
+    def berufsuebergreifend
+      noten.select{ |n| n.fach.Fachgruppe_ID == 10 && !n.NotenKrz.nil? }
+    end
+
+    # wählt alle Fächer des Differenzierungsbreichs des gewählten Schülers in angegeben Halbjahr.
+    def differenzierungsbereich
+      noten.select{ |n| n.fach.Fachgruppe_ID == 30 && !n.NotenKrz.nil? }
+    end
+
+    # wählt alle Fächergruppen aus.
+    def faechergruppen
+      [berufsuebergreifend, berufsbezogen, differenzierungsbereich]
+    end
+
+    # gibt den Namen des Klassenlehrers mit gekürztem Vornamen.
+    def v_name_klassenlehrer
+      v = klassenlehrer.Vorname
+      n = klassenlehrer.Nachname
+      "#{v[0]}. #{n}"
+    end
+
+    # gibt "Klassenlehrer" entsprechend Geschlecht zurück
+    def klassenlehrer_in
+      klassenlehrer.Geschlecht == "3" ? "Klassenlehrer" : "Klassenlehrerin"
+    end
+  end
+
+  # Assoziation für Noten
+  class Noten < Sequel::Model(:schuelerleistungsdaten)
+    many_to_one :abschnitt, :class => :Abschnitt, :key => :Abschnitt_ID
+    many_to_one :fach, :class => :Faecher, :key => :Fach_ID
+
+    # Notenbezeichnung als String
+    def note
+      case self.NotenKrz
+      when "1"
+        "sehr gut"
+      when "2"
+        "gut"
+      when "3"
+        "befriedigend"
+      when "4"
+        "ausreichend"
+      when "5"
+        "mangelhaft"
+      when "6"
+        "ungenügend"
+      when 'NB'
+        "----------"
+      end
+    end
+
+    # Bezeichnung des Fachs
+    def bezeichnung
+      fach.Bezeichnung
+    end
+
+    # Die Fachgruppen ID des Fachs
+    def fachgruppe_ID
+      fach.Fachgruppe_ID
+    end
+  end
+
+  # Assoziation für Fächer
+  class Faecher < Sequel::Model(:eigeneschule_faecher)
+    one_to_one :noten
+  end
+
+  # Schul-Tabelle mit vereinfachtem Zugriff auf Datenfelder.
+  class Schule < Sequel::Model(:eigeneschule)
+    # gibt die Schulnummer zurück
+    def self.schulnummer
+      self.first.SchulNr
+    end
+  end
+end
+

lib/schild/version.rb

@@ -0,0 +1,3 @@
+module Schild
+  VERSION = "0.1.0"
+end

schild.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schild/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schild"
+  spec.version       = Schild::VERSION
+  spec.authors       = ["HMT"]
+  spec.email         = ["dev@hmt.im"]
+  spec.summary       = %q{Schild-API}
+  spec.description   = %q{schild bietet eine Ruby-Schnittstelle zu SchilD-NRW-Datenbanken.}
+  spec.homepage      = "https://github.com/hmt/schild"
+  spec.license       = "Creative Commons Namensnennung 4.0 International Lizenz."
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "minitest-rg", "~> 5"
+  spec.add_development_dependency "mysql2", "~> 0"
+  spec.add_development_dependency "envyable", "~> 0"
+
+  spec.add_runtime_dependency "sequel", "~> 4"
+end

specs/schueler_spec.rb

@@ -0,0 +1,107 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe Schueler do
+  before do
+    # lade einen Standardschueler
+    @sm = Schueler.where(:Status => 2, :Geloescht => "-", :Gesperrt => "-").first
+  end
+
+  describe 'Models funktionieren erwartungsgemäß und geben einen Wert aus der Tabelle zurück' do
+    it 'Model gibt Vornamen zurück' do
+      @sm.Vorname.must_equal "Tanja"
+    end
+  end
+
+  describe 'Associations funktionieren Erwartungsgemäß' do
+    it 'geben Fachklassenbezeichnung zurück (eigeneschule_fachklassen:Fachklassen)' do
+      @sm.fachklasse.Bezeichnung.must_equal "Friseur"
+    end
+
+    it 'geben Noten aus dem angegebenen Halbjahr und Jahr zurück (via Lernabschnitte und Leistungen)' do
+      @sm.erstes_halbjahr(2013).noten.first.ID.must_equal 163701
+    end
+
+    it 'gibt Konferenzdatum zurück (Lernabschnitte)' do
+      skip
+      # offenbar keine in der Testdatenbank eingetragen
+      @sm.erstes_halbjahr(2013)[:Konferenzdatum].must_be_instance_of Date
+    end
+
+    it 'gibt berufsbezogene Fächer aus den angegebenen Lernabschnitten zurück' do
+      @sm.zweites_halbjahr(2013).berufsbezogen.map{|n|n.fach.FachKrz}.must_include 'FF'
+    end
+
+    it 'gibt berufsübergreifende Fächer aus den angegebenen Lernabschnitten zurück' do
+      @sm.zweites_halbjahr(2013).berufsuebergreifend.map{|n|n.fach.FachKrz}.must_include 'D'
+    end
+
+    it 'gibt Fächer aus dem Differenzierungsbereich zurück über angegebenen Lernabschnitt' do
+      skip
+      @sm.erstes_halbjahr(2014).differenzierungsbereich.map{|n|n.fach.FachKrz}.must_include 'FF'
+    end
+
+    it 'gibt Fächer aus allen Fächergruppen zurück' do
+      fg = @sm.zweites_halbjahr(2013).faechergruppen.flatten.count
+      fg.must_equal (@sm.zweites_halbjahr(2013).noten.select{|n|!n.NotenKrz.nil?}).count
+    end
+  end
+
+  describe 'gibt die korrekte Anzahl von Schülern über Klasse zurück' do
+    it 'returns a group of people eg Klasse xy' do
+      Schueler.where(:Klasse => 'FOS2').count.must_equal 124
+    end
+  end
+
+  describe 'Methoden funktionieren erwartungsgemäß' do
+    it 'returns the correct salutation' do
+      @sm.anrede.must_equal "Frau"
+    end
+
+    it 'gibt an, ob ein Schüler volljährig ist' do
+      @sm.volljaehrig?.must_equal true
+    end
+
+    it 'gibt ein zusammengesetztes Datum des Schuljahres zurück' do
+      @sm.schuljahr.must_equal "2014/15"
+    end
+
+    it 'gibt die Textbezeichnung für eine Note zurück' do
+      @sm.zweites_halbjahr(2013).noten[5].note.must_equal "gut"
+    end
+
+    it 'gibt die volle Fachbezeichnung zurück' do
+      @sm.zweites_halbjahr(2013).noten[5].bezeichnung.must_equal "Farb- und Formveränderung"
+    end
+
+    it 'gibt die korrekte Fachgruppen_ID zurück' do
+      @sm.zweites_halbjahr(2013).noten[5].fachgruppe_ID.must_equal 20
+    end
+
+    it 'gibt den Namen des Klassenlehrers zurück' do
+      @sm.zweites_halbjahr(2013).v_name_klassenlehrer.must_equal "P. Ronnewinkel"
+    end
+
+    it 'gibt an, ob Klassenlehrer/in' do
+      @sm.zweites_halbjahr(2013).klassenlehrer_in.must_equal "Klassenlehrer"
+    end
+
+    it 'gibt das zweite Halbjahr zurück' do
+      @sm.zweites_halbjahr(2013).Abschnitt.must_equal 2
+      @sm.zweites_halbjahr(2013).Jahr.must_equal 2013
+    end
+
+    it 'gibt das erste Halbjahr zurück' do
+      @sm.erstes_halbjahr(2014).Abschnitt.must_equal 1
+      @sm.erstes_halbjahr(2014).Jahr.must_equal 2014
+    end
+
+    it 'gibt das aktuelle Halbjahr zurück' do
+      @sm.akt_halbjahr.Jahr.must_equal 2014
+      @sm.akt_halbjahr.Abschnitt.must_equal 1
+    end
+
+    it 'wählt das angegebene Jahr und Halbjahr aus' do
+      @sm.halbjahr(2013, 2).ID.must_equal 14478
+    end
+  end
+end

specs/schule_spec.rb

@@ -0,0 +1,10 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe Schule do
+  describe 'methods' do
+    it 'gibt die Schulnummer zurück' do
+      Schule.schulnummer.must_be_instance_of String
+    end
+  end
+end
+

specs/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'sequel'
+require 'minitest/autorun'
+require 'minitest/rg'
+require 'envyable'
+Envyable.load('./config/env.yml', 'local_test')
+
+require 'schild'
+include Schild