spree_api 4.3.0 → 4.5.1

data/config/routes.rb

@@ -6,126 +6,6 @@ end
 
 Spree::Core::Engine.add_routes do
   namespace :api, defaults: { format: 'json' } do
-    namespace :v1 do
-      resources :promotions, only: [:show]
-
-      resources :customer_returns, only: [:index]
-      resources :reimbursements, only: [:index]
-
-      resources :products do
-        resources :images
-        resources :variants
-        resources :product_properties
-      end
-
-      concern :order_routes do
-        member do
-          put :approve
-          put :cancel
-          put :empty
-          put :apply_coupon_code
-        end
-
-        resources :line_items
-        resources :payments do
-          member do
-            put :authorize
-            put :capture
-            put :purchase
-            put :void
-            put :credit
-          end
-        end
-
-        resources :addresses, only: [:show, :update]
-
-        resources :return_authorizations do
-          member do
-            put :add
-            put :cancel
-            put :receive
-          end
-        end
-      end
-
-      resources :checkouts, only: [:update], concerns: :order_routes do
-        member do
-          put :next
-          put :advance
-        end
-      end
-
-      resources :variants do
-        resources :images
-      end
-
-      resources :option_types do
-        resources :option_values
-      end
-      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'
-
-      resources :orders, concerns: :order_routes do
-        put :remove_coupon_code, on: :member
-      end
-
-      resources :zones
-      resources :countries, only: [:index, :show] do
-        resources :states, only: [:index, :show]
-      end
-
-      resources :shipments, only: [:create, :update] do
-        collection do
-          post 'transfer_to_location'
-          post 'transfer_to_shipment'
-          get :mine
-        end
-
-        member do
-          put :ready
-          put :ship
-          put :add
-          put :remove
-        end
-      end
-      resources :states, only: [:index, :show]
-
-      resources :taxonomies do
-        member do
-          get :jstree
-        end
-        resources :taxons do
-          member do
-            get :jstree
-          end
-        end
-      end
-
-      resources :taxons, only: [:index]
-
-      resources :inventory_units, only: [:show, :update]
-
-      resources :users do
-        resources :credit_cards, only: [:index]
-      end
-
-      resources :properties
-      resources :stock_locations do
-        resources :stock_movements
-        resources :stock_items
-      end
-
-      resources :stock_items, only: [:index, :update, :destroy]
-      resources :stores
-
-      put '/classifications', to: 'classifications#update', as: :classifications
-      get '/taxons/products', to: 'taxons#products', as: :taxon_products
-    end
-
     namespace :v2 do
       namespace :storefront do
         resource :cart, controller: :cart, only: %i[show create destroy] do
@@ -145,10 +25,12 @@ Spree::Core::Engine.add_routes do
           patch :next
           patch :advance
           patch :complete
+          post :create_payment
           post :add_store_credit
           post :remove_store_credit
           get :payment_methods
           get :shipping_rates
+          patch :select_shipping_method
         end
 
         resource :account, controller: :account, only: %i[show create update]
@@ -165,35 +47,51 @@ Spree::Core::Engine.add_routes do
         resources :products, only: %i[index show]
         resources :taxons,   only: %i[index show], id: /.+/
         get '/stores/:code', to: 'stores#show', as: :store
+        get '/store', to: 'stores#current', as: :current_store
 
         resources :menus, only: %i[index show]
         resources :cms_pages, only: %i[index show]
+
+        resources :wishlists do
+          get :default, on: :collection
+
+          member do
+            post :add_item
+            patch 'set_item_quantity/:item_id', to: 'wishlists#set_item_quantity', as: :set_item_quantity
+            delete 'remove_item/:item_id', to: 'wishlists#remove_item', as: :remove_item
+          end
+        end
+
+        get '/digitals/:token', to: 'digitals#download', as: 'digital'
       end
 
       namespace :platform do
         # Promotions API
         resources :promotions
+        resources :promotion_actions
+        resources :promotion_categories
+        resources :promotion_rules
 
         # Returns API
         resources :customer_returns
         resources :reimbursements
         resources :return_authorizations do
           member do
-            put :add
-            put :cancel
-            put :receive
+            patch :add
+            patch :cancel
+            patch :receive
           end
         end
 
         # Product Catalog API
         resources :products
         resources :taxonomies
-        resources :taxons
-        resources :classifications do
+        resources :taxons do
           member do
-            put :reposition
+            patch :reposition
           end
         end
+        resources :classifications
         resources :images
         resources :variants
         resources :properties
@@ -204,26 +102,38 @@ Spree::Core::Engine.add_routes do
         # Order API
         resources :orders do
           member do
-            put :next
-            put :advance
-            put :approve
-            put :cancel
-            put :empty
-            put :apply_coupon_code
-            put :remove_coupon_code
+            patch :next
+            patch :advance
+            patch :approve
+            patch :cancel
+            patch :empty
+            patch :apply_coupon_code
+            patch :complete
+            patch :use_store_credit
+            patch :cancel
+            patch :approve
           end
         end
         resources :line_items
+        resources :adjustments
+
+        # Payments API
         resources :payments do
-          member do
-            put :authorize
-            put :capture
-            put :purchase
-            put :void
-            put :credit
-          end
+          # TODO: support custom actions
+          # member do
+          #   patch :authorize
+          #   patch :capture
+          #   patch :purchase
+          #   patch :void
+          #   patch :credit
+          # end
         end
 
+        # Store Credit API
+        resources :store_credits
+        resources :store_credit_categories
+        resources :store_credit_types
+
         # Geo API
         resources :zones
         resources :countries, only: [:index, :show]
@@ -231,18 +141,21 @@ Spree::Core::Engine.add_routes do
 
         # Shipment API
         resources :shipments do
-          collection do
-            post 'transfer_to_location'
-            post 'transfer_to_shipment'
-          end
           member do
-            put :ready
-            put :ship
-            put :add
-            put :remove
+            %w[ready ship cancel resume pend].each do |state|
+              patch state.to_sym
+            end
+            patch :add_item
+            patch :remove_item
+            patch :transfer_to_location
+            patch :transfer_to_shipment
           end
         end
 
+        # Tax API
+        resources :tax_rates
+        resources :tax_categories
+
         # Inventory API
         resources :inventory_units
         resources :stock_items
@@ -254,6 +167,8 @@ Spree::Core::Engine.add_routes do
         resources :credit_cards
         resources :addresses
 
+        resources :roles
+
         # Menu API
         resources :menus
         resources :menu_items do
@@ -262,46 +177,36 @@ Spree::Core::Engine.add_routes do
           end
         end
 
-        # CMS Pages API
-        resources :cms_pages do
-          member do
-            patch :toggle_visibility
-          end
-        end
+        # CMS
+        resources :cms_pages
+        resources :cms_sections
+
+        # Wishlists API
+        resources :wishlists
+        resources :wished_items
 
-        resource :cms_sections do
+        # Digitals API
+        resources :digitals
+        resources :digital_links do
           member do
-            patch :reposition
+            patch :reset
           end
         end
 
         # Store API
         resources :stores
-      end
-    end
-
-    get '/404', to: 'errors#render_404'
 
-    match 'v:api/*path', to: redirect { |params, request|
-      format = ".#{params[:format]}" unless params[:format].blank?
-      query  = "?#{request.query_string}" unless request.query_string.blank?
+        # Configurations API
+        resources :payment_methods
+        resources :shipping_categories
+        resources :shipping_methods
 
-      if request.path == "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-        "#{spree_path}api/404"
-      else
-        "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-      end
-    }, via: [:get, :post, :put, :patch, :delete]
-
-    match '*path', to: redirect { |params, request|
-      format = ".#{params[:format]}" unless params[:format].blank?
-      query  = "?#{request.query_string}" unless request.query_string.blank?
-
-      if request.path == "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-        "#{spree_path}api/404"
-      else
-        "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
+        # Webhooks API
+        namespace :webhooks do
+          resources :events, only: :index
+          resources :subscribers
+        end
       end
-    }, via: [:get, :post, :put, :patch, :delete]
+    end
   end
 end

