openstax_accounts 8.1.1 → 9.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf27a81aef8f196ab5b804f38903395d24367628209a9eeb001a37f258f33d5
-  data.tar.gz: af2ac3a3de4ab707958bc03b0faf561e876b99521f82a8695a55cfcbbd1bc740
+  metadata.gz: 90b87730485400afb68d52f5ffc0c2c54348a8ccc4a0484afdbade1c10a7e9ae
+  data.tar.gz: 31a2ce0e354d58d33313260f5c125649b5a1c0124ef6362a61123afdeb5bb834
 SHA512:
-  metadata.gz: 3f8b506ad52a7bb2b59ed822f0347c7bb5343728dbedf7fa166f7ffc2aabc7ce9c3b8a6113d09aab44795a04e79e74595583e2335e825b0e682e7be3604b4a8c
-  data.tar.gz: fca6c2d52b5540bac193bc099c905ca4a6aa860c7353b411259ae95c878e872fb7c0f46f67c7b0a3813b7ae853dd967e969839c524384a07d1b30e3754677874
+  metadata.gz: 022e79a44e3d134d1661fc7087a5bab2937e256c8f3ac9d3a5096790758f4a59175c8940a85753b78574294f0a3f277c2723d22d51efd4d121af902fbc0d1fd3
+  data.tar.gz: 6f62aac96d93356f27631c2edbc70e4434942da615069939be98a151bb03e24788aaff320b450f1ef31a4492bfd2854f1904d80172122753607d9f675a3de6d8

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

@@ -1,8 +1,6 @@
 module OpenStax
   module Accounts
-
     class ApplicationController < ::ActionController::Base
-
       include Lev::HandleWith
 
       skip_before_action :authenticate_user!, raise: false
@@ -10,8 +8,6 @@ module OpenStax
       def configuration
         OpenStax::Accounts.configuration
       end
-
     end
-
   end
 end

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

@@ -3,23 +3,30 @@ module OpenStax
     module Dev
       class AccountsController < OpenStax::Accounts::Dev::BaseController
         # Allow accessing from inside an iframe
-        before_action :allow_iframe_access, only: [:index, :search]
+        before_action :allow_iframe_access, only: :index
 
         def index
-        end
-
-        def search
-          handle_with(AccountsSearch)
+          handle_with AccountsSearch
         end
 
         def create
-          handle_with(AccountsCreate,
-                      complete: lambda { redirect_to dev_accounts_path })
+          handle_with(
+            AccountsCreate,
+            success: -> do
+              username = @handler_result.outputs.account.username
+              flash.notice = "Account with username \"#{username}\" created."
+              redirect_to dev_accounts_path(search: { query: username })
+            end,
+            failure: -> do
+              flash.alert = @handler_result.errors.first.translate
+              redirect_to dev_accounts_path(search: { query: params.dig(:create, :username) })
+            end
+          )
         end
 
         def become
-          @account = Account.find_by(openstax_uid: params[:id])
-          sign_in(@account)
+          @account = Account.find(params[:id])
+          sign_in @account
           redirect_back key: :accounts_return_to, strategies: [:session]
         end
 
@@ -28,7 +35,6 @@ module OpenStax
         def allow_iframe_access
           response.headers.except! 'X-Frame-Options'
         end
-
       end
     end
   end

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

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

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

@@ -1,7 +1,6 @@
 module OpenStax
   module Accounts
     class SessionsController < OpenStax::Accounts::ApplicationController
-
       def new
         if configuration.is_return_to_url_approved?(params[:return_to])
           store_url url: params[:return_to], key: :accounts_return_to, strategies: [:session]
@@ -40,15 +39,13 @@ module OpenStax
       end
 
       def failure
-        redirect_back key: :accounts_return_to,
-                      alert: "Authentication failed, please try again."
+        redirect_back key: :accounts_return_to, alert: 'Authentication failed, please try again.'
       end
 
       def profile
         # TODO: stub profile if stubbing is enabled
-        redirect_to URI.join(configuration.openstax_accounts_url, "/profile").to_s
+        redirect_to URI.join(configuration.openstax_accounts_url, '/profile').to_s
       end
-
     end
   end
 end

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

@@ -1,7 +1,6 @@
 module OpenStax
   module Accounts
     class AccountsSearch
-
       lev_handler
 
       paramify :search do
@@ -50,17 +49,16 @@ module OpenStax
                   page: search_params.page,
                   per_page: search_params.per_page}
         out = run(OpenStax::Accounts::SearchAccounts, params).outputs
-        outputs[:total_count] = out[:total_count]
+        outputs.total_count = out.total_count
 
-        if !@max_items.nil? && outputs[:total_count] > @max_items
+        if !@max_items.nil? && outputs.total_count > @max_items
           fatal_error(code: :too_many_items,
                       message: "The number of matches exceeded the allowed limit of #{
                         @max_items} matches. Please refine your query and try again.")
         end
 
-        outputs[:items] = out[:items].to_a
+        outputs.items = out.items.to_a
       end
-
     end
   end
 end

data/app/handlers/openstax/accounts/dev/accounts_create.rb

@@ -1,21 +1,17 @@
 module OpenStax
   module Accounts
-
     module Dev
       class AccountsCreate
-
         lev_handler
 
         paramify :create do
           attribute :username, type: String
-          validates :username, presence: true
           attribute :role, type: String
         end
 
         uses_routine OpenStax::Accounts::Dev::CreateAccount,
                      as: :create_account,
-                     translations: { inputs: { scope: :create },
-                                     outputs: { type: :verbatim } }
+                     translations: { inputs: { scope: :create }, outputs: { type: :verbatim } }
 
         protected
 
@@ -26,9 +22,7 @@ module OpenStax
         def handle
           run(:create_account, create_params.as_hash(:username, :role))
         end
-
       end
     end
-
   end
 end

data/app/handlers/openstax/accounts/dev/accounts_search.rb

@@ -2,7 +2,6 @@ module OpenStax
   module Accounts
     module Dev
       class AccountsSearch < OpenStax::Accounts::AccountsSearch
-
         paramify :search do
           attribute :type, type: String
           attribute :query, type: String
@@ -21,7 +20,6 @@ module OpenStax
         def authorized?
           !Rails.env.production?
         end
-
       end
     end
   end

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

@@ -15,15 +15,13 @@ module OpenStax
 
       def handle
         # Don't worry if the account is logged in or not beforehand. Just assume that they aren't.
-
         # 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|
+          outputs.account = Account.find_or_initialize_by(uuid: @auth_data.uid).tap do |account|
             account.access_token = @auth_data.credentials.token
 
             raw_info = @auth_data.extra.raw_info
+            raw_info = raw_info.merge openstax_uid: raw_info[:id]
             OpenStax::Accounts::Account::SYNC_ATTRIBUTES.each do |attribute|
               begin
                 account.send "#{attribute}=", raw_info[attribute]
@@ -36,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

@@ -1,9 +1,9 @@
 module OpenStax::Accounts
     class Account < ActiveRecord::Base
-
     USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
     USERNAME_MAX_LENGTH = 50
     SYNC_ATTRIBUTES = [
+      :openstax_uid,
       :username,
       :first_name,
       :last_name,
@@ -12,29 +12,22 @@ module OpenStax::Accounts
       :self_reported_role,
       :faculty_status,
       :school_type,
+      :school_location,
       :salesforce_contact_id,
-      :uuid,
       :support_identifier,
-      :is_test
+      :is_test,
+      :is_kip
     ]
 
     attr_accessor :syncing
 
-    has_many :group_owners, dependent: :destroy,
-             class_name: 'OpenStax::Accounts::GroupOwner',
-             primary_key: :openstax_uid,
-             foreign_key: :user_id,
-             inverse_of: :user
-    has_many :groups_as_owner, through: :group_owners, source: :group
-
-    has_many :group_members, dependent: :destroy,
-             class_name: 'OpenStax::Accounts::GroupMember',
-             primary_key: :openstax_uid,
-             foreign_key: :user_id,
-             inverse_of: :user
-    has_many :groups_as_member, through: :group_members, source: :group
-
-    enum faculty_status: [:no_faculty_info, :pending_faculty, :confirmed_faculty, :rejected_faculty]
+    enum faculty_status: [
+      :no_faculty_info,
+      :pending_faculty,
+      :confirmed_faculty,
+      :rejected_faculty
+    ]
+
     enum role: [
       :unknown_role,
       :student,
@@ -46,12 +39,24 @@ module OpenStax::Accounts
       :adjunct,
       :homeschool
     ]
-    enum school_type: [:unknown_school_type, :other_school_type, :college]
 
