spree_api 4.10.1 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d0e2b4b596dd8dc2a2e6bf43b9fa32d0915081726e475c986f0ea7df614602
-  data.tar.gz: 7558b4a01bb967603459b116afc417043a6db0ff0e573b4b6dc82dda72cdc36b
+  metadata.gz: eb6f360d4eea998196537701255d202fa7c4fa42f581cd35d649090d144deec2
+  data.tar.gz: 406e748adfadf95edfca1d9864f54d8cedbb7579c902450fcd1027d732e6dd52
 SHA512:
-  metadata.gz: 4a0374f4ff17abdeb6f2b1589db21fb8d96e37b308ce43f9da34e337a3169b76fa9eac9ac2b6e6dcb7d2377c6c95034ad75fe854ac0b2d338b9114890b3cc406
-  data.tar.gz: 21f2e7250c21f38568179ae33f5cc6c744ecebbc64598c9f43a9740a92411199f703ecd1abf39e86763e5da3199b92ee1b8e3c3f3dfb506929b0aa21d722a222
+  metadata.gz: 1c331886acf8f43404f39c3ed38a707db2b3a0c6bc944c49e27ebdf071197c1a65cce0264f94c91cad650887111a4375bdf5df06c2cd53385ed186ee39eacd01
+  data.tar.gz: 3b02f537b9f0ee46c85c4d100736cc0bad2902030cc5d8029cadde05412e320c005fb4e9ec0890ecec8b00ccf6ec03195fc79da53d51cfea119538f62206d73f

data/app/controllers/spree/api/v2/base_controller.rb

@@ -2,6 +2,7 @@ module Spree
   module Api
     module V2
       class BaseController < ActionController::API
+        include ActiveStorage::SetCurrent
         include CanCan::ControllerAdditions
         include Spree::Core::ControllerHelpers::StrongParameters
         include Spree::Core::ControllerHelpers::Store
@@ -75,11 +76,12 @@ module Spree
 
         def spree_current_user
           return nil unless doorkeeper_token
-          return @spree_current_user if @spree_current_user
+          return @spree_current_user if defined?(@spree_current_user)
 
-          doorkeeper_authorize!
-
-          @spree_current_user ||= doorkeeper_token.resource_owner
+          @spree_current_user ||= ActiveRecord::Base.connected_to(role: :writing) do
+            doorkeeper_authorize!
+            doorkeeper_token.resource_owner
+          end
         end
 
         alias try_spree_current_user spree_current_user  # for compatibility with spree_legacy_frontend
@@ -143,13 +145,13 @@ module Spree
         end
 
         def record_not_found(exception)
-          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+          Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
         end
 
         def access_denied(exception)
-          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+          Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(exception.message, 403)
         end
@@ -159,19 +161,17 @@ module Spree
         end
 
         def gateway_error(exception)
-          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+          Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
           render_error_payload(exception.message)
         end
 
         def error_during_processing(exception)
-          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+          Rails.error.report(exception, context: { user_id: spree_current_user&.id }, source: 'spree.api')
 
-          render_error_payload(result.value[:message], 400)
-        end
+          message = exception.respond_to?(:original_message) ? exception.original_message : exception.message
 
-        def error_handler
-          Spree::Api::Dependencies.error_handler.constantize
+          render_error_payload(message, 400)
         end
       end
     end

data/app/controllers/spree/api/v2/storefront/checkout_controller.rb

@@ -17,7 +17,9 @@ module Spree
           def advance
             spree_authorize! :update, spree_current_order, order_token
 
-            result = advance_service.call(order: spree_current_order)
+            check_if_quick_checkout
+
+            result = advance_service.call(order: spree_current_order, state: params[:state], shipping_method_id: params[:shipping_method_id])
 
             render_order(result)
           end
@@ -92,6 +94,23 @@ module Spree
             render_serialized_payload { serialize_payment_methods(spree_current_order.available_payment_methods) }
           end
 
+          def validate_order_for_payment
+            messages = []
+
+            if spree_current_order.present?
+              validated_order, messages = Spree::Cart::RemoveOutOfStockItems.call(order: spree_current_order).value
+              messages << Spree.t(:cart_state_changed) if !validated_order.payment? && params[:skip_state].blank?
+            end
+
+            if messages.any?
+              render_serialized_payload(422) do
+                serialized_current_order.deep_merge({ meta: { messages: messages } })
+              end
+            else
+              render_serialized_payload { serialized_current_order }
+            end
+          end
+
           private
 
           def resource_serializer
@@ -153,6 +172,10 @@ module Spree
               include: [:shipping_rates, :stock_location, :line_items]
             ).serializable_hash
           end
+
+          def check_if_quick_checkout
+            spree_current_order.ship_address&.quick_checkout = params[:quick_checkout] if params[:quick_checkout]
+          end
         end
       end
     end

data/app/helpers/spree/api/v2/store_media_serializer_images_concern.rb

@@ -6,15 +6,11 @@ module Spree
 
         included do
           def self.store_image_url_for(store, attribute_name)
-            attachment = store.send(attribute_name)&.attachment
-            return unless attachment&.attached?
+            attachment = store.send(attribute_name)
+            return unless attachment.attached?
 
             url_helpers = Rails.application.routes.url_helpers
-            if Spree.public_storage_service_name
-              url_helpers.cdn_image_url(attachment)
-            else
-              url_helpers.rails_blob_path(attachment)
-            end
+            url_helpers.cdn_image_url(attachment)
           end
 
           attribute :logo do |store|

data/app/jobs/spree/products/queue_status_changed_webhook_job.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Products
+    class QueueStatusChangedWebhookJob < Spree::BaseJob
+      queue_as Spree.queues.webhooks
+
+      def perform(product_id, event)
+        product = Spree::Product.find(product_id)
+        product.queue_webhooks_requests!("product.#{event}")
+      end
+    end
+  end
+end

data/app/models/spree/oauth_access_grant.rb

@@ -1,5 +1,5 @@
 module Spree
-  class OauthAccessGrant < Base
+  class OauthAccessGrant < Spree.base_class
     include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessGrant
 
     self.table_name = 'spree_oauth_access_grants'

data/app/models/spree/oauth_access_token.rb

@@ -1,5 +1,5 @@
 module Spree
-  class OauthAccessToken < Base
+  class OauthAccessToken < Spree.base_class
     include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken
 
     self.table_name = 'spree_oauth_access_tokens'

data/app/models/spree/oauth_application.rb

@@ -1,5 +1,5 @@
 module Spree
-  class OauthApplication < Base
+  class OauthApplication < Spree.base_class
     include ::Doorkeeper::Orm::ActiveRecord::Mixins::Application
 
     self.table_name = 'spree_oauth_applications'

data/app/models/spree/order/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/payment/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Payment < Spree::Base
+  class Payment < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/product/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Product < Spree::Base
+  class Product < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/shipment/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Shipment < Spree::Base
+  class Shipment < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/stock_item/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockItem < Spree::Base
+  class StockItem < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/stock_movement/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockMovement < Spree::Base
+  class StockMovement < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/variant/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Variant < Spree::Base
+  class Variant < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/webhooks/base.rb

@@ -4,7 +4,7 @@ module Spree
       'spree_webhooks_'
     end
 
-    class Base < Spree::Base
+    class Base < Spree.base_class
       self.abstract_class = true
     end
   end

data/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb

@@ -21,6 +21,7 @@ module Spree
 
         def self.display_getter_methods(model_klazz)
           model_klazz.new.methods.find_all do |method_name|
+            next if method_name.to_s.start_with?('display_on')
             next unless method_name.to_s.start_with?('display_')
             next if method_name.to_s.end_with?('=')
             next if [Spree::Product, Spree::Variant].include?(model_klazz) && method_name == :display_amount

