clever 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba04605f8dd24c5294e0ad902c29df9296ce14e1
-  data.tar.gz: 275fecc1abefb5af4a08d146b38eca3acc24602a
+  metadata.gz: 86d6af37efac719fa831d86a65862a402eb5af65
+  data.tar.gz: 46c1a1e4142338704353295934719e109b09e28f
 SHA512:
-  metadata.gz: a336127ba0c65de367f9ed9a027ab71baa411baf0ee2302e105a475665035d1a6ec9da5cbe1680adc6280acfacf2ae7ac9c8ec28b52837610a39cadacfbd5810
-  data.tar.gz: 1eea6ee645d14b4410dcab268a4508a23200faf724f77467c61822ba8a904e994f11871a39fefe3cc25bd1c633f0c45635aeb9c5676ec55fb6cb13c4fbec7134
+  metadata.gz: e21034624a92171120aa45364bbdc347696c5a65377907703c1297ddf94ee06638884f9d8ba02b2ff2bb133e40947135322c3391207448a114769c483b6e6615
+  data.tar.gz: 41d92685a37b57957ea89584ea60daa52950dfde939529d32daab129352c2e4f3a43ca6caa09debbbb8e71842b0cc6efbfb4f787a99c32cbe460ced858097197

data/Gemfile.lock

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

data/lib/clever.rb

@@ -17,21 +17,23 @@ require 'clever/types/event'
 require 'clever/types/student'
 require 'clever/types/section'
 require 'clever/types/teacher'
-require 'clever/types/admin'
+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/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'
-  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'
+  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
@@ -54,7 +54,7 @@ module Clever
       Paginator.fetch(connection, endpoint, :get, Types::Event, client: self).force
     end
 
-    %i(students courses teachers admins sections terms).each do |record_type|
+    %i(students courses teachers sections terms).each do |record_type|
       define_method(record_type) do |record_uids = []|
         authenticate
 
@@ -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/{admin.rb → district_admin.rb}

@@ -2,7 +2,7 @@
 
 module Clever
   module Types
-    class Admin < Teacher
+    class DistrictAdmin < Teacher
       def initialize(attributes = {}, *, client: nil)
         @district_username = attributes.dig('roles', 'district_admin', 'credentials', 'district_username')
         @email             = attributes['email']

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,12 +192,13 @@ 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
+- 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