clever 2.3.2 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ff0b41f8f5609493aaf2935de074f048f4deb32
-  data.tar.gz: 0630556066c95480e23759940dc631369deef2e9
+  metadata.gz: 5b544d8d4b80be8cd0b754f657c7ccfbeec9f2a4
+  data.tar.gz: 19e063bfda75ad232871c9564958d403b8f41e83
 SHA512:
-  metadata.gz: c469ccfd3a5e2eef2575686cd2704822cba36532a458b9910e87bbb908ce6df7cce0ab58acf78fe5afb92902706920d3cdaa3ca22ab2e8e65934dec7e4a34e61
-  data.tar.gz: dbb555be80c9b63fc4c2d1600dd0e6906a36a1c69de88817c92eed90904a2d219fb3c4501c7548c3fb1226526aab75ab06abfc67eb7e80c690399fbefd528a44
+  metadata.gz: 0754506c3b777034448ccbbc520eeb2ccaaca7501ffc239635662a24777a274aa62fe93d174c84f71adeafaaa6adc113e3fdd826b5aab50d2d2e195d83e66935
+  data.tar.gz: ca941ccd1a012dfa5727ba6535b755db11672a74a804764953a6007233f150b3fe4bae876c2f9022e843d13ee85aa07ce9d1c874ab65a7539849ee67eadbe881

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clever (2.3.2)
+    clever (3.2.1)
       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)
@@ -33,7 +37,8 @@ module Clever
           first_name: @first_name,
           last_name: @last_name,
           username: @username,
-          provider: @provider
+          provider: @provider,
+          legacy_id: @legacy_id
         }
       end
 

data/lib/clever/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 3.2.1
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-06-10 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