IVLE 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/IVLE.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "IVLE/version"
+
+Gem::Specification.new do |s|
+  s.name        = "IVLE"
+  s.version     = IVLE::VERSION
+  s.authors     = ["Ng Guoyou"]
+  s.email       = ["fauxface+github@gmail.com"]
+  s.homepage    = "https://github.com/Fauxface/ivle"
+  s.summary     = %q{Basic Ruby gem wrapper for NUS IVLE LAPI interface.}
+  s.description = %q{Basic Ruby gem wrapper for NUS IVLE LAPI interface. All methods are implemented (but not tested).}
+
+  s.rubyforge_project = "IVLE"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "faraday"
+  s.add_dependency "faraday_middleware"
+  s.add_dependency "mechanize"
+  s.add_dependency "nokogiri"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "debugger"
+  s.add_development_dependency "fakeweb"
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Ng Guoyou
+
+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,61 @@
+# IVLE
+#### version 0.0.1 β
+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=>[], ... }
+
+    ivle.profile_view
+    => {:Results=>[{:UserID=>"My user ID", :Name=>"My Name", ...}
+
+    ivle.module_weblinks '4215f7f9-794d-4045-8d2d-0f8d2db2444f'
+    => {"Results":[{"ID":"4215f7f9-794d-4045-8d2d-0f8d2db2444f","URL":"http://byob.berkeley.edu/", ... }
+
+### API Key
+Log in to IVLE, then access this URL: [http://ivle.nus.edu.sg/LAPI/default.aspx](http://ivle.nus.edu.sg/LAPI/default.aspx)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+### TODO
+* Use proper oAuth authentication
+* More specs
+
+### Tests
+There is a simple RSpec in `spec`.
+
+To run it: `bundle exec rspec spec/api/api_spec.rb`

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/settings.yml

@@ -0,0 +1,2 @@
+:verify_ssl: false
+:faraday_log: false

data/doc/Fixtures.html

@@ -0,0 +1,167 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=IBM437" http-equiv="Content-Type">
+
+<title>module Fixtures - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>spec/fixtures/ivle.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./Gemfile.html">Gemfile</a>
+  
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./IVLE.html">IVLE</a>
+  
+    <li><a href="./IVLE/API.html">IVLE::API</a>
+  
+    <li><a href="./IVLE/Announcement.html">IVLE::Announcement</a>
+  
+    <li><a href="./IVLE/Community.html">IVLE::Community</a>
+  
+    <li><a href="./IVLE/Consultation.html">IVLE::Consultation</a>
+  
+    <li><a href="./IVLE/DeltaDatasets.html">IVLE::DeltaDatasets</a>
+  
+    <li><a href="./IVLE/Forum.html">IVLE::Forum</a>
+  
+    <li><a href="./IVLE/Gradebook.html">IVLE::Gradebook</a>
+  
+    <li><a href="./IVLE/IVLEModule.html">IVLE::IVLEModule</a>
+  
+    <li><a href="./IVLE/IVLENews.html">IVLE::IVLENews</a>
+  
+    <li><a href="./IVLE/LibraryEReserves.html">IVLE::LibraryEReserves</a>
+  
+    <li><a href="./IVLE/Login.html">IVLE::Login</a>
+  
+    <li><a href="./IVLE/MyOrganizer.html">IVLE::MyOrganizer</a>
+  
+    <li><a href="./IVLE/OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
+  
+    <li><a href="./IVLE/Poll.html">IVLE::Poll</a>
+  
+    <li><a href="./IVLE/Profile.html">IVLE::Profile</a>
+  
+    <li><a href="./IVLE/RostersAndGroups.html">IVLE::RostersAndGroups</a>
+  
+    <li><a href="./IVLE/StudentEvents.html">IVLE::StudentEvents</a>
+  
+    <li><a href="./IVLE/Timetable.html">IVLE::Timetable</a>
+  
+    <li><a href="./IVLE/Webcast.html">IVLE::Webcast</a>
+  
+    <li><a href="./IVLE/Workbin.html">IVLE::Workbin</a>
+  
+    <li><a href="./Fixtures.html">Fixtures</a>
+  
+    <li><a href="./Fixtures/IVLE.html">Fixtures::IVLE</a>
+  
+    <li><a href="./Object.html">Object</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module Fixtures</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+

data/doc/Fixtures/IVLE.html

@@ -0,0 +1,213 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=IBM437" http-equiv="Content-Type">
+
+<title>module Fixtures::IVLE - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../index.html">Home</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>spec/fixtures/ivle.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-i-read_fixture">#read_fixture</a>
+    
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="../Gemfile.html">Gemfile</a>
+  
+    <li class="file"><a href="../Rakefile.html">Rakefile</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="../IVLE.html">IVLE</a>
+  
+    <li><a href="../IVLE/API.html">IVLE::API</a>
+  
+    <li><a href="../IVLE/Announcement.html">IVLE::Announcement</a>
+  
+    <li><a href="../IVLE/Community.html">IVLE::Community</a>
+  
+    <li><a href="../IVLE/Consultation.html">IVLE::Consultation</a>
+  
+    <li><a href="../IVLE/DeltaDatasets.html">IVLE::DeltaDatasets</a>
+  
+    <li><a href="../IVLE/Forum.html">IVLE::Forum</a>
+  
+    <li><a href="../IVLE/Gradebook.html">IVLE::Gradebook</a>
+  
+    <li><a href="../IVLE/IVLEModule.html">IVLE::IVLEModule</a>
+  
+    <li><a href="../IVLE/IVLENews.html">IVLE::IVLENews</a>
+  
+    <li><a href="../IVLE/LibraryEReserves.html">IVLE::LibraryEReserves</a>
+  
+    <li><a href="../IVLE/Login.html">IVLE::Login</a>
+  
+    <li><a href="../IVLE/MyOrganizer.html">IVLE::MyOrganizer</a>
+  
+    <li><a href="../IVLE/OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
+  
+    <li><a href="../IVLE/Poll.html">IVLE::Poll</a>
+  
+    <li><a href="../IVLE/Profile.html">IVLE::Profile</a>
+  
+    <li><a href="../IVLE/RostersAndGroups.html">IVLE::RostersAndGroups</a>
+  
+    <li><a href="../IVLE/StudentEvents.html">IVLE::StudentEvents</a>
+  
+    <li><a href="../IVLE/Timetable.html">IVLE::Timetable</a>
+  
+    <li><a href="../IVLE/Webcast.html">IVLE::Webcast</a>
+  
+    <li><a href="../IVLE/Workbin.html">IVLE::Workbin</a>
+  
+    <li><a href="../Fixtures.html">Fixtures</a>
+  
+    <li><a href="../Fixtures/IVLE.html">Fixtures::IVLE</a>
+  
+    <li><a href="../Object.html">Object</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module Fixtures::IVLE</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+
+    
+      <div id="method-i-read_fixture" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">read_fixture</span><span
+            class="method-args">(name)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="read_fixture-source">
+            <pre><span class="ruby-comment"># File spec/fixtures/ivle.rb, line 3</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_fixture</span>(<span class="ruby-identifier">name</span>)
+  <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword">__FILE__</span>) <span class="ruby-operator">+</span> <span class="ruby-node">&quot;/api/#{name}&quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- read_fixture-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- read_fixture-method -->
+
+    
+    </section><!-- public-instance-method-details -->
+  
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+