spree_api 4.2.4 → 4.3.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398e606a4fa385f695dcae2d670fd962b8f89bf70ea3dee71d8f3c51ba570509
-  data.tar.gz: 63e8b6115082c93cf97a01517d4ccb87de04cb08a15139c64e10dab186505449
+  metadata.gz: 2bd9fd052b9bc9fd57cabf4fb28955081e4e3522aad98fe014641d46ca7b5c2c
+  data.tar.gz: f91442e429d34783f73dbc25806afa80ab0cbd5013c07c499c8b7da4bc5a29aa
 SHA512:
-  metadata.gz: 6cb3deff3d9592281640ed605a85bf33e47ecf992db9d78d54a242d4ab8fc081d7fcc7b98f2705317f8b22b9b36182609e8f046db46e7787b01c3bf8eeb3e07b
-  data.tar.gz: f6a6b2e292107eb33c8d0eabcd6cea61eb3f1b9f92785e5540f31e92d06bcc17d66520213f17465303cc6071d73facd7af28e29a1a7c13e0c705e945ba27c633
+  metadata.gz: dcc5d4344630b798bb0ea424285c89267ec2034d2a2f2fb483686c17670793b13fb23499a10aec1c579a3c807cd995b2b6b9f6c33ba68cfe4da9883b57de017f
+  data.tar.gz: c9d7016ddc08b9d26a438b46a5374d1c229e90e51cb2bace94c4f616c647d13d37eecd913c10ed80126508e25b23d5054032f1bd4ef349098c2caa8fc8869ae6

data/Rakefile

@@ -3,7 +3,6 @@ require 'rake'
 require 'rake/testtask'
 require 'rspec/core/rake_task'
 require 'spree/testing_support/common_rake'
-require 'rails/all'
 
 RSpec::Core::RakeTask.new
 
@@ -14,3 +13,17 @@ task :test_app do
   ENV['LIB_NAME'] = 'spree/api'
   Rake::Task['common:test_app'].invoke
 end
+
+namespace :rswag do
+  namespace :specs do
+    desc 'Generate Swagger JSON files from integration specs'
+    RSpec::Core::RakeTask.new('swaggerize') do |t|
+      t.pattern = ENV.fetch(
+        'PATTERN',
+        'spec/integration/**/*_spec.rb'
+      )
+
+      t.rspec_opts = ['--format Rswag::Specs::SwaggerFormatter', '--order defined']
+    end
+  end
+end

data/app/controllers/concerns/spree/api/v2/caching.rb

