openstax_accounts 9.2.0 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62551f377f8696bbba00fe09aa6aa6f05e73f19228a53ff80b887ecdd928cbf5
-  data.tar.gz: 2c44edd556152ed485164f79c4f22eb7bf6678f3ae9f89549c3e522f33df3b7c
+  metadata.gz: 1364b5315f92f25857db5723efd47da0dda8a8d00f9d03171b30f9138cdfabab
+  data.tar.gz: 575fe4c6617a7f3e98ee876698cb8f719256d0d16982c9386692b98778cb92ac
 SHA512:
-  metadata.gz: f99971a6f9896957b4cef704c78cc577a91ed54b5569ec887a76f347490a216cb73da401901939a46fdbf965ec1197b99ceb9b7a2a53536e0f01f7a5e6ec66d6
-  data.tar.gz: ec791f1e30ca7465f151c7ac2e7900993d43d0c387007f046dd2107fef8fd52f76efe1a28e4425ef913b05eb7765df4319aab24d6df449782ac447bb19a98f6f
+  metadata.gz: 981eda25a7e6aa4548d0a7af4d16bfeaead35d1626f7a4d22b1aad3288ad26af10b24cf84a84a456418f3a9ae0e1ae0afd0de2130f7c05d5cba314497c62ef0e
+  data.tar.gz: fba052fb63636e613e25188c25010092ffa520ce7377e3089644cd2d9b8b44b70c3999d182bbbbe772c0ee3b8c6dc1ca6bdb9496d77521e40c600c46d3d8c3ac

data/app/controllers/openstax/accounts/sessions_controller.rb

@@ -27,14 +27,18 @@ module OpenStax
       end
 
       def destroy
-        sign_out!
-
-        # Unless we are stubbing, we redirect to a configurable URL, which is normally
-        # (or at least eventually) the Accounts logout URL so that users can't sign back
-        # in automagically.
-        redirect_to configuration.enable_stubbing? ?
-                    main_app.root_url :
-                    configuration.logout_redirect_url(request)
+        # if a handler is configured, let it handle everything
+        if configuration.logout_handler
+          configuration.logout_handler.call(self)
+        else
+          # Unless we are stubbing, we redirect to a configurable URL, which is normally
+          # (or at least eventually) the Accounts logout URL so that users can't sign back
+          # in automagically.
+          sign_out!
+          redirect_to configuration.enable_stubbing? ?
+                        main_app.root_url :
+                        configuration.logout_redirect_url(request)
+        end
       end
 
       def failure

data/app/handlers/openstax/accounts/sessions_callback.rb

@@ -34,6 +34,7 @@ module OpenStax
             account.faculty_status ||= :no_faculty_info
             account.role ||= :unknown_role
             account.school_type ||= :unknown_school_type
+            account.school_location ||= :unknown_school_location
           end
 
           outputs.account.save if outputs.account.changed?

data/app/models/openstax/accounts/account.rb

@@ -5,6 +5,7 @@ module OpenStax::Accounts
     SYNC_ATTRIBUTES = [
       :openstax_uid,
       :username,
+      :is_administrator,
       :first_name,
       :last_name,
       :full_name,
@@ -12,10 +13,12 @@ module OpenStax::Accounts
       :self_reported_role,
       :faculty_status,
       :school_type,
+      :school_location,
       :salesforce_contact_id,
       :support_identifier,
       :is_test,
-      :is_kip
+      :is_kip,
+      :grant_tutor_access
     ]
 
     attr_accessor :syncing
@@ -26,6 +29,7 @@ module OpenStax::Accounts
       :confirmed_faculty,
       :rejected_faculty
     ]
+
     enum role: [
       :unknown_role,
       :student,
@@ -37,15 +41,23 @@ module OpenStax::Accounts
       :adjunct,
       :homeschool
     ]
+
     enum school_type: [
       :unknown_school_type,
       :other_school_type,
       :college,
       :high_school,
-      :k12_school
+      :k12_school,
+      :home_school
+    ]
+
+    enum school_location: [
+      :unknown_school_location,
+      :domestic_school,
+      :foreign_school
     ]
 
-    validates :faculty_status, :role, :school_type, presence: true
+    validates :faculty_status, :role, :school_type, :school_location, presence: true
 
     validates :uuid, presence: true, uniqueness: true
     validates :support_identifier, uniqueness: { allow_nil: true }

data/app/representers/openstax/accounts/api/v1/account_representer.rb

@@ -9,8 +9,9 @@ module OpenStax
           # and so must allow read/write on all properties
           # Do not use it in create/update APIs!
 
-          # Otherwise, this representer can be used directly or subclassed
-          # for an object that delegates openstax_uid, username, first_name, last_name, full_name, # title, faculty_status, role, school_type and salesforce_contact_id to an account
+          # This representer can be used directly or subclassed for an object that delegates
+          # openstax_uid, username, first_name, last_name, full_name, title, faculty_status,
+          # role, school_type, school_location and salesforce_contact_id to an account
 
           include Roar::JSON
 
@@ -85,6 +86,14 @@ module OpenStax
                      }"
                    }
 
+          property :school_location,
+                   type: String,
+                   schema_info: {
+                     description: "One of #{
+                       OpenStax::Accounts::Account.school_locations.keys.map(&:to_s).inspect
+                     }"
+                   }
+
           property :uuid,
                    type: String,
                    schema_info: {
@@ -108,6 +117,12 @@ module OpenStax
                    schema_info: {
                      description: 'Whether or not this is a Key Institutional Partner account'
                    }
+
+          property :grant_tutor_access,
+                   type: :boolean,
+                   schema_info: {
+                     description: 'Whether or not the account should be granted Tutor access'
+                   }
         end
       end
     end

data/app/routines/openstax/accounts/dev/create_account.rb

@@ -32,6 +32,8 @@ module OpenStax
             role: inputs[:role] || :unknown_role,
             uuid: SecureRandom.uuid,
             support_identifier: "cs_#{SecureRandom.hex(4)}",
+            school_type: inputs[:school_type] || :unknown_school_type,
+            school_location: inputs[:school_location] || :unknown_school_location,
             is_test: true
           )
 

data/app/routines/openstax/accounts/find_or_create_account.rb

@@ -7,7 +7,8 @@ module OpenStax
 
       def exec(email: nil, username: nil, password: nil, first_name: nil, last_name: nil,
                full_name: nil, title: nil, salesforce_contact_id: nil, faculty_status: nil,
-               role: nil, school_type: nil, is_test: nil)
+               role: nil, school_type: nil, school_location: nil, is_kip: nil,
+               grant_tutor_access: nil, is_test: nil)
         raise(
           ArgumentError,
           'You must specify either an email address or a username (and an optional password)'
@@ -23,7 +24,8 @@ module OpenStax
             email: email, username: username, password: password,
             first_name: first_name, last_name: last_name, full_name: full_name,
             salesforce_contact_id: salesforce_contact_id, faculty_status: faculty_status,
-            role: role, school_type: school_type, is_test: is_test
+            role: role, school_type: school_type, school_location: school_location,
+            is_kip: is_kip, grant_tutor_access: grant_tutor_access, is_test: is_test
           )
           fatal_error(code: :invalid_inputs) unless (200..202).include?(response.status)
 
@@ -45,7 +47,10 @@ module OpenStax
           account.faculty_status = faculty_status || :no_faculty_info
           account.role = role || :unknown_role
           account.school_type = school_type || :unknown_school_type
+          account.school_location = school_location || :unknown_school_location
           account.support_identifier = support_identifier
+          account.is_kip = is_kip
+          account.grant_tutor_access = grant_tutor_access
           account.is_test = is_test
         end
 

data/app/routines/openstax/accounts/find_or_create_from_sso.rb

@@ -8,7 +8,7 @@ module OpenStax
         uid = attrs.delete('id')
         uuid = attrs.delete('uuid')
         account = Account.find_or_initialize_by(uuid: uuid)
-        account.update_attributes!(attrs.slice(*Account.column_names))
+        account.update!(attrs.slice(*Account.column_names))
         transfer_errors_from(account, {type: :verbatim})
         outputs.account = account
       end

data/app/routines/openstax/accounts/sync_accounts.rb

@@ -1,7 +1,5 @@
 # Routine for getting account updates from the Accounts server
-#
 # Should be scheduled to run regularly
-
 module OpenStax
   module Accounts
     class SyncAccounts
@@ -12,36 +10,40 @@ module OpenStax
       def exec(options={})
         return if OpenStax::Accounts.configuration.enable_stubbing?
 
-        response = OpenStax::Accounts::Api.get_application_account_updates
+        loop do
+          response = OpenStax::Accounts::Api.get_application_account_updates
 
-        app_accounts = []
-        app_accounts_rep = OpenStax::Accounts::Api::V1::ApplicationAccountsRepresenter
-                             .new(app_accounts)
-        app_accounts_rep.from_json(response.body)
+          app_accounts = []
+          app_accounts_rep = OpenStax::Accounts::Api::V1::ApplicationAccountsRepresenter.new(
+            app_accounts
+          )
+          app_accounts_rep.from_json(response.body)
 
-        return if app_accounts.empty?
+          num_accounts = app_accounts.size
+          return if num_accounts == 0
 
-        updated_app_accounts = []
-        app_accounts.each do |app_account|
-          account = OpenStax::Accounts::Account.find_by(
-            uuid: app_account.account.uuid
-          ) || app_account.account
-          account.syncing = true
+          updated_app_accounts = []
+          app_accounts.each do |app_account|
+            account = OpenStax::Accounts::Account.find_by(
+              uuid: app_account.account.uuid
+            ) || app_account.account
+            account.syncing = true
 
-          if account != app_account.account
             OpenStax::Accounts::Account::SYNC_ATTRIBUTES.each do |attribute|
