spree_api 4.3.0.rc1 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 381bcae626a5cfcc30444d47853c1bc26063befbc5c18db328276d8c1998c309
-  data.tar.gz: 01fc310be446eff60debb73a6da32a1b4e548dcd2ec7e7fca562ef7fada5a248
+  metadata.gz: ebccfdea767ae857de3ace38671f8e7ab7e30d3b9f5eb61ee43ef02b317ddf85
+  data.tar.gz: f483c076187833ce9c64c28a068cc7c2399aa076c9239ee1494b9b78fca002f2
 SHA512:
-  metadata.gz: 03c6087202462b6ff19e3cc1b081a175e3db9273ce486b321c27aa44e4ae82a57c9b73b24894f788c1335584e0cfcf7b94733844f3875d8f4ff67be59ba04acb
-  data.tar.gz: 24ae9980e17d37c7963cdbd7fb1e9ab6a02ef099e7763b83bf8276d9ea8e296ee49e4a3b4c42587a3b02010151f450478c0c376f6c835f8db4e6536fbc33d0fa
+  metadata.gz: 440f825585fb1ca9c66584aa773bbcd38f54b9f29b7c49813e63bd64ec5860ad400160385003b4dc25a9135d13a00fc33ad446e2125dbe4b2eadacc88288975a
+  data.tar.gz: 627bcf3c7ab826dc4bfd35b3391a3d3a3a016e2ad1283debde518157a052118e1a767ea46fdf92cad31b98d5d9d2a1adf9addd5697d3c7228b9b420f9d3c5b23

data/app/controllers/concerns/spree/api/v2/caching.rb

@@ -0,0 +1,33 @@
+module Spree
+  module Api
+    module V2
+      module Caching
+        extend ActiveSupport::Concern
+
+        def collection_cache_key(collection)
+          unscoped_collection = collection.unscope(:includes).unscope(:order)
+          cache_key_parts = [
+            self.class.to_s,
+            unscoped_collection.maximum(:updated_at),
+            unscoped_collection.ids,
+            resource_includes,
+            sparse_fields,
+            serializer_params,
+            params[:sort]&.strip,
+            params[:page]&.to_s&.strip,
+            params[:per_page]&.to_s&.strip,
+          ].flatten.join('-')
+
+          Digest::MD5.hexdigest(cache_key_parts)
+        end
+
+        def collection_cache_opts
+          {
+            namespace: Spree::Api::Config[:api_v2_collection_cache_namespace],
+            expires_in: Spree::Api::Config[:api_v2_collection_cache_ttl],
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -132,7 +132,9 @@ module Spree
             currency: current_currency,
             locale: current_locale,
             store: current_store,
-            user: spree_current_user
+            user: spree_current_user,
+            image_transformation: params[:image_transformation],
+            taxon_image_transformation: params[:taxon_image_transformation]
           }
         end
 

data/app/controllers/spree/api/v2/platform/menu_items_controller.rb

@@ -8,7 +8,7 @@ module Spree
           def reposition
             spree_authorize! :update, @moved_item if spree_current_user.present?
 
-            @moved_item = scope.find(params[:moved_item_id])
+            @moved_item = scope.find(params[:id])
             @new_parent = scope.find(params[:new_parent_id])
             new_index = params[:new_position_idx].to_i
 
@@ -19,7 +19,7 @@ module Spree
             end
 
             if @moved_item.save
-              head :no_content
+              render_serialized_payload { serialize_resource(resource) }
             end
           end
 

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

@@ -12,6 +12,10 @@ module Spree
           def scope_includes
             [:menu_items]
           end
+
+          def scope
+            current_store.menus
+          end
         end
       end
     end

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

@@ -14,6 +14,18 @@ module Spree
           def scope_includes
             product_list_includes
           end
+
+          def allowed_sort_attributes
+            super << :available_on
+          end
+
+          def sorted_collection
+            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
+          end
+
+          def collection_sorter
+            Spree::Api::Dependencies.platform_products_sorter.constantize
+          end
         end
       end
     end

data/app/controllers/spree/api/v2/platform/resource_controller.rb

@@ -18,6 +18,8 @@ module Spree
           def create
             resource = model_class.new(permitted_resource_params)
 
+            ensure_current_store(resource)
+
             if resource.save
               render_serialized_payload(201) { serialize_resource(resource) }
             else
@@ -27,6 +29,7 @@ module Spree
 
           def update
             if resource.update(permitted_resource_params)
+              ensure_current_store(resource)
               render_serialized_payload { serialize_resource(resource) }
             else
               render_error_payload(resource.errors)

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

@@ -3,9 +3,14 @@ module Spree
     module V2
       class ResourceController < ::Spree::Api::V2::BaseController
         include Spree::Api::V2::CollectionOptionsHelpers
+        include Spree::Api::V2::Caching
 
         def index
-          render_serialized_payload { serialize_collection(paginated_collection) }
+          render_serialized_payload do
+            Rails.cache.fetch(collection_cache_key(paginated_collection), collection_cache_opts) do
+              serialize_collection(paginated_collection)
+            end
+          end
         end
 
         def show

data/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb

@@ -4,6 +4,8 @@ module Spree
       module Storefront
         module Account
           class AddressesController < ::Spree::Api::V2::ResourceController
+            include Spree::BaseHelper
+
             before_action :require_spree_current_user
 
             def create
@@ -37,7 +39,7 @@ module Spree
             end
 
             def scope
-              super.where(user: spree_current_user).not_deleted
+              super.where(user: spree_current_user, country: available_countries).not_deleted
             end
 
             def model_class

data/app/controllers/spree/api/v2/storefront/account/orders_controller.rb

@@ -38,6 +38,10 @@ module Spree
             def resource_finder
               Spree::Api::Dependencies.storefront_completed_order_finder.constantize
             end
+
+            def model_class
+              Spree::Order
+            end
           end
         end
       end

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

@@ -4,8 +4,10 @@ module Spree
       module Storefront
         class CartController < ::Spree::Api::V2::BaseController
           include Spree::Api::V2::Storefront::OrderConcern
-          before_action :ensure_order, except: :create
+          before_action :ensure_order, except: %i[create associate]
           before_action :load_variant, only: :add_item
+          before_action :require_spree_current_user, only: :associate
+
 
           def create
             spree_authorize! :create, Spree::Order
@@ -128,6 +130,34 @@ module Spree
             end
           end
 
