spree_api 3.7.1 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a8ca7dd6ec45062eb2f95fad2081b467cdbebc52252739cdb1016c8370d302
-  data.tar.gz: 29924921d03fcbc9f784b6633b552c0dd2a93997d0bce6110e1189c4e30317b5
+  metadata.gz: b5d7921c3d756d21b52c3b0533c15f5a73520b8fadd5b27fdd97865e14f19ca0
+  data.tar.gz: 217e9158bd8b96694763eaf9767cc4cde8fec4b58461cc00669fa9a8d64fb90d
 SHA512:
-  metadata.gz: 49ad14a8cfcf55a30b9e02dddf8ed7aa4f2366af86755a0cb47f51f24855f32f43dc2c3771cca9e2ea00eb845a5d328f4bdbab67abd715f2ce84eea9a4ed429d
-  data.tar.gz: 809dbcb0bfc5dfb53901b50e4e7e3da242a0f1c24b993be9387df242d822dca50209eabf85a26cb668e2747248fd9f321d9101d9080c19c2669966e17c0389d2
+  metadata.gz: db362f697b5fca101db4c9a6a6262a75da56c97deacf50b85cd346faafad82c6eb17448eb5198b38abdd56f3712ecf25d9b481bf36972ce12cfdc283b214c400
+  data.tar.gz: 9ab9e97101eef9472aef26c85636dedd0c1e7d518bcbc73f469875bd9325da54d69a965200ee9ad483e8b37566a7bd0c2c443034dad443e7b22895125b98156d

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

@@ -90,7 +90,15 @@ module Spree
           def remove_coupon_code
             spree_authorize! :update, spree_current_order, order_token
 
-            result = coupon_handler.new(spree_current_order).remove(params[:coupon_code])
+            coupon_code = if params[:coupon_code].present?
+                            params[:coupon_code]
+                          else
+                            spree_current_order.promotions.coupons.first&.code
+                          end
+
+            return render_error_payload(Spree.t('v2.cart.no_coupon_code', scope: 'api')) if coupon_code.nil?
+
+            result = coupon_handler.new(spree_current_order).remove(coupon_code)
 
             if result.error.blank?
               render_serialized_payload { serialized_current_order }
@@ -99,6 +107,18 @@ module Spree
             end
           end
 
+          def estimate_shipping_rates
+            spree_authorize! :show, spree_current_order, order_token
+
+            result = estimate_shipping_rates_service.call(order: spree_current_order, country_iso: params[:country_iso])
+
+            if result.error.blank?
+              render_serialized_payload { serialize_estimated_shipping_rates(result.value) }
+            else
+              render_error_payload(result.error)
+            end
+          end
+
           private
 
           def resource_serializer
@@ -125,6 +145,10 @@ module Spree
             Spree::Api::Dependencies.storefront_coupon_handler.constantize
           end
 
+          def estimate_shipping_rates_service
+            Spree::Api::Dependencies.storefront_cart_estimate_shipping_rates_service.constantize
+          end
+
           def line_item
             @line_item ||= spree_current_order.line_items.find(params[:line_item_id])
           end
@@ -132,6 +156,17 @@ module Spree
           def render_error_item_quantity
             render json: { error: I18n.t(:wrong_quantity, scope: 'spree.api.v2.cart') }, status: 422
           end
+
+          def estimate_shipping_rates_serializer
+            Spree::Api::Dependencies.storefront_estimated_shipment_serializer.constantize
+          end
+
+          def serialize_estimated_shipping_rates(shipping_rates)
+            estimate_shipping_rates_serializer.new(
+              shipping_rates,
+              params: { currency: spree_current_order.currency }
+            ).serializable_hash
+          end
         end
       end
     end

data/app/models/spree/api_dependencies.rb

@@ -13,7 +13,7 @@ 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_update_service, :storefront_cart_estimate_shipping_rates_service, :storefront_estimated_shipment_serializer
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -34,6 +34,7 @@ module Spree
       @storefront_cart_remove_item_service = Spree::Dependencies.cart_remove_item_service
       @storefront_cart_set_item_quantity_service = Spree::Dependencies.cart_set_item_quantity_service
       @storefront_cart_recalculate_service = Spree::Dependencies.cart_recalculate_service
