absorb_api 0.1.6 → 0.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/doc/AbsorbApi.html +83 -0
- data/doc/AbsorbApi/Base.html +0 -83
- data/doc/AbsorbApi/Course.html +5 -5
- data/doc/AbsorbApi/CourseEnrollment.html +6 -17
- data/doc/AbsorbApi/Lesson.html +279 -0
- data/doc/AbsorbApi/Orm.html +12 -4
- data/doc/AbsorbApi/Prerequisite.html +188 -0
- data/doc/AbsorbApi/Relations.html +5 -5
- data/doc/AbsorbApi/Resource.html +162 -0
- data/doc/AbsorbApi/Role.html +149 -0
- data/doc/AbsorbApi/SessionSchedule.html +253 -0
- data/doc/AbsorbApi/Tag.html +147 -0
- data/doc/AbsorbApi/User.html +3 -3
- data/doc/Gemfile_lock.html +1 -1
- data/doc/README_md.html +122 -10
- data/doc/created.rid +32 -28
- data/doc/index.html +12 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search_index.js +1 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +30 -4
- data/lib/absorb_api.rb +20 -0
- data/lib/absorb_api/base.rb +0 -21
- data/lib/absorb_api/course.rb +3 -3
- data/lib/absorb_api/course_enrollment.rb +3 -3
- data/lib/absorb_api/orm.rb +2 -2
- data/lib/absorb_api/relations.rb +5 -5
- data/lib/absorb_api/user.rb +3 -3
- data/lib/absorb_api/version.rb +1 -1
- metadata +8 -2
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class AbsorbApi::SessionSchedule - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="Base.html">AbsorbApi::Base</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
</nav>
|
|
70
|
+
|
|
71
|
+
<main role="main" aria-labelledby="class-AbsorbApi::SessionSchedule">
|
|
72
|
+
<h1 id="class-AbsorbApi::SessionSchedule" class="class">
|
|
73
|
+
class AbsorbApi::SessionSchedule
|
|
74
|
+
</h1>
|
|
75
|
+
|
|
76
|
+
<section class="description">
|
|
77
|
+
|
|
78
|
+
</section>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
<section class="attribute-method-details" class="method-section">
|
|
92
|
+
<header>
|
|
93
|
+
<h3>Attributes</h3>
|
|
94
|
+
</header>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<div id="attribute-i-date_end" class="method-detail">
|
|
98
|
+
<div class="method-heading attribute-method-heading">
|
|
99
|
+
<span class="method-name">date_end</span><span
|
|
100
|
+
class="attribute-access-type">[RW]</span>
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
<div class="method-description">
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
</div>
|
|
109
|
+
|
|
110
|
+
<div id="attribute-i-date_start" class="method-detail">
|
|
111
|
+
<div class="method-heading attribute-method-heading">
|
|
112
|
+
<span class="method-name">date_start</span><span
|
|
113
|
+
class="attribute-access-type">[RW]</span>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div class="method-description">
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
<div id="attribute-i-id" class="method-detail">
|
|
124
|
+
<div class="method-heading attribute-method-heading">
|
|
125
|
+
<span class="method-name">id</span><span
|
|
126
|
+
class="attribute-access-type">[RW]</span>
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
<div class="method-description">
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
</div>
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
<div id="attribute-i-meeting_id" class="method-detail">
|
|
137
|
+
<div class="method-heading attribute-method-heading">
|
|
138
|
+
<span class="method-name">meeting_id</span><span
|
|
139
|
+
class="attribute-access-type">[RW]</span>
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
<div class="method-description">
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</div>
|
|
147
|
+
</div>
|
|
148
|
+
|
|
149
|
+
<div id="attribute-i-meeting_password" class="method-detail">
|
|
150
|
+
<div class="method-heading attribute-method-heading">
|
|
151
|
+
<span class="method-name">meeting_password</span><span
|
|
152
|
+
class="attribute-access-type">[RW]</span>
|
|
153
|
+
</div>
|
|
154
|
+
|
|
155
|
+
<div class="method-description">
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</div>
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
<div id="attribute-i-meeting_username" class="method-detail">
|
|
163
|
+
<div class="method-heading attribute-method-heading">
|
|
164
|
+
<span class="method-name">meeting_username</span><span
|
|
165
|
+
class="attribute-access-type">[RW]</span>
|
|
166
|
+
</div>
|
|
167
|
+
|
|
168
|
+
<div class="method-description">
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</div>
|
|
173
|
+
</div>
|
|
174
|
+
|
|
175
|
+
<div id="attribute-i-session_id" class="method-detail">
|
|
176
|
+
<div class="method-heading attribute-method-heading">
|
|
177
|
+
<span class="method-name">session_id</span><span
|
|
178
|
+
class="attribute-access-type">[RW]</span>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
<div class="method-description">
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
|
|
188
|
+
<div id="attribute-i-time_zone_id" class="method-detail">
|
|
189
|
+
<div class="method-heading attribute-method-heading">
|
|
190
|
+
<span class="method-name">time_zone_id</span><span
|
|
191
|
+
class="attribute-access-type">[RW]</span>
|
|
192
|
+
</div>
|
|
193
|
+
|
|
194
|
+
<div class="method-description">
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
<div id="attribute-i-venue_id" class="method-detail">
|
|
202
|
+
<div class="method-heading attribute-method-heading">
|
|
203
|
+
<span class="method-name">venue_id</span><span
|
|
204
|
+
class="attribute-access-type">[RW]</span>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
<div class="method-description">
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
</div>
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
<div id="attribute-i-venue_name" class="method-detail">
|
|
215
|
+
<div class="method-heading attribute-method-heading">
|
|
216
|
+
<span class="method-name">venue_name</span><span
|
|
217
|
+
class="attribute-access-type">[RW]</span>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
<div class="method-description">
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</div>
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
<div id="attribute-i-venue_type" class="method-detail">
|
|
228
|
+
<div class="method-heading attribute-method-heading">
|
|
229
|
+
<span class="method-name">venue_type</span><span
|
|
230
|
+
class="attribute-access-type">[RW]</span>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
<div class="method-description">
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</div>
|
|
238
|
+
</div>
|
|
239
|
+
|
|
240
|
+
</section>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</section>
|
|
245
|
+
</main>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<footer id="validator-badges" role="contentinfo">
|
|
249
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
250
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
251
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
252
|
+
</footer>
|
|
253
|
+
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class AbsorbApi::Tag - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="Base.html">AbsorbApi::Base</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
<div id="includes-section" class="nav-section">
|
|
66
|
+
<h3>Included Modules</h3>
|
|
67
|
+
|
|
68
|
+
<ul class="link-list">
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<li><a class="include" href="Relations.html">AbsorbApi::Relations</a>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</ul>
|
|
75
|
+
</div>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
</div>
|
|
80
|
+
</nav>
|
|
81
|
+
|
|
82
|
+
<main role="main" aria-labelledby="class-AbsorbApi::Tag">
|
|
83
|
+
<h1 id="class-AbsorbApi::Tag" class="class">
|
|
84
|
+
class AbsorbApi::Tag
|
|
85
|
+
</h1>
|
|
86
|
+
|
|
87
|
+
<section class="description">
|
|
88
|
+
|
|
89
|
+
</section>
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<section class="attribute-method-details" class="method-section">
|
|
103
|
+
<header>
|
|
104
|
+
<h3>Attributes</h3>
|
|
105
|
+
</header>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<div id="attribute-i-id" class="method-detail">
|
|
109
|
+
<div class="method-heading attribute-method-heading">
|
|
110
|
+
<span class="method-name">id</span><span
|
|
111
|
+
class="attribute-access-type">[RW]</span>
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
<div class="method-description">
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
|
|
121
|
+
<div id="attribute-i-name" class="method-detail">
|
|
122
|
+
<div class="method-heading attribute-method-heading">
|
|
123
|
+
<span class="method-name">name</span><span
|
|
124
|
+
class="attribute-access-type">[RW]</span>
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
<div class="method-description">
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
</section>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
</section>
|
|
139
|
+
</main>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<footer id="validator-badges" role="contentinfo">
|
|
143
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
144
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
145
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
146
|
+
</footer>
|
|
147
|
+
|
data/doc/AbsorbApi/User.html
CHANGED
|
@@ -575,13 +575,13 @@ getting bogged down</p>
|
|
|
575
575
|
|
|
576
576
|
|
|
577
577
|
<div class="method-source-code" id="courses_from_collection-source">
|
|
578
|
-
<pre><span class="ruby-comment"># File lib/absorb_api/user.rb, line
|
|
578
|
+
<pre><span class="ruby-comment"># File lib/absorb_api/user.rb, line 15</span>
|
|
579
579
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">courses_from_collection</span>(<span class="ruby-identifier">users</span>)
|
|
580
580
|
<span class="ruby-identifier">courses</span> = []
|
|
581
581
|
<span class="ruby-identifier">users</span>.<span class="ruby-identifier">each_slice</span>(<span class="ruby-value">105</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user_slice</span><span class="ruby-operator">|</span>
|
|
582
|
-
<span class="ruby-identifier">api</span>.<span class="ruby-identifier">in_parallel</span> <span class="ruby-keyword">do</span>
|
|
582
|
+
<span class="ruby-constant">AbsorbApi</span>.<span class="ruby-identifier">api</span>.<span class="ruby-identifier">in_parallel</span> <span class="ruby-keyword">do</span>
|
|
583
583
|
<span class="ruby-identifier">user_slice</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
|
|
584
|
-
<span class="ruby-identifier">courses</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">api</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">"users/#{user.id}/courses"</span>)
|
|
584
|
+
<span class="ruby-identifier">courses</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">AbsorbApi</span>.<span class="ruby-identifier">api</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">"users/#{user.id}/courses"</span>)
|
|
585
585
|
<span class="ruby-keyword">end</span>
|
|
586
586
|
<span class="ruby-keyword">end</span>
|
|
587
587
|
<span class="ruby-keyword">end</span>
|
data/doc/Gemfile_lock.html
CHANGED
data/doc/README_md.html
CHANGED
|
@@ -67,6 +67,14 @@
|
|
|
67
67
|
<li><a href="#label-Chapter">Chapter</a>
|
|
68
68
|
<li><a href="#label-Curriculum">Curriculum</a>
|
|
69
69
|
<li><a href="#label-Department">Department</a>
|
|
70
|
+
<li><a href="#label-Role">Role</a>
|
|
71
|
+
<li><a href="#label-Tag">Tag</a>
|
|
72
|
+
<li><a href="#label-SessionSchedule">SessionSchedule</a>
|
|
73
|
+
<li><a href="#label-Resource">Resource</a>
|
|
74
|
+
<li><a href="#label-Prerequisite">Prerequisite</a>
|
|
75
|
+
<li><a href="#label-Lesson">Lesson</a>
|
|
76
|
+
<li><a href="#label-CourseEnrollment">CourseEnrollment</a>
|
|
77
|
+
<li><a href="#label-LessonEnrollment">LessonEnrollment</a>
|
|
70
78
|
<li><a href="#label-Development">Development</a>
|
|
71
79
|
<li><a href="#label-Contributing">Contributing</a>
|
|
72
80
|
<li><a href="#label-License">License</a>
|
|
@@ -137,6 +145,22 @@ href="http://npezza93.github.io/absorb_api/">npezza93.github.io/absorb_api/</a><
|
|
|
137
145
|
</li><li>
|
|
138
146
|
<p><a href="#department">Department</a></p>
|
|
139
147
|
</li><li>
|
|
148
|
+
<p><a href="#role">Role</a></p>
|
|
149
|
+
</li><li>
|
|
150
|
+
<p><a href="#tag">Tag</a></p>
|
|
151
|
+
</li><li>
|
|
152
|
+
<p><a href="#sessionschedule">SessionSchedule</a></p>
|
|
153
|
+
</li><li>
|
|
154
|
+
<p><a href="#resource">Resource</a></p>
|
|
155
|
+
</li><li>
|
|
156
|
+
<p><a href="#prerequisite">Prerequisite</a></p>
|
|
157
|
+
</li><li>
|
|
158
|
+
<p><a href="#lesson">Lesson</a></p>
|
|
159
|
+
</li><li>
|
|
160
|
+
<p><a href="#courseenrollment">CourseEnrollment</a></p>
|
|
161
|
+
</li><li>
|
|
162
|
+
<p><a href="#lessonenrollment">LessonEnrollment</a></p>
|
|
163
|
+
</li><li>
|
|
140
164
|
<p><a href="#development">Development</a></p>
|
|
141
165
|
</li></ol>
|
|
142
166
|
|
|
@@ -192,6 +216,9 @@ href="http://npezza93.github.io/absorb_api/">npezza93.github.io/absorb_api/</a><
|
|
|
192
216
|
<span class="ruby-comment"># To return a single certificate for a specific user</span>
|
|
193
217
|
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">find_certificate</span>(<span class="ruby-identifier">id</span>)
|
|
194
218
|
|
|
219
|
+
<span class="ruby-comment"># To return a collection of all resources available to an user</span>
|
|
220
|
+
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">resources</span>
|
|
221
|
+
|
|
195
222
|
<span class="ruby-comment"># To return a collection of all courses available for enrollment for a user</span>
|
|
196
223
|
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">courses</span>
|
|
197
224
|
|
|
@@ -206,11 +233,10 @@ href="http://npezza93.github.io/absorb_api/">npezza93.github.io/absorb_api/</a><
|
|
|
206
233
|
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">email_address</span> = <span class="ruby-string">"email_address"</span>
|
|
207
234
|
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">password</span> = <span class="ruby-string">"password"</span>
|
|
208
235
|
<span class="ruby-keyword">end</span>
|
|
209
|
-
</pre>
|
|
210
236
|
|
|
211
|
-
<
|
|
212
|
-
|
|
213
|
-
|
|
237
|
+
<span class="ruby-comment"># To return a collection of courses available per user given a collection of users</span>
|
|
238
|
+
<span class="ruby-identifier">courses</span> = <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">courses_from_collection</span>(<span class="ruby-identifier">users</span>)
|
|
239
|
+
</pre>
|
|
214
240
|
|
|
215
241
|
<h3 id="label-Course">Course<span><a href="#label-Course">¶</a> <a href="#top">↑</a></span></h3>
|
|
216
242
|
|
|
@@ -230,7 +256,7 @@ AbsorbApi::User.courses_from_collection(users) </code></p>
|
|
|
230
256
|
<span class="ruby-comment"># Available filters for enrollments include status and modifiedSince</span>
|
|
231
257
|
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">enrollments</span>(<span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>, <span class="ruby-identifier">modifiedSince</span><span class="ruby-operator">:</span> <span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2016</span>, <span class="ruby-value">1</span>, <span class="ruby-value">1</span>).<span class="ruby-identifier">to_s</span>)
|
|
232
258
|
|
|
233
|
-
<span class="ruby-comment"># To return a collection of all certificates awarded
|
|
259
|
+
<span class="ruby-comment"># To return a collection of all certificates awarded in a course</span>
|
|
234
260
|
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">certificates</span>
|
|
235
261
|
<span class="ruby-comment"># Available filters for certificates include includeExpired, acquiredDate, and expiryDate</span>
|
|
236
262
|
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">certificates</span>(<span class="ruby-identifier">includeExpired</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>)
|
|
@@ -241,12 +267,24 @@ AbsorbApi::User.courses_from_collection(users) </code></p>
|
|
|
241
267
|
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">chapters</span>
|
|
242
268
|
<span class="ruby-comment"># To return a single chapters for a specific course</span>
|
|
243
269
|
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">find_chapter</span>(<span class="ruby-identifier">id</span>)
|
|
244
|
-
</pre>
|
|
245
270
|
|
|
246
|
-
<
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
</
|
|
271
|
+
<span class="ruby-comment"># To return a collection of all resources available to a course</span>
|
|
272
|
+
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">resources</span>
|
|
273
|
+
<span class="ruby-comment"># To return a single resource for a specific course</span>
|
|
274
|
+
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">find_resource</span>(<span class="ruby-identifier">id</span>)
|
|
275
|
+
|
|
276
|
+
<span class="ruby-comment"># To return a collection of all prerequisites to a course</span>
|
|
277
|
+
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">prerequisites</span>
|
|
278
|
+
|
|
279
|
+
<span class="ruby-comment"># To return a collection of all lessons available to a course</span>
|
|
280
|
+
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">lessons</span>
|
|
281
|
+
<span class="ruby-comment"># To return a single lesson for a specific course</span>
|
|
282
|
+
<span class="ruby-identifier">course</span>.<span class="ruby-identifier">find_lesson</span>(<span class="ruby-identifier">id</span>)
|
|
283
|
+
|
|
284
|
+
<span class="ruby-comment"># To return a collection of associated enrollments given a collection of courses</span>
|
|
285
|
+
<span class="ruby-comment"># Available conditions include modifiedSince and status</span>
|
|
286
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Course</span>.<span class="ruby-identifier">enrollments_from_collection</span>(<span class="ruby-identifier">courses</span>, <span class="ruby-identifier">modifiedSince</span><span class="ruby-operator">:</span> <span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2016</span>, <span class="ruby-value">1</span>, <span class="ruby-value">1</span>))
|
|
287
|
+
</pre>
|
|
250
288
|
|
|
251
289
|
<h3 id="label-Category">Category<span><a href="#label-Category">¶</a> <a href="#top">↑</a></span></h3>
|
|
252
290
|
|
|
@@ -306,6 +344,80 @@ AbsorbApi::Course.enrollments_from_collection(AbsorbApi::Course.all)
|
|
|
306
344
|
<span class="ruby-keyword">end</span>
|
|
307
345
|
</pre>
|
|
308
346
|
|
|
347
|
+
<h3 id="label-Role">Role<span><a href="#label-Role">¶</a> <a href="#top">↑</a></span></h3>
|
|
348
|
+
|
|
349
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available roles</span>
|
|
350
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Role</span>.<span class="ruby-identifier">all</span>
|
|
351
|
+
|
|
352
|
+
<span class="ruby-comment"># To find a single role by id</span>
|
|
353
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Role</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
354
|
+
</pre>
|
|
355
|
+
|
|
356
|
+
<h3 id="label-Tag">Tag<span><a href="#label-Tag">¶</a> <a href="#top">↑</a></span></h3>
|
|
357
|
+
|
|
358
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available tags</span>
|
|
359
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Tag</span>.<span class="ruby-identifier">all</span>
|
|
360
|
+
|
|
361
|
+
<span class="ruby-comment"># To find a single tag by id</span>
|
|
362
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Tag</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
363
|
+
|
|
364
|
+
<span class="ruby-comment"># To create a new tag</span>
|
|
365
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Tag</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-string">"example"</span>)
|
|
366
|
+
<span class="ruby-comment"># or</span>
|
|
367
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Tag</span>.<span class="ruby-identifier">create</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tag</span><span class="ruby-operator">|</span>
|
|
368
|
+
<span class="ruby-identifier">user</span>.<span class="ruby-identifier">name</span> = <span class="ruby-string">"example"</span>
|
|
369
|
+
<span class="ruby-keyword">end</span>
|
|
370
|
+
</pre>
|
|
371
|
+
|
|
372
|
+
<h3 id="label-SessionSchedule">SessionSchedule<span><a href="#label-SessionSchedule">¶</a> <a href="#top">↑</a></span></h3>
|
|
373
|
+
|
|
374
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available session schedules</span>
|
|
375
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionSchedule</span>.<span class="ruby-identifier">all</span>
|
|
376
|
+
|
|
377
|
+
<span class="ruby-comment"># To find a single session schedule by id</span>
|
|
378
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">SessionSchedule</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
379
|
+
</pre>
|
|
380
|
+
|
|
381
|
+
<h3 id="label-Resource">Resource<span><a href="#label-Resource">¶</a> <a href="#top">↑</a></span></h3>
|
|
382
|
+
|
|
383
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available resources</span>
|
|
384
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Resource</span>.<span class="ruby-identifier">all</span>
|
|
385
|
+
|
|
386
|
+
<span class="ruby-comment"># To find a single resource by id</span>
|
|
387
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Resource</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
388
|
+
</pre>
|
|
389
|
+
|
|
390
|
+
<h3 id="label-Prerequisite">Prerequisite<span><a href="#label-Prerequisite">¶</a> <a href="#top">↑</a></span></h3>
|
|
391
|
+
|
|
392
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available prerequisites</span>
|
|
393
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Prerequisite</span>.<span class="ruby-identifier">all</span>
|
|
394
|
+
|
|
395
|
+
<span class="ruby-comment"># To find a single prerequisite by id</span>
|
|
396
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Prerequisite</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
397
|
+
</pre>
|
|
398
|
+
|
|
399
|
+
<h3 id="label-Lesson">Lesson<span><a href="#label-Lesson">¶</a> <a href="#top">↑</a></span></h3>
|
|
400
|
+
|
|
401
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of all available lessons</span>
|
|
402
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Lesson</span>.<span class="ruby-identifier">all</span>
|
|
403
|
+
|
|
404
|
+
<span class="ruby-comment"># To find a single lesson by id</span>
|
|
405
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Lesson</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
|
|
406
|
+
</pre>
|
|
407
|
+
|
|
408
|
+
<h3 id="label-CourseEnrollment">CourseEnrollment<span><a href="#label-CourseEnrollment">¶</a> <a href="#top">↑</a></span></h3>
|
|
409
|
+
|
|
410
|
+
<pre class="ruby"><span class="ruby-comment"># To return a collection of associated lessons matching conditions</span>
|
|
411
|
+
<span class="ruby-comment"># Available conditions are modifiedSince and status</span>
|
|
412
|
+
<span class="ruby-identifier">course_enrollment</span>.<span class="ruby-identifier">lessons</span>
|
|
413
|
+
|
|
414
|
+
<span class="ruby-comment"># To return a collection of associated enrollments given a collection of courses</span>
|
|
415
|
+
<span class="ruby-comment"># Available conditions include modifiedSince and status</span>
|
|
416
|
+
<span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">CourseEnrollment</span>.<span class="ruby-identifier">lessons_from_collection</span>(<span class="ruby-identifier">course_enrollments</span>, <span class="ruby-identifier">modifiedSince</span><span class="ruby-operator">:</span> <span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2016</span>, <span class="ruby-value">1</span>, <span class="ruby-value">1</span>))
|
|
417
|
+
</pre>
|
|
418
|
+
|
|
419
|
+
<h3 id="label-LessonEnrollment">LessonEnrollment<span><a href="#label-LessonEnrollment">¶</a> <a href="#top">↑</a></span></h3>
|
|
420
|
+
|
|
309
421
|
<h2 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#top">↑</a></span></h2>
|
|
310
422
|
|
|
311
423
|
<p>After checking out the repo, run <code>bin/setup</code> to install
|