spree_api 6.0.0.beta3 → 6.0.0.rc1

data/app/controllers/spree/api/v3/store/carts/gift_cards_controller.rb

@@ -18,6 +18,7 @@ module Spree
                 result = @cart.apply_gift_card(gift_card)
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart(status: :created)
                 else
                   render_service_error(result.error)
@@ -31,6 +32,7 @@ module Spree
                 result = @cart.remove_gift_card
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart
                 else
                   render_service_error(result.error)
@@ -44,17 +46,17 @@ module Spree
               gift_card = @cart.store.gift_cards.find_by(code: permitted_params[:code]&.downcase)
 
               if gift_card.nil?
-                render_error(code: ERROR_CODES[:gift_card_not_found], message: Spree.t(:gift_card_not_found), status: :not_found)
+                render_error(code: ERROR_CODES[:gift_card_not_found], message: I18n.t('spree.gift_card_not_found'), status: :not_found)
                 return
               end
 
               if gift_card.expired?
-                render_error(code: ERROR_CODES[:gift_card_expired], message: Spree.t(:gift_card_expired), status: :unprocessable_content)
+                render_error(code: ERROR_CODES[:gift_card_expired], message: I18n.t('spree.gift_card_expired'), status: :unprocessable_content)
                 return
               end
 
               if gift_card.redeemed?
-                render_error(code: ERROR_CODES[:gift_card_already_redeemed], message: Spree.t(:gift_card_already_redeemed), status: :unprocessable_content)
+                render_error(code: ERROR_CODES[:gift_card_already_redeemed], message: I18n.t('spree.gift_card_already_redeemed'), status: :unprocessable_content)
                 return
               end
 

data/app/controllers/spree/api/v3/store/carts/items_controller.rb

@@ -21,6 +21,7 @@ module Spree
                 )
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart(status: :created)
                 else
                   render_result_error(result)
@@ -41,7 +42,7 @@ module Spree
                   if permitted_params[:quantity].to_i < 1
                     return render_error(
                       code: ERROR_CODES[:invalid_quantity],
-                      message: Spree.t('cart_line_item.quantity_must_be_positive'),
+                      message: I18n.t('spree.cart_line_item.quantity_must_be_positive'),
                       status: :unprocessable_content
                     )
                   end
@@ -56,6 +57,7 @@ module Spree
                   )
 
                   if result.success?
+                    sweep_unavailable_coupon_code!
                     render_cart
                   else
                     render_result_error(result)
@@ -67,6 +69,7 @@ module Spree
                     @line_item.update!(metadata: @line_item.metadata.merge(permitted_params[:metadata].to_h))
                   end
 
+                  sweep_unavailable_coupon_code!
                   render_cart
                 end
               end
@@ -83,6 +86,7 @@ module Spree
                 )
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart
                 else
                   render_result_error(result)
@@ -93,7 +97,7 @@ module Spree
             private
 
             def variant
-              @variant ||= current_store.variants.find_by_prefix_id!(permitted_params[:variant_id])
+              @variant ||= @cart.orderable_variants.find_by_prefix_id!(permitted_params[:variant_id])
             end
 
             # Extension attributes ride in `options`, which is how AddItem

data/app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb

@@ -19,7 +19,7 @@ module Spree
                 unless payment_method.available_for_order?(@cart)
                   return render_error(
                     code: 'payment_method_unavailable',
-                    message: Spree.t('api.v3.payments.method_unavailable'),
+                    message: I18n.t('spree.api.v3.payments.method_unavailable'),
                     status: :unprocessable_content
                   )
                 end

data/app/controllers/spree/api/v3/store/carts/payments_controller.rb

@@ -20,15 +20,17 @@ module Spree
               if payment_method.session_required?
                 return render_error(
                   code: 'payment_session_required',
-                  message: Spree.t('api.v3.payments.session_required'),
+                  message: I18n.t('spree.api.v3.payments.session_required'),
                   status: :unprocessable_content
                 )
               end
 
-              unless payment_method.available_for_order?(@cart)
+              # Store credit passes the lookup above but has its own endpoint, so
+              # it is never among the methods the cart offers.
+              unless @cart.payment_methods.include?(payment_method)
                 return render_error(
                   code: 'payment_method_unavailable',
-                  message: Spree.t('api.v3.payments.method_unavailable'),
+                  message: I18n.t('spree.api.v3.payments.method_unavailable'),
                   status: :unprocessable_content
                 )
               end

