spree_api 4.2.0.rc1 → 4.2.0

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

@@ -2,15 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class OrderStatusController < ::Spree::Api::V2::BaseController
+        class OrderStatusController < ::Spree::Api::V2::ResourceController
           include Spree::Api::V2::Storefront::OrderConcern
 
           before_action :ensure_order_token
 
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
           private
 
           def resource
@@ -29,7 +25,7 @@ module Spree
           end
 
           def ensure_order_token
-            raise ActiveRecord::RecordNotFound unless order_token
+            raise ActiveRecord::RecordNotFound unless order_token.present?
           end
         end
       end

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

@@ -2,21 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class ProductsController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(paginated_collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class ProductsController < ::Spree::Api::V2::ResourceController
           private
 
           def sorted_collection
-            collection_sorter.new(collection, params, current_currency).call
+            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
           end
 
           def collection
@@ -43,8 +33,8 @@ module Spree
             Spree::Api::Dependencies.storefront_product_serializer.constantize
           end
 
-          def scope
-            Spree::Product.accessible_by(current_ability, :show).includes(scope_includes)
+          def model_class
+            Spree::Product
           end
 
           def scope_includes

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

@@ -2,14 +2,10 @@ module Spree
   module Api
     module V2
       module Storefront
-        class StoresController < ::Spree::Api::V2::BaseController
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class StoresController < ::Spree::Api::V2::ResourceController
           private
 
-          def scope
+          def model_class
             Spree::Store
           end
 

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

@@ -2,17 +2,7 @@ module Spree
   module Api
     module V2
       module Storefront
-        class TaxonsController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(paginated_collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class TaxonsController < ::Spree::Api::V2::ResourceController
           private
 
           def collection_serializer
@@ -39,8 +29,8 @@ module Spree
             scope.find_by(permalink: params[:id]) || scope.find(params[:id])
           end
 
-          def scope
-            Spree::Taxon.accessible_by(current_ability, :show).includes(scope_includes)
+          def model_class
+            Spree::Taxon
           end
 
           def scope_includes

data/app/helpers/spree/api/api_helpers.rb

@@ -163,7 +163,7 @@ module Spree
         :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
         :mail_from_address, :customer_support_email, :default_currency,
         :code, :default, :facebook, :twitter, :instagram,
-        :supported_currencies
+        :supported_currencies, :default_locale, :supported_locales
       ]
 
       @@tag_attributes = [:id, :name]

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module V2
+      module DisplayMoneyHelper
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def find_price(product_or_variant, currency)
+            product_or_variant.price_in(currency)
+          end
+
+          def price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            format('%.2f', price.amount)
+          end
+
+          def display_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            Spree::Money.new(price.amount, currency: currency).to_s
+          end
+
+          def compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            format('%.2f', price.compare_at_amount)
+          end
+
+          def display_compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            Spree::Money.new(price.compare_at_amount, currency: currency).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/api_configuration.rb

@@ -2,5 +2,6 @@ module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
     preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
+    preference :api_v2_per_page_limit, :integer, default: 100
   end
 end

data/app/models/spree/api_dependencies.rb

@@ -14,8 +14,9 @@ module Spree
       :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_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder
+      :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
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -66,9 +67,11 @@ module Spree
       @storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'
       @storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'
       @storefront_store_serializer = 'Spree::V2::Storefront::StoreSerializer'
+      @storefront_order_serializer = 'Spree::V2::Storefront::CartSerializer'
 
       # sorters
-      @storefront_order_sorter = Spree::Dependencies.order_sorter
+      @storefront_collection_sorter = Spree::Dependencies.collection_sorter
+      @storefront_order_sorter = Spree::Dependencies.collection_sorter
       @storefront_products_sorter = Spree::Dependencies.products_sorter
 
       # paginators
@@ -83,6 +86,8 @@ module Spree
       @storefront_find_by_variant_finder = Spree::Dependencies.line_item_by_variant_finder
       @storefront_products_finder = Spree::Dependencies.products_finder
       @storefront_taxon_finder = Spree::Dependencies.taxon_finder
+
+      @error_handler = 'Spree::Api::ErrorHandler'
     end
   end
 end

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

@@ -7,8 +7,13 @@ module Spree
         attributes :firstname, :lastname, :address1, :address2, :city, :zipcode, :phone, :state_name,
                    :company, :country_name, :country_iso3, :country_iso, :label
 
-        attribute :state_code, &:state_abbr
-        attribute :state_name, &:state_name_text
+        attribute :state_code do |address|
+          address.state_abbr
+        end
+
+        attribute :state_name do |address|
+          address.state_name_text
+        end
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Spree
   module V2
     module Storefront
       class BaseSerializer
-        include FastJsonapi::ObjectSerializer
+        include JSONAPI::Serializer
       end
     end
   end

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

@@ -9,7 +9,8 @@ module Spree
                    :display_included_tax_total, :tax_total, :currency, :state, :token, :email,
                    :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
+                   :pre_tax_item_amount, :display_pre_tax_item_amount, :pre_tax_total, :display_pre_tax_total,
+                   :shipment_state, :payment_state
 
         has_many   :line_items
         has_many   :variants

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

@@ -12,6 +12,12 @@ module Spree
         end
 
         has_many :states, if: proc { |_record, params| params && params[:include_states] }
+
+        has_many :checkout_zone_applicable_states,
+                 serializer: ::Spree::V2::Storefront::StateSerializer,
+                 if: proc { |_record, params| params && params[:current_store].present? } do |object, params|
+          params[:current_store].states_available_for_checkout(object)
+        end
       end
     end
   end

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

@@ -6,7 +6,9 @@ module Spree
 
         attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
 
-        attribute :final_price, &:cost
+        attribute :final_price do |shipping_rate|
+          shipping_rate.cost
+        end
 
         attributes :display_cost, :display_final_price do |object, params|
           Spree::Money.new(object.cost, currency: params[:currency])

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

@@ -8,7 +8,7 @@ module Spree
         has_one :payment_method
 
         attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message,
-                   :payment_method_id, :payment_method_name
+                   :payment_method_id, :payment_method_name, :state
       end
     end
   end

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

@@ -6,8 +6,13 @@ module Spree
 
         attribute :value
 
-        attribute :name,        &:property_name
-        attribute :description, &:property_presentation
+        attribute :name do |product_property|
+          product_property.property_name
+        end
+
+        attribute :description do |product_property|
+          product_property.property_presentation
+        end
       end
     end
   end

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

@@ -2,16 +2,47 @@ module Spree
   module V2
     module Storefront
       class ProductSerializer < BaseSerializer
+        include ::Spree::Api::V2::DisplayMoneyHelper
+
         set_type :product
 
-        attributes :name, :description, :price, :currency, :display_price,
-                   :compare_at_price, :display_compare_at_price, :available_on,
-                   :slug, :meta_description, :meta_keywords, :updated_at
+        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at
+
+        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 :purchasable,   &:purchasable?
-        attribute :in_stock,      &:in_stock?
-        attribute :backorderable, &:backorderable?
-        attribute :available,     &:available?
+        attribute :display_compare_at_price do |product, params|
+          display_compare_at_price(product, params[:currency])
+        end
 
         has_many :variants
         has_many :option_types

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

@@ -7,7 +7,9 @@ module Spree
         attributes :number, :final_price, :display_final_price,
                    :state, :shipped_at, :tracking_url
 
-        attribute :free, &:free?
+        attribute :free do |shipment|
+          shipment.free?
+        end
 
         has_many :shipping_rates
 

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

@@ -7,7 +7,9 @@ module Spree
         attributes :name, :selected, :final_price, :display_final_price, :cost,
                    :display_cost, :tax_amount, :display_tax_amount, :shipping_method_id
 
-        attribute :free, &:free?
+        attribute :free do |shipping_rate|
+          shipping_rate.free?
+        end
       end
     end
   end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class StoreCreditCategorySerializer < BaseSerializer
+        set_type :store_credit_category
+
+        attributes :name
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Spree
       class StoreCreditSerializer < BaseSerializer
         set_type :store_credit
 
-        belongs_to :category
+        belongs_to :category, serializer: :store_credit_category
         has_many :store_credit_events
         belongs_to :credit_type,
                    id_method_name: :type_id,

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

@@ -6,7 +6,9 @@ module Spree
 
         attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency, :default, :supported_currencies, :facebook,
                    :twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
-                   :address, :contact_phone, :contact_email
+                   :address, :contact_phone, :supported_locales
+
+        has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end
     end
   end

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

@@ -7,9 +7,17 @@ module Spree
         attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
                    :meta_keywords, :left, :right, :position, :depth, :updated_at
 
-        attribute :is_root,  &:root?
-        attribute :is_child, &:child?
-        attribute :is_leaf,  &:leaf?
+        attribute :is_root do |taxon|
+          taxon.root?
+        end
+
+        attribute :is_child do |taxon|
+          taxon.child?
+        end
+
+        attribute :is_leaf do |taxon|
+          taxon.leaf?
+        end
 
         belongs_to :parent,   record_type: :taxon, serializer: :taxon
         belongs_to :taxonomy, record_type: :taxonomy

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

@@ -6,7 +6,9 @@ module Spree
 
         attributes :email
 
-        attribute :store_credits, &:total_available_store_credit
+        attribute :store_credits do |user|
+          user.total_available_store_credit
+        end
 
         attribute :completed_orders do |object|
           object.orders.complete.count