oneroster 2.0.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56b1e4481ec56f6041edd31f16457ace9bd84d88
-  data.tar.gz: 364a22aeaa63d58c65997563a239e549e1fbd70a
+  metadata.gz: 3d9b2a06cf3a50f5e78071d6a74349c39079a687
+  data.tar.gz: fb2d03aca728cf15aa886cf72010ede9ee14359e
 SHA512:
-  metadata.gz: f0a4b44c8e3e518fc65bb7ca287b7ace69f5a036b82def7c33f2fbccc5aae60188efe7152e012a4bd4878dbd58512f28d15f1b4557ba95d59432d1226ec3e260
-  data.tar.gz: 7940dcec5c164d80229032579927374c9b2c9d539d15a30ed8423002ad35795de980152252a58b04b04371762a4c9c76a47e675fd22fabafdc91f0efafecb383
+  metadata.gz: 472c0969f9ce2256f1b52615a135c61411be0c4dc04466b72aea5c24bf534cb205586d1727c32b71217fa1663d9db8fbcc9fe1a350858a551e8b7929f8f7cd44
+  data.tar.gz: b07e234e1a1c5323e341a8fb3e0a34fd3e194c13b17431db8fea10030d73b7a1cd80ade3b21d8dc64ec88db06cfb98c139463fe3a3ae9c0d9e29a38a1f8e5cd5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oneroster (2.0.1)
+    oneroster (2.3.2)
       dry-inflector
       faraday
       faraday_middleware

data/lib/one_roster/client.rb

@@ -4,7 +4,7 @@ module OneRoster
   class Client
     attr_accessor :app_id, :app_token, :api_url,
                   :app_secret, :logger, :vendor_key,
-                  :username_source, :oauth_strategy
+                  :username_source, :oauth_strategy, :staff_username_source
 
     attr_reader :authenticated
 
@@ -56,6 +56,7 @@ module OneRoster
           'course_number' => course.course_code,
           'period' => oneroster_class.period,
           'grades' => oneroster_class.grades,
+          'subjects' => oneroster_class.subjects,
           'term_name' => term&.name,
           'term_start_date' => term&.start_date,
           'term_end_date' => term&.end_date

data/lib/one_roster/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneRoster
   class Response
     attr_reader :status, :raw_body, :headers

data/lib/one_roster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OneRoster
-  VERSION = '2.0.1'
+  VERSION = '2.3.2'
 end

data/lib/types/class.rb

@@ -9,6 +9,7 @@ module OneRoster
                   :provider,
                   :period,
                   :grades,
+                  :subjects,
                   :term_id
 
       def initialize(attributes = {}, *)
@@ -17,8 +18,9 @@ module OneRoster
         @course_uid = attributes['course']['sourcedId']
         @status     = attributes['status']
         @period     = first_period(attributes) || period_from_code(attributes)
-        @grades     = attributes['grades']
-        @term_id    = attributes['terms'][0]['sourcedId']
+        @grades     = presence(attributes['grades']) || []
+        @subjects   = presence(attributes['subjects']) || []
+        @term_id    = attributes.dig('terms', 0, 'sourcedId')
         @provider   = 'oneroster'
       end
 
@@ -35,6 +37,14 @@ module OneRoster
       def period_from_code(attributes)
         attributes['classCode']&.match(/- Period (\d+) -/) { |m| m[1] }
       end
+
+      def presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
+      end
     end
   end
 end

data/lib/types/classroom.rb

@@ -8,6 +8,7 @@ module OneRoster
                   :course_number,
                   :period,
                   :grades,
+                  :subjects,
                   :provider,
                   :term_name,
                   :term_start_date,
@@ -19,6 +20,7 @@ module OneRoster
         @course_number   = attributes['course_number']
         @period          = attributes['period']
         @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']

data/lib/types/enrollment.rb

@@ -25,7 +25,7 @@ module OneRoster
         teacher?
       end
 
-      def primary_teacher?
+      def primary
         teacher? && @primary.to_s == 'true'
       end
 
@@ -41,6 +41,7 @@ module OneRoster
         {
           classroom_uid: @classroom_uid,
           user_uid: @user_uid,
+          primary: primary,
           provider: @provider
         }
       end

data/lib/types/teacher.rb

@@ -9,12 +9,59 @@ module OneRoster
                   :last_name,
                   :provider
 
-      def initialize(attributes = {}, *)
-        @uid        = attributes['sourcedId']
-        @email      = attributes['email']
-        @first_name = attributes['givenName']
-        @last_name  = attributes['familyName']
-        @provider   = 'oneroster'
+      def initialize(attributes = {}, *, client: nil)
+        @uid          = attributes['sourcedId']
+        @email        = attributes['email']
+        @first_name   = attributes['givenName']
+        @last_name    = attributes['familyName']
+        @api_username = attributes['username']
+        @username     = username(client)
+        @provider     = 'oneroster'
+      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 presence(field)
+        field unless blank?(field)
+      end
+
+      def blank?(field)
+        field.nil? || field == ''
+      end
+
+      def username_from(username_source)
+        return unless presence(username_source)
+
+        source = username_source(username_source)
+
+        presence(instance_variable_get("@#{source}"))
+      end
+
+      # if the username_source is `sourcedId`, we want to return `uid`
+      # so we can grab the right instance variable
+      def username_source(source)
+        case source
+        when 'sourcedId' then 'uid'
+        when 'username' then 'api_username'
+        else
+          source
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneroster
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday