oneroster 2.3.6 → 2.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d6aa35d7eac60a9e611302845be1ed8072e0dca2bedd11282e6bcc23cc1dfc
-  data.tar.gz: af958aebb8a105f98eb17ab33a42cd065ced816917a76245591f01634a3909cd
+  metadata.gz: 231447994bb3bfc7fbb87334a6888270cbb99ef0e1b1a23438411a30ae7f4085
+  data.tar.gz: c03f5c959ffc3d5244bc82cbc8f969617443561efd0fdbeb0f6e04f4f14875de
 SHA512:
-  metadata.gz: 9d297d5100333fefe6749270f6e44620ad38b0dde3ae3cc399d73aa51c4c933eb9a87796262a0f6c93844dd8c71451f60964ac31a3ffff02734dc4c82287277e
-  data.tar.gz: 45d8e0c74996efe2b1e75de72a9ba57a6282ebaaf315a5bf274067a82614b935124c0aa02b9b0b0c581f53e7b2956c330cdfecb4687442e76a6969ec2e596469
+  metadata.gz: 02a8a15a2a483fb1dace9bfca0aa004201f91feed8fa2cff442d079333fb016b11656ab27e6ff814f0858bafaadc53cc1dc6f2656c5f47c36fe74d2dd36a68e6
+  data.tar.gz: a89ceb563113c819edc848960b761dfc8ae055da5fa69236be84e0d364a238d2b46b9365dae78f2bc26ba17531a2375718b9160c04ffadc38a6819501238c947

data/Gemfile.lock

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

data/lib/one_roster/client.rb

@@ -4,7 +4,7 @@ module OneRoster
   class Client
     attr_accessor :app_id, :app_token, :api_url, :token_url, :roster_app,
                   :app_secret, :logger, :vendor_key,
-                  :username_source, :oauth_strategy, :staff_username_source
+                  :username_source, :oauth_strategy, :staff_username_source, :token_content_type
 
     attr_reader :authenticated
 
@@ -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
 
@@ -134,9 +145,9 @@ module OneRoster
                             scope: 'https://purl.imsglobal.org/spec/or/v1p1/scope/roster-core.readonly' }
 
       if roster_app == 'infinite_campus'
-        connection.execute(url, :post, credential_params)
+        connection.execute(url, :post, credential_params, nil, token_content_type)
       elsif roster_app == 'synergy'
-        connection.execute(url, :post, nil, credential_params)
+        connection.execute(url, :post, nil, credential_params, token_content_type)
       else
         connection.execute(url, :post)
       end

data/lib/one_roster/connection.rb

@@ -10,8 +10,8 @@ module OneRoster
       @oauth_strategy = oauth_strategy
     end
 
-    def execute(path, method = :get, params = nil, body = nil)
-      Response.new(raw_request(path, method, params, body))
+    def execute(path, method = :get, params = nil, body = nil, content_type = nil)
+      Response.new(raw_request(path, method, params, body, content_type))
     end
 
     def set_auth_headers(token, cookie)
@@ -37,31 +37,37 @@ module OneRoster
 
     private
 
-    def raw_request(path, method, params, body)
+    def raw_request(path, method, params, body, content_type = nil)
       p "request #{path} #{params}"
 
       connection.public_send(method) do |request|
         request.options.open_timeout     = OPEN_TIMEOUT
         request.options.timeout          = TIMEOUT
         request.url path, params
-        request.headers['Content-Type']  = content_type
+        request.headers['Content-Type']  = content_type || set_content_type
         request.headers['Cookie']        = @cookie
-        request.body                     = render_body(body)
+        request.body                     = render_body(body, content_type)
       end
     end
 
-    def content_type
+    def set_content_type
       return 'application/x-www-form-urlencoded' if @client.roster_app == 'synergy'
 
       'application/json'
     end
 
-    def render_body(body)
-      return URI.encode_www_form(body) if !body.nil? && @client.roster_app == 'synergy'
+    def render_body(body, content_type)
+      return URI.encode_www_form(body) if should_encode_body?(body, content_type)
 
       body
     end
 
+    def should_encode_body?(body, content_type)
+      return false if body.nil?
+
+      @client.roster_app == 'synergy' || content_type == 'application/x-www-form-urlencoded'
+    end
+
     def oauth_connection
       Faraday.new(@client.api_url) do |connection|
         connection.request :oauth,

data/lib/one_roster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OneRoster
-  VERSION = '2.3.6'
+  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.6
+  version: 2.3.10
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-28 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