openstax_accounts 7.13.0 → 8.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f92ee3ec16b3bfa98971c5eb4c7f0fe7e6aa6c9ab55c1a8aaa9987f61adf90
-  data.tar.gz: fcf45cbfaf4ddd1108043729a57d0823b994752556762e547aedeeb8af3eeaeb
+  metadata.gz: edf27a81aef8f196ab5b804f38903395d24367628209a9eeb001a37f258f33d5
+  data.tar.gz: af2ac3a3de4ab707958bc03b0faf561e876b99521f82a8695a55cfcbbd1bc740
 SHA512:
-  metadata.gz: e23bcba422c20b646574efac818a710df0921dd4c032d1cf653750dce39abbd59833575efbeb25ef02e15f9857aa7c7da0e46e6799040d06c38c0c333a0e1cfb
-  data.tar.gz: 2907f10d08578f208ca96064d11ff3d1b857a74d50355e1b92a339edff48f57b5f83ad3f2659f9603cb108f62346bf584cb5b86151ce76c1cdf2804cbb48d595
+  metadata.gz: 3f8b506ad52a7bb2b59ed822f0347c7bb5343728dbedf7fa166f7ffc2aabc7ce9c3b8a6113d09aab44795a04e79e74595583e2335e825b0e682e7be3604b4a8c
+  data.tar.gz: fca6c2d52b5540bac193bc099c905ca4a6aa860c7353b411259ae95c878e872fb7c0f46f67c7b0a3813b7ae853dd967e969839c524384a07d1b30e3754677874

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

@@ -5,7 +5,7 @@ module OpenStax
 
       include Lev::HandleWith
 
-      skip_before_filter :authenticate_user!
+      skip_before_action :authenticate_user!, raise: false
 
       def configuration
         OpenStax::Accounts.configuration

data/app/controllers/openstax/accounts/dev/accounts_controller.rb

@@ -3,7 +3,7 @@ module OpenStax
     module Dev
       class AccountsController < OpenStax::Accounts::Dev::BaseController
         # Allow accessing from inside an iframe
-        before_filter :allow_iframe_access, only: [:index, :search]
+        before_action :allow_iframe_access, only: [:index, :search]
 
         def index
         end

data/app/controllers/openstax/accounts/dev/base_controller.rb

@@ -3,7 +3,7 @@ module OpenStax
     module Dev
       class BaseController < OpenStax::Accounts::ApplicationController
 
-        before_filter do
+        before_action do
           raise SecurityTransgression if Rails.env.production?
         end
 

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

@@ -12,7 +12,7 @@ module OpenStax
           redirect_to dev_accounts_path
         else
           forwardable_params =
-            params.slice(*configuration.forwardable_login_param_keys.map(&:to_s))
+            params.permit(*configuration.forwardable_login_param_keys.map(&:to_s)).to_h
           redirect_to openstax_login_path(forwardable_params)
         end
       end
@@ -20,13 +20,12 @@ module OpenStax
       def callback
         handle_with(
           SessionsCallback,
-            success: lambda {
-              sign_in(@handler_result.outputs[:account])
-              redirect_back key: :accounts_return_to, strategies: [:session]
-            },
-            failure: lambda {
-              failure
-            })
+          success: -> do
+            sign_in(@handler_result.outputs[:account])
+            redirect_back key: :accounts_return_to, strategies: [:session]
+          end,
+          failure: -> { failure }
+        )
       end
 
       def destroy

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

@@ -1,8 +1,6 @@
 module OpenStax
   module Accounts
-
     class SessionsCallback
-
       lev_handler
 
       protected
@@ -12,59 +10,41 @@ module OpenStax
       end
 
       def authorized?
-        @auth_data.provider == "openstax"
+        @auth_data.provider == 'openstax'
       end
 
       def handle
-        # Don't worry if the account is logged in or not beforehand.
-        # Just assume that they aren't.
+        # Don't worry if the account is logged in or not beforehand. Just assume that they aren't.
 
-        # http://apidock.com/rails/v4.0.2/ActiveRecord/Relation/find_or_create_by
+        # tap is used because we want the block to always run (not just when initializing)
         begin
-          outputs[:account] = Account.find_or_initialize_by(openstax_uid: @auth_data.uid).tap do |account|
-            account.username     = @auth_data.info.nickname
-            account.first_name   = @auth_data.info.first_name
-            account.last_name    = @auth_data.info.last_name
-            account.full_name    = @auth_data.info.name
-            account.title        = @auth_data.info.title
+          outputs.account = Account.find_or_initialize_by(
+            openstax_uid: @auth_data.uid
+          ).tap do |account|
             account.access_token = @auth_data.credentials.token
 
-            # Gracefully handle absent and unknown faculty status info
             raw_info = @auth_data.extra.raw_info
-            if raw_info.present?
-              begin
-                account.faculty_status = raw_info['faculty_status'] || :no_faculty_info
-              rescue ArgumentError => ee
-                account.faculty_status = :no_faculty_info
-              end
-
-              begin
-                account.role = raw_info['self_reported_role'] || :unknown_role
-              rescue ArgumentError => ee
-                account.role = :unknown_role
-              end
-
+            OpenStax::Accounts::Account::SYNC_ATTRIBUTES.each do |attribute|
               begin
-                account.school_type = raw_info['school_type'] || :unknown_school_type
-              rescue ArgumentError => ee
-                account.school_type = :unknown_school_type
+                account.send "#{attribute}=", raw_info[attribute]
+              rescue ArgumentError
+                # Ignore errors, for example if enum values are invalid
               end
-
-              account.uuid = raw_info['uuid']
-              account.support_identifier = raw_info['support_identifier']
-              account.is_test = raw_info['is_test']
             end
+
+            # Gracefully handle absent and unknown enum values
+            account.faculty_status ||= :no_faculty_info
+            account.role ||= :unknown_role
+            account.school_type ||= :unknown_school_type
           end
 
-          outputs[:account].save if outputs[:account].changed?
+          outputs.account.save if outputs.account.changed?
         rescue ActiveRecord::RecordNotUnique
           retry
         end
 
-        transfer_errors_from(outputs[:account], {type: :verbatim})
+        transfer_errors_from(outputs.account, type: :verbatim)
       end
-
     end
-
   end
 end

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

@@ -3,6 +3,20 @@ module OpenStax::Accounts
 
     USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
     USERNAME_MAX_LENGTH = 50
+    SYNC_ATTRIBUTES = [
+      :username,
+      :first_name,
+      :last_name,
+      :full_name,
+      :title,
+      :self_reported_role,
+      :faculty_status,
+      :school_type,
+      :salesforce_contact_id,
+      :uuid,
+      :support_identifier,
+      :is_test
+    ]
 
     attr_accessor :syncing
 
@@ -21,7 +35,17 @@ module OpenStax::Accounts
     has_many :groups_as_member, through: :group_members, source: :group
 
     enum faculty_status: [:no_faculty_info, :pending_faculty, :confirmed_faculty, :rejected_faculty]
-    enum role: [:unknown_role, :student, :instructor, :administrator, :librarian, :designer, :other]
+    enum role: [
+      :unknown_role,
+      :student,
+      :instructor,
+      :administrator,
+      :librarian,
+      :designer,
+      :other,
+      :adjunct,
+      :homeschool
+    ]
     enum school_type: [:unknown_school_type, :other_school_type, :college]
 
     validates :faculty_status, :role, :school_type, presence: true
@@ -53,6 +77,14 @@ module OpenStax::Accounts
       !openstax_uid.nil? && openstax_uid > 0
     end
 
+    def self_reported_role
+      role
+    end
+
+    def self_reported_role=(role)
+      self.role = role
+    end
+
     protected
 
     def syncing_or_stubbing?

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

@@ -115,10 +115,12 @@ module OpenStax::Accounts
       reload
 
       gids = [openstax_uid] + (
-        self.class.joins(:member_group_nestings)
-                  .where(openstax_accounts_group_nestings: { member_group_id: openstax_uid })
-                  .first
-                  .try!(:supertree_group_ids) || []
+        self.class.joins(:member_group_nestings).where(
+          # This could have been:
+          # member_group_nestings: { member_group_id: openstax_uid }
+          # However that needs a monkeypatch to work in Rails 5 so we currently do this:
+          openstax_accounts_group_nestings: { member_group_id: openstax_uid }
+        ).first.try!(:supertree_group_ids) || []
       )
       update_column(:cached_supertree_group_ids, gids)
       self.cached_supertree_group_ids = gids
@@ -129,10 +131,12 @@ module OpenStax::Accounts
       return [] unless persisted?
       reload
 
-      gids = [openstax_uid] +
-        self.class.joins(:container_group_nesting)
-                  .where(openstax_accounts_group_nestings: { container_group_id: openstax_uid })
-                  .map { |group| group.subtree_group_ids }.flatten
+      gids = [openstax_uid] + self.class.joins(:container_group_nesting).where(
+        # This could have been:
+        # container_group_nesting: { container_group_id: openstax_uid }
+        # However that needs a monkeypatch to work in Rails 5 so we currently do this:
+        openstax_accounts_group_nestings: { container_group_id: openstax_uid }
+      ).map { |group| group.subtree_group_ids }.flatten
       update_column(:cached_subtree_group_ids, gids)
       self.cached_subtree_group_ids = gids
     end

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

@@ -26,25 +26,26 @@ module OpenStax::Accounts
     end
 
     def no_loops
-      return if member_group.nil? ||\
-                !member_group.subtree_group_ids.include?(container_group_id)
+      return if member_group.nil? || !member_group.subtree_group_ids.include?(container_group_id)
+
       errors.add(:base, 'would create a loop') if errors[:base].blank?
-      false
+      throw :abort
     end
 
     def update_group_caches
-      # Returns false if the update fails (aborting the save transaction)
-      UpdateGroupCaches.call(self).errors.none?
+      UpdateGroupCaches.call(self)
+
+      throw(:abort) if errors.any?
     end
 
     def create_openstax_accounts_group_nesting
-      return false if requestor.nil? || requestor.is_anonymous?
+      throw(:abort) if requestor.nil? || requestor.is_anonymous?
 
       OpenStax::Accounts::Api.create_group_nesting(requestor, self) if requestor.has_authenticated?
     end
 
     def destroy_openstax_accounts_group_nesting
-      return false if requestor.nil? || requestor.is_anonymous?
+      throw(:abort) if requestor.nil? || requestor.is_anonymous?
 
       OpenStax::Accounts::Api.destroy_group_nesting(requestor, self) \
         if requestor.has_authenticated?

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

@@ -4,7 +4,7 @@ module OpenStax
       module V1
         class UnclaimedAccountRepresenter < Roar::Decorator
 
-          # This representer is used to communicate with Accounts
+          # This representer is used to read from Accounts
           # and so must allow read/write on all properties
           # Do not use it in create/update APIs!
 
@@ -30,12 +30,6 @@ module OpenStax
                      description: "The unclaimed account's support_identifier"
                    }
 
-          property :is_test,
-                   type: :boolean,
-                   schema_info: {
-                     description: "Whether or not this is a test account"
-                   }
-
         end
       end
     end

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

@@ -6,12 +6,13 @@ module OpenStax
 
       protected
 
-      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)
-        raise ArgumentError,
-              'You must specify either an email address or a username (and an optional password)' \
-                if email.nil? && username.nil?
+      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)
+        raise(
+          ArgumentError,
+          'You must specify either an email address or a username (and an optional password)'
+        ) if email.nil? && username.nil?
 
         if OpenStax::Accounts.configuration.enable_stubbing
           # We can only stub finding by username b/c accounts-rails doesn't persist emails
@@ -24,7 +25,7 @@ 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)
+            role: role, school_type: school_type, is_test: is_test)
           fatal_error(code: :invalid_inputs) unless (200..202).include?(response.status)
 
           struct = OpenStruct.new
