<commit_before># IVLE
#### version 0.0.1 &beta;
Basic Ruby gem wrapper for NUS IVLE LAPI interface. All methods are implemented (but not tested).

* [IVLE LAPI documentation](http://wiki.nus.edu.sg/display/ivlelapi/Home)
* A skeleton gem documentation is available in `doc`.

This gem is in beta and is not guaranteed to work 100%. If you encounter problems, submit an issue (preferably with the bugfix) and I'll get on it.

## Installation

Add this line to your application's Gemfile:

    gem 'ivle'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ivle

## Usage

    ivle = IVLE::API.new('api_key', 'access_token')
    => #<IVLE::API:0x41e5a98 @api_key="api_key", @access_token="access_token">

    # Or, pass in the username and password and retrieve the token via Mechanize

    ivle = IVLE::API.new('api_key', 'username', 'password')
    => #<IVLE::API:0x4112d00 @api_key="api_key", @username="username", @password="password">

    ivle.modules
    => {:Results=>[{:Announcements=>[], :Forums=>[], :Workbins=>[], :Webcasts=>[], ... }
<commit_msg>Update README with doc link.<commit_after># IVLE
#### version 0.0.1 &beta;
Basic Ruby gem wrapper for NUS IVLE LAPI interface. All methods are implemented (but not tested).

* [IVLE LAPI documentation](http://wiki.nus.edu.sg/display/ivlelapi/Home)
* A skeleton gem documentation is available in `doc`, or [here](http://fauxface.github.io/ivle/).

This gem is in beta and is not guaranteed to work 100%. If you encounter problems, submit an issue (preferably with the bugfix) and I'll get on it.

## Installation

Add this line to your application's Gemfile:

    gem 'ivle'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ivle

## Usage

    ivle = IVLE::API.new('api_key', 'access_token')
    => #<IVLE::API:0x41e5a98 @api_key="api_key", @access_token="access_token">

    # Or, pass in the username and password and retrieve the token via Mechanize

    ivle = IVLE::API.new('api_key', 'username', 'password')
    => #<IVLE::API:0x4112d00 @api_key="api_key", @username="username", @password="password">

    ivle.modules
    => {:Results=>[{:Announcements=>[], :Forums=>[], :Workbins=>[], :Webcasts=>[], ... }

{'fraction_non_alphanumeric': 0.14580529385374608, 'fraction_numerical': 0.01704800358905339, 'mean_word_length': 4.259433962264151, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 23, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1709863', 'n_tokens_mistral': 766, 'n_tokens_neox': 723, 'n_words': 236}