data/app/controllers/spree/api/v3/store/carts/po_documents_controller.rb

@@ -94,8 +94,8 @@ module Spree
             def render_po_document_invalid
               render_error(
                 code: ERROR_CODES[:parameter_invalid],
-                message: Spree.t(
-                  :po_document_invalid,
+                message: I18n.t(
+                  'spree.po_document_invalid',
                   size: ActiveSupport::NumberHelper.number_to_human_size(
                     Spree::Purchase::PurchaseOrder::MAX_PO_DOCUMENT_SIZE
                   )

data/app/controllers/spree/api/v3/store/carts/store_credits_controller.rb

@@ -19,6 +19,7 @@ module Spree
                 )
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart
                 else
                   render_service_error(result.error)
@@ -32,6 +33,7 @@ module Spree
                 result = Spree.store_credit_remove_service.call(order: @cart)
 
                 if result.success?
+                  sweep_unavailable_coupon_code!
                   render_cart
                 else
                   render_service_error(result.error)

data/app/controllers/spree/api/v3/store/carts_controller.rb

@@ -26,12 +26,13 @@ module Spree
             # with_order_lock, and a read must not 409 against the fence.
             if @cart.ship_address_id.present? && @cart.fulfillments.empty? && !@cart.completion_claimed?
               ActiveRecord::Base.connected_to(role: :writing) do
-                with_order_lock { Spree::Checkout::Advance.call(order: @cart) }
+                with_order_lock { Spree.checkout_advance_service.call(order: @cart) }
               end
             end
 
             # The customer is returning to a cart that may have sat for days.
             sweep_unbuyable_lines!
+            sweep_unavailable_coupon_code!
             render_cart
           end
 
@@ -39,9 +40,9 @@ module Spree
           # Creates a new shopping cart (order)
           # Can be created by guests or authenticated customers
           def create
-            result = Spree::Carts::Create.call(
+            result = Spree.carts_create_service.call(
               params: permitted_params.merge(
-                user: current_user,
+                customer: current_user,
                 store: current_store,
                 channel: current_channel,
                 currency: current_currency,
@@ -64,12 +65,13 @@ module Spree
             find_cart!
 
             with_order_lock do
-              result = Spree::Carts::Update.call(
+              result = Spree.carts_update_service.call(
                 cart: @cart,
                 params: permitted_params
               )
 
               if result.success?
+                sweep_unavailable_coupon_code!
                 render_cart
               else
                 render_service_error(result.error, code: ERROR_CODES[:validation_error])
@@ -107,6 +109,7 @@ module Spree
             if result.success?
               # Signing in hands back a cart built earlier, possibly long ago.
               sweep_unbuyable_lines!
+              sweep_unavailable_coupon_code!
               render_cart
             else
               render_service_error(result.error.to_s)
@@ -121,7 +124,7 @@ module Spree
             find_cart!(include_completed: true)
 
             if @cart.guest_checkout_disallowed?
-              return render_authentication_required('api.errors.guest_checkout_not_allowed', 'You must be signed in to complete checkout')
+              return render_authentication_required(I18n.t('spree.api.errors.guest_checkout_not_allowed'))
             end
 
             result = Spree::Dependencies.carts_complete_workflow.constantize.call(cart: @cart)
@@ -184,7 +187,7 @@ module Spree
           def render_invalid_po_document
             render_error(
               code: ERROR_CODES[:validation_error],
-              message: Spree.t(:po_document_invalid_signed_id),
+              message: I18n.t('spree.po_document_invalid_signed_id'),
               status: :unprocessable_content
             )
           end

data/app/controllers/spree/api/v3/store/companies/addresses_controller.rb

@@ -66,10 +66,6 @@ module Spree
               action_name == 'index' ? @parent.address_book : @parent.addresses
             end
 
-            def parent_association
-              :addresses
-            end
-
             def permitted_params
               params.permit(:label, *Spree::Api::V3::AddressParams::ADDRESS_KEYS)
             end

data/app/controllers/spree/api/v3/store/companies/invitations_controller.rb

@@ -15,7 +15,7 @@ module Spree
               else
                 render_error(
                   code: Spree::Api::V3::ErrorHandler::ERROR_CODES[:validation_error],
-                  message: Spree.t('company_invitations.not_pending'),
+                  message: I18n.t('spree.company_invitations.not_pending'),
                   status: :unprocessable_content
                 )
               end
@@ -38,10 +38,6 @@ module Spree
             def scope
               action_name == 'index' ? @parent.invitations.pending : @parent.invitations
             end
-
-            def parent_association
-              :invitations
-            end
           end
         end
       end

data/app/controllers/spree/api/v3/store/company_invitations_controller.rb

@@ -52,7 +52,7 @@ module Spree
             else
               render_error(
                 code: Spree::Api::V3::ErrorHandler::ERROR_CODES[:validation_error],
-                message: Spree.t('company_invitations.not_pending'),
+                message: I18n.t('spree.company_invitations.not_pending'),
                 status: :unprocessable_content
               )
             end

data/app/controllers/spree/api/v3/store/customer/addresses_controller.rb

@@ -49,10 +49,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :addresses
-            end
-
             def model_class
               Spree::Address
             end

data/app/controllers/spree/api/v3/store/customer/credit_cards_controller.rb

@@ -12,10 +12,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :credit_cards
-            end
-
             # Customers are global; a saved card belongs to the store-scoped
             # payment method it was created against, so the nested collection is
             # bound to the current store's payment methods.

data/app/controllers/spree/api/v3/store/customer/data_requests_controller.rb

@@ -46,10 +46,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :data_requests
-            end
-
             # A person sees their own requests and no one else's. The store
             # narrowing is restated because the parent branch of the base scope
             # replaces `for_store` with the association, and a customer is
@@ -69,7 +65,6 @@ module Spree
             def erasure?
               params[:kind].to_s == Spree::DataRequest::ERASURE
             end
-
           end
         end
       end

data/app/controllers/spree/api/v3/store/customer/digital_links_controller.rb

@@ -23,10 +23,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :digital_links
-            end
-
             # The `digital_links` association reaches links through orders and
             # line items, so it carries a DISTINCT and inherits an ORDER BY on
             # the line items' table. PostgreSQL rejects DISTINCT combined with

data/app/controllers/spree/api/v3/store/customer/gift_cards_controller.rb

@@ -12,10 +12,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :gift_cards
-            end
-
             def model_class
               Spree::GiftCard
             end

data/app/controllers/spree/api/v3/store/customer/orders_controller.rb

@@ -20,10 +20,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :orders
-            end
-
             def scope
               super.for_store(current_store).complete
             end

data/app/controllers/spree/api/v3/store/customer/password_resets_controller.rb

@@ -32,14 +32,16 @@ module Spree
               user = Spree.customer_class.find_by(email: params[:email])
 
               if user
-                token = user.generate_token_for(:password_reset)
-                event_payload = { reset_token: token, email: user.email, store_id: current_store.prefixed_id }
-                event_payload[:redirect_url] = redirect_url if redirect_url.present?
-                user.publish_event('customer.password_reset_requested', event_payload)
+                event_name = 'customer.password_reset_requested'
+                payload = user.event_payload_for(
+                  event_name,
+                  reset_token: user.generate_token_for(:password_reset), store: current_store, redirect_url: redirect_url.presence
+                )
+                user.publish_event(event_name, payload)
               end
 
               # Always return 202 to prevent email enumeration
-              render json: { message: Spree.t(:password_reset_requested, scope: :api) }, status: :accepted
+              render json: { message: I18n.t('spree.api.password_reset_requested') }, status: :accepted
             end
 
             # PATCH /api/v3/store/password_resets/:id
@@ -49,7 +51,7 @@ module Spree
               unless user
                 return render_error(
                   code: ERROR_CODES[:password_reset_token_invalid],
-                  message: Spree.t(:password_reset_token_invalid, scope: :api),
+                  message: I18n.t('spree.api.password_reset_token_invalid'),
                   status: :unprocessable_content
                 )
               end

data/app/controllers/spree/api/v3/store/customer/payment_setup_sessions_controller.rb

@@ -50,10 +50,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :payment_setup_sessions
-            end
-
             def model_class
               Spree::PaymentSetupSession
             end

data/app/controllers/spree/api/v3/store/customer/store_credits_controller.rb

@@ -12,10 +12,6 @@ module Spree
               @parent = current_user
             end
 
-            def parent_association
-              :store_credits
-            end
-
             def scope
               super.for_store(current_store).where(currency: current_currency)
             end
@@ -27,7 +23,6 @@ module Spree
             def serializer_class
               Spree.api.store_credit_serializer
             end
-
           end
         end
       end

data/app/controllers/spree/api/v3/store/data_request_downloads_controller.rb

@@ -30,7 +30,7 @@ module Spree
             unless data_request&.downloadable?
               return render_error(
                 code: 'data_request_expired',
-                message: Spree.t('data_request_errors.download_unavailable'),
+                message: I18n.t('spree.data_request_errors.download_unavailable'),
                 status: :forbidden
               )
             end

data/app/controllers/spree/api/v3/store/delivery_methods_controller.rb

@@ -26,7 +26,7 @@ module Spree
           def pickup_points
             provider = find_resource.pickup_point_provider_instance
             if provider.nil?
-              return render_error(code: ERROR_CODES[:record_not_found], message: Spree.t('errors.messages.no_pickup_point_provider'), status: :not_found)
+              return render_error(code: ERROR_CODES[:record_not_found], message: I18n.t('spree.errors.messages.no_pickup_point_provider'), status: :not_found)
             end
 
             latitude = params[:latitude].presence&.to_f

data/app/controllers/spree/api/v3/store/newsletter_subscribers_controller.rb

@@ -43,7 +43,7 @@ module Spree
             unless subscriber
               return render_error(
                 code: ERROR_CODES[:invalid_token],
-                message: Spree.t(:newsletter_verification_token_invalid, scope: :api),
+                message: I18n.t('spree.api.newsletter_verification_token_invalid'),
                 status: :unprocessable_content
               )
             end
@@ -64,7 +64,7 @@ module Spree
             if subscriber.blank?
               return render_error(
                 code: ERROR_CODES[:invalid_token],
-                message: Spree.t(:newsletter_unsubscribe_token_invalid, scope: :api),
+                message: I18n.t('spree.api.newsletter_unsubscribe_token_invalid'),
                 status: :unprocessable_content
               )
             end
@@ -87,18 +87,9 @@ module Spree
             subscriber = Spree::NewsletterSubscriber.for_store(current_store).find_by(email: params[:email])
 
             if subscriber
-              payload = {
-                id: subscriber.prefixed_id,
-                email: subscriber.email,
-                unsubscribe_token: subscriber.generate_token_for(:unsubscribe),
-                store_id: current_store.prefixed_id,
-                customer_id: subscriber.customer&.prefixed_id
-              }
-
-              redirect_url = validated_redirect_url
-              payload[:redirect_url] = redirect_url if redirect_url.present?
-
-              subscriber.publish_event('newsletter_subscriber.unsubscribe_requested', payload)
+              event_name = 'newsletter_subscriber.unsubscribe_requested'
+              payload = subscriber.event_payload_for(event_name, store: current_store, redirect_url: validated_redirect_url.presence)
+              subscriber.publish_event(event_name, payload)
             end
 
             head :accepted

data/app/controllers/spree/api/v3/store/orders/claims_controller.rb

@@ -18,11 +18,7 @@ module Spree
                 memo: create_params[:memo]
               )
 
-              if result.success?
-                render json: serialize_resource(result.value), status: :created
-              else
-                render_result_error(result)
-              end
+              render_result(result, status: :created)
             end
 
             protected

data/app/controllers/spree/api/v3/store/orders/returns_controller.rb

@@ -37,11 +37,7 @@ module Spree
                 memo: create_params[:memo]
               )
 
-              if result.success?
-                render json: serialize_resource(result.value), status: :created
-              else
-                render_result_error(result)
-              end
+              render_result(result, status: :created)
             end
 
             protected

data/app/controllers/spree/api/v3/store/wishlist_items_controller.rb

@@ -16,10 +16,6 @@ module Spree
             authorize_storefront_write!(@parent)
           end
 
-          def parent_association
-            :wishlist_items
-          end
-
           def model_class
             Spree::WishlistItem
           end

data/app/serializers/spree/api/v3/admin/address_serializer.rb

@@ -24,18 +24,16 @@ module Spree
             address.longitude&.to_f
           end
 
-          attribute :customer_id do |address|
-            address.customer_owner&.prefixed_id
-          end
+          prefixed_id_attributes customer_id: :customer_owner
 
           # Who the row belongs to — a customer's book, a company node's, or a
           # seller's billing address. `customer_id` above stays as the
           # customer-only shorthand the customers surface reads.
-          attribute :owner_id do |address|
-            address.owner&.prefixed_id
-          end
+          prefixed_id_attributes :owner
 
-          attributes :owner_type
+          attribute :owner_type do |address|
+            Spree::Base.polymorphic_api_type(address.owner_type)
+          end
         end
       end
     end

data/app/serializers/spree/api/v3/admin/api_key_serializer.rb

@@ -27,17 +27,13 @@ module Spree
                      created_at: :iso8601, updated_at: :iso8601,
                      revoked_at: :iso8601, last_used_at: :iso8601
 
-          attribute :channel_id do |key|
-            key.channel&.prefixed_id
-          end
+          prefixed_id_attributes :channel
 
           # Returned only on the create response — `plaintext_token` is held in
           # memory on the model after `generate_token` and is never persisted
           # for secret keys, so we serialize it whenever it's available rather
           # than gating on the action.
-          attribute :plaintext_token do |key|
-            key.plaintext_token
-          end
+          attributes :plaintext_token
 
           # A key can be minted by another key, which has no email — so the
           # address is answered only for the actors that have one, and

data/app/serializers/spree/api/v3/admin/catalog_assignment_serializer.rb

@@ -18,9 +18,7 @@ module Spree
             assignment.assignable_type.demodulize.underscore
           end
 
-          attribute :assignable_id do |assignment|
-            assignment.assignable&.prefixed_id
-          end
+          prefixed_id_attributes :assignable
 
           attribute :assignable_name do |assignment|
             assignment.assignable.try(:name)

data/app/serializers/spree/api/v3/admin/catalog_order_minimum_serializer.rb

@@ -9,13 +9,7 @@ module Spree
 
           attributes :currency, created_at: :iso8601, updated_at: :iso8601
 
-          attribute :amount do |minimum|
-            minimum.amount.to_s
-          end
-
-          attribute :display_amount do |minimum|
-            minimum.display_amount.to_s
-          end
+          attributes amount: :string, display_amount: :string
         end
       end
     end

data/app/serializers/spree/api/v3/admin/catalog_product_term_serializer.rb

@@ -28,9 +28,7 @@ module Spree
           # True when the product's variants carry different terms, so the
           # editor shows "mixed" rather than claiming one variant's pair is
           # the product's.
-          attribute :mixed do |term|
-            term.mixed?
-          end
+          attribute :mixed, &:mixed?
         end
       end
     end

data/app/serializers/spree/api/v3/admin/catalog_quantity_rule_serializer.rb

@@ -15,9 +15,7 @@ module Spree
           attributes :minimum_order_quantity, :order_multiple,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :variant_id do |rule|
-            rule.variant&.prefixed_id
-          end
+          prefixed_id_attributes :variant
 
           attribute :variant_sku do |rule|
             rule.variant&.sku

data/app/serializers/spree/api/v3/admin/channel_serializer.rb

@@ -4,17 +4,18 @@ module Spree
       module Admin
         class ChannelSerializer < V3::ChannelSerializer
           typelize store_id: :string,
-                   preferred_order_routing_strategy: [:string, nullable: true],
+                   preferred_order_routing_strategy: [:string, nullable: true, comment: 'Order routing strategy; null inherits the store setting. Built-in: rules. Extensions may register more.'],
                    preferred_storefront_access: [:string, nullable: true],
                    preferred_guest_checkout: [:boolean, nullable: true],
                    stock_location_ids: [:string, multi: true],
                    default_catalog_id: [:string, nullable: true]
 
-          attributes :preferred_order_routing_strategy,
-                     :preferred_storefront_access,
+          attributes :preferred_storefront_access,
                      :preferred_guest_checkout,
                      created_at: :iso8601, updated_at: :iso8601
 
+          api_type_attributes :preferred_order_routing_strategy
+
           # Fulfillment-origin allowlist; empty means every store location
           # serves this channel.
           attribute :stock_location_ids do |record|
@@ -23,9 +24,7 @@ module Spree
 
           # When set, only the default catalog's products are visible on this
           # channel; unset means every publication.
-          attribute :default_catalog_id do |record|
-            record.default_catalog&.prefixed_id
-          end
+          prefixed_id_attributes :default_catalog
         end
       end
     end

data/app/serializers/spree/api/v3/admin/claim_reason_serializer.rb

@@ -11,9 +11,7 @@ module Spree
 
           # Lets the dashboard hide destructive controls instead of offering a
           # delete that the model will refuse.
-          attribute :can_be_deleted do |reason|
-            reason.can_be_deleted?
-          end
+          attribute :can_be_deleted, &:can_be_deleted?
         end
       end
     end