oneroster 2.3.19 → 2.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131516e529d174e5a500c33ce48f40b09da2451bcb8ef3650f1cc01df51f36d0
-  data.tar.gz: 3b584a578567e3108f68b8a42e34b6c28f3b1f905a6a6d2ebb0cf45b351391ea
+  metadata.gz: ac0acbc4043d8a4f9c27923592085c6dfdbcdccf982739a331514ed9dec4469a
+  data.tar.gz: 91d63689995e7b37a0c9814c2ebbacbd42c3d44d4e02b8502e28d8ae21c5d874
 SHA512:
-  metadata.gz: 66659d99147c0c9e970e29a878113353f6b39cc1b659cf1552785a180a47f1274d51fe36de5d93ef72b1a2e534377aa599d8ca3f6549823d8df6f8d9f6af3f76
-  data.tar.gz: e7eb26ca869db7c12e1abc01f72572b7016ef6c50c33f256e5b9f257ac326019fd7e1a9c9a24a69ffec4ba323de49aeb80ad5b259ed039c7625a3467c086d8cd
+  metadata.gz: 6516b3419a838c610b88324b9c0692241565714326b6b30efe65616c6684fce7db7c6b470bfaba1d56ca3edd2aa061a7053cd7edd3ada5ebd20ef04cd9e5402a
+  data.tar.gz: 83c434b84756bc076b089289f6ae7d1f4c6644c0f9730663f47985b3e493120e5c5ec9ccac703dac6ac562b01f5d68d8e30f7e1ea6b9ca3aeca7e2290f0cffa6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oneroster (2.3.19)
+    oneroster (2.3.20)
       dry-inflector (~> 1.0.0)
       faraday
       faraday_middleware

data/lib/one_roster/client.rb

@@ -48,10 +48,18 @@ module OneRoster
       records.select { |record| record_uids_set.include?(record.uid) }
     end
 
+    def schools
+      authenticate
+
+      Paginator.fetch(connection, SCHOOLS_ENDPOINT,
+                      :get, Types::School, client: self).force
+    end
+
     def classrooms(course_codes = [])
       authenticate
 
       oneroster_classes = classes
+      fetched_schools = schools
 
       terms_hash = terms.each_with_object({}) { |term, terms| terms[term.uid] = term }
 
@@ -62,6 +70,7 @@ module OneRoster
         next unless course
 
         term = terms_hash[oneroster_class.term_id&.first]
+        school = fetched_schools.find { |school| school.uid == oneroster_class.school_uid }
 
         oneroster_classes << Types::Classroom.new(
           'id' => oneroster_class.uid,
@@ -73,7 +82,9 @@ module OneRoster
           'term_name' => term&.name,
           'term_start_date' => term&.start_date,
           'term_end_date' => term&.end_date,
-          'term_id' => oneroster_class.term_id
+          'term_id' => oneroster_class.term_id,
+          'school_name' => school&.name,
+          'school_uid' => school&.uid
         )
       end
     end

data/lib/one_roster/version.rb

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

data/lib/one_roster.rb

@@ -23,6 +23,7 @@ require 'types/student'
 require 'types/teacher'
 require 'types/term'
 require 'types/admin'
+require 'types/school'
 
 module OneRoster
   class DistrictNotFound < StandardError; end
@@ -35,6 +36,7 @@ module OneRoster
   CLASSES_ENDPOINT           = 'ims/oneroster/v1p1/classes'
   ENROLLMENTS_ENDPOINT       = 'ims/oneroster/v1p1/enrollments'
   ACADEMIC_SESSIONS_ENDPOINT = 'ims/oneroster/v1p1/academicSessions'
+  SCHOOLS_ENDPOINT           = 'ims/oneroster/v1p1/schools'
 
   RESPONSE_TYPE_MAP = {
     'users'            => 'users',
@@ -43,6 +45,7 @@ module OneRoster
     'academicSessions' => 'academicSessions',
     'courses'          => 'courses',
     'classes'          => 'classes',
-    'enrollments'      => 'enrollments'
+    'enrollments'      => 'enrollments',
+    'schools'          => 'orgs'
   }.freeze
 end

data/lib/types/class.rb

@@ -10,7 +10,8 @@ module OneRoster
                   :period,
                   :grades,
                   :subjects,
-                  :term_id
+                  :term_id,
+                  :school_uid
 
       def initialize(attributes = {}, *)
         @uid        = attributes['sourcedId']
@@ -21,6 +22,7 @@ module OneRoster
         @grades     = presence(attributes['grades']) || []
         @subjects   = presence(attributes['subjects']) || []
         @term_id    = attributes.dig('terms')&.map { |term| term['sourcedId'] } || []
+        @school_uid = attributes.dig('school', 'sourcedId')
         @provider   = 'oneroster'
       end
 

data/lib/types/classroom.rb

@@ -13,7 +13,9 @@ module OneRoster
                   :term_name,
                   :term_start_date,
                   :term_end_date,
-                  :term_id
+                  :term_id,
+                  :school_name,
+                  :school_uid
 
       def initialize(attributes = {})
         @uid             = attributes['id']
@@ -26,6 +28,8 @@ module OneRoster
         @term_start_date = attributes['term_start_date']
         @term_end_date   = attributes['term_end_date']
         @term_id         = attributes['term_id']
+        @school_name     = attributes['school_name']
+        @school_uid      = attributes['school_uid']
         @provider        = 'oneroster'
       end
     end

data/lib/types/school.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class School
+      attr_reader :uid, :name, :number
+
+      def initialize(attributes = {}, *)
+        @uid      = attributes['sourcedId']
+        @name     = attributes['name']
+        @number   = attributes['identifier']
+        @provider = 'oneroster'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneroster
 version: !ruby/object:Gem::Version
-  version: 2.3.19
+  version: 2.3.20
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -218,7 +218,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-style.yml"
-- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -241,6 +241,7 @@ files:
 - lib/types/classroom.rb
 - lib/types/course.rb
 - lib/types/enrollment.rb
+- lib/types/school.rb
 - lib/types/student.rb
 - lib/types/teacher.rb
 - lib/types/term.rb

data/.ruby-version

@@ -1 +0,0 @@
-2.4.1