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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Open source admin customer store credits (#12416)
Łukasz Adamczykcb5d9a27000e
diff --git a/admin/app/controllers/spree/admin/store_credits_controller.rb b/admin/app/controllers/spree/admin/store_credits_controller.rbnew file mode 100644index 0000000000..579cc95b6d--- /dev/null+++ b/admin/app/controllers/spree/admin/store_credits_controller.rb@@ -0,0 +1,93 @@+module Spree+ module Admin+ class StoreCreditError < StandardError; end++ class StoreCreditsController < Spree::Admin::BaseController+ before_action :load_user+ before_action :load_store_credit, only: [:new, :edit, :update]+ before_action :ensure_unused_store_credit, only: [:update]++ def index+ @store_credits = scope.includes(:category).order(created_at: :desc)+ @store_credits = @store_credits.page(params[:page]).per(params[:per_page])++ @collection = @store_credits+ end++ def create+ @store_credit = @user.store_credits.build(+ permitted_store_credit_params.merge(+ created_by: try_spree_current_user,+ action_originator: try_spree_current_user,+ store: current_store+ )+ )++ if @store_credit.save+ flash[:success] = flash_message_for(@store_credit, :successfully_created)+ redirect_to spree.admin_user_path(@user)+ else+ flash[:error] = Spree.t('store_credit.errors.unable_to_create')+ render :new, status: :unprocessable_entity+ end+ end++ def update+ @store_credit.assign_attributes(permitted_store_credit_params)+ @store_credit.created_by = try_spree_current_user++ if @store_credit.save+ flash[:success] = flash_message_for(@store_credit, :successfully_updated)+ redirect_to spree.admin_user_path(@user)+ else+ flash[:error] = Spree.t('store_credit.errors.unable_to_update')+ render :edit, status: :unprocessable_entity+ end+ end++ def destroy+ @store_credit = @user.store_credits.for_store(current_store).find(params[:id])+ ensure_unused_store_credit++ if @store_credit.destroy+ flash[:success] = flash_message_for(@store_credit, :successfully_removed)+ else+ flash[:error] = Spree.t('store_credit.errors.unable_to_delete')+ end++ redirect_to spree.admin_user_path(@user)+ end++ protected++ def permitted_store_credit_params+ params.require(:store_credit).permit(permitted_store_credit_attributes)+ end++ private++ def load_user+ @user = Spree.user_class.find_by(id: params[:user_id])++ unless @user+ flash[:error] = Spree.t(:user_not_found)+ redirect_to spree.admin_path+ end+ end++ def load_store_credit+ @store_credit = scope.find_by(id: params[:id]) || scope.new+ end++ def scope+ current_store.store_credits.where(user: @user)+ end++ def ensure_unused_store_credit+ unless @store_credit.amount_used.zero?+ raise StoreCreditError, Spree.t('store_credit.errors.cannot_change_used_store_credit')+ end+ end+ end+ end+enddiff --git a/admin/app/views/spree/admin/store_credits/_form.html.erb b/admin/app/views/spree/admin/store_credits/_form.html.erbnew file mode 100644index 0000000000..76cade39b3--- /dev/null+++ b/admin/app/views/spree/admin/store_credits/_form.html.erb@@ -0,0 +1,24 @@+<div data-hook='admin_store_credit_form_fields'>+ <div class="row mb-2">+ <div class="col-6">+ <div class="form-group">+ <%= f.label :amount, raw(Spree.t(:amount) + required_span_tag) %>+ <%= f.number_field :amount, class: 'form-control', step: 0.01, required: true, disabled: !f.object.editable? %>+ <%= f.error_message_on :amount %>+ </div>+ </div>++ <div class="col-6">+ <div class="form-group">+ <%= f.label :currency, raw(Spree.t(:currency) + required_span_tag), class: 'form-label' %>+ <%= f.currency_select :currency, preferred_currencies, {}, { data: { controller: 'autocomplete-select', enable_button_target: 'input', store_form_target: 'currency' } } %>+ </div>+ </div>+ </div>++ <div class="form-group">+ <%= f.label :memo, Spree.t(:memo) %>+ <%= f.text_area :memo, class: 'form-control' %>+ <%= f.error_message_on :memo %>+ </div>+</div>diff --git a/admin/app/views/spree/admin/store_credits/_list.html.erb b/admin/app/views/spree/admin/store_credits/_list.html.erbnew file mode 100644index 0000000000..b7c199aa18--- /dev/null+++ b/admin/app/views/spree/admin/store_credits/_list.html.erb@@ -0,0 +1,35 @@+<% if @store_credits.any? %>+ <div class="table-responsive">+ <table class="table">+ <thead class="text-muted">+ <th><%= Spree.t(:credited) %></th>+ <th><%= Spree.t(:used) %></th>+ <th><%= Spree.t(:created_by) %></th>+ <th><%= Spree.t(:issued_on) %></th>+ <th data-hook="admin_store_credits_index_header_actions" class="actions"></th>+ <thead class="text-muted">+ <tbody>+ <% @store_credits.each do |store_credit| %>+ <tr>+ <td><%= store_credit.display_amount.to_html %></td>+ <td><%= store_credit.display_amount_used.to_html %></td>+ <td><%= store_credit.created_by_email %></td>+ <td><%= local_date(store_credit.created_at) %></td>+ <td class="actions">+ <% if store_credit.editable? && can?(:edit, store_credit) %>+ <%= link_to_edit_url spree.edit_admin_user_store_credit_path(@user, store_credit), no_text: true, data: { 'turbo-frame': '_top' } %>+ <% end %>+ </td>+ </tr>+ <% end %>+ </tbody>+ </table>+ </div>+<% else %>+ <div class="text-muted p-5 d-flex align-items-center w-100 justify-content-center">+ <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::StoreCredit)) %>+ <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_user_store_credit_path(@user), class: 'btn btn-link', data: { 'turbo-frame': '_top' } if can?(:create, Spree::StoreCredit) %>+ </div>+<% end %>++<%= render partial: 'spree/admin/shared/index_table_options', locals: { collection: @collection } %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/store_credits/edit.html.erb b/admin/app/views/spree/admin/store_credits/edit.html.erbnew file mode 100644index 0000000000..571173e58d--- /dev/null+++ b/admin/app/views/spree/admin/store_credits/edit.html.erb@@ -0,0 +1,36 @@+<% content_for :title do %>+ <%= Spree.t(:store_credit_name) %>+<% end %>++<% content_for :page_title do %>+ <%= page_header_back_button spree.admin_user_path(@user) %>+ <%= Spree.t(:new_store_credit) %>+<% end %>++<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @store_credit } %>++<%= form_for @store_credit, url: spree.admin_user_store_credit_path(@user, @store_credit) do |f| %>+ <div class="card mb-4">+ <div class="card-header">+ <h5 class="card-title">+ <%= Spree.t(:store_credit_name) %>+ </h5>+ </div>++ <div class="card-body">+ <%= render 'form', f: f %>+ </div>+ </div>++ <% if can? :update, @store_credit %>+ <div class="form-actions">+ <%= turbo_save_button_tag Spree.t('actions.update') %>++ <% if @store_credit.can_be_deleted? && can?(:delete, @store_credit) %>+ <%= link_to Spree.t('actions.destroy'), spree.admin_user_store_credit_path(@user),+ data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure) },+ class: 'btn btn-danger ml-auto' %>+ <% end %>+ </div>+ <% end %>+<% end %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/store_credits/index.html.erb b/admin/app/views/spree/admin/store_credits/index.html.erbnew file mode 100644index 0000000000..7e49f43b41--- /dev/null+++ b/admin/app/views/spree/admin/store_credits/index.html.erb@@ -0,0 +1,20 @@+<% unless turbo_frame_request? %>+ <% content_for :page_title do %>+ <%= page_header_back_button spree.admin_user_path(@user) %>+ <%= Spree.t(:store_credit_name) %>+ <% end %>++ <% content_for :page_actions do %>+ <%= button_link_to Spree.t(:add_store_credit), spree.new_admin_user_store_credit_path(@user), class: "btn-primary", icon: 'plus' if can?(:create, Spree::StoreCredit) %>+ <% end %>+<% end %>++<div class="card-lg p-0">+ <% if params[:frame_name].present? %>+ <%= turbo_frame_tag params[:frame_name], autoscroll: true, data: { autoscroll_block: :nearest, autoscroll_behavior: :smooth } do %>+ <%= render 'list' %>+ <% end %>+ <% else %>+ <%= render 'list' %>+ <% end %>+</div>diff --git a/admin/app/views/spree/admin/store_credits/new.html.erb b/admin/app/views/spree/admin/store_credits/new.html.erbnew file mode 100644index 0000000000..99f2848713--- /dev/null+++ b/admin/app/views/spree/admin/store_credits/new.html.erb@@ -0,0 +1,26 @@+<% content_for :title do %>+ <%= Spree.t(:store_credit_name) %>+<% end %>++<% content_for :page_title do %>+ <%= page_header_back_button spree.admin_user_path(@user) %>+ <%= Spree.t(:new_store_credit) %>+<% end %>++<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @store_credit } %>++<%= form_for @store_credit, url: spree.admin_user_store_credits_path(@user, @store_credit) do |f| %>+ <div class="card mb-4">+ <div class="card-header">+ <h5 class="card-title">+ <%= Spree.t(:store_credit_name) %>+ </h5>+ </div>++ <div class="card-body">+ <%= render 'form', f: f %>+ </div>+ </div>++ <%= render partial: 'spree/admin/shared/new_resource_links', locals: { collection_url: spree.admin_user_store_credits_path(@user) } %>+<% end %>diff --git a/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rbnew file mode 100644index 0000000000..d902de0d26--- /dev/null+++ b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb@@ -0,0 +1,121 @@+require 'spec_helper'++RSpec.describe Spree::Admin::StoreCreditsController, type: :controller do+ stub_authorization!+ render_views++ let(:user) { create(:user) }++ describe 'GET #index' do+ let!(:store_credits) { create_list(:store_credit, 3, user: user) }+ let!(:other_store_credits) { create_list(:store_credit, 3) }++ it 'renders the list of store credits' do+ get :index, params: { user_id: user.id }++ expect(response).to be_successful+ expect(response).to render_template(:index)++ expect(assigns(:store_credits)).to contain_exactly(*store_credits)+ end+ end++ describe 'GET #new' do+ it 'renders the new store credit form' do+ get :new, params: { user_id: user.id }++ expect(response).to be_successful+ expect(response).to render_template(:new)+ end+ end++ describe 'POST #create' do+ subject { post :create, params: { user_id: user.id, store_credit: store_credit_params } }++ let(:store_credit_params) { { amount: 100, currency: 'USD' } }++ let(:store_credit) { user.store_credits.last }++ it 'creates a new user store credit' do+ expect { subject }.to change { user.reload.store_credits.count }.by(1)++ expect(response).to redirect_to(spree.admin_user_path(user))++ expect(store_credit.amount).to eq(100)+ expect(store_credit.currency).to eq('USD')+ end++ context 'when the store credit is not valid' do+ let(:store_credit_params) { { amount: 100 } }++ it 'does not create a new store credit' do+ expect { subject }.not_to change { user.reload.store_credits.count }++ expect(response).to be_unprocessable+ expect(response).to render_template(:new)++ expect(flash[:error]).to eq(Spree.t('store_credit.errors.unable_to_create'))+ end+ end+ end++ describe 'GET #edit' do+ let(:store_credit) { create(:store_credit, user: user) }++ it 'renders the edit store credit form' do+ get :edit, params: { user_id: user.id, id: store_credit.id }++ expect(response).to be_successful+ expect(response).to render_template(:edit)+ end+ end++ describe 'PUT #update' do+ subject { put :update, params: { user_id: user.id, id: store_credit.id, store_credit: store_credit_params } }++ let(:store_credit) { create(:store_credit, user: user) }+ let(:store_credit_params) { { amount: 200 } }++ it 'updates the store credit' do+ expect { subject }.to change { store_credit.reload.amount }.to(200)++ expect(response).to redirect_to(spree.admin_user_path(user))+ end++ context 'when the store credit is not valid' do+ let(:store_credit_params) { { amount: 200, currency: nil } }++ it 'does not update the store credit' do+ expect { subject }.not_to change { store_credit.reload.amount }++ expect(response).to be_unprocessable+ expect(response).to render_template(:edit)++ expect(flash[:error]).to eq(Spree.t('store_credit.errors.unable_to_update'))+ end+ end+ end++ describe 'DELETE #destroy' do+ subject { delete :destroy, params: { user_id: user.id, id: store_credit.id } }++ let(:store_credit) { create(:store_credit, user: user) }++ it 'deletes the store credit' do+ subject++ expect(response).to redirect_to(spree.admin_user_path(user))+ expect(store_credit.reload).to be_deleted+ end++ context 'when the store credit is used' do+ let(:store_credit) { create(:store_credit, user: user, amount: 100, amount_used: 50) }++ it 'does not delete the store credit' do+ expect { subject }.to raise_error(Spree::Admin::StoreCreditError, Spree.t('store_credit.errors.cannot_change_used_store_credit'))++ expect(store_credit.reload).not_to be_deleted+ end+ end+ end+end