spree_api 5.3.5 → 5.4.0.beta

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

@@ -1,46 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module CollectionOptionsHelpers
-        def collection_links(collection)
-          {
-            self: request.original_url,
-            next: pagination_url(collection.next_page || collection.total_pages),
-            prev: pagination_url(collection.prev_page || 1),
-            last: pagination_url(collection.total_pages),
-            first: pagination_url(1)
-          }
-        end
-
-        def collection_meta(collection)
-          {
-            count: collection.size,
-            total_count: collection.total_count,
-            total_pages: collection.total_pages
-          }
-        end
-
-        # leaving this method in public scope so it's still possible to modify
-        # those params to support non-standard non-JSON API parameters
-        def collection_permitted_params
-          params.permit(:format, :page, :per_page, :sort, :include, :locale, fields: {}, filter: {})
-        end
-
-        private
-
-        def pagination_url(page)
-          url_for(collection_permitted_params.merge(page: page))
-        end
-
-        def collection_options(collection)
-          {
-            links: collection_links(collection),
-            meta: collection_meta(collection),
-            include: resource_includes,
-            fields: sparse_fields
-          }
-        end
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module DisplayMoneyHelper
-        extend ActiveSupport::Concern
-
-        class_methods do
-          def find_price(product_or_variant, currency, context_options = {})
-            variant = product_or_variant.is_a?(Spree::Product) ? product_or_variant.default_variant : product_or_variant
-
-            if context_options.present?
-              context = build_pricing_context(variant, currency, context_options)
-              variant.price_for(context)
-            else
-              variant.price_in(currency)
-            end
-          end
-
-          def price(product_or_variant, currency, context_options = {})
-            price = find_price(product_or_variant, currency, context_options)
-            return nil if price.new_record?
-
-            price.amount
-          end
-
-          def display_price(product_or_variant, currency, context_options = {})
-            price = find_price(product_or_variant, currency, context_options)
-            return nil if price.new_record?
-
-            Spree::Money.new(price.amount, currency: currency).to_s
-          end
-
-          def compare_at_price(product_or_variant, currency, context_options = {})
-            price = find_price(product_or_variant, currency, context_options)
-            return nil if price.new_record? || price.compare_at_amount.blank?
-
-            price.compare_at_amount
-          end
-
-          def display_compare_at_price(product_or_variant, currency, context_options = {})
-            price = find_price(product_or_variant, currency, context_options)
-            return nil if price.new_record? || price.compare_at_amount.blank?
-
-            Spree::Money.new(price.compare_at_amount, currency: currency).to_s
-          end
-
-          private
-
-          def build_pricing_context(variant, currency, options)
-            Spree::Pricing::Context.new(
-              variant: variant,
-              currency: currency,
-              store: options[:store],
-              zone: options[:tax_zone] || options[:zone],
-              user: options[:user],
-              quantity: options[:quantity]
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-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)
-            return unless attachment.attached?
-
-            url_helpers.cdn_image_url(attachment)
-          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/user_api_authentication.rb

@@ -1,19 +0,0 @@
-module Spree
-  module UserApiAuthentication
-    def generate_spree_api_key!
-      self.spree_api_key = generate_spree_api_key
-      save!
-    end
-
-    def clear_spree_api_key!
-      self.spree_api_key = nil
-      save!
-    end
-
-    private
-
-    def generate_spree_api_key
-      SecureRandom.hex(24)
-    end
-  end
-end

data/app/models/concerns/spree/user_api_methods.rb

@@ -1,7 +0,0 @@
-module Spree
-  module UserApiMethods
-    extend ActiveSupport::Concern
-
-    include Spree::UserApiAuthentication
-  end
-end

data/app/models/spree/oauth_access_grant.rb

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

data/app/models/spree/oauth_access_token.rb

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

data/app/models/spree/oauth_application.rb

