absorb_api 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (96) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +8 -0
  3. data/Gemfile +11 -0
  4. data/LICENSE.txt +21 -0
  5. data/README.md +203 -0
  6. data/Rakefile +2 -0
  7. data/absorb_api.gemspec +25 -0
  8. data/bin/console +14 -0
  9. data/bin/setup +8 -0
  10. data/doc/AbsorbApi.html +216 -0
  11. data/doc/AbsorbApi/Base.html +239 -0
  12. data/doc/AbsorbApi/Category.html +173 -0
  13. data/doc/AbsorbApi/Certificate.html +212 -0
  14. data/doc/AbsorbApi/Chapter.html +160 -0
  15. data/doc/AbsorbApi/Collection.html +180 -0
  16. data/doc/AbsorbApi/Configuration.html +188 -0
  17. data/doc/AbsorbApi/Course.html +534 -0
  18. data/doc/AbsorbApi/CourseEnrollment.html +437 -0
  19. data/doc/AbsorbApi/Curriculum.html +498 -0
  20. data/doc/AbsorbApi/Department.html +242 -0
  21. data/doc/AbsorbApi/LessonEnrollment.html +370 -0
  22. data/doc/AbsorbApi/Orm.html +201 -0
  23. data/doc/AbsorbApi/Relations.html +301 -0
  24. data/doc/AbsorbApi/ResourceNotFound.html +102 -0
  25. data/doc/AbsorbApi/RouteNotFound.html +102 -0
  26. data/doc/AbsorbApi/User.html +615 -0
  27. data/doc/AbsorbApi/ValidationError.html +102 -0
  28. data/doc/Gemfile.html +100 -0
  29. data/doc/Gemfile_lock.html +150 -0
  30. data/doc/LICENSE_txt.html +113 -0
  31. data/doc/README_md.html +340 -0
  32. data/doc/Rakefile.html +93 -0
  33. data/doc/absorb_api_gemspec.html +126 -0
  34. data/doc/bin/setup.html +97 -0
  35. data/doc/created.rid +26 -0
  36. data/doc/css/fonts.css +167 -0
  37. data/doc/css/rdoc.css +590 -0
  38. data/doc/fonts/Lato-Light.ttf +0 -0
  39. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  40. data/doc/fonts/Lato-Regular.ttf +0 -0
  41. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  42. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  43. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  44. data/doc/images/add.png +0 -0
  45. data/doc/images/arrow_up.png +0 -0
  46. data/doc/images/brick.png +0 -0
  47. data/doc/images/brick_link.png +0 -0
  48. data/doc/images/bug.png +0 -0
  49. data/doc/images/bullet_black.png +0 -0
  50. data/doc/images/bullet_toggle_minus.png +0 -0
  51. data/doc/images/bullet_toggle_plus.png +0 -0
  52. data/doc/images/date.png +0 -0
  53. data/doc/images/delete.png +0 -0
  54. data/doc/images/find.png +0 -0
  55. data/doc/images/loadingAnimation.gif +0 -0
  56. data/doc/images/macFFBgHack.png +0 -0
  57. data/doc/images/package.png +0 -0
  58. data/doc/images/page_green.png +0 -0
  59. data/doc/images/page_white_text.png +0 -0
  60. data/doc/images/page_white_width.png +0 -0
  61. data/doc/images/plugin.png +0 -0
  62. data/doc/images/ruby.png +0 -0
  63. data/doc/images/tag_blue.png +0 -0
  64. data/doc/images/tag_green.png +0 -0
  65. data/doc/images/transparent.png +0 -0
  66. data/doc/images/wrench.png +0 -0
  67. data/doc/images/wrench_orange.png +0 -0
  68. data/doc/images/zoom.png +0 -0
  69. data/doc/index.html +135 -0
  70. data/doc/js/darkfish.js +161 -0
  71. data/doc/js/jquery.js +4 -0
  72. data/doc/js/navigation.js +142 -0
  73. data/doc/js/navigation.js.gz +0 -0
  74. data/doc/js/search.js +109 -0
  75. data/doc/js/search_index.js +1 -0
  76. data/doc/js/search_index.js.gz +0 -0
  77. data/doc/js/searcher.js +228 -0
  78. data/doc/js/searcher.js.gz +0 -0
  79. data/doc/table_of_contents.html +218 -0
  80. data/lib/absorb_api.rb +26 -0
  81. data/lib/absorb_api/base.rb +31 -0
  82. data/lib/absorb_api/category.rb +7 -0
  83. data/lib/absorb_api/certificate.rb +7 -0
  84. data/lib/absorb_api/chapter.rb +7 -0
  85. data/lib/absorb_api/collection.rb +19 -0
  86. data/lib/absorb_api/configuration.rb +21 -0
  87. data/lib/absorb_api/course.rb +24 -0
  88. data/lib/absorb_api/course_enrollment.rb +33 -0
  89. data/lib/absorb_api/curriculum.rb +7 -0
  90. data/lib/absorb_api/department.rb +10 -0
  91. data/lib/absorb_api/lesson_enrollment.rb +5 -0
  92. data/lib/absorb_api/orm.rb +28 -0
  93. data/lib/absorb_api/relations.rb +62 -0
  94. data/lib/absorb_api/user.rb +27 -0
  95. data/lib/absorb_api/version.rb +3 -0
  96. metadata +168 -0
