oneroster 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d91a0bad177611a68ff1df87f169e8e13e28c099
-  data.tar.gz: 0e9d6b9b88376cf28bacd10a4cad460917c6f0ca
+  metadata.gz: ac81a3a6a046beb01b2ae6d34e6ff2f373921d41
+  data.tar.gz: 35e4d0240dc30cfe9aa5bf38af83de2ab19dcb31
 SHA512:
-  metadata.gz: 6346c597c1c3017ae5e423f8f1ff5f11a1df833ad0451ee533bfd6cb57842f25c3bc8e818cbdd4a6dfd38da1b16e8a47c0835de1c6b29fac10ae8a649e70311a
-  data.tar.gz: 607d41b9292ad1533e6c7339feeae9a97b344c4dd04c77509141018e026d73797075b2d6438ddc075b3ffe76fd1b054d1ee032e93b961e2ad1b6b65322153f5d
+  metadata.gz: dcd9b28d5b6d2607fff300142b0978a97b01d0227fa0ed1f89f828bdcad656b1955b9951864afd3a7ef75277cf4312d6b121ce12e61a882376adce66d9f46f7e
+  data.tar.gz: b8bc51ac42ea3b4aa4609f6b8d999368b2b181c35006d951133c1169151a02a85a41ba1c24fc035a00263185a26d776801203a3aa27094a05d08710d23919375

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oneroster (2.0.0)
+    oneroster (2.3.1)
       dry-inflector
       faraday
       faraday_middleware

data/lib/one_roster.rb

@@ -21,19 +21,22 @@ require 'types/classroom'
 require 'types/enrollment'
 require 'types/student'
 require 'types/teacher'
+require 'types/term'
 
 module OneRoster
   class DistrictNotFound < StandardError; end
   class ConnectionError < StandardError; end
 
-  STUDENTS_ENDPOINT    = 'ims/oneroster/v1p1/students'
-  TEACHERS_ENDPOINT    = 'ims/oneroster/v1p1/teachers'
-  COURSES_ENDPOINT     = 'ims/oneroster/v1p1/courses'
-  CLASSES_ENDPOINT     = 'ims/oneroster/v1p1/classes'
-  ENROLLMENTS_ENDPOINT = 'ims/oneroster/v1p1/enrollments'
+  STUDENTS_ENDPOINT          = 'ims/oneroster/v1p1/students'
+  TEACHERS_ENDPOINT          = 'ims/oneroster/v1p1/teachers'
+  COURSES_ENDPOINT           = 'ims/oneroster/v1p1/courses'
+  CLASSES_ENDPOINT           = 'ims/oneroster/v1p1/classes'
+  ENROLLMENTS_ENDPOINT       = 'ims/oneroster/v1p1/enrollments'
+  ACADEMIC_SESSIONS_ENDPOINT = 'ims/oneroster/v1p1/academicSessions'
 
   RESPONSE_TYPE_MAP = {
     'teachers'     => 'users',
+    'academicSessions'        => 'academicSessions',
     'students'     => 'users',
     'courses'      => 'courses',
     'classes'      => 'classes',

data/lib/one_roster/client.rb

@@ -40,22 +40,40 @@ module OneRoster
 
       oneroster_classes = classes
 
+      terms_hash = terms.each_with_object({}) { |term, terms| terms[term.uid] = term }
+
       courses = courses(course_codes, oneroster_classes)
 
       oneroster_classes.each_with_object([]) do |oneroster_class, oneroster_classes|
         course = courses.find { |course| course.uid == oneroster_class.course_uid }
         next unless course
 
+        term = terms_hash[oneroster_class.term_id]
+
         oneroster_classes << Types::Classroom.new(
           'id' => oneroster_class.uid,
           'name' => oneroster_class.title,
           'course_number' => course.course_code,
           'period' => oneroster_class.period,
-          'grades' => oneroster_class.grades
+          'grades' => oneroster_class.grades,
+          'subjects' => oneroster_class.subjects,
+          'term_name' => term&.name,
+          'term_start_date' => term&.start_date,
+          'term_end_date' => term&.end_date
         )
       end
     end
 
+    def terms
+      authenticate
+
+      endpoint = OneRoster::ACADEMIC_SESSIONS_ENDPOINT
+
+      type = Types::Term
+
+      Paginator.fetch(connection, endpoint, :get, type, client: self).force
+    end
+
     def courses(course_codes = [], oneroster_classes = classes)
       authenticate
 

data/lib/one_roster/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneRoster
   class Response
     attr_reader :status, :raw_body, :headers

data/lib/one_roster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OneRoster
-  VERSION = '2.0.0'
+  VERSION = '2.3.1'
 end

data/lib/types/class.rb

@@ -8,7 +8,9 @@ module OneRoster
                   :course_uid,
                   :provider,
                   :period,
-                  :grades
+                  :grades,
+                  :subjects,
+                  :term_id
 
       def initialize(attributes = {}, *)
         @uid        = attributes['sourcedId']
@@ -16,7 +18,9 @@ module OneRoster
         @course_uid = attributes['course']['sourcedId']
         @status     = attributes['status']
         @period     = first_period(attributes) || period_from_code(attributes)
-        @grades     = attributes['grades']
+        @grades     = presence(attributes['grades']) || []
+        @subjects   = presence(attributes['subjects']) || []
+        @term_id    = attributes.dig('terms', 0, 'sourcedId')
         @provider   = 'oneroster'
       end
 
@@ -33,6 +37,14 @@ module OneRoster
       def period_from_code(attributes)
         attributes['classCode']&.match(/- Period (\d+) -/) { |m| m[1] }
       end
+
+      def presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
+      end
     end
   end
 end

data/lib/types/classroom.rb

@@ -8,15 +8,23 @@ module OneRoster
                   :course_number,
                   :period,
                   :grades,
-                  :provider
+                  :subjects,
+                  :provider,
+                  :term_name,
+                  :term_start_date,
+                  :term_end_date
 
       def initialize(attributes = {})
-        @uid           = attributes['id']
-        @name          = attributes['name']
-        @course_number = attributes['course_number']
-        @period        = attributes['period']
-        @grades        = attributes['grades']
-        @provider      = 'oneroster'
+        @uid             = attributes['id']
+        @name            = attributes['name']
+        @course_number   = attributes['course_number']
+        @period          = attributes['period']
+        @grades          = attributes['grades']
+        @subjects        = attributes['subjects']
+        @term_name       = attributes['term_name']
+        @term_start_date = attributes['term_start_date']
+        @term_end_date   = attributes['term_end_date']
+        @provider        = 'oneroster'
       end
     end
   end

data/lib/types/enrollment.rb

@@ -25,7 +25,7 @@ module OneRoster
         teacher?
       end
 
-      def primary_teacher?
+      def primary
         teacher? && @primary.to_s == 'true'
       end
 
@@ -41,6 +41,7 @@ module OneRoster
         {
           classroom_uid: @classroom_uid,
           user_uid: @user_uid,
+          primary: primary,
           provider: @provider
         }
       end

data/lib/types/term.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class Term < Base
+      attr_reader :uid,
+                  :name,
+                  :start_date,
+                  :end_date
+
+      def initialize(attributes = {}, *)
+        @uid        = attributes['sourcedId']
+        @name       = attributes['title']
+        @start_date = attributes['startDate']
+        @end_date   = attributes['endDate']
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneroster
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -243,6 +243,7 @@ files:
 - lib/types/enrollment.rb
 - lib/types/student.rb
 - lib/types/teacher.rb
+- lib/types/term.rb
 - one_roster.gemspec
 homepage: https://github.com/TCI/oneroster
 licenses: