spree_api 4.1.13 → 4.2.0.rc4

data/app/controllers/spree/api/v2/storefront/countries_controller.rb

@@ -2,17 +2,7 @@ module Spree
   module Api
     module V2
       module Storefront
-        class CountriesController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class CountriesController < ::Spree::Api::V2::ResourceController
           private
 
           def serialize_collection(collection)
@@ -24,12 +14,15 @@ module Spree
               resource,
               include: resource_includes,
               fields: sparse_fields,
-              params: { include_states: true }
+              params: resource_serializer_params
             ).serializable_hash
           end
 
-          def collection
-            collection_finder.new(scope, params).call
+          def resource_serializer_params
+            {
+              include_states: true,
+              current_store: current_store
+            }
           end
 
           def resource
@@ -52,8 +45,8 @@ module Spree
             Spree::Api::Dependencies.storefront_country_finder.constantize
           end
 
-          def scope
-            Spree::Country.accessible_by(current_ability, :show)
+          def model_class
+            Spree::Country
           end
         end
       end

data/app/controllers/spree/api/v2/storefront/order_status_controller.rb

@@ -2,15 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class OrderStatusController < ::Spree::Api::V2::BaseController
+        class OrderStatusController < ::Spree::Api::V2::ResourceController
           include Spree::Api::V2::Storefront::OrderConcern
 
           before_action :ensure_order_token
 
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
           private
 
           def resource

data/app/controllers/spree/api/v2/storefront/products_controller.rb

@@ -2,21 +2,11 @@ module Spree
   module Api
     module V2
       module Storefront
-        class ProductsController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(paginated_collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class ProductsController < ::Spree::Api::V2::ResourceController
           private
 
           def sorted_collection
-            collection_sorter.new(collection, params, current_currency).call
+            collection_sorter.new(collection, current_currency, params, allowed_sort_attributes).call
           end
 
           def collection
@@ -43,8 +33,8 @@ module Spree
             Spree::Api::Dependencies.storefront_product_serializer.constantize
           end
 
-          def scope
-            Spree::Product.accessible_by(current_ability, :show).includes(scope_includes)
+          def model_class
+            Spree::Product
           end
 
           def scope_includes

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

@@ -2,14 +2,10 @@ module Spree
   module Api
     module V2
       module Storefront
-        class StoresController < ::Spree::Api::V2::BaseController
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class StoresController < ::Spree::Api::V2::ResourceController
           private
 
-          def scope
+          def model_class
             Spree::Store
           end
 

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

@@ -2,17 +2,7 @@ module Spree
   module Api
     module V2
       module Storefront
-        class TaxonsController < ::Spree::Api::V2::BaseController
-          include Spree::Api::V2::CollectionOptionsHelpers
-
-          def index
-            render_serialized_payload { serialize_collection(paginated_collection) }
-          end
-
-          def show
-            render_serialized_payload { serialize_resource(resource) }
-          end
-
+        class TaxonsController < ::Spree::Api::V2::ResourceController
           private
 
           def collection_serializer
@@ -39,8 +29,8 @@ module Spree
             scope.find_by(permalink: params[:id]) || scope.find(params[:id])
           end
 
-          def scope
-            Spree::Taxon.accessible_by(current_ability, :show).includes(scope_includes)
+          def model_class
+            Spree::Taxon
           end
 
           def scope_includes
@@ -51,7 +41,7 @@ module Spree
               children: node_includes,
               taxonomy: [root: node_includes],
               products: [],
-              icon: []
+              icon: [attachment_attachment: :blob]
             }
           end
         end

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

@@ -116,7 +116,7 @@ module Spree
       @@address_attributes = [
         :id, :firstname, :lastname, :full_name, :address1, :address2, :city,
         :zipcode, :phone, :company, :alternative_phone, :country_id, :state_id,
-        :state_name, :state_text
+        :label, :state_name, :state_text
       ]
 
       @@country_attributes = [:id, :iso_name, :iso, :iso3, :name, :numcode]
@@ -161,8 +161,9 @@ module Spree
 
       @@store_attributes = [
         :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
-        :mail_from_address, :default_currency, :code, :default,
-        :facebook, :twitter, :instagram
+        :mail_from_address, :customer_support_email, :default_currency,
+        :code, :default, :facebook, :twitter, :instagram,
+        :supported_currencies
       ]
 
       @@tag_attributes = [:id, :name]

data/app/models/spree/api_dependencies.rb

@@ -15,7 +15,8 @@ module Spree
       :storefront_product_serializer, :storefront_taxon_serializer, :storefront_taxon_finder, :storefront_find_by_variant_finder,
       :storefront_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
       :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
-      :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder
+      :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder,
+      :storefront_collection_sorter
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -69,7 +70,8 @@ module Spree
       @storefront_order_serializer = 'Spree::V2::Storefront::CartSerializer'
 
       # sorters
-      @storefront_order_sorter = Spree::Dependencies.order_sorter
+      @storefront_collection_sorter = Spree::Dependencies.collection_sorter
+      @storefront_order_sorter = Spree::Dependencies.collection_sorter
       @storefront_products_sorter = Spree::Dependencies.products_sorter
 
       # paginators

data/app/serializers/spree/v2/storefront/address_serializer.rb

@@ -5,10 +5,15 @@ module Spree
         set_type :address
 
         attributes :firstname, :lastname, :address1, :address2, :city, :zipcode, :phone, :state_name,
-                   :company, :country_name, :country_iso3, :country_iso
+                   :company, :country_name, :country_iso3, :country_iso, :label
 
-        attribute :state_code, &:state_abbr
-        attribute :state_name, &:state_name_text
+        attribute :state_code do |address|
+          address.state_abbr
+        end
+
+        attribute :state_name do |address|
+          address.state_name_text
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/base_serializer.rb

@@ -2,7 +2,7 @@ module Spree
   module V2
     module Storefront
       class BaseSerializer
-        include FastJsonapi::ObjectSerializer
+        include JSONAPI::Serializer
       end
     end
   end

data/app/serializers/spree/v2/storefront/country_serializer.rb

@@ -12,6 +12,12 @@ module Spree
         end
 
         has_many :states, if: proc { |_record, params| params && params[:include_states] }
+
+        has_many :checkout_zone_applicable_states,
+                 serializer: ::Spree::V2::Storefront::StateSerializer,
+                 if: proc { |_record, params| params && params[:current_store].present? } do |object, params|
+          params[:current_store].states_available_for_checkout(object)
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb

@@ -6,7 +6,9 @@ module Spree
 
         attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
 
-        attribute :final_price, &:cost
+        attribute :final_price do |shipping_rate|
+          shipping_rate.cost
+        end
 
         attributes :display_cost, :display_final_price do |object, params|
           Spree::Money.new(object.cost, currency: params[:currency])

data/app/serializers/spree/v2/storefront/product_property_serializer.rb

@@ -6,8 +6,13 @@ module Spree
 
         attribute :value
 
-        attribute :name,        &:property_name
-        attribute :description, &:property_presentation
+        attribute :name do |product_property|
+          product_property.property_name
+        end
+
+        attribute :description do |product_property|
+          product_property.property_presentation
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/product_serializer.rb

@@ -5,13 +5,24 @@ module Spree
         set_type :product
 
         attributes :name, :description, :price, :currency, :display_price,
-                   :available_on, :slug, :meta_description, :meta_keywords,
-                   :updated_at
+                   :compare_at_price, :display_compare_at_price, :available_on,
+                   :slug, :meta_description, :meta_keywords, :updated_at
 
-        attribute :purchasable,   &:purchasable?
-        attribute :in_stock,      &:in_stock?
-        attribute :backorderable, &:backorderable?
-        attribute :available,     &:available?
+        attribute :purchasable do |product|
+          product.purchasable?
+        end
+
+        attribute :in_stock do |product|
+          product.in_stock?
+        end
+
+        attribute :backorderable do |product|
+          product.backorderable?
+        end
+
+        attribute :available do |product|
+          product.available?
+        end
 
         has_many :variants
         has_many :option_types

data/app/serializers/spree/v2/storefront/shipment_serializer.rb

@@ -7,7 +7,9 @@ module Spree
         attributes :number, :final_price, :display_final_price,
                    :state, :shipped_at, :tracking_url
 
-        attribute :free, &:free?
+        attribute :free do |shipment|
+          shipment.free?
+        end
 
         has_many :shipping_rates
 

data/app/serializers/spree/v2/storefront/shipping_rate_serializer.rb

@@ -7,7 +7,9 @@ module Spree
         attributes :name, :selected, :final_price, :display_final_price, :cost,
                    :display_cost, :tax_amount, :display_tax_amount, :shipping_method_id
 
-        attribute :free, &:free?
+        attribute :free do |shipping_rate|
+          shipping_rate.free?
+        end
       end
     end
   end

data/app/serializers/spree/v2/storefront/store_serializer.rb

@@ -6,7 +6,9 @@ module Spree
 
         attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency, :default, :supported_currencies, :facebook,
                    :twitter, :instagram, :default_locale, :customer_support_email, :default_country_id, :description,
-                   :address, :contact_phone, :contact_email
+                   :address, :contact_phone
+
+        has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end
     end
   end

data/app/serializers/spree/v2/storefront/taxon_serializer.rb

@@ -7,9 +7,17 @@ module Spree
         attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
                    :meta_keywords, :left, :right, :position, :depth, :updated_at
 
-        attribute :is_root,  &:root?
-        attribute :is_child, &:child?
-        attribute :is_leaf,  &:leaf?
+        attribute :is_root do |taxon|
+          taxon.root?
+        end
+
+        attribute :is_child do |taxon|
+          taxon.child?
+        end
+
+        attribute :is_leaf do |taxon|
+          taxon.leaf?
+        end
 
         belongs_to :parent,   record_type: :taxon, serializer: :taxon
         belongs_to :taxonomy, record_type: :taxonomy

data/app/serializers/spree/v2/storefront/user_serializer.rb

@@ -6,7 +6,9 @@ module Spree
 
         attributes :email
 
-        attribute :store_credits, &:total_available_store_credit
+        attribute :store_credits do |user|
+          user.total_available_store_credit
+        end
 
         attribute :completed_orders do |object|
           object.orders.complete.count

data/app/serializers/spree/v2/storefront/variant_serializer.rb

@@ -4,12 +4,20 @@ module Spree
       class VariantSerializer < BaseSerializer
         set_type :variant
 
-        attributes :name, :sku, :price, :currency, :display_price, :weight, :height,
-                   :width, :depth, :is_master, :options_text, :slug, :description
+        attributes :sku, :price, :currency, :display_price, :weight, :height,
+                   :width, :depth, :is_master, :options_text
 
-        attribute :purchasable,   &:purchasable?
-        attribute :in_stock,      &:in_stock?
-        attribute :backorderable, &:backorderable?
+        attribute :purchasable do |variant|
+          variant.purchasable?
+        end
+
+        attribute :in_stock do |variant|
+          variant.in_stock?
+        end
+
+        attribute :backorderable do |variant|
+          variant.backorderable?
+        end
 
         belongs_to :product
         has_many :images

data/app/views/spree/api/v1/products/show.rabl

@@ -6,6 +6,10 @@ attributes *product_attributes
 node(:display_price) { |p| p.display_price.to_s }
 node(:has_variants, &:has_variants?)
 node(:taxon_ids, &:taxon_ids)
+node(:display_current_currency_price) do |product|
+  price = product.price_in(current_currency)
+  Spree::Money.new(price.amount, currency: current_currency).to_s
+end
 
 child master: :master do
   extends 'spree/api/v1/variants/small'

data/config/locales/en.yml

@@ -26,7 +26,7 @@ en:
         cannot_ready: "Cannot ready shipment."
       stock_location_required: "A stock_location_id parameter must be provided in order to retrieve stock movements."
       invalid_taxonomy_id: "Invalid taxonomy id."
-      shipment_transfer_errors_occured: "Following errors occured while attempting this action:"
+      shipment_transfer_errors_occurred: "Following errors occured while attempting this action:"
       negative_quantity: "quantity is negative"
       wrong_shipment_target: "target shipment is the same as original shipment"
 

data/docs/oauth/index.yml

@@ -1,17 +1,24 @@
 openapi: 3.0.0
 servers:
-  - url: 'http://localhost:3000/spree_oauth'
+  - url: 'https://demo.spreecommerce.org'
+    description: demo
+  - url: 'http://localhost:3000'
+    description: localhost
 info:
   version: 1.0.0
   title: Spree OAuth 2.0 Authentication
