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.

Invitations and Team management WIP

Damian Legawiec205c164b1e52
diff --git a/admin/app/assets/stylesheets/spree/admin/global/_variables.scss b/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
index e58f2f600a..31f870e3d0 100644
--- a/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
+++ b/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
@@ -50,7 +50,7 @@ $theme-colors: (
);
$body-color: #333 !default;
-$body-bg: #FCFCFC !default;
+$body-bg: $gray-25 !default;
$enable-shadows: false;
$enable-responsive-font-sizes: true;
$font-family-sans-serif: Inter, sans-serif !default;
diff --git a/admin/app/controllers/spree/admin/admin_users_controller.rb b/admin/app/controllers/spree/admin/admin_users_controller.rb
new file mode 100644
index 0000000000..e82d7a079a
--- /dev/null
+++ b/admin/app/controllers/spree/admin/admin_users_controller.rb
@@ -0,0 +1,90 @@
+module Spree
+ module Admin
+ class AdminUsersController < BaseController
+ skip_before_action :authorize_admin, only: [:new, :create]
+
+ before_action :load_invitation, only: [:new, :create]
+ before_action :load_admin_user, only: [:edit, :update, :destroy]
+
+ layout :choose_layout
+
+ # GET /admin/admin_users
+ def index
+ params[:q] ||= {}
+ params[:q][:s] ||= 'created_at asc'
+ @search = scope.ransack(params[:q])
+ @collection = @search.result
+ end
+
+ def show
+ @admin_user = scope.find(params[:id])
+ end
+
+ # GET /admin/admin_users/new?token=<token>
+ # this is a self signup flow for admin users from the invitation email
+ def new
+ @admin_user = Spree.admin_user_class.new
+ @admin_user.email = @invitation.email
+ end
+
+ # POST /admin/admin_users
+ # this is a self signup flow for admin users from the invitation email
+ def create
+ @admin_user = Spree.admin_user_class.new(permitted_params)
+ @admin_user.spree_role_ids = @invitation.role_ids
+ if @admin_user.save && @invitation.accept!
+ @invitation.update!(invitee: @admin_user)
+
+ # Automatically log in the user after successful signup
+ # if Devise is installed
+ if defined?(sign_in)
+ sign_in(Spree.admin_user_class.model_name.singular_route_key, @admin_user)
+ end
+ flash[:success] = Spree.t(:welcome_to_spree_admin)
+ redirect_to spree.admin_path
+ else
+ render :new, status: :unprocessable_entity
+ end
+ end
+
+ # GET /admin/admin_users/:id/edit
+ def edit
+ end
+
+ # PUT /admin/admin_users/:id
+ def update
+ authorize! :update, @admin_user
+
+ if @admin_user.update(permitted_params.merge(spree_role_ids: []))
+ redirect_to spree.edit_admin_admin_user_path(@admin_user), status: :see_other, notice: flash_message_for(@admin_user, :successfully_updated)
+ else
+ render :edit, status: :unprocessable_entity
+ end
+ end
+
+ private
+
+ def permitted_params
+ params.require(:admin_user).permit(:email, :password, :password_confirmation, :first_name, :last_name)
+ end
+
+ def load_invitation
+ raise ActiveRecord::RecordNotFound if params[:token].blank?
+
+ @invitation = Spree::Invitation.pending.not_expired.find_by!(token: params[:token])
+ end
+
+ def scope
+ Spree.admin_user_class.accessible_by(current_ability, :manage)
+ end
+
+ def choose_layout
+ @invitation.present? ? 'spree/minimal' : 'spree/admin'
+ end
+
+ def load_admin_user
+ @admin_user = scope.find(params[:id])
+ end
+ end
+ end
+end
diff --git a/admin/app/controllers/spree/admin/invitations_controller.rb b/admin/app/controllers/spree/admin/invitations_controller.rb
new file mode 100644
index 0000000000..363c1aae55
--- /dev/null
+++ b/admin/app/controllers/spree/admin/invitations_controller.rb
@@ -0,0 +1,112 @@
+module Spree
+ module Admin
+ class InvitationsController < BaseController
+ skip_before_action :authorize_admin, only: [:show]
+
+ before_action :load_invitation_resource
+ before_action :load_invitation, only: [:accept, :revoke, :destroy]
+ before_action :load_roles, only: [:new, :create]
+
+ layout :choose_layout
+
+ # GET /admin/invitations
+ def index
+ params[:q] ||= {}
+ params[:q][:s] ||= 'created_at desc'
+ @search = scope.includes(:inviter, :roles).ransack(params[:q])
+ @collection = @search.result
+ end
+
+ # GET /admin/invitations/new
+ def new
+ @invitation = Spree::Invitation.new
+ end
+
+ # POST /admin/invitations
+ def create
+ authorize! :create, Spree::Invitation
+ authorize! :manage, @resource
+
+ @invitation = Spree::Invitation.new(permitted_params)
+ @invitation.resource = @resource
+ @invitation.inviter = try_spree_current_user
+
+ if @invitation.save
+ respond_to do |format|
+ format.html { redirect_to spree.admin_invitations_path, notice: Spree.t('invitation_created') }
+ format.turbo_stream
+ end
+ else
+ render :new, status: :unprocessable_entity
+ end
+ end
+
+ # GET /admin/invitations/:id?token=:token
+ def show
+ @invitation = Spree::Invitation.pending.not_expired.find_by!(id: params[:id], token: params[:token])
+
+ # if there's no current user, redirect to the new admin user path so they can sign up
+ unless try_spree_current_user
+ redirect_to spree.new_admin_admin_user_path(token: @invitation.token), status: :see_other
+ return
+ end
+ end
+
+ # PUT /admin/invitations/:id/accept
+ 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')
+ end
+
+ # PUT /admin/invitations/:id/revoke
+ def revoke
+ authorize! :update, @invitation
+
+ @invitation.revoke!
+ redirect_to spree.admin_invitations_path, notice: Spree.t('invitation_revoked')
+ end
+
+ # PUT /admin/invitations/:id/resend
+ def resend
+ @invitation = try_spree_current_user.invitations.pending.not_expired.find(params[:id])
+ @invitation.resend!
+ redirect_to spree.admin_invitations_path, notice: Spree.t('invitation_resent')
+ end
+
+ # DELETE /admin/invitations/:id
+ def destroy
+ authorize! :destroy, @invitation
+
+ @invitation.destroy
+ redirect_to spree.admin_invitations_path, notice: flash_message_for(@invitation, :successfully_removed)
+ end
+
+ private
+
+ def load_invitation
+ @invitation = scope.find(params[:id])
+ end
+
+ def load_invitation_resource
+ @resource = current_store
+ end
+
+ def scope
+ Spree::Invitation.accessible_by(current_ability).where(resource: @resource)
+ end
+
+ def load_roles
+ @roles = Spree::Role.accessible_by(current_ability)
+ end
+
+ def permitted_params
+ params.require(:invitation).permit(:email, :expires_at, role_ids: [])
+ end
+
+ def choose_layout
+ action_name == 'show' ? 'spree/minimal' : 'spree/admin'
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rb
index d4ef00907d..e446421d3c 100644
--- a/admin/app/helpers/spree/admin/base_helper.rb
+++ b/admin/app/helpers/spree/admin/base_helper.rb
@@ -25,12 +25,10 @@ module Spree
# this is used to display different sidebar navigation for settings pages
# @return [Boolean]
def settings_active?
- @settings_active || %w[stores zones shipping_methods oauth_applications
- payment_methods refund_reasons reimbursement_types
- shipping_categories store_credit_categories
- syncs tax_categories tax_rates webhooks accounts
- custom_domains audits exports imports return_authorization_reasons
- documents stripe_tax_registrations members subscriptions stock_locations webhooks_subscribers].include?(controller_name)
+ @settings_active || %w[admin_users audits custom_domains exports imports invitations oauth_applications
+ payment_methods refund_reasons reimbursement_types return_authorization_reasons roles
+ shipping_categories shipping_methods stock_locations store_credit_categories
+ stores tax_categories tax_rates webhooks webhooks_subscribers zones].include?(controller_name)
end
# @return [Array<String>] the available countries for checkout
diff --git a/admin/app/helpers/spree/admin/stores_helper.rb b/admin/app/helpers/spree/admin/stores_helper.rb
index 79c5920b20..64418c27c1 100644
--- a/admin/app/helpers/spree/admin/stores_helper.rb
+++ b/admin/app/helpers/spree/admin/stores_helper.rb
@@ -36,23 +36,6 @@ module Spree
opts[:class] += ' rounded text-dark d-flex align-items-center justify-content-center bg-gray-200'
content_tag(:span, name[0].upcase, class: opts[:class], style: "height: #{opts[:height]}px; width: #{opts[:width]}px;")
end
-
- def store_logo(store = nil, options = {})
- store ||= current_store
- return unless store
-
- opts = { width: 30, height: 30, crop: :fit, quality: :auto, fetch_format: :auto, alt: store.name, title: store.name, class: 'with-tip' }
- opts.merge!(options)
-
- if store.is_a?(Spree::Store) && store.logo&.attached? && store.logo&.variable?
- spree_image_tag(store.logo, class: opts[:class], width: opts[:width], height: opts[:height])
- else
- initials = store.name.split.map(&:first).join.upcase
- content_tag(:div, initials, class: "avatar rounded with-tip bg-light",
- style: "width: #{opts[:height]}px; height: #{opts[:height]}px;",
- title: store.name)
- end
- end
end
end
end
diff --git a/admin/app/views/layouts/spree/minimal.html.erb b/admin/app/views/layouts/spree/minimal.html.erb
new file mode 100644
index 0000000000..d39d2e69a6
--- /dev/null
+++ b/admin/app/views/layouts/spree/minimal.html.erb
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+ <head>
+ <%= render "spree/admin/shared/head" %>
+ </head>
+ <body class="admin min-vh-100 <%= controller_name %> <%= action_name %>">
+ <div class="container">
+ <%= yield %>
+ </div>
+ <%= render "spree/admin/shared/modal" %>
+ <%= render "spree/admin/shared/alerts" %>
+ </body>
+</html>
diff --git a/admin/app/views/spree/admin/admin_users/edit.html.erb b/admin/app/views/spree/admin/admin_users/edit.html.erb
new file mode 100644
index 0000000000..75d86968a1
--- /dev/null
+++ b/admin/app/views/spree/admin/admin_users/edit.html.erb
@@ -0,0 +1,9 @@
+<% content_for :page_title do %>
+ <%= page_header_back_button spree.admin_admin_users_path, @admin_user %>
+ <%= @admin_user.name %>
+<% end %>
+
+<%= content_for :title do %>
+ <%= @admin_user.name %>
+<% end %>
+
diff --git a/admin/app/views/spree/admin/admin_users/index.html.erb b/admin/app/views/spree/admin/admin_users/index.html.erb
new file mode 100644
index 0000000000..bed363ca8b
--- /dev/null
+++ b/admin/app/views/spree/admin/admin_users/index.html.erb
@@ -0,0 +1,39 @@
+<%= render 'spree/admin/shared/team_nav' %>
+
+
+<div class="card-lg">
+ <div class="table-responsive">
+ <table class="table">
+ <thead class="text-muted">
+ <tr>
+ <th><%= Spree.t(:user) %></th>
+ <th><%= Spree.t(:roles) %></th>
+ <th><%= sort_link @search, :created_at, Spree.t(:created_at) %></th>
+ </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 %>
+ </tbody>
+ </table>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/admin_users/new.html.erb b/admin/app/views/spree/admin/admin_users/new.html.erb
new file mode 100644
index 0000000000..04e00875f6
--- /dev/null
+++ b/admin/app/views/spree/admin/admin_users/new.html.erb
@@ -0,0 +1,47 @@
+<div class="col-lg-6 offset-lg-3">
+
+ <div class="mx-auto mt-5 mb-3">
+ <% if current_store.logo.attached? %>
+ <%= spree_image_tag current_store.logo, class: 'mx-auto d-block', height: 64 %>
+ <% else %>
+ <%= image_tag 'logo.png', class: 'mx-auto d-block', height: 64 %>
+ <% end %>
+ </div>
+
+ <%= form_with model: @admin_user, url: spree.admin_admin_users_path(token: @invitation.token), method: :post, scope: :admin_user do |f| %>
+ <div class="card mb-5">
+ <div class="card-body">
+ <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @admin_user } %>
+
+ <div class="rounded border p-3 mb-3 d-flex align-items-center gap-2">
+ <%= render_avatar(@invitation.inviter, height: 32, width: 32) %>
+ <%= @invitation.inviter.name %> has invited you to join <strong><%= @invitation.resource.name %></strong>
+ </div>
+
+ <div class="form-group">
+ <%= f.label :email %>
+ <%= f.email_field :email, class: 'form-control', required: true, autofocus: true %>
+ </div>
+ <div class="form-group">
+ <%= f.label :first_name %>
+ <%= f.text_field :first_name, class: 'form-control', required: true %>
+ </div>
+ <div class="form-group">
+ <%= f.label :last_name %>
+ <%= f.text_field :last_name, class: 'form-control', required: true %>
+ </div>
+ <div class="form-group">
+ <%= f.label :password %>
+ <%= f.password_field :password, class: 'form-control', required: true %>
+ </div>
+ <div class="form-group">
+ <%= f.label :password_confirmation %>
+ <%= f.password_field :password_confirmation, class: 'form-control', required: true %>
+ </div>
+ </div>
+ <div class="card-footer">
+ <%= turbo_save_button_tag(Spree.t('create_a_new_account')) %>
+ </div>
+ </div>
+ <% end %>
+</div>
diff --git a/admin/app/views/spree/admin/admin_users/show.html.erb b/admin/app/views/spree/admin/admin_users/show.html.erb
new file mode 100644
index 0000000000..be7692bf76
--- /dev/null
+++ b/admin/app/views/spree/admin/admin_users/show.html.erb
@@ -0,0 +1,8 @@
+<% content_for :page_title do %>
+ <%= page_header_back_button spree.admin_admin_users_path, @admin_user %>
+ <%= @admin_user.name %>
+<% end %>
+
+<%= content_for :title do %>
+ <%= @admin_user.name %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/invitations/_invitation.html.erb b/admin/app/views/spree/admin/invitations/_invitation.html.erb
new file mode 100644
index 0000000000..53a90dba7e
--- /dev/null
+++ b/admin/app/views/spree/admin/invitations/_invitation.html.erb
@@ -0,0 +1,50 @@
+<tr id="<%= spree_dom_id invitation %>">
+ <td class="w-30">
+ <%= invitation.email %>
+ </td>
+ <td class="w-10">
+ <%= link_to invitation.inviter.name, spree.admin_admin_user_path(invitation.inviter) %>
+ </td>
+ <td class="w-20">
+ <% invitation.roles.each do |role| %>
+ <span class="badge badge-light"><%= role.name %></span>
+ <% end %>
+ </td>
+ <td class="w-20">
+ <% if invitation.accepted? %>
+ <span class="badge badge-success"><%= Spree.t(:accepted) %></span>
+ <% elsif invitation.revoked? %>
+ <span class="badge badge-danger"><%= Spree.t(:revoked) %></span>
+ <% elsif invitation.expired? %>
+ <span class="badge badge-warning"><%= Spree.t(:expired) %></span>
+ <% else %>
+ <span class="badge badge-light"><%= Spree.t(:pending) %></span>
+ <p class="text-muted font-size-sm mb-0 mt-2 pl-1">Expires at: <%= local_time(invitation.expires_at) %></p>
+ <% end %>
+ </td>
+ <td class="w-10">
+ <%= local_time(invitation.created_at) %>
+ </td>
+ <td class="w-10 actions">
+ <% if invitation.pending? && !invitation.expired? %>
+ <div class="dropdown" data-controller="clipboard">
+ <%= hidden_field_tag nil, spree.admin_invitation_url(invitation, token: invitation.token), data: { clipboard_target: "source" } %>
+
+ <button class="btn btn-sm btn-light" type="button" id="dropdownMenuButton-<%= invitation.id %>" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+ <%= icon('dots', class: 'mr-0') %>
+ </button>
+ <div class="dropdown-menu dropdown-menu-right" aria-labelledby="dropdownMenuButton-<%= invitation.id %>">
+ <%= link_to_with_icon 'copy', Spree.t(:copy_invitation_link), '#',
+ class: "dropdown-item",
+ data: { action: "clipboard#copy" } %>
+ <%= link_to_with_icon 'send', Spree.t(:resend_invitation), spree.resend_admin_invitation_path(invitation),
+ class: "dropdown-item",
+ data: { turbo_method: :put, turbo_confirm: Spree.t(:are_you_sure) } %>
+ <%= link_to_with_icon 'trash', Spree.t(:revoke), spree.revoke_admin_invitation_path(invitation),
+ class: "dropdown-item btn-danger",
+ data: { turbo_method: :put, turbo_confirm: Spree.t(:are_you_sure) } %>
+ </div>
+ </div>
+ <% end %>
+ </td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/invitations/create.turbo_stream.erb b/admin/app/views/spree/admin/invitations/create.turbo_stream.erb
new file mode 100644
index 0000000000..1b86f584fe
--- /dev/null
+++ b/admin/app/views/spree/admin/invitations/create.turbo_stream.erb
@@ -0,0 +1,4 @@
+<%= turbo_render_alerts %>
+<%= turbo_close_modal %>
+
+<%= turbo_stream.prepend 'invitations', partial: 'spree/admin/invitations/invitation', locals: { invitation: @invitation } %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/invitations/index.html.erb b/admin/app/views/spree/admin/invitations/index.html.erb
new file mode 100644
index 0000000000..0576c2d292
--- /dev/null
+++ b/admin/app/views/spree/admin/invitations/index.html.erb
@@ -0,0 +1,21 @@
+<%= render 'spree/admin/shared/team_nav' %>
+
+<div class="card-lg">
+ <div class="table-responsive">
+ <table class="table">
+ <thead class="text-muted">
+ <tr>
+ <th><%= Spree.t(:email) %></th>
+ <th><%= Spree.t(:inviter) %></th>
+ <th><%= Spree.t(:roles) %></th>
+ <th><%= Spree.t(:status) %></th>
+ <th><%= sort_link @search, :created_at, Spree.t(:created_at) %></th>
+ <th></th>
+ </tr>
+ </thead>
+ <tbody id="invitations">
+ <%= render collection: @collection, partial: 'spree/admin/invitations/invitation', as: :invitation %>
+ </tbody>
+ </table>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/invitations/new.html.erb b/admin/app/views/spree/admin/invitations/new.html.erb
new file mode 100644
index 0000000000..b62b78dae5
--- /dev/null
+++ b/admin/app/views/spree/admin/invitations/new.html.erb
@@ -0,0 +1,30 @@
+<%= turbo_frame_tag :dialog_modal do %>
+ <%= form_for @invitation,
+ url: spree.admin_invitations_path,
+ data: { controller: "enable-button" } do |f| %>
+ <div class="modal-content">
+ <%= modal_header Spree.t('invite_teammate') %>
+ <div class="modal-body">
+ <%= render 'spree/admin/shared/error_messages', target: @invitation %>
+ <div class="form-group">
+ <%= f.label :email, Spree.t(:email) %>
+ <%= f.email_field :email, class: 'form-control', required: :required, data: { 'enable-button-target': 'input' }, placeholder: 'eg. [email protected]' %>
+ </div>
+ <div class="form-group">
+ <%= f.label :role, Spree.t(:role) %>
+ <%= f.select :role_ids, @roles.map { |role| [role.name, role.id] }, {}, { data: { controller: 'autocomplete-select', 'enable-button-target': 'input' }, multiple: true, required: true } %>
+ </div>
+ <div class="form-group">
+ <%= f.label :expires_at, Spree.t(:expires_at) %>
+ <%= f.date_field :expires_at, class: 'form-control', required: true, data: { 'enable-button-target': 'input' } %>
+ </div>
+ </div>
+ <div class="modal-footer d-flex justify-content-between">
+ <%= turbo_save_button_tag nil, class: 'btn btn-primary', data: { 'enable-button-target': 'button' } do %>
+ <%= icon 'send' %>
+ <%= Spree.t('actions.send_invitation') %>
+ <% end %>
+ </div>
+ </div>
+ <% end %>
+<% end %>
diff --git a/admin/app/views/spree/admin/invitations/show.html.erb b/admin/app/views/spree/admin/invitations/show.html.erb
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/admin/app/views/spree/admin/roles/index.html.erb b/admin/app/views/spree/admin/roles/index.html.erb
index 5466db4859..68b53ab194 100644
--- a/admin/app/views/spree/admin/roles/index.html.erb
+++ b/admin/app/views/spree/admin/roles/index.html.erb
@@ -1,6 +1,4 @@
-<% content_for :page_title do %>
- <%= Spree.t(:roles) %>
-<% end %>
+<%= render 'spree/admin/shared/team_nav' %>
<% content_for :page_actions do %>
<%= link_to_with_icon 'plus', Spree.t(:new_role), new_object_url, class: "btn btn-primary" %>
@@ -12,16 +10,22 @@
<table class="table">
<thead class="text-muted">
<tr>
- <th><%= Spree.t(:role_id) %></th>
+ <th><%= Spree.t(:name) %></th>
+ <th><%= Spree.t(:permissions) %></th>
<th></th>
</tr>
</thead>
<tbody>
<% @collection.each do |role| %>
<tr id="<%= spree_dom_id role %>">
- <td><%= role.name %></td>
+ <td class="w-20">
+ <code><%= role.name %></code>
+ </td>
+ <td class="w-80">
+ <%= Spree.t(:all) %>
+ </td>
<td class="actions">
- <%= link_to_edit(role, no_text: true) if can? :edit, role %>
+ <%= link_to_edit(role) %>
</td>
</tr>
<% end %>
diff --git a/admin/app/views/spree/admin/shared/_content_header.html.erb b/admin/app/views/spree/admin/shared/_content_header.html.erb
index 835d0073d1..ec8f62cfb9 100644
--- a/admin/app/views/spree/admin/shared/_content_header.html.erb
+++ b/admin/app/views/spree/admin/shared/_content_header.html.erb
@@ -67,7 +67,7 @@
<% if content_for?(:page_tabs) %>
<div class="container">
- <ul class="nav nav-pills flex-nowrap overflow-auto w-100 mb-3">
+ <ul class="nav nav-pills flex-nowrap w-100 mb-3">
<%= yield :page_tabs %>
</ul>
</div>
diff --git a/admin/app/views/spree/admin/shared/_team_nav.html.erb b/admin/app/views/spree/admin/shared/_team_nav.html.erb
new file mode 100644
index 0000000000..83af3e5d94
--- /dev/null
+++ b/admin/app/views/spree/admin/shared/_team_nav.html.erb
@@ -0,0 +1,13 @@
+<% content_for :page_title, Spree.t(:team) %>
+
+<%= content_for(:page_tabs) do %>
+ <%= nav_item(Spree.t(:team), spree.admin_admin_users_path) if can?(:manage, Spree.admin_user_class) %>
+ <%= nav_item(Spree.t(:invitations), spree.admin_invitations_path) if can?(:manage, Spree::Invitation) %>
+ <%= nav_item(Spree.t(:roles), spree.admin_roles_path) if can?(:manage, Spree::Role) %>
+<% end %>
+
+<% content_for :page_actions do %>
+ <span data-toggle="modal" data-target="#modal">
+ <%= link_to_with_icon 'user-plus', Spree.t(:invite_teammate), spree.new_admin_invitation_path, class: "btn btn-primary", data: { turbo_frame: 'dialog_modal' } %>
+ </span>
+<% end if can? :create, Spree.admin_user_class && controller_name != 'roles' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/sidebar/_store_dropdown.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_dropdown.html.erb
index c676effe8a..449067c286 100644
--- a/admin/app/views/spree/admin/shared/sidebar/_store_dropdown.html.erb
+++ b/admin/app/views/spree/admin/shared/sidebar/_store_dropdown.html.erb
@@ -73,7 +73,7 @@
<% end if can?(:create, Spree::Product) %>
<%= link_to spree.new_admin_user_path, class: 'dropdown-item' do %>
<%= icon 'user' %>
- <%= Spree.t(:new_user) %>
+ <%= Spree.t(:new_customer) %>
<% end if can?(:create, Spree.user_class) %>
<%= link_to spree.new_admin_promotion_path, class: 'dropdown-item' do %>
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 a1ccb38980..3017b30f1f 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
@@ -1,19 +1,12 @@
<% if settings_active? %>
<ul class="nav flex-column">
<li class="nav-item mb-1 py-2 border-bottom border-bottom-dashed">
- <%= active_link_to_with_icon('chevron-left', Spree.t('admin.back_to_dashboard'), spree.admin_dashboard_path, class: 'nav-link') %>
+ <%= active_link_to_with_icon('arrow-back-up', Spree.t('admin.back_to_dashboard'), spree.admin_dashboard_path, class: 'nav-link') %>
</li>
<% 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') %>
- <% end %>
-
- <% if defined?(current_account) && current_account.present? && can?(:manage, current_account) %>
- <%= nav_item(Spree.t(:account), main_app.edit_account_path(current_account), icon: 'receipt') %>
- <%= nav_item(Spree.t(:account_members), main_app.account_members_path(current_account), icon: 'users') %>
- <% end %>
-
- <% if can?(:manage, current_store) %>
+ <%= nav_item(Spree.t(:team), spree.admin_admin_users_path, icon: 'users', active: %w[admin_users invitations roles].include?(controller_name)) if can?(:manage, Spree.admin_user_class) %>
<%= 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') %>
@@ -144,9 +137,7 @@
<% if can?(:manage, current_store) %>
<li class="nav-item border-top border-top-dashed my-1"></li>
<%= nav_item(Spree.t(:settings), spree.edit_admin_store_path(section: 'general-settings'), icon: 'settings', active: params[:section] == 'general-settings') %>
- <% end %>
- <% if defined?(current_account) && current_account.present? && can?(:manage, current_account) %>
- <%= nav_item(Spree.t(:account_members), main_app.account_members_path(current_account), icon: 'users') %>
+ <%= nav_item(Spree.t(:team), spree.admin_admin_users_path, icon: 'users') %>
<% end %>
</ul>
<% end %>
diff --git a/admin/app/views/spree/admin/users/new.html.erb b/admin/app/views/spree/admin/users/new.html.erb
index 8e16f52ac9..03796e47bf 100644
--- a/admin/app/views/spree/admin/users/new.html.erb
+++ b/admin/app/views/spree/admin/users/new.html.erb
@@ -1,6 +1,6 @@
<% content_for :page_title do %>
<%= page_header_back_button spree.admin_users_path %>
- <%= Spree.t(:new_user) %>
+ <%= Spree.t(:new_customer) %>
<% end %>
<%= form_for [:admin, @user], url: spree.admin_users_path, method: :post do |f| %>
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index f761d11adc..d6b41c40e4 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -217,6 +217,14 @@ Spree::Core::Engine.add_routes do
# account management
resources :roles, except: :show
+ resources :invitations, except: :destroy do
+ member do
+ put :accept
+ put :revoke
+ put :resend
+ end
+ end
+ resources :admin_users
# Action Text
namespace :action_text do
diff --git a/core/app/assets/images/logo.png b/core/app/assets/images/logo.png
new file mode 100644
index 0000000000..8d0d83f754
Binary files /dev/null and b/core/app/assets/images/logo.png differ
diff --git a/core/app/mailers/spree/invitation_mailer.rb b/core/app/mailers/spree/invitation_mailer.rb
new file mode 100644
index 0000000000..88b12449fa
--- /dev/null
+++ b/core/app/mailers/spree/invitation_mailer.rb
@@ -0,0 +1,15 @@
+module Spree
+ class InvitationMailer < BaseMailer
+ # invitation email, sending email to the invited to let them know they have been invited to join a store/account/vendor
+ def invitation_email(invitation)
+ @invitation = invitation
+ mail(to: invitation.email, subject: Spree.t('invitation_mailer.invitation_email.subject', resource_name: invitation.resource.name))
+ end
+
+ # accept/reject, sending email to the invited to let them know the status of their invitation
+ def invitation_accepted(invitation)
+ @invitation = invitation
+ mail(to: invitation.inviter.email, subject: Spree.t('invitation_mailer.invitation_accepted.subject', invitee_name: invitation.email, resource_name: invitation.resource.name))
+ end
+ end
+end
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 8c8426cc73..d328496f6f 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -31,6 +31,7 @@ module Spree
has_many :wishlists, class_name: 'Spree::Wishlist', foreign_key: :user_id, dependent: :destroy
has_many :wished_items, through: :wishlists, source: :wished_items
has_many :gateway_customers, class_name: 'Spree::GatewayCustomer', foreign_key: :user_id
+ has_many :invitations, class_name: 'Spree::Invitation', foreign_key: :invitee_id, dependent: :destroy
belongs_to :ship_address, class_name: 'Spree::Address', optional: true
belongs_to :bill_address, class_name: 'Spree::Address', optional: true
diff --git a/core/app/models/spree/invitation.rb b/core/app/models/spree/invitation.rb
new file mode 100644
index 0000000000..178c9177ad
--- /dev/null
+++ b/core/app/models/spree/invitation.rb
@@ -0,0 +1,126 @@
+module Spree
+ class Invitation < Base
+ has_secure_token
+
+ #
+ # Virtual Attributes
+ #
+ attribute :skip_email, :boolean, default: false
+
+ #
+ # Associations
+ #
+ belongs_to :resource, polymorphic: true # eg. Store, Vendor, Account
+ belongs_to :inviter, polymorphic: true # User or AdminUser
+ belongs_to :invitee, polymorphic: true # User or AdminUser
+ has_many :invitation_roles, dependent: :destroy
+ has_many :roles, through: :invitation_roles
+
+ #
+ # Validations
+ #
+ validates :email, email: true, presence: true
+ validates :token, presence: true, uniqueness: true
+ validates :inviter, presence: true
+ validates :roles, presence: true
+ validate :invitee_is_not_inviter, on: :create
+ validate :invitee_already_exists, on: :create
+
+ #
+ # Scopes
+ #
+ scope :pending, -> { where(status: 'pending') }
+ scope :accepted, -> { where(status: 'accepted') }
+ scope :revoked, -> { where(status: 'revoked') }
+ scope :not_expired, -> { where('expires_at > ?', Time.current) }
+ scope :for_resource, ->(resource) { where(resource_id: resource.id, resource_type: resource.class.name) }
+
+ #
+ # State Machine
+ #
+ state_machine initial: :pending, attribute: :status do
+ event :accept do
+ transition :pending => :accepted
+ end
+ after_transition to: :accepted, do: [:set_accepted_at, :send_acceptance_notification]
+
+ event :revoke do
+ transition :pending => :revoked
+ end
+ after_transition to: :revoked, do: [:set_revoked_at]
+ end
+
+ #
+ # Callbacks
+ #
+ after_initialize :set_defaults, if: :new_record?
+ after_create :send_invitation_email, unless: :skip_email
+
+ # returns the store for the invitation
+ # if the resource is a store, return the resource
+ # if the resource responds to store, return the store
+ # otherwise, return the current store
+ # @return [Spree::Store]
+ def store
+ if resource.is_a?(Spree::Store)
+ resource
+ elsif resource.respond_to?(:store)
+ resource.store
+ else
+ Spree::Store.current
+ end
+ end
+
+ # returns true if the invitation has expired
+ # @return [Boolean]
+ def expired?
+ expires_at < Time.current
+ end
+
+ def resend!
+ return if expired? || revoked? || accepted?
+
+ send_invitation_email
+ end
+
+ private
+
+ def send_invitation_email
+ Spree::InvitationMailer.invitation_email(self).deliver_later
+ end
+
+ def send_acceptance_notification
+ Spree::InvitationMailer.invitation_accepted(self).deliver_later
+ end
+
+ def set_defaults
+ self.expires_at ||= 2.weeks.from_now
+ end
+
+ def invitee_is_not_inviter
+ if invitee == inviter
+ errors.add(:invitee, 'cannot be the same as the inviter')
+ end
+ end
+
+ def invitee_already_exists
+ exists = if invitee.present?
+ store.admin_users.include?(invitee)
+ else
+ store.admin_users.exists?(email: email)
+ end
+
+ if exists
+ errors.add(:email, 'already exists')
+ end
+ end
+
+ def set_accepted_at
+ update!(accepted_at: Time.current)
+ end
+
+ def set_revoked_at
+ update!(revoked_at: Time.current)
+ end
+ end
+end
diff --git a/core/app/models/spree/invitation_role.rb b/core/app/models/spree/invitation_role.rb
new file mode 100644
index 0000000000..01fa82c78a
--- /dev/null
+++ b/core/app/models/spree/invitation_role.rb
@@ -0,0 +1,6 @@
+module Spree
+ class InvitationRole < Base
+ belongs_to :invitation, class_name: 'Spree::Invitation'
+ belongs_to :role, class_name: 'Spree::Role'
+ end
+end
diff --git a/core/app/models/spree/invitations/store.rb b/core/app/models/spree/invitations/store.rb
new file mode 100644
index 0000000000..cc6d75720e
--- /dev/null
+++ b/core/app/models/spree/invitations/store.rb
@@ -0,0 +1,6 @@
+module Spree
+ module Invitations
+ class Store < Base
+ end
+ end
+end
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index 22350d117c..51d2aeb323 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -351,6 +351,8 @@ module Spree
@admin_users ||= Spree.admin_user_class.joins(:spree_roles).where(spree_roles: { name: :admin })
end
+ alias_method :users, :admin_users
+
def favicon
return unless favicon_image.attached? && favicon_image.variable?
diff --git a/core/app/views/spree/invitation_mailer/invitation_email.html.erb b/core/app/views/spree/invitation_mailer/invitation_email.html.erb
new file mode 100644
index 0000000000..41df0947ae
--- /dev/null
+++ b/core/app/views/spree/invitation_mailer/invitation_email.html.erb
@@ -0,0 +1,21 @@
+<h1>
+ <%= Spree.t('invitation_mailer.greeting', user_name: @invitation.invitee&.name || @invitation.email) %>
+</h1>
+<p>
+ <%= Spree.t('invitation_mailer.invitation_email.body', inviter_name: @invitation.inviter.name, resource_name: @invitation.resource.name) %>
+</p>
+<p>
+ <%= Spree.t('invitation_mailer.invitation_email.link_description') %>
+</p>
+
+<% if spree.respond_to?(:admin_invitation_url) %>
+ <p>
+ <%= link_to Spree.t('invitation_mailer.invitation_email.link_text'), spree.admin_invitation_url(@invitation, token: @invitation.token, host: @current_store.formatted_url) %>
+ </p>
+<% end %>
+
+<p>
+ <%= Spree.t('invitation_mailer.thanks') %><br />
+ <%= current_store.name %>
+</p>
+
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 327b0ba0a1..1396c69c8d 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -823,7 +823,6 @@ en:
coupon_codes: Coupon codes
create: Create
create_a_new_account: Create a new account
- create_account: Create account
create_customer: Create customer
create_new: Create new
create_new_order: Create new order
@@ -1131,6 +1130,18 @@ en:
inventory_adjustment: Inventory Adjustment
inventory_error_flash_for_insufficient_quantity: An item in your cart has become unavailable.
inventory_state: Inventory State
+ invitation_accepted: Invitation accepted!
+ invitation_revoked: Invitation revoked!
+ invitation_mailer:
+ greeting: Hi %{user_name},
+ thanks: Thank you,
+ invitation_email:
+ subject: Invitation to join %{resource_name}
+ body: "%{inviter_name} has invited you to join %{resource_name}"
+ link_description: "To accept this invitation, please click the link below:"
+ invitation_accepted:
+ subject: "%{invitee_name} has accepted your invitation to join %{resource_name}"
+ body: "%{invitee_name} has accepted your invitation to join %{resource_name}"
is_not_available_to_shipment_address: is not available to shipment address
iso: ISO Alpha-2
iso3: ISO Alpha-3
@@ -1235,7 +1246,7 @@ en:
new_billing_address: New Billing Address
new_country: New Country
new_custom_domain: New Custom Domain
- new_customer: Create new account
+ new_customer: New Customer
new_customer_return: New Customer Return
new_digital_asset: New digital asset
new_domain: New domain
diff --git a/core/db/migrate/20250410061306_create_spree_invitations.rb b/core/db/migrate/20250410061306_create_spree_invitations.rb
new file mode 100644
index 0000000000..e1f1272f34
--- /dev/null
+++ b/core/db/migrate/20250410061306_create_spree_invitations.rb
@@ -0,0 +1,28 @@
+class CreateSpreeInvitations < ActiveRecord::Migration[7.2]
+ def change
+ create_table :spree_invitations do |t|
+ t.string :email, index: true, null: false
+ t.string :token, index: { unique: true }, null: false
+ t.string :status, null: false
+
+ t.references :resource, polymorphic: true, index: true, null: false # eg. Store, Vendor, Account
+ t.references :inviter, polymorphic: true, index: true, null: false
+ t.references :invitee, polymorphic: true, index: true
+
+ t.datetime :accepted_at
+ t.datetime :revoked_at
+ t.datetime :expires_at
+
+ t.timestamps
+ end
+
+ # attach roles to invitations
+ create_table :spree_invitation_roles do |t|
+ t.references :invitation, null: false
+ t.references :role, null: false
+
+ t.timestamps
+ end
+ add_index :spree_invitation_roles, [:invitation_id, :role_id], unique: true
+ end
+end
diff --git a/storefront/app/views/devise/registrations/_form.html.erb b/storefront/app/views/devise/registrations/_form.html.erb
index 0b3fca9dc8..b64616a369 100644
--- a/storefront/app/views/devise/registrations/_form.html.erb
+++ b/storefront/app/views/devise/registrations/_form.html.erb
@@ -1,6 +1,6 @@
<div class="card-dialog mx-auto lg:w-1/3">
<% unless params[:checkout] %>
- <h3 class="mb-5 font-semibold"><%= Spree.t(:create_account) %></h3>
+ <h3 class="mb-5 font-semibold"><%= Spree.t(:create_a_new_account) %></h3>
<% end %>
<%= render partial: 'spree/shared/error_messages', locals: { target: @user } %>
<%= form_for resource, as: :spree_user, url: spree.registration_path(checkout: params[:checkout]), data: { turbo: false } do |f| %>
@@ -16,6 +16,6 @@
</div>
</div>
</div>
- <%= f.submit Spree.t(:create_account), class: 'btn-primary block w-full lg:w-48 text-center mx-auto' %>
+ <%= f.submit Spree.t(:create_a_new_account), class: 'btn-primary block w-full lg:w-48 text-center mx-auto' %>
<% end %>
</div>