oneroster 2.3.18 → 2.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 269540ac1adae115fcf0133d2fcc45f78240d9d6b42e0893e0dae6b313c96e77
-  data.tar.gz: ac7ed53651a0d15bcd8a787b62aaff690f2d2cf8e1e834b9ca81abe65d07370b
+  metadata.gz: ac0acbc4043d8a4f9c27923592085c6dfdbcdccf982739a331514ed9dec4469a
+  data.tar.gz: 91d63689995e7b37a0c9814c2ebbacbd42c3d44d4e02b8502e28d8ae21c5d874
 SHA512:
-  metadata.gz: 57c71058e2400618f80a3075723ab1ae03b7c428c117236f66780269ec9e011c79fc7412fafd9040934b67fc61c4fdd47ddb82bc53a5bf4b13ed7562081fecf8
-  data.tar.gz: 66af86c94eea4f543873e071f855e852be2a0906c92410e24692612b131a3c73c331e2428f84292b01e35cbc1ded6472f175c2de6fe8506a63638291360751d8
+  metadata.gz: 6516b3419a838c610b88324b9c0692241565714326b6b30efe65616c6684fce7db7c6b470bfaba1d56ca3edd2aa061a7053cd7edd3ada5ebd20ef04cd9e5402a
+  data.tar.gz: 83c434b84756bc076b089289f6ae7d1f4c6644c0f9730663f47985b3e493120e5c5ec9ccac703dac6ac562b01f5d68d8e30f7e1ea6b9ca3aeca7e2290f0cffa6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oneroster (2.3.18)
+    oneroster (2.3.20)
       dry-inflector (~> 1.0.0)
       faraday
       faraday_middleware
@@ -11,11 +11,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.2)
     builder (3.2.3)
     coderay (1.1.2)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.4.1)
     dry-inflector (1.0.0)
     faraday (1.10.3)
       faraday-em_http (~> 1.0)
@@ -43,8 +43,8 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashie (5.0.0)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
     metaclass (0.0.4)
     method_source (0.8.2)
     mocha (1.8.0)
@@ -56,18 +56,20 @@ GEM
       version_gem (~> 1.1)
     oauth-tty (1.0.5)
       version_gem (~> 1.1, >= 1.1.1)