data/app/serializers/spree/api/v2/platform/payment_source_serializer.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PaymentSourceSerializer < BaseSerializer
+          belongs_to :payment_method
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v2/platform/reimbursement_serializer.rb

@@ -7,6 +7,7 @@ module Spree
 
           belongs_to :order
           belongs_to :customer_return
+          belongs_to :performed_by, serializer: Spree::Api::V2::Platform::AdminUserSerializer
 
           has_many :refunds
           has_many :reimbursement_credits, object_method_name: :credits, id_method_name: :credit_ids

data/app/serializers/spree/api/v2/platform/store_serializer.rb

@@ -6,7 +6,6 @@ module Spree
           include ResourceSerializerConcern
           include StoreMediaSerializerImagesConcern
 
-          has_many :menus
           has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
         end
       end

data/app/serializers/spree/api/v2/platform/taxon_serializer.rb

@@ -7,6 +7,14 @@ module Spree
 
           attributes :pretty_name, :seo_title
 
+          attribute :description do |taxon|
+            taxon.description.to_plain_text
+          end
+
+          attribute :header_url do |taxon|
+            taxon.image.attachment&.url
+          end
+
           attribute :is_root do |taxon|
             taxon.root?
           end

data/app/serializers/spree/v2/storefront/cart_serializer.rb

@@ -10,7 +10,35 @@ module Spree
                    :display_item_total, :display_ship_total, :display_adjustment_total, :display_tax_total,
                    :promo_total, :display_promo_total, :item_count, :special_instructions, :display_total,
                    :pre_tax_item_amount, :display_pre_tax_item_amount, :pre_tax_total, :display_pre_tax_total,
-                   :shipment_state, :payment_state, :public_metadata
+                   :shipment_state, :payment_state, :public_metadata, :total_minus_store_credits, :display_total_minus_store_credits
+
+        attribute :subtotal_cents do |cart|
+          cart.display_item_total.amount_in_cents
+        end
+
+        attribute :ship_total_cents do |cart|
+          cart.display_ship_total.amount_in_cents
+        end
+
+        attribute :store_credit_total_cents do |cart|
+          cart.display_total_applied_store_credit.abs.amount_in_cents
+        end
+
+        attribute :promo_total_cents do |cart|
+          cart.display_promo_total.abs.amount_in_cents
+        end
+
+        attribute :tax_total_cents do |cart|
+          cart.display_tax_total.amount_in_cents
+        end
+
+        attribute :total_cents do |cart|
+          cart.display_total.amount_in_cents
+        end
+
+        attribute :total_minus_store_credits_cents do |cart|
+          cart.display_total_minus_store_credits.amount_in_cents
+        end
 
         has_many   :line_items
         has_many   :variants

data/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb

@@ -6,7 +6,13 @@ module Spree
 
         cache_options store: nil
 
-        attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
+        attributes :name, :selected, :cost, :tax_amount
+
+        attribute :shipping_method_id do |shipping_rate|
+          shipping_rate.shipping_method_id.to_s
+        end
+
+        belongs_to :shipping_method
 
         attribute :final_price do |shipping_rate|
           shipping_rate.cost

data/app/serializers/spree/v2/storefront/payment_serializer.rb

@@ -7,8 +7,11 @@ module Spree
         has_one :source, polymorphic: true
         has_one :payment_method
 
-        attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message,
-                   :payment_method_id, :payment_method_name, :state, :public_metadata
+        attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message, :payment_method_name, :state, :public_metadata
+
+        attribute :payment_method_id do |payment|
+          payment.payment_method_id.to_s
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/payment_source_serializer.rb

@@ -0,0 +1,10 @@
+module Spree
+  module V2
+    module Storefront
+      class PaymentSourceSerializer < BaseSerializer
+        belongs_to :payment_method
+        belongs_to :user
+      end
+    end
+  end
+end

data/app/serializers/spree/v2/storefront/product_serializer.rb