-    validates :faculty_status, :role, :school_type, presence: true
+    enum school_type: [
+      :unknown_school_type,
+      :other_school_type,
+      :college,
+      :high_school,
+      :k12_school,
+      :home_school
+    ]
+
+    enum school_location: [
+      :unknown_school_location,
+      :domestic_school,
+      :foreign_school
+    ]
+
+    validates :faculty_status, :role, :school_type, :school_location, presence: true
 
-    validates :openstax_uid, uniqueness: { allow_nil: true }
-    validates :username, uniqueness: { allow_nil: true }
     validates :uuid, presence: true, uniqueness: true
     validates :support_identifier, uniqueness: { allow_nil: true }
 
@@ -98,6 +103,5 @@ module OpenStax::Accounts
     def update_openstax_accounts
       OpenStax::Accounts::Api.update_account(self)
     end
-
   end
 end

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

@@ -1,7 +1,6 @@
 module OpenStax
   module Accounts
     class AnonymousAccount < Account
-
       include Singleton
 
       before_save { false }
@@ -9,6 +8,7 @@ module OpenStax
       def initialize(attributes=nil)
         super
         self.id           = nil
+        self.uuid         = nil
         self.openstax_uid = nil
         self.username     = 'anonymous'
         self.first_name   = 'Guest'
@@ -18,7 +18,6 @@ module OpenStax
       def is_anonymous?
         true
       end
-
     end
   end
 end

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

@@ -5,13 +5,13 @@ module OpenStax
     module Api
       module V1
         class AccountRepresenter < Roar::Decorator
-
           # This representer is used to communicate with Accounts
           # 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
 
@@ -86,24 +86,37 @@ 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: {
-                     description: "The UUID as set by Accounts"
+                     description: 'The UUID as set by Accounts'
                    }
 
           property :support_identifier,
                    type: String,
                    schema_info: {
-                     description: "The support_identifier as set by Accounts"
+                     description: 'The support_identifier as set by Accounts'
                    }
 
           property :is_test,
                    type: :boolean,
                    schema_info: {
-                     description: "Whether or not this is a test account"
+                     description: 'Whether or not this is a test account'
                    }
 
+          property :is_kip,
+                   type: :boolean,
+                   schema_info: {
+                     description: 'Whether or not this is a Key Institutional Partner account'
+                   }
         end
       end
     end

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

@@ -1,5 +1,4 @@
-# Routine for creating an account, only for use when stubbing and
-# not on production.
+# Routine for creating an account, only for use when stubbing and not on production.
 
 module OpenStax
   module Accounts
@@ -11,30 +10,35 @@ module OpenStax
 
         def exec(inputs={})
           fatal_error(code: :cannot_create_account_in_production) if Rails.env.production?
-          fatal_error(code: :can_only_create_account_when_stubbing) if !OpenStax::Accounts.configuration.enable_stubbing?
+          fatal_error(code: :can_only_create_account_when_stubbing) \
+            unless OpenStax::Accounts.configuration.enable_stubbing?
 
           username = inputs[:username]
-          while username.nil? || Account.where(username: username).exists? do
-            username = SecureRandom.hex(3).to_s
+          if username.blank?
+            while username.blank? || Account.where(username: username).exists? do
+              username = SecureRandom.hex(3).to_s
+            end
+          else
+            fatal_error(
+              code: :account_already_exists,
+              message: "One or more accounts with username \"#{username}\" already exist."
+            ) if Account.where(username: username).exists?
           end
 
-          account = OpenStax::Accounts::Account.new
-
-          account.openstax_uid = -SecureRandom.hex(4).to_i(16)/2
-          account.access_token = SecureRandom.hex.to_s
-          account.username = username
-          account.role = inputs[:role] || :unknown_role
-          account.uuid = SecureRandom.uuid
-          account.support_identifier = "cs_#{SecureRandom.hex(4)}"
-          account.is_test = true
-
-          account.save
-
-          transfer_errors_from(account, {type: :verbatim}, true)
-
-          outputs[:account] = account
+          outputs.account = OpenStax::Accounts::Account.create(
+            openstax_uid: -SecureRandom.hex(4).to_i(16)/2,
+            access_token: SecureRandom.hex.to_s,
+            username: username,
+            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
+          )
+
+          transfer_errors_from(outputs.account, {type: :verbatim}, true)
         end
-
       end
     end
   end