spree_api 4.1.7 → 4.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c3f1cd95091b79ee1beb6fffc494c87914cf332be9d1314b70383d059f267a
-  data.tar.gz: a4c12d109f2517b68b202b484d91fd7ddf255417cd776e9bfd834b90c34b9df0
+  metadata.gz: 38bd4bf2ae62f5f2019c58e30756ca2ff678469f4efa5264a82400abc9af6f48
+  data.tar.gz: 199f6ebcf4a79862a238dd08ca444ec8938d85bb4f47b4386a71060efe8e5d21
 SHA512:
-  metadata.gz: e98952caa2783c1bdaba56f8e91b21df7b620cca80a5895da1ca29f77bf374befa276dc2c0319881d158501fe2c0752b658e03f5c37447921cd1d2d9103e56e3
-  data.tar.gz: 4e8607d0e68f83fd13d98ccb1fa241b22b965826a46f42eed412c6ea1e09c5ae3e6c1053657d9e4aa5499618daf4d321d7049174d06e97b50283bb0ebdd002a3
+  metadata.gz: ed12d85f966d2b03b6c1efd27ab9641d74b669dfe11908b16045e907900b5f9514af54e41d1ec91e4034017a4f981f7040c7cf169536b406c150a2ac85505b47
+  data.tar.gz: 11f665989207e8d720e7b06b1ca96c84b9d0540b08c7cbb9ce17fc154ca784917a3f7602ac3634569d258ce0c5f96cca3386e3e913db7acc456e575a19596093

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

@@ -7,6 +7,7 @@ module Spree
         include Spree::Core::ControllerHelpers::Store
         rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
         rescue_from CanCan::AccessDenied, with: :access_denied
+        rescue_from Spree::Core::GatewayError, with: :gateway_error
 
         def content_type
           Spree::Api::Config[:api_v2_content_type]
@@ -52,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)
@@ -108,6 +114,10 @@ module Spree
         def access_denied(exception)
           render_error_payload(exception.message, 403)
         end
+
+        def gateway_error(exception)
+          render_error_payload(exception.message)
+        end
       end
     end
   end

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

@@ -65,7 +65,11 @@ module Spree
           def shipping_rates
             result = shipping_rates_service.call(order: spree_current_order)
 
-            render_serialized_payload { serialize_shipping_rates(result.value) }
+            if result.success?
+              render_serialized_payload { serialize_shipping_rates(result.value) }
+            else
+              render_error_payload(result.error)
+            end
           end
 
           def payment_methods
@@ -121,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/order_status_controller.rb

@@ -29,7 +29,7 @@ module Spree
           end
 
           def ensure_order_token
-            raise ActiveRecord::RecordNotFound unless order_token
+            raise ActiveRecord::RecordNotFound unless order_token.present?
           end
         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/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/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

@@ -774,7 +774,7 @@ paths:
       description: >-
         Returns a list of available Shipping Rates for Checkout.
         Shipping Rates are grouped against Shipments.
-        Each checkout cna have multiple Shipments eg. some products are available
+        Each checkout can have multiple Shipments eg. some products are available
         in stock and will be send out instantly and some needs to be backordered.
       tags:
         - Checkout
@@ -1125,6 +1125,14 @@ components:
             company:
               type: string
               example: 'Google Inc.'
+    AddressList:
+      required:
+        - data
+      properties:
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/Address'
     Cart:
       required:
         - data
@@ -1291,6 +1299,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
@@ -1503,6 +1523,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'

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

data/spree_api.gemspec

@@ -2,20 +2,27 @@
 require_relative '../core/lib/spree/core/version.rb'
 
 Gem::Specification.new do |s|
+  s.name          = "spree_api"
+  s.version       = Spree.version
   s.authors       = ["Ryan Bigg"]
   s.email         = ["ryan@spreecommerce.com"]
-  s.description   = %q{Spree's API}
   s.summary       = %q{Spree's API}
+  s.description   = %q{Spree's API}
   s.homepage      = 'http://spreecommerce.org'
   s.license       = 'BSD-3-Clause'
 
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/spree/spree/issues",
+    "changelog_uri"     => "https://github.com/spree/spree/releases/tag/v#{s.version}",
+    "documentation_uri" => "https://guides.spreecommerce.org/",
+    "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
+  }
+
   s.required_ruby_version = '>= 2.5.0'
 
   s.files         = `git ls-files`.split($\).reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.name          = "spree_api"
   s.require_paths = ["lib"]
-  s.version       = Spree.version
 
   s.add_development_dependency 'jsonapi-rspec'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.1.7
+  version: 4.1.12
 platform: ruby
 authors:
 - Ryan Bigg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-11-10 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.1.7
+        version: 4.1.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.1.12
 - !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
@@ -300,8 +304,12 @@ files:
 homepage: http://spreecommerce.org
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/spree/spree/issues
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.1.12
+  documentation_uri: https://guides.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.1.12
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -317,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Spree's API
 test_files: []