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 company self-service on the Store API
Damian Legawiec00c80b22f5a5
diff --git a/spree/api/app/controllers/spree/api/v3/store/account/companies_controller.rb b/spree/api/app/controllers/spree/api/v3/store/account/companies_controller.rbnew file mode 100644index 0000000000..2b504a4037--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/account/companies_controller.rb@@ -0,0 +1,42 @@+module Spree+ module Api+ module V3+ module Store+ module Account+ # The signed-in buyer's company memberships — each with its node and+ # ancestor path, so an account page can offer "buying for" choices+ # in one request.+ class CompaniesController < ResourceController+ prepend_before_action :require_authentication!++ # GET /api/v3/store/account/companies+ def index+ memberships = current_user.company_memberships.+ joins(:company).+ merge(Spree::Company.where(store_id: current_store.id)).+ includes(company: :parent)++ render json: {+ 'data' => memberships.map do |membership|+ Spree.api.company_membership_serializer.new(membership, params: serializer_params).to_h.merge(+ 'company' => Spree.api.company_serializer.new(membership.company, params: serializer_params).to_h+ )+ end+ }+ end++ protected++ def model_class+ Spree::CompanyMembership+ end++ def serializer_class+ Spree.api.company_membership_serializer+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rbindex 7e94e4296f..c20a6fa895 100644--- a/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/carts_controller.rb@@ -187,6 +187,7 @@ module Spree:shipping_address_id,:billing_address_id,:preferred_stock_location_id,+ :company_id,:use_shipping,shipping_address: address_params,billing_address: address_params,diff --git a/spree/api/app/controllers/spree/api/v3/store/companies/addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies/addresses_controller.rbnew file mode 100644index 0000000000..8e760a477f--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies/addresses_controller.rb@@ -0,0 +1,58 @@+module Spree+ module Api+ module V3+ module Store+ module Companies+ # The node's address book, managed by its members. Editing and+ # deleting an entry are addressed directly+ # (Store::CompanyAddressesController).+ class AddressesController < BaseController+ # Enumerated rather than borrowing a global list, which permits+ # :id, :user_id and :deleted_at.+ ADDRESS_KEYS = [+ :first_name, :last_name, :company, :address1, :address2, :city,+ :postal_code, :zipcode, :phone, :country_code, :state_code, :state_name, :label+ ].freeze++ # POST /api/v3/store/companies/:company_id/addresses+ def create+ entry = @parent.company_addresses.new(permitted_params)++ if entry.save+ render json: serialize_resource(entry), status: :created+ else+ render_validation_error(entry.errors)+ end+ end++ protected++ def model_class+ Spree::CompanyAddress+ end++ def serializer_class+ Spree.api.company_address_serializer+ end++ def scope+ @parent.company_addresses+ end++ def parent_association+ :company_addresses+ end++ def collection_includes+ [:address]+ end++ def permitted_params+ params.permit(:label, :default_billing, :default_shipping, address: ADDRESS_KEYS)+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/companies/base_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies/base_controller.rbnew file mode 100644index 0000000000..6d9afcb081--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies/base_controller.rb@@ -0,0 +1,24 @@+module Spree+ module Api+ module V3+ module Store+ module Companies+ # Anything a member manages under a company node. The parent is+ # resolved through the caller's standing, so a node they may not act+ # for is a 404 rather than a readable record.+ class BaseController < ResourceController+ prepend_before_action :require_authentication!++ protected++ def set_parent+ @parent = @company = storefront_access_policy.+ scope(current_store.companies).+ find_by_prefix_id!(params[:company_id])+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/companies/invitations_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies/invitations_controller.rbnew file mode 100644index 0000000000..cc1df41db8--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies/invitations_controller.rb@@ -0,0 +1,31 @@+module Spree+ module Api+ module V3+ module Store+ module Companies+ # The pending invitations into one node, visible to its members.+ # Revocation is addressed directly by invitation id.+ class InvitationsController < BaseController+ protected++ def model_class+ Spree::CompanyInvitation+ end++ def serializer_class+ Spree.api.company_invitation_serializer+ end++ def scope+ @parent.invitations+ end++ def parent_association+ :invitations+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/companies/members_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies/members_controller.rbnew file mode 100644index 0000000000..ef93b9cef3--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies/members_controller.rb@@ -0,0 +1,58 @@+module Spree+ module Api+ module V3+ module Store+ module Companies+ # The people with standing over one node, listed and added by its+ # members. Adding takes an email and does the right thing: a+ # membership for an existing customer, an invitation otherwise —+ # the same convergent behavior as the dashboard endpoint. Any member+ # can invite; restraint is Enterprise's policy layer.+ class MembersController < BaseController+ # POST /api/v3/store/companies/:company_id/members+ def create+ result = Spree.company_add_member_service.call(+ company: @parent,+ email: params.require(:customer_email),+ inviter: current_user+ )++ if result.success?+ serializer = if result.value.is_a?(Spree::CompanyInvitation)+ Spree.api.company_invitation_serializer+ else+ serializer_class+ end+ render json: serializer.new(result.value, params: serializer_params).to_h, status: :created+ else+ render_validation_error(result.value.errors)+ end+ end++ protected++ def model_class+ Spree::CompanyMembership+ end++ def serializer_class+ Spree.api.company_membership_serializer+ end++ def scope+ @parent.memberships+ end++ def parent_association+ :memberships+ end++ def collection_includes+ [:customer]+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/companies/orders_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies/orders_controller.rbnew file mode 100644index 0000000000..a0a67c5803--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies/orders_controller.rb@@ -0,0 +1,28 @@+module Spree+ module Api+ module V3+ module Store+ module Companies+ # Completed purchases across the node's subtree — every member sees+ # them; per-member narrowing is Enterprise's policy layer.+ class OrdersController < BaseController+ protected++ def model_class+ Spree::Order+ end++ def serializer_class+ Spree.api.order_serializer+ end++ def scope+ current_store.orders.complete.+ where(company_id: @parent.self_and_descendants.select(:id))+ end+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/companies_controller.rb b/spree/api/app/controllers/spree/api/v3/store/companies_controller.rbnew file mode 100644index 0000000000..f2af170197--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/companies_controller.rb@@ -0,0 +1,47 @@+module Spree+ module Api+ module V3+ module Store+ # A company node, self-served by its members. Authorization is+ # standing plus the storefront access policy — never CanCanCan, never+ # roles: OSS lets any member act within their subtree, and Enterprise+ # narrows through the policy class+ # (docs/plans/6.0-b2b-companies-and-catalogs.md).+ class CompaniesController < ResourceController+ prepend_before_action :require_authentication!++ # PATCH /api/v3/store/companies/:id+ def update+ authorize_storefront_write!(@resource)++ if @resource.update(permitted_params)+ render json: serialize_resource(@resource)+ else+ render_validation_error(@resource.errors)+ end+ end++ protected++ def model_class+ Spree::Company+ end++ def serializer_class+ Spree.api.company_serializer+ end++ # The nodes the caller has standing over — a node outside it is a+ # 404, never a readable record.+ def scope+ storefront_access_policy.scope(current_store.companies)+ end++ def permitted_params+ params.permit(:name)+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/company_addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/store/company_addresses_controller.rbnew file mode 100644index 0000000000..125f27d8f8--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/company_addresses_controller.rb@@ -0,0 +1,52 @@+module Spree+ module Api+ module V3+ module Store+ # An address-book entry addressed directly. Reached through the+ # caller's standing — an entry of a node they may not act for is a+ # 404.+ class CompanyAddressesController < ResourceController+ prepend_before_action :require_authentication!++ # PATCH /api/v3/store/company_addresses/:id+ def update+ if @resource.update(permitted_params)+ render json: serialize_resource(@resource.reload)+ else+ render_validation_error(@resource.errors)+ end+ end++ # DELETE /api/v3/store/company_addresses/:id+ def destroy+ @resource.destroy!+ head :no_content+ rescue ActiveRecord::RecordNotDestroyed => e+ render_validation_error(e.record.errors.presence || e.message)+ end++ protected++ def model_class+ Spree::CompanyAddress+ end++ def serializer_class+ Spree.api.company_address_serializer+ end++ def scope+ Spree::CompanyAddress.where(+ company_id: storefront_access_policy.scope(current_store.companies).select(:id)+ )+ end++ def permitted_params+ params.permit(:label, :default_billing, :default_shipping,+ address: Companies::AddressesController::ADDRESS_KEYS)+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/company_invitations_controller.rb b/spree/api/app/controllers/spree/api/v3/store/company_invitations_controller.rbnew file mode 100644index 0000000000..5cb9e10bf5--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/company_invitations_controller.rb@@ -0,0 +1,113 @@+module Spree+ module Api+ module V3+ module Store+ # Invitations addressed directly. Two audiences share this+ # controller:+ #+ # - Members revoke by prefixed id (DELETE — authenticated, standing+ # scoped).+ # - Invitees look up and accept by plaintext token (GET/POST —+ # unauthenticated: the token from the invite email IS the+ # credential, and the acceptance page must load before the invitee+ # has an account, even on a login-gated store).+ class CompanyInvitationsController < ResourceController+ allow_guest_storefront_access!++ prepend_before_action :require_authentication!, only: [:destroy]++ # `show` is the token lookup, not a prefixed-id read — the standing+ # scope would 404 the unauthenticated invitee.+ skip_before_action :set_resource+ before_action :set_resource, only: [:destroy]++ # GET /api/v3/store/company_invitations/:token — what is being+ # joined. Expired and revoked tokens 404.+ def show+ invitation = find_by_token!++ render json: serialize_resource(invitation).merge(+ 'company_name' => invitation.company.name,+ 'store_name' => current_store.name+ )+ end++ # POST /api/v3/store/company_invitations/:token/accept+ #+ # Takes a registration payload (the account is created through the+ # customer-creation workflow, with the invited email), or an+ # authenticated request from a customer the invitation then binds+ # to. Returns the created membership.+ def accept+ invitation = find_by_token!++ result = Spree.company_invitation_accept_service.call(+ invitation: invitation,+ customer: current_user,+ customer_attributes: current_user ? nil : registration_params.to_h+ )++ if result.success?+ render json: Spree.api.company_membership_serializer.new(+ result.value, params: serializer_params+ ).to_h, status: :created+ elsif result.value.respond_to?(:errors) && result.value.errors.any?+ render_validation_error(result.value.errors)+ else+ render_error(+ code: Spree::Api::V3::ErrorHandler::ERROR_CODES[:validation_error],+ message: Spree.t('company_invitations.not_pending'),+ status: :unprocessable_content+ )+ end+ end++ # DELETE /api/v3/store/company_invitations/:id — revoke, by any+ # member with standing.+ def destroy+ if @resource.revoke!+ head :no_content+ else+ render_error(+ code: Spree::Api::V3::ErrorHandler::ERROR_CODES[:validation_error],+ message: Spree.t('company_invitations.not_pending'),+ status: :unprocessable_content+ )+ end+ end++ protected++ def model_class+ Spree::CompanyInvitation+ end++ def serializer_class+ Spree.api.company_invitation_serializer+ end++ # For revocation: invitations of nodes the caller has standing over.+ def scope+ Spree::CompanyInvitation.where(+ company_id: storefront_access_policy.scope(current_store.companies).select(:id)+ )+ end++ private++ # Token lookup, scoped to the current store and to pending rows —+ # a spent, revoked or expired token does not exist.+ def find_by_token!+ Spree::CompanyInvitation.pending.+ where(company_id: current_store.companies.select(:id)).+ find_by!(token: params[:token] || params[:id])+ end++ def registration_params+ params.permit(:first_name, :last_name, :phone, :password, :password_confirmation)+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/company_members_controller.rb b/spree/api/app/controllers/spree/api/v3/store/company_members_controller.rbnew file mode 100644index 0000000000..a5ff5b7ebb--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/store/company_members_controller.rb@@ -0,0 +1,38 @@+module Spree+ module Api+ module V3+ module Store+ # Removing a member's standing, addressed directly by membership id.+ # Any member with standing over the node may do this — the accepted+ # OSS trade-off; restraint is Enterprise's policy layer.+ class CompanyMembersController < ResourceController+ prepend_before_action :require_authentication!++ # DELETE /api/v3/store/company_members/:id+ def destroy+ @resource.destroy!+ head :no_content+ rescue ActiveRecord::RecordNotDestroyed => e+ render_validation_error(e.record.errors.presence || e.message)+ end++ protected++ def model_class+ Spree::CompanyMembership+ end++ def serializer_class+ Spree.api.company_membership_serializer+ end++ def scope+ Spree::CompanyMembership.where(+ company_id: storefront_access_policy.scope(current_store.companies).select(:id)+ )+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/store/products_controller.rb b/spree/api/app/controllers/spree/api/v3/store/products_controller.rbindex defcf5b1e4..88f2242249 100644--- a/spree/api/app/controllers/spree/api/v3/store/products_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/products_controller.rb@@ -29,7 +29,18 @@ module Spreeenddef scope- super.available(Time.current, Spree::Current.currency, include_preorderable: true)+ base = super.available(Time.current, Spree::Current.currency, include_preorderable: true)++ # Catalog narrowing for the buyer: their company's effective+ # catalogs, their group's, or the channel default — union of+ # assortments, resolved in one place+ # (docs/plans/6.0-b2b-companies-and-catalogs.md).+ Spree.products_for_context_service.call(+ store: current_store,+ channel: current_channel,+ customer: current_user,+ base: base+ ).valueend# these scopes are not automatically picked by ar_lazy_preload gem and we need to explicitly include themdiff --git a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb b/spree/api/app/serializers/spree/api/v3/cart_serializer.rbindex 906e98fda9..17d91d34e2 100644--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb@@ -9,6 +9,7 @@ module Spreecurrency: :string, locale: [:string, nullable: true], total_quantity: :number,coupon_code: [:string, nullable: true],preferred_stock_location_id: [:string, nullable: true],+ company_id: [:string, nullable: true], company_name: [:string, nullable: true],requirements: 'Array<{step: string, field: string, code: string, message: string}>',item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],delivery_total: [:string, nullable: true], display_delivery_total: [:string, nullable: true],@@ -44,6 +45,16 @@ module Spreecart.preferred_stock_location&.prefixed_idend+ # Which company node the purchase is for — mirrors the writable+ # `company_id` param. Read from the column, never re-resolved.+ attribute :company_id do |cart|+ cart.company&.prefixed_id+ end++ attribute :company_name do |cart|+ cart.company&.name+ end+# @deprecated `number` mirrors `id` (carts have no order-style# number) — kept one release for 5.x clients; removed in 6.1.attributes :number, :token, :email, :customer_note,diff --git a/spree/api/app/serializers/spree/api/v3/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_serializer.rbindex af1a5dd403..37e7e3f11c 100644--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb@@ -8,6 +8,7 @@ module Spreenumber: :string, email: :string,customer_note: [:string, nullable: true],market_id: [:string, nullable: true], channel_id: [:string, nullable: true],+ company_id: [:string, nullable: true], company_name: [:string, nullable: true],currency: :string, locale: [:string, nullable: true], total_quantity: :number,coupon_code: [:string, nullable: true],fulfillment_status: [:string, nullable: true], payment_status: [:string, nullable: true],@@ -44,6 +45,15 @@ module Spreeorder.channel&.prefixed_idend+ # Which company node the order was placed for — frozen at completion.+ attribute :company_id do |order|+ order.company&.prefixed_id+ end++ attribute :company_name do |order|+ order.company&.name+ end+attributes :number, :email, :customer_note,:currency, :locale, :total_quantity, :coupon_code,:fulfillment_status, :payment_status,diff --git a/spree/api/spec/controllers/spree/api/v3/store/account/companies_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/account/companies_controller_spec.rbnew file mode 100644index 0000000000..00d9686f73--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/account/companies_controller_spec.rb@@ -0,0 +1,42 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::Account::CompaniesController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ before { request.headers.merge!(headers) }++ describe 'GET #index' do+ it 'lists my memberships with each node and its ancestor path' do+ root = create(:company, store: store, name: 'Acme')+ division = create(:company, store: store, kind: 'division', parent: root, name: 'EMEA')+ membership = create(:company_membership, company: division, customer: user)++ get :index, as: :json++ expect(response).to have_http_status(:ok)+ row = json_response['data'].sole+ expect(row['id']).to eq(membership.prefixed_id)+ expect(row['company']['id']).to eq(division.prefixed_id)+ expect(row['company']['name']).to eq('EMEA')+ expect(row['company']['ancestors'].map { |a| a['name'] }).to eq(['Acme'])+ end++ it 'hides memberships at companies of another store' do+ create(:company_membership, company: create(:company, store: create(:store)), customer: user)++ get :index, as: :json++ expect(json_response['data']).to be_empty+ end++ it '401s a guest' do+ request.headers['Authorization'] = nil++ get :index, as: :json++ expect(response).to have_http_status(:unauthorized)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rbindex a26a7707f0..d37430ea1f 100644--- a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb@@ -614,6 +614,46 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller doexpect(order.reload.ship_address_id).to eq(existing_address.id)end+ context 'naming the company the purchase is for' do+ let(:company) { create(:company, store: store) }++ it 'persists a node the buyer has standing over' do+ create(:company_membership, company: company, customer: user)++ patch :update, params: { id: order.prefixed_id, company_id: company.prefixed_id }++ expect(response).to have_http_status(:ok)+ expect(order.reload.company).to eq(company)+ expect(json_response['company_id']).to eq(company.prefixed_id)+ expect(json_response['company_name']).to eq(company.name)+ end++ it 'refuses a node the buyer has no standing over' do+ patch :update, params: { id: order.prefixed_id, company_id: company.prefixed_id }++ expect(response).to have_http_status(:unprocessable_content)+ expect(order.reload.company_id).to be_nil+ end++ it '404s a node of another store' do+ foreign = create(:company, store: create(:store))++ patch :update, params: { id: order.prefixed_id, company_id: foreign.prefixed_id }++ expect(response).to have_http_status(:not_found)+ end++ it 'clears the node when passed nothing' do+ create(:company_membership, company: company, customer: user)+ order.update!(company: company)++ patch :update, params: { id: order.prefixed_id, company_id: nil }++ expect(response).to have_http_status(:ok)+ expect(order.reload.company_id).to be_nil+ end+ end+context 'selecting a pickup location' dolet!(:pickup_location) { create(:stock_location, pickup_enabled: true, store: store) }diff --git a/spree/api/spec/controllers/spree/api/v3/store/companies/addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/companies/addresses_controller_spec.rbnew file mode 100644index 0000000000..7b38ddf66d--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/companies/addresses_controller_spec.rb@@ -0,0 +1,47 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::Companies::AddressesController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }++ before do+ create(:company_membership, company: company, customer: user)+ request.headers.merge!(headers)+ end++ describe 'GET #index' do+ it 'lists the node address book' do+ create(:company_address, company: company, label: 'HQ')++ get :index, params: { company_id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].sole['label']).to eq('HQ')+ end++ it '404s a node without standing' do+ get :index, params: { company_id: create(:company, store: store).prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end++ describe 'POST #create' do+ it 'creates an entry with a nested address' do+ post :create, params: {+ company_id: company.prefixed_id,+ label: 'Plant 2 dock', default_shipping: true,+ address: { first_name: 'Ops', last_name: 'Team', address1: '1 Dock Rd',+ city: 'Springfield', postal_code: '62704', country_code: 'US', state_code: 'IL' }+ }, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['label']).to eq('Plant 2 dock')+ expect(json_response['default_shipping']).to be(true)+ expect(json_response['address']['city']).to eq('Springfield')+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/companies/invitations_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/companies/invitations_controller_spec.rbnew file mode 100644index 0000000000..700fa5642b--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/companies/invitations_controller_spec.rb@@ -0,0 +1,32 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::Companies::InvitationsController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }++ before { request.headers.merge!(headers) }++ describe 'GET #index' do+ it 'lists the node invitations for a member' do+ create(:company_membership, company: company, customer: user)+ invitation = create(:company_invitation, company: company)++ get :index, params: { company_id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:ok)+ row = json_response['data'].sole+ expect(row['id']).to eq(invitation.prefixed_id)+ expect(row['status']).to eq('pending')+ expect(row).not_to have_key('token')+ end++ it '404s a node without standing' do+ get :index, params: { company_id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/companies/members_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/companies/members_controller_spec.rbnew file mode 100644index 0000000000..ed161007fe--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/companies/members_controller_spec.rb@@ -0,0 +1,61 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::Companies::MembersController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }++ before do+ create(:company_membership, company: company, customer: user)+ request.headers.merge!(headers)+ end++ describe 'GET #index' do+ it 'lists the members with who they are' do+ get :index, params: { company_id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['data'].sole['email']).to eq(user.email)+ end++ it '404s a node without standing' do+ other = create(:company, store: store)++ get :index, params: { company_id: other.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end++ describe 'POST #create' do+ it 'adds an existing customer as a member immediately' do+ buyer = create(:customer, email: '[email protected]')++ post :create, params: { company_id: company.prefixed_id, customer_email: '[email protected]' }, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['id']).to start_with('cmem_')+ expect(company.memberships.reload.map(&:customer)).to include(buyer)+ end++ it 'invites an unknown email, recording the inviter' do+ post :create, params: { company_id: company.prefixed_id, customer_email: '[email protected]' }, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['id']).to start_with('cinv_')+ expect(json_response).not_to have_key('token')+ expect(company.invitations.sole.inviter).to eq(user)+ end++ it 'lets a member of an ancestor act on a division' do+ division = create(:company, store: store, kind: 'division', parent: company)+ create(:customer, email: '[email protected]')++ post :create, params: { company_id: division.prefixed_id, customer_email: '[email protected]' }, as: :json++ expect(response).to have_http_status(:created)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/companies/orders_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/companies/orders_controller_spec.rbnew file mode 100644index 0000000000..d7b30812b1--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/companies/orders_controller_spec.rb@@ -0,0 +1,46 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::Companies::OrdersController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }+ let(:division) { create(:company, store: store, kind: 'division', parent: company) }++ before do+ create(:company_membership, company: company, customer: user)+ request.headers.merge!(headers)+ end++ describe 'GET #index' do+ it 'lists completed purchases across the subtree, not just the node' do+ node_order = create(:completed_order_with_totals, store: store)+ node_order.update_columns(company_id: company.id)+ subtree_order = create(:completed_order_with_totals, store: store)+ subtree_order.update_columns(company_id: division.id)+ create(:completed_order_with_totals, store: store) # consumer order++ get :index, params: { company_id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:ok)+ ids = json_response['data'].map { |row| row['id'] }+ expect(ids).to contain_exactly(node_order.prefixed_id, subtree_order.prefixed_id)+ end++ it 'scopes a division to its own subtree' do+ parent_order = create(:completed_order_with_totals, store: store)+ parent_order.update_columns(company_id: company.id)++ get :index, params: { company_id: division.prefixed_id }, as: :json++ expect(json_response['data']).to be_empty+ end++ it '404s a node without standing' do+ get :index, params: { company_id: create(:company, store: store).prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/companies_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/companies_controller_spec.rbnew file mode 100644index 0000000000..0c70e45dac--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/companies_controller_spec.rb@@ -0,0 +1,68 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::CompaniesController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store, name: 'Acme Industrial') }+ let(:division) { create(:company, store: store, kind: 'division', parent: company, name: 'Berlin') }++ before { request.headers.merge!(headers) }++ describe 'GET #show' do+ it 'returns a node the member has standing over, with its ancestor path' do+ create(:company_membership, company: company, customer: user)++ get :show, params: { id: division.prefixed_id }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['name']).to eq('Berlin')+ expect(json_response['kind']).to eq('division')+ expect(json_response['ancestors'].map { |a| a['name'] }).to eq(['Acme Industrial'])+ end++ it '404s a node the member has no standing over' do+ get :show, params: { id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end++ it '404s an ancestor of the membership node' do+ create(:company_membership, company: division, customer: user)++ get :show, params: { id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end++ it '401s a guest' do+ request.headers['Authorization'] = nil++ get :show, params: { id: company.prefixed_id }, as: :json++ expect(response).to have_http_status(:unauthorized)+ end+ end++ describe 'PATCH #update' do+ it 'lets any member rename the node' do+ create(:company_membership, company: company, customer: user)++ patch :update, params: { id: company.prefixed_id, name: 'Acme Global' }, as: :json++ expect(response).to have_http_status(:ok)+ expect(company.reload.name).to eq('Acme Global')+ end++ it 'never lets a member re-parent or retype the node' do+ create(:company_membership, company: company, customer: user)+ other_root = create(:company, store: store)++ patch :update, params: { id: division.prefixed_id, parent_id: other_root.prefixed_id, kind: 'company' }, as: :json++ expect(division.reload.parent).to eq(company)+ expect(division.kind).to eq('division')+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/company_addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/company_addresses_controller_spec.rbnew file mode 100644index 0000000000..086518538c--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/company_addresses_controller_spec.rb@@ -0,0 +1,41 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::CompanyAddressesController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }+ let!(:entry) { create(:company_address, company: company, label: 'HQ') }++ before { request.headers.merge!(headers) }++ context 'with standing' do+ before { create(:company_membership, company: company, customer: user) }++ it 'edits the entry, keeping the address row' do+ original_address_id = entry.address_id++ patch :update, params: { id: entry.prefixed_id, label: 'Head office', address: { city: 'Shelbyville' } }, as: :json++ expect(response).to have_http_status(:ok)+ expect(entry.reload.label).to eq('Head office')+ expect(entry.address_id).to eq(original_address_id)+ expect(entry.address.city).to eq('Shelbyville')+ end++ it 'removes the entry and its owned address row' do+ expect {+ delete :destroy, params: { id: entry.prefixed_id }, as: :json+ }.to change(Spree::Address, :count).by(-1)++ expect(response).to have_http_status(:no_content)+ end+ end++ it '404s without standing' do+ patch :update, params: { id: entry.prefixed_id, label: 'X' }, as: :json++ expect(response).to have_http_status(:not_found)+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/company_invitations_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/company_invitations_controller_spec.rbnew file mode 100644index 0000000000..1a964bb5e6--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/company_invitations_controller_spec.rb@@ -0,0 +1,120 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::CompanyInvitationsController, type: :controller do+ render_views++ include_context 'API v3 Store'++ let(:company) { create(:company, store: store, name: 'Acme Industrial') }+ let!(:invitation) { create(:company_invitation, company: company, email: '[email protected]') }++ describe 'GET #show (token lookup, unauthenticated)' do+ before { request.headers.merge!(api_key_headers) }++ it 'shows what is being joined' do+ get :show, params: { token: invitation.token }, as: :json++ expect(response).to have_http_status(:ok)+ expect(json_response['email']).to eq('[email protected]')+ expect(json_response['company_name']).to eq('Acme Industrial')+ expect(json_response['store_name']).to eq(store.name)+ expect(json_response).not_to have_key('token')+ end++ it '404s an expired token' do+ invitation.update!(expires_at: 1.day.ago)++ get :show, params: { token: invitation.token }, as: :json++ expect(response).to have_http_status(:not_found)+ end++ it '404s a revoked token' do+ invitation.revoke!++ get :show, params: { token: invitation.token }, as: :json++ expect(response).to have_http_status(:not_found)+ end++ it '404s garbage' do+ get :show, params: { token: 'nope' }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end++ describe 'POST #accept' do+ context 'with a registration payload' do+ before { request.headers.merge!(api_key_headers) }++ it 'registers the invited email and lands as a membership' do+ post :accept, params: {+ token: invitation.token,+ first_name: 'Ada', password: 'Sup3r-secret', password_confirmation: 'Sup3r-secret'+ }, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['id']).to start_with('cmem_')+ expect(json_response['email']).to eq('[email protected]')+ expect(invitation.reload).to be_accepted+ end++ it 'fails a bad registration and keeps the invitation pending' do+ post :accept, params: { token: invitation.token, password: 'x' }, as: :json++ expect(response).to have_http_status(:unprocessable_content)+ expect(invitation.reload).to be_pending+ end+ end++ context 'authenticated' do+ before { request.headers.merge!(bearer_headers) }++ it 'binds the invitation to the signed-in customer' do+ post :accept, params: { token: invitation.token }, as: :json++ expect(response).to have_http_status(:created)+ expect(invitation.reload.customer).to eq(user)+ expect(company.memberships.sole.customer).to eq(user)+ end+ end++ it '422s a spent token' do+ request.headers.merge!(api_key_headers)+ invitation.update!(accepted_at: Time.current)++ post :accept, params: { token: invitation.token }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end++ describe 'DELETE #destroy (revoke)' do+ it 'lets a member with standing revoke' do+ create(:company_membership, company: company, customer: user)+ request.headers.merge!(bearer_headers)++ delete :destroy, params: { id: invitation.prefixed_id }, as: :json++ expect(response).to have_http_status(:no_content)+ expect(invitation.reload).to be_revoked+ end++ it '404s without standing' do+ request.headers.merge!(bearer_headers)++ delete :destroy, params: { id: invitation.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end++ it '401s a guest' do+ request.headers.merge!(api_key_headers)++ delete :destroy, params: { id: invitation.prefixed_id }, as: :json++ expect(response).to have_http_status(:unauthorized)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/company_members_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/company_members_controller_spec.rbnew file mode 100644index 0000000000..cd4fc8c9f6--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/store/company_members_controller_spec.rb@@ -0,0 +1,30 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Store::CompanyMembersController, type: :controller do+ render_views++ include_context 'API v3 Store authenticated'++ let(:company) { create(:company, store: store) }+ let!(:other_membership) { create(:company_membership, company: company) }++ before { request.headers.merge!(headers) }++ describe 'DELETE #destroy' do+ # The accepted OSS trade-off: within a company, every member is trusted.+ it 'lets any member remove another member' do+ create(:company_membership, company: company, customer: user)++ delete :destroy, params: { id: other_membership.prefixed_id }, as: :json++ expect(response).to have_http_status(:no_content)+ expect(Spree::CompanyMembership.where(id: other_membership.id)).to be_empty+ end++ it '404s without standing' do+ delete :destroy, params: { id: other_membership.prefixed_id }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rbindex 5eb80f62db..09e7074e99 100644--- a/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/products_controller_spec.rb@@ -48,6 +48,42 @@ RSpec.describe Spree::Api::V3::Store::ProductsController, type: :controller doendend+ describe 'catalog narrowing' do+ let(:user) { create(:customer) }+ let(:company) { create(:company, store: store) }+ let(:catalog) { create(:catalog, store: store) }++ before do+ create(:catalog_assignment, catalog: catalog, assignable: company)+ catalog.add_products([product.id])+ end++ it 'narrows a sole-standing buyer to their effective catalogs' do+ create(:company_membership, company: company, customer: user)+ request.headers['Authorization'] = "Bearer #{Spree::Api::V3::TestingSupport.generate_jwt(user)}"++ get :index, as: :json++ expect(json_response['data'].map { |row| row['id'] }).to contain_exactly(product.prefixed_id)+ end++ it 'leaves anonymous buyers un-narrowed' do+ get :index, as: :json++ ids = json_response['data'].map { |row| row['id'] }+ expect(ids).to include(product.prefixed_id, product2.prefixed_id)+ end++ it 'hides a catalog-only 404 from show for buyers outside the assortment' do+ create(:company_membership, company: company, customer: user)+ request.headers['Authorization'] = "Bearer #{Spree::Api::V3::TestingSupport.generate_jwt(user)}"++ get :show, params: { id: product2.slug }, as: :json++ expect(response).to have_http_status(:not_found)+ end+ end+describe 'GET #index' doit 'returns a list of products' doget :indexdiff --git a/spree/core/app/models/spree/storefront/access_policy.rb b/spree/core/app/models/spree/storefront/access_policy.rbindex cb475d5266..774b44dfe8 100644--- a/spree/core/app/models/spree/storefront/access_policy.rb+++ b/spree/core/app/models/spree/storefront/access_policy.rb@@ -14,14 +14,14 @@ module Spree## This class is the storefront's extension seam: replace it via# `Spree::Dependencies.storefront_access_policy_class` when access must- # widen beyond the owner — e.g. B2B company accounts where an approver- # sees every purchase or shared wishlist of their company location- # (docs/plans/6.1-channels-catalogs-b2b.md). Override the entry points- # and fall through to `super`:+ # widen or narrow beyond the owner — e.g. B2B company governance where+ # only an approver sees the subtree's purchases+ # (docs/plans/6.0-b2b-companies-and-catalogs.md). Override the entry+ # points and fall through to `super`:## class Enterprise::CompanyAccessPolicy < Spree::Storefront::AccessPolicy# def scope(base, token: nil)- # return base.where(company_location_id: approver_location_ids) if+ # return base.where(company_id: standing_company_ids) if# base.klass <= Spree::Order && approver?## super@@ -52,6 +52,7 @@ module Spree# @return [Boolean]def readable?(record, token: nil)return purchase_readable?(record, token: token) if purchase?(record)+ return company_standing?(record) if company_record?(record)owned?(record)end@@ -64,6 +65,7 @@ module Spree# @return [Boolean]def writable?(record, token: nil)return purchase_writable?(record, token: token) if purchase?(record)+ return company_standing?(record) if company_record?(record)owned?(record)end@@ -78,6 +80,7 @@ module Spree# @return [ActiveRecord::Relation]def scope(base, token: nil)return purchases_scope(base, token: token) if purchase_class?(base.klass)+ return company_scope(base) if base.klass <= Spree::Companyowned_scope(base)end@@ -123,6 +126,31 @@ module Spreeklass <= Spree::Cart || klass <= Spree::Order || klass <= Spree::OrderGroupend+ # --- the company directory: standing ---++ # OSS ships no company roles: any member with standing over the record's+ # node — a membership on it or an ancestor — may read and write it.+ # Enterprise narrows this by overriding these entry points+ # (docs/plans/6.0-b2b-companies-and-catalogs.md).+ def company_record?(record)+ record.is_a?(Spree::Company) || record.is_a?(Spree::CompanyAddress) ||+ record.is_a?(Spree::CompanyMembership) || record.is_a?(Spree::CompanyInvitation)+ end++ def company_standing?(record)+ return false if user.blank?++ node = record.is_a?(Spree::Company) ? record : record.company+ user.standing_for?(node)+ end++ # The nodes the caller may list: their standing within the store.+ def company_scope(base)+ return base.none if user.blank?++ base.merge(user.company_standing(store: store))+ end+# --- everything else: ownership ---# Ownership keys on `customer_id`, the canonical column since thediff --git a/spree/core/app/services/spree/carts/update.rb b/spree/core/app/services/spree/carts/update.rbindex 5ff499ff04..1d0734c4de 100644--- a/spree/core/app/services/spree/carts/update.rb+++ b/spree/core/app/services/spree/carts/update.rb@@ -75,6 +75,21 @@ module Spreecart.metadata = cart.metadata.merge(params[:metadata].to_h) if params[:metadata].present?cart.use_shipping = params[:use_shipping] if params.key?(:use_shipping)assign_preferred_stock_location if params.key?(:preferred_stock_location_id)+ assign_company if params.key?(:company_id)+ end++ # Which company node the purchase is for. Resolved through the cart's+ # store so a foreign node 404s; the model validates that the cart's+ # customer has standing over it.+ def assign_company+ value = params[:company_id]++ if value.blank?+ cart.company_id = nil+ return+ end++ cart.company_id = cart.store.companies.find_by_prefix_id!(value).idend# Storefront pickup selection: resolves the public prefixed ID (or raw