-    parallel (1.15.0)
-    parser (2.6.2.0)
-      ast (~> 2.4.0)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
-    psych (3.1.0)
-    rainbow (3.0.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (10.5.0)
+    regexp_parser (2.10.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -84,27 +86,34 @@ GEM
     rspec_junit_formatter (0.2.2)
       builder (< 4)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.66.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.71.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simple_oauth (0.3.1)
-    simplecov (0.16.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
     slop (3.6.0)
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     version_gem (1.1.3)
 
 PLATFORMS
@@ -119,8 +128,8 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec_junit_formatter
-  rubocop
-  simplecov
+  rubocop (~> 1.53)
+  simplecov (~> 0.22)
 
 BUNDLED WITH
    2.1.4

data/lib/one_roster/client.rb

@@ -4,7 +4,8 @@ module OneRoster
   class Client
     attr_accessor :app_id, :app_token, :api_url, :token_url, :roster_app,
                   :app_secret, :logger, :vendor_key,
-                  :username_source, :oauth_strategy, :staff_username_source, :token_content_type
+                  :username_source, :oauth_strategy, :staff_username_source, :token_content_type,
+                  :sentry_client
 
     attr_reader :authenticated
 
@@ -47,10 +48,18 @@ module OneRoster
       records.select { |record| record_uids_set.include?(record.uid) }
     end
 
+    def schools
+      authenticate
+
+      Paginator.fetch(connection, SCHOOLS_ENDPOINT,
+                      :get, Types::School, client: self).force
+    end
+
     def classrooms(course_codes = [])
       authenticate
 
       oneroster_classes = classes
+      fetched_schools = schools
 
       terms_hash = terms.each_with_object({}) { |term, terms| terms[term.uid] = term }
 
@@ -61,6 +70,7 @@ module OneRoster
         next unless course
 
         term = terms_hash[oneroster_class.term_id&.first]
+        school = fetched_schools.find { |school| school.uid == oneroster_class.school_uid }
 
         oneroster_classes << Types::Classroom.new(
           'id' => oneroster_class.uid,
@@ -72,7 +82,9 @@ module OneRoster
           'term_name' => term&.name,
           'term_start_date' => term&.start_date,
           'term_end_date' => term&.end_date,
-          'term_id' => oneroster_class.term_id
+          'term_id' => oneroster_class.term_id,
+          'school_name' => school&.name,
+          'school_uid' => school&.uid
         )
       end
     end

data/lib/one_roster/connection.rb

@@ -11,7 +11,22 @@ module OneRoster
     end
 
     def execute(path, method = :get, params = nil, body = nil, content_type = nil)
-      Response.new(raw_request(path, method, params, body, content_type))
+      response = Response.new(raw_request(path, method, params, body, content_type))
+
+      if [502, 504].include?(response.status)
+        log_to_sentry(
+          'client.app_id' => @client.app_id,
+          'connection.path' => path,
+          'connection.method' => method,
+          'connection.params' => params,
+          'connection.body' => body,
+          'connection.content_type' => content_type,
+          'response.http_status' => response.status,
+          'response.raw_body' => response.raw_body
+        )
+      end
+
+      response
     end
 
     def set_auth_headers(token, cookie)
@@ -89,5 +104,14 @@ module OneRoster
       connection.basic_auth(@client.app_id, @client.app_secret)
       connection
     end
+
+    def log_to_sentry(payload)
+      return unless @client.sentry_client
+
+      @client.sentry_client.capture_message(
+        'Exception in OneRoster::Connection',
+        **{ extra: payload }
+      )
+    end
   end
 end

data/lib/one_roster/version.rb

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

data/lib/one_roster.rb

@@ -23,6 +23,7 @@ require 'types/student'
 require 'types/teacher'
 require 'types/term'
 require 'types/admin'
+require 'types/school'
 
 module OneRoster
   class DistrictNotFound < StandardError; end
@@ -35,6 +36,7 @@ module OneRoster
   CLASSES_ENDPOINT           = 'ims/oneroster/v1p1/classes'
   ENROLLMENTS_ENDPOINT       = 'ims/oneroster/v1p1/enrollments'
   ACADEMIC_SESSIONS_ENDPOINT = 'ims/oneroster/v1p1/academicSessions'
+  SCHOOLS_ENDPOINT           = 'ims/oneroster/v1p1/schools'
 
   RESPONSE_TYPE_MAP = {
     'users'            => 'users',
@@ -43,6 +45,7 @@ module OneRoster
     'academicSessions' => 'academicSessions',
     'courses'          => 'courses',
     'classes'          => 'classes',
-    'enrollments'      => 'enrollments'
+    'enrollments'      => 'enrollments',
+    'schools'          => 'orgs'
   }.freeze
 end

data/lib/types/class.rb

@@ -10,7 +10,8 @@ module OneRoster
                   :period,
                   :grades,
                   :subjects,
-                  :term_id
+                  :term_id,
+                  :school_uid
 
       def initialize(attributes = {}, *)
         @uid        = attributes['sourcedId']
@@ -21,6 +22,7 @@ module OneRoster
         @grades     = presence(attributes['grades']) || []
         @subjects   = presence(attributes['subjects']) || []
         @term_id    = attributes.dig('terms')&.map { |term| term['sourcedId'] } || []
+        @school_uid = attributes.dig('school', 'sourcedId')
         @provider   = 'oneroster'
       end
 

data/lib/types/classroom.rb

@@ -13,7 +13,9 @@ module OneRoster
                   :term_name,
                   :term_start_date,
                   :term_end_date,
-                  :term_id
+                  :term_id,
+                  :school_name,
+                  :school_uid
 
       def initialize(attributes = {})
         @uid             = attributes['id']
@@ -26,6 +28,8 @@ module OneRoster
         @term_start_date = attributes['term_start_date']
         @term_end_date   = attributes['term_end_date']
         @term_id         = attributes['term_id']
+        @school_name     = attributes['school_name']
+        @school_uid      = attributes['school_uid']
         @provider        = 'oneroster'
       end
     end

data/lib/types/school.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OneRoster
+  module Types
+    class School
+      attr_reader :uid, :name, :number
+
+      def initialize(attributes = {}, *)
+        @uid      = attributes['sourcedId']
+        @name     = attributes['name']
+        @number   = attributes['identifier']
+        @provider = 'oneroster'
+      end
+    end
+  end
+end

data/one_roster.gemspec

@@ -45,6 +45,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop', '~>1.53'
+  spec.add_development_dependency 'simplecov', '~>0.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneroster
 version: !ruby/object:Gem::Version
-  version: 2.3.18
+  version: 2.3.20
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,30 +182,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.53'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.53'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
 description: Wrapper for the OneRoster API.
 email:
 - robertmjulius@gmail.com
@@ -213,13 +213,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-style.yml"
-- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -242,6 +241,7 @@ files:
 - lib/types/classroom.rb
 - lib/types/course.rb
 - lib/types/enrollment.rb
+- lib/types/school.rb
 - lib/types/student.rb
 - lib/types/teacher.rb
 - lib/types/term.rb

data/.circleci/config.yml

@@ -1,116 +0,0 @@
-version: 2
-defaults: &defaults
-  docker:
-    - image: circleci/ruby:2.4.1-node-browsers
-  working_directory: ~/repo
-restore_ruby_cache: &restore_ruby_cache
-  restore_cache:
-    keys:
-      - v2-dependencies-{{ checksum "Gemfile.lock" }}
-      - v2-dependencies-
-setup_rubygems: &setup_rubygems
-  run:
-    name: Add RubyGems API key
-    command: |
-      mkdir -p ~/.gem
-      echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
-      chmod 0600 ~/.gem/credentials
-
-install_dependencies: &install_dependencies
-  run:
-    name: Install Dependencies
-    command: |
-      echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
-      source $BASH_ENV
-      gem install bundler
-      bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-save_ruby_cache: &save_ruby_cache
-  save_cache:
-    paths:
-      - ./vendor/bundle
-    key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-download_cc_reporter: &download_cc_reporter
-  run:
-    name: Download Code Climate Test Reporter
-    command: |
-      mkdir -p tmp/
-      curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
-      chmod +x ./tmp/cc-test-reporter
-
-
-
-
-persist: &persist
-  persist_to_workspace:
-    root: tmp
-    paths:
-      - cc-test-reporter
-run_rspec_tests: &run_rspec_tests
-  run:
-    name: Run RSpec Tests
-    command: |
-      mkdir /tmp/test-results
-      ./tmp/cc-test-reporter before-build
-      TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
-        circleci tests split --split-by=timings)"
-
-      bundle exec rspec --format progress \
-                        --format RspecJunitFormatter \
-                        --out /tmp/test-results/rspec.xml \
-                        --format progress \
-                        $TEST_FILES
-      ./tmp/cc-test-reporter format-coverage -t simplecov -o "tmp/codeclimate.json"
-
-upload_coverage: &upload_coverage
-  run:
-    name: Upload Coverage
-    command: |
-      ./tmp/cc-test-reporter upload-coverage -i tmp/codeclimate.json
-
-release_rubygem: &release_rubygem
-  run:
-    name: Release new version to RubyGems
-    command: |
-      bundle exec rake release
-
-jobs:
-  rspec-tests:
-    <<: *defaults
-    steps:
-      - checkout
-      - *restore_ruby_cache
-      - *install_dependencies
-      - *save_ruby_cache
-      - *download_cc_reporter
-      - *persist
-      - *run_rspec_tests
-      - *upload_coverage
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
-
-  release:
-    <<: *defaults
-    steps:
-      - checkout
-      - *restore_ruby_cache
-      - *setup_rubygems
-      - *install_dependencies
-      - *save_ruby_cache
-      - *release_rubygem
-
-workflows:
-  version: 2
-  commit:
-    jobs:
-      - rspec-tests
-      - release:
-          requires:
-            - rspec-tests
-          filters:
-            branches:
-              only:
-                - master

data/.ruby-version

@@ -1 +0,0 @@
-2.4.1