spree_api 4.2.4 → 4.3.0.rc3

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

@@ -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_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?
+
+            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

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

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

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

@@ -0,0 +1,45 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class MenuItemSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          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: :icon,
+                  serializer: :icon
+
+          belongs_to :menu, serializer: :menu
+          belongs_to :parent, 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
+  end
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,78 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class ProductSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ::Spree::Api::V2::DisplayMoneyHelper
+
+          attribute :purchasable do |product|
+            product.purchasable?
+          end
+
+          attribute :in_stock do |product|
+            product.in_stock?
+          end
+
+          attribute :backorderable do |product|
+            product.backorderable?
+          end
+
+          attribute :available do |product|
+            product.available?
+          end
+
+          attribute :currency do |_product, params|
+            params[:currency]
+          end
+
+          attribute :price do |product, params|
+            price(product, params[:currency])
+          end
+
+          attribute :display_price do |product, params|
+            display_price(product, params[:currency])
+          end
+
+          attribute :compare_at_price do |product, params|
+            compare_at_price(product, params[:currency])
+          end
+
+          attribute :display_compare_at_price do |product, params|
+            display_compare_at_price(product, params[:currency])
+          end
+
+          belongs_to :tax_category
+
+          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_many :variants
+          has_many :option_types
+          has_many :product_properties
+          has_many :taxons, serializer: :taxon, record_type: :taxon do |object, params|
+            object.taxons_for_store(params[:store])
+          end
+
+          has_many :images,
+                   object_method_name: :variant_images,
+                   id_method_name: :variant_image_ids,
+                   record_type: :image,
+                   serializer: :image
+
+          # TODO: add stock items
+          # TODO: add prices
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class StockItemSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          set_type :stock_item
+
+          attribute :is_available do |stock_item|
+            stock_item.available?
+          end
+
+          belongs_to :stock_location
+          belongs_to :variant
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class StockLocationSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          attributes :name
+
+          has_many :shipments
+          has_many :stock_items
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class StoreSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          has_many :menus
+          has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class TaxCategorySerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          # TODO: add tax_rates
+        end
+      end
+    end
+  end
+end