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.

Reach every part of a company through its node

Damian Legawiec3ef1acb3b3ba
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yaml
index 9075a4df30..478f6ec228 100644
--- a/docs/api-reference/admin.yaml
+++ b/docs/api-reference/admin.yaml
@@ -29124,15 +29124,15 @@ paths:
type: carrier
group: shipping
preferences:
- api_key: "•••••cret"
account_number: '42'
+ api_key: "•••••cret"
preference_schema:
- - key: api_key
- type: password
- default:
- key: account_number
type: string
default:
+ - key: api_key
+ type: password
+ default:
meta:
page: 1
limit: 25
@@ -29197,15 +29197,15 @@ paths:
type: carrier
group: shipping
preferences:
- api_key: "•••••cret"
account_number:
+ api_key: "•••••cret"
preference_schema:
- - key: api_key
- type: password
- default:
- key: account_number
type: string
default:
+ - key: api_key
+ type: password
+ default:
requestBody:
content:
application/json:
@@ -29277,12 +29277,12 @@ paths:
description:
logo_url:
preference_schema:
- - key: api_key
- type: password
- default:
- key: account_number
type: string
default:
+ - key: api_key
+ type: password
+ default:
"/api/v3/admin/integrations/{id}/test":
post:
summary: Test integration connection
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index 1a21e1c78d..5afd704e21 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -10330,12 +10330,18 @@ paths:
in: 1
previous:
next:
- "/api/v3/store/company_addresses/{id}":
+ "/api/v3/store/companies/{company_id}/addresses/{id}":
parameters:
+ - name: company_id
+ in: path
+ required: true
+ description: Company node ID (comp_...)
+ schema:
+ type: string
- name: id
in: path
required: true
- description: Address book entry ID (caddr_...)
+ description: Address ID (addr_...)
schema:
type: string
patch:
@@ -10420,8 +10426,14 @@ paths:
responses:
'204':
description: address book entry removed
- "/api/v3/store/company_invitations/{id}":
+ "/api/v3/store/companies/{company_id}/invitations/{id}":
parameters:
+ - name: company_id
+ in: path
+ required: true
+ description: Company node ID (comp_...)
+ schema:
+ type: string
- name: id
in: path
required: true
diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.ts
index 5902c04667..1a41701be6 100644
--- a/packages/admin-sdk/src/admin-client.ts
+++ b/packages/admin-sdk/src/admin-client.ts
@@ -2881,9 +2881,8 @@ export class AdminClient {
* List roots with `{ parent_id_null: 1 }` and a node's children with
* `{ parent_id_eq: 'comp_…' }`. Deleting a node destroys its subtree.
*
- * Address-book entries, memberships and invitations are listed and created
- * under their node, then addressed by their own id via `companyAddresses`,
- * `companyMemberships` and `companyInvitations`.
+ * Address-book entries, memberships and invitations all belong to a node,
+ * so every one of them is reached through it.
*/
readonly companies = {
list: (
@@ -2929,6 +2928,24 @@ export class AdminClient {
...options,
body: params,
}),
+
+ get: (companyId: string, id: string, options?: RequestOptions): Promise<Address> =>
+ this.request<Address>('GET', `/companies/${companyId}/addresses/${id}`, options),
+
+ /** Address fields edit the entry in place, so send only what changes. */
+ update: (
+ companyId: string,
+ id: string,
+ params: CompanyAddressParams,
+ options?: RequestOptions,
+ ): Promise<Address> =>
+ this.request<Address>('PATCH', `/companies/${companyId}/addresses/${id}`, {
+ ...options,
+ body: params,
+ }),
+
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/addresses/${id}`, options),
},
/**
@@ -2959,6 +2976,17 @@ export class AdminClient {
`/companies/${companyId}/memberships`,
{ ...options, body: params },
),
+
+ get: (companyId: string, id: string, options?: RequestOptions): Promise<CompanyMembership> =>
+ this.request<CompanyMembership>(
+ 'GET',
+ `/companies/${companyId}/memberships/${id}`,
+ options,
+ ),
+
+ /** Withdraws the member's standing. The customer account is untouched. */
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/memberships/${id}`, options),
},
invitations: {
@@ -2972,6 +3000,17 @@ export class AdminClient {
`/companies/${companyId}/invitations`,
{ ...options, params: params ? transformListParams(params) : undefined },
),
+
+ get: (companyId: string, id: string, options?: RequestOptions): Promise<CompanyInvitation> =>
+ this.request<CompanyInvitation>(
+ 'GET',
+ `/companies/${companyId}/invitations/${id}`,
+ options,
+ ),
+
+ /** Revokes a pending invitation; its token then stops resolving. */
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/invitations/${id}`, options),
},
/**
@@ -3142,48 +3181,6 @@ export class AdminClient {
},
}
- /** Address-book entries addressed by their own id. */
- readonly companyAddresses = {
- get: (id: string, options?: RequestOptions): Promise<Address> =>
- this.request<Address>('GET', `/company_addresses/${id}`, options),
-
- /**
- * Address fields sent here edit the entry's existing address in place, so
- * send only what changes.
- */
- update: (
- id: string,
- params: CompanyAddressParams,
- options?: RequestOptions,
- ): Promise<Address> =>
- this.request<Address>('PATCH', `/company_addresses/${id}`, {
- ...options,
- body: params,
- }),
-
- /** Removes the entry and the address row it owned. */
- delete: (id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/company_addresses/${id}`, options),
- }
-
- readonly companyMemberships = {
- get: (id: string, options?: RequestOptions): Promise<CompanyMembership> =>
- this.request<CompanyMembership>('GET', `/company_memberships/${id}`, options),
-
- /** Withdraws the member's standing. The customer account is untouched. */
- delete: (id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/company_memberships/${id}`, options),
- }
-
- readonly companyInvitations = {
- get: (id: string, options?: RequestOptions): Promise<CompanyInvitation> =>
- this.request<CompanyInvitation>('GET', `/company_invitations/${id}`, options),
-
- /** Revokes a pending invitation; its token then stops resolving. */
- delete: (id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/company_invitations/${id}`, options),
- }
-
// ============================================
// Catalogs (assortment + optional price list)
// ============================================
diff --git a/packages/admin-sdk/tests/companies.test.ts b/packages/admin-sdk/tests/companies.test.ts
index 81a1459f4b..c19e10d012 100644
--- a/packages/admin-sdk/tests/companies.test.ts
+++ b/packages/admin-sdk/tests/companies.test.ts
@@ -110,12 +110,15 @@ describe('companies', () => {
body = (await request.json()) as Record<string, unknown>
return HttpResponse.json(sampleAddress, { status: 201 })
}),
- http.patch(`${API_PREFIX}/company_addresses/caddr_abc123`, async ({ request }) => {
- patched = (await request.json()) as Record<string, unknown>
- return HttpResponse.json(sampleAddress)
- }),
+ http.patch(
+ `${API_PREFIX}/companies/comp_abc123/addresses/caddr_abc123`,
+ async ({ request }) => {
+ patched = (await request.json()) as Record<string, unknown>
+ return HttpResponse.json(sampleAddress)
+ },
+ ),
http.delete(
- `${API_PREFIX}/company_addresses/caddr_abc123`,
+ `${API_PREFIX}/companies/comp_abc123/addresses/caddr_abc123`,
() => new HttpResponse(null, { status: 204 }),
),
)
@@ -125,18 +128,22 @@ describe('companies', () => {
await client.companies.addresses.create('comp_abc123', {
label: 'Plant 2 dock',
default_shipping: true,
- address: { city: 'Hamburg', country_code: 'DE' },
+ city: 'Hamburg',
+ country_code: 'DE',
})
- await client.companyAddresses.update('caddr_abc123', { address: { city: 'Berlin' } })
- await expect(client.companyAddresses.delete('caddr_abc123')).resolves.toBeUndefined()
+ await client.companies.addresses.update('comp_abc123', 'caddr_abc123', { city: 'Berlin' })
+ await expect(
+ client.companies.addresses.delete('comp_abc123', 'caddr_abc123'),
+ ).resolves.toBeUndefined()
expect(listed.data[0]?.id).toBe('caddr_abc123')
expect(body).toEqual({
label: 'Plant 2 dock',
default_shipping: true,
- address: { city: 'Hamburg', country_code: 'DE' },
+ city: 'Hamburg',
+ country_code: 'DE',
})
- expect(patched).toEqual({ address: { city: 'Berlin' } })
+ expect(patched).toEqual({ city: 'Berlin' })
})
})
@@ -163,7 +170,7 @@ describe('companies', () => {
return HttpResponse.json(membership, { status: 201 })
}),
http.delete(
- `${API_PREFIX}/company_memberships/cmem_abc123`,
+ `${API_PREFIX}/companies/comp_abc123/memberships/cmem_abc123`,
() => new HttpResponse(null, { status: 204 }),
),
)
@@ -173,7 +180,9 @@ describe('companies', () => {
await client.companies.memberships.create('comp_abc123', {
customer_email: '[email protected]',
})
- await expect(client.companyMemberships.delete('cmem_abc123')).resolves.toBeUndefined()
+ await expect(
+ client.companies.memberships.delete('comp_abc123', 'cmem_abc123'),
+ ).resolves.toBeUndefined()
expect(listed.data[0]?.email).toBe('[email protected]')
expect(body).toEqual({ customer_email: '[email protected]' })
@@ -198,14 +207,16 @@ describe('companies', () => {
HttpResponse.json(paginated([invitation])),
),
http.delete(
- `${API_PREFIX}/company_invitations/cinv_abc123`,
+ `${API_PREFIX}/companies/comp_abc123/invitations/cinv_abc123`,
() => new HttpResponse(null, { status: 204 }),
),
)
const client = createTestClient()
const listed = await client.companies.invitations.list('comp_abc123')
- await expect(client.companyInvitations.delete('cinv_abc123')).resolves.toBeUndefined()
+ await expect(
+ client.companies.invitations.delete('comp_abc123', 'cinv_abc123'),
+ ).resolves.toBeUndefined()
expect(listed.data[0]?.status).toBe('pending')
})
diff --git a/packages/dashboard/src/hooks/use-companies.ts b/packages/dashboard/src/hooks/use-companies.ts
index 64b49ecb6d..2b5ceba267 100644
--- a/packages/dashboard/src/hooks/use-companies.ts
+++ b/packages/dashboard/src/hooks/use-companies.ts
@@ -101,7 +101,7 @@ export function useCreateCompanyAddress(companyId: string) {
/** Edits an entry in place — the address row is updated, never replaced. */
export function useUpdateCompanyAddress(companyId: string) {
return useResourceMutation<Address, Error, { id: string; params: CompanyAddressParams }>({
- mutationFn: ({ id, params }) => adminClient.companyAddresses.update(id, params),
+ mutationFn: ({ id, params }) => adminClient.companies.addresses.update(companyId, id, params),
invalidate: [['companies', companyId, 'addresses']],
successMessage: i18n.t('admin.company_addresses.messages.updated'),
errorMessage: i18n.t('admin.errors.failed_to_update'),
@@ -111,7 +111,7 @@ export function useUpdateCompanyAddress(companyId: string) {
/** Removes an entry and the address row it owned. */
export function useDeleteCompanyAddress(companyId: string) {
return useResourceMutation<void, Error, string>({
- mutationFn: (id) => adminClient.companyAddresses.delete(id),
+ mutationFn: (id) => adminClient.companies.addresses.delete(companyId, id),
invalidate: [['companies', companyId, 'addresses']],
successMessage: i18n.t('admin.company_addresses.messages.deleted'),
errorMessage: i18n.t('admin.errors.failed_to_delete'),
@@ -155,7 +155,7 @@ export function useAddCompanyMember(companyId: string) {
/** Withdraws a member's standing; the customer account is untouched. */
export function useDeleteCompanyMembership(companyId: string) {
return useResourceMutation<void, Error, string>({
- mutationFn: (id) => adminClient.companyMemberships.delete(id),
+ mutationFn: (id) => adminClient.companies.memberships.delete(companyId, id),
invalidate: [['companies', companyId, 'memberships']],
successMessage: i18n.t('admin.company_memberships.messages.removed'),
errorMessage: i18n.t('admin.errors.failed_to_delete'),
@@ -178,7 +178,7 @@ export function useCompanyInvitations(companyId: string | undefined, page = 1, l
/** Revokes a pending invitation, so its emailed token stops resolving. */
export function useRevokeCompanyInvitation(companyId: string) {
return useResourceMutation<void, Error, string>({
- mutationFn: (id) => adminClient.companyInvitations.delete(id),
+ mutationFn: (id) => adminClient.companies.invitations.delete(companyId, id),
invalidate: [['companies', companyId, 'invitations']],
successMessage: i18n.t('admin.company_invitations.messages.revoked'),
errorMessage: i18n.t('admin.errors.failed_to_update'),
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index b126f36e81..cc52ff12aa 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -1216,6 +1216,24 @@ export class StoreClient {
...options,
body: params,
}),
+
+ update: (
+ companyId: string,
+ id: string,
+ params: Record<string, unknown> & {
+ label?: string
+ default_billing?: boolean
+ default_shipping?: boolean
+ },
+ options?: RequestOptions,
+ ): Promise<Address> =>
+ this.request<Address>('PATCH', `/companies/${companyId}/addresses/${id}`, {
+ ...options,
+ body: params,
+ }),
+
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/addresses/${id}`, options),
},
members: {
@@ -1248,6 +1266,10 @@ export class StoreClient {
`/companies/${companyId}/members`,
{ ...options, body: params },
),
+
+ /** Withdraws the member's standing. The customer account is untouched. */
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/members/${id}`, options),
},
invitations: {
@@ -1261,6 +1283,10 @@ export class StoreClient {
`/companies/${companyId}/invitations`,
{ ...options, params: transformListParams({ ...params }) },
),
+
+ /** Revokes a pending invitation; its token then stops resolving. */
+ delete: (companyId: string, id: string, options?: RequestOptions): Promise<void> =>
+ this.request<void>('DELETE', `/companies/${companyId}/invitations/${id}`, options),
},
/** Completed purchases across the node's subtree. */
@@ -1277,30 +1303,6 @@ export class StoreClient {
},
}
- readonly companyAddresses = {
- update: (
- id: string,
- params: Record<string, unknown> & {
- label?: string
- default_billing?: boolean
- default_shipping?: boolean
- },
- options?: RequestOptions,
- ): Promise<Address> =>
- this.request<Address>('PATCH', `/company_addresses/${id}`, {
- ...options,
- body: params,
- }),
-
- delete: (id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/company_addresses/${id}`, options),
- }
-
- readonly companyMembers = {
- delete: (id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/company_members/${id}`, options),
- }
-
/**
* Invitations: members revoke by prefixed id; invitees look up and accept
* by the plaintext token from the invite email (no authentication needed —
diff --git a/spree/api/app/controllers/spree/api/v3/admin/companies/addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/companies/addresses_controller.rb
index 37cc2eb133..9230143ab4 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/companies/addresses_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/companies/addresses_controller.rb
@@ -3,9 +3,8 @@ module Spree
module V3
module Admin
module Companies
- # A node's address book. Listing and creating live here; editing and
- # deleting an entry are addressed directly, since a caller holding
- # an entry id shouldn't have to know its company.
+ # A node's address book — an entry is an ordinary address the node
+ # owns, so the whole of it is reached through the node.
class AddressesController < BaseController
include Spree::Api::V3::Admin::Concerns::CompanyAddressParams
@@ -13,7 +12,6 @@ module Spree
protected
-
def model_class
Spree::Address
end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/companies/invitations_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/companies/invitations_controller.rb
index ec0ffbd057..8acfa85162 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/companies/invitations_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/companies/invitations_controller.rb
@@ -8,6 +8,21 @@ module Spree
class InvitationsController < BaseController
before_action :authorize_parent_access!
+ # DELETE /api/v3/admin/companies/:company_id/invitations/:id
+ #
+ # Revokes rather than erases: a spent token keeps refusing.
+ 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
@@ -22,8 +37,12 @@ module Spree
# invitations would otherwise push live ones out of the first
# page and make the row count describe the wrong set. Spent and
# revoked rows are history, not a work list.
+ # The listing shows live invitations only, so spent rows cannot
+ # push pending ones off the first page. Addressing one by id still
+ # finds it, so revoking an already-spent invitation answers "not
+ # pending" rather than "no such invitation".
def scope
- @parent.invitations.pending
+ action_name == 'index' ? @parent.invitations.pending : @parent.invitations
end
def parent_association
diff --git a/spree/api/app/controllers/spree/api/v3/admin/company_addresses_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/company_addresses_controller.rb
deleted file mode 100644
index 00d7394eca..0000000000
--- a/spree/api/app/controllers/spree/api/v3/admin/company_addresses_controller.rb
+++ /dev/null
@@ -1,32 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- # An address-book entry addressed directly. Reached through the
- # store's companies so an entry of another tenant's company is a 404.
- class CompanyAddressesController < ResourceController
- include Spree::Api::V3::Admin::Concerns::CompanyAddressParams
-
- scoped_resource :customers
-
- protected
-
-
- def model_class
- Spree::Address
- end
-
- def serializer_class
- Spree.api.admin_address_serializer
- end
-
- def scope
- Spree::Address.where(owner_type: 'Spree::Company',
- owner_id: current_store.companies.select(:id)).
- accessible_by(current_ability, ability_action_for_request)
- end
- end
- end
- end
- end
-end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/company_invitations_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/company_invitations_controller.rb
deleted file mode 100644
index fdf0816a7f..0000000000
--- a/spree/api/app/controllers/spree/api/v3/admin/company_invitations_controller.rb
+++ /dev/null
@@ -1,42 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- # An invitation addressed directly. DELETE revokes rather than
- # destroys — the row is the record that an invite went out, and a
- # revoked token has to keep 404ing rather than becoming reissuable.
- class CompanyInvitationsController < ResourceController
- scoped_resource :customers
-
- # DELETE /api/v3/admin/company_invitations/:id
- 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.admin_company_invitation_serializer
- end
-
- def scope
- Spree::CompanyInvitation.where(company_id: current_store.companies.select(:id)).
- accessible_by(current_ability, ability_action_for_request)
- end
- end
- end
- end
- end
-end
diff --git a/spree/api/app/controllers/spree/api/v3/admin/company_memberships_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/company_memberships_controller.rb
deleted file mode 100644
index cb9912ec3b..0000000000
--- a/spree/api/app/controllers/spree/api/v3/admin/company_memberships_controller.rb
+++ /dev/null
@@ -1,28 +0,0 @@
-module Spree
- module Api
- module V3
- module Admin
- # Removing a buyer's standing over a node, addressed directly by
- # membership id.
- class CompanyMembershipsController < ResourceController
- scoped_resource :customers
-
- protected
-
- def model_class
- Spree::CompanyMembership
- end
-
- def serializer_class
- Spree.api.admin_company_membership_serializer
- end
-
- def scope
- Spree::CompanyMembership.where(company_id: current_store.companies.select(:id)).
- accessible_by(current_ability, ability_action_for_request)
- end
- end
- end
- end
- end
-end
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.rb
index aad14e9b49..15e03ef770 100644
--- 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.rb
@@ -3,11 +3,12 @@ module Spree
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).
+ # The node's address book, managed by its members. Every entry is
+ # reached through its node, so standing over that node is the only
+ # thing that authorizes reading or writing one.
class AddressesController < BaseController
include Spree::Api::V3::Store::Concerns::CompanyAddressDefaults
+
# POST /api/v3/store/companies/:company_id/addresses
def create
address = @parent.addresses.new(permitted_params)
@@ -20,6 +21,24 @@ module Spree
end
end
+ # PATCH /api/v3/store/companies/:company_id/addresses/:id
+ def update
+ if @resource.update(permitted_params)
+ apply_default_flags!(@resource)
+ render json: serialize_resource(@resource.reload)
+ else
+ render_validation_error(@resource.errors)
+ end
+ end
+
+ # DELETE /api/v3/store/companies/:company_id/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
diff --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.rb
index cc1df41db8..32ecca2856 100644
--- 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.rb
@@ -6,6 +6,21 @@ module Spree
# The pending invitations into one node, visible to its members.
# Revocation is addressed directly by invitation id.
class InvitationsController < BaseController
+ # DELETE /api/v3/store/companies/:company_id/invitations/:id
+ #
+ # Revokes rather than erases: a spent token keeps refusing.
+ 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
@@ -16,8 +31,12 @@ module Spree
Spree.api.company_invitation_serializer
end
+ # The listing shows live invitations only, so spent rows cannot
+ # push pending ones off the first page. Addressing one by id still
+ # finds it, so revoking an already-spent invitation answers "not
+ # pending" rather than "no such invitation".
def scope
- @parent.invitations
+ action_name == 'index' ? @parent.invitations.pending : @parent.invitations
end
def parent_association
diff --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.rb
index ef93b9cef3..6d0831d492 100644
--- 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.rb
@@ -29,6 +29,14 @@ module Spree
end
end
+ # DELETE /api/v3/store/companies/:company_id/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
diff --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.rb
deleted file mode 100644
index fd2686b365..0000000000
--- a/spree/api/app/controllers/spree/api/v3/store/company_addresses_controller.rb
+++ /dev/null
@@ -1,56 +0,0 @@
-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
- include Spree::Api::V3::Store::Concerns::CompanyAddressDefaults
-
- prepend_before_action :require_authentication!
-
- # PATCH /api/v3/store/company_addresses/:id
- def update
- if @resource.update(permitted_params)
- apply_default_flags!(@resource)
- 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::Address
- end
-
- def serializer_class
- Spree.api.address_serializer
- end
-
- def scope
- Spree::Address.where(
- owner_type: 'Spree::Company',
- owner_id: storefront_access_policy.scope(current_store.companies).select(:id)
- )
- end
-
- def permitted_params
- params.permit(:label, *Spree::Api::V3::AddressParams::ADDRESS_KEYS)
- end
-
- end
- end
- end
- end
-end
diff --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.rb
index 5cb9e10bf5..50fc2a8705 100644
--- 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.rb
@@ -2,24 +2,20 @@ module Spree
module Api
module V3
module Store
- # Invitations addressed directly. Two audiences share this
- # controller:
+ # The invitee's side of an invitation: look up and accept by plaintext
+ # token, 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 — which is why this is the
+ # one part of the company surface not reached through a node.
#
- # - 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).
+ # Members revoke through the node
+ # (Store::Companies::InvitationsController).
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.
+ # Both actions are token lookups, not prefixed-id reads — 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.
@@ -62,19 +58,6 @@ module Spree
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
@@ -86,12 +69,6 @@ module Spree
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
diff --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.rb
deleted file mode 100644
index a5ff5b7ebb..0000000000
--- a/spree/api/app/controllers/spree/api/v3/store/company_members_controller.rb
+++ /dev/null
@@ -1,38 +0,0 @@
-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
-end
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 93351ee471..a1c430a81f 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -124,20 +124,20 @@ Spree::Core::Engine.add_routes do
get 'account/companies', to: 'account/companies#index'
resources :companies, only: [:show, :update] do
- resources :addresses, only: [:index, :create], controller: 'companies/addresses'
+ resources :addresses, only: [:index, :create, :update, :destroy],
+ controller: 'companies/addresses'
# POST takes customer_email — a membership for an existing customer,
# an invitation otherwise.
- resources :members, only: [:index, :create], controller: 'companies/members'
- resources :invitations, only: [:index], controller: 'companies/invitations'
+ resources :members, only: [:index, :create, :destroy], controller: 'companies/members'
+ # DELETE revokes the invitation rather than erasing the record.
+ resources :invitations, only: [:index, :destroy], controller: 'companies/invitations'
# Completed purchases across the node's subtree.
resources :orders, only: [:index], controller: 'companies/orders'
end
- resources :company_addresses, only: [:update, :destroy]
- resources :company_members, only: [:destroy]
- # DELETE revokes (by prefixed id, member-authenticated); GET and
- # accept are the unauthenticated token flow from the invite email.
- resources :company_invitations, only: [:destroy]
+ # The invitee has no company yet — and no account — so the token flow
+ # is deliberately top-level and unauthenticated, unlike everything
+ # else about a company, which is reached through the node.
get 'company_invitations/:token', to: 'company_invitations#show', as: :company_invitation_lookup
post 'company_invitations/:token/accept', to: 'company_invitations#accept'
@@ -536,12 +536,15 @@ Spree::Core::Engine.add_routes do
# a caller holding an entry id does not have to know its company.
resources :companies do
# The node's address book.
- resources :addresses, controller: 'companies/addresses', only: [:index, :create]
+ resources :addresses, controller: 'companies/addresses'
# The people with standing over the node. Creation takes an email:
# a membership for an existing customer, an invitation otherwise.
- resources :memberships, controller: 'companies/memberships', only: [:index, :create]
- resources :invitations, controller: 'companies/invitations', only: [:index]
+ resources :memberships, controller: 'companies/memberships',
+ only: [:index, :show, :create, :destroy]
+ # DELETE revokes the invitation rather than erasing the record.
+ resources :invitations, controller: 'companies/invitations',
+ only: [:index, :show, :destroy]
# The business's own registration — the number on its invoices, which
# outranks the buyer's own. Same shape as the customer's.
@@ -563,10 +566,6 @@ Spree::Core::Engine.add_routes do
end
end
- resources :company_addresses, only: [:show, :update, :destroy]
- resources :company_memberships, only: [:show, :destroy]
- # DELETE revokes the invitation rather than erasing the record.
- resources :company_invitations, only: [:show, :destroy]
# Catalogs — assortment + optional price list, assigned to an audience
# (channel, customer group, market, or company subtree).
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/companies/invitations_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/companies/invitations_controller_spec.rb
index 05a1a67ee3..7cdc41eeea 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/companies/invitations_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/companies/invitations_controller_spec.rb
@@ -30,6 +30,45 @@ RSpec.describe Spree::Api::V3::Admin::Companies::InvitationsController, type: :c
it '404s under another store company' do
get :index, params: { company_id: create(:company, store: create(:store)).prefixed_id }, as: :json
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+ describe 'GET #show' do
+ it 'returns the invitation without its token' do
+ invitation = create(:company_invitation, company: company)
+
+ get :show, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['status']).to eq('pending')
+ expect(json_response).not_to have_key('token')
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ it 'revokes rather than erases' do
+ invitation = create(:company_invitation, company: company)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:no_content)
+ expect(invitation.reload).to be_revoked
+ end
+
+ it 'refuses on an already spent invitation' do
+ invitation = create(:company_invitation, company: company, accepted_at: Time.current)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:unprocessable_content)
+ end
+
+ it '404s an invitation of another store company' do
+ foreign_company = create(:company, store: create(:store))
+ foreign = create(:company_invitation, company: foreign_company)
+
+ delete :destroy, params: { company_id: foreign_company.prefixed_id, id: foreign.prefixed_id }, as: :json
+
expect(response).to have_http_status(:not_found)
end
end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/company_addresses_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/company_addresses_controller_spec.rb
deleted file mode 100644
index 642700493c..0000000000
--- a/spree/api/spec/controllers/spree/api/v3/admin/company_addresses_controller_spec.rb
+++ /dev/null
@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::Api::V3::Admin::CompanyAddressesController, type: :controller do
- render_views
-
- include_context 'API v3 Admin authenticated'
-
- let(:company) { create(:company, store: store) }
- let!(:entry) { create(:company_address, owner: company, label: 'HQ') }
-
- before { request.headers.merge!(headers) }
-
- describe 'GET #show' do
- it 'returns the entry with its address' do
- get :show, params: { id: entry.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(json_response['label']).to eq('HQ')
- expect(json_response['owner_id']).to eq(company.prefixed_id)
- end
-
- it '404s an entry of another store company' do
- foreign = create(:company_address, owner: create(:company, store: create(:store)))
-
- get :show, params: { id: foreign.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:not_found)
- end
- end
-
- describe 'PATCH #update' do
- it 'edits the address in place instead of replacing it' do
- patch :update, params: { id: entry.prefixed_id, city: 'Shelbyville' }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(entry.reload.city).to eq('Shelbyville')
- end
-
- it 'promotes an entry to default billing' do
- patch :update, params: { id: entry.prefixed_id, default_billing: true }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(company.reload.default_bill_address_id).to eq(entry.id)
- expect(json_response['is_default_billing']).to be(true)
- end
- end
-
- describe 'DELETE #destroy' do
- it 'removes the 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
-end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/company_invitations_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/company_invitations_controller_spec.rb
deleted file mode 100644
index 8eb4a95087..0000000000
--- a/spree/api/spec/controllers/spree/api/v3/admin/company_invitations_controller_spec.rb
+++ /dev/null
@@ -1,47 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::Api::V3::Admin::CompanyInvitationsController, type: :controller do
- render_views
-
- include_context 'API v3 Admin authenticated'
-
- let(:company) { create(:company, store: store) }
- let!(:invitation) { create(:company_invitation, company: company) }
-
- before { request.headers.merge!(headers) }
-
- describe 'GET #show' do
- it 'returns the invitation without its token' do
- get :show, params: { id: invitation.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(json_response['status']).to eq('pending')
- expect(json_response).not_to have_key('token')
- end
- end
-
- describe 'DELETE #destroy' do
- it 'revokes rather than erases' do
- 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 'refuses on an already spent invitation' do
- invitation.update!(accepted_at: Time.current)
-
- delete :destroy, params: { id: invitation.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:unprocessable_content)
- end
-
- it '404s an invitation of another store company' do
- foreign = create(:company_invitation, company: create(:company, store: create(:store)))
-
- delete :destroy, params: { id: foreign.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:not_found)
- end
- end
-end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/company_memberships_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/company_memberships_controller_spec.rb
deleted file mode 100644
index 0c9b067487..0000000000
--- a/spree/api/spec/controllers/spree/api/v3/admin/company_memberships_controller_spec.rb
+++ /dev/null
@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::Api::V3::Admin::CompanyMembershipsController, type: :controller do
- render_views
-
- include_context 'API v3 Admin authenticated'
-
- let(:company) { create(:company, store: store) }
- let!(:membership) { create(:company_membership, company: company) }
-
- before { request.headers.merge!(headers) }
-
- describe 'GET #show' do
- it 'returns the membership' do
- get :show, params: { id: membership.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(json_response['id']).to eq(membership.prefixed_id)
- end
-
- it '404s a membership of another store company' do
- foreign = create(:company_membership, company: create(:company, store: create(:store)))
-
- get :show, params: { id: foreign.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:not_found)
- end
- end
-
- describe 'DELETE #destroy' do
- it 'removes the standing' do
- delete :destroy, params: { id: membership.prefixed_id }, as: :json
-
- expect(response).to have_http_status(:no_content)
- expect(company.memberships.reload).to be_empty
- end
- end
-end
diff --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.rb
index 700fa5642b..59a73cc670 100644
--- 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.rb
@@ -26,6 +26,34 @@ RSpec.describe Spree::Api::V3::Store::Companies::InvitationsController, type: :c
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
+ describe 'DELETE #destroy' do
+ it 'lets a member revoke rather than erase' do
+ create(:company_membership, company: company, customer: user)
+ invitation = create(:company_invitation, company: company)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:no_content)
+ expect(invitation.reload).to be_revoked
+ end
+
+ it 'refuses on an already spent invitation' do
+ create(:company_membership, company: company, customer: user)
+ invitation = create(:company_invitation, company: company, accepted_at: Time.current)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:unprocessable_content)
+ end
+
+ it '404s without standing' do
+ invitation = create(:company_invitation, company: company)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: invitation.prefixed_id }, as: :json
+
expect(response).to have_http_status(:not_found)
end
end
diff --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.rb
index ed161007fe..7a1c214cf9 100644
--- 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.rb
@@ -58,4 +58,24 @@ RSpec.describe Spree::Api::V3::Store::Companies::MembersController, type: :contr
expect(response).to have_http_status(:created)
end
end
+ describe 'DELETE #destroy' do
+ # OSS ships no company roles: any member may manage the directory.
+ it 'lets any member remove another member' do
+ other = create(:company_membership, company: company)
+
+ delete :destroy, params: { company_id: company.prefixed_id, id: other.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:no_content)
+ expect(Spree::CompanyMembership.find_by(id: other.id)).to be_nil
+ end
+
+ it '404s a member of a node the caller has no standing over' do
+ other_company = create(:company, store: store)
+ other = create(:company_membership, company: other_company)
+
+ delete :destroy, params: { company_id: other_company.prefixed_id, id: other.prefixed_id }, as: :json
+
+ expect(response).to have_http_status(:not_found)
+ end
+ end
end
diff --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.rb
deleted file mode 100644
index 26c77ea0fb..0000000000
--- a/spree/api/spec/controllers/spree/api/v3/store/company_addresses_controller_spec.rb
+++ /dev/null
@@ -1,38 +0,0 @@
-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, owner: company, label: 'HQ') }
-
- before { request.headers.merge!(headers) }
-
- context 'with standing' do
- before { create(:company_membership, company: company, customer: user) }
-
- it 'edits the entry in place' do
- patch :update, params: { id: entry.prefixed_id, label: 'Head office', city: 'Shelbyville' }, as: :json
-
- expect(response).to have_http_status(:ok)
- expect(entry.reload.label).to eq('Head office')
- expect(entry.city).to eq('Shelbyville')
- end
-
- it 'removes the 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
-end
diff --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.rb
index 24661eeee6..0e72ff29bd 100644
--- 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.rb
@@ -102,31 +102,4 @@ RSpec.describe Spree::Api::V3::Store::CompanyInvitationsController, type: :contr
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
end
diff --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.rb
deleted file mode 100644
index cd4fc8c9f6..0000000000
--- a/spree/api/spec/controllers/spree/api/v3/store/company_members_controller_spec.rb
+++ /dev/null
@@ -1,30 +0,0 @@
-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
-end
diff --git a/spree/api/spec/integration/spree/api/v3/store/companies_spec.rb b/spree/api/spec/integration/spree/api/v3/store/companies_spec.rb
index 4a00157dc1..64b23e5168 100644
--- a/spree/api/spec/integration/spree/api/v3/store/companies_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/companies_spec.rb
@@ -196,8 +196,9 @@ RSpec.describe 'Company Self-Service API', type: :request, swagger_doc: 'api-ref
end
end
- path '/api/v3/store/company_addresses/{id}' do
- parameter name: :id, in: :path, type: :string, required: true, description: 'Address book entry ID (caddr_...)'
+ path '/api/v3/store/companies/{company_id}/addresses/{id}' do
+ parameter name: :company_id, in: :path, type: :string, required: true, description: 'Company node ID (comp_...)'
+ parameter name: :id, in: :path, type: :string, required: true, description: 'Address ID (addr_...)'
patch 'Update an address book entry' do
tags 'Companies'
@@ -219,6 +220,7 @@ RSpec.describe 'Company Self-Service API', type: :request, swagger_doc: 'api-ref
response '200', 'address book entry updated' do
let!(:membership) { create(:company_membership, company: company, customer: user) }
let!(:entry) { create(:company_address, owner: company, label: 'Headquarters') }
+ let(:company_id) { company.prefixed_id }
let(:id) { entry.prefixed_id }
let(:body) { { label: 'Northern Warehouse', default_shipping: true } }
let(:'x-spree-api-key') { api_key.token }
@@ -242,6 +244,7 @@ RSpec.describe 'Company Self-Service API', type: :request, swagger_doc: 'api-ref
response '204', 'address book entry removed' do
let!(:membership) { create(:company_membership, company: company, customer: user) }
let!(:entry) { create(:company_address, owner: company, label: 'Headquarters') }
+ let(:company_id) { company.prefixed_id }
let(:id) { entry.prefixed_id }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }
@@ -251,7 +254,8 @@ RSpec.describe 'Company Self-Service API', type: :request, swagger_doc: 'api-ref
end
end
- path '/api/v3/store/company_invitations/{id}' do
+ path '/api/v3/store/companies/{company_id}/invitations/{id}' do
+ parameter name: :company_id, in: :path, type: :string, required: true, description: 'Company node ID (comp_...)'
parameter name: :id, in: :path, type: :string, required: true, description: 'Invitation ID (cinv_...)'
delete 'Revoke an invitation' do
@@ -266,6 +270,7 @@ RSpec.describe 'Company Self-Service API', type: :request, swagger_doc: 'api-ref
response '204', 'invitation revoked' do
let!(:membership) { create(:company_membership, company: company, customer: user) }
let!(:invitation) { create(:company_invitation, company: company, email: '[email protected]') }
+ let(:company_id) { company.prefixed_id }
let(:id) { invitation.prefixed_id }
let(:'x-spree-api-key') { api_key.token }
let(:'Authorization') { "Bearer #{jwt_token}" }