solidus_api 3.4.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70cc27fff9a0eac74ce650fa673db3869e48af365d630c64877c6e6112851422
-  data.tar.gz: 94b25a7f446671606fe0bcec5c2ef4e476885a84459be8c0a9fb3b1ad4e21e82
+  metadata.gz: 889a03ceedfdc041802ee129c1be2a2aba750d8d6501757f09ecc5cf26da2662
+  data.tar.gz: 912510a11207bda356602e8bf5d98780b95aaf88b556bfad714c1393392f3ada
 SHA512:
-  metadata.gz: 6c45c8fe1d0a855ed6687091b431197dab80a7913140aaf88e2038e662b2cec16e92993fc1aeb509564bd640c9203283354f7c0b90f1d56ed55544000ee880e2
-  data.tar.gz: 6581fa60379b0dceee93c27ced9102df3dd3e29d9d9d985372cd8ace7ce3a1eab29eb0ac6b3429197a3b90f3b416a86259cb45eb7fccb6dab80440c90f15e5a5
+  metadata.gz: 66890843cd4957ff345aec5ff633b28c5f7224d9171ec027062943ac0cdf2df43db1be12d861c73c5b5a6399330b62b5b70706791f097a09c0046e6ea99c3761
+  data.tar.gz: 9fd9b5e9c7d8e774f31637e62177662c9fb1c597e1a085ce7192c2b0d52001486a83ce63050fbc9ecb24b71fe2f6a68d6bd440501b8d970f345388e8ef76b484

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

@@ -69,14 +69,6 @@ module Spree
         return_items_params = customer_return_attributes.
           delete(:return_items_attributes)
 
-        if return_items_params.is_a? ActionController::Parameters
-          return_items_params = return_items_params.values
-          Spree::Deprecation.warn(
-            "Passing `return_items_attributes` as a hash of hashes is \
-deprecated and will be removed in future versions of Solidus."
-          )
-        end
-
         @customer_return = CustomerReturn.new(customer_return_attributes)
 
         @customer_return.return_items = return_items_params.map do |item_params|

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

@@ -13,20 +13,11 @@ module Spree
       end
 
       def show
-        warn_if_nested_member_route
-
         @option_value = scope.find(params[:id])
         respond_with(@option_value)
       end
 
       def create
-        Spree::Deprecation.warn <<~MSG unless request.path.include?('/option_types/')
-          This route is deprecated, as it'll be no longer possible to create an
-          option_value without an associated option_type. Please, use instead:
-
-            POST api/option_types/{option_type_id}/option_values
-        MSG
-
         authorize! :create, Spree::OptionValue
         @option_value = scope.new(option_value_params)
         if @option_value.save
@@ -37,8 +28,6 @@ module Spree
       end
 
       def update
-        warn_if_nested_member_route
-
         @option_value = scope.accessible_by(current_ability, :update).find(params[:id])
         if @option_value.update(option_value_params)
           render :show
@@ -48,8 +37,6 @@ module Spree
       end
 
       def destroy
-        warn_if_nested_member_route
-
         @option_value = scope.accessible_by(current_ability, :destroy).find(params[:id])
         @option_value.destroy
         render plain: nil, status: 204
@@ -68,14 +55,6 @@ module Spree
       def option_value_params
         params.require(:option_value).permit(permitted_option_value_attributes)
       end
-
-      def warn_if_nested_member_route
-        Spree::Deprecation.warn <<~MSG if request.path.include?('/option_types/')
-          This route is deprecated. Use shallow version instead:
-
-            #{request.method.upcase} api/option_values/:id
-        MSG
-      end
     end
   end
 end

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

@@ -40,30 +40,8 @@ module Spree
 
       def create
         authorize! :create, Shipment
-
         @shipment = @order.shipments.create(stock_location_id: params.fetch(:stock_location_id))
 
-        if passing_deprecated_params_on_create?
-          Spree::Deprecation.warn <<~MSG
-          Passing `quantity` or `variant_id` to
-
-              POST /api/shipments
-
-          is deprecated and won't be allowed anymore starting from Solidus 4.0.
-          Instead, create an empty shipment and add items to it subsequently using
-          the dedicated endpoint:
-
-              PUT /api/shipments/{shipment_number}/add
-
-          MSG
-
-          quantity = params[:quantity].to_i
-          variant = Spree::Variant.unscoped.find(params[:variant_id])
-          @order.contents.add(variant, quantity, { shipment: @shipment })
-          @shipment.save!
-          @shipment.reload
-        end
-
         respond_with(@shipment, default_template: :show)
       end
 
@@ -149,10 +127,6 @@ module Spree
         authorize! :create, Shipment
       end
 
-      def passing_deprecated_params_on_create?
-        params[:variant_id] || params[:quantity]
-      end
-
       def find_order_on_create
         @order = Spree::Order.find_by!(number: params[:shipment][:order_id])
         authorize! :show, @order

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

@@ -6,12 +6,6 @@ module Spree
       before_action :product
 
       def create
-        Spree::Deprecation.warn <<~MSG unless request.path.include?('/products/')
-          This route is deprecated. Use the route nested within the product resource:
-
-            POST api/products/{product_id}/variants
-        MSG
-
         authorize! :create, Variant
         @variant = scope.new(variant_params)
         if @variant.save
@@ -22,8 +16,6 @@ module Spree
       end
 
       def destroy
-        warn_if_nested_member_route
-
         @variant = scope.accessible_by(current_ability, :destroy).find(params[:id])
         @variant.discard
         respond_with(@variant, status: 204)
@@ -50,16 +42,12 @@ module Spree
       end
 
       def show
-        warn_if_nested_member_route
-
         @variant = scope.includes(include_list)
           .find(params[:id])
         respond_with(@variant)
       end
 
       def update
-        warn_if_nested_member_route
-
         @variant = scope.accessible_by(current_ability, :update).find(params[:id])
         if @variant.update(variant_params)
           respond_with(@variant, status: 200, default_template: :show)
@@ -70,14 +58,6 @@ module Spree
 
       private
 
-      def warn_if_nested_member_route
-        Spree::Deprecation.warn <<~MSG if request.path.include?('/products/')
-          This route is deprecated. Use shallow version instead:
-
-            #{request.method.upcase} api/variants/:id
-        MSG
-      end
-
       def product
         @product ||= Spree::Product.accessible_by(current_ability, :show).friendly.find(params[:product_id]) if params[:product_id]
       end

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

@@ -41,11 +41,6 @@ module Spree
         define_method attribute do
           Spree::Api::Config.send(attribute)
         end
-
-        define_singleton_method attribute do
-          Spree::Deprecation.warn("Please use Spree::Api::Config::#{attribute} instead.")
-          Spree::Api::Config.send(attribute)
-        end
       end
 
       def required_fields_for(model)

data/config/routes.rb

@@ -54,12 +54,9 @@ Spree::Core::Engine.routes.draw do
     end
 
     resources :option_types do
-      # TODO: Use shallow option on Solidus v4.0
-      resources :option_values
+      resources :option_values, shallow: true
     end
-    # TODO: Use only: :index on Solidus v4.0 and use shallow option on the nested routes
-    # within option_types
-    resources :option_values
+    resources :option_values, only: :index
 
     get '/orders/mine', to: 'orders#mine', as: 'my_orders'
     get "/orders/current", to: "orders#current", as: "current_order"

data/lib/spree/api_configuration.rb

@@ -114,7 +114,7 @@ module Spree
 
     preference :promotion_attributes, :array, default: [
       :id, :name, :description, :expires_at, :starts_at, :type, :usage_limit,
-      :match_policy, :advertise, :path
+      :advertise, :path
     ]
 
     preference :store_attributes, :array, default: [

data/openapi/solidus-api.oas.yml

@@ -667,121 +667,6 @@ paths:
               properties:
                 image:
                   $ref: '#/components/schemas/image-input'
-  '/products/{product_id}/variants/{id}':
-    get:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/variant'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-      summary: Get product variant
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/87df124706c5f-get-variant) instead
-
-        Retrieves a product's variant.
-      operationId: get-product-variant
-      tags:
-        - Variants
-      security:
-        - api-key: []
-    parameters:
-      - name: product_id
-        in: path
-        required: true
-        schema:
-          type: string
-      - name: id
-        in: path
-        required: true
-        schema:
-          type: string
-    delete:
-      responses:
-        '204':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/variant'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-        '422':
-          $ref: '#/components/responses/delete-restriction'
-      summary: Delete product variant
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/82ccaada99139-delete-variant) instead
-
-        Deletes a product's variant.
-      operationId: delete-product-variant
-      tags:
-        - Variants
-      security:
-        - api-key: []
-    put:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/variant'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-        '422':
-          $ref: '#/components/responses/unprocessable-entity'
-      summary: Update product variant
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/ce338b5f3b940-update-variant) instead
-
-        Updates a product's variant.
-      operationId: update-product-variant
-      tags:
-        - Variants
-      security:
-        - api-key: []
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                variant:
-                  $ref: '#/components/schemas/variant-input'
-            examples:
-              Example with Option Value Ids:
-                value:
-                  variant:
-                    price: '11.22'
-                    cost_price: '9'
-                    position: 1
-                    track_inventory: true
-                    sku: AWSOME-1122
-                    cost_currency: USD
-                    option_value_ids:
-                      - 1
-                      - 2
-              Example with Option Value Text:
-                value:
-                  variant:
-                    price: '11.22'
-                    cost_price: '9'
-                    position: 1
-                    track_inventory: true
-                    sku: AWSOME-1122
-                    cost_currency: USD
-                    options:
-                      name: Color
-                      value: White
   /states:
     get:
       responses:
@@ -852,65 +737,6 @@ paths:
         - $ref: '#/components/parameters/q'
       security:
         - api-key: []
-    post:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/variant'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '422':
-          $ref: '#/components/responses/unprocessable-entity'
-      summary: Create variant
-      description: |-
-        **Deprecation Warning**: Use [nested version](/docs/solidus/681aa6cb75b1e-create-product-variant) instead
-
-        Creates a variant. Only users with `can :create, Variant` permissions can perform this action.
-      operationId: create-variant
-      tags:
-        - Variants
-      security:
-        - api-key: []
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                product_id:
-                  type: integer
-                variant:
-                  $ref: '#/components/schemas/variant-input'
-            examples:
-              Example with Option Value Ids:
-                value:
-                  product_id: 1
-                  variant:
-                    price: '11.22'
-                    cost_price: '9'
-                    position: 1
-                    track_inventory: true
-                    sku: AWSOME-1122
-                    cost_currency: USD
-                    option_value_ids:
-                      - 1
-                      - 2
-              Example with Option Value Text:
-                value:
-                  product_id: 1
-                  variant:
-                    price: '11.22'
-                    cost_price: '9'
-                    position: 1
-                    track_inventory: true
-                    sku: AWSOME-1122
-                    cost_currency: USD
-                    options:
-                      name: Color
-                      value: White
   '/variants/{id}':
     get:
       responses:
@@ -2541,38 +2367,6 @@ paths:
         - Option values
       security:
         - api-key: []
-    post:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/option-value'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '422':
-          $ref: '#/components/responses/unprocessable-entity'
-      summary: Create option value
-      description: |-
-        **Deprecation Warning**: Use [nested version](/docs/solidus/810154673c613-create-option-type-value) instead
-
-        Creates an option value.
-
-        Only users with the `create` permission on `Spree::OptionValue` can perform this action.
-      operationId: create-option-value
-      tags:
-        - Option values
-      security:
-        - api-key: []
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                option_value:
-                  $ref: '#/components/schemas/option-value-input'
   '/option_values/{id}':
     get:
       responses:
@@ -2715,99 +2509,6 @@ paths:
               properties:
                 option_value:
                   $ref: '#/components/schemas/option-value-input'
-  '/option_types/{option_type_id}/option_values/{id}':
-    get:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema: {}
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-      summary: Get option type value
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/cbbc403ed08a3-get-option-value) instead
-
-        Retrieves an option type's value.
-      operationId: get-option-type-value
-      tags:
-        - Option values
-      security:
-        - api-key: []
-    parameters:
-      - name: option_type_id
-        in: path
-        required: true
-        schema:
-          type: string
-        description: 'The ID of the Spree::OptionType'
-      - name: id
-        in: path
-        required: true
-        schema:
-          type: string
-        description: The ID of the OptionValue
-    delete:
-      responses:
-        '204':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/option-value'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-        '422':
-          $ref: '#/components/responses/delete-restriction'
-      summary: Delete option type value
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/0742e63219b1f-delete-option-value) instead
-
-        Deletes an option type's value.
-      operationId: delete-option-type-value
-      tags:
-        - Option values
-      security:
-        - api-key: []
-    patch:
-      responses:
-        '200':
-          description: ''
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/option-value'
-        '401':
-          $ref: '#/components/responses/invalid-api-key'
-        '404':
-          $ref: '#/components/responses/not-found'
-        '422':
-          $ref: '#/components/responses/unprocessable-entity'
-      summary: Update option type value
-      description: |-
-        **Deprecation Warning**: Use [shallow version](/docs/solidus/b43f889175ebb-update-option-value) instead
-
-        Updates an option type's value.
-
-        Only users with the `update` permission on the option value can perform this action.
-      operationId: update-option-type-value
-      tags:
-        - Option values
-      security:
-        - api-key: []
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                option_value:
-                  $ref: '#/components/schemas/option-value-input'
   '/products/{product_id}/product_properties':
     get:
       responses:
@@ -5589,10 +5290,6 @@ paths:
         Creates a shipment.
 
         Please note that this request can be only performed by users with the `create` permission on the shipment.
-
-        **Deprecation Warning**: Adding items to the shipment via this endpoint
-        is deprecated. Instead, create an empty shipment and populate it with
-        the dedicated endpoint [to add items to the shipment](/docs/solidus/7078dbcf415ac-add-shipment-item).
       operationId: create-shipment
       tags:
         - Shipments
@@ -5606,18 +5303,10 @@ paths:
               properties:
                 stock_location_id:
                   type: integer
-                variant_id:
-                  type: integer
-                  deprecated: true
-                quantity:
-                  type: integer
-                  deprecated: true
             examples:
               Example:
                 value:
                   stock_location_id: 0
-                  variant_id: 0
-                  quantity: 0
   /shipments/transfer_to_location:
     post:
       responses:

data/solidus_api.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
     f.match(%r{^(spec|script)/})
   end
 
-  s.required_ruby_version = '>= 2.7.0'
+  s.required_ruby_version = '>= 3.0.0'
   s.required_rubygems_version = '>= 1.8.23'
 
   s.add_dependency 'jbuilder', '~> 2.8'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_api
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 4.0.0
 platform: ruby
 authors:
 - Solidus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.4
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.4.4
+        version: 4.0.0
 description: REST API for the Solidus e-commerce framework.
 email: contact@solidus.io
 executables: []
@@ -97,7 +97,6 @@ files:
 - app/controllers/spree/api/products_controller.rb
 - app/controllers/spree/api/promotions_controller.rb
 - app/controllers/spree/api/properties_controller.rb
-- app/controllers/spree/api/resource_controller.rb
 - app/controllers/spree/api/return_authorizations_controller.rb
 - app/controllers/spree/api/shipments_controller.rb
 - app/controllers/spree/api/states_controller.rb
@@ -266,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-# @deprecated Inherit directly from Spree::Api::BaseController
-class Spree::Api::ResourceController < Spree::Api::BaseController
-  before_action :load_resource, only: [:show, :update, :destroy]
-
-  def self.inherited(klass)
-    Spree::Deprecation.warn <<~MSG
-      Spree::Api::ResourceController is deprecated. Please, copy any logic you
-      need and inherit directly from Spree::Api::BaseController.
-    MSG
-    super
-  end
-
-  def index
-    collection_scope = model_class.accessible_by(current_ability)
-    if params[:ids]
-      ids = params[:ids].split(",").flatten
-      collection_scope = collection_scope.where(id: ids)
-    else
-      collection_scope = collection_scope.ransack(params[:q]).result
-    end
-
-    @collection = paginate(collection_scope)
-    instance_variable_set("@#{controller_name}", @collection)
-
-    respond_with(@collection)
-  end
-
-  def show
-    respond_with(@object)
-  end
-
-  def new
-    authorize! :new, model_class
-    respond_with(model_class.new)
-  end
-
-  def create
-    authorize! :create, model_class
-
-    @object = model_class.new(permitted_resource_params)
-    instance_variable_set("@#{object_name}", @object)
-
-    if @object.save
-      respond_with(@object, status: 201, default_template: :show)
-    else
-      invalid_resource!(@object)
-    end
-  end
-
-  def update
-    authorize! :update, @object
-
-    if @object.update(permitted_resource_params)
-      respond_with(@object, status: 200, default_template: :show)
-    else
-      invalid_resource!(@object)
-    end
-  end
-
-  def destroy
-    authorize! :destroy, @object
-
-    destroy_result = if @object.respond_to?(:discard)
-      @object.discard
-    else
-      @object.destroy
-    end
-
-    if destroy_result
-      respond_with(@object, status: 204)
-    else
-      invalid_resource!(@object)
-    end
-  rescue ActiveRecord::DeleteRestrictionError
-    render "spree/api/errors/delete_restriction", status: 422
-  end
-
-  protected
-
-  def load_resource
-    @object = model_class.accessible_by(current_ability, :show).find(params[:id])
-    instance_variable_set("@#{object_name}", @object)
-  end
-
-  def permitted_resource_params
-    params.require(object_name).permit(permitted_resource_attributes)
-  end
-
-  def permitted_resource_attributes
-    send("permitted_#{object_name}_attributes")
-  end
-
-  def model_class
-    "Spree::#{controller_name.classify}".constantize
-  end
-
-  def object_name
-    controller_name.singularize
-  end
-end