spree_api 4.3.0 → 4.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 700721bfeb78aa6977d43dc85580aed316002b12e2f909a89bbe5ff334d425f9
-  data.tar.gz: f3b7d4ad9f7311210b44952d5778988a788ccd87d3f9cac2f83d1b99c55450bb
+  metadata.gz: c32fc06464c859dafea05de9d4786294a850a1ce7e724f9bb413c781455ef4ca
+  data.tar.gz: 52a87aa1158ea496f713f6f08e0cbe03698b6d557387b99b8be9ae4e91b2b78b
 SHA512:
-  metadata.gz: c0ab5fba7a140b1d87ba247c9a0cbf0e7a8d65b1b1a95de956f0a4d6fb84dafbf7294f2b63928182a31bd1dac80a525277c455dcc5c7feeeb3345ea69108e436
-  data.tar.gz: 33ec8fcad7aca3e1b65b19aeb9661cf1e85db2ce36387fc5eee9916ca99bdf4ddd8be5b8b3e1c423713b75f49630056c5109766a39e63e82917e6205541f4688
+  metadata.gz: e1e410a834e2126791fbe193ec7f2c76703dc03e78d525599e3efeb736f9db1becb7f530dead45485190b5c29e03d58c29853458a117d09600a1e267145246cb
+  data.tar.gz: 87bca09a460287bc66aa342e3bbfe649c96e23e617fb954de72c295dd621036063e23a9941750fc106e5dedf2740b6e2dbb7dc41a9869cfbed55524806bf30b8

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

@@ -5,11 +5,15 @@ module Spree
         extend ActiveSupport::Concern
 
         def collection_cache_key(collection)
