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
Add Direct Uploads API for Admin
Damian Legawiecd61f49aec30e
diff --git a/packages/sdk/src/admin-client.ts b/packages/sdk/src/admin-client.tsindex c78efb576b..07b892108a 100644--- a/packages/sdk/src/admin-client.ts+++ b/packages/sdk/src/admin-client.ts@@ -96,6 +96,18 @@ export class AdminClient {this.request<AdminAuthTokens>('POST', '/auth/refresh', options),};+ // ============================================+ // Direct Uploads (hand-written, not auto-generated)+ // ============================================++ readonly directUploads = {+ create: (+ params: { blob: { filename: string; byte_size: number; checksum: string; content_type: string } },+ options?: RequestOptions,+ ): Promise<{ direct_upload: { url: string; headers: Record<string, string> }; signed_id: string }> =>+ this.request('POST', '/direct_uploads', { ...options, body: params }),+ } as const;+// ============================================// Option Types// ============================================diff --git a/packages/sdk/src/admin-params.ts b/packages/sdk/src/admin-params.tsindex e6514ee174..42c8d3f0ab 100644--- a/packages/sdk/src/admin-params.ts+++ b/packages/sdk/src/admin-params.ts@@ -109,6 +109,7 @@ export interface AdminAssetCreateParams {position?: number;type?: string;url?: string;+ signed_id?: string;}export interface AdminAssetUpdateParams {diff --git a/server/config/initializers/cors.rb b/server/config/initializers/cors.rbindex a13f827ae6..d54e755f83 100644--- a/server/config/initializers/cors.rb+++ b/server/config/initializers/cors.rb@@ -26,5 +26,11 @@ Rails.application.config.middleware.insert_before 0, Rack::Cors domethods: [:get, :post, :put, :patch, :delete, :options, :head],expose: ['X-Total-Count', 'X-Page', 'X-Per-Page'],max_age: 7200++ # Active Storage direct uploads (disk service uses Rails routes for PUT)+ resource '/rails/active_storage/*',+ headers: :any,+ methods: [:get, :put, :options, :head],+ max_age: 3600endenddiff --git a/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rbindex 176a7b739c..8be4c492c3 100644--- a/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb@@ -6,6 +6,8 @@ module Spreedef createif permitted_params[:url].present?create_from_url+ elsif permitted_params[:signed_id].present?+ create_from_signed_idelse@resource = build_resourceauthorize_resource!(@resource, :create)@@ -25,7 +27,7 @@ module Spreeenddef serializer_class- Spree.api.admin_asset_serializer+ Spree.api.admin_image_serializerenddef set_parent@@ -52,7 +54,7 @@ module Spreeraise ArgumentError, "Invalid asset type: #{asset_type}"end- asset = @parent.images.build(permitted_params.except(:type, :url))+ asset = @parent.images.build(permitted_params.except(:type, :url, :signed_id))asset.type = asset_typeasset@@ -78,6 +80,18 @@ module Spreehead :acceptedend++ def create_from_signed_id+ @resource = build_resource+ @resource.attachment.attach(permitted_params[:signed_id])+ authorize_resource!(@resource, :create)++ if @resource.save+ render json: serialize_resource(@resource), status: :created+ else+ render_validation_error(@resource.errors)+ end+ endendendenddiff --git a/spree/api/app/controllers/spree/api/v3/admin/direct_uploads_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/direct_uploads_controller.rbnew file mode 100644index 0000000000..e16f23da6a--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/admin/direct_uploads_controller.rb@@ -0,0 +1,30 @@+module Spree+ module Api+ module V3+ module Admin+ class DirectUploadsController < Admin::BaseController+ skip_before_action :authenticate_user++ # POST /api/v3/admin/direct_uploads+ def create+ blob = ActiveStorage::Blob.create_before_direct_upload!(**blob_params)++ render json: {+ direct_upload: {+ url: blob.service_url_for_direct_upload,+ headers: blob.service_headers_for_direct_upload+ },+ signed_id: blob.signed_id+ }, status: :created+ end++ private++ def blob_params+ params.require(:blob).permit(:filename, :byte_size, :checksum, :content_type).to_h.symbolize_keys+ end+ end+ end+ end+ end+enddiff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rbindex 69e128a62e..9fe3f7c83c 100644--- a/spree/api/config/routes.rb+++ b/spree/api/config/routes.rb@@ -95,6 +95,9 @@ Spree::Core::Engine.add_routes dopost 'auth/login', to: 'auth#create'post 'auth/refresh', to: 'auth#refresh'+ # Direct Uploads (Active Storage)+ resources :direct_uploads, only: [:create]+# Productsresources :products domember dodiff --git a/spree/api/spec/controllers/spree/api/v3/admin/direct_uploads_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/direct_uploads_controller_spec.rbnew file mode 100644index 0000000000..ecb7eea7cc--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/direct_uploads_controller_spec.rb@@ -0,0 +1,41 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Admin::DirectUploadsController, type: :controller do+ render_views++ include_context 'API v3 Admin authenticated'++ describe 'POST #create' do+ before { request.headers.merge!(headers) }++ let(:blob_params) do+ {+ blob: {+ filename: 'test-image.jpg',+ byte_size: 1024,+ checksum: 'dGVzdA==',+ content_type: 'image/jpeg'+ }+ }+ end++ it 'creates a direct upload and returns presigned URL' do+ post :create, params: blob_params, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['signed_id']).to be_present+ expect(json_response['direct_upload']).to be_present+ expect(json_response['direct_upload']['url']).to be_present+ expect(json_response['direct_upload']['headers']).to be_a(Hash)+ end++ context 'without API key' do+ let(:headers) { {} }++ it 'returns unauthorized' do+ post :create, params: blob_params, as: :json+ expect(response).to have_http_status(:unauthorized)+ end+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rbnew file mode 100644index 0000000000..79190df5b8--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rb@@ -0,0 +1,34 @@+require 'spec_helper'++RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do+ render_views++ include_context 'API v3 Admin authenticated'++ let!(:product) { create(:product, stores: [store]) }++ before { request.headers.merge!(headers) }++ describe 'POST #create with signed_id' do+ let(:blob) do+ ActiveStorage::Blob.create_and_upload!(+ io: File.open(Spree::Core::Engine.root.join('spec', 'fixtures', 'thinking-cat.jpg')),+ filename: 'test-image.jpg',+ content_type: 'image/jpeg'+ )+ end++ it 'creates an asset from a signed blob ID' do+ post :create, params: {+ product_id: product.prefixed_id,+ signed_id: blob.signed_id,+ alt: 'Test image',+ position: 1+ }, as: :json++ expect(response).to have_http_status(:created)+ expect(json_response['id']).to be_present+ expect(json_response['alt']).to eq('Test image')+ end+ end+enddiff --git a/spree/core/lib/spree/permitted_attributes.rb b/spree/core/lib/spree/permitted_attributes.rbindex a41e75a0d8..7cffc53a73 100644--- a/spree/core/lib/spree/permitted_attributes.rb+++ b/spree/core/lib/spree/permitted_attributes.rb@@ -92,7 +92,7 @@ module Spree@@api_key_attributes = [:name, :key_type]- @@asset_attributes = [:type, :viewable_id, :viewable_type, :attachment, :alt, :position, :url]+ @@asset_attributes = [:type, :viewable_id, :viewable_type, :attachment, :alt, :position, :url, :signed_id]@@checkout_attributes = [:coupon_code, :email, :shipping_method_id, :special_instructions, :use_billing, :use_shipping,