spree_api 4.2.7 → 4.3.0.rc1

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

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

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

@@ -0,0 +1,22 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class MenuItemSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          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: true
+          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  :master_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 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

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class TaxonImageSerializer < BaseSerializer
+          set_type :taxon_image
+
+          attributes :styles, :alt, :created_at, :updated_at
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class TaxonSerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          attributes :pretty_name, :seo_title
+
+          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
+
+          has_many   :children, record_type: :taxon, serializer: :taxon
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class TaxonomySerializer < BaseSerializer
+          include ::Spree::Api::V2::ResourceSerializerConcern
+
+          has_many :taxons
+          has_one :root, serializer: :taxon
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class UserSerializer < BaseSerializer
+          set_type :user
+
+          attributes :email, :created_at, :updated_at
+
+          has_one :bill_address,
+                  record_type: :address,
+                  serializer: :address
+
+          has_one :ship_address,
+                  record_type: :address,
+                  serializer: :address
+        end
+      end
+    end
+  end
+end

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,37 @@
+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 :parent, record_type: :menu_item, serializer: :menu_item
+        belongs_to :linked_resource, polymorphic: true
+        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,7 +47,10 @@ module Spree
         has_many :variants
         has_many :option_types
         has_many :product_properties
-        has_many :taxons
+
+        has_many :taxons do |object, params|
+          object.taxons_for_store(params[:store])
+        end
 
         # all images from all variants
         has_many :images,

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