spree_api 4.2.0.beta → 4.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d7a31de48e37ea579244e2c62fb47e2891f5663b095aa8f49de99ecc24abc1e
-  data.tar.gz: 6d5470cb5181210801f5210f46b1e0fc7a3d704b8cd930f372a0544b5861713b
+  metadata.gz: 6ca201da4875f262850ded05d71868a5161f3e8055c6047b544bef63f536e5d3
+  data.tar.gz: cfc2c37c3bdd2041b91cfa4cffad2643f4131a69fb8793b6eb6c793e5ae17ee6
 SHA512:
-  metadata.gz: 0b79cb583334e0813cde900718b6062a3601761aba2093159846a383c684219735ebf6861056a24376701d072e766eb74b2a280ef9dacf0f4993f67237dc6c01
-  data.tar.gz: 2429b6091f2e256743136cef85b42a65cfd53f9daadc6b1a5f3945c0fba1b9a1f882491edc85f0cf8a22cd7a7ee8dbed30c174f53e3d139b7d62eda8fe91c4a4
+  metadata.gz: dfd25ddcca9e0fb04dd7141cfa5fb153ff43de9f0137fa3d78618300a71372c5057de303ab0728da69aa08c3e0a0eba0675493bf0bf42caa8f325207fb94603c
+  data.tar.gz: 4798f5ddbfc85d778adcfd0509ea7d2361f1464a61ae6a194d4d8f7d1014738e570a89c17b95c735317f25394ca8ad75c148e1fc81d4a2f195a986a8ac63f55a

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

@@ -53,7 +53,12 @@ module Spree
         end
 
         def spree_current_user
-          @spree_current_user ||= Spree.user_class.find_by(id: doorkeeper_token.resource_owner_id) if doorkeeper_token
+          return nil unless doorkeeper_token
+          return @spree_current_user if @spree_current_user
+
+          doorkeeper_authorize!
+
+          @spree_current_user ||= Spree.user_class.find_by(id: doorkeeper_token.resource_owner_id)
         end
 
         def spree_authorize!(action, subject, *args)

data/app/controllers/spree/api/v2/storefront/account/addresses_controller.rb

@@ -0,0 +1,77 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        module Account
+          class AddressesController < ::Spree::Api::V2::BaseController
+            before_action :require_spree_current_user
+
+            def index
+              render_serialized_payload { serialize_collection(collection) }
+            end
+
+            def create
+              result = create_service.call(user: spree_current_user, address_params: address_params)
+              render_result(result)
+            end
+
+            def update
+              result = update_service.call(address: resource, address_params: address_params)
+              render_result(result)
+            end
+
+            private
+
+            def collection
+              collection_finder.new(scope: scope, params: params).execute
+            end
+
+            def resource
+              @resource ||= scope.find(params[:id])
+            end
+
+            def scope
+              spree_current_user.addresses
+            end
+
+            def collection_finder
+              Spree::Api::Dependencies.storefront_address_finder.constantize
+            end
+
+            def collection_serializer
+              Spree::Api::Dependencies.storefront_address_serializer.constantize
+            end
+
+            def resource_serializer
+              Spree::Api::Dependencies.storefront_address_serializer.constantize
+            end
+
+            def serialize_collection(collection)
+              collection_serializer.new(collection).serializable_hash
+            end
+
+            def create_service
+              Spree::Api::Dependencies.storefront_account_create_address_service.constantize
+            end
+
+            def update_service
+              Spree::Api::Dependencies.storefront_account_update_address_service.constantize
+            end
+
+            def address_params
+              params.require(:address).permit(permitted_address_attributes)
+            end
+
+            def render_result(result)
+              if result.success?
+                render_serialized_payload { serialize_resource(result.value) }
+              else
+                render_error_payload(result.error)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -125,8 +125,7 @@ module Spree
           def serialize_shipping_rates(shipments)
             shipping_rates_serializer.new(
               shipments,
-              include: [:shipping_rates],
-              params: { show_rates: true }
+              include: [:shipping_rates, :stock_location]
             ).serializable_hash
           end
         end

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

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class StoresController < ::Spree::Api::V2::BaseController
+          def show
+            render_serialized_payload { serialize_resource(resource) }
+          end
+
+          private
+
+          def scope
+            Spree::Store
+          end
+
+          def resource
+            scope.find_by!(code: params[:code])
+          end
+
+          def resource_serializer
+            Spree::Api::Dependencies.storefront_store_serializer.constantize
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -51,7 +51,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]

