clever 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c69433963fc1da84ed7e47f2d3193bc40d731a4
-  data.tar.gz: 8642226c4912d92db027a46bc12d47abb8630f7e
+  metadata.gz: c35d6eada204a0058fad8c09d0bd59a63a928255
+  data.tar.gz: 467317854d78559603c9d829899b9adc9cc20cfa
 SHA512:
-  metadata.gz: 950c9c78c29684ecf22d9f46dde4e06dd3de6b3888b08910b2b27c6b5dada759225a9e71e8d8938d78adfc4ccdb15dc6e0b4f2823d535d280ea4b94a6b9eec23
-  data.tar.gz: b0f14d5cecb65e02cd1723da7ab9a99c843a27efa9fc50b10c0be69909514ed29610303c7acf6521813bf53732a7630930d1720caa3fa4a7b50adc75ab60fb63
+  metadata.gz: 7595b689345c6a9dc347a561f7c0674ae4a82d53b436455f6ce8e5b0bfb278ac39ccb63e625ffbd052a08c291c426f810927d89c6a3c72e8723c0a071d2b9642
+  data.tar.gz: 6dc199bfa6d54d851a607cb04d52edb3c5393a5515e28c89ddf6aa6ab1790ecfd542d6405d80dfadb98152c6a7a658ebfb923f24aaacbb20026e40d7237d4e4f

data/Gemfile.lock

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

data/lib/clever.rb

@@ -17,6 +17,7 @@ require 'clever/types/event'
 require 'clever/types/student'
 require 'clever/types/section'
 require 'clever/types/teacher'
+require 'clever/types/term'
 require 'clever/types/token'
 
 module Clever
@@ -27,6 +28,7 @@ module Clever
   SECTIONS_ENDPOINT = '/v2.0/sections'
   TEACHERS_ENDPOINT = '/v2.0/teachers'
   EVENTS_ENDPOINT   = '/v1.2/events'
+  TERMS_ENDPOINT    = '/v2.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).each do |record_type|
+    %i(students courses teachers sections terms).each do |record_type|
       define_method(record_type) do |record_uids = []|
         authenticate
 
@@ -75,14 +75,21 @@ module Clever
 
       fetched_courses = courses
 
+      terms_hash = terms.each_with_object({}) { |term, terms| terms[term.uid] = term  }
+
       sections.map do |section|
         course = fetched_courses.find { |clever_course| clever_course.uid == section.course }
+        term = terms_hash[section.term_id]
         Types::Classroom.new(
           'id' => section.uid,
           'name' => section.name,
           'period' => section.period,
           'course_number' => course&.number,
-          'grades' => section.grades
+          'grades' => section.grades,
+          'subjects' => section.subjects,
+          'term_name' => term&.name,
+          'term_start_date' => term&.start_date,
+          'term_end_date' => term&.end_date
         )
       end
     end
@@ -129,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/base.rb

@@ -10,6 +10,14 @@ module Clever
           variables[key] = value
         end
       end
+
+      def presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
+      end
     end
   end
 end

data/lib/clever/types/classroom.rb

@@ -8,15 +8,23 @@ module Clever
                   :period,
                   :course_number,
                   :grades,
-                  :provider
+                  :subjects,
+                  :provider,
+                  :term_name,
+                  :term_start_date,
+                  :term_end_date
 
       def initialize(attributes = {}, *)
-        @uid           = attributes['id']
-        @name          = attributes['name']
-        @period        = attributes['period']
-        @course_number = attributes['course_number']
-        @grades        = attributes['grades']
-        @provider      = 'clever'
+        @uid             = attributes['id']
+        @name            = attributes['name']
+        @period          = attributes['period']
+        @course_number   = attributes['course_number']
+        @grades          = attributes['grades']
+        @subjects        = attributes['subjects']
+        @term_name       = attributes['term_name']
+        @term_start_date = attributes['term_start_date']
+        @term_end_date   = attributes['term_end_date']
+        @provider        = 'clever'
       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

@@ -8,19 +8,25 @@ module Clever
                   :period,
                   :course,
                   :grades,
+                  :subjects,
                   :students,
                   :teachers,
-                  :provider
+                  :term_id,
+                  :provider,
+                  :primary_teacher_uid
 
       def initialize(attributes = {}, *)
-        @uid      = attributes['id']
-        @name     = attributes['name']
-        @period   = attributes['period']
-        @course   = attributes['course']
-        @grades   = attributes['grade']
-        @students = attributes['students']
-        @teachers = attributes['teachers']
-        @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

@@ -37,14 +37,6 @@ module Clever
 
       private
 
-      def presence(field)
-        field unless blank?(field)
-      end
-
-      def blank?(field)
-        field.nil? || field == ''
-      end
-
       def username_from(username_source)
         return if blank?(username_source)
 

data/lib/clever/types/teacher.rb

@@ -9,13 +9,38 @@ module Clever
                   :last_name,
                   :provider
 
-      def initialize(attributes = {}, *)
+      def initialize(attributes = {}, *, client: nil)
         @uid        = attributes['id']
         @email      = attributes['email']
         @first_name = attributes['name']['first']
         @last_name  = attributes['name']['last']
+        @district_username = attributes.dig('credentials', 'district_username')
+        @sis_id            = attributes['sis_id']
+        @username   = username(client)
         @provider   = 'clever'
       end
+
+      def username(client = nil)
+        username_source = client&.staff_username_source
+
+        @username ||= presence(username_from(username_source))
+      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
 end

data/lib/clever/types/term.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Clever
+  module Types
+    class Term < Base
+      attr_reader :uid,
+                  :name,
+                  :start_date,
+                  :end_date
+
+      def initialize(attributes = {}, *)
+        @uid        = attributes['id']
+        @name       = attributes['name']
+        @start_date = attributes['start_date']
+        @end_date   = attributes['end_date']
+      end
+    end
+  end
+end

data/lib/clever/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -200,6 +200,7 @@ files:
 - lib/clever/types/section.rb
 - lib/clever/types/student.rb
 - lib/clever/types/teacher.rb
+- lib/clever/types/term.rb
 - lib/clever/types/token.rb
 - lib/clever/version.rb
 homepage: https://github.com/tci/clever