clever 2.3.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eadea65a93fb58c3c03e4669c9eee742a4d0ca3b
-  data.tar.gz: 5cf08d8b4e9c9aa374b522e448ef867fc95db0f6
+  metadata.gz: ba04605f8dd24c5294e0ad902c29df9296ce14e1
+  data.tar.gz: 275fecc1abefb5af4a08d146b38eca3acc24602a
 SHA512:
-  metadata.gz: 8d8ba0401e1c2076e71b8e633a53d2e388a72b1e4c1bd49ac01d1792e0801002c12d743578be42ba75deacd96355f80c5a4584a49aa6e40ca50e19352de6fed5
-  data.tar.gz: 55e3247234f4b6612f6ee9dd90c16773608b5c042042e323f562446341e5f8226cdd582a98c198814a3ad36b94d3c49eb60e1fc661cb55c47ec9e324af258dad
+  metadata.gz: a336127ba0c65de367f9ed9a027ab71baa411baf0ee2302e105a475665035d1a6ec9da5cbe1680adc6280acfacf2ae7ac9c8ec28b52837610a39cadacfbd5810
+  data.tar.gz: 1eea6ee645d14b4410dcab268a4508a23200faf724f77467c61822ba8a904e994f11871a39fefe3cc25bd1c633f0c45635aeb9c5676ec55fb6cb13c4fbec7134

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clever (2.3.0)
+    clever (3.1.1)
       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 teachers admins sections terms).each do |record_type|
       define_method(record_type) do |record_uids = []|
         authenticate
 

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/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.3.0'
+  VERSION = '3.1.1'
 end

metadata

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