@@ -1,22 +0,0 @@
-module Spree
-  class OauthApplication < Spree.base_class
-    include ::Doorkeeper::Orm::ActiveRecord::Mixins::Application
-
-    self.table_name = 'spree_oauth_applications'
-
-    before_validation :set_blank_for_redirect_uri
-
-    # returns the last someone used this application
-    #
-    # @return [DateTime]
-    def last_used_at
-      access_tokens.order(:created_at).last&.created_at
-    end
-
-    private
-
-    def set_blank_for_redirect_uri
-      self.redirect_uri = '' if redirect_uri.nil?
-    end
-  end
-end

data/app/paginators/spree/api/paginate.rb

@@ -1,68 +0,0 @@
-require 'pagy'
-
-module Spree
-  module Api
-    class Paginate
-      include Pagy::Method
-
-      def initialize(collection, params)
-        @collection = collection
-        @params = params
-
-        per_page_limit = Spree::Api::Config[:api_v2_per_page_limit]
-        @per_page = if params[:per_page].to_i.between?(1, per_page_limit)
-                      params[:per_page].to_i
-                    else
-                      25
-                    end
-      end
-
-      def call
-        # Pass params as a hash-based request object for Pagy
-        # Pagy::Request accepts a hash with :params key
-        # Use to_unsafe_h for ActionController::Parameters, fallback to to_h for regular hashes
-        params_hash = @params.respond_to?(:to_unsafe_h) ? @params.to_unsafe_h : @params.to_h
-        request_hash = { params: params_hash }
-
-        # Uses countish paginator which is faster as it avoids COUNT queries
-        pagy, records = pagy(:countish, @collection, limit: @per_page, request: request_hash)
-
-        PagyCollection.new(records, pagy)
-      end
-    end
-
-    # Wrapper providing Kaminari-compatible interface for CollectionOptionsHelpers
-    # Includes Enumerable so jsonapi-serializer detects it as a collection
-    class PagyCollection < SimpleDelegator
-      include Enumerable
-
-      attr_reader :pagy
-
-      def initialize(records, pagy)
-        super(records)
-        @pagy = pagy
-      end
-
-      # Enumerable requires #each to be defined
-      def each(&block)
-        __getobj__.each(&block)
-      end
-
-      def next_page
-        @pagy.next
-      end
-
-      def prev_page
-        @pagy.previous
-      end
-
-      def total_pages
-        @pagy.pages
-      end
-
-      def total_count
-        @pagy.count
-      end
-    end
-  end
-end

data/app/presenters/spree/api/products/filters_presenter.rb

@@ -1,39 +0,0 @@
-module Spree
-  module Api
-    module Products
-      class FiltersPresenter
-        def initialize(current_store, current_currency, params)
-          @products_for_filters = find_products_for_filters(current_store, current_currency, params)
-        end
-
-        def to_h
-          option_values = Spree::OptionValues::FindAvailable.new(products_scope: products_for_filters).execute
-          option_values_presenters = Spree::Filters::OptionsPresenter.new(option_values_scope: option_values).to_a
-          product_properties = Spree::ProductProperties::FindAvailable.new(products_scope: products_for_filters).execute
-          product_properties_presenters = Spree::Filters::PropertiesPresenter.new(product_properties_scope: product_properties).to_a
-          {
-            option_types: option_values_presenters.map(&:to_h),
-            product_properties: product_properties_presenters.map(&:to_h)
-          }
-        end
-
-        private
-
-        attr_reader :products_for_filters
-
-        def find_products_for_filters(current_store, current_currency, params)
-          current_taxons = find_current_taxons(current_store, params)
-          current_store.products.active(current_currency).in_taxons(current_taxons)
-        end
-
-        def find_current_taxons(current_store, params)
-          taxons_param = params.dig(:filter, :taxons)
-          return nil if taxons_param.nil? || taxons_param.to_s.blank?
-
-          taxon_ids = taxons_param.to_s.split(',')
-          current_store.taxons.where(id: taxon_ids)
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module ImageTransformationConcern
-        extend ActiveSupport::Concern
-
-        def self.included(base)
-          base.attribute :transformed_url do |image, params|
-            image.generate_url(size: params.dig(:image_transformation, :size))
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module PublicMetafieldsConcern
-        extend ActiveSupport::Concern
-
-        included do
-          has_many :metafields, serializer: Spree.api.storefront_metafield_serializer,
-                                record_type: :metafield,
-                                object_method_name: :public_metafields
-        end
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module ResourceSerializerConcern
-        extend ActiveSupport::Concern
-
-        def self.included(base)
-          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
-
-          metafield_enabled_resources = Spree::MetafieldDefinition.available_resources || []
-          if metafield_enabled_resources.map(&:name).include?(model_klazz.name) && model_klazz.method_defined?(:metafields)
-            base.has_many :metafields, serializer: Spree.api.platform_metafield_serializer,
-                                       record_type: :metafield,
-                                       object_method_name: :metafields
-          end
-        end
-
-        def self.display_getter_methods(model_klazz)
-          model_klazz.new.methods.find_all do |method_name|
-            next if method_name.to_s.start_with?('display_on')
-            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
-  end
-end

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

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module TaxonImageTransformationConcern
-        extend ActiveSupport::Concern
-
-        def self.included(base)
-          base.attribute :transformed_url do |image, params|
-            image.generate_url(size: params.dig(:taxon_image_transformation, :size))
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-module Spree
-  module Api
-    module V2
-      class BaseSerializer
-        include JSONAPI::Serializer
-
-        # to learn more about caching, please refer to:
-        # https://github.com/jsonapi-serializer/jsonapi-serializer#caching
-        # https://guides.rubyonrails.org/caching_with_rails.html#low-level-caching
-        cache_options(store: Rails.cache, namespace: 'jsonapi-serializer', expires_in: Spree::Api::Config[:api_v2_serializers_cache_ttl])
-
-        def self.record_cache_options(options, fieldset, include_list, params)
-          opts = options.dup
-
-          params_cache_key = params.map do |param|
-            value = param.last
-            next if param.nil? || value.nil?
-
-            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
-              value.to_s.downcase
-            end
-          end.compact.reject(&:blank?).join('-')
-
-          opts[:namespace] += "-#{params_cache_key}"
-
-          super(opts, fieldset, include_list, params)
-        end
-
-        def self.url_helpers
-          Rails.application.routes.url_helpers
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class AddressSerializer < BaseSerializer
-          include ResourceSerializerConcern
-
-          belongs_to :country, serializer: Spree.api.platform_country_serializer
-          belongs_to :state, serializer: Spree.api.platform_state_serializer
-          belongs_to :user, serializer: Spree.api.platform_user_serializer
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,11 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class AdminUserSerializer < UserSerializer
-          set_type :admin_user
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-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/base_serializer.rb

@@ -1,10 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class BaseSerializer < ::Spree::Api::V2::BaseSerializer
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-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

@@ -1,14 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class ClassificationSerializer < BaseSerializer
-          include ResourceSerializerConcern
-
-          belongs_to :product, serializer: Spree.api.platform_product_serializer
-          belongs_to :taxon, serializer: Spree.api.platform_taxon_serializer
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class CountrySerializer < BaseSerializer
-          include ResourceSerializerConcern
-
-          has_many :states, serializer: Spree.api.platform_state_serializer
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,17 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class CustomerReturnSerializer < BaseSerializer
-          include ResourceSerializerConcern
-
-          belongs_to :stock_location, serializer: Spree.api.platform_stock_location_serializer
-
-          has_many :reimbursements, serializer: Spree.api.platform_reimbursement_serializer
-          has_many :return_items, serializer: Spree.api.platform_return_item_serializer
-          has_many :return_authorizations, serializer: Spree.api.platform_return_authorization_serializer
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class DataFeedSerializer < BaseSerializer
-          set_type :data_feed
-
-          attributes :name, :type, :slug, :active
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,29 +0,0 @@
-module Spree
-  module Api
-    module V2
-      module Platform
-        class DigitalSerializer < BaseSerializer
-          set_type :digital
-
-          attribute :url do |digital|
-            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, serializer: Spree.api.platform_variant_serializer
-        end
-      end
-    end
-  end
-end