spree_api 4.2.3.1 → 4.3.0.rc2

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

@@ -0,0 +1,57 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class VariantSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ::Spree::Api::V2::DisplayMoneyHelper
+
+          attributes :name, :options_text, :total_on_hand
+
+          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 |object, params|
+            price(object, params[:currency])
+          end
+
+          attribute :display_price do |object, params|
+            display_price(object, params[:currency])
+          end
+
+          attribute :compare_at_price do |object, params|
+            compare_at_price(object, params[:currency])
+          end
+
+          attribute :display_compare_at_price do |object, params|
+            display_compare_at_price(object, params[:currency])
+          end
+
+          belongs_to :product
+          belongs_to :tax_category
+          has_many :images
+          has_many :option_values
+          has_many :stock_items
+          has_many :stock_locations
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,9 @@
+require 'active_support/cache'
+
 module Spree
   module V2
     module Storefront
-      class BaseSerializer
-        include JSONAPI::Serializer
+      class BaseSerializer < ::Spree::Api::V2::BaseSerializer
       end
     end
   end

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class CmsPageSerializer < BaseSerializer
+        set_type :cms_page
+
+        attributes :title, :content, :locale, :meta_description, :meta_title,
+                   :slug, :type
+
+        has_many :cms_sections, serializer: :cms_section
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Spree
+  module V2
+    module Storefront
+      class CmsSectionSerializer < BaseSerializer
+        set_type :cms_section
+
+        attributes :name, :content, :settings, :link, :fit, :type, :position
+
+        Spree::CmsSection::IMAGE_COUNT.each do |count|
+          Spree::CmsSection::IMAGE_SIZE.each do |size|
+            attribute "img_#{count}_#{size}".to_sym do |section|
+              if section.send("image_#{count}").attached? && section.send("img_#{count}_#{size}").present?
+                url_helpers = Rails.application.routes.url_helpers
+                url_helpers.rails_representation_path(section.send("img_#{count}_#{size}"), only_path: true)
+              end
+            end
+          end
+        end
+
+        attribute :is_fullscreen do |section|
+          section.fullscreen?
+        end
+
+        belongs_to :linked_resource, polymorphic: true
+      end
+    end
+  end
+end

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

@@ -7,16 +7,16 @@ module Spree
         attributes :iso, :iso3, :iso_name, :name, :states_required,
                    :zipcode_required
 
-        attribute :default do |object|
-          object.default?
+        attribute :default do |object, params|
+          object.default?(params[:store])
         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)
+                 if: proc { |_record, params| params && params[:store].present? } do |object, params|
+          params[:store].states_available_for_checkout(object)
         end
       end
     end

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

@@ -4,6 +4,8 @@ module Spree
       class EstimatedShippingRateSerializer < BaseSerializer
         set_type :shipping_rate
 
+        cache_options store: nil
+
         attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
 
         attribute :final_price do |shipping_rate|

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

@@ -0,0 +1,43 @@
+module Spree
+  module V2
+    module Storefront
+      class MenuItemSerializer < BaseSerializer
+        set_type :menu_item
+
+        attributes :code, :name, :subtitle, :link, :new_window, :lft, :rgt, :depth
+
+        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 :image,
+                object_method_name: :icon,
+                id_method_name: :icon_id,
+                record_type: :image,
+                serializer: :image
+
+        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

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

@@ -0,0 +1,13 @@
+module Spree
+  module V2
+    module Storefront
+      class MenuSerializer < BaseSerializer
+        set_type :menu
+
+        attributes :name, :location, :locale
+
+        has_many :menu_items
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Spree
       class ProductPropertySerializer < BaseSerializer
         set_type  :product_property
 
-        attribute :value
+        attribute :value, :filter_param
 
         attribute :name do |product_property|
           product_property.property_name

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

@@ -47,20 +47,29 @@ module Spree
         has_many :variants
         has_many :option_types
         has_many :product_properties
-        has_many :taxons
+
+        has_many :taxons, serializer: :taxon, record_type: :taxon do |object, params|
+          object.taxons_for_store(params[:store])
+        end
 
         # all images from all variants
         has_many :images,
-          object_method_name: :variant_images,
-          id_method_name: :variant_image_ids,
-          record_type: :image,
-          serializer: :image
-
-        has_one  :default_variant,
-          object_method_name: :default_variant,
-          id_method_name: :default_variant_id,
-          record_type: :variant,
-          serializer: :variant
+                 object_method_name: :variant_images,
+                 id_method_name: :variant_image_ids,
+                 record_type: :image,
+                 serializer: :image
+
+        has_one :default_variant,
+                object_method_name: :default_variant,
+                id_method_name: :default_variant_id,
+                record_type: :variant,
+                serializer: :variant
+
+        has_one :primary_variant,
+                object_method_name: :master,
+                id_method_name: :master_id,
+                record_type: :variant,
+                serializer: :variant
       end
     end
   end

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

@@ -8,7 +8,17 @@ module Spree
                    :twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
                    :address, :contact_phone, :supported_locales
 
+        has_many :menus
+        has_many :cms_pages
+
         has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
+
+        attribute :favicon_path do |store|
+          if store.favicon_image.attached?
+            url_helpers = Rails.application.routes.url_helpers
+            url_helpers.rails_representation_path(store.favicon, only_path: true)
+          end
+        end
       end
     end
   end

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

@@ -23,13 +23,14 @@ module Spree
         belongs_to :taxonomy, record_type: :taxonomy
 
         has_many   :children, record_type: :taxon, serializer: :taxon
-        has_many   :products, record_type: :product
+        has_many   :products, record_type: :product,
+                              if: proc { |_taxon, params| params && params[:include_products] == true }
 
         has_one    :image,
-          object_method_name: :icon,
-          id_method_name: :icon_id,
-          record_type: :taxon_image,
-          serializer: :taxon_image
+                   object_method_name: :icon,
+                   id_method_name: :icon_id,
+                   record_type: :taxon_image,
+                   serializer: :taxon_image
       end
     end
   end

data/config/initializers/doorkeeper.rb

@@ -2,6 +2,7 @@ Doorkeeper.configure do
   orm :active_record
   use_refresh_token
   api_only
+  base_controller 'ActionController::API'
 
   skip_client_authentication_for_password_grant { true } if defined?(skip_client_authentication_for_password_grant)
 
@@ -23,9 +24,15 @@ Doorkeeper.configure do
     current_spree_user&.has_spree_role?('admin') || redirect_to(routes.root_url)
   end
 
-  grant_flows %w(password)
+  grant_flows %w[password client_credentials]
+
+  allow_blank_redirect_uri true
+
+  handle_auth_errors :raise
 
   access_token_methods :from_bearer_authorization, :from_access_token_param
+
+  optional_scopes :admin, :write, :read
 end
 
 Doorkeeper::AccessGrant.class_eval do

data/config/initializers/rabl.rb

@@ -0,0 +1,9 @@
+Rabl.configure do |config|
+  config.include_json_root = false
+  config.include_child_root = false
+
+  # Motivation here it make it call as_json when rendering timestamps
+  # and therefore display miliseconds. Otherwise it would fall to
+  # JSON.dump which doesn't display the miliseconds
+  config.json_engine = ActiveSupport::JSON
+end

data/config/locales/en.yml

@@ -26,7 +26,7 @@ en:
         cannot_ready: "Cannot ready shipment."
       stock_location_required: "A stock_location_id parameter must be provided in order to retrieve stock movements."
       invalid_taxonomy_id: "Invalid taxonomy id."
-      shipment_transfer_errors_occurred: "Following errors occured while attempting this action:"
+      shipment_transfer_errors_occurred: "Following errors occurred while attempting this action:"
       negative_quantity: "quantity is negative"
       wrong_shipment_target: "target shipment is the same as original shipment"
 

data/config/routes.rb

@@ -128,7 +128,7 @@ Spree::Core::Engine.add_routes do
 
     namespace :v2 do
       namespace :storefront do
-        resource :cart, controller: :cart, only: %i[show create] do
+        resource :cart, controller: :cart, only: %i[show create destroy] do
           post   :add_item
           patch  :empty
           delete 'remove_line_item/:line_item_id', to: 'cart#remove_line_item', as: :cart_remove_line_item
@@ -149,11 +149,11 @@ Spree::Core::Engine.add_routes do
           get :shipping_rates
         end
 
-        resource :account, controller: :account, only: %i[show]
+        resource :account, controller: :account, only: %i[show create update]
 
         namespace :account do
           resources :addresses, controller: :addresses
-          resources :credit_cards, controller: :credit_cards, only: %i[index show]
+          resources :credit_cards, controller: :credit_cards, only: %i[index show destroy]
           resources :orders, controller: :orders, only: %i[index show]
         end
 
@@ -163,6 +163,118 @@ Spree::Core::Engine.add_routes do
         resources :products, only: %i[index show]
         resources :taxons,   only: %i[index show], id: /.+/
         get '/stores/:code', to: 'stores#show', as: :store
+
+        resources :menus, only: %i[index show]
+        resources :cms_pages, only: %i[index show]
+      end
+
+      namespace :platform do
+        # Promotions API
+        resources :promotions
+
+        # Returns API
+        resources :customer_returns
+        resources :reimbursements
+        resources :return_authorizations do
+          member do
+            put :add
+            put :cancel
+            put :receive
+          end
+        end
+
+        # Product Catalog API
+        resources :products
+        resources :taxonomies
+        resources :taxons
+        resources :classifications do
+          member do
+            put :reposition
+          end
+        end
+        resources :images
+        resources :variants
+        resources :properties
+        resources :product_properties
+        resources :option_types
+        resources :option_values
+
+        # Order API
+        resources :orders do
+          member do
+            put :next
+            put :advance
+            put :approve
+            put :cancel
+            put :empty
+            put :apply_coupon_code
+            put :remove_coupon_code
+          end
+        end
+        resources :line_items
+        resources :payments do
+          member do
+            put :authorize
+            put :capture
+            put :purchase
+            put :void
+            put :credit
+          end
+        end
+
+        # Geo API
+        resources :zones
+        resources :countries, only: [:index, :show]
+        resources :states, only: [:index, :show]
+
+        # Shipment API
+        resources :shipments do
+          collection do
+            post 'transfer_to_location'
+            post 'transfer_to_shipment'
+          end
+          member do
+            put :ready
+            put :ship
+            put :add
+            put :remove
+          end
+        end
+
+        # Inventory API
+        resources :inventory_units
+        resources :stock_items
+        resources :stock_locations
+        resources :stock_movements
+
+        # User API
+        resources :users
+        resources :credit_cards
+        resources :addresses
+
+        # Menu API
+        resources :menus
+        resource :menu_items do
+          member do
+            patch :reposition
+          end
+        end
+
+        # CMS Pages API
+        resources :cms_pages do
+          member do
+            patch :toggle_visibility
+          end
+        end
+
+        resource :cms_sections do
+          member do
+            patch :reposition
+          end
+        end
+
+        # Store API
+        resources :stores
       end
     end