-          unscoped_collection = collection.unscope(:includes).unscope(:order)
+          ids_and_timestamps = collection.unscope(:includes).unscope(:order).pluck(:id, :updated_at)
+
+          ids = ids_and_timestamps.map(&:first)
+          max_updated_at = ids_and_timestamps.map(&:last).max
+
           cache_key_parts = [
             self.class.to_s,
-            unscoped_collection.maximum(:updated_at),
-            unscoped_collection.ids,
+            max_updated_at,
+            ids,
             resource_includes,
             sparse_fields,
             serializer_params,

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

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V2
+      module CouponCodesHelper
+        def select_coupon_codes
+          params[:coupon_code].present? ? [params[:coupon_code]] : check_coupon_codes
+        end
+
+        def check_coupon_codes
+          spree_current_order.promotions.coupons.map(&:code)
+        end
+
+        def select_error(coupon_codes)
+          result = coupon_handler.new(spree_current_order).remove(coupon_codes.first)
+          result.error
+        end
+
+        def select_errors(coupon_codes)
+          results = []
+          coupon_codes.each do |coupon_code|
+            results << coupon_handler.new(spree_current_order).remove(coupon_code)
+          end
+
+          results.select(&:error)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module NumberResource
+        def resource
+          @resource ||= scope.find_by(number: params[:id]) || scope.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/spree/api/v2/platform/nested_set_reposition_concern.rb

@@ -0,0 +1,37 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        module NestedSetRepositionConcern
+          def reposition
+            spree_authorize! :update, resource if spree_current_user.present?
+
+            @new_parent = scope.find(permitted_resource_params[:new_parent_id])
+            new_index = permitted_resource_params[:new_position_idx].to_i
+
+            if resource.move_to_child_with_index(@new_parent, new_index)
+              # If successful reposition call the custom method for handling success.
+              successful_reposition_actions
+            elsif resource.errors.any?
+              # If there are errors output them to the response
+              render_error_payload(resource.errors.full_messages.to_sentence)
+            else
+              # If the user drops the re-positioned item in the same location it came from
+              # we just render the serialized payload, nothing has changed, we don't need to
+              # render any errors, or fire any custom success methods.
+              render_serialized_payload { serialize_resource(resource) }
+            end
+          end
+
+          private
+
+          def successful_reposition_actions
+            # Call a separate method for a successful reposition so this can be easily overridden
+            # if a more complex set of events need to occur after a successful reposition.
+            render_serialized_payload { serialize_resource(resource) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/spree/api/v2/platform/promotion_calculator_params.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        module PromotionCalculatorParams
+          private
+
+          def calculator_params
+            [:preferred_flat_percent, :preferred_amount, :preferred_first_item, :preferred_additional_item,
+             :preferred_max_items, :preferred_percent, :preferred_minimal_amount, :preferred_normal_amount,
+             :preferred_discount_amount, :preferred_currency, :preferred_base_amount, :preferred_base_percent, { preferred_tiers: {} }]
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/spree/api/v2/platform/promotion_rule_params.rb

@@ -0,0 +1,16 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        module PromotionRuleParams
+          private
+
+          def rule_params
+            [:preferred_match_policy, :preferred_country_id, :preferred_amount_min, :preferred_operator_min, :preferred_amount_max,
+             :preferred_operator_max, { taxon_ids: [], user_ids: [], product_ids: [], preferred_eligible_values: {} }]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        module MetadataControllerConcern
+          protected
+
+          def ensure_valid_metadata
+            if params[:public_metadata].present? && !params[:public_metadata].is_a?(ActionController::Parameters) ||
+                params[:private_metadata].present? && !params[:private_metadata].is_a?(ActionController::Parameters)
+              render_error_payload(I18n.t(:invalid_params, scope: 'spree.api.v2.metadata'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -47,7 +47,7 @@ module Spree
           params[:order][:user_id] if params[:order]
         end
 
-        # Should be overriden if you have areas of your checkout that don't match
+        # Should be overridden if you have areas of your checkout that don't match
         # up to a step within checkout_steps, such as a registration step
         def skip_state_validation?
           false

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

@@ -64,9 +64,9 @@ module Spree
           render json: json, status: status, content_type: content_type
         end
 
-        def render_result(result)
+        def render_result(result, ok_status = 200)
           if result.success?
-            render_serialized_payload { serialize_resource(result.value) }
+            render_serialized_payload(ok_status) { serialize_resource(result.value) }
           else
             render_error_payload(result.error)
           end
@@ -78,7 +78,7 @@ module Spree
 
           doorkeeper_authorize!
 
-          @spree_current_user ||= Spree.user_class.find_by(id: doorkeeper_token.resource_owner_id)
+          @spree_current_user ||= doorkeeper_token.resource_owner
         end
 
         def spree_authorize!(action, subject, *args)
@@ -89,13 +89,13 @@ module Spree
           raise CanCan::AccessDenied if spree_current_user.nil?
         end
 
-        # Needs to be overriden so that we use Spree's Ability rather than anyone else's.
+        # Needs to be overridden so that we use Spree's Ability rather than anyone else's.
         def current_ability
           @current_ability ||= Spree::Dependencies.ability_class.constantize.new(spree_current_user)
         end
 
         def request_includes
-          # if API user want's to receive only the bare-minimum
+          # if API user wants to receive only the bare-minimum
           # the API will return only the main resource without any included
           if params[:include]&.blank?
             []
@@ -131,6 +131,7 @@ module Spree
           {
             currency: current_currency,
             locale: current_locale,
+            price_options: current_price_options,
             store: current_store,
             user: spree_current_user,
             image_transformation: params[:image_transformation],

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class AdjustmentsController < ResourceController
+          private
+
+          def model_class
+            Spree::Adjustment
+          end
+
+          def scope_includes
+            [:order, :adjustable]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,23 +3,6 @@ module Spree
     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
@@ -29,13 +12,9 @@ module Spree
           def scope_includes
             [
               taxon: [],
-              product: [:variants_including_master, :variant_images, :master, variants: [:prices]]
+              product: [:variants_including_master, :variant_images, :master, { variants: [:prices] }]
             ]
           end
-
-          def classification_reposition_service
-            Spree::Dependencies.classification_reposition_service.constantize
-          end
         end
       end
     end

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

@@ -8,6 +8,10 @@ module Spree
           def model_class
             Spree::CmsPage
           end
+
+          def scope_includes
+            [:cms_sections]
+          end
         end
       end
     end

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

@@ -3,29 +3,24 @@ module Spree
     module V2
       module Platform
         class CmsSectionsController < ResourceController
-          before_action -> { doorkeeper_authorize! :write, :admin }, only: WRITE_ACTIONS << :reposition
+          private
 
-          def reposition
-            spree_authorize! :update, @moved_section if spree_current_user.present?
+          def model_class
+            Spree::CmsSection
+          end
 
-            @moved_section = scope.find(params[:section_id])
-            new_index = params[:new_position_idx].to_i + 1
+          def spree_permitted_attributes
+            stored_attributes = []
 
-            if @moved_section && new_index
-              @moved_section.set_list_position(new_index)
-            else
-              head :bad_request
+            Spree::CmsSection::TYPES.each do |type|
+              type.constantize.stored_attributes.each do |_name, values|
+                values.each do |value|
+                  stored_attributes << value
+                end
+              end
             end
 
-            if @moved_section.save
-              head :no_content
-            end
-          end
-
-          private
-
-          def model_class
-            Spree::CmsSection
+            super + stored_attributes.compact.uniq!
           end
         end
       end

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

@@ -0,0 +1,25 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalLinksController < ResourceController
+          def reset
+            spree_authorize! :update, resource if spree_current_user.present?
+
+            if resource.reset!
+              render_serialized_payload { serialize_resource(resource) }
+            else
+              render_error_payload(resource.errors)
+            end
+          end
+
+          private
+
+          def model_class
+            Spree::DigitalLink
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class DigitalsController < ResourceController
+          private
+
+          def model_class
+            Spree::Digital
+          end
+
+          def spree_permitted_attributes
+            super + [:attachment]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class LineItemsController < ResourceController
+          def create
+            order = current_store.orders.find(permitted_resource_params[:order_id])
+
+            result = create_service.call(order: order, line_item_attributes: permitted_resource_params)
+
+            if result.success?
+              render_serialized_payload(201) { serialize_resource(result.value) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          def update
+            result = update_service.call(line_item: resource, line_item_attributes: permitted_resource_params)
+
+            if result.success?
+              render_serialized_payload { serialize_resource(result.value) }
+            else
+              render_error_payload(resource.errors)
+            end
+          end
+
+          def destroy
+            result = destroy_service.call(line_item: resource)
+
+            if result.success?
+              head 204
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          private
+
+          def model_class
+            Spree::LineItem
+          end
+
+          def create_service
+            Spree::Api::Dependencies.platform_line_item_create_service.constantize
+          end
+
+          def update_service
+            Spree::Api::Dependencies.platform_line_item_update_service.constantize
+          end
+
+          def destroy_service
+            Spree::Api::Dependencies.platform_line_item_destroy_service.constantize
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,31 +3,17 @@ module Spree
     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
+          include ::Spree::Api::V2::Platform::NestedSetRepositionConcern
 
           private
 
           def model_class
             Spree::MenuItem
           end
+
+          def spree_permitted_attributes
+            super + [:new_parent_id, :new_position_idx]
+          end
         end
       end
     end

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

@@ -12,10 +12,6 @@ module Spree
           def scope_includes
             [:menu_items]
           end
-
-          def scope
-            current_store.menus
-          end
         end
       end
     end

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

@@ -0,0 +1,163 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class OrdersController < ResourceController
+          include CouponCodesHelper
+          include NumberResource
+
+          def create
+            resource = current_store.orders.new(permitted_resource_params)
+
+            if resource.save
+              render_serialized_payload(201) { serialize_resource(resource) }
+            else
+              render_error_payload(resource.errors)
+            end
+          end
+
+          def update
+            result = update_service.call(
+              order: resource,
+              params: params,
+              permitted_attributes: spree_permitted_attributes,
+              request_env: request.headers.env
+            )
+
+            render_result(result)
+          end
+
+          def next
+            result = next_service.call(order: resource)
+
+            render_result(result)
+          end
+
+          def advance
+            result = advance_service.call(order: resource)
+
+            render_result(result)
+          end
+
+          def complete
+            result = complete_service.call(order: resource)
+
+            render_result(result)
+          end
+
+          def empty
+            result = empty_service.call(order: resource)
+
+            render_result(result)
+          end
+
+          def cancel
+            result = cancel_service.call(order: resource, canceler: spree_current_user)
+
+            render_result(result)
+          end
+
+          def approve
+            result = approve_service.call(order: resource, approver: spree_current_user)
+
+            render_result(result)
+          end
+
+          def destroy
+            result = destroy_service.call(order: resource)
+
+            if result.success?
+              head 204
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          def apply_coupon_code
+            resource.coupon_code = params[:coupon_code]
+            result = coupon_handler.new(resource).apply
+
+            if result.error.blank?
+              render_serialized_payload { serialize_resource(resource.reload) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
+          def use_store_credit
+            result = use_store_credit_service.call(
+              order: resource,
+              amount: params[:amount].try(:to_f)
+            )
+
+            render_result(result)
+          end
+
+          private
+
+          def model_class
+            Spree::Order
+          end
+
+          def allowed_sort_attributes
+            super.push(:available_on, :total, :payment_total, :item_total, :shipment_total,
+                       :adjustment_total, :promo_total, :included_tax_total, :additional_tax_total,
+                       :item_count, :tax_total, :completed_at)
+          end
+
+          def update_service
+            Spree::Api::Dependencies.platform_order_update_service.constantize
+          end
+
+          def next_service
+            Spree::Api::Dependencies.platform_order_next_service.constantize
+          end
+
+          def advance_service
+            Spree::Api::Dependencies.platform_order_advance_service.constantize
+          end
+
+          def use_store_credit_service
+            Spree::Api::Dependencies.platform_order_use_store_credit_service.constantize
+          end
+
+          def complete_service
+            Spree::Api::Dependencies.platform_order_complete_service.constantize
+          end
+
+          def empty_service
+            Spree::Api::Dependencies.platform_order_empty_service.constantize
+          end
+
+          def destroy_service
+            Spree::Api::Dependencies.platform_order_destroy_service.constantize
+          end
+
+          def approve_service
+            Spree::Api::Dependencies.platform_order_approve_service.constantize
+          end
+
+          def cancel_service
+            Spree::Api::Dependencies.platform_order_cancel_service.constantize
+          end
+
+          def coupon_handler
+            Spree::Api::Dependencies.platform_coupon_handler.constantize
+          end
+
+          def spree_permitted_attributes
+            super + [
+              bill_address_attributes: Spree::Address.json_api_permitted_attributes,
+              ship_address_attributes: Spree::Address.json_api_permitted_attributes,
+              line_items_attributes: Spree::LineItem.json_api_permitted_attributes,
+              payments_attributes: Spree::Payment.json_api_permitted_attributes + [
+                source_attributes: Spree::CreditCard.json_api_permitted_attributes
+              ],
+              shipments_attributes: Spree::Shipment.json_api_permitted_attributes
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module V2
+      module Platform
+        class PaymentMethodsController < ResourceController
+          private
+
+          def model_class
+            Spree::PaymentMethod
+          end
+
+          def spree_permitted_attributes
+            preferred_attributes = []
+
+            if action_name == 'update'
+              resource.defined_preferences.each do |preference|
+                preferred_attributes << "preferred_#{preference}".to_sym
+              end
+            end
+
+            super + preferred_attributes
+          end
+        end
+      end
+    end
+  end
+end