-              account.send("#{attribute}=", app_account.account.send(attribute))
-            end
+              account.send "#{attribute}=", app_account.account.send(attribute)
+            end if account != app_account.account
+
+            next unless account.save
+
+            updated_app_accounts << {
+              user_id: account.openstax_uid, read_updates: app_account.unread_updates
+            }
           end
 
-          next unless account.save
+          OpenStax::Accounts::Api.mark_account_updates_as_read(updated_app_accounts)
 
-          updated_app_accounts << {
-            user_id: account.openstax_uid, read_updates: app_account.unread_updates
-          }
+          return if num_accounts < OpenStax::Accounts.configuration.max_user_updates_per_request
         end
-
-        OpenStax::Accounts::Api.mark_account_updates_as_read(updated_app_accounts)
       end
     end
   end

data/db/migrate/17_add_school_location_to_openstax_accounts_accounts.rb

@@ -0,0 +1,5 @@
+class AddSchoolLocationToOpenStaxAccountsAccounts < ActiveRecord::Migration[5.2]
+  def change
+    add_column :openstax_accounts_accounts, :school_location, :integer, default: 0, null: false
+  end
+end

data/db/migrate/18_add_grant_tutor_access_to_openstax_accounts_accounts.rb

@@ -0,0 +1,5 @@
+class AddGrantTutorAccessToOpenStaxAccountsAccounts < ActiveRecord::Migration[5.2]
+  def change
+    add_column :openstax_accounts_accounts, :grant_tutor_access, :boolean
+  end
+end

data/db/migrate/19_add_is_administrator_to_openstax_accounts_accounts.rb

@@ -0,0 +1,5 @@
+class AddIsAdministratorToOpenStaxAccountsAccounts < ActiveRecord::Migration[5.2]
+  def change
+    add_column :openstax_accounts_accounts, :is_administrator, :boolean
+  end
+end

data/lib/openstax/accounts/api.rb

@@ -81,7 +81,9 @@ module OpenStax
       # On success, returns an OAuth2::Response object.
       def self.get_application_account_updates(options = {})
         limit = OpenStax::Accounts.configuration.max_user_updates_per_request
-        request(:get, "application_users/updates#{ '?limit=' + limit.to_s if !limit.blank? }", options)
+        request(
+          :get, "application_users/updates#{ '?limit=' + limit.to_s if !limit.blank? }", options
+        )
       end
 
       # Marks account updates as "read".

data/lib/openstax/accounts/configuration.rb

@@ -53,9 +53,16 @@ module OpenStax
       # If more would be returned, the result will be empty instead
       attr_accessor :max_search_items
 
+      # logout_handler
+      # Handles logging out and redirecting user when they've requested logout
+      # if specified, the logout_redirect_url has no effect
+      attr_accessor :logout_handler
+
       # logout_redirect_url
       # A URL to redirect to after the app logs out, can be a string or a Proc.
       # If a Proc (or lambda), it will be called with the logout request.
+      #
+      # Only used if the logout_handler above is not specified
       # If this field is nil or if the Proc returns nil, the logout will redirect
       # to the default Accounts logout URL.
       attr_writer :logout_redirect_url
@@ -117,6 +124,7 @@ module OpenStax
         @account_user_mapper = OpenStax::Accounts::DefaultAccountUserMapper
         @min_search_characters = 3
         @max_search_items = 10
+        @logout_handler = nil
         @logout_redirect_url = nil
         @return_to_url_approver = nil
         @forwardable_login_params = [

data/lib/openstax/accounts/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Accounts
-    VERSION = '9.2.0'
+    VERSION = '9.6.0'
   end
 end

data/spec/factories/openstax_accounts_account.rb

@@ -6,6 +6,7 @@ FactoryBot.define do
     faculty_status     { OpenStax::Accounts::Account.faculty_statuses[:no_faculty_info] }
     role               { OpenStax::Accounts::Account.roles[:unknown_role] }
     school_type        { OpenStax::Accounts::Account.school_types[:unknown_school_type] }
+    school_location    { OpenStax::Accounts::Account.school_locations[:unknown_school_location] }
     uuid               { SecureRandom.uuid }
     support_identifier { "cs_#{SecureRandom.hex(4)}" }
     is_test            { true }

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: openstax_accounts
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.6.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -342,6 +348,9 @@ files:
 - db/migrate/14_drop_openstax_uid_and_username_uniqueness.rb
 - db/migrate/15_drop_accounts_groups.rb
 - db/migrate/16_add_is_kip_to_openstax_accounts_accounts.rb
+- db/migrate/17_add_school_location_to_openstax_accounts_accounts.rb
+- db/migrate/18_add_grant_tutor_access_to_openstax_accounts_accounts.rb
+- db/migrate/19_add_is_administrator_to_openstax_accounts_accounts.rb
 - db/migrate/1_create_openstax_accounts_groups.rb
 - db/migrate/2_create_openstax_accounts_group_members.rb
 - db/migrate/3_create_openstax_accounts_group_owners.rb
@@ -384,7 +393,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails common code and bindings for the 'accounts' API