IVLE 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +4 -0
- data/Gemfile +4 -0
- data/IVLE.gemspec +29 -0
- data/LICENSE +7 -0
- data/README.md +61 -0
- data/Rakefile +1 -0
- data/config/settings.yml +2 -0
- data/doc/Fixtures.html +167 -0
- data/doc/Fixtures/IVLE.html +213 -0
- data/doc/Gemfile.html +133 -0
- data/doc/IVLE.html +278 -0
- data/doc/IVLE/API.html +424 -0
- data/doc/IVLE/Announcement.html +309 -0
- data/doc/IVLE/Community.html +1305 -0
- data/doc/IVLE/Consultation.html +342 -0
- data/doc/IVLE/DeltaDatasets.html +213 -0
- data/doc/IVLE/Forum.html +533 -0
- data/doc/IVLE/Gradebook.html +213 -0
- data/doc/IVLE/IVLEModule.html +567 -0
- data/doc/IVLE/IVLENews.html +213 -0
- data/doc/IVLE/LibraryEReserves.html +245 -0
- data/doc/IVLE/Login.html +309 -0
- data/doc/IVLE/MyOrganizer.html +520 -0
- data/doc/IVLE/OpenWebcastLectures.html +247 -0
- data/doc/IVLE/Poll.html +309 -0
- data/doc/IVLE/Profile.html +213 -0
- data/doc/IVLE/RostersAndGroups.html +676 -0
- data/doc/IVLE/StudentEvents.html +378 -0
- data/doc/IVLE/Timetable.html +309 -0
- data/doc/IVLE/Webcast.html +247 -0
- data/doc/IVLE/Workbin.html +245 -0
- data/doc/Object.html +185 -0
- data/doc/Rakefile.html +131 -0
- data/doc/created.rid +26 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +126 -0
- data/doc/js/darkfish.js +155 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/table_of_contents.html +379 -0
- data/lib/IVLE.rb +133 -0
- data/lib/IVLE/api/announcement.rb +19 -0
- data/lib/IVLE/api/community.rb +174 -0
- data/lib/IVLE/api/consultation.rb +24 -0
- data/lib/IVLE/api/delta_datasets.rb +7 -0
- data/lib/IVLE/api/forum.rb +47 -0
- data/lib/IVLE/api/gradebook.rb +7 -0
- data/lib/IVLE/api/ivle_news.rb +7 -0
- data/lib/IVLE/api/library_ereserves.rb +11 -0
- data/lib/IVLE/api/login.rb +19 -0
- data/lib/IVLE/api/module.rb +53 -0
- data/lib/IVLE/api/my_organizer.rb +62 -0
- data/lib/IVLE/api/open_webcast_lectures.rb +13 -0
- data/lib/IVLE/api/poll.rb +19 -0
- data/lib/IVLE/api/profile.rb +7 -0
- data/lib/IVLE/api/rosters_and_groups.rb +78 -0
- data/lib/IVLE/api/student_events.rb +32 -0
- data/lib/IVLE/api/timetable.rb +19 -0
- data/lib/IVLE/api/webcast.rb +13 -0
- data/lib/IVLE/api/workbin.rb +11 -0
- data/lib/IVLE/version.rb +3 -0
- data/spec/api/api_spec.rb +34 -0
- data/spec/fixtures/api/login.html +11 -0
- data/spec/fixtures/api/modules.json +201 -0
- data/spec/fixtures/ivle.rb +7 -0
- data/spec/fixtures/modules.json +201 -0
- metadata +216 -0
data/doc/Gemfile.html
ADDED
@@ -0,0 +1,133 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=IBM437" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>Gemfile - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body class="file">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="project-metadata">
|
47
|
+
<nav id="fileindex-section" class="section project-section">
|
48
|
+
<h3 class="section-header">Pages</h3>
|
49
|
+
|
50
|
+
<ul>
|
51
|
+
|
52
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
53
|
+
|
54
|
+
<li class="file"><a href="./Rakefile.html">Rakefile</a>
|
55
|
+
|
56
|
+
</ul>
|
57
|
+
</nav>
|
58
|
+
|
59
|
+
<nav id="classindex-section" class="section project-section">
|
60
|
+
<h3 class="section-header">Class and Module Index</h3>
|
61
|
+
|
62
|
+
<ul class="link-list">
|
63
|
+
|
64
|
+
<li><a href="./IVLE.html">IVLE</a>
|
65
|
+
|
66
|
+
<li><a href="./IVLE/API.html">IVLE::API</a>
|
67
|
+
|
68
|
+
<li><a href="./IVLE/Announcement.html">IVLE::Announcement</a>
|
69
|
+
|
70
|
+
<li><a href="./IVLE/Community.html">IVLE::Community</a>
|
71
|
+
|
72
|
+
<li><a href="./IVLE/Consultation.html">IVLE::Consultation</a>
|
73
|
+
|
74
|
+
<li><a href="./IVLE/DeltaDatasets.html">IVLE::DeltaDatasets</a>
|
75
|
+
|
76
|
+
<li><a href="./IVLE/Forum.html">IVLE::Forum</a>
|
77
|
+
|
78
|
+
<li><a href="./IVLE/Gradebook.html">IVLE::Gradebook</a>
|
79
|
+
|
80
|
+
<li><a href="./IVLE/IVLEModule.html">IVLE::IVLEModule</a>
|
81
|
+
|
82
|
+
<li><a href="./IVLE/IVLENews.html">IVLE::IVLENews</a>
|
83
|
+
|
84
|
+
<li><a href="./IVLE/LibraryEReserves.html">IVLE::LibraryEReserves</a>
|
85
|
+
|
86
|
+
<li><a href="./IVLE/Login.html">IVLE::Login</a>
|
87
|
+
|
88
|
+
<li><a href="./IVLE/MyOrganizer.html">IVLE::MyOrganizer</a>
|
89
|
+
|
90
|
+
<li><a href="./IVLE/OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
|
91
|
+
|
92
|
+
<li><a href="./IVLE/Poll.html">IVLE::Poll</a>
|
93
|
+
|
94
|
+
<li><a href="./IVLE/Profile.html">IVLE::Profile</a>
|
95
|
+
|
96
|
+
<li><a href="./IVLE/RostersAndGroups.html">IVLE::RostersAndGroups</a>
|
97
|
+
|
98
|
+
<li><a href="./IVLE/StudentEvents.html">IVLE::StudentEvents</a>
|
99
|
+
|
100
|
+
<li><a href="./IVLE/Timetable.html">IVLE::Timetable</a>
|
101
|
+
|
102
|
+
<li><a href="./IVLE/Webcast.html">IVLE::Webcast</a>
|
103
|
+
|
104
|
+
<li><a href="./IVLE/Workbin.html">IVLE::Workbin</a>
|
105
|
+
|
106
|
+
<li><a href="./Fixtures.html">Fixtures</a>
|
107
|
+
|
108
|
+
<li><a href="./Fixtures/IVLE.html">Fixtures::IVLE</a>
|
109
|
+
|
110
|
+
<li><a href="./Object.html">Object</a>
|
111
|
+
|
112
|
+
</ul>
|
113
|
+
</nav>
|
114
|
+
|
115
|
+
</div>
|
116
|
+
</nav>
|
117
|
+
|
118
|
+
<div id="documentation" class="description">
|
119
|
+
|
120
|
+
<p>source "<a href="http://rubygems.org">rubygems.org</a>"</p>
|
121
|
+
|
122
|
+
<p># Specify your gem's dependencies in IVLE.gemspec gemspec</p>
|
123
|
+
|
124
|
+
</div>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
<footer id="validator-badges">
|
129
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
130
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
|
131
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
132
|
+
</footer>
|
133
|
+
|
data/doc/IVLE.html
ADDED
@@ -0,0 +1,278 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=IBM437" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>module IVLE - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="module">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>lib/IVLE/api/announcement.rb
|
51
|
+
<li>lib/IVLE/api/community.rb
|
52
|
+
<li>lib/IVLE/api/consultation.rb
|
53
|
+
<li>lib/IVLE/api/delta_datasets.rb
|
54
|
+
<li>lib/IVLE/api/forum.rb
|
55
|
+
<li>lib/IVLE/api/gradebook.rb
|
56
|
+
<li>lib/IVLE/api/ivle_news.rb
|
57
|
+
<li>lib/IVLE/api/library_ereserves.rb
|
58
|
+
<li>lib/IVLE/api/login.rb
|
59
|
+
<li>lib/IVLE/api/module.rb
|
60
|
+
<li>lib/IVLE/api/my_organizer.rb
|
61
|
+
<li>lib/IVLE/api/open_webcast_lectures.rb
|
62
|
+
<li>lib/IVLE/api/poll.rb
|
63
|
+
<li>lib/IVLE/api/profile.rb
|
64
|
+
<li>lib/IVLE/api/rosters_and_groups.rb
|
65
|
+
<li>lib/IVLE/api/student_events.rb
|
66
|
+
<li>lib/IVLE/api/timetable.rb
|
67
|
+
<li>lib/IVLE/api/webcast.rb
|
68
|
+
<li>lib/IVLE/api/workbin.rb
|
69
|
+
<li>lib/IVLE/version.rb
|
70
|
+
<li>lib/IVLE.rb
|
71
|
+
</ul>
|
72
|
+
</nav>
|
73
|
+
|
74
|
+
|
75
|
+
</div>
|
76
|
+
|
77
|
+
<div id="class-metadata">
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
<!-- Method Quickref -->
|
82
|
+
<nav id="method-list-section" class="section">
|
83
|
+
<h3 class="section-header">Methods</h3>
|
84
|
+
|
85
|
+
<ul class="link-list">
|
86
|
+
|
87
|
+
<li><a href="#method-c-root">::root</a>
|
88
|
+
|
89
|
+
<li><a href="#method-c-settings">::settings</a>
|
90
|
+
|
91
|
+
</ul>
|
92
|
+
</nav>
|
93
|
+
|
94
|
+
</div>
|
95
|
+
|
96
|
+
<div id="project-metadata">
|
97
|
+
<nav id="fileindex-section" class="section project-section">
|
98
|
+
<h3 class="section-header">Pages</h3>
|
99
|
+
|
100
|
+
<ul>
|
101
|
+
|
102
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
103
|
+
|
104
|
+
<li class="file"><a href="./Rakefile.html">Rakefile</a>
|
105
|
+
|
106
|
+
</ul>
|
107
|
+
</nav>
|
108
|
+
|
109
|
+
<nav id="classindex-section" class="section project-section">
|
110
|
+
<h3 class="section-header">Class and Module Index</h3>
|
111
|
+
|
112
|
+
<ul class="link-list">
|
113
|
+
|
114
|
+
<li><a href="./IVLE.html">IVLE</a>
|
115
|
+
|
116
|
+
<li><a href="./IVLE/API.html">IVLE::API</a>
|
117
|
+
|
118
|
+
<li><a href="./IVLE/Announcement.html">IVLE::Announcement</a>
|
119
|
+
|
120
|
+
<li><a href="./IVLE/Community.html">IVLE::Community</a>
|
121
|
+
|
122
|
+
<li><a href="./IVLE/Consultation.html">IVLE::Consultation</a>
|
123
|
+
|
124
|
+
<li><a href="./IVLE/DeltaDatasets.html">IVLE::DeltaDatasets</a>
|
125
|
+
|
126
|
+
<li><a href="./IVLE/Forum.html">IVLE::Forum</a>
|
127
|
+
|
128
|
+
<li><a href="./IVLE/Gradebook.html">IVLE::Gradebook</a>
|
129
|
+
|
130
|
+
<li><a href="./IVLE/IVLEModule.html">IVLE::IVLEModule</a>
|
131
|
+
|
132
|
+
<li><a href="./IVLE/IVLENews.html">IVLE::IVLENews</a>
|
133
|
+
|
134
|
+
<li><a href="./IVLE/LibraryEReserves.html">IVLE::LibraryEReserves</a>
|
135
|
+
|
136
|
+
<li><a href="./IVLE/Login.html">IVLE::Login</a>
|
137
|
+
|
138
|
+
<li><a href="./IVLE/MyOrganizer.html">IVLE::MyOrganizer</a>
|
139
|
+
|
140
|
+
<li><a href="./IVLE/OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
|
141
|
+
|
142
|
+
<li><a href="./IVLE/Poll.html">IVLE::Poll</a>
|
143
|
+
|
144
|
+
<li><a href="./IVLE/Profile.html">IVLE::Profile</a>
|
145
|
+
|
146
|
+
<li><a href="./IVLE/RostersAndGroups.html">IVLE::RostersAndGroups</a>
|
147
|
+
|
148
|
+
<li><a href="./IVLE/StudentEvents.html">IVLE::StudentEvents</a>
|
149
|
+
|
150
|
+
<li><a href="./IVLE/Timetable.html">IVLE::Timetable</a>
|
151
|
+
|
152
|
+
<li><a href="./IVLE/Webcast.html">IVLE::Webcast</a>
|
153
|
+
|
154
|
+
<li><a href="./IVLE/Workbin.html">IVLE::Workbin</a>
|
155
|
+
|
156
|
+
<li><a href="./Fixtures.html">Fixtures</a>
|
157
|
+
|
158
|
+
<li><a href="./Fixtures/IVLE.html">Fixtures::IVLE</a>
|
159
|
+
|
160
|
+
<li><a href="./Object.html">Object</a>
|
161
|
+
|
162
|
+
</ul>
|
163
|
+
</nav>
|
164
|
+
|
165
|
+
</div>
|
166
|
+
</nav>
|
167
|
+
|
168
|
+
<div id="documentation">
|
169
|
+
<h1 class="module">module IVLE</h1>
|
170
|
+
|
171
|
+
<div id="description" class="description">
|
172
|
+
|
173
|
+
</div><!-- description -->
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
<!-- Constants -->
|
185
|
+
<section id="constants-list" class="section">
|
186
|
+
<h3 class="section-header">Constants</h3>
|
187
|
+
<dl>
|
188
|
+
|
189
|
+
<dt id="VERSION">VERSION
|
190
|
+
|
191
|
+
<dd class="description">
|
192
|
+
|
193
|
+
|
194
|
+
</dl>
|
195
|
+
</section>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
<!-- Methods -->
|
201
|
+
|
202
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
203
|
+
<h3 class="section-header">Public Class Methods</h3>
|
204
|
+
|
205
|
+
|
206
|
+
<div id="method-c-root" class="method-detail ">
|
207
|
+
|
208
|
+
<div class="method-heading">
|
209
|
+
<span class="method-name">root</span><span
|
210
|
+
class="method-args">()</span>
|
211
|
+
<span class="method-click-advice">click to toggle source</span>
|
212
|
+
</div>
|
213
|
+
|
214
|
+
|
215
|
+
<div class="method-description">
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<div class="method-source-code" id="root-source">
|
222
|
+
<pre><span class="ruby-comment"># File lib/IVLE.rb, line 29</span>
|
223
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">root</span>
|
224
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span> <span class="ruby-string">'../..'</span>, <span class="ruby-keyword">__FILE__</span>
|
225
|
+
<span class="ruby-keyword">end</span></pre>
|
226
|
+
</div><!-- root-source -->
|
227
|
+
|
228
|
+
</div>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
</div><!-- root-method -->
|
234
|
+
|
235
|
+
|
236
|
+
<div id="method-c-settings" class="method-detail ">
|
237
|
+
|
238
|
+
<div class="method-heading">
|
239
|
+
<span class="method-name">settings</span><span
|
240
|
+
class="method-args">()</span>
|
241
|
+
<span class="method-click-advice">click to toggle source</span>
|
242
|
+
</div>
|
243
|
+
|
244
|
+
|
245
|
+
<div class="method-description">
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
<div class="method-source-code" id="settings-source">
|
252
|
+
<pre><span class="ruby-comment"># File lib/IVLE.rb, line 33</span>
|
253
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">settings</span>
|
254
|
+
<span class="ruby-identifier">@@settings</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">root</span>, <span class="ruby-string">'config'</span>, <span class="ruby-string">'settings.yml'</span>)))
|
255
|
+
<span class="ruby-keyword">end</span></pre>
|
256
|
+
</div><!-- settings-source -->
|
257
|
+
|
258
|
+
</div>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</div><!-- settings-method -->
|
264
|
+
|
265
|
+
|
266
|
+
</section><!-- public-class-method-details -->
|
267
|
+
|
268
|
+
</section><!-- 5Buntitled-5D -->
|
269
|
+
|
270
|
+
</div><!-- documentation -->
|
271
|
+
|
272
|
+
|
273
|
+
<footer id="validator-badges">
|
274
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
275
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
|
276
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
277
|
+
</footer>
|
278
|
+
|
data/doc/IVLE/API.html
ADDED
@@ -0,0 +1,424 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=IBM437" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class IVLE::API - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "../";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="../index.html">Home</a>
|
28
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>lib/IVLE.rb
|
51
|
+
</ul>
|
52
|
+
</nav>
|
53
|
+
|
54
|
+
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<div id="class-metadata">
|
58
|
+
|
59
|
+
<nav id="parent-class-section" class="section">
|
60
|
+
<h3 class="section-header">Parent</h3>
|
61
|
+
|
62
|
+
<p class="link"><a href="../Object.html">Object</a>
|
63
|
+
|
64
|
+
</nav>
|
65
|
+
|
66
|
+
<!-- Included Modules -->
|
67
|
+
<nav id="includes-section" class="section">
|
68
|
+
<h3 class="section-header">Included Modules</h3>
|
69
|
+
|
70
|
+
<ul class="link-list">
|
71
|
+
|
72
|
+
|
73
|
+
<li><a class="include" href="Login.html">IVLE::Login</a>
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
<li><a class="include" href="IVLEModule.html">IVLE::IVLEModule</a>
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
<li><a class="include" href="Consultation.html">IVLE::Consultation</a>
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
<li><a class="include" href="RostersAndGroups.html">IVLE::RostersAndGroups</a>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<li><a class="include" href="Announcement.html">IVLE::Announcement</a>
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
<li><a class="include" href="Forum.html">IVLE::Forum</a>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<li><a class="include" href="Webcast.html">IVLE::Webcast</a>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
<li><a class="include" href="Poll.html">IVLE::Poll</a>
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
<li><a class="include" href="Workbin.html">IVLE::Workbin</a>
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
<li><a class="include" href="Gradebook.html">IVLE::Gradebook</a>
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
<li><a class="include" href="LibraryEReserves.html">IVLE::LibraryEReserves</a>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<li><a class="include" href="MyOrganizer.html">IVLE::MyOrganizer</a>
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
<li><a class="include" href="Community.html">IVLE::Community</a>
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
<li><a class="include" href="OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
<li><a class="include" href="StudentEvents.html">IVLE::StudentEvents</a>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<li><a class="include" href="IVLENews.html">IVLE::IVLENews</a>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
<li><a class="include" href="Timetable.html">IVLE::Timetable</a>
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<li><a class="include" href="DeltaDatasets.html">IVLE::DeltaDatasets</a>
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
<li><a class="include" href="Profile.html">IVLE::Profile</a>
|
146
|
+
|
147
|
+
|
148
|
+
</ul>
|
149
|
+
</nav>
|
150
|
+
|
151
|
+
<!-- Method Quickref -->
|
152
|
+
<nav id="method-list-section" class="section">
|
153
|
+
<h3 class="section-header">Methods</h3>
|
154
|
+
|
155
|
+
<ul class="link-list">
|
156
|
+
|
157
|
+
<li><a href="#method-c-new">::new</a>
|
158
|
+
|
159
|
+
<li><a href="#method-i-api">#api</a>
|
160
|
+
|
161
|
+
<li><a href="#method-i-api_post">#api_post</a>
|
162
|
+
|
163
|
+
</ul>
|
164
|
+
</nav>
|
165
|
+
|
166
|
+
</div>
|
167
|
+
|
168
|
+
<div id="project-metadata">
|
169
|
+
<nav id="fileindex-section" class="section project-section">
|
170
|
+
<h3 class="section-header">Pages</h3>
|
171
|
+
|
172
|
+
<ul>
|
173
|
+
|
174
|
+
<li class="file"><a href="../Gemfile.html">Gemfile</a>
|
175
|
+
|
176
|
+
<li class="file"><a href="../Rakefile.html">Rakefile</a>
|
177
|
+
|
178
|
+
</ul>
|
179
|
+
</nav>
|
180
|
+
|
181
|
+
<nav id="classindex-section" class="section project-section">
|
182
|
+
<h3 class="section-header">Class and Module Index</h3>
|
183
|
+
|
184
|
+
<ul class="link-list">
|
185
|
+
|
186
|
+
<li><a href="../IVLE.html">IVLE</a>
|
187
|
+
|
188
|
+
<li><a href="../IVLE/API.html">IVLE::API</a>
|
189
|
+
|
190
|
+
<li><a href="../IVLE/Announcement.html">IVLE::Announcement</a>
|
191
|
+
|
192
|
+
<li><a href="../IVLE/Community.html">IVLE::Community</a>
|
193
|
+
|
194
|
+
<li><a href="../IVLE/Consultation.html">IVLE::Consultation</a>
|
195
|
+
|
196
|
+
<li><a href="../IVLE/DeltaDatasets.html">IVLE::DeltaDatasets</a>
|
197
|
+
|
198
|
+
<li><a href="../IVLE/Forum.html">IVLE::Forum</a>
|
199
|
+
|
200
|
+
<li><a href="../IVLE/Gradebook.html">IVLE::Gradebook</a>
|
201
|
+
|
202
|
+
<li><a href="../IVLE/IVLEModule.html">IVLE::IVLEModule</a>
|
203
|
+
|
204
|
+
<li><a href="../IVLE/IVLENews.html">IVLE::IVLENews</a>
|
205
|
+
|
206
|
+
<li><a href="../IVLE/LibraryEReserves.html">IVLE::LibraryEReserves</a>
|
207
|
+
|
208
|
+
<li><a href="../IVLE/Login.html">IVLE::Login</a>
|
209
|
+
|
210
|
+
<li><a href="../IVLE/MyOrganizer.html">IVLE::MyOrganizer</a>
|
211
|
+
|
212
|
+
<li><a href="../IVLE/OpenWebcastLectures.html">IVLE::OpenWebcastLectures</a>
|
213
|
+
|
214
|
+
<li><a href="../IVLE/Poll.html">IVLE::Poll</a>
|
215
|
+
|
216
|
+
<li><a href="../IVLE/Profile.html">IVLE::Profile</a>
|
217
|
+
|
218
|
+
<li><a href="../IVLE/RostersAndGroups.html">IVLE::RostersAndGroups</a>
|
219
|
+
|
220
|
+
<li><a href="../IVLE/StudentEvents.html">IVLE::StudentEvents</a>
|
221
|
+
|
222
|
+
<li><a href="../IVLE/Timetable.html">IVLE::Timetable</a>
|
223
|
+
|
224
|
+
<li><a href="../IVLE/Webcast.html">IVLE::Webcast</a>
|
225
|
+
|
226
|
+
<li><a href="../IVLE/Workbin.html">IVLE::Workbin</a>
|
227
|
+
|
228
|
+
<li><a href="../Fixtures.html">Fixtures</a>
|
229
|
+
|
230
|
+
<li><a href="../Fixtures/IVLE.html">Fixtures::IVLE</a>
|
231
|
+
|
232
|
+
<li><a href="../Object.html">Object</a>
|
233
|
+
|
234
|
+
</ul>
|
235
|
+
</nav>
|
236
|
+
|
237
|
+
</div>
|
238
|
+
</nav>
|
239
|
+
|
240
|
+
<div id="documentation">
|
241
|
+
<h1 class="class">class IVLE::API</h1>
|
242
|
+
|
243
|
+
<div id="description" class="description">
|
244
|
+
|
245
|
+
</div><!-- description -->
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
<!-- Attributes -->
|
259
|
+
<section id="attribute-method-details" class="method-section section">
|
260
|
+
<h3 class="section-header">Attributes</h3>
|
261
|
+
|
262
|
+
|
263
|
+
<div id="attribute-i-api_key" class="method-detail">
|
264
|
+
<div class="method-heading attribute-method-heading">
|
265
|
+
<span class="method-name">api_key</span><span
|
266
|
+
class="attribute-access-type">[RW]</span>
|
267
|
+
</div>
|
268
|
+
|
269
|
+
<div class="method-description">
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
</div>
|
274
|
+
</div>
|
275
|
+
|
276
|
+
<div id="attribute-i-password" class="method-detail">
|
277
|
+
<div class="method-heading attribute-method-heading">
|
278
|
+
<span class="method-name">password</span><span
|
279
|
+
class="attribute-access-type">[RW]</span>
|
280
|
+
</div>
|
281
|
+
|
282
|
+
<div class="method-description">
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</div>
|
287
|
+
</div>
|
288
|
+
|
289
|
+
<div id="attribute-i-username" class="method-detail">
|
290
|
+
<div class="method-heading attribute-method-heading">
|
291
|
+
<span class="method-name">username</span><span
|
292
|
+
class="attribute-access-type">[RW]</span>
|
293
|
+
</div>
|
294
|
+
|
295
|
+
<div class="method-description">
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
</div>
|
300
|
+
</div>
|
301
|
+
|
302
|
+
</section><!-- attribute-method-details -->
|
303
|
+
|
304
|
+
|
305
|
+
<!-- Methods -->
|
306
|
+
|
307
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
308
|
+
<h3 class="section-header">Public Class Methods</h3>
|
309
|
+
|
310
|
+
|
311
|
+
<div id="method-c-new" class="method-detail ">
|
312
|
+
|
313
|
+
<div class="method-heading">
|
314
|
+
<span class="method-name">new</span><span
|
315
|
+
class="method-args">(api_key, username, password)</span>
|
316
|
+
<span class="method-click-advice">click to toggle source</span>
|
317
|
+
</div>
|
318
|
+
|
319
|
+
|
320
|
+
<div class="method-description">
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
<div class="method-source-code" id="new-source">
|
327
|
+
<pre><span class="ruby-comment"># File lib/IVLE.rb, line 62</span>
|
328
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>)
|
329
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">api_key</span> = <span class="ruby-identifier">api_key</span>
|
330
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">username</span> = <span class="ruby-identifier">username</span>
|
331
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
|
332
|
+
<span class="ruby-keyword">end</span></pre>
|
333
|
+
</div><!-- new-source -->
|
334
|
+
|
335
|
+
</div>
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
</div><!-- new-method -->
|
341
|
+
|
342
|
+
|
343
|
+
</section><!-- public-class-method-details -->
|
344
|
+
|
345
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
346
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
347
|
+
|
348
|
+
|
349
|
+
<div id="method-i-api" class="method-detail ">
|
350
|
+
|
351
|
+
<div class="method-heading">
|
352
|
+
<span class="method-name">api</span><span
|
353
|
+
class="method-args">(method, params={}, verb=:get, add_auth=true)</span>
|
354
|
+
<span class="method-click-advice">click to toggle source</span>
|
355
|
+
</div>
|
356
|
+
|
357
|
+
|
358
|
+
<div class="method-description">
|
359
|
+
|
360
|
+
<p>I don't trust the <a href="API.html">API</a> documentation so this is now
|
361
|
+
public. Call this yourself if my implementation fails.</p>
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
<div class="method-source-code" id="api-source">
|
366
|
+
<pre><span class="ruby-comment"># File lib/IVLE.rb, line 70</span>
|
367
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">api</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">params</span>={}, <span class="ruby-identifier">verb</span>=<span class="ruby-value">:get</span>, <span class="ruby-identifier">add_auth</span>=<span class="ruby-keyword">true</span>)
|
368
|
+
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">add_auth</span>(<span class="ruby-identifier">params</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">add_auth</span>
|
369
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">verb</span>, <span class="ruby-node">"api/Lapi.svc/#{method}"</span>, <span class="ruby-identifier">params</span>)
|
370
|
+
<span class="ruby-identifier">format_response</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>)
|
371
|
+
<span class="ruby-keyword">end</span></pre>
|
372
|
+
</div><!-- api-source -->
|
373
|
+
|
374
|
+
</div>
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
</div><!-- api-method -->
|
380
|
+
|
381
|
+
|
382
|
+
<div id="method-i-api_post" class="method-detail ">
|
383
|
+
|
384
|
+
<div class="method-heading">
|
385
|
+
<span class="method-name">api_post</span><span
|
386
|
+
class="method-args">(method, params={})</span>
|
387
|
+
<span class="method-click-advice">click to toggle source</span>
|
388
|
+
</div>
|
389
|
+
|
390
|
+
|
391
|
+
<div class="method-description">
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
<div class="method-source-code" id="api_post-source">
|
398
|
+
<pre><span class="ruby-comment"># File lib/IVLE.rb, line 76</span>
|
399
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">api_post</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">params</span>={})
|
400
|
+
<span class="ruby-identifier">api</span>(<span class="ruby-identifier">method</span>, <span class="ruby-identifier">params</span>, <span class="ruby-value">:post</span>)
|
401
|
+
<span class="ruby-keyword">end</span></pre>
|
402
|
+
</div><!-- api_post-source -->
|
403
|
+
|
404
|
+
</div>
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
</div><!-- api_post-method -->
|
410
|
+
|
411
|
+
|
412
|
+
</section><!-- public-instance-method-details -->
|
413
|
+
|
414
|
+
</section><!-- 5Buntitled-5D -->
|
415
|
+
|
416
|
+
</div><!-- documentation -->
|
417
|
+
|
418
|
+
|
419
|
+
<footer id="validator-badges">
|
420
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
421
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
|
422
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
423
|
+
</footer>
|
424
|
+
|