solidus_api 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c562a97483797d4edf86580f41c97cf5447eb07e4de11dae54d159c60b77e940
-  data.tar.gz: 72930bcb20c678116935e1206be82296915d4a311069979ee6b0e9fd9ee79165
+  metadata.gz: 81dc1a350d5a6cb29b00476153f804d83b0822b96ca1db252df1514610af2847
+  data.tar.gz: ec8f1a79d31578b5bf1355a527b0ebe0afa1fcfb7110c5ac4aa113752fb0055f
 SHA512:
-  metadata.gz: 3b47ffcdacbabb1d041fb9672a9eebb17367aef22081aee9d89667c09cf6161f77e91fff7b4e65fb7479c51e618bac2d224fd2c5a2f9f37959f98c90f486122a
-  data.tar.gz: 5a9bc97b3e2ea1d5a167953b7c46790f13bbf67f8ed02e9fe54cadddcb8c6843e6ae7105e3f85b3ea315e7de5d572953316f5b357b5feb75f229b3b52433154e
+  metadata.gz: 03ed6b298468ceb85fa18974d870904278ca534d4331f90174525293e61620584178cdef3b76c6067a7a9fa5957b2588a791712cff0f0c5961143adedf91c7a9
+  data.tar.gz: 602090d3a192a11f6869b5fc0e575352161519aaf9c5f16066bc39545da90553dd1bd370e8ab1aff3bd887ab6696130fdb22e4219c6c62e53b300ea97d4bcd43

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

@@ -71,8 +71,11 @@ module Spree
       end
 
       def gateway_error(exception)
-        @order.errors.add(:base, exception.message)
-        invalid_resource!(@order)
+        # Fall back to a blank order if one isn't set, as we only need this for
+        # its errors interface.
+        model = @order || Spree::Order.new
+        model.errors.add(:base, exception.message)
+        invalid_resource!(model)
       end
 
       def parameter_missing_error(exception)
@@ -139,7 +142,7 @@ module Spree
       end
 
       def variants_associations
-        [{ option_values: :option_type }, :default_price, :images]
+        [{ option_values: :option_type }, :prices, :images]
       end
 
       def product_includes

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

@@ -4,13 +4,14 @@ module Spree
   module Api
     class CustomerReturnsController < Spree::Api::BaseController
       before_action :load_order
+      before_action :build_customer_return, only: [:create]
       around_action :lock_order, only: [:create, :update, :destroy, :cancel]
 
       rescue_from Spree::Order::InsufficientStock, with: :insufficient_stock_error
 
       def create
         authorize! :create, CustomerReturn
-        @customer_return = CustomerReturn.create(customer_return_params)
+
         if @customer_return.save
           respond_with(@customer_return, status: 201, default_template: :show)
         else
@@ -62,6 +63,34 @@ module Spree
       def customer_return_params
         params.require(:customer_return).permit(permitted_customer_return_attributes)
       end
+
+      def build_customer_return
+        customer_return_attributes = customer_return_params
+        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|
+          return_item = if item_params[:id]
+                          Spree::ReturnItem.find(item_params[:id])
+                        else
+                          Spree::ReturnItem.new
+                        end
+
+          return_item.assign_attributes(item_params)
+
+          return_item
+        end
+      end
     end
   end
 end

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

@@ -186,7 +186,7 @@ module Spree
             },
             variant: {
               product: {},
-              default_price: {},
+              prices: {},
               option_values: {
                 option_type: {}
               }

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

@@ -69,7 +69,7 @@ module Spree
         # Products#index does not do the sorting.
         taxon = Spree::Taxon.find(params[:id])
         @products = paginate(taxon.products.ransack(params[:q]).result)
-        @products = @products.includes(master: :default_price)
+        @products = @products.includes(master: :prices)
 
         if params[:simple]
           @exclude_data = {

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

@@ -83,7 +83,7 @@ module Spree
       end
 
       def include_list
-        [{ option_values: :option_type }, :product, :default_price, :images, { stock_items: :stock_location }]
+        [{ option_values: :option_type }, :product, :prices, :images, { stock_items: :stock_location }]
       end
     end
   end

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

@@ -37,7 +37,16 @@ module Spree
         :variant_property_attributes
       ]
 
-      mattr_reader(*ATTRIBUTES)
+      ATTRIBUTES.each do |attribute|
+        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)
         required_fields = model._validators.select do |_field, validations|
@@ -51,142 +60,12 @@ module Spree
         required_fields
       end
 
