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
Fix: Fixed the Admin API returning a server error for a single digital link (#14981)
Łukasz Adamczyk687724a48d85
diff --git a/packages/admin-sdk/examples/digital-links/get.ts b/packages/admin-sdk/examples/digital-links/get.tsnew file mode 100644index 0000000000..ec18bfe104--- /dev/null+++ b/packages/admin-sdk/examples/digital-links/get.ts@@ -0,0 +1,13 @@+import { createAdminClient } from '@spree/admin-sdk'++const client = createAdminClient({+ baseUrl: 'https://your-store.com',+ secretKey: 'sk_xxx',+})++// region:example+const digitalLink = await client.digitalLinks.retrieve('dl_xxx')++// endregion:example++export { digitalLink }diff --git a/spree/api/app/controllers/spree/api/v3/admin/digital_links_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/digital_links_controller.rbindex f0583cc7ec..1ca69b0dfb 100644--- a/spree/api/app/controllers/spree/api/v3/admin/digital_links_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/digital_links_controller.rb@@ -5,7 +5,9 @@ module Spreeclass DigitalLinksController < ResourceControllerscoped_resource :orders- before_action :set_resource, only: [:reset]+ # Redeclaring `set_resource` replaces the base class's filter rather+ # than extending it, so every routed member action is listed here.+ before_action :set_resource, only: [:show, :reset]# PATCH /api/v3/admin/digital_links/:id/reset#diff --git a/spree/api/spec/controllers/spree/api/v3/admin/digital_links_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/digital_links_controller_spec.rbindex 69a3cdfd25..a6c22df213 100644--- a/spree/api/spec/controllers/spree/api/v3/admin/digital_links_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/admin/digital_links_controller_spec.rb@@ -10,6 +10,10 @@ RSpec.describe Spree::Api::V3::Admin::DigitalLinksController, type: :controllerlet(:line_item) { order.line_items.first }let(:digital_asset) { create(:digital_asset, variant: line_item.variant) }let!(:digital_link) { create(:digital_link, digital_asset: digital_asset, line_item: line_item) }+ let(:other_store_link) do+ other_item = create(:order_with_line_items, store: create(:store)).line_items.first+ create(:digital_link, digital_asset: create(:digital_asset, variant: other_item.variant), line_item: other_item)+ endbefore { request.headers.merge!(headers) }@@ -22,14 +26,27 @@ RSpec.describe Spree::Api::V3::Admin::DigitalLinksController, type: :controllerendit 'excludes links from another store' do- other_order = create(:order_with_line_items, store: create(:store))- other_item = other_order.line_items.first- other_link = create(:digital_link, digital_asset: create(:digital_asset, variant: other_item.variant),- line_item: other_item)+ other_store_linkget :index- expect(json_response['data'].map { |l| l['id'] }).not_to include(other_link.prefixed_id)+ expect(json_response['data'].map { |l| l['id'] }).not_to include(other_store_link.prefixed_id)+ end+ end++ describe 'GET #show' do+ it 'returns the link' do+ get :show, params: { id: digital_link.prefixed_id }++ expect(response).to have_http_status(:ok)+ expect(json_response['id']).to eq(digital_link.prefixed_id)+ expect(json_response['access_counter']).to eq(0)+ end++ it 'does not return a link from another store' do+ get :show, params: { id: other_store_link.prefixed_id }++ expect(response).to have_http_status(:not_found)endend@@ -55,12 +72,7 @@ RSpec.describe Spree::Api::V3::Admin::DigitalLinksController, type: :controllerendit 'does not reset a link from another store' do- other_order = create(:order_with_line_items, store: create(:store))- other_item = other_order.line_items.first- other_link = create(:digital_link, digital_asset: create(:digital_asset, variant: other_item.variant),- line_item: other_item)-- patch :reset, params: { id: other_link.prefixed_id }+ patch :reset, params: { id: other_store_link.prefixed_id }expect(response).to have_http_status(:not_found)end@@ -69,6 +81,24 @@ RSpec.describe Spree::Api::V3::Admin::DigitalLinksController, type: :controller# Reset is a write: the catalog grants :manage for write_orders, so no# per-action mapping is needed — but the deny path is worth pinning.describe 'scope enforcement' do+ it 'denies show to a key without an orders scope' do+ products_key = create(:api_key, :secret, store: store, scopes: ['read_products'])+ request.headers['x-spree-api-key'] = products_key.plaintext_token++ get :show, params: { id: digital_link.prefixed_id }++ expect(response.status).to be_in([401, 403])+ end++ it 'allows show with a read-only key' do+ read_key = create(:api_key, :secret, store: store, scopes: ['read_orders'])+ request.headers['x-spree-api-key'] = read_key.plaintext_token++ get :show, params: { id: digital_link.prefixed_id }++ expect(response).to have_http_status(:ok)+ end+it 'denies reset to a read-only key' doread_key = create(:api_key, :secret, store: store, scopes: ['read_orders'])request.headers['x-spree-api-key'] = read_key.plaintext_tokendiff --git a/spree/api/spec/integration/spree/api/v3/admin/digital_links_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/digital_links_spec.rbindex 63f2864909..d6bfeb1c13 100644--- a/spree/api/spec/integration/spree/api/v3/admin/digital_links_spec.rb+++ b/spree/api/spec/integration/spree/api/v3/admin/digital_links_spec.rb@@ -40,4 +40,42 @@ RSpec.describe 'Admin Digital Links API', type: :request, swagger_doc: 'api-refeendendend++ path '/api/v3/admin/digital_links/{id}' do+ parameter name: :id, in: :path, type: :string, required: true, description: 'Digital link ID'++ get 'Get a digital link' do+ tags 'Orders'+ produces 'application/json'+ security [api_key: [], bearer_auth: []]+ description 'Returns a single download link with its download count and expiry.'+ admin_scope :read, :orders++ admin_sdk_example 'digital-links/get'++ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true+ parameter name: :Authorization, in: :header, type: :string, required: true,+ description: 'Bearer token for admin authentication'++ response '200', 'digital link found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { digital_link.prefixed_id }++ schema '$ref' => '#/components/schemas/DigitalLink'++ run_test! do |response|+ expect(JSON.parse(response.body)['id']).to eq(digital_link.prefixed_id)+ end+ end++ response '404', 'digital link not found' do+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }+ let(:id) { 'dl_nonexistent' }++ schema '$ref' => '#/components/schemas/ErrorResponse'++ run_test!+ end+ end+ endend