@@ -32,7 +33,6 @@ module OpenStax
           id = struct.id
           uuid = struct.uuid
           support_identifier = struct.support_identifier
-          is_test = struct.is_test
         end
 
         account = Account.find_or_initialize_by(openstax_uid: id)
@@ -57,7 +57,7 @@ module OpenStax
         end
 
         transfer_errors_from(account, {type: :verbatim}, true)
-        outputs[:account] = account
+        outputs.account = account
       end
 
     end

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

@@ -0,0 +1,23 @@
+module OpenStax
+  module Accounts
+    class FindOrCreateFromSso
+
+      lev_routine express_output: :account
+
+      def exec(attrs)
+        attrs.stringify_keys!
+        uid = attrs.delete('id')
+        uuid = attrs.delete('uuid')
+        account = Account.find_or_initialize_by(
+          uuid: uuid, openstax_uid: uid
+        )
+        account.update_attributes!(
+          attrs.slice(*Account.column_names)
+        )
+        transfer_errors_from(account, {type: :verbatim})
+        outputs.account = account
+      end
+
+    end
+  end
+end

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

@@ -7,11 +7,6 @@ module OpenStax
 
     class SyncAccounts
 
-      SYNC_ATTRIBUTES = [
-        'username', 'first_name', 'last_name', 'full_name', 'title', 'role', 'faculty_status',
-        'school_type', 'salesforce_contact_id', 'uuid', 'support_identifier', 'is_test'
-      ]
-
       lev_routine transaction: :no_transaction
 
       protected
@@ -37,7 +32,7 @@ module OpenStax
           account.syncing = true
 
           if account != app_account.account
-            SYNC_ATTRIBUTES.each do |attribute|
+            OpenStax::Accounts::Account::SYNC_ATTRIBUTES.each do |attribute|
               account.send("#{attribute}=", app_account.account.send(attribute))
             end
           end

data/config/routes.rb

@@ -1,31 +1,31 @@
 OpenStax::Accounts::Engine.routes.draw do
 
   # Redirect here if we don't know what to do (theoretically should not happen)
-  root :to => 'sessions#new'
+  root to: 'sessions#new'
 
   # Shortcut to OmniAuth route that redirects to the Accounts server
   # This is provided by OmniAuth and is not in the SessionsController
-  get '/auth/openstax', :as => 'openstax_login'
+  get '/auth/openstax', as: 'openstax_login'
 
   # User profile route
   if OpenStax::Accounts.configuration.enable_stubbing?
     namespace :dev do
-      resources :accounts, :only => [:index, :create] do
-        post 'become', :on => :member
-        get 'search', :on => :collection
+      resources :accounts, only: [:index, :create] do
+        post 'become', on: :member
+        get 'search', on: :collection
       end
     end
   end
 
   # OmniAuth local routes (SessionsController)
   scope module: 'sessions' do
-    get 'callback', :path => 'auth/:provider/callback' # Authentication success
-    get 'failure', :path => 'auth/failure' # Authentication failure
+    get 'auth/:provider/callback', action: :callback, as: :callback # Authentication success
+    get 'auth/failure', action: :failure, as: :failure              # Authentication failure
 
-    get 'login', :action => :new # Redirects to /auth/openstax or stub
-    match 'logout', :action => :destroy, # Redirects to logout path or stub
-                    :via => OpenStax::Accounts.configuration.logout_via
-    get 'profile', :action => :profile # Redirects to profile path or stub
+    get 'login', action: :new # Redirects to /auth/openstax or stub
+    match 'logout', action: :destroy, # Redirects to logout path or stub
+                    via: OpenStax::Accounts.configuration.logout_via
+    get 'profile', action: :profile # Redirects to profile path or stub
   end
 
 end

data/db/migrate/0_create_openstax_accounts_accounts.rb

@@ -1,4 +1,4 @@
-class CreateOpenStaxAccountsAccounts < ActiveRecord::Migration
+class CreateOpenStaxAccountsAccounts < ActiveRecord::Migration[4.2]
   def change
     create_table :openstax_accounts_accounts do |t|
       t.integer :openstax_uid, null: false