+          def associate
+            guest_order_token = params[:guest_order_token]
+            guest_order = ::Spree::Api::Dependencies.storefront_current_order_finder.constantize.new.execute(
+              store: current_store,
+              user: nil,
+              token: guest_order_token,
+              currency: current_currency
+            )
+
+            spree_authorize! :update, guest_order, guest_order_token
+
+            result = associate_service.call(guest_order: guest_order, user: spree_current_user)
+
+            if result.success?
+              render_serialized_payload { serialize_resource(guest_order) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          def change_currency
+            spree_authorize! :update, spree_current_order, order_token
+
+            result = change_currency_service.call(order: spree_current_order, new_currency: params[:new_currency])
+
+            render_order(result)
+          end
+
           private
 
           def resource_serializer
@@ -166,6 +196,14 @@ module Spree
             Spree::Api::Dependencies.storefront_cart_estimate_shipping_rates_service.constantize
           end
 
+          def associate_service
+            Spree::Api::Dependencies.storefront_cart_associate_service.constantize
+          end
+
+          def change_currency_service
+            Spree::Api::Dependencies.storefront_cart_change_currency_service.constantize
+          end
+
           def line_item
             @line_item ||= spree_current_order.line_items.find(params[:line_item_id])
           end

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

@@ -3,6 +3,8 @@ module Spree
     module V2
       module Storefront
         class CountriesController < ::Spree::Api::V2::ResourceController
+          before_action :set_default_per_page
+
           private
 
           def serialize_collection(collection)
@@ -43,6 +45,11 @@ module Spree
           def model_class
             Spree::Country
           end
+
+          # by default we want to return all countries on a single page
+          def set_default_per_page
+            params[:per_page] ||= Spree::Country.count
+          end
         end
       end
     end

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

@@ -42,6 +42,18 @@ module Spree
           def scope_includes
             product_list_includes
           end
+
+          def allowed_sort_attributes
+            super << :available_on
+          end
+
+          def collection_meta(collection)
+            super(collection).merge(filters: filters_meta)
+          end
+
+          def filters_meta
+            Spree::Api::Products::FiltersPresenter.new(current_store, current_currency, params).to_h
+          end
         end
       end
     end

data/app/models/spree/api_configuration.rb

@@ -1,8 +1,10 @@
 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_serializers_cache_ttl, :integer, default: 3600 # 1 hour in seconds
+    preference :api_v2_collection_cache_ttl, :integer, default: 3600 # 1 hour in seconds
+    preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'
     preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
-    preference :api_v2_per_page_limit, :integer, default: 100
+    preference :api_v2_per_page_limit, :integer, default: 500
   end
 end

data/app/models/spree/api_dependencies.rb

@@ -14,12 +14,13 @@ module Spree
       :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_taxon_finder, :storefront_find_by_variant_finder, :storefront_cart_update_service, :storefront_cart_associate_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_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
+      :storefront_cart_empty_service, :storefront_cart_destroy_service, :storefront_credit_cards_destroy_service, :platform_products_sorter,
+      :storefront_cart_change_currency_service
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -43,6 +44,8 @@ module Spree
       @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
+      @storefront_cart_associate_service = Spree::Dependencies.cart_associate_service
+      @storefront_cart_change_currency_service = Spree::Dependencies.cart_change_currency_service
 
       # coupon code handler
       @storefront_coupon_handler = Spree::Dependencies.coupon_handler
@@ -85,6 +88,7 @@ module Spree
       @storefront_collection_sorter = Spree::Dependencies.collection_sorter
       @storefront_order_sorter = Spree::Dependencies.collection_sorter
       @storefront_products_sorter = Spree::Dependencies.products_sorter
+      @platform_products_sorter = Spree::Dependencies.products_sorter
 
       # paginators
       @storefront_collection_paginator = Spree::Dependencies.collection_paginator

data/app/presenters/spree/api/products/filters_presenter.rb

@@ -0,0 +1,39 @@
+module Spree
+  module Api
+    module Products
+      class FiltersPresenter
+        def initialize(current_store, current_currency, params)
+          @products_for_filters = find_products_for_filters(current_store, current_currency, params)
+        end
+
+        def to_h
+          option_values = Spree::OptionValues::FindAvailable.new(products_scope: products_for_filters).execute
+          option_values_presenters = Spree::Filters::OptionsPresenter.new(option_values_scope: option_values).to_a
+          product_properties = Spree::ProductProperties::FindAvailable.new(products_scope: products_for_filters).execute
+          product_properties_presenters = Spree::Filters::PropertiesPresenter.new(product_properties_scope: product_properties).to_a
+          {
+            option_types: option_values_presenters.map(&:to_h),
+            product_properties: product_properties_presenters.map(&:to_h)
+          }
+        end
+
+        private
+
+        attr_reader :products_for_filters
+
+        def find_products_for_filters(current_store, current_currency, params)
+          current_taxons = find_current_taxons(current_store, params)
+          current_store.products.active(current_currency).in_taxons(current_taxons)
+        end
+
+        def find_current_taxons(current_store, params)
+          taxons_param = params.dig(:filter, :taxons)
+          return nil if taxons_param.nil? || taxons_param.to_s.blank?
+
+          taxon_ids = taxons_param.to_s.split(',')
+          current_store.taxons.where(id: taxon_ids)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module ImageTransformationConcern
+        extend ActiveSupport::Concern
+
+        def self.included(base)
+          base.attribute :transformed_url do |image, params|
+            image.generate_url(size: params.dig(:image_transformation, :size))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module TaxonImageTransformationConcern
+        extend ActiveSupport::Concern
+
+        def self.included(base)
+          base.attribute :transformed_url do |image, params|
+            image.generate_url(size: params.dig(:taxon_image_transformation, :size))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Spree
         # 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])
+        cache_options(store: Rails.cache, namespace: 'jsonapi-serializer', expires_in: Spree::Api::Config[:api_v2_serializers_cache_ttl])
 
         def self.record_cache_options(options, fieldset, include_list, params)
           opts = options.dup

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class IconSerializer < BaseSerializer
+          set_type :icon
+
+          attribute :url do |icon|
+            url_helpers = Rails.application.routes.url_helpers
+            url_helpers.polymorphic_url(icon.attachment, only_path: true)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,9 +3,11 @@ module Spree
     module V2
       module Platform
         class ImageSerializer < BaseSerializer
+          include ::Spree::Api::V2::ImageTransformationConcern
+
           set_type :image
 
-          attributes :styles, :position, :alt, :created_at, :updated_at
+          attributes :styles, :position, :alt, :created_at, :updated_at, :original_url
 
           belongs_to :viewable, polymorphic: true
         end

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

@@ -5,16 +5,39 @@ module Spree
         class MenuItemSerializer < BaseSerializer
           include ::Spree::Api::V2::ResourceSerializerConcern
 
-          has_one :image,
+          attributes :link
+
+          attribute :is_container do |menu_item|
+            menu_item.container?
+          end
+
+          attribute :is_root do |menu_item|
+            menu_item.root?
+          end
+
+          attribute :is_child do |menu_item|
+            menu_item.child?
+          end
+
+          attribute :is_leaf do |menu_item|
+            menu_item.leaf?
+          end
+
+          has_one :icon,
                   object_method_name: :icon,
                   id_method_name: :icon_id,
-                  record_type: :image,
-                  serializer: :image
+                  record_type: :icon,
+                  serializer: :icon
 
           belongs_to :menu, serializer: :menu
           belongs_to :parent, record_type: :menu_item, serializer: :menu_item
-          belongs_to :linked_resource, polymorphic: true
-          has_many   :children, record_type: :menu_item, serializer: :menu_item
+          belongs_to :linked_resource, polymorphic: {
+            Spree::Cms::Pages::StandardPage => :cms_page,
+            Spree::Cms::Pages::FeaturePage => :cms_page,
+            Spree::Cms::Pages::Homepage => :cms_page
+          }
+
+          has_many :children, record_type: :menu_item, serializer: :menu_item
         end
       end
     end

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

@@ -44,22 +44,22 @@ module Spree
 
           belongs_to :tax_category
 
-          has_one  :master_variant,
-                   object_method_name: :master,
-                   id_method_name: :master_id,
-                   record_type: :variant,
-                   serializer: :variant
+          has_one :primary_variant,
+                  object_method_name: :master,
+                  id_method_name: :master_id,
+                  record_type: :variant,
+                  serializer: :variant
 
-          has_one  :default_variant,
-                   object_method_name: :default_variant,
-                   id_method_name: :default_variant_id,
-                   record_type: :variant,
-                   serializer: :variant
+          has_one :default_variant,
+                  object_method_name: :default_variant,
+                  id_method_name: :default_variant_id,
+                  record_type: :variant,
+                  serializer: :variant
 
           has_many :variants
           has_many :option_types
           has_many :product_properties
-          has_many :taxons do |object, params|
+          has_many :taxons, serializer: :taxon, record_type: :taxon do |object, params|
             object.taxons_for_store(params[:store])
           end
 

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

@@ -3,9 +3,11 @@ module Spree
     module V2
       module Platform
         class TaxonImageSerializer < BaseSerializer
+          include ::Spree::Api::V2::TaxonImageTransformationConcern
+
           set_type :taxon_image
 
-          attributes :styles, :alt, :created_at, :updated_at
+          attributes :alt, :created_at, :updated_at, :original_url
         end
       end
     end

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

@@ -7,6 +7,18 @@ module Spree
 
           attributes :email, :created_at, :updated_at
 
+          attribute :average_order_value do |user, params|
+            price_stats(user.report_values_for(:average_order_value, params[:store]))
+          end
+
+          attribute :lifetime_value do |user, params|
+            price_stats(user.report_values_for(:lifetime_value, params[:store]))
+          end
+
+          attribute :store_credits do |user, params|
+            price_stats(user.available_store_credits(params[:store]))
+          end
+
           has_one :bill_address,
                   record_type: :address,
                   serializer: :address
@@ -14,6 +26,10 @@ module Spree
           has_one :ship_address,
                   record_type: :address,
                   serializer: :address
+
+          def self.price_stats(stats)
+            stats.map { |value| { currency: value.currency.to_s, amount: value.money.to_s } }
+          end
         end
       end
     end

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class IconSerializer < BaseSerializer
+        set_type :icon
+
+        attribute :url do |icon|
+          url_helpers = Rails.application.routes.url_helpers
+          url_helpers.polymorphic_url(icon.attachment, only_path: true)
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,11 @@ module Spree
   module V2
     module Storefront
       class ImageSerializer < BaseSerializer
+        include ::Spree::Api::V2::ImageTransformationConcern
+
         set_type :image
 
-        attributes :viewable_type, :viewable_id, :styles
+        attributes :styles, :position, :alt, :original_url
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Spree
       class MenuItemSerializer < BaseSerializer
         set_type :menu_item
 
-        attributes :code, :name, :subtitle, :link, :new_window, :lft, :rgt, :depth
+        attributes :code, :name, :subtitle, :link, :destination, :item_type, :new_window, :lft, :rgt, :depth
 
         attribute :is_container do |menu_item|
           menu_item.container?
@@ -22,15 +22,21 @@ module Spree
           menu_item.leaf?
         end
 
-        has_one :image,
+        has_one :icon,
                 object_method_name: :icon,
                 id_method_name: :icon_id,
-                record_type: :image,
-                serializer: :image
+                record_type: :icon,
+                serializer: :icon
 
+        belongs_to :menu, serializer: :menu
         belongs_to :parent, record_type: :menu_item, serializer: :menu_item
-        belongs_to :linked_resource, polymorphic: true
-        has_many   :children, record_type: :menu_item, serializer: :menu_item
+        belongs_to :linked_resource, polymorphic: {
+          Spree::Cms::Pages::StandardPage => :cms_page,
+          Spree::Cms::Pages::FeaturePage => :cms_page,
+          Spree::Cms::Pages::Homepage => :cms_page
+        }
+
+        has_many :children, record_type: :menu_item, serializer: :menu_item
       end
     end
   end

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

@@ -5,6 +5,10 @@ module Spree
         set_type :payment_method
 
         attributes :type, :name, :description
+
+        attribute :preferences do |object|
+          object.public_preferences.as_json
+        end
       end
     end
   end