@@ -0,0 +1,33 @@
+module Spree
+  module Api
+    module V2
+      module Caching
+        extend ActiveSupport::Concern
+
+        def collection_cache_key(collection)
+          unscoped_collection = collection.unscope(:includes).unscope(:order)
+          cache_key_parts = [
+            self.class.to_s,
+            unscoped_collection.maximum(:updated_at),
+            unscoped_collection.ids,
+            resource_includes,
+            sparse_fields,
+            serializer_params,
+            params[:sort]&.strip,
+            params[:page]&.to_s&.strip,
+            params[:per_page]&.to_s&.strip,
+          ].flatten.join('-')
+
+          Digest::MD5.hexdigest(cache_key_parts)
+        end
+
+        def collection_cache_opts
+          {
+            namespace: Spree::Api::Config[:api_v2_collection_cache_namespace],
+            expires_in: Spree::Api::Config[:api_v2_collection_cache_ttl],
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/spree/api/v2/product_list_includes.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Api
+    module V2
+      module ProductListIncludes
+        def product_list_includes
+          variant_includes = {
+            prices: [],
+            option_values: :option_type,
+            images: []
+          }
+
+          {
+            product_properties: [],
+            option_types: [],
+            variant_images: [],
+            master: variant_includes,
+            variants: variant_includes
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -9,9 +9,10 @@ module Spree
             product_id: params[:product_id],
             taxon_id: params[:taxon_id]
           )
-          # Because position we get back is 0-indexed.
-          # acts_as_list is 1-indexed.
-          classification.insert_at(params[:position].to_i + 1)
+          Spree::Dependencies.classification_reposition_service.constantize.call(
+            classification: classification,
+            position: params[:position]
+          )
           head :ok
         end
       end

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

@@ -56,7 +56,7 @@ module Spree
 
         def empty
           authorize! :update, @order, order_token
-          @order.empty!
+          cart_empty_service.call(order: @order)
           render plain: nil, status: 204
         end
 
@@ -150,6 +150,10 @@ module Spree
         def order_id
           super || params[:id]
         end
+
+        def cart_empty_service
+          Spree::Dependencies.cart_empty_service.constantize
+        end
       end
     end
   end

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

@@ -64,7 +64,7 @@ module Spree
           params[:product][:available_on] ||= Time.current
           set_up_shipping_category
 
-          options = { variants_attrs: variants_params, options_attrs: option_types_params }
+          options = { store: current_store, variants_attrs: variants_params, options_attrs: option_types_params }
           @product = Core::Importer::Product.new(nil, product_params, options).create
 
           if @product.persisted?
@@ -77,7 +77,7 @@ module Spree
         def update
           authorize! :update, @product
 
-          options = { variants_attrs: variants_params, options_attrs: option_types_params }
+          options = { store: current_store, variants_attrs: variants_params, options_attrs: option_types_params }
           @product = Core::Importer::Product.new(@product, product_params, options).update
 
           if @product.errors.empty?

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

@@ -19,7 +19,7 @@ module Spree
 
         def create
           authorize! :create, Taxonomy
-          @taxonomy = Taxonomy.new(taxonomy_params)
+          @taxonomy = current_store.taxonomies.new(taxonomy_params)
           if @taxonomy.save
             respond_with(@taxonomy, status: 201, default_template: :show)
           else

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

@@ -7,8 +7,10 @@ module Spree
         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 Doorkeeper::Errors::DoorkeeperError, with: :access_denied_401
         rescue_from Spree::Core::GatewayError, with: :gateway_error
         rescue_from ActionController::ParameterMissing, with: :error_during_processing
         if defined?(JSONAPI::Serializer::UnsupportedIncludeError)
@@ -39,7 +41,7 @@ module Spree
         end
 
         def paginated_collection
-          collection_paginator.new(sorted_collection, params).call
+          @paginated_collection ||= collection_paginator.new(sorted_collection, params).call
         end
 
         def collection_paginator
@@ -51,10 +53,22 @@ module Spree
         end
 
         def render_error_payload(error, status = 422)
-          if error.is_a?(Struct)
-            render json: { error: error.to_s, errors: error.to_h }, status: status, content_type: content_type
-          elsif error.is_a?(String)
-            render json: { error: error }, status: status, content_type: content_type
+          json = if error.is_a?(ActiveModel::Errors)
+                   { error: error.full_messages.to_sentence, errors: error.messages }
+                 elsif error.is_a?(Struct)
+                   { error: error.to_s, errors: error.to_h }
+                 else
+                   { error: error }
+                 end
+
+          render json: json, status: status, content_type: content_type
+        end
+
+        def render_result(result)
+          if result.success?
+            render_serialized_payload { serialize_resource(result.value) }
+          else
+            render_error_payload(result.error)
           end
         end
 
@@ -114,7 +128,14 @@ module Spree
         end
 
         def serializer_params
-          { currency: current_currency, store: current_store, user: spree_current_user }
+          {
+            currency: current_currency,
+            locale: current_locale,
+            store: current_store,
+            user: spree_current_user,
+            image_transformation: params[:image_transformation],
+            taxon_image_transformation: params[:taxon_image_transformation]
+          }
         end
 
         def record_not_found
@@ -125,6 +146,10 @@ module Spree
           render_error_payload(exception.message, 403)
         end
 
+        def access_denied_401(exception)
+          render_error_payload(exception.message, 401)
+        end
+
         def gateway_error(exception)
           render_error_payload(exception.message)
         end

data/app/controllers/spree/api/v2/platform/addresses_controller.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AddressesController < ResourceController
+          private
+
+          def model_class
+            Spree::Address
+          end
+
+          def scope_includes
+            [:country, :state, :user]
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/classifications_controller.rb

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class ClassificationsController < ResourceController
+          before_action -> { doorkeeper_authorize! :write, :admin }, only: WRITE_ACTIONS << :reposition
+
+          def reposition
+            spree_authorize! :update, resource if spree_current_user.present?
+
+            result = classification_reposition_service.call(
+              classification: resource,
+              position: permitted_resource_params[:position]
+            )
+
+            if result.success?
+              render_serialized_payload { serialize_resource(result.value) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          private
+
+          def model_class
+            Spree::Classification
+          end
+
+          def scope_includes
+            [
+              taxon: [],
+              product: [:variants_including_master, :variant_images, :master, variants: [:prices]]
+            ]
+          end
+
+          def classification_reposition_service
+            Spree::Dependencies.classification_reposition_service.constantize
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/cms_pages_controller.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsPagesController < ResourceController
+          private
+
+          def model_class
+            Spree::CmsPage
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/cms_sections_controller.rb

@@ -0,0 +1,34 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CmsSectionsController < ResourceController
+          before_action -> { doorkeeper_authorize! :write, :admin }, only: WRITE_ACTIONS << :reposition
+
+          def reposition
+            spree_authorize! :update, @moved_section if spree_current_user.present?
+
+            @moved_section = scope.find(params[:section_id])
+            new_index = params[:new_position_idx].to_i + 1
+
+            if @moved_section && new_index
+              @moved_section.set_list_position(new_index)
+            else
+              head :bad_request
+            end
+
+            if @moved_section.save
+              head :no_content
+            end
+          end
+
+          private
+
+          def model_class
+            Spree::CmsSection
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/countries_controller.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class CountriesController < ResourceController
+          private
+
+          def model_class
+            Spree::Country
+          end
+
+          def scope_includes
+            [:states, :zones]
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/menu_items_controller.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class MenuItemsController < ResourceController
+          before_action -> { doorkeeper_authorize! :write, :admin }, only: WRITE_ACTIONS << :reposition
+
+          def reposition
+            spree_authorize! :update, @moved_item if spree_current_user.present?
+
+            @moved_item = scope.find(params[:id])
+            @new_parent = scope.find(params[:new_parent_id])
+            new_index = params[:new_position_idx].to_i
+
+            if @moved_item && @new_parent && new_index
+              @moved_item.move_to_child_with_index(@new_parent, new_index)
+            else
+              head :bad_request
+            end
+
+            if @moved_item.save
+              render_serialized_payload { serialize_resource(resource) }
+            end
+          end
+
+          private
+
+          def model_class
+            Spree::MenuItem
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/menus_controller.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class MenusController < ResourceController
+          private
+
+          def model_class
+            Spree::Menu
+          end
+
+          def scope_includes
+            [:menu_items]
+          end
+
+          def scope
+            current_store.menus
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/platform/option_types_controller.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class OptionTypesController < ResourceController
+          private
+
+          def model_class
+            Spree::OptionType
+          end
+        end
+      end
+    end
+  end
+end