clever 3.2.8 → 3.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555e971aed2bc72b24d66ad95c92f09deb2b8302f6f53b6d68e3f70d87966e30
-  data.tar.gz: 368d5cca074115d9ae70d4199edb2facfdfdd7c8795c2a2250fa13ae00d186c3
+  metadata.gz: ceec693a7d2d2f1bc55b066c15e28e6db98653c71e5dd746a2923868ad5b1b55
+  data.tar.gz: c1a680ed722256d4a0fe1440991e1853d69889c491728f3d37934c0136203a80
 SHA512:
-  metadata.gz: 0e996e7e8ddbd810bb5ea10a03b128134210fa409708b4dacd61a17ee51b2225d42d86e9ceba2fb28a533e419aec7ec4ce632a18f9a9a8045d7ce1acee148c20
-  data.tar.gz: 80651e3fd43eaed6fb2a26dc8390756687558ae53cdb30a5be80a27014e9e3bba3c731e337f69e6c31d2a517f62397fe3cd453d09f165093ffd677f122ba80a9
+  metadata.gz: 04f28e43270da90cfa839dcaf370afba666163f0c34f333fd83a1583629476cb82b0a8a42eb6d265d5fc1612540efea00af29fa8e8ed2251ae64f39ab7a28ab6
+  data.tar.gz: 28411f7c9abcb4eb50234de31376c554dd35fd0b1a23bbb34413540bf35151c8f18098d2efb45aace7b4578d5edf6d557eb8b201db4199e5e338b65fd7b2b0c7

data/Gemfile.lock

@@ -1,42 +1,43 @@
 PATH
   remote: .
   specs:
-    clever (3.2.8)
+    clever (3.2.10)
       faraday
       faraday_middleware
 
 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)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (1.0.0)
       faraday (~> 1.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)
       metaclass (~> 0.0.1)
     multipart-post (2.1.1)
-    parallel (1.14.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
+    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)
@@ -53,23 +54,29 @@ GEM
     rspec_junit_formatter (0.2.2)
       builder (< 4)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.65.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)
-      powerpack (~> 0.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)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    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)
-    unicode-display_width (1.4.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   ruby
@@ -83,8 +90,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/clever.gemspec

@@ -42,6 +42,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

data/lib/clever/client.rb

@@ -3,7 +3,8 @@
 module Clever
   class Client
     attr_accessor :app_id, :app_token, :sync_id, :logger, :redirect_uri,
-                  :vendor_key, :vendor_secret, :username_source, :staff_username_source
+                  :vendor_key, :vendor_secret, :username_source, :staff_username_source,
+                  :sentry_client
 
     attr_reader :api_url, :tokens_endpoint
 
@@ -103,17 +104,27 @@ module Clever
       admins.select { |record| record_uids_set.include?(record.uid) }
     end
 
+    def schools
+      authenticate
+
+      Paginator.fetch(connection, Clever::SCHOOLS_ENDPOINT,
+                      :get, Types::School, client: self).force
+    end
+
     # discard params to make the API behave the same as the one roster gem
     def classrooms(*)
       authenticate
 
       fetched_courses = courses
+      fetched_schools = schools
 
       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]
+        school = fetched_schools.find { |school| school.uid == section.school_uid }
+
         Types::Classroom.new(
           'id' => section.uid,
           'name' => section.name,
@@ -124,7 +135,9 @@ module Clever
           'term_name' => term&.name,
           'term_start_date' => term&.start_date,
           'term_end_date' => term&.end_date,
-          'term_id' => section.term_id
+          'term_id' => section.term_id,
+          'school_name' => school&.name,
+          'school_uid' => school&.uid
         )
       end
     end

data/lib/clever/connection.rb

@@ -10,7 +10,21 @@ module Clever
     end
 
     def execute(path, method = :get, params = nil, body = nil)
-      Response.new(raw_request(path, method, params, body))
+      response = Response.new(raw_request(path, method, params, body))
+
+      if [502, 504].include?(response.status)
+        log_to_sentry(
+          'client.app_id' => @client.app_id,
+          'connection.body' => body,
+          'connection.method' => method,
+          'connection.params' => params,
+          'connection.path' => path,
+          'response.http_status' => response.status,
+          'response.raw_body' => response.raw_body
+        )
+      end
+
+      response
     end
 
     def set_token(token)
@@ -48,5 +62,11 @@ module Clever
         request.body                     = body
       end
     end
+
+    def log_to_sentry(payload)
+      return unless @client.sentry_client
+
+      @client.sentry_client.capture_message('Exception in Clever::Connection', **{ extra: payload })
+    end
   end
 end

data/lib/clever/types/classroom.rb

@@ -13,7 +13,9 @@ module Clever
                   :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 Clever
         @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        = 'clever'
       end
     end

data/lib/clever/types/school.rb

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

data/lib/clever/types/section.rb

@@ -13,6 +13,7 @@ module Clever
                   :teachers,
                   :term_id,
                   :provider,
+                  :school_uid,
                   :primary_teacher_uid
 
       def initialize(attributes = {}, *)
@@ -25,8 +26,9 @@ module Clever
         @students            = attributes['students']
         @teachers            = attributes['teachers']
         @term_id             = attributes['term_id']
-        @provider            = 'clever'
         @primary_teacher_uid = attributes['teacher']
+        @school_uid          = attributes['school']
+        @provider            = 'clever'
       end
     end
   end

data/lib/clever/version.rb

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

data/lib/clever.rb

@@ -16,6 +16,7 @@ require 'clever/types/enrollment'
 require 'clever/types/event'
 require 'clever/types/student'
 require 'clever/types/section'
+require 'clever/types/school'
 require 'clever/types/teacher'
 require 'clever/types/district_admin'
 require 'clever/types/school_admin'
@@ -36,6 +37,7 @@ module Clever
   EVENTS_ENDPOINT          = '/v1.2/events'
   TERMS_ENDPOINT           = '/v3.0/terms'
   GRADES_ENDPOINT          = 'https://grades-api.beta.clever.com/v1/grade'
+  SCHOOLS_ENDPOINT         = '/v3.0/schools'
 
   class DistrictNotFound < StandardError; end
   class ConnectionError < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever
 version: !ruby/object:Gem::Version
-  version: 3.2.8
+  version: 3.2.10
 platform: ruby
 authors:
 - Robert Julius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -140,30 +140,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 Clever API.
 email:
 - robertmjulius@gmail.com
@@ -171,7 +171,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
@@ -198,6 +197,7 @@ files:
 - lib/clever/types/district_admin.rb
 - lib/clever/types/enrollment.rb
 - lib/clever/types/event.rb
+- lib/clever/types/school.rb
 - lib/clever/types/school_admin.rb
 - lib/clever/types/section.rb
 - lib/clever/types/student.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  -v '2.1.4'
-      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