spree_api 4.3.0.rc1 → 4.4.0.rc1

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class WishlistSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          attributes :token
+
+          attribute :variant_included do |wishlist, params|
+            wishlist.include?(params[:is_variant_included])
+          end
+
+          has_many :wished_items
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,13 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class ZoneSerializer < BaseSerializer
+          include ResourceSerializerConcern
+
+          has_many :zone_members
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Spree
         set_type :address
 
         attributes :firstname, :lastname, :address1, :address2, :city, :zipcode, :phone, :state_name,
-                   :company, :country_name, :country_iso3, :country_iso, :label
+                   :company, :country_name, :country_iso3, :country_iso, :label, :public_metadata
 
         attribute :state_code do |address|
           address.state_abbr

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

@@ -10,7 +10,7 @@ module Spree
                    :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,
-                   :shipment_state, :payment_state
+                   :shipment_state, :payment_state, :public_metadata
 
         has_many   :line_items
         has_many   :variants

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

@@ -21,7 +21,11 @@ module Spree
           section.fullscreen?
         end
 
-        belongs_to :linked_resource, polymorphic: true
+        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/v2/storefront/credit_card_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       class CreditCardSerializer < BaseSerializer
         set_type :credit_card
 
-        attributes :cc_type, :last_digits, :month, :year, :name, :default
+        attributes :cc_type, :last_digits, :month, :year, :name, :default, :public_metadata
 
         belongs_to :payment_method
       end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class DigitalLinkSerializer < BaseSerializer
+        set_type :digital_link
+
+        attribute :token
+      end
+    end
+  end
+end

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

@@ -13,11 +13,11 @@ module Spree
         end
 
         attributes :display_cost, :display_final_price do |object, params|
-          Spree::Money.new(object.cost, currency: params[:currency])
+          Spree::Money.new(object.cost, currency: params[:currency]).to_s
         end
 
         attribute :display_tax_amount do |object, params|
-          Spree::Money.new(object.tax_amount, currency: params[:currency])
+          Spree::Money.new(object.tax_amount, currency: params[:currency]).to_s
         end
 
         attribute :free do |object|

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class IconSerializer < BaseSerializer
+        set_type :icon
+
+        attribute :url do |icon|
+          url_helpers = Rails.application.routes.url_helpers
+          url_helpers.polymorphic_url(icon.attachment, only_path: true)
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,11 @@ module Spree
   module V2
     module Storefront
       class ImageSerializer < BaseSerializer
+        include ::Spree::Api::V2::ImageTransformationConcern
+
         set_type :image
 
-        attributes :viewable_type, :viewable_id, :styles
+        attributes :styles, :position, :alt, :original_url
       end
     end
   end

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

@@ -10,9 +10,10 @@ module Spree
                    :discounted_amount, :display_discounted_amount,
                    :display_additional_tax_total, :promo_total, :display_promo_total,
                    :included_tax_total, :display_included_tax_total,
-                   :pre_tax_amount, :display_pre_tax_amount
+                   :pre_tax_amount, :display_pre_tax_amount, :public_metadata
 
         belongs_to :variant
+        has_many :digital_links
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Spree
       class MenuItemSerializer < BaseSerializer
         set_type :menu_item
 
-        attributes :code, :name, :subtitle, :link, :new_window, :lft, :rgt, :depth
+        attributes :code, :name, :subtitle, :link, :destination, :item_type, :new_window, :lft, :rgt, :depth
 
         attribute :is_container do |menu_item|
           menu_item.container?
@@ -22,15 +22,21 @@ module Spree
           menu_item.leaf?
         end
 
-        has_one :image,
+        has_one :icon,
                 object_method_name: :icon,
                 id_method_name: :icon_id,
-                record_type: :image,
-                serializer: :image
+                record_type: :icon,
+                serializer: :icon
 
+        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
+        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

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

@@ -4,7 +4,7 @@ module Spree
       class OptionTypeSerializer < BaseSerializer
         set_type   :option_type
 
-        attributes :name, :presentation, :position
+        attributes :name, :presentation, :position, :public_metadata
 
         has_many   :option_values
       end

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

@@ -4,7 +4,7 @@ module Spree
       class OptionValueSerializer < BaseSerializer
         set_type   :option_value
 
