clever 2.3.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35d6eada204a0058fad8c09d0bd59a63a928255
-  data.tar.gz: 467317854d78559603c9d829899b9adc9cc20cfa
+  metadata.gz: 86d6af37efac719fa831d86a65862a402eb5af65
+  data.tar.gz: 46c1a1e4142338704353295934719e109b09e28f
 SHA512:
-  metadata.gz: 7595b689345c6a9dc347a561f7c0674ae4a82d53b436455f6ce8e5b0bfb278ac39ccb63e625ffbd052a08c291c426f810927d89c6a3c72e8723c0a071d2b9642
-  data.tar.gz: 6dc199bfa6d54d851a607cb04d52edb3c5393a5515e28c89ddf6aa6ab1790ecfd542d6405d80dfadb98152c6a7a658ebfb923f24aaacbb20026e40d7237d4e4f
+  metadata.gz: e21034624a92171120aa45364bbdc347696c5a65377907703c1297ddf94ee06638884f9d8ba02b2ff2bb133e40947135322c3391207448a114769c483b6e6615
+  data.tar.gz: 41d92685a37b57957ea89584ea60daa52950dfde939529d32daab129352c2e4f3a43ca6caa09debbbb8e71842b0cc6efbfb4f787a99c32cbe460ced858097197

data/Gemfile.lock

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

data/lib/clever.rb

@@ -17,19 +17,23 @@ require 'clever/types/event'
 require 'clever/types/student'
 require 'clever/types/section'
 require 'clever/types/teacher'
+require 'clever/types/district_admin'
+require 'clever/types/school_admin'
 require 'clever/types/term'
 require 'clever/types/token'
 
 module Clever
-  API_URL           = 'https://api.clever.com/v2.0'
-  TOKENS_ENDPOINT   = 'https://clever.com/oauth/tokens?owner_type=district'
-  STUDENTS_ENDPOINT = '/v2.0/students'
-  COURSES_ENDPOINT  = '/v2.0/courses'
-  SECTIONS_ENDPOINT = '/v2.0/sections'
-  TEACHERS_ENDPOINT = '/v2.0/teachers'
-  EVENTS_ENDPOINT   = '/v1.2/events'
-  TERMS_ENDPOINT    = '/v2.0/terms'
-  GRADES_ENDPOINT   = 'https://grades-api.beta.clever.com/v1/grade'
+  API_URL                  = 'https://api.clever.com/v3.0'
+  TOKENS_ENDPOINT          = 'https://clever.com/oauth/tokens?owner_type=district'
+  STUDENTS_ENDPOINT        = '/v3.0/users?role=student'
+  COURSES_ENDPOINT         = '/v3.0/courses'
+  SECTIONS_ENDPOINT        = '/v3.0/sections'
+  TEACHERS_ENDPOINT        = '/v3.0/users?role=teacher'
+  DISTRICT_ADMINS_ENDPOINT = '/v3.0/users?role=district_admin'
+  SCHOOL_ADMINS_ENDPOINT   = '/v3.0/users?role=staff'
+  EVENTS_ENDPOINT          = '/v1.2/events'
+  TERMS_ENDPOINT           = '/v3.0/terms'
+  GRADES_ENDPOINT          = 'https://grades-api.beta.clever.com/v1/grade'
 
   class DistrictNotFound < StandardError; end
   class ConnectionError < StandardError; end

data/lib/clever/client.rb

@@ -8,8 +8,8 @@ module Clever
     attr_reader :api_url, :tokens_endpoint
 
     def initialize
-      @api_url           = API_URL
-      @tokens_endpoint   = TOKENS_ENDPOINT
+      @api_url         = API_URL
+      @tokens_endpoint = TOKENS_ENDPOINT
     end
 
     def self.configure
@@ -69,6 +69,22 @@ module Clever
       end
     end
 
+    def admins(record_uids = [])
+      authenticate
+
+      district_admins = Paginator.fetch(connection, Clever::DISTRICT_ADMINS_ENDPOINT,
+                                        :get, Types::DistrictAdmin, client: self).force
+
+      school_admins = Paginator.fetch(connection, Clever::SCHOOL_ADMINS_ENDPOINT,
+                                      :get, Types::SchoolAdmin, client: self).force
+
+      admins = (district_admins + school_admins).uniq(&:uid)
+
+      return admins if record_uids.empty?
+
+      admins.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/district_admin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class DistrictAdmin < 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/school_admin.rb

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

data/lib/clever/types/student.rb

@@ -6,17 +6,19 @@ module Clever
       attr_reader :uid,
                   :first_name,
                   :last_name,
-                  :provider
+                  :provider,
+                  :legacy_id
 
       def initialize(attributes = {}, client: nil)
-        @uid               = attributes['id']
+        @district_username = attributes.dig('credentials', 'district_username')
+        @email             = attributes['email']
         @first_name        = attributes['name']['first']
         @last_name         = attributes['name']['last']
-        @district_username = attributes.dig('credentials', 'district_username')
+        @legacy_id         = attributes.dig('roles', 'student', 'legacy_id')
+        @provider          = 'clever'
         @sis_id            = attributes['sis_id']
-        @email             = attributes['email']
+        @uid               = attributes['id']
         @username          = username(client)
-        @provider          = 'clever'
       end
 
       def username(client = nil)

data/lib/clever/types/teacher.rb

@@ -7,17 +7,21 @@ module Clever
                   :email,
                   :first_name,
                   :last_name,
-                  :provider
+                  :provider,
+                  :legacy_id,
+                  :role
 
       def initialize(attributes = {}, *, client: nil)
-        @uid        = attributes['id']
-        @email      = attributes['email']
-        @first_name = attributes['name']['first']
-        @last_name  = attributes['name']['last']
-        @district_username = attributes.dig('credentials', 'district_username')
-        @sis_id            = attributes['sis_id']
-        @username   = username(client)
-        @provider   = 'clever'
+        @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.dig('roles', 'teacher', 'credentials', 'sis_id')
+        @uid               = attributes['id']
+        @username          = username(client)
+        @role              = 'teacher'
       end
 
       def username(client = nil)
@@ -26,6 +30,17 @@ module Clever
         @username ||= presence(username_from(username_source))
       end
 
+      def to_h
+        {
+          uid: @uid,
+          email: @email,
+          first_name: @first_name,
+          last_name: @last_name,
+          username: @username,
+          provider: @provider
+        }
+      end
+
       private
 
       def username_from(username_source)

data/lib/clever/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -195,8 +195,10 @@ files:
 - lib/clever/types/base.rb
 - lib/clever/types/classroom.rb
 - lib/clever/types/course.rb
+- lib/clever/types/district_admin.rb
 - lib/clever/types/enrollment.rb
 - lib/clever/types/event.rb
+- lib/clever/types/school_admin.rb
 - lib/clever/types/section.rb
 - lib/clever/types/student.rb
 - lib/clever/types/teacher.rb