spree_api 4.3.0 → 4.4.0

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module Webhooks
+      module OrderDecorator
+        def self.prepended(base)
+          def base.custom_webhook_events
+            %w[order.canceled order.placed order.resumed order.shipped]
+          end
+
+          base.after_update_commit :queue_webhooks_requests_for_order_resumed!
+        end
+
+        def after_cancel
+          super
+          queue_webhooks_requests!('order.canceled')
+        end
+
+        def finalize!
+          super
+          queue_webhooks_requests!('order.placed')
+        end
+
+        def after_resume
+          super
+          queue_webhooks_requests!('order.resumed')
+          self.state_machine_resumed = false
+        end
+
+        private
+
+        def queue_webhooks_requests_for_order_resumed!
+          return if state_machine_resumed?
+          return unless state_previously_changed?
+          return unless state_previous_change&.last == 'resumed'
+
+          queue_webhooks_requests!('order.resumed')
+        end
+      end
+    end
+  end
+end
+
+Spree::Order.prepend(Spree::Api::Webhooks::OrderDecorator)

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

@@ -0,0 +1,26 @@
+module Spree
+  module Api
+    module Webhooks
+      module PaymentDecorator
+        def self.prepended(base)
+          def base.custom_webhook_events
+            %w[payment.paid payment.voided]
+          end
+        end
+
+        def after_void
+          super
+          queue_webhooks_requests!('payment.voided')
+        end
+
+        def after_completed
+          super
+          queue_webhooks_requests!('payment.paid')
+          order.queue_webhooks_requests!('order.paid') if order.paid?
+        end
+      end
+    end
+  end
+end
+
+Spree::Payment.prepend(Spree::Api::Webhooks::PaymentDecorator)

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

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module Webhooks
+      module ProductDecorator
+        def self.prepended(base)
+          def base.custom_webhook_events
+            %w[product.back_in_stock product.backorderable product.discontinued product.out_of_stock]
+          end
+
+          base.after_update_commit :queue_webhooks_requests_for_product_discontinued!
+        end
+
+        private
+
+        def queue_webhooks_requests_for_product_discontinued!
+          return unless discontinue_on_previously_changed?
+          return if (change = discontinue_on_previous_change).blank? || change.last.blank?
+
+          queue_webhooks_requests!('product.discontinued')
+        end
+      end
+    end
+  end
+end
+
+Spree::Product.prepend(Spree::Api::Webhooks::ProductDecorator)
+

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

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module Webhooks
+      module ShipmentDecorator
+        def self.prepended(base)
+          def base.custom_webhook_events
+            %w[shipment.shipped]
+          end
+        end
+
+        def after_ship
+          super
+          queue_webhooks_requests!('shipment.shipped')
+          order.queue_webhooks_requests!('order.shipped') if order.fully_shipped?
+        end
+      end
+    end
+  end
+end
+
+Spree::Shipment.prepend(Spree::Api::Webhooks::ShipmentDecorator)

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module Webhooks
+      module StockItemDecorator
+        def self.prepended(base)
+          base.around_save :queue_webhooks_requests_for_variant_backorderable!
+          base.around_save :queue_webhooks_requests_for_product_backorderable!
+        end
+
+        private
+
+        def queue_webhooks_requests_for_variant_backorderable!
+          was_out_of_stock = !variant.in_stock_or_backorderable?
+          was_not_backorderable = !variant_backorderable?
+          yield
+          if was_out_of_stock && was_not_backorderable && variant_backorderable?
+            reload
+            variant.queue_webhooks_requests!('variant.backorderable')
+          end
+        end
+
+        def queue_webhooks_requests_for_product_backorderable!
+          product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
+          product_was_not_backorderable = !product_backorderable?
+          yield
+          if product_was_out_of_stock && product_was_not_backorderable && product_backorderable?
+            variant.product.queue_webhooks_requests!('product.backorderable')
+          end
+        end
+
+        def product_backorderable?
+          Spree::StockItem.exists?(backorderable: true, variant_id: variant.product.variants.ids)
+        end
+
+        def variant_backorderable?
+          variant.stock_items.exists?(backorderable: true)
+        end
+      end
+    end
+  end
+end
+
+Spree::StockItem.prepend(Spree::Api::Webhooks::StockItemDecorator)

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

@@ -0,0 +1,52 @@
+module Spree
+  module Api
+    module Webhooks
+      module StockMovementDecorator
+        def self.prepended(base)
+          base.around_save :queue_webhooks_requests_for_variant_out_of_stock!
+          base.around_save :queue_webhooks_requests_for_variant_back_in_stock!
+          base.around_save :queue_webhooks_requests_for_product_out_of_stock!
+          base.around_save :queue_webhooks_requests_for_product_back_in_stock!
+        end
+
+        private
+
+        def queue_webhooks_requests_for_variant_out_of_stock!
+          variant_in_stock_before_update = variant.in_stock_or_backorderable?
+          yield
+          if variant_in_stock_before_update && !variant.in_stock_or_backorderable?
+            reload
+            stock_item.variant.queue_webhooks_requests!('variant.out_of_stock')
+          end
+        end
+
+        def queue_webhooks_requests_for_variant_back_in_stock!
+          variant_was_out_of_stock = !variant.in_stock_or_backorderable?
+          yield
+          if variant_was_out_of_stock && variant.in_stock_or_backorderable?
+            reload
+            variant.queue_webhooks_requests!('variant.back_in_stock')
+          end
+        end
+
+        def queue_webhooks_requests_for_product_back_in_stock!
+          product_was_out_of_stock = !product.any_variant_in_stock_or_backorderable?
+          yield
+          if product_was_out_of_stock && product.any_variant_in_stock_or_backorderable?
+            product.queue_webhooks_requests!('product.back_in_stock')
+          end
+        end
+
+        def queue_webhooks_requests_for_product_out_of_stock!
+          product_was_in_stock = product.any_variant_in_stock_or_backorderable?
+          yield
+          if product_was_in_stock && !product.any_variant_in_stock_or_backorderable?
+            product.queue_webhooks_requests!('product.out_of_stock')
+          end
+        end
+      end
+    end
+  end
+end
+
+Spree::StockMovement.prepend(Spree::Api::Webhooks::StockMovementDecorator)

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

@@ -0,0 +1,26 @@
+module Spree
+  module Api
+    module Webhooks
+      module VariantDecorator
+        def self.prepended(base)
+          def base.custom_webhook_events
+            %w[variant.back_in_stock variant.backorderable variant.discontinued variant.out_of_stock]
+          end
+
+          base.after_update_commit :queue_webhooks_requests_for_variant_discontinued!
+        end
+
+        private
+
+        def queue_webhooks_requests_for_variant_discontinued!
+          return unless discontinue_on_previously_changed?
+          return if (change = discontinue_on_previous_change).blank? || change.last.blank?
+
+          queue_webhooks_requests!('variant.discontinued')
+        end
+      end
+    end
+  end
+end
+
+Spree::Variant.prepend(Spree::Api::Webhooks::VariantDecorator)

data/app/models/spree/oauth_access_grant.rb

@@ -0,0 +1,7 @@
+module Spree
+  class OauthAccessGrant < Base
+    include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessGrant
+
+    self.table_name = 'spree_oauth_access_grants'
+  end
+end

data/app/models/spree/oauth_access_token.rb

@@ -0,0 +1,7 @@
+module Spree
+  class OauthAccessToken < Base
+    include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken
+
+    self.table_name = 'spree_oauth_access_tokens'
+  end
+end

data/app/models/spree/oauth_application.rb

@@ -0,0 +1,15 @@
+module Spree
+  class OauthApplication < Base
+    include ::Doorkeeper::Orm::ActiveRecord::Mixins::Application
+
+    self.table_name = 'spree_oauth_applications'
+
+    before_validation :set_blank_for_redirect_uri
+
+    private
+
+    def set_blank_for_redirect_uri
+      self.redirect_uri = '' if redirect_uri.nil?
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Webhooks
+    def self.table_name_prefix
+      'spree_webhooks_'
+    end
+
+    class Base < Spree::Base
+      self.abstract_class = true
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module Webhooks
+    class Event < Spree::Webhooks::Base
+      validates :name, :subscriber, presence: true
+
+      belongs_to :subscriber, inverse_of: :events, optional: false
+
+      self.whitelisted_ransackable_associations = %w[subscriber]
+      self.whitelisted_ransackable_attributes = %w[name request_errors response_code success url]
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Spree
+  module Webhooks
+    class Subscriber < Spree::Webhooks::Base
+      has_many :events, inverse_of: :subscriber
+
+      validates :url, 'spree/url': true, presence: true
+
+      validate :check_uri_path
+
+      self.whitelisted_ransackable_attributes = %w[active subscriptions url]
+      self.whitelisted_ransackable_associations = %w[event]
+
+      scope :active, -> { where(active: true) }
+      scope :inactive, -> { where(active: false) }
+
+      before_save :parse_subscriptions
+
+      def self.with_urls_for(event)
+        where(
+          case ActiveRecord::Base.connection.adapter_name
+          when 'Mysql2'
+            ["('*' MEMBER OF(subscriptions) OR ? MEMBER OF(subscriptions))", event]
+          when 'PostgreSQL'
+            ["subscriptions @> '[\"*\"]' OR subscriptions @> ?", [event].to_json]
+          end
+        )
+      end
+
+      def self.supported_events
+        Spree::Base.descendants.
+          select { |model| model.included_modules.include? Spree::Webhooks::HasWebhooks }.
+          to_h do |model|
+          model_name = model.name.demodulize.underscore.to_sym
+          [model_name, model.supported_webhook_events]
+        end
+      end
+
+      private
+
+      def check_uri_path
+        uri = begin
+          URI.parse(url)
+        rescue URI::InvalidURIError
+          return false
+        end
+
+        errors.add(:url, 'the URL must have a path') if uri.blank? || uri.path.blank?
+      end
+
+      def parse_subscriptions
+        return if subscriptions.blank? || subscriptions.is_a?(Array)
+
+        self.subscriptions = JSON.parse(subscriptions)
+      end
+    end
+  end
+end

data/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb

@@ -5,10 +5,28 @@ module Spree
         extend ActiveSupport::Concern
 
         def self.included(base)
-          model_klazz = "Spree::#{base.to_s.demodulize.gsub(/Serializer/, '')}".constantize
+          serializer_base_name = base.to_s.sub(/^Spree::Api::V2::Platform::/, '').sub(/Serializer$/, '')
+          model_klazz = "Spree::#{serializer_base_name}".constantize
 
           base.set_type model_klazz.json_api_type
+          # include standard attributes
           base.attributes(*model_klazz.json_api_columns)
+          # include money attributes
+          display_getter_methods(model_klazz).each do |method_name|
+            base.attribute(method_name) do |object|
+              object.public_send(method_name).to_s
+            end
+          end
+        end
+
+        def self.display_getter_methods(model_klazz)
+          model_klazz.new.methods.find_all do |method_name|
+            next unless method_name.to_s.start_with?('display_')
+            next if method_name.to_s.end_with?('=')
+            next if [Spree::Product, Spree::Variant].include?(model_klazz) && method_name == :display_amount
+
+            method_name
+          end
         end
       end
     end

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

@@ -13,12 +13,19 @@ module Spree
           opts = options.dup
 
           params_cache_key = params.map do |param|
-            next if param.nil? || param.last.nil?
+            value = param.last
+            next if param.nil? || value.nil?
 
-            if param.last.respond_to?(:cache_key_with_version)
-              param.last.cache_key_with_version
+            if value.respond_to?(:cache_key_with_version)
+              value.cache_key_with_version
+            elsif value.is_a?(Hash)
+              # covers the current_price_options cases:
+              #     { price_options: { tax_zone: Spree::Zone... } } or
+              #     { price_options: { tax_zone: nil } }
+              only_key = value.keys.first
+              value[only_key]&.cache_key_with_version
             else
-              param.last.to_s.downcase
+              value.to_s.downcase
             end
           end.compact.reject(&:blank?).join('-')
 

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class AddressSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           belongs_to :country
           belongs_to :state

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

@@ -0,0 +1,20 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AdjustmentSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :adjustable, polymorphic: true
+          belongs_to :source, polymorphic: {
+            Spree::Promotion::Actions::FreeShipping => :promotion_action,
+            Spree::Promotion::Actions::CreateAdjustment => :promotion_action,
+            Spree::Promotion::Actions::CreateItemAdjustments => :promotion_action,
+            Spree::Promotion::Actions::CreateLineItems => :promotion_action
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AssetSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :viewable, polymorphic: true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CalculatorSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          attributes :type
+
+          attribute :preferences do |calculator|
+            calculator.preferences
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class ClassificationSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           belongs_to :product
           belongs_to :taxon

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class CmsPageSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           has_many :cms_sections, serializer: :cms_section
         end

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

@@ -3,7 +3,14 @@ module Spree
     module V2
       module Platform
         class CmsSectionSerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
+
+          belongs_to :cms_page, serializer: :cms_page
+          belongs_to :linked_resource, polymorphic: {
+            Spree::Cms::Pages::StandardPage => :cms_page,
+            Spree::Cms::Pages::FeaturePage => :cms_page,
+            Spree::Cms::Pages::Homepage => :cms_page
+          }
         end
       end
     end

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

@@ -3,7 +3,7 @@ module Spree
     module V2
       module Platform
         class CountrySerializer < BaseSerializer
-          include ::Spree::Api::V2::ResourceSerializerConcern
+          include ResourceSerializerConcern
 
           has_many :states
         end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CreditCardSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :payment_method
+          belongs_to :user
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CustomerReturnSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :stock_location
+
+          has_many :reimbursements
+          has_many :return_items
+          has_many :return_authorizations
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalLinkSerializer < BaseSerializer
+          set_type :digital_link
+
+          attributes :token, :access_counter
+
+          belongs_to :digital
+          belongs_to :line_item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalSerializer < BaseSerializer
+          set_type :digital
+
+          attribute :url do |digital|
+            url_helpers = Rails.application.routes.url_helpers
+            url_helpers.polymorphic_url(digital.attachment, only_path: true)
+          end
+
+          attribute :content_type do |digital|
+            digital.attachment.content_type.to_s
+          end
+
+          attribute :filename do |digital|
+            digital.attachment.filename.to_s
+          end
+
+          attribute :byte_size do |digital|
+            digital.attachment.byte_size.to_i
+          end
+
+          belongs_to :variant
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class FeaturePageSerializer < CmsPageSerializer
+          # Place holder serializer for Webhooks.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class HomepageSerializer < CmsPageSerializer
+          # Place holder serializer for Webhooks.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class InventoryUnitSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          belongs_to :order
+          belongs_to :variant
+          belongs_to :shipment
+          has_many :return_items
+          has_many :return_authorizations
+          belongs_to :line_item
+          belongs_to :original_return_item, serializer: :return_item, type: :return_item
+        end
+      end
+    end
+  end
+end