spree_api 4.3.0.rc1 → 4.4.0.rc1

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/resource_serializer_concern.rb

@@ -5,10 +5,28 @@ module Spree
         extend ActiveSupport::Concern
 
         def self.included(base)
-          model_klazz = "Spree::#{base.to_s.demodulize.gsub(/Serializer/, '')}".constantize
+          serializer_base_name = base.to_s.sub(/^Spree::Api::V2::Platform::/, '').sub(/Serializer$/, '')
+          model_klazz = "Spree::#{serializer_base_name}".constantize
 
           base.set_type model_klazz.json_api_type
+          # include standard attributes
           base.attributes(*model_klazz.json_api_columns)
+          # include money attributes
+          display_getter_methods(model_klazz).each do |method_name|
+            base.attribute(method_name) do |object|
+              object.public_send(method_name).to_s
+            end
+          end
+        end
+
+        def self.display_getter_methods(model_klazz)
+          model_klazz.new.methods.find_all do |method_name|
+            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
+
+            method_name
+          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,18 +7,25 @@ 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
 
           params_cache_key = params.map do |param|
-            next if param.nil? || param.last.nil?
+            value = param.last
+            next if param.nil? || value.nil?
 
-            if param.last.respond_to?(:cache_key_with_version)
-              param.last.cache_key_with_version
+            if value.respond_to?(:cache_key_with_version)
+              value.cache_key_with_version
+            elsif value.is_a?(Hash)
+              # covers the current_price_options cases:
+              #     { price_options: { tax_zone: Spree::Zone... } } or
+              #     { price_options: { tax_zone: nil } }
+              only_key = value.keys.first
+              value[only_key]&.cache_key_with_version
             else
-              param.last.to_s.downcase
+              value.to_s.downcase
             end
           end.compact.reject(&:blank?).join('-')
 

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class AddressSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           belongs_to :country
           belongs_to :state

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

@@ -0,0 +1,20 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AdjustmentSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :adjustable, polymorphic: true
+          belongs_to :source, polymorphic: {
+            Spree::Promotion::Actions::FreeShipping => :promotion_action,
+            Spree::Promotion::Actions::CreateAdjustment => :promotion_action,
+            Spree::Promotion::Actions::CreateItemAdjustments => :promotion_action,
+            Spree::Promotion::Actions::CreateLineItems => :promotion_action
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AssetSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :viewable, polymorphic: true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CalculatorSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          attributes :type
+
+          attribute :preferences do |calculator|
+            calculator.preferences
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class ClassificationSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           belongs_to :product
           belongs_to :taxon

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

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

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

@@ -3,7 +3,14 @@ module Spree
     module V2
       module Platform
         class CmsSectionSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
+
+          belongs_to :cms_page, serializer: :cms_page
+          belongs_to :linked_resource, polymorphic: {
+            Spree::Cms::Pages::StandardPage => :cms_page,
+            Spree::Cms::Pages::FeaturePage => :cms_page,
+            Spree::Cms::Pages::Homepage => :cms_page
+          }
         end
       end
     end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class CountrySerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           has_many :states
         end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CreditCardSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :payment_method
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CustomerReturnSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :stock_location
+
+          has_many :reimbursements
+          has_many :return_items
+          has_many :return_authorizations
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalLinkSerializer < BaseSerializer
+          set_type :digital_link
+
+          attributes :token, :access_counter
+
+          belongs_to :digital
+          belongs_to :line_item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalSerializer < BaseSerializer
+          set_type :digital
+
+          attribute :url do |digital|
+            url_helpers = Rails.application.routes.url_helpers
+            url_helpers.polymorphic_url(digital.attachment, only_path: true)
+          end
+
+          attribute :content_type do |digital|
+            digital.attachment.content_type.to_s
+          end
+
+          attribute :filename do |digital|
+            digital.attachment.filename.to_s
+          end
+
+          attribute :byte_size do |digital|
+            digital.attachment.byte_size.to_i
+          end
+
+          belongs_to :variant
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class FeaturePageSerializer < CmsPageSerializer
+          # Place holder serializer for Webhooks.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class HomepageSerializer < CmsPageSerializer
+          # Place holder serializer for Webhooks.
+        end
+      end
+    end
+  end
+end

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/inventory_unit_serializer.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class InventoryUnitSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :variant
+          belongs_to :shipment
+          has_many :return_items
+          has_many :return_authorizations
+          belongs_to :line_item
+          belongs_to :original_return_item, serializer: :return_item, type: :return_item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class LineItemSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :tax_category
+          belongs_to :variant
+
+          has_many :adjustments
+          has_many :inventory_units
+          has_many :digital_links
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class LogEntrySerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :source, polymorphic: true
+        end
+      end
+    end
+  end
+end

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

@@ -3,18 +3,41 @@ module Spree
     module V2
       module Platform
         class MenuItemSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include 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/menu_serializer.rb

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class MenuSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           has_many :menu_items
         end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class OptionTypeSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           has_many :option_values
         end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class OptionValueSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           belongs_to :option_type
         end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class OrderPromotionSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :promotion
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class OrderSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :user
+          belongs_to :created_by, serializer: Dependencies.platform_admin_user_serializer.constantize
+          belongs_to :approver, serializer: Dependencies.platform_admin_user_serializer.constantize
+          belongs_to :canceler, serializer: Dependencies.platform_admin_user_serializer.constantize
+
+          belongs_to :bill_address, serializer: AddressSerializer
+          belongs_to :ship_address, serializer: AddressSerializer
+
+          has_many :line_items
+          has_many :payments
+          has_many :shipments
+
+          has_many :state_changes
+          has_many :return_authorizations
+          has_many :reimbursements
+          has_many :adjustments
+          has_many :all_adjustments, serializer: :adjustments, type: :adjustment
+
+          has_many :order_promotions
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PaymentCaptureEventSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :payment
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PaymentMethodSerializer < BaseSerializer
+          attributes :name, :type, :description, :active, :display_on, :auto_capture, :position,
+                     :created_at, :updated_at, :deleted_at, :public_metadata, :private_metadata
+
+          attribute :preferences do |payment_method|
+            payment_method.preferences
+          end
+
+          has_many :stores
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PaymentSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :payment_method
+          belongs_to :source, polymorphic: true
+
+          has_many :log_entries
+          has_many :state_changes
+          has_many :payment_capture_events, object_method_name: :capture_events,
+                                            id_method_name: :capture_event_ids
+          has_many :refunds
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PriceSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          attribute :display_price_including_vat_for do |price, params|
+            price.display_price_including_vat_for(params[:price_options].presence || {}).to_s
+          end
+
+          attribute :display_compare_at_price_including_vat_for do |price, params|
+            price.display_compare_at_price_including_vat_for(params[:price_options].presence || {}).to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class ProductPropertySerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
         end
       end
     end

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

@@ -3,8 +3,8 @@ module Spree
     module V2
       module Platform
         class ProductSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
-          include ::Spree::Api::V2::DisplayMoneyHelper
+          include ResourceSerializerConcern
+          include DisplayMoneyHelper
 
           attribute :purchasable do |product|
             product.purchasable?
@@ -44,23 +44,27 @@ 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|
-            object.taxons_for_store(params[:store])
+          has_many :taxons, serializer: :taxon, record_type: :taxon do |object, params|
+            if params[:store].present?
+              object.taxons_for_store(params[:store])
+            else
+              object.taxons
+            end
           end
 
           has_many :images,