clever 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '090aa2a5761f72e7e462c3357ddaf259dd0f6c81'
-  data.tar.gz: b16b89f8e7b208e2dcddd4be8638cd0ea557951e
+  metadata.gz: ae0e8318fdecf7c7c7165bef8c0ac88051f66d18
+  data.tar.gz: d3d7ae47d72ca7535fa478f4ff5f29dc97b0b192
 SHA512:
-  metadata.gz: b75c8494f7899b7f6b7027d24c77586e2cbd704240d86decba941fb3acbebf36c1420f4f377698a65d0f0746e84733be0211b29c28849140ed30acf577b70067
-  data.tar.gz: a0179bba8d24cbeab7b13d10750a826aadd144c98281c33e2ca3091bc11888177f11091855e0e534de8bcb220966bf25bb0b0e1199019eca89f8fc3bb0dad8e2
+  metadata.gz: 3041336d755fecb6fc2860439c6bc2b9f94e5bbef769647a0fd767587ac3a9eabda9db14311178920aca7edcd5ef2b5e3ac0c52e93630fc8d0a621a6a8394301
+  data.tar.gz: d043aa91dabd5b5e0044cfdd396bbae6f846776e2e126db85ef70b4afb04e6256aad7e4630ff0541c55fd60167d30f8cd82548175dd1e7162753ede4c31db067

data/Gemfile.lock

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

data/lib/clever.rb

@@ -21,14 +21,14 @@ 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'
   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
 
@@ -136,7 +136,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/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   = attributes['grade']
-        @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,52 @@ 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
+
+      def initialize(attributes = {}, *, client: nil)
+        @district_username = attributes.dig('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['sis_id']
+        @uid               = attributes['id']
+        @username          = username(client)
+      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.1.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday