spree_api 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1802b10c520208b262e97e6b9e174ff2c3dcb7176f9f73842826c560c7dee71b
-  data.tar.gz: c4516614a3bee3a7392c1ae213f3e8c2e9945b1ffe04eceb82ff925a7e52d62b
+  metadata.gz: 57236192b982b8939614697a3f1ea3b46e95456e2b9f43c324b4c4b88dd3a5be
+  data.tar.gz: 4cf278eeee9926968327b8e4746bec902a8067a8594f7d6c9fdea281d8fbef84
 SHA512:
-  metadata.gz: 1bd20ff5548f56f27295e768e7a54744fe5274fb27ac636337ccc2dcdb79e5257479cc8b4f4c81f2f8827e65a4f809f54b01e0796fa74b4003d956922abb7b92
-  data.tar.gz: df44b43a9b23c235772ba76603546a9dec7037d126b1e0998ccd34c6ceedb8ddb126a3099e197118cb9881c67d911b18035464f58a61c665bf2f764dace0fbdf
+  metadata.gz: 3e43407ea4cf9ddefeb0921d6c244f0ac73e09856f7fb4bfbbf6ffb34f6c45f00104f7668cd6e4230122bd06db65e83e1f6425e22392b1f003ab5c4ef26689e5
+  data.tar.gz: 656fab17f5d7ed57b30fb71f13de42659364e62f52062923a89a3c0c0df2ab13902fc458446ee40af59add2b72b08ada892db05647dc1edd2308771d37279448

data/app/controllers/concerns/spree/api/v2/product_list_includes.rb

@@ -3,18 +3,20 @@ module Spree
     module V2
       module ProductListIncludes
         def product_list_includes
-          variant_includes = {
-            prices: [],
-            option_values: :option_type,
-            images: []
-          }
-
           {
             product_properties: [],
             option_types: [],
             variant_images: [],
-            master: variant_includes,
-            variants: variant_includes
+            master: product_variant_includes,
+            variants: product_variant_includes
+          }
+        end
+
+        def product_variant_includes
+          {
+            prices: [],
+            option_values: :option_type,
+            images: []
           }
         end
       end

data/app/controllers/spree/api/v2/platform/orders_controller.rb

@@ -100,7 +100,7 @@ module Spree
           end
 
           def allowed_sort_attributes
-            super.push(:available_on, :total, :payment_total, :item_total, :shipment_total,
+            super.push(:available_on, :make_active_at, :total, :payment_total, :item_total, :shipment_total,
                        :adjustment_total, :promo_total, :included_tax_total, :additional_tax_total,
                        :item_count, :tax_total, :completed_at)
           end

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

@@ -15,8 +15,12 @@ module Spree
             product_list_includes
           end
 
+          def spree_permitted_attributes
+            super.push(:price)
+          end
+
           def allowed_sort_attributes
-            super << :available_on
+            super.push(:available_on, :make_active_at)
           end
 
           def sorted_collection

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

@@ -150,7 +150,7 @@ module Spree
             shipping_rates_serializer.new(
               shipments,
               params: serializer_params,
-              include: [:shipping_rates, :stock_location]
+              include: [:shipping_rates, :stock_location, :line_items]
             ).serializable_hash
           end
         end

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

@@ -22,7 +22,7 @@ module Spree
                   redirect_to attachment.url(
                     expires_in: current_store.digital_asset_link_expire_time.seconds,
                     disposition: 'attachment',
-                    host: current_store.formatted_url
+                    host: digital_attachment_host
                   ) and return
 
                 end
@@ -47,6 +47,10 @@ module Spree
           def attachment
             @attachment ||= digital_link.digital.try(:attachment) if digital_link.present?
           end
+
+          def digital_attachment_host
+            current_store.formatted_url
+          end
         end
       end
     end

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

@@ -3,6 +3,10 @@ module Spree
     module V2
       module Storefront
         class StoresController < ::Spree::Api::V2::ResourceController
+          def current
+            render_serialized_payload { serialize_resource(current_store) }
+          end
+
           private
 
           def model_class

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

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V2
+      module StoreMediaSerializerImagesConcern
+        extend ActiveSupport::Concern
+
+        included do
+          def self.store_image_url_for(store, attribute_name)
+            attachment = store.send(attribute_name)&.attachment
+            return unless attachment&.attached?
+
+            url_helpers = Rails.application.routes.url_helpers
+            if Spree.public_storage_service_name
+              url_helpers.cdn_image_url(attachment)
+            else
+              url_helpers.rails_blob_path(attachment)
+            end
+          end
+
+          attribute :logo do |store|
+            store_image_url_for store, :logo
+          end
+
+          attribute :mailer_logo do |store|
+            store_image_url_for store, :mailer_logo
+          end
+
+          attribute :favicon_path do |store|
+            store_image_url_for store, :favicon_image
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/spree/webhooks/has_webhooks.rb

@@ -11,10 +11,12 @@ module Spree
         def queue_webhooks_requests!(event_name)
           return if disable_spree_webhooks?
           return if Spree::Webhooks::Subscriber.active.with_urls_for(event_name).none?
-          return if update_event?(event_name) && updating_only_timestamps?
+          return if update_event?(event_name) && updating_only_ignored_attributes?
           return if webhook_payload_body.blank?
 
-          Spree::Webhooks::Subscribers::QueueRequests.call(event_name: event_name, webhook_payload_body: webhook_payload_body)
+          Spree::Webhooks::Subscribers::QueueRequests.call(
+            event_name: event_name, webhook_payload_body: webhook_payload_body, **webhooks_request_options
+          )
         end
 
         def self.default_webhook_events
@@ -32,20 +34,38 @@ module Spree
       private
 
       def webhook_payload_body
-        resource_serializer.new(self).serializable_hash.to_json
+        resource_serializer.new(self, include: included_relationships).serializable_hash.to_json
       end
 
       def inferred_event_name(operation)
         "#{self.class.name.demodulize.tableize.singularize}.#{operation}"
       end
 
+      def included_relationships
+        if resource_serializer.relationships_to_serialize
+          resource_serializer.relationships_to_serialize.keys
+        else
+          []
+        end
+      end
+
       def resource_serializer
-        demodulized_class_name = self.class.to_s.demodulize
-        "Spree::Api::V2::Platform::#{demodulized_class_name}Serializer".constantize
+        @resource_serializer ||=
+          begin
+            demodulized_class_name = self.class.to_s.demodulize
+            "Spree::Api::V2::Platform::#{demodulized_class_name}Serializer".constantize
+          end
+      end
+
+      def updating_only_ignored_attributes?
+        (saved_changes.keys - ignored_attributes).empty?
       end
 
-      def updating_only_timestamps?
-        (saved_changes.keys - %w[created_at updated_at deleted_at]).empty?
+      def ignored_attributes
+        timestamps = %w[created_at updated_at deleted_at]
+        return timestamps unless self.class.respond_to?(:ignored_attributes_for_update_webhook_event)
+
+        timestamps + self.class.ignored_attributes_for_update_webhook_event
       end
 
       def update_event?(event_name)
@@ -55,6 +75,10 @@ module Spree
       def disable_spree_webhooks?
         ENV['DISABLE_SPREE_WEBHOOKS'] == 'true'
       end
+
+      def webhooks_request_options
+        {}
+      end
     end
   end
 end

data/app/models/spree/api/webhooks/product_decorator.rb

@@ -4,12 +4,32 @@ module Spree
       module ProductDecorator
         def self.prepended(base)
           def base.custom_webhook_events
-            %w[product.back_in_stock product.backorderable product.discontinued product.out_of_stock]
+            %w[product.back_in_stock product.backorderable product.discontinued
+               product.out_of_stock product.activated product.archived product.drafted]
+          end
+
+          def base.ignored_attributes_for_update_webhook_event
+            %w[status]
           end
 
           base.after_update_commit :queue_webhooks_requests_for_product_discontinued!
         end
 
+        def after_activate
+          super
+          queue_webhooks_requests!('product.activated')
+        end
+
+        def after_archive
+          super
+          queue_webhooks_requests!('product.archived')
+        end
+
+        def after_draft
+          super
+          queue_webhooks_requests!('product.drafted')
+        end
+
         private
 
         def queue_webhooks_requests_for_product_discontinued!
@@ -24,4 +44,3 @@ module Spree
 end
 
 Spree::Product.prepend(Spree::Api::Webhooks::ProductDecorator)
-

data/app/models/spree/webhooks/subscriber.rb

@@ -1,6 +1,10 @@
 module Spree
   module Webhooks
     class Subscriber < Spree::Webhooks::Base
+      if defined?(Spree::VendorConcern)
+        include Spree::VendorConcern
+      end
+
       has_many :events, inverse_of: :subscriber
 
       validates :url, 'spree/url': true, presence: true

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

@@ -0,0 +1,9 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsSectionImageOneSerializer < AssetSerializer; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsSectionImageThreeSerializer < AssetSerializer; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsSectionImageTwoSerializer < AssetSerializer; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class HeroImageSerializer < CmsSectionSerializer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class ImageGallerySerializer < CmsSectionSerializer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class SideBySideImageSerializer < CmsSectionSerializer
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module Spree
       module Platform
         class StoreSerializer < BaseSerializer
           include ResourceSerializerConcern
+          include StoreMediaSerializerImagesConcern
 
           has_many :menus
           has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id

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

@@ -5,7 +5,7 @@ module Spree
         class UserSerializer < BaseSerializer
           set_type :user
 
-          attributes :email, :created_at, :updated_at, :public_metadata, :private_metadata
+          attributes :email, :first_name, :last_name, :created_at, :updated_at, :public_metadata, :private_metadata
 
           attribute :average_order_value do |user, params|
             price_stats(user.report_values_for(:average_order_value, params[:store]))

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

@@ -6,10 +6,10 @@ module Spree
 
         attributes :name, :content, :settings, :link, :fit, :type, :position
 
-        Spree::CmsSection::IMAGE_COUNT.each do |count|
-          Spree::CmsSection::IMAGE_SIZE.each do |size|
+        Spree::CmsSectionImage::IMAGE_COUNT.each do |count|
+          Spree::CmsSectionImage::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?
+              if section.send("image_#{count}")&.attachment&.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

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

@@ -0,0 +1,9 @@
+module Spree
+  module V2
+    module Storefront
+      class OrderSerializer < CartSerializer
+        set_type :order
+      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, :filter_param
+        attribute :value, :filter_param, :show_property, :position
 
         attribute :name do |product_property|
           product_property.property_name

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

@@ -6,7 +6,7 @@ module Spree
 
         set_type :product
 
-        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at, :sku, :public_metadata
+        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at, :sku, :barcode, :public_metadata
 
         attribute :purchasable do |product|
           product.purchasable?

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

@@ -15,6 +15,9 @@ module Spree
         has_one :selected_shipping_rate, serializer: :shipping_rate
 
         belongs_to :stock_location
+        has_many :line_items do |shipment|
+          shipment.line_items
+        end
       end
     end
   end

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

@@ -2,23 +2,18 @@ module Spree
   module V2
     module Storefront
       class StoreSerializer < BaseSerializer
+        include Spree::Api::V2::StoreMediaSerializerImagesConcern
+
         set_type :store
 
-        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, :supported_locales, :settings
+        attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency,
+                   :default, :supported_currencies, :facebook, :twitter, :instagram, :default_locale,
+                   :customer_support_email, :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/user_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       class UserSerializer < BaseSerializer
         set_type :user
 
-        attributes :email, :public_metadata
+        attributes :email, :first_name, :last_name, :public_metadata
 
         attribute :store_credits do |user|
           user.total_available_store_credit

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

@@ -6,7 +6,7 @@ module Spree
 
         set_type :variant
 
-        attributes :sku, :weight, :height, :width, :depth, :is_master, :options_text, :public_metadata
+        attributes :sku, :barcode, :weight, :height, :width, :depth, :is_master, :options_text, :public_metadata
 
         attribute :purchasable do |variant|
           variant.purchasable?

data/app/services/spree/webhooks/subscribers/queue_requests.rb

@@ -4,13 +4,19 @@ module Spree
       class QueueRequests
         prepend Spree::ServiceModule::Base
 
-        def call(event_name:, webhook_payload_body:)
-          Spree::Webhooks::Subscriber.active.with_urls_for(event_name).each do |subscriber|
+        def call(event_name:, webhook_payload_body:, **options)
+          filtered_subscribers(event_name, webhook_payload_body, options).each do |subscriber|
             Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
               webhook_payload_body, event_name, subscriber
             )
           end
         end
