clever 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae0e8318fdecf7c7c7165bef8c0ac88051f66d18
-  data.tar.gz: d3d7ae47d72ca7535fa478f4ff5f29dc97b0b192
+  metadata.gz: 77dbd6fdbbf2b13bdf7d7011c19f03d90db8ab4e
+  data.tar.gz: c98d3ea989e3c3cdfd0bd8114a412965c232c586
 SHA512:
-  metadata.gz: 3041336d755fecb6fc2860439c6bc2b9f94e5bbef769647a0fd767587ac3a9eabda9db14311178920aca7edcd5ef2b5e3ac0c52e93630fc8d0a621a6a8394301
-  data.tar.gz: d043aa91dabd5b5e0044cfdd396bbae6f846776e2e126db85ef70b4afb04e6256aad7e4630ff0541c55fd60167d30f8cd82548175dd1e7162753ede4c31db067
+  metadata.gz: 36c9a1621dedd554ff8959ec6f4477baa48a5832dde56fd4d64201fdb5bca3d8b02d502f443beff52978908164e9286b4897cc5aa546cf5b4f153764a381cf5e
+  data.tar.gz: 8de9b79585e796b400544747294ddbd4fd23e1688df9875497270004b80c988d6745147556ca23eb70c0b729c5c85f5a7d143b131ed173779220cd8c9c03810d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clever (3.0.0)
+    clever (3.1.0)
       faraday
       faraday_middleware
 

data/lib/clever.rb

@@ -17,6 +17,7 @@ require 'clever/types/event'
 require 'clever/types/student'
 require 'clever/types/section'
 require 'clever/types/teacher'
+require 'clever/types/admin'
 require 'clever/types/term'
 require 'clever/types/token'
 
@@ -26,7 +27,8 @@ module Clever
   STUDENTS_ENDPOINT = '/v3.0/users?role=student'
   COURSES_ENDPOINT  = '/v3.0/courses'
   SECTIONS_ENDPOINT = '/v3.0/sections'
-  TEACHERS_ENDPOINT = '/v3.0/users'
+  TEACHERS_ENDPOINT = '/v3.0/users?role=teacher'
+  ADMINS_ENDPOINT   = '/v3.0/users?role=district_admin'
   EVENTS_ENDPOINT   = '/v1.2/events'
   TERMS_ENDPOINT    = '/v3.0/terms'
   GRADES_ENDPOINT   = 'https://grades-api.beta.clever.com/v1/grade'

data/lib/clever/client.rb

@@ -54,7 +54,7 @@ module Clever
       Paginator.fetch(connection, endpoint, :get, Types::Event, client: self).force
     end
 
-    %i(students courses teachers sections terms).each do |record_type|
+    %i(students courses sections terms).each do |record_type|
       define_method(record_type) do |record_uids = []|
         authenticate
 
@@ -69,6 +69,19 @@ module Clever
       end
     end
 
+    def teachers(record_uids = [])
+      authenticate
+
+      teachers = Paginator.fetch(connection, Clever::TEACHERS_ENDPOINT, :get, Types::Teacher, client: self).force
+      admins = Paginator.fetch(connection, Clever::ADMINS_ENDPOINT, :get, Types::Admin, client: self).force
+
+      records = (admins + teachers).uniq(&:uid)
+
+      return records if record_uids.empty?
+
+      records.select { |record| record_uids.to_set.include?(record.uid) }
+    end
+
     # discard params to make the API behave the same as the one roster gem
     def classrooms(*)
       authenticate

data/lib/clever/types/admin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Admin < Teacher
+      def initialize(attributes = {}, *, client: nil)
+        @district_username = attributes.dig('roles', 'district_admin', 'credentials', 'district_username')
+        @email             = attributes['email']
+        @first_name        = attributes['name']['first']
+        @last_name         = attributes['name']['last']
+        @legacy_id         = attributes.dig('roles', 'district_admin', 'legacy_id')
+        @provider          = 'clever'
+        @sis_id            = attributes.dig('roles', 'district_admin', 'credentials', 'sis_id')
+        @uid               = attributes['id']
+        @username          = username(client)
+        @role              = 'admin'
+      end
+    end
+  end
+end

data/lib/clever/types/teacher.rb

@@ -8,18 +8,20 @@ module Clever
                   :first_name,
                   :last_name,
                   :provider,
-                  :legacy_id
+                  :legacy_id,
+                  :role
 
       def initialize(attributes = {}, *, client: nil)
-        @district_username = attributes.dig('credentials', 'district_username')
+        @district_username = attributes.dig('roles', 'teacher', 'credentials', 'district_username')
         @email             = attributes['email']
         @first_name        = attributes['name']['first']
         @last_name         = attributes['name']['last']
         @legacy_id         = attributes.dig('roles', 'teacher', 'legacy_id')
         @provider          = 'clever'
-        @sis_id            = attributes['sis_id']
+        @sis_id            = attributes.dig('roles', 'teacher', 'credentials', 'sis_id')
         @uid               = attributes['id']
         @username          = username(client)
+        @role              = 'teacher'
       end
 
       def username(client = nil)

data/lib/clever/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clever
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,6 +192,7 @@ files:
 - lib/clever/connection.rb
 - lib/clever/paginator.rb
 - lib/clever/response.rb
+- lib/clever/types/admin.rb
 - lib/clever/types/base.rb
 - lib/clever/types/classroom.rb
 - lib/clever/types/course.rb