-      @@product_attributes = [
-        :id, :name, :description, :available_on,
-        :slug, :meta_description, :meta_keywords, :shipping_category_id,
-        :taxon_ids, :total_on_hand, :meta_title
-      ]
-
-      @@product_property_attributes = [
-        :id, :product_id, :property_id, :value, :property_name
-      ]
-
-      @@variant_attributes = [
-        :id, :name, :sku, :weight, :height, :width, :depth, :is_master,
-        :slug, :description, :track_inventory
-      ]
-
-      @@variant_property_attributes = [
-        :id, :property_id, :value, :property_name
-      ]
-
-      @@image_attributes = [
-        :id, :position, :attachment_content_type, :attachment_file_name, :type,
-        :attachment_updated_at, :attachment_width, :attachment_height, :alt
-      ]
-
-      @@option_value_attributes = [
-        :id, :name, :presentation, :option_type_name, :option_type_id,
-        :option_type_presentation
-      ]
-
-      @@order_attributes = [
-        :id, :number, :item_total, :total, :ship_total, :state, :adjustment_total,
-        :user_id, :created_at, :updated_at, :completed_at, :payment_total,
-        :shipment_state, :payment_state, :email, :special_instructions, :channel,
-        :included_tax_total, :additional_tax_total, :display_included_tax_total,
-        :display_additional_tax_total, :tax_total, :currency,
-        :covered_by_store_credit, :display_total_applicable_store_credit,
-        :order_total_after_store_credit, :display_order_total_after_store_credit,
-        :total_applicable_store_credit, :display_total_available_store_credit,
-        :display_store_credit_remaining_after_capture, :canceler_id
-
-      ]
-
-      @@line_item_attributes = [:id, :quantity, :price, :variant_id]
-
-      @@option_type_attributes = [:id, :name, :presentation, :position]
-
-      @@payment_attributes = [
-        :id, :source_type, :source_id, :amount, :display_amount,
-        :payment_method_id, :state, :avs_response, :created_at,
-        :updated_at
-      ]
-
-      @@payment_method_attributes = [:id, :name, :description]
-
-      @@shipment_attributes = [:id, :tracking, :tracking_url, :number, :cost, :shipped_at, :state]
-
-      @@taxonomy_attributes = [:id, :name]
-
-      @@taxon_attributes = [
-        :id, :name, :pretty_name, :permalink, :parent_id,
-        :taxonomy_id
-      ]
-
-      @@inventory_unit_attributes = [
-        :id, :state, :variant_id, :shipment_id
-      ]
-
-      @@customer_return_attributes = [
-        :id, :number, :stock_location_id, :created_at, :updated_at
-      ]
-
-      @@return_authorization_attributes = [
-        :id, :number, :state, :order_id, :memo, :created_at, :updated_at
-      ]
-
-      @@address_attributes = [
-        :id, :name, :address1, :address2, :city, :zipcode, :phone, :company,
-        :alternative_phone, :country_id, :country_iso, :state_id, :state_name,
-        :state_text
-      ]
-
-      @@country_attributes = [:id, :iso_name, :iso, :iso3, :name, :numcode]
-
-      @@state_attributes = [:id, :name, :abbr, :country_id]
-
-      @@adjustment_attributes = [
-        :id, :source_type, :source_id, :adjustable_type, :adjustable_id,
-        :amount, :label, :promotion_code_id,
-        :finalized, :eligible, :created_at, :updated_at
-      ]
-
-      @@creditcard_attributes = [
-        :id, :month, :year, :cc_type, :last_digits, :name
-      ]
-
-      @@payment_source_attributes = [
-        :id, :month, :year, :cc_type, :last_digits, :name
-      ]
-
-      @@user_attributes = [:id, :email, :created_at, :updated_at]
-
-      @@property_attributes = [:id, :name, :presentation]
-
-      @@stock_location_attributes = [
-        :id, :name, :address1, :address2, :city, :state_id, :state_name,
-        :country_id, :zipcode, :phone, :active
-      ]
-
-      @@stock_movement_attributes = [:id, :quantity, :stock_item_id]
-
-      @@stock_item_attributes = [
-        :id, :count_on_hand, :backorderable, :stock_location_id,
-        :variant_id
-      ]
-
-      @@promotion_attributes = [
-        :id, :name, :description, :expires_at, :starts_at, :type, :usage_limit,
-        :match_policy, :advertise, :path
-      ]
-
-      @@store_attributes = [
-        :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
-        :mail_from_address, :default_currency, :code, :default, :available_locales,
-        :bcc_email
-      ]
-
-      @@store_credit_history_attributes = [
-        :display_amount, :display_user_total_amount, :display_action,
-        :display_event_date, :display_remaining_amount
-      ]
-
       def variant_attributes
+        preference_attributes = Spree::Api::Config.variant_attributes
         if @current_user_roles&.include?("admin")
-          @@variant_attributes + [:cost_price]
+          preference_attributes + [:cost_price]
         else
-          @@variant_attributes
+          preference_attributes
         end
       end
 

data/app/views/spree/api/products/_product.json.jbuilder

@@ -4,8 +4,8 @@
 json.cache! [I18n.locale, @current_user_roles.include?('admin'), current_pricing_options, @product_attributes, @exclude_data, product] do
   json.(product, *(@product_attributes - [:total_on_hand]))
   json.total_on_hand(total_on_hand_for(product))
-  json.price(product.price_for(current_pricing_options).try(:to_d))
-  json.display_price(product.price_for(current_pricing_options).to_s)
+  json.price(product.price_for_options(current_pricing_options)&.amount)
+  json.display_price(product.price_for_options(current_pricing_options)&.money&.to_s)
 
   @exclude_data ||= {}
   unless @exclude_data[:variants]

data/app/views/spree/api/variants/_small.json.jbuilder

@@ -2,8 +2,8 @@
 
 json.cache! [I18n.locale, current_pricing_options, variant] do
   json.(variant, *variant_attributes)
-  json.price(variant.price_for(current_pricing_options).try(:to_d))
-  json.display_price(variant.price_for(current_pricing_options).to_s)
+  json.price(variant.price_for_options(current_pricing_options)&.amount)
+  json.display_price(variant.price_for_options(current_pricing_options)&.money&.to_s)
   json.options_text(variant.options_text)
   json.track_inventory(variant.should_track_inventory?)
   json.in_stock(variant.in_stock?)

data/lib/spree/api/engine.rb

@@ -11,6 +11,10 @@ module Spree
       # Leave initializer empty for backwards-compatibility. Other apps
       # might still rely on this event.
       initializer "spree.api.environment", before: :load_config_initializers do; end
+
+      config.after_initialize do
+        Spree::Api::Config.check_load_defaults_called('Spree::Api::Config')
+      end
     end
   end
 end

data/lib/spree/api_configuration.rb

@@ -3,5 +3,133 @@
 module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