+      @storefront_cart_estimate_shipping_rates_service = Spree::Dependencies.cart_estimate_shipping_rates_service
 
       # coupon code handler
       @storefront_coupon_handler = Spree::Dependencies.coupon_handler
@@ -56,6 +57,7 @@ module Spree
       @storefront_taxon_serializer = 'Spree::V2::Storefront::TaxonSerializer'
       @storefront_payment_method_serializer = 'Spree::V2::Storefront::PaymentMethodSerializer'
       @storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'
+      @storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'
 
       # sorters
       @storefront_order_sorter = Spree::Dependencies.order_sorter

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

@@ -0,0 +1,25 @@
+module Spree
+  module V2
+    module Storefront
+      class EstimatedShippingRateSerializer < BaseSerializer
+        set_type :shipping_rate
+
+        attributes :name, :selected, :cost, :tax_amount, :shipping_method_id
+
+        attribute :final_price, &:cost
+
+        attributes :display_cost, :display_final_price do |object, params|
+          Spree::Money.new(object.cost, currency: params[:currency])
+        end
+
+        attribute :display_tax_amount do |object, params|
+          Spree::Money.new(object.tax_amount, currency: params[:currency])
+        end
+
+        attribute :free do |object|
+          object.cost.zero?
+        end
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -33,3 +33,4 @@ en:
       v2:
         cart:
           wrong_quantity: "Quantity has to be greater than 0"
+          no_coupon_code: "No coupon code provided and the Order doesn't have any coupon code promotions applied"

data/config/routes.rb

@@ -137,6 +137,8 @@ Spree::Core::Engine.add_routes do
           patch  :set_quantity
           patch  :apply_coupon_code
           delete 'remove_coupon_code/:coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code
+          delete 'remove_coupon_code', to: 'cart#remove_coupon_code', as: :cart_remove_coupon_code_without_code
+          get :estimate_shipping_rates
         end
 
         resource :checkout, controller: :checkout, only: %i[update] do

data/docs/v2/storefront/index.yaml

@@ -404,6 +404,35 @@ paths:
         - orderToken: []
         - bearerAuth: []
 
+  '/cart/estimate_shipping_rates':
+    get:
+      description:  Returns a list of Estimated Shipping Rates for Cart
+      tags:
+        - Cart
+      operationId: 'Estimate Shipping Rates'
+      parameters:
+        - name: country_iso
+          in: query
+          description: >-
+            Country ISO or ISO3 symbol to get estimations for this destination,
+            by default we'll try to reuse Cart shipping address or the default Country for the current Store
+          schema:
+            type: string
+          example: 'USA'
+        - $ref: '#/components/parameters/SparseFieldsParam'
+      responses:
+        '200':
+          description: Returns a list of estimated Shipping Rates for Cart
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/EstimateShippingRatesList'
+        '404':
+          $ref: '#/components/responses/404NotFound'
+      security:
+        - orderToken: []
+        - bearerAuth: []
+
   '/checkout':
     patch:
       description: >-
@@ -788,6 +817,18 @@ paths:
           description: >-
             Find Prodcuts with Variants that have the specified option (eg. color, size)
             and value (eg. red, XS)
+        - in: query
+          name: 'filter[show_deleted]'
+          schema:
+            type: boolean
+          example: true
+          description: Returns also deleted products
+        - in: query
+          name: 'filter[show_discontinued]'
+          schema:
+            type: boolean
+          example: true
+          description: Returns also discontinued products
         - in: query
           name: sort
           schema:
@@ -2221,6 +2262,14 @@ components:
           items:
             oneOf:
               - $ref: '#/components/schemas/ShippingRate'
+    EstimateShippingRatesList:
+      required:
+        - data
+      properties:
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/ShippingRate'
     ShippingRate:
       properties:
         id:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.7.2
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-04-09 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.1
+        version: 3.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 3.7.2
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,7 @@ files:
 - app/serializers/spree/v2/storefront/cart_serializer.rb
 - app/serializers/spree/v2/storefront/country_serializer.rb
 - app/serializers/spree/v2/storefront/credit_card_serializer.rb
+- app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
 - app/serializers/spree/v2/storefront/image_serializer.rb
 - app/serializers/spree/v2/storefront/line_item_serializer.rb
 - app/serializers/spree/v2/storefront/option_type_serializer.rb