openstax_accounts 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3fe1e9662df1f455d7506864c26c6143134196a7e191b6606a4644db5e564b2
-  data.tar.gz: 13778e9ea7baf42944c3fdfe3ccd590e1bcf8100771956dbbc12a2e1295042d9
+  metadata.gz: 62551f377f8696bbba00fe09aa6aa6f05e73f19228a53ff80b887ecdd928cbf5
+  data.tar.gz: 2c44edd556152ed485164f79c4f22eb7bf6678f3ae9f89549c3e522f33df3b7c
 SHA512:
-  metadata.gz: e74e04ebbf93d4703146f94f23d63ec69a9d68fd9437bee355789a36f51ec010857fd5b1805b79bfb6e5880b5eac73cb883d8e51163c6ec28ea599247ae85675
-  data.tar.gz: 9aa7d1ddfd8c37e9de254403c51469fad5a317406d5eab74001421131deef5b94e3078f3378567e3a141f1ff461cf65d741a5969fe809d3e50b0dcf320799dfa
+  metadata.gz: f99971a6f9896957b4cef704c78cc577a91ed54b5569ec887a76f347490a216cb73da401901939a46fdbf965ec1197b99ceb9b7a2a53536e0f01f7a5e6ec66d6
+  data.tar.gz: ec791f1e30ca7465f151c7ac2e7900993d43d0c387007f046dd2107fef8fd52f76efe1a28e4425ef913b05eb7765df4319aab24d6df449782ac447bb19a98f6f

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(params[:id])
-          sign_in(@account)
+          sign_in @account
           redirect_back key: :accounts_return_to, strategies: [:session]
         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]
@@ -11,8 +10,7 @@ module OpenStax
         if configuration.enable_stubbing?
           redirect_to dev_accounts_path
         else
-          forwardable_params =
-            params.permit(*configuration.forwardable_login_param_keys.map(&:to_s)).to_h
+          forwardable_params = params.permit(*configuration.forwardable_login_params).to_h
           redirect_to openstax_login_path(forwardable_params)
         end
       end
@@ -40,14 +38,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/models/openstax/accounts/account.rb

@@ -14,12 +14,18 @@ module OpenStax::Accounts
       :school_type,
       :salesforce_contact_id,
       :support_identifier,
-      :is_test
+      :is_test,
+      :is_kip
     ]
 
     attr_accessor :syncing
 
-    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,
@@ -31,7 +37,13 @@ module OpenStax::Accounts
       :adjunct,
       :homeschool
     ]
-    enum school_type: [:unknown_school_type, :other_school_type, :college]
+    enum school_type: [
+      :unknown_school_type,
+      :other_school_type,
+      :college,
+      :high_school,
+      :k12_school
+    ]
 
     validates :faculty_status, :role, :school_type, presence: true
 

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

@@ -5,7 +5,6 @@ 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!
@@ -89,21 +88,26 @@ module OpenStax
           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,33 @@ 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)}",
+            is_test: true
+          )
+
+          transfer_errors_from(outputs.account, {type: :verbatim}, true)
         end
-
       end
     end
   end

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

@@ -15,12 +15,11 @@ module OpenStax
 
         if OpenStax::Accounts.configuration.enable_stubbing
           # We can only stub finding by username b/c accounts-rails doesn't persist emails
-          openstax_uid = Account.find_by(username: username)&.openstax_uid ||
-                         -SecureRandom.hex(4).to_i(16)/2
-          uuid = SecureRandom.uuid
+          uuid = Account.find_by(username: username)&.uuid || SecureRandom.uuid
+          openstax_uid = -SecureRandom.hex(4).to_i(16)/2
           support_identifier = "cs_#{SecureRandom.hex(4)}"
         else