-  description: >-
-    Spree uses the [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) gem
-    for handling OAuth. This integration is built into `spree_api` gem.
+  description: "For API v2 Spree uses [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) gem for handling OAuth athentication. \n\nSpree supports new token creation and refreshing of existing tokens."
+  contact:
+    name: Spark Solutions
+    url: 'https://sparksolutions.co'
+    email: we@sparksolutions.co
+  license:
+    url: 'https://github.com/spree/spree/blob/master/license.md'
+    name: BSD-3-Clause
 paths:
-  '/token':
+  /spree_oauth/token:
     post:
-      description: >-
-        Creates or refreshes a Bearer token required to authorize calls API calls
+      description: Creates or refreshes a Bearer token required to authorize calls API calls
       tags:
         - Token
       operationId: Create or Refresh Token
@@ -22,14 +29,40 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Token'
+              examples:
+                create token:
+                  value:
+                    access_token: SfM3k8kq5Wkc6xz6rgMlsl-mbygJ1ptq4DR0Ah51vjA
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+                    created_at: 1581873931
+                refresh token:
+                  value:
+                    access_token: Es9lLPW2mVaDB80I-I_OdQCw3JfOT1s19YN1naFWx98
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: j92BxulqIIYtiiaBsuAM1TzGsGSVxaykT4kk8OYHGNY
+                    created_at: 1581876572
       requestBody:
         required: true
         content:
-          application/x-www-form-urlencoded:
+          application/json:
             schema:
               oneOf:
                 - $ref: '#/components/schemas/CreateTokenBody'
                 - $ref: '#/components/schemas/RefreshTokenBody'
+            examples:
+              create token:
+                value:
+                  grant_type: password
+                  username: spree@example.com
+                  password: spree123
+              refresh token:
+                value:
+                  grant_type: refresh_token
+                  refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+        description: ''
 components:
   schemas:
     Token:
@@ -44,34 +77,64 @@ components:
         expires_in:
           type: integer
           example: 7200
-          description: 'Time (in seconds) after which the access token will expire'
+          description: Time (in seconds) after which the access token will expire
         refresh_token:
           type: string
           example: f5d78642252eeb3f3001f67b196ac21a27afc030462a54060b0ebbdae2b8dc9c
         created_at:
           type: integer
           example: 1539863418
+      x-examples:
+        create token:
+          access_token: SfM3k8kq5Wkc6xz6rgMlsl-mbygJ1ptq4DR0Ah51vjA
+          token_type: Bearer
+          expires_in: 7200
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+          created_at: 1581873931
+        refresh token:
+          access_token: Es9lLPW2mVaDB80I-I_OdQCw3JfOT1s19YN1naFWx98
+          token_type: Bearer
+          expires_in: 7200
+          refresh_token: j92BxulqIIYtiiaBsuAM1TzGsGSVxaykT4kk8OYHGNY
+          created_at: 1581876572
     CreateTokenBody:
+      type: object
+      x-examples:
+        example-1:
+          grant_type: password
+          username: spree@example.com
+          password: spree123
       properties:
         grant_type:
           type: string
           default: password
-          description: >-
-            Use `password` to create a token and `refresh_token` to refresh it
+          description: Use `password` to create a token and `refresh_token` to refresh it
         username:
           type: string
           description: User email address
-          example: 'spree@example.com'
+          example: spree@example.com
         password:
           type: string
           description: User password
-          example: 'spree123'
+          example: spree123
+      required:
+        - grant_type
+        - username
+        - password
     RefreshTokenBody:
+      type: object
       properties:
         grant_type:
           type: string
           default: refresh_token
         refresh_token:
           type: string
-          description: Rerefresh token obtained from the old created token
-          example: 27af95fd57a424e5d01aaf5eab1324a8d5c0ca57daf384fae39f811a5144330143301'
+          description: Refresh token obtained from the create token response
+          example: "27af95fd57a424e5d01aaf5eab1324a8d5c0ca57daf384fae39f811a5144330143301'"
+      required:
+        - grant_type
+        - refresh_token
+      x-examples:
+        example-1:
+          grant_type: refresh_token
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k