oneroster 2.2.0 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5d6015d83caa8a16179106a7989b290ade4e55c
-  data.tar.gz: b5c49be79af2479551f2ab83d960be422e6102c2
+  metadata.gz: 22cfb219341af86583ad0be1601058826784c557
+  data.tar.gz: 419847c21f7e5bec0e3d85e98fefcb47834a7cac
 SHA512:
-  metadata.gz: c38baa996a5efe36b531a5f785d8c6cfd353a5259d3c5b6b07474bf648d8d91132b0ac18a61a20fa4a0907da15bdc4a5381b237ac97c600ef1851f2be4a57a62
-  data.tar.gz: bbe85324fc9799e923c8bda4897ef05dcd002c379ab30ef8c8f067cf67c03abb29cddf46d31b2001bf6442c6d007b1a7d21c350a639eb2a4857b22ba37b25dd7
+  metadata.gz: 7f27a2372bc742484d796a40f3e26fa3c8cdc8694cf58ed9797a9023244b7eec3503df68075a0227dc23cc11d0bcb8f3cbd44ba179f655644895e6792e9ef5a0
+  data.tar.gz: f443a111507f5d03ee8f089a0fdb5163077229d70d76d4b45e96ea5d9f8deff79d06fb2f49fe4144f4f0b61a228567127d43b920df2cb91efd43f068bc39f40b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oneroster (2.2.0)
+    oneroster (2.3.3)
       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
 
@@ -31,7 +31,8 @@ module OneRoster
 
         return records if record_uids.empty?
 
-        records.select { |record| record_uids.to_set.include?(record.uid) }
+        record_uids_set = record_uids.to_set
+        records.select { |record| record_uids_set.include?(record.uid) }
       end
     end
 

data/lib/one_roster/version.rb

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

data/lib/types/class.rb

@@ -20,7 +20,7 @@ module OneRoster
         @period     = first_period(attributes) || period_from_code(attributes)
         @grades     = presence(attributes['grades']) || []
         @subjects   = presence(attributes['subjects']) || []
-        @term_id    = attributes['terms'][0]['sourcedId']
+        @term_id    = attributes.dig('terms', 0, 'sourcedId')
         @provider   = 'oneroster'
       end
 

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.2.0
+  version: 2.3.3
 platform: ruby
 authors:
 - Robert Julius
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -250,7 +250,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -265,9 +265,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
 specification_version: 4
 summary: Wrapper for the OneRoster API.
 test_files: []