webuntis 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
-# Webuntis
+# WebUntis
 
-TODO: Write a gem description
+This gem makes calls to the [WebUntis][wu] JSON-RPC API.
 
 ## Installation
 
@@ -18,7 +18,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Using it should be quite easy.  For example, to print a list of all active
+teachers, you just do this:
+
+``` ruby
+require "webuntis"
+
+wu = WebUntis.new("demo_inf",  "student", "", server="demo.webuntis.com")
+wu.authorize
+wu.teachers.each do |teacher|
+  puts teacher["longName"] if teacher["active"]
+end
+```
 
 ## Contributing
 
@@ -27,3 +38,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+[wu]: http://www.grupet.at/en/produkte/webuntis/uebersicht_webuntis.php

data/lib/webuntis.rb

@@ -1,7 +1,6 @@
 require "webuntis/version"
 require "httparty"
 require "securerandom"
-require "pp"
 
 class WebUntis
   include HTTParty # http://www.youtube.com/watch?v=6Zbi0XmGtMw
@@ -20,8 +19,7 @@ class WebUntis
   # @param school [String] The school name (e.g. htl-stp)
   # @param user [String] The user name
   # @param password [String] The user's password
-  # @param server [String] The server to use, without +/WebUntis+ (e.g.
-  # demo.webuntis.com).
+  # @param server [String] The server to use, without +/WebUntis+ (e.g. demo.webuntis.com).
   def initialize(school, user, password, server="demo.webuntis.com")
     @school = school
     @user = user
@@ -42,6 +40,112 @@ class WebUntis
   alias authorize authenticate
   alias login authenticate
   
+  # Gets a list of teachers.  Requires Authentication.
+  # @return [Array] Array of hashes.
+  def teachers()
+    require_authentication!
+    options = make_options("getTeachers")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets a list of classes for the school year with ID +schoolyear+.
+  # @param schoolyear [Integer] The ID of the school year, whatever that could be.  Defaults to +nil+ (current schoolyear) 
+  # @return [Array] Array of hashes.
+  def classes(schoolyear=nil)
+    require_authentication!
+    options = make_options("getKlassen", (schoolyear.nil? ? {} : {schoolyear: schoolyear}))
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  alias klassen classes
+  
+  # Gets a list of subjects. 
+  # @return [Array] Array of hashes.
+  def subjects()
+    require_authentication!
+    options = make_options("getSubjects")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets a list of rooms.
+  # @return [Array] Array of hashes.
+  def rooms()
+    require_authentication!
+    options = make_options("getRooms")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets a list of departments.
+  # @return [Array] Array of hashes.
+  def departments()
+    require_authentication!
+    options = make_options("getDepartments")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets a list of holidays.
+  # Dates are stored as an integer in the format yyyymmdd (e.g. 20141026)
+  # @return [Array] Array of hashes.
+  def holidays()
+    require_authentication!
+    options = make_options("getHolidays")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets the timegrid units.
+  # Times are stored as an integer in the format hhmm (e.g. 750, 1030)
+  # @return [Array] Array of hashes.
+  def timegrid()
+    require_authentication!
+    options = make_options("getTimegridUnits")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets information about lesson types, period codes and their colours.
+  # Lession types (lstypes): +ls+: lesson; +oh+: office hour; +sb+: standby;
+  # +bs+: break supervision; +ex+: examination
+  # @return [Array] Array of hashes.
+  def status_data()
+    require_authentication!
+    options = make_options("getStatusData")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets the current school year.
+  # @return [Hash] The current school year object as a hash.
+  def current_schoolyear()
+    require_authentication!
+    options = make_options("getCurrentSchoolyear")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
+  # Gets all available school years.
+  # @return [Array] Array of hashes.
+  def schoolyears()
+    require_authentication!
+    options = make_options("getSchoolyears")
+    response = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    response["result"]
+  end
+  
   # Ends the session.  Requires Authentication.
   def logout()
     require_authentication!

data/lib/webuntis/version.rb

@@ -1,6 +1,6 @@
 class WebUntis
   # The version of this gem.
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   
   # The client name, sent while authenticating.
   CLIENT_NAME = "WebUntis gem v#{VERSION}, https://rubygems.org/gems/webuntis"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webuntis
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -103,18 +103,18 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
 summary: Makes calls to the WebUntis API.