data/doc/README_md.html ADDED
@@ -0,0 +1,340 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>README - 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="file">
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
+ <div class="nav-section">
55
+ <h3>Table of Contents</h3>
56
+
57
+ <ul class="link-list" role="directory">
58
+ <li><a href="#label-Absorb+LMS+API+Wrapper">Absorb LMS API Wrapper</a>
59
+ <li><a href="#label-Table+of+Contents">Table of Contents</a>
60
+ <li><a href="#label-Installation">Installation</a>
61
+ <li><a href="#label-Configuration">Configuration</a>
62
+ <li><a href="#label-Models">Models</a>
63
+ <li><a href="#label-User">User</a>
64
+ <li><a href="#label-Course">Course</a>
65
+ <li><a href="#label-Category">Category</a>
66
+ <li><a href="#label-Certificate">Certificate</a>
67
+ <li><a href="#label-Chapter">Chapter</a>
68
+ <li><a href="#label-Curriculum">Curriculum</a>
69
+ <li><a href="#label-Department">Department</a>
70
+ <li><a href="#label-Development">Development</a>
71
+ <li><a href="#label-Contributing">Contributing</a>
72
+ <li><a href="#label-License">License</a>
73
+ </ul>
74
+ </div>
75
+
76
+
77
+ <div id="project-metadata">
78
+ <div id="fileindex-section" class="nav-section">
79
+ <h3>Pages</h3>
80
+
81
+ <ul class="link-list">
82
+
83
+ <li><a href="./Gemfile.html">Gemfile</a>
84
+
85
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
86
+
87
+ <li><a href="./LICENSE_txt.html">LICENSE</a>
88
+
89
+ <li><a href="./README_md.html">README</a>
90
+
91
+ <li><a href="./Rakefile.html">Rakefile</a>
92
+
93
+ <li><a href="./absorb_api_gemspec.html">absorb_api.gemspec</a>
94
+
95
+ <li><a href="./bin/setup.html">setup</a>
96
+
97
+ </ul>
98
+ </div>
99
+
100
+ </div>
101
+ </nav>
102
+
103
+ <main role="main" aria-label="Page README.md">
104
+
105
+ <h1 id="label-Absorb+LMS+API+Wrapper">Absorb LMS API Wrapper<span><a href="#label-Absorb+LMS+API+Wrapper">&para;</a> <a href="#top">&uarr;</a></span></h1>
106
+
107
+ <p>“Absorb LMS is a powerful, flexible, and visually stunning software
108
+ platform teamed with expert implementation and support to help you build
109
+ the training programs your business needs. Whether your old LMS is slowing
110
+ you down or you’ve outgrown your current training model, Absorb can help. ”</p>
111
+
112
+ <p>All the available REST routes can be found <a
113
+ href="https://myabsorb.com/api/rest/v1/Help">here</a>.</p>
114
+
115
+ <p>Full documentation can be found at <a
116
+ href="http://npezza93.github.io/absorb_api/">npezza93.github.io/absorb_api/</a></p>
117
+
118
+ <h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
119
+ <ol><li>
120
+ <p><a href="#installation">Installation</a></p>
121
+ </li><li>
122
+ <p><a href="#configuration">Configuration</a></p>
123
+ </li><li>
124
+ <p><a href="#models">Models</a></p>
125
+ </li><li>
126
+ <p><a href="#user">User</a></p>
127
+ </li><li>
128
+ <p><a href="#course">Course</a></p>
129
+ </li><li>
130
+ <p><a href="#category">Category</a></p>
131
+ </li><li>
132
+ <p><a href="#certificate">Certificate</a></p>
133
+ </li><li>
134
+ <p><a href="#chapter">Chapter</a></p>
135
+ </li><li>
136
+ <p><a href="#curriculum">Curriculum</a></p>
137
+ </li><li>
138
+ <p><a href="#department">Department</a></p>
139
+ </li><li>
140
+ <p><a href="#development">Development</a></p>
141
+ </li></ol>
142
+
143
+ <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
144
+
145
+ <p>Add this line to your application&#39;s Gemfile:</p>
146
+
147
+ <pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;absorb_api&#39;</span>
148
+ </pre>
149
+
150
+ <p>And then execute:</p>
151
+
152
+ <pre>$ bundle</pre>
153
+
154
+ <p>Or install it yourself as:</p>
155
+
156
+ <pre>$ gem install absorb_api</pre>
157
+
158
+ <h2 id="label-Configuration">Configuration<span><a href="#label-Configuration">&para;</a> <a href="#top">&uarr;</a></span></h2>
159
+
160
+ <pre class="ruby"><span class="ruby-constant">AbsorbApi</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
161
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">absorbuser</span> = <span class="ruby-identifier">absorb_username</span>
162
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">absorbpass</span> = <span class="ruby-identifier">absorb_password</span>
163
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">absorbkey</span> = <span class="ruby-identifier">absorb_privatekey</span>
164
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">url</span> = <span class="ruby-identifier">absorb_url</span>
165
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">ignored_course_ids</span> = [<span class="ruby-identifier">course_ids_to_ignore</span>]
166
+ <span class="ruby-identifier">c</span>.<span class="ruby-identifier">ignored_lesson_types</span> = [<span class="ruby-identifier">lesson_types_to_ignore</span>]
167
+ <span class="ruby-keyword">end</span>
168
+ </pre>
169
+
170
+ <h2 id="label-Models">Models<span><a href="#label-Models">&para;</a> <a href="#top">&uarr;</a></span></h2>
171
+
172
+ <h3 id="label-User">User<span><a href="#label-User">&para;</a> <a href="#top">&uarr;</a></span></h3>
173
+
174
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available users</span>
175
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">all</span>
176
+
177
+ <span class="ruby-comment"># To find a single user by id:</span>
178
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
179
+
180
+ <span class="ruby-comment"># To return a collection of users matching conditions</span>
181
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">conditions</span>)
182
+ <span class="ruby-comment"># available conditions include email, username, modifiedSince, and externalId</span>
183
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">email</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;email@gmail.com&quot;</span>)
184
+
185
+ <span class="ruby-comment"># To return a collection of enrollments for a specific user:</span>
186
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">enrollments</span>
187
+ <span class="ruby-comment"># Available filters for enrollments include status and modifiedSince</span>
188
+ <span class="ruby-identifier">user</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>)
189
+
190
+ <span class="ruby-comment"># To return a collection of all certificates awarded to a user</span>
191
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">certificates</span>
192
+ <span class="ruby-comment"># To return a single certificate for a specific user</span>
193
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">find_certificate</span>(<span class="ruby-identifier">id</span>)
194
+
195
+ <span class="ruby-comment"># To return a collection of all courses available for enrollment for a user</span>
196
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">courses</span>
197
+
198
+ <span class="ruby-comment"># To create a new user</span>
199
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">department_id</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;department_id&quot;</span>, <span class="ruby-identifier">first_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;first_name&quot;</span>, <span class="ruby-identifier">last_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;last_name&quot;</span>, <span class="ruby-identifier">user_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;user_name&quot;</span>, <span class="ruby-identifier">email_address</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;email_address&quot;</span>, <span class="ruby-identifier">password</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;password&quot;</span>)
200
+ <span class="ruby-comment"># or</span>
201
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">create</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
202
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">department_id</span> = <span class="ruby-string">&quot;department_id&quot;</span>
203
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">first_name</span> = <span class="ruby-string">&quot;first_name&quot;</span>
204
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">last_name</span> = <span class="ruby-string">&quot;last_name&quot;</span>
205
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">user_name</span> = <span class="ruby-string">&quot;user_name&quot;</span>
206
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">email_address</span> = <span class="ruby-string">&quot;email_address&quot;</span>
207
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">password</span> = <span class="ruby-string">&quot;password&quot;</span>
208
+ <span class="ruby-keyword">end</span>
209
+ </pre>
210
+
211
+ <p>To return a collection of courses available per user given a collection of
212
+ users: <code>ruby users = AbsorbApi::User.all courses =
213
+ AbsorbApi::User.courses_from_collection(users) </code></p>
214
+
215
+ <h3 id="label-Course">Course<span><a href="#label-Course">&para;</a> <a href="#top">&uarr;</a></span></h3>
216
+
217
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available courses</span>
218
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Course</span>.<span class="ruby-identifier">all</span>
219
+
220
+ <span class="ruby-comment"># To find a single course by id</span>
221
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Course</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
222
+
223
+ <span class="ruby-comment"># To return a collection of courses matching conditions</span>
224
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Course</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">conditions</span>)
225
+ <span class="ruby-comment"># available conditions include modifiedSince and externalId</span>
226
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Course</span>.<span class="ruby-identifier">where</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>)
227
+
228
+ <span class="ruby-comment"># To return a collection of enrollments for a specific course:</span>
229
+ <span class="ruby-identifier">course</span>.<span class="ruby-identifier">enrollments</span>
230
+ <span class="ruby-comment"># Available filters for enrollments include status and modifiedSince</span>
231
+ <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
+
233
+ <span class="ruby-comment"># To return a collection of all certificates awarded to a user</span>
234
+ <span class="ruby-identifier">course</span>.<span class="ruby-identifier">certificates</span>
235
+ <span class="ruby-comment"># Available filters for certificates include includeExpired, acquiredDate, and expiryDate</span>
236
+ <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>)
237
+ <span class="ruby-comment"># To return a single certificate for a specific course</span>
238
+ <span class="ruby-identifier">course</span>.<span class="ruby-identifier">find_certificate</span>(<span class="ruby-identifier">id</span>)
239
+
240
+ <span class="ruby-comment"># To return a collection of chapters for a specific course</span>
241
+ <span class="ruby-identifier">course</span>.<span class="ruby-identifier">chapters</span>
242
+ <span class="ruby-comment"># To return a single chapters for a specific course</span>
243
+ <span class="ruby-identifier">course</span>.<span class="ruby-identifier">find_chapter</span>(<span class="ruby-identifier">id</span>)
244
+ </pre>
245
+
246
+ <p>To return a collection of associated enrollments given a collection of
247
+ courses <code>ruby
248
+ AbsorbApi::Course.enrollments_from_collection(AbsorbApi::Course.all)
249
+ </code></p>
250
+
251
+ <h3 id="label-Category">Category<span><a href="#label-Category">&para;</a> <a href="#top">&uarr;</a></span></h3>
252
+
253
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available categories</span>
254
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Category</span>.<span class="ruby-identifier">all</span>
255
+
256
+ <span class="ruby-comment"># To find a single category by id:</span>
257
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Category</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
258
+ </pre>
259
+
260
+ <h3 id="label-Certificate">Certificate<span><a href="#label-Certificate">&para;</a> <a href="#top">&uarr;</a></span></h3>
261
+
262
+ <pre class="ruby"><span class="ruby-comment"># To find a single certificate by id</span>
263
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
264
+ </pre>
265
+
266
+ <h3 id="label-Chapter">Chapter<span><a href="#label-Chapter">&para;</a> <a href="#top">&uarr;</a></span></h3>
267
+
268
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available chapters</span>
269
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Chapter</span>.<span class="ruby-identifier">all</span>
270
+
271
+ <span class="ruby-comment"># To find a single chapter by id</span>
272
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Chapter</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
273
+ </pre>
274
+
275
+ <h3 id="label-Curriculum">Curriculum<span><a href="#label-Curriculum">&para;</a> <a href="#top">&uarr;</a></span></h3>
276
+
277
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available curriculums</span>
278
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Curriculum</span>.<span class="ruby-identifier">all</span>
279
+
280
+ <span class="ruby-comment"># To find a single curriculum by id</span>
281
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Curriculum</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
282
+ </pre>
283
+
284
+ <h3 id="label-Department">Department<span><a href="#label-Department">&para;</a> <a href="#top">&uarr;</a></span></h3>
285
+
286
+ <pre class="ruby"><span class="ruby-comment"># To return a collection of all available departments</span>
287
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">all</span>
288
+
289
+ <span class="ruby-comment"># To find a single department by id</span>
290
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">id</span>)
291
+
292
+ <span class="ruby-comment"># To return a collection of departments matching conditions</span>
293
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">conditions</span>)
294
+ <span class="ruby-comment"># available conditions include departmentName, and externalId</span>
295
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">departmentName</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;Technology&quot;</span>)
296
+
297
+ <span class="ruby-comment"># To return the parent department</span>
298
+ <span class="ruby-identifier">department</span>.<span class="ruby-identifier">parent</span>
299
+
300
+ <span class="ruby-comment"># To create a new department</span>
301
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;Test Department&quot;</span>, <span class="ruby-identifier">parent_id</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span>)
302
+ <span class="ruby-comment"># or</span>
303
+ <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Department</span>.<span class="ruby-identifier">create</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">department</span><span class="ruby-operator">|</span>
304
+ <span class="ruby-identifier">department</span>.<span class="ruby-identifier">name</span> = <span class="ruby-string">&quot;Test Department&quot;</span>
305
+ <span class="ruby-identifier">department</span>.<span class="ruby-identifier">parent_id</span> = <span class="ruby-value">1</span>
306
+ <span class="ruby-keyword">end</span>
307
+ </pre>
308
+
309
+ <h2 id="label-Development">Development<span><a href="#label-Development">&para;</a> <a href="#top">&uarr;</a></span></h2>
310
+
311
+ <p>After checking out the repo, run <code>bin/setup</code> to install
312
+ dependencies. You can also run <code>bin/console</code> for an interactive
313
+ prompt that will allow you to experiment.</p>
314
+
315
+ <p>To install this gem onto your local machine, run <code>bundle exec rake
316
+ install</code>. To release a new version, update the version number in
317
+ <code>version.rb</code>, and then run <code>bundle exec rake
318
+ release</code>, which will create a git tag for the version, push git
319
+ commits and tags, and push the <code>.gem</code> file to <a
320
+ href="https://rubygems.org">rubygems.org</a>.</p>
321
+
322
+ <h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">&para;</a> <a href="#top">&uarr;</a></span></h2>
323
+
324
+ <p>Bug reports and pull requests are welcome on GitHub at <a
325
+ href="https://github.com/npezza93/absorb_api">github.com/npezza93/absorb_api</a>.</p>
326
+
327
+ <h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
328
+
329
+ <p>The gem is available as open source under the terms of the <a
330
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
331
+ </main>
332
+
333
+
334
+
335
+ <footer id="validator-badges" role="contentinfo">
336
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
337
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
338
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
339
+ </footer>
340
+
data/doc/Rakefile.html ADDED
@@ -0,0 +1,93 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>Rakefile - 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="file">
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="project-metadata">
56
+ <div id="fileindex-section" class="nav-section">
57
+ <h3>Pages</h3>
58
+
59
+ <ul class="link-list">
60
+
61
+ <li><a href="./Gemfile.html">Gemfile</a>
62
+
63
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
64
+
65
+ <li><a href="./LICENSE_txt.html">LICENSE</a>
66
+
67
+ <li><a href="./README_md.html">README</a>
68
+
69
+ <li><a href="./Rakefile.html">Rakefile</a>
70
+
71
+ <li><a href="./absorb_api_gemspec.html">absorb_api.gemspec</a>
72
+
73
+ <li><a href="./bin/setup.html">setup</a>
74
+
75
+ </ul>
76
+ </div>
77
+
78
+ </div>
79
+ </nav>
80
+
81
+ <main role="main" aria-label="Page Rakefile">
82
+
83
+ <p>require “bundler/gem_tasks” task :default =&gt; :spec</p>
84
+ </main>
85
+
86
+
87
+
88
+ <footer id="validator-badges" role="contentinfo">
89
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
90
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
91
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
92
+ </footer>
93
+
data/doc/absorb_api_gemspec.html ADDED
@@ -0,0 +1,126 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>absorb_api.gemspec - 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="file">
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="project-metadata">
56
+ <div id="fileindex-section" class="nav-section">
57
+ <h3>Pages</h3>
58
+
59
+ <ul class="link-list">
60
+
61
+ <li><a href="./Gemfile.html">Gemfile</a>
62
+
63
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
64
+
65
+ <li><a href="./LICENSE_txt.html">LICENSE</a>
66
+
67
+ <li><a href="./README_md.html">README</a>
68
+
69
+ <li><a href="./Rakefile.html">Rakefile</a>
70
+
71
+ <li><a href="./absorb_api_gemspec.html">absorb_api.gemspec</a>
72
+
73
+ <li><a href="./bin/setup.html">setup</a>
74
+
75
+ </ul>
76
+ </div>
77
+
78
+ </div>
79
+ </nav>
80
+
81
+ <main role="main" aria-label="Page absorb_api.gemspec">
82
+
83
+ <p>lib = File.expand_path(&#39;../lib&#39;, __FILE__) $LOAD_PATH.unshift(lib)
84
+ unless $LOAD_PATH.include?(lib) require &#39;absorb_api/version&#39;</p>
85
+
86
+ <p>Gem::Specification.new do |spec|</p>
87
+
88
+ <pre class="ruby"><span class="ruby-identifier">spec</span>.<span class="ruby-identifier">name</span> = <span class="ruby-string">&quot;absorb_api&quot;</span>
89
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">version</span> = <span class="ruby-constant">AbsorbApi</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
90
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">authors</span> = [<span class="ruby-string">&quot;npezza93&quot;</span>]
91
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">email</span> = [<span class="ruby-string">&quot;npezza93@gmail.com&quot;</span>]
92
+
93
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">summary</span> = <span class="ruby-string">&quot;API wrapper for Absorb LMS&quot;</span>
94
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">description</span> = <span class="ruby-string">&quot;\&quot;Absorb LMS is a powerful, flexible, and visually stunning software platform teamed with expert implementation and support to help you build the training programs your business needs. Whether your old LMS is slowing you down or you’ve outgrown your current training model, Absorb can help.
95
+ \&quot;&quot;</span>
96
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">homepage</span> = <span class="ruby-string">&quot;https://github.com/npezza93/absorb_api&quot;</span>
97
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">license</span> = <span class="ruby-string">&quot;MIT&quot;</span>
98
+
99
+ <span class="ruby-comment"># Prevent pushing this gem to RubyGems.org by setting &#39;allowed_push_host&#39;, or</span>
100
+ <span class="ruby-comment"># delete this section to allow pushing this gem to any host.</span>
101
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">respond_to?</span>(:<span class="ruby-identifier">metadata</span>)
102
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">metadata</span>[<span class="ruby-string">&#39;allowed_push_host&#39;</span>] = <span class="ruby-string">&quot;TODO: Set to &#39;http://mygemserver.com&#39;&quot;</span>
103
+ <span class="ruby-keyword">else</span>
104
+ <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;RubyGems 2.0 or newer is required to protect against public gem pushes.&quot;</span>
105
+ <span class="ruby-keyword">end</span>
106
+
107
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">files</span> = <span class="ruby-value">%x`git ls-files -z`</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;\x0&quot;</span>).<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r{^(test|spec|features)/}</span>) }
108
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">bindir</span> = <span class="ruby-string">&quot;exe&quot;</span>
109
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">executables</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">files</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp">%r{^exe/}</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">f</span>) }
110
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">require_paths</span> = [<span class="ruby-string">&quot;lib&quot;</span>]
111
+
112
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">add_development_dependency</span> <span class="ruby-string">&quot;bundler&quot;</span>, <span class="ruby-string">&quot;~&gt; 1.11&quot;</span>
113
+ <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">add_development_dependency</span> <span class="ruby-string">&quot;rake&quot;</span>, <span class="ruby-string">&quot;~&gt; 10.0&quot;</span>
114
+ </pre>
115
+
116
+ <p>end</p>
117
+ </main>
118
+
119
+
120
+
121
+ <footer id="validator-badges" role="contentinfo">
122
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
123
+ <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
124
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
125
+ </footer>
126
+