clever 3.1.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77dbd6fdbbf2b13bdf7d7011c19f03d90db8ab4e
-  data.tar.gz: c98d3ea989e3c3cdfd0bd8114a412965c232c586
+  metadata.gz: 63979f4986db64df6612124fd9ab0974cb198bab
+  data.tar.gz: 9304f5516f09faeaaaa7c107f6c531f42164ee4b
 SHA512:
-  metadata.gz: 36c9a1621dedd554ff8959ec6f4477baa48a5832dde56fd4d64201fdb5bca3d8b02d502f443beff52978908164e9286b4897cc5aa546cf5b4f153764a381cf5e
-  data.tar.gz: 8de9b79585e796b400544747294ddbd4fd23e1688df9875497270004b80c988d6745147556ca23eb70c0b729c5c85f5a7d143b131ed173779220cd8c9c03810d
+  metadata.gz: 866dd8a3c35e4a950cce8f2d5de0e854ae1890b60ae8a05d4f2b6189c37aaa0eaf8b5d5b5e217f9ae2c47b9358cd429ae1460c6b1ceef34ecd421d97c646fb77
+  data.tar.gz: 66156debf6f11613064e09645aca230d61611f98f140abf15b6b0aa324b7756b94a6d0f329a96e4d4c25b671018eac25e0910ac28bbef1ac4010a013d0216e4b

data/Gemfile.lock

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

data/lib/clever.rb

@@ -17,21 +17,25 @@ 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'
+  ME_ENDPOINT              = '/v3.0/me'
+  USER_TOKEN_ENDPOINT      = 'https://clever.com/oauth/tokens'
+  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

@@ -2,14 +2,14 @@
 
 module Clever
   class Client
-    attr_accessor :app_id, :app_token, :sync_id, :logger,
+    attr_accessor :app_id, :app_token, :sync_id, :logger, :redirect_uri,
                   :vendor_key, :vendor_secret, :username_source, :staff_username_source
 
     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
@@ -38,6 +38,22 @@ module Clever
       response
     end
 
+    def user_uid_for_code(code)
+      response = connection.execute(USER_TOKEN_ENDPOINT,
+                                    :post,
+                                    nil,
+                                    { code: code,
+                                      grant_type: 'authorization_code',
+                                      redirect_uri: redirect_uri })
+
+      fail ConnectionError, response.raw_body unless response.success?
+
+      connection.set_token(response.raw_body['access_token'])
+
+      response = connection.execute(ME_ENDPOINT, :get)
+      response&.body&.dig('id')
+    end
+
     def most_recent_event
       authenticate
 
@@ -54,7 +70,7 @@ module Clever
       Paginator.fetch(connection, endpoint, :get, Types::Event, client: self).force
     end
 
-    %i(students courses 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,17 +85,20 @@ module Clever
       end
     end
 
-    def teachers(record_uids = [])
+    def admins(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
+      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
 
-      records = (admins + teachers).uniq(&:uid)
+      admins = (district_admins + school_admins).uniq(&:uid)
 
-      return records if record_uids.empty?
+      return admins if record_uids.empty?
 
-      records.select { |record| record_uids.to_set.include?(record.uid) }
+      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

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/types/teacher.rb

@@ -37,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 = '3.1.0'
+  VERSION = '3.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.2
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-27 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