@@ -48,6 +48,9 @@ module Spree
           product.localized_slugs_for_store(params[:store])
         end
 
+        attribute :tags, &:tag_list
+        attribute :labels, &:label_list
+
         has_many :variants
         has_many :option_types
         has_many :product_properties

data/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb

@@ -5,11 +5,21 @@ module Spree
         set_type :shipping_rate
 
         attributes :name, :selected, :final_price, :display_final_price, :cost,
-                   :display_cost, :tax_amount, :display_tax_amount, :shipping_method_id
+                   :display_cost, :tax_amount, :display_tax_amount
+
+        attribute :shipping_method_id do |shipping_rate|
+          shipping_rate.shipping_method_id.to_s
+        end
+
+        belongs_to :shipping_method
 
         attribute :free do |shipping_rate|
           shipping_rate.free?
         end
+
+        attribute :final_price_cents do |shipping_rate|
+          shipping_rate.display_final_price.cents
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/store_serializer.rb

@@ -10,9 +10,6 @@ module Spree
                    :default, :supported_currencies, :facebook, :twitter, :instagram, :default_locale,
                    :customer_support_email, :description, :address, :contact_phone, :supported_locales
 
-        has_many :menus
-        has_many :cms_pages
-
         has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end
     end

data/app/serializers/spree/v2/storefront/taxon_serializer.rb

@@ -4,9 +4,21 @@ module Spree
       class TaxonSerializer < BaseSerializer
         set_type   :taxon
 
-        attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
+        attributes :name, :pretty_name, :permalink, :seo_title, :meta_title, :meta_description,
                    :meta_keywords, :left, :right, :position, :depth, :updated_at, :public_metadata
 
+        attribute :description do |taxon|
+          taxon.description.to_plain_text
+        end
+
+        attribute :has_products do |taxon|
+          taxon.active_products_with_descendants.exists?
+        end
+
+        attribute :header_url do |taxon|
+          taxon.image.attachment&.url
+        end
+
         attribute :is_root do |taxon|
           taxon.root?
         end

data/app/serializers/spree/v2/storefront/user_serializer.rb

@@ -6,6 +6,8 @@ module Spree
 
         attributes :email, :first_name, :selected_locale, :last_name, :public_metadata
 
+        attribute :tags, &:tag_list
+
         attribute :store_credits do |user|
           user.total_available_store_credit
         end
@@ -15,16 +17,16 @@ module Spree
         end
 
         has_one :default_billing_address,
-          id_method_name: :bill_address_id,
-          object_method_name: :bill_address,
-          record_type: :address,
-          serializer: :address
+                id_method_name: :bill_address_id,
+                object_method_name: :bill_address,
+                record_type: :address,
+                serializer: :address
 
         has_one :default_shipping_address,
-          id_method_name: :ship_address_id,
-          object_method_name: :ship_address,
-          record_type: :address,
-          serializer: :address
+                id_method_name: :ship_address_id,
+                object_method_name: :ship_address,
+                record_type: :address,
+                serializer: :address
       end
     end
   end

data/app/services/spree/products/queue_status_changed_webhook.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Products
+    class QueueStatusChangedWebhook
+      def self.call(ids:, event:)
+        return false if ids.blank? || event.blank?
+
+        # for ActiveJob 7.1+
+        if ActiveJob.respond_to?(:perform_all_later)
+          jobs = ids.map { |id| Spree::Products::QueueStatusChangedWebhookJob.new(id, event) }
+          ActiveJob.perform_all_later(jobs)
+        else
+          ids.each { |id| Spree::Products::QueueStatusChangedWebhookJob.perform_later(id, event) }
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -31,6 +31,7 @@ Spree::Core::Engine.add_routes do
           get :payment_methods
           get :shipping_rates
           patch :select_shipping_method
+          post :validate_order_for_payment
         end
 
         resource :account, controller: :account, only: %i[show create update]