data/app/models/spree/api_dependencies.rb

@@ -13,7 +13,9 @@ module Spree
       :storefront_country_serializer, :storefront_current_order_finder, :storefront_completed_order_finder, :storefront_order_sorter,
       :storefront_collection_paginator, :storefront_user_serializer, :storefront_products_sorter, :storefront_products_finder,
       :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_cart_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer,
+      :storefront_store_serializer, :storefront_address_serializer,
+      :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -48,7 +50,12 @@ module Spree
       @storefront_checkout_remove_store_credit_service = Spree::Dependencies.checkout_remove_store_credit_service
       @storefront_checkout_get_shipping_rates_service = Spree::Dependencies.checkout_get_shipping_rates_service
 
+      # account services
+      @storefront_account_create_address_service = Spree::Dependencies.account_create_address_service
+      @storefront_account_update_address_service = Spree::Dependencies.account_update_address_service
+
       # serializers
+      @storefront_address_serializer = 'Spree::V2::Storefront::AddressSerializer'
       @storefront_cart_serializer = 'Spree::V2::Storefront::CartSerializer'
       @storefront_credit_card_serializer = 'Spree::V2::Storefront::CreditCardSerializer'
       @storefront_country_serializer = 'Spree::V2::Storefront::CountrySerializer'
@@ -58,6 +65,7 @@ module Spree
       @storefront_payment_method_serializer = 'Spree::V2::Storefront::PaymentMethodSerializer'
       @storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'
       @storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'
+      @storefront_store_serializer = 'Spree::V2::Storefront::StoreSerializer'
 
       # sorters
       @storefront_order_sorter = Spree::Dependencies.order_sorter
@@ -67,6 +75,7 @@ module Spree
       @storefront_collection_paginator = Spree::Dependencies.collection_paginator
 
       # finders
+      @storefront_address_finder = Spree::Dependencies.address_finder
       @storefront_country_finder = Spree::Dependencies.country_finder
       @storefront_current_order_finder = Spree::Dependencies.current_order_finder
       @storefront_completed_order_finder = Spree::Dependencies.completed_order_finder

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

@@ -5,7 +5,7 @@ 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

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

@@ -8,7 +8,8 @@ module Spree
                    :updated_at, :completed_at, :included_tax_total, :additional_tax_total, :display_additional_tax_total,
                    :display_included_tax_total, :tax_total, :currency, :state, :token, :email,
                    :display_item_total, :display_ship_total, :display_adjustment_total, :display_tax_total,
-                   :promo_total, :display_promo_total, :item_count, :special_instructions, :display_total
+                   :promo_total, :display_promo_total, :item_count, :special_instructions, :display_total,
+                   :pre_tax_item_amount, :display_pre_tax_item_amount, :pre_tax_total, :display_pre_tax_total
 
         has_many   :line_items
         has_many   :variants

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

@@ -9,7 +9,8 @@ module Spree
                    :display_adjustment_total, :additional_tax_total,
                    :discounted_amount, :display_discounted_amount,
                    :display_additional_tax_total, :promo_total, :display_promo_total,
-                   :included_tax_total, :display_included_tax_total
+                   :included_tax_total, :display_included_tax_total,
+                   :pre_tax_amount, :display_pre_tax_amount
 
         belongs_to :variant
       end

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

@@ -9,7 +9,9 @@ module Spree
 
         attribute :free, &:free?
 
-        has_many :shipping_rates, if: proc { |_record, params| params&.dig(:show_rates) }
+        has_many :shipping_rates
+
+        belongs_to :stock_location
       end
     end
   end

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

@@ -0,0 +1,11 @@
+module Spree
+  module V2
+    module Storefront
+      class StockLocationSerializer < BaseSerializer
+        set_type :stock_location
+
+        attributes :name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Spree
+  module V2
+    module Storefront
+      class StoreSerializer < BaseSerializer
+        set_type :store
+
+        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
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -152,6 +152,7 @@ Spree::Core::Engine.add_routes do
         resource :account, controller: :account, only: %i[show]
 
         namespace :account do
+          resources :addresses, controller: :addresses, only: %i[index create update]
           resources :credit_cards, controller: :credit_cards, only: %i[index show]
           resources :orders, controller: :orders, only: %i[index show]
         end
@@ -161,6 +162,7 @@ Spree::Core::Engine.add_routes do
         get '/order_status/:number', to: 'order_status#show', as: :order_status
         resources :products, only: %i[index show]
         resources :taxons,   only: %i[index show], id: /.+/
+        get '/stores/:code', to: 'stores#show', as: :store
       end
     end
 

data/docs/v2/storefront/index.yaml

@@ -52,7 +52,7 @@ paths:
     post:
       description: >-
         Creates a new account
-        
+
         This endpoint requires [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem installed
       tags:
         - Account
@@ -92,7 +92,7 @@ paths:
     patch:
       description: >-
         Updates user account
-        
+
         This endpoint requires [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem installed
       tags:
         - Account
@@ -131,6 +131,85 @@ paths:
                 $ref: '#/components/schemas/Error'
       security:
         - bearerAuth: []
+  '/account/addresses':
+    get:
+      description: >-
+        Returns a list of Addresses for the signed in User
+      tags:
+        - Account
+      operationId: 'Addresses list'
+      responses:
+        '200':
+          description: Listing user addresses.
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/AddressList'
+        '403':
+          $ref: '#/components/responses/403Forbidden'
+      security:
+        - bearerAuth: []
+    post:
+      description: >-
+        Create a new Address for the signed in User
+      tags:
+        - Account
+      operationId: 'Create Address'
+      requestBody:
+        required: true
+        content:
+          application/vnd.api+json:
+            schema:
+              type: object
+              properties:
+                address:
+                  $ref: '#/components/schemas/AddressPayload'
+      responses:
+        '200':
+          description: Created Address.
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/AddressList'
+        '403':
+          $ref: '#/components/responses/403Forbidden'
+      security:
+        - bearerAuth: []
+  '/account/addresses/{id}':
+    patch:
+      description: >-
+        Update selected Address for the signed in User
+      tags:
+        - Account
+      operationId: 'Update Address'
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Selected Address for update
+          schema:
+            type: string
+          example: '1'
+      requestBody:
+        required: true
+        content:
+          application/vnd.api+json:
+            schema:
+              type: object
+              properties:
+                address:
+                  $ref: '#/components/schemas/AddressPayload'
+      responses:
+        '200':
+          description: Updated Address.
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/AddressList'
+        '403':
+          $ref: '#/components/responses/403Forbidden'
+      security:
+        - bearerAuth: []
   '/account/credit_cards':
     get:
       description: >-
@@ -1206,6 +1285,14 @@ components:
             company:
               type: string
               example: 'Google Inc.'
+    AddressList:
+      required:
+        - data
+      properties:
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/Address'
     Cart:
       required:
         - data
@@ -1372,6 +1459,18 @@ components:
         display_tax_total:
           type: string
           example: '$10.00'
+        pre_tax_item_amount:
+          type: string
+          example: '17.00'
+        display_pre_tax_item_amount:
+          type: string
+          example: '$17.00'
+        pre_tax_total:
+          type: string
+          example: '20.00'
+        display_pre_tax_total:
+          type: string
+          example: '$20.00'
         item_count:
           type: number
           example: 2
@@ -1584,6 +1683,12 @@ components:
             display_discounted_amount:
               type: string
               example: '$125.00'
+            pre_tax_amount:
+              type: string
+              example: '125.0'
+            display_pre_tax_amount:
+              type: string
+              example: '$125.00'
             promo_total:
               type: string
               example: '-5.0'
@@ -2287,6 +2392,11 @@ components:
           $ref: '#/components/schemas/ShipmentAttributes'
         relationships:
           properties:
+            stock_location:
+              type: object
+              properties:
+                data:
+                  $ref: '#/components/schemas/Relation'
             shipping_rates:
               properties:
                 data:
@@ -2342,6 +2452,7 @@ components:
           items:
             oneOf:
               - $ref: '#/components/schemas/ShippingRate'
+              - $ref: '#/components/schemas/StockLocation'
     EstimateShippingRatesList:
       required:
         - data
@@ -2396,6 +2507,20 @@ components:
               type: integer
               example: 1
               description: 'ID of a Shipping Method. You will need this for the Checkout Update action'
+    StockLocation:
+      properties:
+        id:
+          type: string
+          example: '1'
+        type:
+          type: string
+          default: 'stock_location'
+        attributes:
+          type: object
+          properties:
+            name:
+              type: string
+              example: 'Main Warehouse'
     Account:
       required:
         - data

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

@@ -4,7 +4,7 @@ shared_context 'API v2 tokens' do
   let(:headers_order_token) { { 'X-Spree-Order-Token' => order.token } }
 end
 
-[200, 201, 400, 404, 403, 422].each do |status_code|
+[200, 201, 400, 401, 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)

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

@@ -48,6 +48,10 @@ shared_examples 'returns valid cart JSON' do
     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_attribute(:pre_tax_item_amount).with_value(order.pre_tax_item_amount.to_s)
+    expect(json_response['data']).to have_attribute(:display_pre_tax_item_amount).with_value(order.display_pre_tax_item_amount.to_s)
+    expect(json_response['data']).to have_attribute(:pre_tax_total).with_value(order.pre_tax_total.to_s)
+    expect(json_response['data']).to have_attribute(:display_pre_tax_total).with_value(order.display_pre_tax_total.to_s)
     expect(json_response['data']).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.2.0.beta
+  version: 4.2.0.rc1
 platform: ruby
 authors:
 - Ryan Bigg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta
+        version: 4.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta
+        version: 4.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ files:
 - app/controllers/spree/api/v1/variants_controller.rb
 - app/controllers/spree/api/v1/zones_controller.rb
 - app/controllers/spree/api/v2/base_controller.rb
+- app/controllers/spree/api/v2/storefront/account/addresses_controller.rb
 - app/controllers/spree/api/v2/storefront/account/credit_cards_controller.rb
 - app/controllers/spree/api/v2/storefront/account/orders_controller.rb
 - app/controllers/spree/api/v2/storefront/account_controller.rb
@@ -141,6 +142,7 @@ files:
 - 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/stores_controller.rb
 - app/controllers/spree/api/v2/storefront/taxons_controller.rb
 - app/helpers/spree/api/api_helpers.rb
 - app/helpers/spree/api/v2/collection_options_helpers.rb
@@ -166,9 +168,11 @@ files:
 - app/serializers/spree/v2/storefront/shipment_serializer.rb
 - app/serializers/spree/v2/storefront/shipping_rate_serializer.rb
 - app/serializers/spree/v2/storefront/state_serializer.rb
+- app/serializers/spree/v2/storefront/stock_location_serializer.rb
 - app/serializers/spree/v2/storefront/store_credit_event_serializer.rb
 - app/serializers/spree/v2/storefront/store_credit_serializer.rb
 - app/serializers/spree/v2/storefront/store_credit_type_serializer.rb
+- app/serializers/spree/v2/storefront/store_serializer.rb
 - app/serializers/spree/v2/storefront/taxon_image_serializer.rb
 - app/serializers/spree/v2/storefront/taxon_serializer.rb
 - app/serializers/spree/v2/storefront/taxonomy_serializer.rb
@@ -302,10 +306,10 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0.beta
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0.rc1
   documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.beta
-post_install_message: 
+  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.rc1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -320,8 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Spree's API
 test_files: []