Fluminus

Build Status Coverage Status

F LumiNUS! IVLE ftw! Why fix what ain't broken?!

Since IVLE will be deprecated next academic year (AY2019/2020), while LumiNUS has consistently pushed back its schedule to release an API, I have decided to reverse-engineer the API used by the Angular front-end of LumiNUS. Currently, my goal is to be able to automatically download files a la ivle-sync

I try to keep to best coding practices and use as little dependencies as possible. Do let me know if you have any suggestions!

PR's are welcome.

demo

Installation

CLI

  1. Install elixir+erlang for your platform
  2. Clone this repo
  3. Get the dependencies:
mix deps.get
  1. Fluminus CLI is available as a mix task:
mix fluminus

Note that the first time running the mix task might be a bit slow because the code has to be compiled first.

As a dependency

This package can be installed by adding fluminus to your list of dependencies in mix.exs:

def deps do
  [
    {:fluminus, "~> 0.0.1"}
  ]
end

Documentation can be found at https://hexdocs.pm/fluminus.

Roadmap

  • [ ] Write tests, mock with ExVCR