+
+        private
+
+        def filtered_subscribers(event_name, _, _)
+          Spree::Webhooks::Subscriber.active.with_urls_for(event_name)
+        end
       end
     end
   end

data/config/routes.rb

@@ -6,126 +6,6 @@ end
 
 Spree::Core::Engine.add_routes do
   namespace :api, defaults: { format: 'json' } do
-    namespace :v1 do
-      resources :promotions, only: [:show]
-
-      resources :customer_returns, only: [:index]
-      resources :reimbursements, only: [:index]
-
-      resources :products do
-        resources :images
-        resources :variants
-        resources :product_properties
-      end
-
-      concern :order_routes do
-        member do
-          put :approve
-          put :cancel
-          put :empty
-          put :apply_coupon_code
-        end
-
-        resources :line_items
-        resources :payments do
-          member do
-            put :authorize
-            put :capture
-            put :purchase
-            put :void
-            put :credit
-          end
-        end
-
-        resources :addresses, only: [:show, :update]
-
-        resources :return_authorizations do
-          member do
-            put :add
-            put :cancel
-            put :receive
-          end
-        end
-      end
-
-      resources :checkouts, only: [:update], concerns: :order_routes do
-        member do
-          put :next
-          put :advance
-        end
-      end
-
-      resources :variants do
-        resources :images
-      end
-
-      resources :option_types do
-        resources :option_values
-      end
-      resources :option_values
-
-      resources :option_values, only: :index
-
-      get '/orders/mine', to: 'orders#mine', as: 'my_orders'
-      get '/orders/current', to: 'orders#current', as: 'current_order'
-
-      resources :orders, concerns: :order_routes do
-        put :remove_coupon_code, on: :member
-      end
-
-      resources :zones
-      resources :countries, only: [:index, :show] do
-        resources :states, only: [:index, :show]
-      end
-
-      resources :shipments, only: [:create, :update] do
-        collection do
-          post 'transfer_to_location'
-          post 'transfer_to_shipment'
-          get :mine
-        end
-
-        member do
-          put :ready
-          put :ship
-          put :add
-          put :remove
-        end
-      end
-      resources :states, only: [:index, :show]
-
-      resources :taxonomies do
-        member do
-          get :jstree
-        end
-        resources :taxons do
-          member do
-            get :jstree
-          end
-        end
-      end
-
-      resources :taxons, only: [:index]
-
-      resources :inventory_units, only: [:show, :update]
-
-      resources :users do
-        resources :credit_cards, only: [:index]
-      end
-
-      resources :properties
-      resources :stock_locations do
-        resources :stock_movements
-        resources :stock_items
-      end
-
-      resources :stock_items, only: [:index, :update, :destroy]
-      resources :stores
-
-      put '/classifications', to: 'classifications#update', as: :classifications
-      get '/taxons/products', to: 'taxons#products', as: :taxon_products
-    end
-
     namespace :v2 do
       namespace :storefront do
         resource :cart, controller: :cart, only: %i[show create destroy] do
@@ -167,6 +47,7 @@ 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
+        get '/store', to: 'stores#current', as: :current_store
 
         resources :menus, only: %i[index show]
         resources :cms_pages, only: %i[index show]