absorb_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5387f031cc50ad89f0af07737f46ececb7193ae2
-  data.tar.gz: c8f6b4e99484161d9bd07215aab7ac03c9475141
+  metadata.gz: 29ac6927feaf3f06a8b8cc7d1c67f83696e34300
+  data.tar.gz: f1dff5922ac85bdf95aa3f0f742c9401e0e1da00
 SHA512:
-  metadata.gz: 45b6490be166ec18e27f3a671bef8d738111d8107771996891970c47c12e5ffda6bb2a0dd0be4b40f6bab66b48716571998a717fca8f67d45691c6e22292dc05
-  data.tar.gz: a2c4aae967b2921d9576960b7c24c6d9c3ee5a52250ab1d1d5ee6bbcf8d666070d1a8286a530e58190b2cedb282bb672a75d0f782f318bab978f710b51e9e38e
+  metadata.gz: e3af4ec6f0fecc9c48b305155cc2fce09ce1292feb4510347cfc4baa7eadcbf633176c671d8c3c4680c743e44ade1406d3ed9d7da13806de36d15f358aff29f5
+  data.tar.gz: 514173a715b6d9c2db6637e263d9b2e55dcc81641c86b14427161adaece3189ba05a2169e32f8509178f4542731b0f7142d89a532c94347c2daf86273acd08c3

data/README.md