data/db/migrate/20210902162826_create_spree_webhooks_tables.rb

@@ -0,0 +1,16 @@
+class CreateSpreeWebhooksTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_subscribers do |t|
+      t.string :url, null: false
+      t.boolean :active, default: false, index: true
+
+      if t.respond_to? :jsonb
+        t.jsonb :subscriptions
+      else
+        t.json :subscriptions
+      end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210919183228_enable_polymorphic_resource_owner.rb

@@ -0,0 +1,21 @@
+class EnablePolymorphicResourceOwner < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_oauth_access_tokens, :resource_owner_type, :string
+    add_column :spree_oauth_access_grants, :resource_owner_type, :string
+    change_column_null :spree_oauth_access_grants, :resource_owner_type, false
+
+    add_index :spree_oauth_access_tokens,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_tokens'
+
+    add_index :spree_oauth_access_grants,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_grants'
+
+    Spree::OauthAccessToken.reset_column_information
+    Spree::OauthAccessToken.update_all(resource_owner_type: Spree.user_class)
+
+    Spree::OauthAccessGrant.reset_column_information
+    Spree::OauthAccessGrant.update_all(resource_owner_type: Spree.user_class)
+  end
+end

data/db/migrate/20211025162826_create_spree_webhooks_events.rb

@@ -0,0 +1,14 @@
+class CreateSpreeWebhooksEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_events do |t|
+      t.integer "execution_time"
+      t.string "name", null: false
+      t.string "request_errors"
+      t.string "response_code", index: true
+      t.belongs_to "subscriber", null: false, index: true
+      t.boolean "success", index: true
+      t.string "url", null: false
+      t.timestamps
+    end
+  end
+end

data/docs/oauth/index.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.0.3
 servers:
   - url: 'https://demo.spreecommerce.org'
     description: demo
@@ -7,7 +7,7 @@ servers:
 info:
   version: 1.0.0
   title: Authentication
-  description: "Spree uses oAuth based Authentication via short-lived Bearer tokens. You can either create a new one or refresh existing token."
+  description: Spree uses oAuth based Authentication via short-lived Bearer tokens. You can either create a new one or refresh existing token.
   contact:
     name: Spark Solutions
     url: 'https://sparksolutions.co'
@@ -18,26 +18,35 @@ info:
 paths:
   /spree_oauth/token:
     post:
-      description: Creates or refreshes a Bearer token required to authorize API calls
-      tags:
-        - Token
-      operationId: Create or Refresh Token
+      description: |-
+        This endpoint creates a new Bearer Token or refreshes an existing Bearer Token.
+
+        The `token` found in the response body is required to authorize API calls.
+      operationId: create-or-refresh-token
       responses:
         '200':
-          description: Token was successfully created or refreshed
+          description: Token was successfully created or refreshed.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Token'
               examples:
-                create token:
+                Storefront User Token:
                   value:
                     access_token: SfM3k8kq5Wkc6xz6rgMlsl-mbygJ1ptq4DR0Ah51vjA
                     token_type: Bearer
                     expires_in: 7200
                     refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
                     created_at: 1581873931
-                refresh token:
+                Platform User Token:
+                  value:
+                    access_token: 2480c16561d1391ea81ca5336b651e9a29f4524f6dee8c7f3f02a600159189c3
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: f5d78642252eeb3f3001f67b196ac21a27afc030462a54060b0ebbdae2b8dc9c
+                    scope: admin
+                    created_at: 1539863418
+                Refreshed Token:
                   value:
                     access_token: Es9lLPW2mVaDB80I-I_OdQCw3JfOT1s19YN1naFWx98
                     token_type: Bearer
@@ -51,21 +60,57 @@ paths:
             schema:
               oneOf:
                 - $ref: '#/components/schemas/CreateTokenBody'
+                - $ref: '#/components/schemas/ClientTokenBody'
                 - $ref: '#/components/schemas/RefreshTokenBody'
             examples:
-              create token:
+              Create Storefront API User Token:
+                value:
+                  grant_type: password
+                  username: spree@example.com
+                  password: spree123
+              Create Platform API User Token:
                 value:
+                  client_id: 7ZY15L7crVZul8i3PZPrnpOkEURK7xnXEWRZdE6K39M
+                  client_secret: cxMZ0tbe604qj_13hibNmc3GDsXUQfpzHt9PvweihFc
                   grant_type: password
                   username: spree@example.com
                   password: spree123
-              refresh token:
+                  scope: admin
+              Create Platform API Application Token:
+                value:
+                  grant_type: client_credentials
+                  client_id: 7ZY15L7crVZul8i3PZPrnpOkEURK7xnXEWRZdE6K39M
+                  client_secret: cxMZ0tbe604qj_13hibNmc3GDsXUQfpzHt9PvweihFc
+                  scope: admin
+              Refresh a Token:
                 value:
                   grant_type: refresh_token
                   refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+          application/xml:
+            schema:
+              type: object
+              properties: {}
         description: ''
+      summary: Create or Refresh a Token
+      tags:
+        - Token
 components:
   schemas:
     Token:
+      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
+      type: object
       properties:
         access_token:
           type: string
@@ -81,34 +126,42 @@ components:
         refresh_token:
           type: string
           example: f5d78642252eeb3f3001f67b196ac21a27afc030462a54060b0ebbdae2b8dc9c
+        scope:
+          type: string
+          example: admin
+          default: admin
         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
+      required:
+        - access_token
+        - token_type
+        - expires_in
+        - refresh_token
+        - created_at
+      x-internal: true
     CreateTokenBody:
       type: object
       x-examples:
-        example-1:
+        User Token:
+          grant_type: password
+          username: spree@example.com
+          password: spree123
+        Application Token:
           grant_type: password
           username: spree@example.com
           password: spree123
+          scope: admin
+      x-internal: true
+      title: 'Create a new token (grant_type: password)'
+      description: ''
       properties:
         grant_type:
           type: string
-          default: password
-          description: Use `password` to create a token and `refresh_token` to refresh it
+          description: ''
+          example: password
+          enum:
+            - password
         username:
           type: string
           description: User email address
@@ -117,24 +170,64 @@ components:
           type: string
           description: User password
           example: spree123
+        scope:
+          type: string
+          enum:
+            - admin
+          description: 'Pass the value `admin` to create a Platform User Token, allowing access to the Platform API.'
+          nullable: true
       required:
         - grant_type
         - username
         - password
-    RefreshTokenBody:
+    ClientTokenBody:
       type: object
+      x-examples:
+        example-1:
+          grant_type: refresh_token
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+      x-internal: true
+      title: 'Create a new token (grant_type: client_credentials)'
+      description: ''
       properties:
         grant_type:
           type: string
-          default: refresh_token
-        refresh_token:
+          example: client_credentials
+          enum:
+            - client_credentials
+        client_id:
           type: string
-          description: Refresh token obtained from the create token response
-          example: "27af95fd57a424e5d01aaf5eab1324a8d5c0ca57daf384fae39f811a5144330143301'"
+          description: Use the client id
+          example: 27af95fd57a424e5d01aaf5eab
+        client_secret:
+          type: string
+          example: 1324a8d5c0ca57daf384fae39f811a5144330143301'
+          description: Client secret key.
       required:
         - grant_type
-        - refresh_token
+        - client_id
+        - client_secret
+    RefreshTokenBody:
+      type: object
       x-examples:
         example-1:
           grant_type: refresh_token
           refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+      x-internal: true
+      title: 'Refresh an existing token (grant_type: refresh_token)'
+      description: ''
+      properties:
+        grant_type:
+          type: string
+          example: refresh_token
+          enum:
+            - refresh_token
+        refresh_token:
+          type: string
+          description: Refresh token obtained from the create token response
+          example: 27af95fd57a424e5d01aaf5eab1324a8d5c0ca57daf384fae39f811a5144330143301'
+      required:
+        - grant_type
+        - refresh_token
+tags:
+  - name: Token