-          response = Api.find_or_create_account(
+          response = OpenStax::Accounts::Api.find_or_create_account(
             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,
@@ -35,12 +34,8 @@ module OpenStax
           support_identifier = struct.support_identifier
         end
 
-        account = Account.find_or_initialize_by(uuid: uuid)
-
-        unless account.persisted?
-          while username.nil? || Account.where(username: username).exists? do
-            username = SecureRandom.hex(3).to_s
-          end
+        outputs.account = Account.find_or_create_by(uuid: uuid) do |account|
+          account.openstax_uid = openstax_uid
           account.username = username
           account.first_name = first_name
           account.last_name = last_name
@@ -50,14 +45,11 @@ module OpenStax
           account.faculty_status = faculty_status || :no_faculty_info
           account.role = role || :unknown_role
           account.school_type = school_type || :unknown_school_type
-          account.openstax_uid = openstax_uid
           account.support_identifier = support_identifier
           account.is_test = is_test
-          account.save!
         end
 
-        transfer_errors_from(account, {type: :verbatim}, true)
-        outputs.account = account
+        transfer_errors_from outputs.account, { type: :verbatim }, true
       end
     end
   end

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

@@ -10,7 +10,6 @@ module OpenStax
       protected
 
       def exec(options={})
-
         return if OpenStax::Accounts.configuration.enable_stubbing?
 
         response = OpenStax::Accounts::Api.get_application_account_updates

data/app/views/layouts/openstax/accounts/application.html.erb

@@ -2,8 +2,8 @@
 <html>
 <head>
   <title>Accounts</title>
-  <%= stylesheet_link_tag    "openstax/accounts/application", :media => "all" %>
-  <%= javascript_include_tag "openstax/accounts/application" %>
+  <%= stylesheet_link_tag    'openstax/accounts/application', media: 'all' %>
+  <%= javascript_include_tag 'openstax/accounts/application' %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/app/views/openstax/accounts/dev/accounts/_search_results.html.erb

@@ -1,5 +1,5 @@
-<% total_count = @handler_result.outputs[:total_count]
-   accounts = @handler_result.outputs[:items] %>
+<% total_count = @handler_result.outputs.total_count
+   accounts = @handler_result.outputs.items || [] %>
 
 <div id='search-results-count'>
   <%= pluralize(total_count, 'user') %> found.
@@ -9,14 +9,13 @@
   <%= osu.action_list(
         records: accounts,
         list: {
-          headings: ['UID', 'Username (click to sign in as)', 'Name'],
-          widths: ['20%', '40%', '40%'],
+          headings: ['UID', 'UUID', 'Username (click to sign in as)', 'Name'],
+          widths: ['20%', '20%', '30%', '30%'],
           data_procs: [
             ->(account) { account.openstax_uid },
+            ->(account) { account.uuid },
             ->(account) {
-              link_to account.username, become_dev_account_path(
-                                          account.openstax_uid
-                                        ), method: :post
+              link_to account.username, become_dev_account_path(account.id), method: :post
             },
             ->(account) { account.name || '---' }
           ]

data/app/views/openstax/accounts/dev/accounts/index.html.erb

@@ -1,5 +1,4 @@
 <div class="openstax-accounts development-login">
-
   <%= render partial: 'openstax/accounts/shared/attention' %>
 
   <h3>Create an Account</h3>
@@ -11,7 +10,7 @@
 
 
     <div class="form-group">
-      <%= f.text_field :username, placeholder: "Username" %>&nbsp;
+      <%= f.text_field :username, placeholder: 'Username' %>&nbsp;
       <%= f.select :role, OpenStax::Accounts::Account.roles.keys.map{|rr| [rr, rr]} %>&nbsp;
       <%= f.submit 'Create', class: 'btn btn-primary' %>
     </div>
@@ -23,15 +22,13 @@
   <p>You need to login, but we're not connected to the Accounts server.<br>
   Search for a user below and click the sign in link next to him or her.</p>
 
-  <%= render :partial => 'openstax/accounts/shared/accounts/search',
-             :locals => {
-               :search_action_path => openstax_accounts.search_dev_accounts_path,
-               :remote => true,
-               :method => :get
+  <%= render partial: 'openstax/accounts/shared/accounts/search',
+             locals: {
+               search_action_path: openstax_accounts.dev_accounts_path,
+               search_results_partial: 'openstax/accounts/dev/accounts/search_results',
+               remote: true,
+               method: :get
              } %>
 
   <br>
-
-  <div id="search-results"></div>
-
 </div>

data/app/views/openstax/accounts/shared/_attention.html.erb

@@ -1,3 +1,11 @@
 <% handler_errors.each do |error| %>
-  <%= error.translate %>
+  <div class="error"><%= error.translate %></div>
+<% end %>
+
+<% if flash.alert %>
+  <div class="alert"><%= flash.alert %></div>
+<% end %>
+
+<% if flash.notice %>
+  <div class="notice"><%= flash.notice %></div>
 <% end %>

data/app/views/openstax/accounts/shared/accounts/_search.html.erb

@@ -1,12 +1,11 @@
 <%
-   # Clients of this partial can override the following variables:
-   search_action_path ||= nil
-   method ||= :get
-   remote ||= false
-   form_html ||=  {id: 'search-form',
-                   class: 'form-inline'}
-   search_types ||= ['Any', 'Username', 'Name',
-                     'First Name', 'Last Name', 'Email']
+  # Clients of this partial can override the following variables:
+  search_action_path ||= nil
+  search_results_partial ||= nil
+  method ||= :get
+  remote ||= false
+  form_html ||=  {id: 'search-form', class: 'form-inline'}
+  search_types ||= ['Any', 'Username', 'Name', 'First Name', 'Last Name', 'Email']
 %>
 
 <%= lev_form_for :search,
@@ -26,6 +25,11 @@
 
 <% end %>
 
+<div id="search-results">
+  <% unless search_results_partial.blank? %>
+    <%= render partial: search_results_partial %>
+  <% end %>
+</div>
 
 <script>
   var input = $('input[name="search[query]"]');

data/config/routes.rb

@@ -4,14 +4,13 @@ OpenStax::Accounts::Engine.routes.draw do
 
   # 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', to: ->(env) { [ 404, {}, [ '' ] ] }, as: 'openstax_login'
 
   if OpenStax::Accounts.configuration.enable_stubbing?
     # User profile route
     namespace :dev do
       resources :accounts, only: [:index, :create] do
         post 'become', on: :member
-        get 'search', on: :collection
       end
     end
   end

data/db/migrate/16_add_is_kip_to_openstax_accounts_accounts.rb

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

data/lib/openstax/accounts/configuration.rb

@@ -60,9 +60,9 @@ module OpenStax
       # to the default Accounts logout URL.
       attr_writer :logout_redirect_url
 
-      # forwardable_login_param_keys
+      # forwardable_login_params
       # Which params are forwarded on the accounts login path
-      attr_accessor :forwardable_login_param_keys
+      attr_accessor :forwardable_login_params
 
       # max_user_updates_per_request
       # When the user profile sync operation is called, this parameter will limit
@@ -119,10 +119,10 @@ module OpenStax
         @max_search_items = 10
         @logout_redirect_url = nil
         @return_to_url_approver = nil
-        @forwardable_login_param_keys = [
+        @forwardable_login_params = [
           :signup_at,
           :go,
-          :sp          # "signed payload"; "sp" for short to keep nested parameter names short
+          sp: {} # "signed payload"; "sp" to keep nested parameter names short.
         ]
         @max_user_updates_per_request = 250
         @sso_cookie_name = 'ox'

data/lib/openstax/accounts/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openstax_accounts
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2020-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
@@ -330,7 +330,7 @@ files:
 - app/views/layouts/openstax/accounts/application.html.erb
 - app/views/openstax/accounts/dev/accounts/_search_results.html.erb
 - app/views/openstax/accounts/dev/accounts/index.html.erb
-- app/views/openstax/accounts/dev/accounts/search.js.erb
+- app/views/openstax/accounts/dev/accounts/index.js.erb
 - app/views/openstax/accounts/shared/_attention.html.erb
 - app/views/openstax/accounts/shared/accounts/_search.html.erb
 - config/routes.rb
@@ -341,6 +341,7 @@ files:
 - db/migrate/13_add_school_type_to_accounts_accounts.rb
 - 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/1_create_openstax_accounts_groups.rb
 - db/migrate/2_create_openstax_accounts_group_members.rb
 - db/migrate/3_create_openstax_accounts_group_owners.rb