@@ -17,6 +17,12 @@ Full documentation can be found at [http://npezza93.github.io/absorb_api/](http:
   * [Chapter](#chapter)
   * [Curriculum](#curriculum)
   * [Department](#department)
+  * [Role](#role)
+  * [Tag](#tag)
+  * [SessionSchedule](#sessionschedule)
+  * [Resource](#resource)
+  * [Prerequisite](#prerequisite)
+  * [Lesson](#lesson)
   * [CourseEnrollment](#courseenrollment)
   * [LessonEnrollment](#lessonenrollment)
 4. [Development](#development)
@@ -73,6 +79,9 @@ user.certificates
 # To return a single certificate for a specific user
 user.find_certificate(id)
 
+# To return a collection of all resources available to an user
+user.resources
+
 # To return a collection of all courses available for enrollment for a user
 user.courses
 
@@ -110,7 +119,7 @@ course.enrollments
 # Available filters for enrollments include status and modifiedSince
 course.enrollments(status: 0, modifiedSince: DateTime.new(2016, 1, 1).to_s)
 
-# To return a collection of all certificates awarded to a user
+# To return a collection of all certificates awarded in a course
 course.certificates
 # Available filters for certificates include includeExpired, acquiredDate, and expiryDate
 course.certificates(includeExpired: true)
@@ -122,6 +131,19 @@ course.chapters
 # To return a single chapters for a specific course
 course.find_chapter(id)
 
+# To return a collection of all resources available to a course
+course.resources
+# To return a single resource for a specific course
+course.find_resource(id)
+
+# To return a collection of all prerequisites to a course
+course.prerequisites
+
+# To return a collection of all lessons available to a course
+course.lessons
+# To return a single lesson for a specific course
+course.find_lesson(id)
+
 # To return a collection of associated enrollments given a collection of courses
 # Available conditions include modifiedSince and status
 AbsorbApi::Course.enrollments_from_collection(courses, modifiedSince: DateTime.new(2016, 1, 1))
@@ -185,6 +207,67 @@ AbsorbApi::Department.create do |department|
 end
 ```
 
+### Role
+```ruby
+# To return a collection of all available roles
+AbsorbApi::Role.all
+
+# To find a single role by id
+AbsorbApi::Role.find(id)
+```
+
+### Tag
+```ruby
+# To return a collection of all available tags
+AbsorbApi::Tag.all
+
+# To find a single tag by id
+AbsorbApi::Tag.find(id)
+
+# To create a new tag
+AbsorbApi::Tag.create(name: "example")
+# or
+AbsorbApi::Tag.create do |tag|
+  user.name  = "example"
+end
+```
+
+### SessionSchedule
+```ruby
+# To return a collection of all available session schedules
+AbsorbApi::SessionSchedule.all
+
+# To find a single session schedule by id
+AbsorbApi::SessionSchedule.find(id)
+```
+
+### Resource
+```ruby
+# To return a collection of all available resources
+AbsorbApi::Resource.all
+
+# To find a single resource by id
+AbsorbApi::Resource.find(id)
+```
+
+### Prerequisite
+```ruby
+# To return a collection of all available prerequisites
+AbsorbApi::Prerequisite.all
+
+# To find a single prerequisite by id
+AbsorbApi::Prerequisite.find(id)
+```
+
+### Lesson
+```ruby
+# To return a collection of all available lessons
+AbsorbApi::Lesson.all
+
+# To find a single lesson by id
+AbsorbApi::Lesson.find(id)
+```
+
 ### CourseEnrollment
 ```ruby
 # To return a collection of associated lessons matching conditions

data/lib/absorb_api.rb

@@ -21,6 +21,12 @@ require "absorb_api/certificate"
 require "absorb_api/chapter"
 require "absorb_api/curriculum"
 require "absorb_api/department"
+require "absorb_api/tag"
+require "absorb_api/session_schedule"
+require "absorb_api/role"
+require "absorb_api/resource"
+require "absorb_api/prerequisite"
+require "absorb_api/lesson"
 
 module AbsorbApi
 end

data/lib/absorb_api/course.rb

@@ -7,7 +7,10 @@ module AbsorbApi
     has_many :certificates
     has_many :chapters
     has_many :enrollments, :course_enrollment
-
+    has_many :resources
+    has_many :prerequisites
+    has_many :lessons
+    
     # gets all associated enrollments given a collection of courses
     # all calls are called in parallel
     def self.enrollments_from_collection(courses, **conditions)

data/lib/absorb_api/lesson.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class Lesson < Base
+    attr_accessor :id, :chapter_id, :name, :description, :notes, :type, :width, :height, :url, :use_popup, :passing_score, :weight, :ref_id
+  end
+end

data/lib/absorb_api/orm.rb

@@ -10,13 +10,21 @@ module AbsorbApi
       def find(id)
         raise ResourceNotFound if id.blank?
         response = Base.api.get("#{to_s.demodulize.pluralize}/#{id}")
-        response.status == 404 ? raise(ResourceNotFound) : new(response.body)
+        if response.status == 404
+          raise(RouteNotFound)
+        elsif response.status == 400
+          raise ResourceNotFound
+        else
+          new(response.body)
+        end
       end
 
       def all
         response = Base.api.get("#{to_s.demodulize.pluralize}")
         if response.status == 404
           raise RouteNotFound
+        elsif response.status == 400
+          raise ResourceNotFound
         else
           Collection.new( response.body.map! do |attributes|
             new(attributes)

data/lib/absorb_api/prerequisite.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class Prerequisite < Base
+    attr_accessor :id, :name, :required_number, :prerequisite_type, :course_ids, :competency_definition_ids
+  end
+end

data/lib/absorb_api/resource.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class Resource < Base
+    attr_accessor :id, :name, :file, :module_id
+  end
+end

data/lib/absorb_api/role.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class Role < Base
+    attr_accessor :id, :name, :description
+  end
+end

data/lib/absorb_api/session_schedule.rb

@@ -0,0 +1,5 @@
+module AbsorbApi
+  class SessionSchedule < Base
+    attr_accessor :id, :session_id, :venue_id, :venue_type, :venue_name, :date_start, :date_end, :time_zone_id, :meeting_id, :meeting_username, :meeting_password
+  end
+end

data/lib/absorb_api/tag.rb

@@ -0,0 +1,7 @@
+module AbsorbApi
+  class Tag < Base
+    include Relations
+    
+    attr_accessor :id, :name
+  end
+end

data/lib/absorb_api/user.rb

@@ -7,7 +7,8 @@ module AbsorbApi
     has_many :courses
     has_many :enrollments, klass: :course_enrollment
     has_many :certificates
-
+    has_many :resources
+    
     # gets all associated courses given a collection of users
     # all calls are called in parallel
     # users are chunked in groups of 105 to keep typhoeus from getting bogged down

data/lib/absorb_api/version.rb

@@ -1,3 +1,3 @@
 module AbsorbApi
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: absorb_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - npezza
@@ -135,9 +135,15 @@ files:
 - lib/absorb_api/course_enrollment.rb
 - lib/absorb_api/curriculum.rb
 - lib/absorb_api/department.rb
+- lib/absorb_api/lesson.rb
 - lib/absorb_api/lesson_enrollment.rb
 - lib/absorb_api/orm.rb
+- lib/absorb_api/prerequisite.rb
 - lib/absorb_api/relations.rb
+- lib/absorb_api/resource.rb
+- lib/absorb_api/role.rb
+- lib/absorb_api/session_schedule.rb
+- lib/absorb_api/tag.rb
 - lib/absorb_api/user.rb
 - lib/absorb_api/version.rb
 homepage: https://github.com/npezza93/absorb_api