webuntis 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 nilsding
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Webuntis
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webuntis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webuntis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/nilsding/webuntis/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

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

data/lib/webuntis.rb

@@ -0,0 +1,86 @@
+require "webuntis/version"
+require "httparty"
+require "securerandom"
+require "pp"
+
+class WebUntis
+  include HTTParty # http://www.youtube.com/watch?v=6Zbi0XmGtMw
+  format :json
+  base_uri "demo.webuntis.com"
+  
+  attr_accessor :school
+  attr_accessor :user
+  attr_accessor :password
+  
+  attr_reader :session_id
+  attr_reader :person_type
+  attr_reader :person_id
+  attr_reader :class_id
+  
+  # @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).
+  def initialize(school, user, password, server="demo.webuntis.com")
+    @school = school
+    @user = user
+    @password = password
+    self.class.base_uri server
+  end
+  
+  # Authenticates the given user and starts a session.
+  def authenticate()
+    options = make_options("authenticate", {user: @user, password: @password, client: CLIENT_NAME})
+    response = self.class.post("/WebUntis/jsonrpc.do?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    @session_id  = response["result"]["sessionId"]
+    @class_id    = response["result"]["klasseId"]
+    @person_type = response["result"]["personType"]
+    @person_id   = response["result"]["personId"]
+  end
+  alias authorize authenticate
+  alias login authenticate
+  
+  # Ends the session.  Requires Authentication.
+  def logout()
+    require_authentication!
+    options = make_options("logout")
+    response  = self.class.post("/WebUntis/jsonrpc.do;jsessionid=#{@session_id}?school=#{@school}", options)
+    raise response["error"]["message"] unless response["error"].nil?
+    @session_id = nil
+  end
+  
+  private
+    def require_authentication!
+      raise "Please authenticate first!" if @session_id.nil?
+    end
+  
+    # contains options given to HTTParty, including params for webuntis calls
+    # @param method [String] the method that gets called
+    # @param params [Hash] additional params for the method
+    # @return [Hash]
+    def make_options(method, params={})
+      options = base_options
+      options[:body][:params].merge! params
+      options[:body].merge!({ method: method })
+      options[:body] = options[:body].to_json
+      options
+    end
+  
+    # @return [Hash] the base options used for all HTTP POST requests
+    def base_options
+      {
+        body: {
+          id: SecureRandom.hex,
+          params: {},
+          jsonrpc: "2.0"
+        },
+        options: {
+          headers: {
+            "Content-Type" => "application/json",
+          }
+        }
+      }
+    end
+end

data/lib/webuntis/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'webuntis'

data/spec/webuntis_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe WebUntis do
+  it 'has a version number' do
+    expect(WebUntis::VERSION).not_to be nil
+  end
+end

data/webuntis.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webuntis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webuntis"
+  spec.version       = WebUntis::VERSION
+  spec.authors       = ["nilsding"]
+  spec.email         = ["nilsding@nilsding.org"]
+  spec.summary       = %q{Makes calls to the WebUntis API.}
+  spec.description   = %q{This gem makes calls to the WebUntis JSON-RPC API.}
+  spec.homepage      = "https://github.com/nilsding/webuntis"
+  spec.license       = "MIT"
+
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: webuntis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- nilsding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: This gem makes calls to the WebUntis JSON-RPC API.
+email:
+- nilsding@nilsding.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webuntis.rb
+- lib/webuntis/version.rb
+- spec/spec_helper.rb
+- spec/webuntis_spec.rb
+- webuntis.gemspec
+homepage: https://github.com/nilsding/webuntis
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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
+signing_key: 
+specification_version: 3
+summary: Makes calls to the WebUntis API.
+test_files:
+- spec/spec_helper.rb
+- spec/webuntis_spec.rb
+has_rdoc: