spree_api 3.7.0.rc3 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb5034c1887c750d3b1437db3d0a922dc85a2b918362398e5fd09d23ad53cad0
-  data.tar.gz: 8bc92a25c619d9569861bdf0c2bb95a95fbfc06ad1776eb47c80d734c01e4a47
+  metadata.gz: 44cc06b0850a333645e6a6d2bf64cf12f4027c00c384d63b93cb5f300e078d24
+  data.tar.gz: b4afc56d8582365d30138740d9801048204f41a457b8586ecab81e2bda551d41
 SHA512:
-  metadata.gz: deed5581a6699910b7ef95e4f3674f1c090a1a0a2f54e47f0f2789b9962a9dd596d7c94416222ccc871a99756037601b4587f0bab673e33cb60323f38c4f47ae
-  data.tar.gz: ee2ae411b29c449168adf4d8ebf9226500fd8414638ac4c9e29daa921483f408de143e0cbbddc85a46e88aa14a99beab8071f30b7b4ed1d847a420d16a9942d2
+  metadata.gz: 2d23e8bf8132452698c0a7e5e837e4c602786ffc6643b4816d9f9b800c86411fd89c73acab7caf67dd13a547d562a8135260bb4603e7d54cc6c93ba2ca790ef5
+  data.tar.gz: d8c110fd93c97c51e03d02c8783ae232afdf18227fe9c6ae8a6b7aba755d4638b004a3af6760953dbc67089850cce19923beb498761f6a855e25aaed8699e334

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

@@ -7,6 +7,10 @@ module Spree
         rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
         rescue_from CanCan::AccessDenied, with: :access_denied
 
+        def content_type
+          Spree::Api::Config[:api_v2_content_type]
+        end
+
         private
 
         def collection_paginator
@@ -14,16 +18,16 @@ module Spree
         end
 
         def render_serialized_payload(status = 200)
-          render json: yield, status: status
+          render json: yield, status: status, content_type: content_type
         rescue ArgumentError => exception
           render_error_payload(exception.message, 400)
         end
 
         def render_error_payload(error, status = 422)
           if error.is_a?(Struct)
-            render json: { error: error.to_s, errors: error.to_h }, status: status
+            render json: { error: error.to_s, errors: error.to_h }, status: status, content_type: content_type
           elsif error.is_a?(String)
-            render json: { error: error }, status: status
+            render json: { error: error }, status: status, content_type: content_type
           end
         end
 

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

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class OrderStatusController < ::Spree::Api::V2::BaseController
+          include Spree::Api::V2::Storefront::OrderConcern
+
+          def show
+            render_serialized_payload { serialize_resource(resource) }
+          end
+
+          private
+
+          def resource
+            resource = resource_finder.new(number: params[:number], token: order_token).execute.take
+            raise ActiveRecord::RecordNotFound if resource.nil?
+
+            resource
+          end
+
+          def serialize_resource(resource)
+            resource_serializer.new(
+              resource,
+              include: resource_includes,
+              sparse_fields: sparse_fields
+            ).serializable_hash
+          end
+
+          def resource_finder
+            Spree::Api::Dependencies.storefront_completed_order_finder.constantize
+          end
+
+          def resource_serializer
+            Spree::Api::Dependencies.storefront_cart_serializer.constantize
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/api_configuration.rb

@@ -1,5 +1,6 @@
 module Spree
   class ApiConfiguration < Preferences::Configuration
     preference :requires_authentication, :boolean, default: true
+    preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
   end
 end

data/config/initializers/json_api_mime_types.rb

@@ -0,0 +1,8 @@
+api_mime_types = %w(
+  application/vnd.api+json
+  text/x-json
+  application/json
+)
+
+Mime::Type.unregister :json
+Mime::Type.register 'application/json', :json, api_mime_types

data/config/routes.rb

@@ -158,6 +158,7 @@ Spree::Core::Engine.add_routes do
 
         resources :countries, only: %i[index]
         get '/countries/:iso', to: 'countries#show', as: :country
+        get '/order_status/:number', to: 'order_status#show', as: :order_status
         resources :products, only: %i[index show]
         resources :taxons,   only: %i[index show]
       end

data/docs/v2/storefront/index.yaml

@@ -34,7 +34,7 @@ paths:
         '200':
           description: ok
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Account'
         '403':
@@ -53,7 +53,7 @@ paths:
         '200':
           description: Listing user credit cards.
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/CreditCardList'
         '403':
@@ -80,7 +80,7 @@ paths:
         '200':
           description: Listing user default credit card.
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/CreditCard'
         '403':
@@ -100,7 +100,7 @@ paths:
         '200':
           description: Listing user completed orders.
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/CartList'
         '403':
@@ -123,7 +123,7 @@ paths:
         '200':
           description: Listing user completed order.
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '403':
@@ -134,6 +134,26 @@ paths:
         - $ref: '#/components/parameters/SparseFieldsParam'
       security:
         - bearerAuth: []
+  '/order_status/{number}':
+    get:
+      description: >-
+        Returns placed Order
+      tags:
+        - Order Status
+      operationId: 'Order Status'
+      responses:
+        '200':
+          description: Requested Order information
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Cart'
+        '404':
+          $ref: '#/components/responses/404NotFound'
+      parameters:
+        - $ref: '#/components/parameters/OrderParam'
+        - $ref: '#/components/parameters/CartIncludeParam'
+        - $ref: '#/components/parameters/SparseFieldsParam'
   '/cart':
     post:
       description: >-
@@ -150,7 +170,7 @@ paths:
         '201':
           description: Cart was successfully created
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
       parameters:
@@ -165,7 +185,7 @@ paths:
         '200':
           description: Correct cart was returned
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '404':
@@ -197,7 +217,7 @@ paths:
         '200':
           description: Item was added to the Cart successfully
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '404':
@@ -211,7 +231,7 @@ paths:
       requestBody:
         required: true
         content:
-          application/json:
+          application/vnd.api+json:
             schema:
               type: object
               properties:
@@ -240,13 +260,13 @@ paths:
         '200':
           description: New quantity has been successfully set for a requested Line Item
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Stock quantity is not sufficient for this request to be fulfielled
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
       security:
@@ -258,7 +278,7 @@ paths:
       requestBody:
         required: true
         content:
-          application/json:
+          application/vnd.api+json:
             schema:
               type: object
               properties:
@@ -284,7 +304,7 @@ paths:
         '200':
           description: Requested Line Item has been removed from the Cart
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '404':
@@ -303,7 +323,7 @@ paths:
         '200':
           description: Cart has been successfully emptied
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '404':
@@ -325,13 +345,13 @@ paths:
         '200':
           description: Cuopon code was applied successfully
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Coupon code couldn't be applied
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
       security:
@@ -343,7 +363,7 @@ paths:
       requestBody:
         required: true
         content:
-          application/json:
+          application/vnd.api+json:
             schema:
               type: object
               properties:
@@ -371,13 +391,13 @@ paths:
         '200':
           description: Coupon code was removed successfully
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Coupon code couldn't be removed
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
       security:
@@ -496,13 +516,13 @@ paths:
         '200':
           description: Checkout was updated
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Checkout couldn't be updated
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -515,7 +535,7 @@ paths:
       requestBody:
         required: true
         content:
-          application/json:
+          application/vnd.api+json:
             schema:
               type: object
               properties:
@@ -553,13 +573,13 @@ paths:
         '200':
           description: Checkout transitioned to the next step
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Checkout couldn't transition to the next step
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -581,13 +601,13 @@ paths:
         '200':
           description: Checkout was advanced to the furthest step
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Checkout couldn't transition to the next step
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -609,13 +629,13 @@ paths:
         '200':
           description: Checkout was completed
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Checkout couldn't be completed
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -636,13 +656,13 @@ paths:
         '200':
           description: Store Credit payment created
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Store Credit couldn't be created
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -671,13 +691,13 @@ paths:
         '200':
           description: Store Credit payment removed
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Cart'
         '422':
           description: Store Credit payments weren't removed
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
@@ -700,7 +720,7 @@ paths:
         '200':
           description: Returns a list of available Payment Methods
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/PaymentMethodsList'
         '404':
@@ -723,7 +743,7 @@ paths:
         '200':
           description: Returns a list of available Shipping Rates for Checkout
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/ShippingRatesList'
         '404':
@@ -788,7 +808,7 @@ paths:
         '200':
           description: Returns a list of Products
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/ProductsList'
   '/products/{id}':
@@ -810,7 +830,7 @@ paths:
         '200':
           description: Returns the requested Product
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Product'
         '404':
@@ -852,7 +872,7 @@ paths:
         '200':
           description: Returns a list of Taxons
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/TaxonsList'
 
@@ -875,7 +895,7 @@ paths:
         '200':
           description: Returns the reqested Taxon
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Taxon'
         '404':
@@ -892,7 +912,7 @@ paths:
         '200':
           description: Returns a list of all Countries
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/CountriesList'
 
@@ -915,7 +935,7 @@ paths:
         '200':
           description: Returns the requested Country
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Country'
         '404':
@@ -936,7 +956,7 @@ paths:
         '200':
           description: Returns the default Country
           content:
-            application/json:
+            application/vnd.api+json:
               schema:
                 $ref: '#/components/schemas/Country'
 
@@ -2528,7 +2548,7 @@ components:
     404NotFound:
       description: Resource not found
       content:
-        application/json:
+        application/vnd.api+json:
           schema:
             properties:
               error:
@@ -2538,7 +2558,7 @@ components:
     403Forbidden:
       description: You are not authorized to access this page.
       content:
-        application/json:
+        application/vnd.api+json:
           schema:
             properties:
               error:

data/lib/spree/api/testing_support/v2/base.rb

@@ -0,0 +1,13 @@
+shared_context 'API v2 tokens' do
+  let(:token) { Doorkeeper::AccessToken.create!(resource_owner_id: user.id, expires_in: nil) }
+  let(:headers_bearer) { { 'Authorization' => "Bearer #{token.token}" } }
+  let(:headers_order_token) { { 'X-Spree-Order-Token' => order.token } }
+end
+
+[200, 201, 400, 404, 403, 422].each do |status_code|
+  shared_examples "returns #{status_code} HTTP status" do
+    it "returns #{status_code}" do
+      expect(response.status).to eq(status_code)
+    end
+  end
+end

data/lib/spree/api/testing_support/v2/current_order.rb

@@ -0,0 +1,73 @@
+def ensure_order_totals
+  order.update_totals
+  order.persist_totals
+end
+
+shared_context 'creates order with line item' do
+  let!(:line_item) { create(:line_item, order: order, currency: currency) }
+  let!(:headers)   { headers_bearer }
+
+  before { ensure_order_totals }
+end
+
+shared_context 'creates guest order with guest token' do
+  let(:guest_token) { 'guest_token' }
+  let!(:order)      { create(:order, token: guest_token, store: store, currency: currency) }
+  let!(:line_item)  { create(:line_item, order: order, currency: currency) }
+  let!(:headers)    { headers_order_token }
+
+  before { ensure_order_totals }
+end
+
+shared_examples 'returns valid cart JSON' do
+  it 'returns a valid cart JSON response' do
+    order.reload
+    expect(json_response['data']).to be_present
+    expect(json_response['data']).to have_id(order.id.to_s)
+    expect(json_response['data']).to have_type('cart')
+    expect(json_response['data']).to have_attribute(:number).with_value(order.number)
+    expect(json_response['data']).to have_attribute(:state).with_value(order.state)
+    expect(json_response['data']).to have_attribute(:token).with_value(order.token)
+    expect(json_response['data']).to have_attribute(:total).with_value(order.total.to_s)
+    expect(json_response['data']).to have_attribute(:item_total).with_value(order.item_total.to_s)
+    expect(json_response['data']).to have_attribute(:ship_total).with_value(order.ship_total.to_s)
+    expect(json_response['data']).to have_attribute(:adjustment_total).with_value(order.adjustment_total.to_s)
+    expect(json_response['data']).to have_attribute(:included_tax_total).with_value(order.included_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:additional_tax_total).with_value(order.additional_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_additional_tax_total).with_value(order.display_additional_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_included_tax_total).with_value(order.display_included_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:tax_total).with_value(order.tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:currency).with_value(order.currency.to_s)
+    expect(json_response['data']).to have_attribute(:email).with_value(order.email)
+    expect(json_response['data']).to have_attribute(:display_item_total).with_value(order.display_item_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_ship_total).with_value(order.display_ship_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_adjustment_total).with_value(order.display_adjustment_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_tax_total).with_value(order.display_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:item_count).with_value(order.item_count)
+    expect(json_response['data']).to have_attribute(:special_instructions).with_value(order.special_instructions)
+    expect(json_response['data']).to have_attribute(:promo_total).with_value(order.promo_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_promo_total).with_value(order.display_promo_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_total).with_value(order.display_total.to_s)
+    expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)
+  end
+end
+
+shared_examples 'no current order' do
+  context "order doesn't exist" do
+    before do
+      order.destroy
+      execute
+    end
+
+    it_behaves_like 'returns 404 HTTP status'
+  end
+
+  context 'already completed order' do
+    before do
+      order.update_column(:completed_at, Time.current)
+      execute
+    end
+
+    it_behaves_like 'returns 404 HTTP status'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 3.7.0.rc3
+  version: 3.7.0
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.0.rc3
+        version: 3.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.0.rc3
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ files:
 - app/controllers/spree/api/v2/storefront/cart_controller.rb
 - app/controllers/spree/api/v2/storefront/checkout_controller.rb
 - app/controllers/spree/api/v2/storefront/countries_controller.rb
+- app/controllers/spree/api/v2/storefront/order_status_controller.rb
 - app/controllers/spree/api/v2/storefront/products_controller.rb
 - app/controllers/spree/api/v2/storefront/taxons_controller.rb
 - app/helpers/spree/api/api_helpers.rb
@@ -282,6 +283,7 @@ files:
 - app/views/spree/api/v1/zones/index.v1.rabl
 - app/views/spree/api/v1/zones/show.v1.rabl
 - config/initializers/doorkeeper.rb
+- config/initializers/json_api_mime_types.rb
 - config/initializers/metal_load_paths.rb
 - config/initializers/user_class_extensions.rb
 - config/locales/en.yml
@@ -301,6 +303,8 @@ files:
 - lib/spree/api/testing_support/caching.rb
 - lib/spree/api/testing_support/helpers.rb
 - lib/spree/api/testing_support/setup.rb
+- lib/spree/api/testing_support/v2/base.rb
+- lib/spree/api/testing_support/v2/current_order.rb
 - lib/spree_api.rb
 - script/rails
 - spec/fixtures/thinking-cat.jpg
@@ -320,9 +324,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.2
 signing_key: