spree_api 4.2.0.rc4 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c7b8ebf1a65cf7fb7063b4811c8d6226298c6435b5fdb9a60fd0c9a0579567d
-  data.tar.gz: 33ab903daaec69fdcb23340146c6e78be7dc64dbe760d2885353518d977887d3
+  metadata.gz: 025ab26b6b25f6644f6acb3662cb7fcea7b215142234f49e06d425d20d0a14a5
+  data.tar.gz: b210a889a6e50e7de730a3c5241eeb8442b933394c1c4a7f637536d5771064c8
 SHA512:
-  metadata.gz: 4f108ec0840bcfdf1aa5f15a8cf7f1de53fc7420bc0d0fc93072786ce139f60afcf5506470dca75c32cfac4b70221b4a9858e8b0a528b643e3f411c892cd46c9
-  data.tar.gz: 75d052059dda3df22fd17236878a14b9ca9a07da5bb287b0df03c11ea347a02abadabf75e2f7f7da950cd9e8bfdb56e96294d0a14ec46049797a63a69da58711
+  metadata.gz: 360cce541d207d3e27f436b4ebd54cde72f7f0f0e9af96e1bb529763d596496958a596abcf9fced6dd7453278a3e76f3981199deb293a67b16ae649265d65371
+  data.tar.gz: 8e0a5c058d275b8409541d3d4e8141b35806ffe8215828e0c511348d71b850fe4d8232562c6b4496579152e1ed3c4dfa82061efb622a04d4cd7b909fb45fb62c

data/app/controllers/concerns/spree/api/v2/storefront/order_concern.rb

@@ -34,16 +34,16 @@ module Spree
             )
           end
 
-          def supported_currencies
-            current_store.supported_currencies_list
+          def serialized_current_order
+            serialize_resource(spree_current_order)
           end
 
           def serialize_order(order)
-            resource_serializer.new(order.reload, include: resource_includes, fields: sparse_fields).serializable_hash
-          end
-
-          def serialized_current_order
-            serialize_order(spree_current_order)
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              `OrderConcern#serialize_order` is deprecated and will be removed in Spree 5.0.
+              Please use `serializer_resource` method
+            DEPRECATION
+            serialize_resource(order)
           end
         end
       end

data/app/controllers/spree/api/base_controller.rb

@@ -6,6 +6,8 @@ module Spree
       include Spree::Api::ControllerSetup
       include Spree::Core::ControllerHelpers::Store
       include Spree::Core::ControllerHelpers::StrongParameters
+      include Spree::Core::ControllerHelpers::Locale
+      include Spree::Core::ControllerHelpers::Currency
 
       attr_accessor :current_api_user
 

data/app/controllers/spree/api/v1/taxons_controller.rb

@@ -37,7 +37,7 @@ module Spree
             invalid_resource!(@taxon) and return
           end
 
-          @taxon.parent_id = taxonomy.root.id unless params[:taxon][:parent_id]
+          @taxon.parent_id = taxonomy.root_id unless params[:taxon][:parent_id]
 
           if @taxon.save
             respond_with(@taxon, status: 201, default_template: :show)

data/app/controllers/spree/api/v2/base_controller.rb

@@ -5,20 +5,49 @@ module Spree
         include CanCan::ControllerAdditions
         include Spree::Core::ControllerHelpers::StrongParameters
         include Spree::Core::ControllerHelpers::Store
+        include Spree::Core::ControllerHelpers::Locale
+        include Spree::Core::ControllerHelpers::Currency
         rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
         rescue_from CanCan::AccessDenied, with: :access_denied
         rescue_from Spree::Core::GatewayError, with: :gateway_error
-
-        before_action :set_user_language
+        rescue_from ActionController::ParameterMissing, with: :error_during_processing
+        if defined?(JSONAPI::Serializer::UnsupportedIncludeError)
+          rescue_from JSONAPI::Serializer::UnsupportedIncludeError, with: :error_during_processing
+        end
+        rescue_from ArgumentError, with: :error_during_processing
 
         def content_type
           Spree::Api::Config[:api_v2_content_type]
         end
 
+        protected
+
+        def serialize_collection(collection)
+          collection_serializer.new(
+            collection,
+            collection_options(collection).merge(params: serializer_params)
+          ).serializable_hash
+        end
+
+        def serialize_resource(resource)
+          resource_serializer.new(
+            resource,
+            params: serializer_params,
+            include: resource_includes,
+            fields: sparse_fields
+          ).serializable_hash
+        end
+
+        def paginated_collection
+          collection_paginator.new(sorted_collection, params).call
+        end
+
+        def collection_paginator
+          Spree::Api::Dependencies.storefront_collection_paginator.constantize
+        end
+
         def render_serialized_payload(status = 200)
           render json: yield, status: status, content_type: content_type
-        rescue ArgumentError => exception
-          render_error_payload(exception.message, 400)
         end
 
         def render_error_payload(error, status = 422)
@@ -84,6 +113,10 @@ module Spree
           fields.presence
         end
 
+        def serializer_params
+          { currency: current_currency, store: current_store, user: spree_current_user }
+        end
+
         def record_not_found
           render_error_payload(I18n.t(:resource_not_found, scope: 'spree.api'), 404)
         end
@@ -96,8 +129,14 @@ module Spree
           render_error_payload(exception.message)
         end
 
-        def set_user_language
-          I18n.locale = current_store.default_locale
+        def error_during_processing(exception)
+          result = error_handler.call(exception: exception, opts: { user: spree_current_user })
+
+          render_error_payload(result.value[:message], 400)
+        end
+
+        def error_handler
+          Spree::Api::Dependencies.error_handler.constantize
         end
       end
     end

data/app/controllers/spree/api/v2/resource_controller.rb

@@ -14,29 +14,6 @@ module Spree
 
         protected
 
-        def serialize_collection(collection)
-          collection_serializer.new(
-            collection,
-            collection_options(collection)
-          ).serializable_hash
-        end
-
-        def serialize_resource(resource)
-          resource_serializer.new(
-            resource,
-            include: resource_includes,
-            fields: sparse_fields
-          ).serializable_hash
-        end
-
-        def paginated_collection
-          collection_paginator.new(sorted_collection, params).call
-        end
-
-        def collection_paginator
-          Spree::Api::Dependencies.storefront_collection_paginator.constantize
-        end
-
         def sorted_collection
           collection_sorter.new(collection, params, allowed_sort_attributes).call
         end

data/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb

@@ -7,21 +7,39 @@ module Spree
             before_action :require_spree_current_user
 
             def create
+              spree_authorize! :create, model_class
+
               result = create_service.call(user: spree_current_user, address_params: address_params)
               render_result(result)
             end
 
             def update
+              spree_authorize! :update, resource
+
               result = update_service.call(address: resource, address_params: address_params)
               render_result(result)
             end
 
+            def destroy
+              spree_authorize! :destroy, resource
+
+              if resource.destroy
+                head 204
+              else
+                render_error_payload(resource.errors)
+              end
+            end
+
             private
 
             def collection
               collection_finder.new(scope: scope, params: params).execute
             end
 
+            def scope
+              super.not_deleted
+            end
+
             def model_class
               Spree::Address
             end

data/app/controllers/spree/api/v2/storefront/account/credit_cards_controller.rb

@@ -12,6 +12,10 @@ module Spree
               Spree::CreditCard
             end
 
+            def scope
+              super.where(user: spree_current_user)
+            end
+
             def collection_serializer
               Spree::Api::Dependencies.storefront_credit_card_serializer.constantize
             end

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

@@ -19,7 +19,7 @@ module Spree
             order   = spree_current_order if spree_current_order.present?
             order ||= create_service.call(order_params).value
 
-            render_serialized_payload(201) { serialize_order(order) }
+            render_serialized_payload(201) { serialize_resource(order) }
           end
 
           def add_item

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

@@ -163,7 +163,7 @@ module Spree
         :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
         :mail_from_address, :customer_support_email, :default_currency,
         :code, :default, :facebook, :twitter, :instagram,
-        :supported_currencies
+        :supported_currencies, :default_locale, :supported_locales
       ]
 
       @@tag_attributes = [:id, :name]

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module V2
+      module DisplayMoneyHelper
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def find_price(product_or_variant, currency)
+            product_or_variant.price_in(currency)
+          end
+
+          def price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            format('%.2f', price.amount)
+          end
+
+          def display_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record?
+
+            Spree::Money.new(price.amount, currency: currency).to_s
+          end
+
+          def compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            format('%.2f', price.compare_at_amount)
+          end
+
+          def display_compare_at_price(product_or_variant, currency)
+            price = find_price(product_or_variant, currency)
+            return nil if price.new_record? || price.compare_at_amount.blank?
+
+            Spree::Money.new(price.compare_at_amount, currency: currency).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/api_configuration.rb

@@ -2,5 +2,6 @@ module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
     preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
+    preference :api_v2_per_page_limit, :integer, default: 100
   end
 end

data/app/models/spree/api_dependencies.rb

@@ -16,7 +16,7 @@ module Spree
       :storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
       :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
       :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,
-      :storefront_collection_sorter
+      :storefront_collection_sorter, :error_handler
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -86,6 +86,8 @@ module Spree
       @storefront_find_by_variant_finder = Spree::Dependencies.line_item_by_variant_finder
       @storefront_products_finder = Spree::Dependencies.products_finder
       @storefront_taxon_finder = Spree::Dependencies.taxon_finder
+
+      @error_handler = 'Spree::Api::ErrorHandler'
     end
   end
 end

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

@@ -2,11 +2,11 @@ module Spree
   module V2
     module Storefront
       class ProductSerializer < BaseSerializer
+        include ::Spree::Api::V2::DisplayMoneyHelper
+
         set_type :product
 
-        attributes :name, :description, :price, :currency, :display_price,
-                   :compare_at_price, :display_compare_at_price, :available_on,
-                   :slug, :meta_description, :meta_keywords, :updated_at
+        attributes :name, :description, :available_on, :slug, :meta_description, :meta_keywords, :updated_at
 
         attribute :purchasable do |product|
           product.purchasable?
@@ -24,6 +24,26 @@ module Spree
           product.available?
         end
 
+        attribute :currency do |_product, params|
+          params[:currency]
+        end
+
+        attribute :price do |product, params|
+          price(product, params[:currency])
+        end
+
+        attribute :display_price do |product, params|
+          display_price(product, params[:currency])
+        end
+
+        attribute :compare_at_price do |product, params|
+          compare_at_price(product, params[:currency])
+        end
+
+        attribute :display_compare_at_price do |product, params|
+          display_compare_at_price(product, params[:currency])
+        end
+
         has_many :variants
         has_many :option_types
         has_many :product_properties

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
+                   :address, :contact_phone, :supported_locales
 
         has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end

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

@@ -2,10 +2,11 @@ module Spree
   module V2
     module Storefront
       class VariantSerializer < BaseSerializer
+        include ::Spree::Api::V2::DisplayMoneyHelper
+
         set_type :variant
 
-        attributes :sku, :price, :currency, :display_price, :weight, :height,
-                   :width, :depth, :is_master, :options_text
+        attributes :sku, :weight, :height, :width, :depth, :is_master, :options_text
 
         attribute :purchasable do |variant|
           variant.purchasable?
@@ -19,6 +20,26 @@ module Spree
           variant.backorderable?
         end
 
+        attribute :currency do |_product, params|
+          params[:currency]
+        end
+
+        attribute :price do |product, params|
+          price(product, params[:currency])
+        end
+
+        attribute :display_price do |product, params|
+          display_price(product, params[:currency])
+        end
+
+        attribute :compare_at_price do |product, params|
+          compare_at_price(product, params[:currency])
+        end
+
+        attribute :display_compare_at_price do |product, params|
+          display_compare_at_price(product, params[:currency])
+        end
+
         belongs_to :product
         has_many :images
         has_many :option_values

data/app/services/spree/api/error_handler.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    class ErrorHandler
+      prepend ::Spree::ServiceModule::Base
+
+      def call(exception:, opts: {})
+        run :format_message
+        run :log_error
+        run :report_error
+      end
+
+      protected
+
+      def format_message(exception:, opts:)
+        message = if exception.respond_to?(:original_message)
+                    exception.original_message
+                  else
+                    exception.message
+                  end
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def log_error(exception:, message:, opts:)
+        Rails.logger.error message
+        Rails.logger.error "User ID: #{opts[:user]&.id}" if opts[:user]
+        Rails.logger.error exception.backtrace.join("\n")
+
+        success(exception: exception, message: message, opts: opts)
+      end
+
+      def report_error(exception:, message:, opts:)
+        # overwrite this method in your application to support different error handlers
+        # eg. Sentry, Rollbar, etc
+
+        success(exception: exception, message: message)
+      end
+    end
+  end
+end

data/config/initializers/doorkeeper.rb

@@ -3,11 +3,20 @@ Doorkeeper.configure do
   use_refresh_token
   api_only
 
+  skip_client_authentication_for_password_grant { true } if defined?(skip_client_authentication_for_password_grant)
+
   resource_owner_authenticator { current_spree_user }
 
   resource_owner_from_credentials do
     user = Spree.user_class.find_for_database_authentication(email: params[:username])
-    user if user&.valid_for_authentication? { user.valid_password?(params[:password]) }
+
+    next if user.nil?
+
+    if defined?(Spree::Auth::Config) && Spree::Auth::Config[:confirmable] == true
+      user if user.active_for_authentication? && user.valid_for_authentication? { user.valid_password?(params[:password]) }
+    elsif user&.valid_for_authentication? { user.valid_password?(params[:password]) }
+      user
+    end
   end
 
   admin_authenticator do |routes|

data/config/routes.rb

@@ -152,7 +152,7 @@ Spree::Core::Engine.add_routes do
         resource :account, controller: :account, only: %i[show]
 
         namespace :account do
-          resources :addresses, controller: :addresses, only: %i[index create update]
+          resources :addresses, controller: :addresses
           resources :credit_cards, controller: :credit_cards, only: %i[index show]
           resources :orders, controller: :orders, only: %i[index show]
         end

data/docs/v2/storefront/index.yaml

@@ -239,6 +239,21 @@ paths:
       security:
         - bearerAuth: []
   '/api/v2/storefront/account/addresses/{id}':
+    delete:
+      description: 'Removes selected Address for the signed in User. It uses soft-delete for addresses with shipments and orders.'
+      tags:
+        - Account
+      operationId: Remove Address
+      parameters:
+        - $ref: '#/components/parameters/AddressId'
+      responses:
+        '204':
+          description: Requested Address has been removed from the User Account
+        '404':
+          $ref: '#/components/responses/404NotFound'
+      security:
+        - bearerAuth: []
+      summary: Remove Address
     patch:
       description: >-
         Update selected Address for the signed in User
@@ -247,13 +262,7 @@ paths:
         - Account
       operationId: 'Update Address'
       parameters:
-        - name: id
-          in: path
-          required: true
-          description: Selected Address for update
-          schema:
-            type: string
-          example: '1'
+        - $ref: '#/components/parameters/AddressId'
       requestBody:
         required: true
         content:
@@ -5246,6 +5255,14 @@ components:
         - state_name
         - country_iso
   parameters:
+    AddressId:
+      name: address_id
+      in: path
+      required: true
+      description: Address ID
+      schema:
+        type: string
+      example: '1'
     CreditCardIncludeParam:
       name: include
       in: query

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.2.0.rc4
+  version: 4.2.3
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.rc4
+        version: 4.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.rc4
+        version: 4.2.3
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,7 @@ files:
 - app/controllers/spree/api/v2/storefront/taxons_controller.rb
 - app/helpers/spree/api/api_helpers.rb
 - app/helpers/spree/api/v2/collection_options_helpers.rb
+- app/helpers/spree/api/v2/display_money_helper.rb
 - app/models/concerns/spree/user_api_authentication.rb
 - app/models/concerns/spree/user_api_methods.rb
 - app/models/spree/api_configuration.rb
@@ -180,6 +181,7 @@ files:
 - app/serializers/spree/v2/storefront/taxonomy_serializer.rb
 - app/serializers/spree/v2/storefront/user_serializer.rb
 - app/serializers/spree/v2/storefront/variant_serializer.rb
+- app/services/spree/api/error_handler.rb
 - app/views/spree/api/errors/gateway_error.rabl
 - app/views/spree/api/errors/invalid_api_key.rabl
 - app/views/spree/api/errors/invalid_resource.rabl
@@ -308,9 +310,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0.rc4
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.3
   documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.rc4
+  source_code_uri: https://github.com/spree/spree/tree/v4.2.3
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -322,11 +324,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Spree's API