Ohel Shem API for JVM

Ohel Shem (Hebrew: אהל שם‎) is an Israeli high school located in the city of Ramat Gan. The school has about 1,550 students studying in 45 classes, from ninth to twelfth grade, and about 160 teachers and 40 workers.

Ohel Shem ❤️ OSS

This project is part of 'Ohel Shem OSS', our attempt at providing open standard for modern school.

Maven dependency

Step 1. Add this repository to your build file

repositories {
        maven {
            url "http://dl.bintray.com/ohelshem/maven" 
        }
    }

Step 2. Add the dependency in the form

dependencies {
        compile 'com.ohelshem:api:0.4.3'
    }

Api

Prerequisites

In order to use the API, you should implement few interfaces that the API is based on:

ColorProvider

A change by itself doesn't have a color. Instead, a filter is being applied on the change to set its color.

The API provide a default color provider, with receives a default Color and a mapping between name and a color. It will use Contains with the String.

ApiFactory.defaultColorProvider(defaultColor: Int, filters: List<Pair<Int, String>> | Map<String, Int>, timetableColors: Int[])

For the colors used by the Android application check this

Usage

First, create the provider:

ApiEngine apiEngine = ApiFactory.create(colorProvider)

Second, call the call() method:

apiProvider.call(userId, userPassword, lastUpdateTime, new Api.Callback() {
   @Override
   public void onSuccess(@NotNull Api.Response response) {
       // response.data can be Student class, or Teacher class.
   }

   @Override
   public void onFailure(@NotNull Exception exception) {

   }
});

Android support

In order to use this with Android, you need to add a gradle dependency for fuel-android module.

repositories {
    jcenter()
}

dependencies {
    compile 'com.github.kittinunf.fuel:fuel-android:1.3.1'
}

This library is based on a library called Fuel which need a plugin to work on Android as intended.

Kotlin support

This library was written fully in Kotlin. Kotlin is Statically typed programming language for the JVM, Android and the browser with 100% interoperable with Java™.

License

Copyright 2016 Yoav Sternberg

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.