+
+    preference :product_attributes, :array, default: [
+      :id, :name, :description, :available_on,
+      :slug, :meta_description, :meta_keywords, :shipping_category_id,
+      :taxon_ids, :total_on_hand, :meta_title
+    ]
+
+    preference :product_property_attributes, :array, default: [:id, :product_id, :property_id, :value, :property_name]
+
+    preference :variant_attributes, :array, default: [
+      :id, :name, :sku, :weight, :height, :width, :depth, :is_master,
+      :slug, :description, :track_inventory
+    ]
+
+    preference :image_attributes, :array, default: [
+      :id, :position, :attachment_content_type, :attachment_file_name, :type,
+      :attachment_updated_at, :attachment_width, :attachment_height, :alt
+    ]
+
+    preference :option_value_attributes, :array, default: [
+      :id, :name, :presentation, :option_type_name, :option_type_id,
+      :option_type_presentation
+    ]
+
+    preference :order_attributes, :array, default: [
+      :id, :number, :item_total, :total, :ship_total, :state, :adjustment_total,
+      :user_id, :created_at, :updated_at, :completed_at, :payment_total,
+      :shipment_state, :payment_state, :email, :special_instructions, :channel,
+      :included_tax_total, :additional_tax_total, :display_included_tax_total,
+      :display_additional_tax_total, :tax_total, :currency,
+      :covered_by_store_credit, :display_total_applicable_store_credit,
+      :order_total_after_store_credit, :display_order_total_after_store_credit,
+      :total_applicable_store_credit, :display_total_available_store_credit,
+      :display_store_credit_remaining_after_capture, :canceler_id
+    ]
+
+    preference :line_item_attributes, :array, default: [:id, :quantity, :price, :variant_id]
+
+    preference :option_type_attributes, :array, default: [:id, :name, :presentation, :position]
+
+    preference :payment_attributes, :array, default: [
+      :id, :source_type, :source_id, :amount, :display_amount,
+      :payment_method_id, :state, :avs_response, :created_at,
+      :updated_at
+    ]
+
+    preference :payment_method_attributes, :array, default: [:id, :name, :description]
+
+    preference :shipment_attributes, :array, default: [:id, :tracking, :tracking_url, :number, :cost, :shipped_at, :state]
+
+    preference :taxonomy_attributes, :array, default: [:id, :name]
+
+    preference :taxon_attributes, :array, default: [
+      :id, :name, :pretty_name, :permalink, :parent_id,
+      :taxonomy_id
+    ]
+
+    preference :address_attributes, :array, default: [
+      :id, :name, :address1, :address2, :city, :zipcode, :phone, :company,
+      :alternative_phone, :country_id, :country_iso, :state_id, :state_name,
+      :state_text
+    ]
+
+    preference :country_attributes, :array, default: [:id, :iso_name, :iso, :iso3, :name, :numcode]
+
+    preference :state_attributes, :array, default: [:id, :name, :abbr, :country_id]
+
+    preference :adjustment_attributes, :array, default: [
+      :id, :source_type, :source_id, :adjustable_type, :adjustable_id,
+      :amount, :label, :promotion_code_id,
+      :finalized, :eligible, :created_at, :updated_at
+    ]
+
+    preference :inventory_unit_attributes, :array, default: [
+      :id, :state, :variant_id, :shipment_id
+    ]
+
+    preference :customer_return_attributes, :array, default: [
+      :id, :number, :stock_location_id, :created_at, :updated_at
+    ]
+
+    preference :return_authorization_attributes, :array, default: [
+      :id, :number, :state, :order_id, :memo, :created_at, :updated_at
+    ]
+
+    preference :creditcard_attributes, :array, default: [
+      :id, :month, :year, :cc_type, :last_digits, :name
+    ]
+
+    preference :payment_source_attributes, :array, default: [
+      :id, :month, :year, :cc_type, :last_digits, :name
+    ]
+
+    preference :user_attributes, :array, default: [:id, :email, :created_at, :updated_at]
+
+    preference :property_attributes, :array, default: [:id, :name, :presentation]
+
+    preference :stock_location_attributes, :array, default: [
+      :id, :name, :address1, :address2, :city, :state_id, :state_name,
+      :country_id, :zipcode, :phone, :active
+    ]
+
+    preference :stock_movement_attributes, :array, default: [:id, :quantity, :stock_item_id]
+
+    preference :stock_item_attributes, :array, default: [
+      :id, :count_on_hand, :backorderable, :stock_location_id,
+      :variant_id
+    ]
+
+    preference :promotion_attributes, :array, default: [
+      :id, :name, :description, :expires_at, :starts_at, :type, :usage_limit,
+      :match_policy, :advertise, :path
+    ]
+
+    preference :store_attributes, :array, default: [
+      :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
+      :mail_from_address, :default_currency, :code, :default, :available_locales,
+      :bcc_email
+    ]
+
+    preference :store_credit_history_attributes, :array, default: [
+      :display_amount, :display_user_total_amount, :display_action,
+      :display_event_date, :display_remaining_amount
+    ]
+
+    preference :variant_property_attributes, :array, default: [
+      :id, :property_id, :value, :property_name
+    ]
   end
 end

data/openapi/main.hub.yml

@@ -38,11 +38,11 @@ pages:
             path: /authentication
           data:
             $ref: ./authentication.md
-        - title: Pagination
+        - title: Pagination and Filtering
           route:
-            path: /pagination
+            path: /pagination-and-filtering
           data:
-            $ref: ./pagination.md
+            $ref: ./pagination-and-filtering.md
         - title: Errors
           route:
             path: /errors

data/openapi/pagination-and-filtering.md

@@ -0,0 +1,23 @@
+# Pagination and Filtering
+
+## Pagination
+
+Most endpoints that return a collection are paginated. A paginated response contains metadata about the current page at the root level and the resources in the current page in a child key named after the resource (e.g. `orders`).
+
+You can pass the `page` and `per_page` parameters to set the current page and the desired number of items per page. Note that the default and the maximum number of items per page is decided at the application level.
+
+All pagination metadata is documented in the individual API endpoints, so take a look there if you're unsure what data you can expect.
+
+## Filtering
+
+Most endpoints that return a collection also have the ability to filter data using query params. This works taking advantage of the search filters provided by [Ransack](https://github.com/activerecord-hackery/ransack/).
+
+For example, if we want to retrieve only products that contain the word "Watch" in their title we can make the following request:
+
+```
+GET /products?q[name_cont]=Watch
+```
+
+The `name_cont` matcher will generate a query using `LIKE` to retrieve all the products that contain the value specified. For an extensive list of search matchers supported, please refer to the Ransack documentation.
+
+The result will be paginated as described in the paragraph above.