@@ -172,14 +173,6 @@ Spree::Core::Engine.add_routes do
 
         resources :roles
 
-        # Menu API
-        resources :menus
-        resources :menu_items do
-          member do
-            patch :reposition
-          end
-        end
-
         # CMS
         resources :cms_pages
         resources :cms_sections

data/lib/spree/api/dependencies.rb

@@ -49,10 +49,10 @@ module Spree
         # serializers
         storefront_address_serializer: 'Spree::V2::Storefront::AddressSerializer',
         storefront_cart_serializer: 'Spree::V2::Storefront::CartSerializer',
-        storefront_cms_page_serializer: 'Spree::V2::Storefront::CmsPageSerializer',
+        storefront_cms_page_serializer: 'Spree::V2::Storefront::CmsPageSerializer', # LEGACY
         storefront_credit_card_serializer: 'Spree::V2::Storefront::CreditCardSerializer',
         storefront_country_serializer: 'Spree::V2::Storefront::CountrySerializer',
-        storefront_menu_serializer: 'Spree::V2::Storefront::MenuSerializer',
+        storefront_menu_serializer: 'Spree::V2::Storefront::MenuSerializer', # LEGACY
         storefront_user_serializer: 'Spree::V2::Storefront::UserSerializer',
         storefront_shipment_serializer: 'Spree::V2::Storefront::ShipmentSerializer',
         storefront_taxon_serializer: 'Spree::V2::Storefront::TaxonSerializer',
@@ -86,8 +86,6 @@ module Spree
         storefront_taxon_finder: -> { Spree::Dependencies.taxon_finder },
         storefront_variant_finder: -> { Spree::Dependencies.variant_finder },
 
-        error_handler: 'Spree::Api::ErrorHandler',
-
         # serializers
         platform_admin_user_serializer: 'Spree::Api::V2::Platform::AdminUserSerializer',
 

data/lib/spree/api/testing_support/v2/current_order.rb

@@ -18,8 +18,10 @@ shared_context 'order with a physical line item' do
 end
 
 shared_context 'order with a digital line item' do
-  let!(:digital) { create(:digital) }
-  let!(:variant_digital) { digital.variant }
+  let(:digital_shipping_method) { create(:digital_shipping_method) }
+  let(:digital_product) { create(:product, shipping_category: digital_shipping_method.shipping_categories.first) }
+  let(:variant_digital) { create(:variant, product: digital_product) }
+  let!(:digital) { create(:digital, variant: variant_digital) }
   let!(:line_item) { create(:line_item, variant: variant_digital, order: order, currency: currency) }
   let!(:headers) { headers_bearer }
 
@@ -30,8 +32,10 @@ shared_context 'order with a digital line item' do
 end
 
 shared_context 'order with a physical and digital line item' do
-  let!(:digital) { create(:digital) }
-  let!(:variant_digital) { digital.variant }
+  let(:digital_shipping_method) { create(:digital_shipping_method) }
+  let(:product_digital) { create(:product, shipping_category: digital_shipping_method.shipping_categories.first) }
+  let(:variant_digital) { create(:variant, product: product_digital) }
+  let!(:digital) { create(:digital, variant: variant_digital) }
   let!(:digital_line_item) { create(:line_item, variant: variant_digital, order: order, currency: currency) }
   let!(:physical_line_item) { create(:line_item, order: order, currency: currency) }
 
@@ -87,7 +91,8 @@ shared_examples 'returns valid cart JSON' do
     expect(json_response['data']).to have_attribute(:display_pre_tax_item_amount).with_value(order.display_pre_tax_item_amount.to_s)
     expect(json_response['data']).to have_attribute(:pre_tax_total).with_value(order.pre_tax_total.to_s)
     expect(json_response['data']).to have_attribute(:display_pre_tax_total).with_value(order.display_pre_tax_total.to_s)
-    expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)
+    expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments,
+                                                        :promotions)
   end
 end