solidus_api 3.0.0.rc2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03f38abf5a8115d6e8ecc4dd6fee2e3e3b1787aaadd8544ebe5ffc46212b6a73
-  data.tar.gz: 692143e952bec18b74fe8531085ce71fb75174c3fa1b943b109002d59464fed0
+  metadata.gz: 95754df420b9b7e750d09379a5daed863451bb18fa0db4d74c30b8777fd7992f
+  data.tar.gz: b3d3f3692c91d9da3150269f2b0a86faab31b7e00034829f82067a6ad9b8c9f4
 SHA512:
-  metadata.gz: 10b782a658fb0f721a6115b086a802bea34061c7d8abd7547bb52224f3dee90d37dbfda07e29a7c194a59ec2f4e2b33e6aef1a3c7ff7465339e0c39a8261a96a
-  data.tar.gz: a236c9b2003e2e79d79390634ba69c579a8757b20cdf9ca0f06ecb19e93be43f71f8a61888e71d6cf72f5c855197b1edb1a9332a891f3c3fb8dc6ee696fce738
+  metadata.gz: 749a592b19194444127974f8f059256599c05137f9f5846221297fd6a8a92a2a2e4374c19fa91dfa061ed9fee1e38f9da219a59293b0a033bec8a93c172f9cd0
+  data.tar.gz: bc5947619160f92268d614f2723b5a36464ba0d1e1dcc025b169e6181649a02c0548392e270eec5c9a1eb402bf00b5ddae3a718de1e24d073f3f0fd58030e1bd

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