spree_api 3.6.6 → 3.7.0.rc1

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

@@ -0,0 +1,82 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class TaxonsController < ::Spree::Api::V2::BaseController
+          include Spree::Api::V2::CollectionOptionsHelpers
+
+          def index
+            render_serialized_payload { serialize_collection(paginated_collection) }
+          end
+
+          def show
+            render_serialized_payload { serialize_resource(resource) }
+          end
+
+          private
+
+          def serialize_collection(collection)
+            dependencies[:collection_serializer].new(
+              collection,
+              collection_options(collection)
+            ).serializable_hash
+          end
+
+          def serialize_resource(resource)
+            dependencies[:resource_serializer].new(
+              resource,
+              include: resource_includes,
+              fields: sparse_fields
+            ).serializable_hash
+          end
+
+          def dependencies
+            {
+              collection_finder: Spree::Taxons::Find,
+              collection_paginator: Spree::Shared::Paginate,
+              collection_serializer: Spree::V2::Storefront::TaxonSerializer,
+              resource_serializer: Spree::V2::Storefront::TaxonSerializer
+            }
+          end
+
+          def collection_options(collection)
+            {
+              links: collection_links(collection),
+              meta: collection_meta(collection),
+              include: resource_includes,
+              fields: sparse_fields
+            }
+          end
+
+          def paginated_collection
+            dependencies[:collection_paginator].new(collection, params).call
+          end
+
+          def collection
+            dependencies[:collection_finder].new(scope: scope, params: params).execute
+          end
+
+          def resource
+            scope.find_by(permalink: params[:id]) || scope.find(params[:id])
+          end
+
+          def scope
+            Spree::Taxon.accessible_by(current_ability, :read).includes(scope_includes)
+          end
+
+          def scope_includes
+            node_includes = %i[icon products parent taxonomy]
+
+            {
+              parent: node_includes,
+              children: node_includes,
+              taxonomy: [root: node_includes],
+              products: [],
+              icon: []
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/spree/api/api_helpers.rb

@@ -177,7 +177,7 @@ module Spree
       ]
 
       def variant_attributes
-        if @current_user_roles && @current_user_roles.include?('admin')
+        if @current_user_roles&.include?('admin')
           @@variant_attributes + [:cost_price]
         else
           @@variant_attributes

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

@@ -0,0 +1,37 @@
+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, :fields, filter: {})
+        end
+
+        private
+
+        def pagination_url(page)
+          url_for(collection_permitted_params.merge(page: page))
+        end
+      end
+    end
+  end
+end

data/app/models/doorkeeper/access_grant_decorator.rb

@@ -0,0 +1,3 @@
+Doorkeeper::AccessGrant.class_eval do
+  self.table_name = 'spree_oauth_access_grants'
+end

data/app/models/doorkeeper/access_token_decorator.rb

@@ -0,0 +1,3 @@
+Doorkeeper::AccessToken.class_eval do
+  self.table_name = 'spree_oauth_access_tokens'
+end

data/app/models/doorkeeper/application_decorator.rb

@@ -0,0 +1,3 @@
+Doorkeeper::Application.class_eval do
+  self.table_name = 'spree_oauth_applications'
+end

data/app/serializers/spree/v2/storefront/account/credit_card_serializer.rb

@@ -0,0 +1,16 @@
+module Spree
+  module V2
+    module Storefront
+      module Account
+        class CreditCardSerializer < BaseSerializer
+          set_type :credit_card
+
+          attributes :cc_type, :last_digits, :month, :year, :name
+
+          belongs_to :payment_method,
+                     serializer: Spree::V2::Storefront::PaymentMethodSerializer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Spree
+  module V2
+    module Storefront
+      class AccountSerializer < BaseSerializer
+        set_type :user
+
+        attributes :email
+
+        attribute :store_credits, &:total_available_store_credit
+
+        attribute :completed_orders do |object|
+          object.orders.complete.count
+        end
+
+        has_one :default_billing_address,
+          id_method_name: :bill_address_id,
+          object_method_name: :bill_address,
+          record_type: :address,
+          serializer: :address
+
+        has_one :default_shipping_address,
+          id_method_name: :ship_address_id,
+          object_method_name: :ship_address,
+          record_type: :address,
+          serializer: :address
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class AddressSerializer < BaseSerializer
+        set_type :address
+
+        attributes :firstname, :lastname, :address1, :address2, :city, :zipcode, :phone, :state_name,
+                   :company, :country_name, :country_iso3
+
+        attribute :state_code, &:state_abbr
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Spree
+  module V2
+    module Storefront
+      class BaseSerializer
+        include FastJsonapi::ObjectSerializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Spree
+  module V2
+    module Storefront
+      class CartSerializer < BaseSerializer
+        set_type :cart
+
+        attributes :number, :item_total, :total, :ship_total, :adjustment_total, :created_at,
+                   :updated_at, :included_tax_total, :additional_tax_total, :display_additional_tax_total,
+                   :display_included_tax_total, :tax_total, :currency, :state, :token, :email,
+                   :display_item_total, :display_ship_total, :display_adjustment_total, :display_tax_total,
+                   :promo_total, :display_promo_total, :item_count, :special_instructions, :display_total
+
+        has_many   :line_items
+        has_many   :variants
+        has_many   :promotions, id_method_name: :promotion_id do |cart|
+          # we only want to display applied and valid promotions
+          # sometimes Order can have multiple promotions but the promo engine
+          # will only apply those that are more beneficial for the customer
+          # TODO: we should probably move this code out of the serializer
+          promotion_ids = cart.all_adjustments.eligible.nonzero.promotion.map { |a| a.source.promotion_id }.uniq
+
+          cart.order_promotions.where(promotion_id: promotion_ids).uniq(&:promotion_id)
+        end
+        has_many   :payments do |cart|
+          cart.payments.valid
+        end
+        has_many   :shipments
+
+        belongs_to :user
+        belongs_to :billing_address,
+          id_method_name: :bill_address_id,
+          serializer: :address
+
+        belongs_to :shipping_address,
+          id_method_name: :ship_address_id,
+          serializer: :address
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module V2
+    module Storefront
+      class CountrySerializer < BaseSerializer
+        set_type :country
+
+        attributes :iso, :iso3, :iso_name, :name, :states_required,
+                   :zipcode_required
+
+        attribute :default do |object|
+          object.default?
+        end
+
+        has_many :states, if: proc { |_record, params| params && params[:include_states] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class ImageSerializer < BaseSerializer
+        set_type :image
+
+        attributes :viewable_type, :viewable_id, :styles
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module V2
+    module Storefront
+      class LineItemSerializer < BaseSerializer
+        set_type   :line_item
+
+        attributes :name, :quantity, :price, :slug, :options_text, :currency,
+                   :display_price, :total, :display_total, :adjustment_total,
+                   :display_adjustment_total, :additional_tax_total,
+                   :display_additional_tax_total, :promo_total, :display_promo_total,
+                   :included_tax_total, :display_included_tax_total
+
+        belongs_to :variant
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module V2
+    module Storefront
+      class OptionTypeSerializer < BaseSerializer
+        set_type   :option_type
+
+        attributes :id, :name, :presentation, :position
+
+        has_many   :option_values
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class OptionValueSerializer < BaseSerializer
+        set_type   :option_value
+
+        attributes :id, :name, :presentation, :position
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class PaymentMethodSerializer < BaseSerializer
+        set_type :payment_method
+
+        attributes :type, :name, :description
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module V2
+    module Storefront
+      class PaymentSerializer < BaseSerializer
+        set_type :payment
+
+        attributes :amount, :response_code, :number, :cvv_response_code, :cvv_response_message,
+                   :payment_method_id, :payment_method_name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class ProductPropertySerializer < BaseSerializer
+        set_type  :product_property
+
+        attribute :value
+
+        attribute :name,        &:property_name
+        attribute :description, &:property_presentation
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Spree
+  module V2
+    module Storefront
+      class ProductSerializer < BaseSerializer
+        set_type :product
+
+        attributes :name, :description, :price, :currency, :display_price,
+                   :available_on, :slug, :meta_description, :meta_keywords,
+                   :updated_at
+
+        attribute :purchasable,   &:purchasable?
+        attribute :in_stock,      &:in_stock?
+        attribute :backorderable, &:backorderable?
+
+        has_many :variants
+        has_many :option_types
+        has_many :product_properties
+        has_many :taxons
+
+        # 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  module V2
+    module Storefront
+      class PromotionSerializer < BaseSerializer
+        set_id     :promotion_id
+        set_type   :promotion
+
+        attributes :name, :description, :amount, :display_amount, :code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module V2
+    module Storefront
+      class ShipmentSerializer < BaseSerializer
+        set_type :shipment
+
+        attributes :number, :final_price, :display_final_price,
+                   :state, :shipped_at, :tracking_url
+
+        attribute :free, &:free?
+
+        has_many :shipping_rates, if: proc { |_record, params| params&.dig(:show_rates) }
+      end
+    end
+  end
+end