spree_api 4.2.3 → 4.3.0.rc1

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

@@ -0,0 +1,41 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class CmsPagesController < ::Spree::Api::V2::ResourceController
+          private
+
+          def model_class
+            Spree::CmsPage
+          end
+
+          def resource
+            @resource ||= scope.find_by(slug: params[:id]) || scope.find(params[:id])
+          end
+
+          def resource_serializer
+            Spree::Api::Dependencies.storefront_cms_page_serializer.constantize
+          end
+
+          def collection_serializer
+            Spree::Api::Dependencies.storefront_cms_page_serializer.constantize
+          end
+
+          def collection_finder
+            Spree::Api::Dependencies.storefront_cms_page_finder.constantize
+          end
+
+          def scope
+            super.by_locale(I18n.locale)
+          end
+
+          def scope_includes
+            {
+              cms_sections: :linked_resource
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,27 +6,22 @@ module Spree
           private
 
           def serialize_collection(collection)
-            collection_serializer.new(collection).serializable_hash
+            collection_serializer.new(
+              collection,
+              collection_options(collection).merge(params: collection_serializer_params)
+            ).serializable_hash
           end
 
-          def serialize_resource(resource)
-            resource_serializer.new(
-              resource,
-              include: resource_includes,
-              fields: sparse_fields,
-              params: resource_serializer_params
-            ).serializable_hash
+          def serializer_params
+            super.merge(include_states: true)
           end
 
-          def resource_serializer_params
-            {
-              include_states: true,
-              current_store: current_store
-            }
+          def collection_serializer_params
+            serializer_params.merge(include_states: false)
           end
 
           def resource
-            return scope.default if params[:iso] == 'default'
+            return current_store.default_country if params[:iso] == 'default'
 
             scope.find_by(iso: params[:iso]&.upcase) ||
               scope.find_by(id: params[:iso]&.upcase) ||

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

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class MenusController < ::Spree::Api::V2::ResourceController
+          private
+
+          def resource_serializer
+            Spree::Api::Dependencies.storefront_menu_serializer.constantize
+          end
+
+          def collection_serializer
+            Spree::Api::Dependencies.storefront_menu_serializer.constantize
+          end
+
+          def collection_finder
+            Spree::Api::Dependencies.storefront_menu_finder.constantize
+          end
+
+          def model_class
+            Spree::Menu
+          end
+
+          def scope
+            super.by_locale(I18n.locale)
+          end
+
+          def scope_includes
+            { menu_items: [:children, :parent, :icon] }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Spree
           private
 
           def resource
-            resource = resource_finder.new(number: params[:number], token: order_token).execute.take
+            resource = resource_finder.new(number: params[:number], token: order_token, store: current_store).execute.take
             raise ActiveRecord::RecordNotFound if resource.nil?
 
             resource

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

@@ -3,18 +3,20 @@ module Spree
     module V2
       module Storefront
         class ProductsController < ::Spree::Api::V2::ResourceController
-          private
+          include ::Spree::Api::V2::ProductListIncludes
+
+          protected
 
           def sorted_collection
             collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
           end
 
           def collection
-            collection_finder.new(scope: scope, params: params, current_currency: current_currency).execute
+            @collection ||= collection_finder.new(scope: scope, params: finder_params).execute
           end
 
           def resource
-            scope.find_by(slug: params[:id]) || scope.find(params[:id])
+            @resource ||= scope.find_by(slug: params[:id]) || scope.find(params[:id])
           end
 
           def collection_sorter
@@ -38,15 +40,7 @@ module Spree
           end
 
           def scope_includes
-            {
-              master: :default_price,
-              variants: [],
-              variant_images: [],
-              taxons: [],
-              product_properties: :property,
-              option_types: :option_values,
-              variants_including_master: %i[default_price option_values]
-            }
+            product_list_includes
           end
         end
       end

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

@@ -10,7 +10,7 @@ module Spree
           end
 
           def resource
-            scope.find_by!(code: params[:code])
+            @resource ||= scope.find_by!(code: params[:code])
           end
 
           def resource_serializer

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

@@ -18,15 +18,11 @@ module Spree
           end
 
           def paginated_collection
-            collection_paginator.new(collection, params).call
-          end
-
-          def collection
-            collection_finder.new(scope: scope, params: params).execute
+            @paginated_collection ||= collection_paginator.new(collection, params).call
           end
 
           def resource
-            scope.find_by(permalink: params[:id]) || scope.find(params[:id])
+            @resource ||= scope.find_by(permalink: params[:id]) || scope.find(params[:id])
           end
 
           def model_class
@@ -34,16 +30,19 @@ module Spree
           end
 
           def scope_includes
-            node_includes = %i[icon products parent taxonomy]
+            node_includes = %i[icon parent taxonomy]
 
             {
               parent: node_includes,
               children: node_includes,
               taxonomy: [root: node_includes],
-              products: [],
               icon: [attachment_attachment: :blob]
             }
           end
+
+          def serializer_params
+            super.merge(include_products: action_name == 'show')
+          end
         end
       end
     end

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

@@ -13,7 +13,7 @@ module Spree
             price = find_price(product_or_variant, currency)
             return nil if price.new_record?
 
-            format('%.2f', price.amount)
+            price.amount
           end
 
           def display_price(product_or_variant, currency)
@@ -27,7 +27,7 @@ module Spree
             price = find_price(product_or_variant, currency)
             return nil if price.new_record? || price.compare_at_amount.blank?
 
-            format('%.2f', price.compare_at_amount)
+            price.compare_at_amount
           end
 
           def display_compare_at_price(product_or_variant, currency)

data/app/models/spree/api_configuration.rb

@@ -1,6 +1,7 @@
 module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
+    preference :api_v2_cache_ttl, :integer, default: 3600 # 1 hour in seconds
     preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
     preference :api_v2_per_page_limit, :integer, default: 100
   end

data/app/models/spree/api_dependencies.rb

@@ -5,18 +5,21 @@ module Spree
     INJECTION_POINTS = [
       :storefront_cart_create_service, :storefront_cart_add_item_service, :storefront_cart_remove_line_item_service,
       :storefront_cart_remove_item_service, :storefront_cart_set_item_quantity_service, :storefront_cart_recalculate_service,
+      :storefront_cms_page_serializer, :storefront_cms_page_finder,
       :storefront_cart_update, :storefront_coupon_handler, :storefront_checkout_next_service, :storefront_checkout_advance_service,
       :storefront_checkout_update_service, :storefront_checkout_complete_service, :storefront_checkout_add_store_credit_service,
       :storefront_checkout_remove_store_credit_service, :storefront_checkout_get_shipping_rates_service,
       :storefront_cart_compare_line_items_service, :storefront_cart_serializer, :storefront_credit_card_serializer,
       :storefront_credit_card_finder, :storefront_shipment_serializer, :storefront_payment_method_serializer, :storefront_country_finder,
-      :storefront_country_serializer, :storefront_current_order_finder, :storefront_completed_order_finder, :storefront_order_sorter,
-      :storefront_collection_paginator, :storefront_user_serializer, :storefront_products_sorter, :storefront_products_finder,
-      :storefront_product_serializer, :storefront_taxon_serializer, :storefront_taxon_finder, :storefront_find_by_variant_finder,
-      :storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
+      :storefront_country_serializer, :storefront_menu_serializer, :storefront_menu_finder, :storefront_current_order_finder,
+      :storefront_completed_order_finder, :storefront_order_sorter, :storefront_collection_paginator, :storefront_user_serializer,
+      :storefront_products_sorter, :storefront_products_finder, :storefront_product_serializer, :storefront_taxon_serializer,
+      :storefront_taxon_finder, :storefront_find_by_variant_finder, :storefront_cart_update_service,
+      :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
       :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
       :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,
-      :storefront_collection_sorter, :error_handler
+      :storefront_account_create_service, :storefront_account_update_service, :storefront_collection_sorter, :error_handler,
+      :storefront_cart_empty_service, :storefront_cart_destroy_service, :storefront_credit_cards_destroy_service
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -38,6 +41,8 @@ module Spree
       @storefront_cart_set_item_quantity_service = Spree::Dependencies.cart_set_item_quantity_service
       @storefront_cart_recalculate_service = Spree::Dependencies.cart_recalculate_service
       @storefront_cart_estimate_shipping_rates_service = Spree::Dependencies.cart_estimate_shipping_rates_service
+      @storefront_cart_empty_service = Spree::Dependencies.cart_empty_service
+      @storefront_cart_destroy_service = Spree::Dependencies.cart_destroy_service
 
       # coupon code handler
       @storefront_coupon_handler = Spree::Dependencies.coupon_handler
@@ -52,14 +57,21 @@ module Spree
       @storefront_checkout_get_shipping_rates_service = Spree::Dependencies.checkout_get_shipping_rates_service
 
       # account services
+      @storefront_account_create_service = Spree::Dependencies.account_create_service
+      @storefront_account_update_service = Spree::Dependencies.account_update_service
       @storefront_account_create_address_service = Spree::Dependencies.account_create_address_service
       @storefront_account_update_address_service = Spree::Dependencies.account_update_address_service
 
+      # credit cards
+      @storefront_credit_cards_destroy_service = Spree::Dependencies.credit_cards_destroy_service
+
       # serializers
       @storefront_address_serializer = 'Spree::V2::Storefront::AddressSerializer'
       @storefront_cart_serializer = 'Spree::V2::Storefront::CartSerializer'
+      @storefront_cms_page_serializer = 'Spree::V2::Storefront::CmsPageSerializer'
       @storefront_credit_card_serializer = 'Spree::V2::Storefront::CreditCardSerializer'
       @storefront_country_serializer = 'Spree::V2::Storefront::CountrySerializer'
+      @storefront_menu_serializer = 'Spree::V2::Storefront::MenuSerializer'
       @storefront_user_serializer = 'Spree::V2::Storefront::UserSerializer'
       @storefront_shipment_serializer = 'Spree::V2::Storefront::ShipmentSerializer'
       @storefront_taxon_serializer = 'Spree::V2::Storefront::TaxonSerializer'
@@ -80,6 +92,8 @@ module Spree
       # finders
       @storefront_address_finder = Spree::Dependencies.address_finder
       @storefront_country_finder = Spree::Dependencies.country_finder
+      @storefront_cms_page_finder = Spree::Dependencies.cms_page_finder
+      @storefront_menu_finder = Spree::Dependencies.menu_finder
       @storefront_current_order_finder = Spree::Dependencies.current_order_finder
       @storefront_completed_order_finder = Spree::Dependencies.completed_order_finder
       @storefront_credit_card_finder = Spree::Dependencies.credit_card_finder

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module ResourceSerializerConcern
+        extend ActiveSupport::Concern
+
+        def self.included(base)
+          model_klazz = "Spree::#{base.to_s.demodulize.gsub(/Serializer/, '')}".constantize
+
+          base.set_type model_klazz.json_api_type
+          base.attributes(*model_klazz.json_api_columns)
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v2/base_serializer.rb

@@ -0,0 +1,32 @@
+module Spree
+  module Api
+    module V2
+      class BaseSerializer
+        include JSONAPI::Serializer
+
+        # to learn more about caching, please refer to:
+        # https://github.com/jsonapi-serializer/jsonapi-serializer#caching
+        # https://guides.rubyonrails.org/caching_with_rails.html#low-level-caching
+        cache_options(store: Rails.cache, namespace: 'jsonapi-serializer', expires_in: Spree::Api::Config[:api_v2_cache_ttl])
+
+        def self.record_cache_options(options, fieldset, include_list, params)
+          opts = options.dup
+
+          params_cache_key = params.map do |param|
+            next if param.nil? || param.last.nil?
+
+            if param.last.respond_to?(:cache_key_with_version)
+              param.last.cache_key_with_version
+            else
+              param.last.to_s.downcase
+            end
+          end.compact.reject(&:blank?).join('-')
+
+          opts[:namespace] += "-#{params_cache_key}"
+
+          super(opts, fieldset, include_list, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AddressSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          belongs_to :country
+          belongs_to :state
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class BaseSerializer < ::Spree::Api::V2::BaseSerializer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class ClassificationSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          belongs_to :product
+          belongs_to :taxon
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsPageSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          has_many :cms_sections, serializer: :cms_section
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsSectionSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CountrySerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          has_many :states
+        end
+      end
+    end
+  end
+end