clever 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31937aa6d83d7456eac854bd077475ddf5d39299
-  data.tar.gz: 77406af9971e86d2044dee2fb97f39d26b5fc77e
+  metadata.gz: 77dbd6fdbbf2b13bdf7d7011c19f03d90db8ab4e
+  data.tar.gz: c98d3ea989e3c3cdfd0bd8114a412965c232c586
 SHA512:
-  metadata.gz: fd292670c55b4206b3ba68dc009e79084e9eb6d601e2179d9a0b6f499542892a4ea470ec789dfb4f0aa244c85e0d5e06f49b1001a6ef92a8ee072c9fd7e67bda
-  data.tar.gz: feea3b0b8dbd0e131bdfd1243425e924850a683c8f86e873b46d06b2f26f50e41abfda429c336440d587ea2a55f76487d40aa3c117b2d24653dd2c8823c71509
+  metadata.gz: 36c9a1621dedd554ff8959ec6f4477baa48a5832dde56fd4d64201fdb5bca3d8b02d502f443beff52978908164e9286b4897cc5aa546cf5b4f153764a381cf5e
+  data.tar.gz: 8de9b79585e796b400544747294ddbd4fd23e1688df9875497270004b80c988d6745147556ca23eb70c0b729c5c85f5a7d143b131ed173779220cd8c9c03810d

data/Gemfile.lock

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

data/lib/clever.rb

@@ -17,18 +17,20 @@ 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'
 
 module Clever
-  API_URL           = 'https://api.clever.com/v2.0'
+  API_URL           = 'https://api.clever.com/v3.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'
+  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    = '/v2.0/terms'
+  TERMS_ENDPOINT    = '/v3.0/terms'
   GRADES_ENDPOINT   = 'https://grades-api.beta.clever.com/v1/grade'
 
   class DistrictNotFound < StandardError; end

data/lib/clever/client.rb

@@ -3,7 +3,7 @@
 module Clever
   class Client
     attr_accessor :app_id, :app_token, :sync_id, :logger,
-                  :vendor_key, :vendor_secret, :username_source
+                  :vendor_key, :vendor_secret, :username_source, :staff_username_source
 
     attr_reader :api_url, :tokens_endpoint
 
@@ -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
@@ -136,7 +149,8 @@ module Clever
       section.teachers.each do |teacher_uid|
         enrollments[:teacher] << Types::Enrollment.new(
           'classroom_uid' => section.uid,
-          'user_uid' => teacher_uid
+          'user_uid' => teacher_uid,
+          'primary' => section.primary_teacher_uid == teacher_uid
         )
       end
     end

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

@@ -5,12 +5,14 @@ module Clever
     class Enrollment < Base
       attr_reader :classroom_uid,
                   :user_uid,
-                  :provider
+                  :provider,
+                  :primary
 
       def initialize(attributes = {})
-        @classroom_uid = attributes['classroom_uid']
-        @user_uid      = attributes['user_uid']
-        @provider      = 'clever'
+        @classroom_uid   = attributes['classroom_uid']
+        @user_uid        = attributes['user_uid']
+        @provider        = 'clever'
+        @primary         = attributes.dig('primary') || false
       end
     end
   end

data/lib/clever/types/section.rb

@@ -12,19 +12,21 @@ module Clever
                   :students,
                   :teachers,
                   :term_id,
-                  :provider
+                  :provider,
+                  :primary_teacher_uid
 
       def initialize(attributes = {}, *)
-        @uid      = attributes['id']
-        @name     = attributes['name']
-        @period   = attributes['period']
-        @course   = attributes['course']
-        @grades   = [presence(attributes['grade'])].compact
-        @subjects = [presence(attributes['subject'])].compact
-        @students = attributes['students']
-        @teachers = attributes['teachers']
-        @term_id  = attributes['term_id']
-        @provider = 'clever'
+        @uid                 = attributes['id']
+        @name                = attributes['name']
+        @period              = attributes['period']
+        @course              = attributes['course']
+        @grades              = [presence(attributes['grade'])].compact
+        @subjects            = [presence(attributes['subject'])].compact
+        @students            = attributes['students']
+        @teachers            = attributes['teachers']
+        @term_id             =  attributes['term_id']
+        @provider            = 'clever'
+        @primary_teacher_uid = attributes['teacher']
       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,14 +7,54 @@ module Clever
                   :email,
                   :first_name,
                   :last_name,
-                  :provider
-
-      def initialize(attributes = {}, *)
-        @uid        = attributes['id']
-        @email      = attributes['email']
-        @first_name = attributes['name']['first']
-        @last_name  = attributes['name']['last']
-        @provider   = 'clever'
+                  :provider,
+                  :legacy_id,
+                  :role
+
+      def initialize(attributes = {}, *, client: nil)
+        @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)
+        username_source = client&.staff_username_source
+
+        @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)
+        return if blank?(username_source)
+
+        presence(instance_variable_get("@#{username_source}"))
+      end
+
+      def presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
       end
     end
   end

data/lib/clever/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-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