oneroster 2.3.9 → 2.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d5e334a53e3d8a02137968318000bdaf7604a02a54291b7fd334552893ec5d
-  data.tar.gz: 94a198a0065ce9c615824acf25f4326fe7159b9a87b397aca640a48df6c3df81
+  metadata.gz: 231447994bb3bfc7fbb87334a6888270cbb99ef0e1b1a23438411a30ae7f4085
+  data.tar.gz: c03f5c959ffc3d5244bc82cbc8f969617443561efd0fdbeb0f6e04f4f14875de
 SHA512:
-  metadata.gz: 2528744a79bf3570e061d9c6c1f81345428be201f9d6b1dd79bfa649ea5b55f6a010f575df8e29ff944ed172be6a5a2983aaad95233ba687844aad88df45ea46
-  data.tar.gz: dc653c3c64ed67ed9546b9be9ba6e00b104829656fcde796d6be43a37c731de6eaaaa1ab50adf361f8bfb5fd28f30dd910eb8286d1bb5a087e2dc4ad0de6b852
+  metadata.gz: 02a8a15a2a483fb1dace9bfca0aa004201f91feed8fa2cff442d079333fb016b11656ab27e6ff814f0858bafaadc53cc1dc6f2656c5f47c36fe74d2dd36a68e6
+  data.tar.gz: a89ceb563113c819edc848960b761dfc8ae055da5fa69236be84e0d364a238d2b46b9365dae78f2bc26ba17531a2375718b9160c04ffadc38a6819501238c947

data/Gemfile.lock

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

data/lib/one_roster/client.rb

@@ -36,6 +36,17 @@ module OneRoster
       end
     end
 
+    def admins(record_uids = [])
+      authenticate
+
+      records = Paginator.fetch(connection, ADMINS_ENDPOINT, :get, Admin, client: self).force
+
+      return records if record_uids.empty?
+
+      record_uids_set = record_uids.to_set
+      records.select { |record| record_uids_set.include?(record.uid) }
+    end
+
     def classrooms(course_codes = [])
       authenticate
 

data/lib/one_roster/version.rb

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

data/lib/one_roster.rb

@@ -29,17 +29,19 @@ module OneRoster
 
   STUDENTS_ENDPOINT          = 'ims/oneroster/v1p1/students'
   TEACHERS_ENDPOINT          = 'ims/oneroster/v1p1/teachers'
+  ADMINS_ENDPOINT            = "ims/oneroster/v1p1/users?filter=role='administrator'"
   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',
-    'enrollments'  => 'enrollments'
+    'users'            => 'users',
+    'teachers'         => 'users',
+    'students'         => 'users',
+    'academicSessions' => 'academicSessions',
+    'courses'          => 'courses',
+    'classes'          => 'classes',
+    'enrollments'      => 'enrollments'
   }.freeze
 end

data/lib/types/admin.rb

@@ -0,0 +1,16 @@
+module OneRoster
+  module Types
+    class Admin < Teacher
+      def initialize(attributes = {}, *, client: nil)
+        @uid          = attributes['sourcedId']
+        @email        = attributes['email']
+        @first_name   = attributes['givenName']
+        @last_name    = attributes['familyName']
+        @api_username = attributes['username']
+        @username     = username(client)
+        @provider     = 'oneroster'
+        @role         = 'admin'
+      end
+    end
+  end
+end

data/lib/types/teacher.rb

@@ -17,6 +17,7 @@ module OneRoster
         @api_username = attributes['username']
         @username     = username(client)
         @provider     = 'oneroster'
+        @role         = 'teacher'
       end
 
       def username(client = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneroster
 version: !ruby/object:Gem::Version
-  version: 2.3.9
+  version: 2.3.10
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -235,6 +235,7 @@ files:
 - lib/one_roster/paginator.rb
 - lib/one_roster/response.rb
 - lib/one_roster/version.rb
+- lib/types/admin.rb
 - lib/types/application.rb
 - lib/types/base.rb
 - lib/types/class.rb