Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Ability to attach User/Invitation management to other resources than Store (#12660)

Damian Legawiec9752aaa893cb
diff --git a/admin/app/controllers/spree/admin/admin_users_controller.rb b/admin/app/controllers/spree/admin/admin_users_controller.rb
index 60b2c2999b..8a8017f1f6 100644
--- a/admin/app/controllers/spree/admin/admin_users_controller.rb
+++ b/admin/app/controllers/spree/admin/admin_users_controller.rb
@@ -2,10 +2,10 @@ module Spree
module Admin
class AdminUsersController < BaseController
skip_before_action :authorize_admin, only: [:new, :create]
-
- before_action :load_resource, except: [:new, :create]
+ before_action :load_parent, except: [:new, :create]
+ before_action :load_roles, except: [:index]
before_action :load_invitation, only: [:new, :create]
- before_action :load_admin_user, only: [:edit, :update, :destroy]
+ before_action :load_admin_user, only: [:show, :edit, :update]
layout :choose_layout
@@ -17,8 +17,9 @@ module Spree
@collection = @search.result
end
+ # GET /admin/admin_users/:id
def show
- @admin_user = scope.find(params[:id])
+ authorize! :read, @admin_user
end
# GET /admin/admin_users/new?token=<token>
@@ -61,43 +62,37 @@ module Spree
end
end
- # DELETE /admin/admin_users/:id
- def destroy
- authorize! :destroy, @admin_user
-
- # we're actually removing the resource_user record, not the user itself
- @resource.resource_users.find_by(user: @admin_user).destroy
- redirect_to spree.admin_admin_users_path, status: :see_other, notice: flash_message_for(@admin_user, :successfully_deleted)
- end
-
private
def permitted_params
params.require(:admin_user).permit(:email, :password, :password_confirmation, :first_name, :last_name)
end
- # load the resource to be used for authorization
- # this can be extended to load different resources, eg vendor users
- def load_resource
- @resource = current_store
- end
-
def load_invitation
raise ActiveRecord::RecordNotFound if params[:token].blank?
@invitation = Spree::Invitation.pending.not_expired.find_by!(token: params[:token])
end
+ def load_parent
+ @parent = current_store
+ end
+
def scope
- @resource.users.accessible_by(current_ability, :manage)
+ @parent.users.accessible_by(current_ability, :manage)
end
+ def load_admin_user
+ @admin_user = scope.find(params[:id])
+ end
+
+ # for self signup flow, we use the minimal layout
def choose_layout
@invitation.present? ? 'spree/minimal' : 'spree/admin'
end
- def load_admin_user
- @admin_user = scope.find(params[:id])
+ def load_roles
+ @roles = Spree::Role.accessible_by(current_ability)
end
end
end
diff --git a/admin/app/controllers/spree/admin/invitations_controller.rb b/admin/app/controllers/spree/admin/invitations_controller.rb
index e76613d8e8..e57437d8d8 100644
--- a/admin/app/controllers/spree/admin/invitations_controller.rb
+++ b/admin/app/controllers/spree/admin/invitations_controller.rb
@@ -3,7 +3,7 @@ module Spree
class InvitationsController < BaseController
skip_before_action :authorize_admin, only: [:show]
- before_action :load_invitation_resource
+ before_action :load_parent, except: [:show]
before_action :load_invitation, only: [:accept, :destroy]
before_action :load_roles, only: [:new, :create]
@@ -19,20 +19,21 @@ module Spree
# GET /admin/invitations/new
def new
- authorize! :manage, @resource
+ authorize! :create, Spree::Invitation
+ authorize! :manage, @parent
@invitation = Spree::Invitation.new
- @invitation.resource = @resource
+ @invitation.resource = @parent
@invitation.inviter = try_spree_current_user
end
# POST /admin/invitations
def create
authorize! :create, Spree::Invitation
- authorize! :manage, @resource
+ authorize! :manage, @parent
@invitation = Spree::Invitation.new(permitted_params)
- @invitation.resource = @resource
+ @invitation.resource = @parent
@invitation.inviter = try_spree_current_user
if @invitation.save
@@ -49,6 +50,7 @@ module Spree
def show
begin
@invitation = Spree::Invitation.pending.not_expired.find_by!(id: params[:id], token: params[:token])
+ @parent = @invitation.resource
if try_spree_current_user != @invitation.invitee
raise ActiveRecord::RecordNotFound
@@ -69,14 +71,14 @@ module Spree
def accept
@invitation = try_spree_current_user.invitations.pending.not_expired.find(params[:id])
@invitation.accept!
- redirect_to spree.admin_invitations_path, notice: Spree.t('invitation_accepted')
+ redirect_to spree.admin_path, notice: Spree.t('invitation_accepted')
end
# PUT /admin/invitations/:id/resend
def resend
@invitation = scope.find(params[:id])
@invitation.resend!
- redirect_to spree.admin_invitations_path, notice: Spree.t('invitation_resent')
+ redirect_back fallback_location: spree.admin_invitations_path, notice: Spree.t('invitation_resent')
end
# DELETE /admin/invitations/:id
@@ -84,7 +86,7 @@ module Spree
authorize! :destroy, @invitation
@invitation.destroy
- redirect_to spree.admin_invitations_path, notice: flash_message_for(@invitation, :successfully_removed)
+ redirect_back fallback_location: spree.admin_invitations_path, notice: flash_message_for(@invitation, :successfully_removed)
end
private
@@ -93,12 +95,12 @@ module Spree
@invitation = scope.find(params[:id])
end
- def load_invitation_resource
- @resource = current_store
+ def load_parent
+ @parent = current_store
end
def scope
- Spree::Invitation.accessible_by(current_ability).where(resource: @resource)
+ Spree::Invitation.accessible_by(current_ability).where(resource: @parent)
end
def load_roles
@@ -112,6 +114,10 @@ module Spree
def choose_layout
action_name == 'show' ? 'spree/minimal' : 'spree/admin'
end
+
+ def model_class
+ Spree::Invitation
+ end
end
end
end
diff --git a/admin/app/controllers/spree/admin/resource_users_controller.rb b/admin/app/controllers/spree/admin/resource_users_controller.rb
new file mode 100644
index 0000000000..57f35c6394
--- /dev/null
+++ b/admin/app/controllers/spree/admin/resource_users_controller.rb
@@ -0,0 +1,36 @@
+module Spree
+ module Admin
+ class ResourceUsersController < BaseController
+ before_action :load_parent
+ before_action :load_resource_user, only: [:edit, :update, :destroy]
+
+ # DELETE /admin/store/resource_users/:id
+ def destroy
+ authorize! :destroy, @resource_user
+
+ @resource_user.destroy
+ redirect_back fallback_location: spree.admin_admin_users_path, status: :see_other, notice: flash_message_for(@resource_user, :successfully_removed)
+ end
+
+ private
+
+ # load the resource to be used for authorization
+ # this can be extended to load different resources, eg vendor users
+ def load_parent
+ @parent = current_store
+ end
+
+ def scope
+ @parent.resource_users.accessible_by(current_ability, :manage)
+ end
+
+ def load_resource_user
+ @resource_user = scope.find(params[:id])
+ end
+
+ def model_class
+ Spree::ResourceUser
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/admin_users/_admin_user.html.erb b/admin/app/views/spree/admin/admin_users/_admin_user.html.erb
new file mode 100644
index 0000000000..d9593bebd8
--- /dev/null
+++ b/admin/app/views/spree/admin/admin_users/_admin_user.html.erb
@@ -0,0 +1,19 @@
+<tr id="<%= spree_dom_id admin_user %>" class="cursor-pointer" data-controller="row-link">
+ <td class="w-50" data-action="click->row-link#openLink">
+ <%= link_to spree.admin_admin_user_path(admin_user), data: { row_link_target: :link }, class: 'd-flex align-items-center' do %>
+ <%= render_avatar(admin_user, width: 48, height: 48, class: 'mr-3 avatar') %>
+ <div class="d-flex flex-column">
+ <%= admin_user.name %>
+ <span class="text-muted"><%= admin_user.email %></span>
+ </div>
+ <% end %>
+ </td>
+ <td class="w-30" data-action="click->row-link#openLink">
+ <% admin_user.spree_roles.each do |role| %>
+ <span class="badge badge-light"><%= role.name %></span>
+ <% end %>
+ </td>
+ <td class="w-20">
+ <%= local_time(admin_user.created_at) %>
+ </td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/admin_users/edit.html.erb b/admin/app/views/spree/admin/admin_users/edit.html.erb
index 1e77f066ec..499e56732a 100644
--- a/admin/app/views/spree/admin/admin_users/edit.html.erb
+++ b/admin/app/views/spree/admin/admin_users/edit.html.erb
@@ -1,5 +1,5 @@
<% content_for :page_title do %>
- <%= page_header_back_button spree.admin_admin_users_path, @admin_user %>
+ <%= page_header_back_button spree.admin_admin_users_path %>
<%= @admin_user.name %>
<% end %>
@@ -18,11 +18,11 @@
<div class="card-body">
<%= render'spree/admin/shared/error_messages', target: @admin_user %>
<%= render 'form', f: f %>
- <% if can?(:manage, Spree::Role) %>
+ <% if can?(:manage, Spree::Role) && @roles.any? %>
<div class="form-group">
<%= f.label :spree_role_ids, Spree.t(:roles) %>
<%= f.select :spree_role_ids,
- options_from_collection_for_select(Spree::Role.all, 'id', 'name', @admin_user.spree_roles.pluck(:id)),
+ options_from_collection_for_select(@roles, 'id', 'name', @admin_user.spree_roles.pluck(:id)),
{ prompt: false },
{ multiple: true, data: { controller: 'autocomplete-select' } } %>
</div>
diff --git a/admin/app/views/spree/admin/admin_users/index.html.erb b/admin/app/views/spree/admin/admin_users/index.html.erb
index 4ffa1e5819..ddf3c8b8b3 100644
--- a/admin/app/views/spree/admin/admin_users/index.html.erb
+++ b/admin/app/views/spree/admin/admin_users/index.html.erb
@@ -11,27 +11,7 @@
</tr>
</thead>
<tbody>
- <% @collection.each do |admin_user| %>
- <tr id="<%= spree_dom_id admin_user %>" class="cursor-pointer" data-controller="row-link">
- <td class="w-50" data-action="click->row-link#openLink">
- <%= link_to spree.admin_admin_user_path(admin_user), data: { row_link_target: :link }, class: 'd-flex align-items-center' do %>
- <%= render_avatar(admin_user, width: 48, height: 48, class: 'mr-3 avatar') %>
- <div class="d-flex flex-column">
- <%= admin_user.name %>
- <span class="text-muted"><%= admin_user.email %></span>
- </div>
- <% end %>
- </td>
- <td class="w-30" data-action="click->row-link#openLink">
- <% admin_user.spree_roles.each do |role| %>
- <span class="badge badge-light"><%= role.name %></span>
- <% end %>
- </td>
- <td class="w-20">
- <%= local_time(admin_user.created_at) %>
- </td>
- </tr>
- <% end %>
+ <%= render partial: 'spree/admin/admin_users/admin_user', collection: @collection %>
</tbody>
</table>
</div>
diff --git a/admin/app/views/spree/admin/invitations/_invitation.html.erb b/admin/app/views/spree/admin/invitations/_invitation.html.erb
index 70137f47c1..912190191a 100644
--- a/admin/app/views/spree/admin/invitations/_invitation.html.erb
+++ b/admin/app/views/spree/admin/invitations/_invitation.html.erb
@@ -3,7 +3,11 @@
<%= invitation.email %>
</td>
<td class="w-10">
- <%= link_to invitation.inviter.name, spree.admin_admin_user_path(invitation.inviter) %>
+ <% if can?(:read, invitation.inviter) %>
+ <%= link_to invitation.inviter.name, spree.admin_admin_user_path(invitation.inviter) %>
+ <% else %>
+ <%= invitation.inviter.name %>
+ <% end %>
</td>
<td class="w-20">
<% invitation.roles.each do |role| %>
diff --git a/admin/app/views/spree/admin/shared/_team_nav.html.erb b/admin/app/views/spree/admin/shared/_team_nav.html.erb
index b5ed755f07..1a0bf72ca3 100644
--- a/admin/app/views/spree/admin/shared/_team_nav.html.erb
+++ b/admin/app/views/spree/admin/shared/_team_nav.html.erb
@@ -10,4 +10,4 @@
<span data-toggle="modal" data-target="#modal">
<%= link_to_with_icon 'send', Spree.t('actions.send_invitation'), spree.new_admin_invitation_path, class: "btn btn-primary", data: { turbo_frame: 'dialog_modal' } %>
</span>
-<% end if can? :create, Spree.admin_user_class %>
\ No newline at end of file
+<% end if can? :create, Spree::Invitation %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb
index c03dec6b14..dbf6b449d6 100644
--- a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb
+++ b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb
@@ -6,7 +6,13 @@
<% if can?(:manage, current_store) %>
<%= nav_item(Spree.t(:store_details), spree.edit_admin_store_path(section: 'general-settings'), icon: 'building-store', active: params[:section] == 'general-settings') %>
- <%= nav_item(Spree.t(:users), spree.admin_admin_users_path, icon: 'users', active: %w[admin_users invitations roles].include?(controller_name)) if can?(:manage, Spree.admin_user_class) %>
+ <% end %>
+
+ <% if can?(:manage, Spree.admin_user_class) %>
+ <%= nav_item(Spree.t(:users), spree.admin_admin_users_path, icon: 'users', active: %w[resource_users invitations roles].include?(controller_name)) %>
+ <% end %>
+
+ <% if can?(:manage, current_store) %>
<%= nav_item(Spree.t(:emails), spree.edit_admin_store_path(section: 'emails'), icon: 'send', active: params[:section] == 'emails') %>
<%= nav_item(Spree.t(:policies), spree.edit_admin_store_path(section: 'policies'), icon: 'list-check', active: params[:section] == 'policies') %>
<%= nav_item(Spree.t(:checkout), spree.edit_admin_store_path(section: 'checkout'), icon: 'shopping-cart', active: params[:section] == 'checkout') %>
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index 264b0f0b31..de21b841d6 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -147,7 +147,9 @@ Spree::Core::Engine.add_routes do
end
end
# setting up a new store
- resources :stores, only: [:new, :create]
+ resources :stores, only: [:new, :create] do
+ resources :resource_users, only: [:destroy]
+ end
resources :payment_methods, except: :show
resources :shipping_methods, except: :show
resources :shipping_categories, except: :show
@@ -217,13 +219,13 @@ Spree::Core::Engine.add_routes do
# account management
resources :roles, except: :show
- resources :invitations do
+ resources :invitations, except: [:edit, :update] do
member do
put :accept
put :resend
end
end
- resources :admin_users
+ resources :admin_users, except: [:destroy]
# Action Text
namespace :action_text do
diff --git a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
index 910d62356f..18812130c9 100644
--- a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
@@ -214,8 +214,8 @@ RSpec.describe Spree::Admin::InvitationsController, type: :controller do
expect(invitation.accepted_at).to be_present
end
- it 'redirects to invitations path' do
- expect(response).to redirect_to(spree.admin_invitations_path)
+ it 'redirects to admin path' do
+ expect(response).to redirect_to(spree.admin_path)
end
it 'sets a notice flash message' do
diff --git a/admin/spec/controllers/spree/admin/resource_users_controller_spec.rb b/admin/spec/controllers/spree/admin/resource_users_controller_spec.rb
new file mode 100644
index 0000000000..3174c0c811
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/resource_users_controller_spec.rb
@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::ResourceUsersController, type: :controller do
+ render_views
+
+ stub_authorization!
+
+ let(:store) { @default_store }
+ let!(:resource_user) { create(:resource_user, resource: store) }
+
+ describe '#destroy' do
+ it 'deletes the resource user' do
+ expect(store.resource_users.count).to eq(1)
+
+ delete :destroy, params: { id: resource_user.id, store_id: store.id }
+
+ expect(response).to redirect_to(spree.admin_admin_users_path)
+ expect(flash[:notice]).to eq("Resource user \"#{resource_user.user.name}\" has been successfully removed!")
+ expect(store.resource_users.count).to eq(0)
+ end
+ end
+end
diff --git a/core/app/models/spree/resource_user.rb b/core/app/models/spree/resource_user.rb
index 996a1b7698..b5a4df5ba6 100644
--- a/core/app/models/spree/resource_user.rb
+++ b/core/app/models/spree/resource_user.rb
@@ -25,6 +25,11 @@ module Spree
after_create :set_roles
after_destroy :revoke_roles
+ #
+ # Delegations
+ #
+ delegate :email, :first_name, :last_name, :name, :spree_roles, to: :user
+
private
def set_roles
diff --git a/core/lib/spree/testing_support/factories/resource_user_factory.rb b/core/lib/spree/testing_support/factories/resource_user_factory.rb
index ce8644a8cf..3877e84a84 100644
--- a/core/lib/spree/testing_support/factories/resource_user_factory.rb
+++ b/core/lib/spree/testing_support/factories/resource_user_factory.rb
@@ -1,6 +1,8 @@
FactoryBot.define do
factory :resource_user, class: Spree::ResourceUser do
association :resource, factory: :store
- association :user, factory: :admin_user
+ user do
+ create(:admin_user, skip_resource_user: true)
+ end
end
end