solidus_api 2.9.6 → 2.10.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9041e899f4cd40c0426851ecab468e5b0e6799979026651d90ed71c68e9a33d2
-  data.tar.gz: 6b6195d91d485815fc3e609c661efa408146b7ab49296c8db33987e568916ee4
+  metadata.gz: 6a9540c2c04dd060a437f426c70d637fd6bc681a625f66ab535f6f6940299071
+  data.tar.gz: 3ae3c6861ffb7a0d95bb3ebe3f3e01c7cfee7efe2b1b10b7ddb1bff09387230d
 SHA512:
-  metadata.gz: 72241153b2007035f40f1869e76a276597580d11fe4d8b24bd37529a03520f799edfd9530a18677df79aeaafffa8f929d1f2bae1b9a320871b781b705c21a2f5
-  data.tar.gz: dcb64f63cb2edd713a03bb3c971ed9de693d4e1af34bb3cb5746ed73b2294660ddb3805382587f10675f2ec71642ebb79f979373b21b7f03af8157bde6250067
+  metadata.gz: f08e8ffc5e36133c43d57082f717817b78c462cafbd2ba87019835d156d92df88c7c875b6739808744d9c0dca86939f38ac7792802ecf72e53831271d7d8830d
+  data.tar.gz: d74356f3fd6de4f1d540ed6232e0bc91f9b1ec5999ed278e4f107357ca26411d4a0bfdca28b5585d856205fe96db1ce631b73f5bc46e2747f537bf596363e2ce

data/README.md

@@ -9,3 +9,17 @@ Run the API tests:
 ```bash
 bundle exec rspec
 ```
+
+## Documentation
+
+The API documentation is in the [openapi](https://github.com/solidusio/solidus/tree/master/api/openapi)
+directory. It follows the OpenAPI specification and it is hosted on
+[Stoplight](https://solidus.docs.stoplight.io/).
+
+If you want to contribute, you can use [Stoplight Studio](https://stoplight.io/p/studio),
+an OpenAPI editor, to edit the files visually, and copy-paste the 
+resulting code into the `openapi` directory.
+
+CircleCI automatically syncs our Git repo with Stoplight when a PR is
+merged, and automatically publishes a new version on Stoplight when
+a new Solidus version is released.

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

@@ -15,7 +15,7 @@ module Spree
         authorize! :update, @order, order_token
         find_address
 
-        if @order.update_attributes({ "#{@order_source}_attributes" => address_params })
+        if @order.update({ "#{@order_source}_attributes" => address_params })
           @address = @order.send(@order_source)
           respond_with(@address, default_template: :show)
         else

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

@@ -76,24 +76,11 @@ module Spree
       end
 
       def update_params
-        state = @order.state
-        case state.to_sym
-        when :cart, :address
-          massaged_params.fetch(:order, {}).permit(
-            permitted_checkout_address_attributes
-          )
-        when :delivery
-          massaged_params.require(:order).permit(
-            permitted_checkout_delivery_attributes
-          )
-        when :payment
-          massaged_params.require(:order).permit(
-            permitted_checkout_payment_attributes
-          )
+        if update_params = massaged_params[:order]
+          update_params.permit(permitted_checkout_attributes)
         else
-          massaged_params.fetch(:order, {}).permit(
-            permitted_checkout_confirm_attributes
-          )
+          # We current allow update requests without any parameters in them.
+          {}
         end
       end
 

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

@@ -18,7 +18,7 @@ module Spree
       end
 
       def update
-        if @credit_card.update_attributes(credit_card_update_params)
+        if @credit_card.update(credit_card_update_params)
           respond_with(@credit_card, default_template: :show)
         else
           invalid_resource!(@credit_card)

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

@@ -21,7 +21,7 @@ module Spree
 
       def update
         @image = Spree::Image.accessible_by(current_ability, :update).find(params[:id])
-        @image.update_attributes(image_params)
+        @image.update(image_params)
         respond_with(@image, default_template: :show)
       end
 

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

@@ -14,7 +14,7 @@ module Spree
         authorize! :update, inventory_unit.order
 
         inventory_unit.transaction do
-          if inventory_unit.update_attributes(inventory_unit_params)
+          if inventory_unit.update(inventory_unit_params)
             fire
             render :show, status: 200
           else

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

@@ -29,7 +29,7 @@ module Spree
 
       def update
         @option_type = Spree::OptionType.accessible_by(current_ability, :update).find(params[:id])
-        if @option_type.update_attributes(option_type_params)
+        if @option_type.update(option_type_params)
           render :show
         else
           invalid_resource!(@option_type)

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

@@ -29,7 +29,7 @@ module Spree
 
       def update
         @option_value = scope.accessible_by(current_ability, :update).find(params[:id])
-        if @option_value.update_attributes(option_value_params)
+        if @option_value.update(option_value_params)
           render :show
         else
           invalid_resource!(@option_value)

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

@@ -131,13 +131,7 @@ module Spree
       end
 
       def normalize_params
-        if params[:order][:payments]
-          payments_params = params[:order].delete(:payments)
-          params[:order][:payments_attributes] = payments_params.map do |payment_params|
-            payment_params[:source_attributes] = payment_params.delete(:source) if payment_params[:source].present?
-            payment_params
-          end
-        end
+        params[:order][:payments_attributes] = params[:order].delete(:payments) if params[:order][:payments]
         params[:order][:shipments_attributes] = params[:order].delete(:shipments) if params[:order][:shipments]
         params[:order][:line_items_attributes] = params[:order].delete(:line_items) if params[:order][:line_items]
         params[:order][:ship_address_attributes] = params[:order].delete(:ship_address) if params[:order][:ship_address].present?

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

@@ -31,7 +31,7 @@ module Spree
         authorize! params[:action], @payment
         if !@payment.pending?
           render 'update_forbidden', status: 403
-        elsif @payment.update_attributes(payment_params)
+        elsif @payment.update(payment_params)
           respond_with(@payment, default_template: :show)
         else
           invalid_resource!(@payment)

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

@@ -38,7 +38,7 @@ module Spree
       def update
         if @product_property
           authorize! :update, @product_property
-          @product_property.update_attributes(product_property_params)
+          @product_property.update(product_property_params)
           respond_with(@product_property, status: 200, default_template: :show)
         else
           invalid_resource!(@product_property)

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

@@ -39,7 +39,7 @@ module Spree
       def update
         if @property
           authorize! :update, @property
-          @property.update_attributes(property_params)
+          @property.update(property_params)
           respond_with(@property, status: 200, default_template: :show)
         else
           invalid_resource!(@property)

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

@@ -43,7 +43,7 @@ class Spree::Api::ResourceController < Spree::Api::BaseController
   def update
     authorize! :update, @object
 
-    if @object.update_attributes(permitted_resource_params)
+    if @object.update(permitted_resource_params)
       respond_with(@object, status: 200, default_template: :show)
     else
       invalid_resource!(@object)

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

@@ -50,7 +50,7 @@ module Spree
 
       def update
         @return_authorization = @order.return_authorizations.accessible_by(current_ability, :update).find(params[:id])
-        if @return_authorization.update_attributes(return_authorization_params)
+        if @return_authorization.update(return_authorization_params)
           respond_with(@return_authorization, default_template: :show)
         else
           invalid_resource!(@return_authorization)

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

@@ -146,7 +146,7 @@ module Spree
       end
 
       def update_shipment
-        @shipment.update_attributes(shipment_params)
+        @shipment.update(shipment_params)
         @shipment.reload
       end
 

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

@@ -40,7 +40,7 @@ module Spree
         adjustment -= @stock_item.count_on_hand if params[:stock_item][:force]
 
         Spree::StockItem.transaction do
-          if @stock_item.update_attributes(stock_item_params)
+          if @stock_item.update(stock_item_params)
             adjust_stock_item_count_on_hand(adjustment)
             respond_with(@stock_item, status: 200, default_template: :show)
           else

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

@@ -33,7 +33,7 @@ module Spree
 
       def update
         authorize! :update, stock_location
-        if stock_location.update_attributes(stock_location_params)
+        if stock_location.update(stock_location_params)
           respond_with(stock_location, status: 200, default_template: :show)
         else
           invalid_resource!(stock_location)

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

@@ -24,7 +24,7 @@ module Spree
 
       def update
         authorize! :update, @store
-        if @store.update_attributes(store_params)
+        if @store.update(store_params)
           respond_with(@store, status: 200, default_template: :show)
         else
           invalid_resource!(@store)

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

@@ -33,7 +33,7 @@ module Spree
 
       def update
         authorize! :update, taxonomy
-        if taxonomy.update_attributes(taxonomy_params)
+        if taxonomy.update(taxonomy_params)
           respond_with(taxonomy, status: 200, default_template: :show)
         else
           invalid_resource!(taxonomy)

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

@@ -56,7 +56,7 @@ module Spree
 
       def update
         authorize! :update, taxon
-        if taxon.update_attributes(taxon_params)
+        if taxon.update(taxon_params)
           respond_with(taxon, status: 200, default_template: :show)
         else
           invalid_resource!(taxon)

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

@@ -43,7 +43,7 @@ module Spree
 
       def update
         @variant = scope.accessible_by(current_ability, :update).find(params[:id])
-        if @variant.update_attributes(variant_params)
+        if @variant.update(variant_params)
           respond_with(@variant, status: 200, default_template: :show)
         else
           invalid_resource!(@product)

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

@@ -37,7 +37,7 @@ module Spree
 
       def update
         authorize! :update, zone
-        if zone.update_attributes(zone_params)
+        if zone.update(zone_params)
           respond_with(zone, status: 200, default_template: :show)
         else
           invalid_resource!(zone)

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

@@ -177,7 +177,7 @@ module Spree
       ]
 
       def variant_attributes
-        if @current_user_roles && @current_user_roles.include?("admin")
+        if @current_user_roles&.include?("admin")
           @@variant_attributes + [:cost_price]
         else
           @@variant_attributes

data/app/views/spree/api/shared/_pagination.json.jbuilder

@@ -4,4 +4,4 @@ json.count        pagination.count
 json.total_count  pagination.total_count
 json.current_page pagination.current_page
 json.pages        pagination.total_pages
-json.per_page     pagination.current_per_page
+json.per_page     pagination.limit_value

data/lib/spree/api/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spree/api_configuration'
+
+module Spree
+  module Api
+    Config = Spree::ApiConfiguration.new
+  end
+end

data/lib/spree/api/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails/engine'
+require 'spree/api/config'
 
 module Spree
   module Api
@@ -8,9 +8,9 @@ module Spree
       isolate_namespace Spree
       engine_name 'spree_api'
 
-      initializer "spree.api.environment", before: :load_config_initializers do |_app|
-        Spree::Api::Config = Spree::ApiConfiguration.new
-      end
+      # Leave initializer empty for backwards-compatability. Other apps
+      # might still rely on this event.
+      initializer "spree.api.environment", before: :load_config_initializers do; end
     end
   end
 end

data/lib/spree/api/responders.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'responders'
 require 'spree/api/responders/rabl_template'
 
 module Spree

data/lib/spree/api.rb

@@ -2,11 +2,4 @@
 
 require 'spree/core'
 
-require 'responders'
-
-module Spree
-  module Api
-  end
-end
-
 require 'spree/api/engine'

data/openapi/.stoplight.yml

@@ -0,0 +1,7 @@
+stoplight: '1.0'
+environments:
+  default:
+    host: 'http://todos.stoplight.io'
+    todosApiKey: 123
+  staging: {}
+  production: {}