-        attributes :name, :presentation, :position
+        attributes :name, :presentation, :position, :public_metadata
 
         belongs_to :option_type
       end

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

@@ -4,7 +4,11 @@ module Spree
       class PaymentMethodSerializer < BaseSerializer
         set_type :payment_method
 
-        attributes :type, :name, :description
+        attributes :type, :name, :description, :public_metadata
+
+        attribute :preferences do |object|
+          object.public_preferences.as_json
+        end
       end
     end
   end

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, :state
+                   :payment_method_id, :payment_method_name, :state, :public_metadata
       end
     end
   end

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
+        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at, :sku, :public_metadata
 
         attribute :purchasable do |product|
           product.purchasable?
@@ -48,22 +48,28 @@ module Spree
         has_many :option_types
         has_many :product_properties
 
-        has_many :taxons do |object, params|
-          object.taxons_for_store(params[:store])
+        has_many :taxons, serializer: :taxon, record_type: :taxon do |object, params|
+          object.taxons_for_store(params[:store]).order(:id)
         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/promotion_serializer.rb

@@ -5,7 +5,7 @@ module Spree
         set_id     :promotion_id
         set_type   :promotion
 
-        attributes :name, :description, :amount, :display_amount, :code
+        attributes :name, :description, :amount, :display_amount, :code, :public_metadata
       end
     end
   end

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

@@ -5,13 +5,14 @@ module Spree
         set_type :shipment
 
         attributes :number, :final_price, :display_final_price,
-                   :state, :shipped_at, :tracking_url
+                   :state, :shipped_at, :tracking_url, :public_metadata
 
         attribute :free do |shipment|
           shipment.free?
         end
 
         has_many :shipping_rates
+        has_one :selected_shipping_rate, serializer: :shipping_rate
 
         belongs_to :stock_location
       end

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

@@ -10,7 +10,7 @@ module Spree
                    id_method_name: :type_id,
                    serializer: :store_credit_type
 
-        attributes :amount, :amount_used, :created_at
+        attributes :amount, :amount_used, :created_at, :public_metadata
       end
     end
   end

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

@@ -6,7 +6,7 @@ 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, :supported_locales
+                   :address, :contact_phone, :supported_locales, :settings
 
         has_many :menus
         has_many :cms_pages

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

@@ -2,9 +2,11 @@ module Spree
   module V2
     module Storefront
       class TaxonImageSerializer < BaseSerializer
+        include ::Spree::Api::V2::TaxonImageTransformationConcern
+
         set_type   :taxon_image
 
-        attributes :viewable_type, :viewable_id, :styles
+        attributes :styles, :alt, :original_url
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Spree
         set_type   :taxon
 
         attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
-                   :meta_keywords, :left, :right, :position, :depth, :updated_at
+                   :meta_keywords, :left, :right, :position, :depth, :updated_at, :public_metadata
 
         attribute :is_root do |taxon|
           taxon.root?

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

@@ -4,7 +4,7 @@ module Spree
       class TaxonomySerializer < BaseSerializer
         set_type   :taxonomy
 
-        attributes :name, :position
+        attributes :name, :position, :public_metadata
       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
+        attributes :email, :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
+        attributes :sku, :weight, :height, :width, :depth, :is_master, :options_text, :public_metadata
 
         attribute :purchasable do |variant|
           variant.purchasable?

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

@@ -0,0 +1,29 @@
+module Spree
+  module V2
+    module Storefront
+      class WishedItemSerializer < BaseSerializer
+        set_type :wished_item
+
+        attributes :quantity
+
+        attribute :price do |wished_item, params|
+          wished_item.price(currency: params[:currency])
+        end
+
+        attribute :total do |wished_item, params|
+          wished_item.total(currency: params[:currency])
+        end
+
+        attribute :display_price do |wished_item, params|
+          wished_item.display_price(currency: params[:currency]).to_s
+        end
+
+        attribute :display_total do |wished_item, params|
+          wished_item.display_total(currency: params[:currency]).to_s
+        end
+
+        belongs_to :variant
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module V2
+    module Storefront
+      class WishlistSerializer < BaseSerializer
+        set_type :wishlist
+
+        attributes :token, :name, :is_private, :is_default
+
+        attribute :variant_included do |wishlist, params|
+          wishlist.include?(params[:is_variant_included])
+        end
+
+        has_many :wished_items
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class HandleRequest
+        def initialize(event_name:, subscriber:, webhook_payload_body:)
+          @event_name = event_name
+          @subscriber = subscriber
+          @webhook_payload_body = JSON.parse(webhook_payload_body)
+        end
+
+        def call
+          Rails.logger.debug(msg("sending to '#{url}'"))
+          Rails.logger.debug(msg("webhook_payload_body: #{body_with_event_metadata}"))
+
+          if request.unprocessable_uri?
+            return process(:warn, msg("can not make a request to '#{url}'"))
+          end
+          return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
+
+          process(:debug, msg("success for URL '#{url}'"))
+        end
+
+        private
+
+        attr_reader :webhook_payload_body, :event_name, :subscriber
+
+        delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?, to: :request
+        delegate :id, :url, to: :subscriber
+        delegate :created_at, :id, to: :event, prefix: true
+
+        def process(log_level, msg)
+          Rails.logger.public_send(log_level, msg)
+          make_request
+          update_event(msg)
+          nil
+        end
+
+        def request
+          @request ||=
+            Spree::Webhooks::Subscribers::MakeRequest.new(webhook_payload_body: body_with_event_metadata, url: url)
+        end
+        alias make_request request
+
+        def body_with_event_metadata
+          webhook_payload_body.
+            merge(event_created_at: event_created_at, event_id: event_id, event_type: event.name).
+            to_json
+        end
+
+        def event
+          @event ||= Spree::Webhooks::Event.create!(
+            name: event_name, subscriber_id: subscriber.id, url: url
+          )
+        end
+
+        def update_event(msg)
+          event.update(
+            execution_time: execution_time,
+            request_errors: msg,
+            response_code: response_code,
+            success: success?
+          )
+        end
+
+        def msg(msg)
+          "[SPREE WEBHOOKS] '#{event_name}' #{msg}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class MakeRequest
+        def initialize(url:, webhook_payload_body:)
+          @execution_time_in_milliseconds = 0
+          @url = url
+          @webhook_payload_body = webhook_payload_body
+          @webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
+        end
+
+        def execution_time
+          request
+          @execution_time_in_milliseconds
+        end
+
+        def failed_request?
+          (200...300).exclude?(response_code)
+        end
+
+        def response_code
+          request.code.to_i
+        end
+
+        def success?
+          !unprocessable_uri? && !failed_request?
+        end
+
+        def unprocessable_uri?
+          uri_path == '' && uri_host.nil? && uri_port.nil?
+        end
+
+        private
+
+        attr_reader :execution_time_in_milliseconds, :url, :webhook_payload_body, :webhooks_timeout
+
+        HEADERS = { 'Content-Type' => 'application/json' }.freeze
+        private_constant :HEADERS
+
+        delegate :host, :path, :port, to: :uri, prefix: true
+
+        def http
+          http = Net::HTTP.new(uri_host, uri_port)
+          http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
+          http.use_ssl = true if use_ssl?
+          http
+        end
+
+        def request
+          req = Net::HTTP::Post.new(uri_path, HEADERS)
+          req.body = webhook_payload_body
+          @request ||= begin
+            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            request_result = http.request(req)
+            @execution_time_in_milliseconds = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).in_milliseconds
+            request_result
+          end
+        rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
+          Class.new do
+            def self.code
+              '0'
+            end
+          end
+        end
+
+        def custom_read_timeout?
+          webhooks_timeout.present?
+        end
+
+        def use_ssl?
+          !(Rails.env.development? || Rails.env.test?)
+        end
+
+        def uri
+          URI(url)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module Webhooks
+    module Subscribers
+      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|
+            Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
+              webhook_payload_body, event_name, subscriber
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Webhooks
+    def self.disable_webhooks
+      webhooks_disabled_previously = ENV['DISABLE_SPREE_WEBHOOKS']
+      begin
+        ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+        yield
+      ensure
+        ENV['DISABLE_SPREE_WEBHOOKS'] = webhooks_disabled_previously
+      end
+    end
+  end
+end