spree_api 4.1.5 → 4.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c9821451801f101e2515e3595c057cdf95ea6afca35c7c7ac28fa23587d36b9
-  data.tar.gz: 367c6e377dc344d7d139171254a407c00659a7a5c82d992eb76edfc871954eca
+  metadata.gz: '081a59e1e4a0962307541447f46aee0b5aa37996d93063bb9f1a8a48fa7284f4'
+  data.tar.gz: ce108948d989bd3b6e77811c5ee644459be649923d018ab2b909d7982f90207b
 SHA512:
-  metadata.gz: 564695676cf6b20217140d99f075f1c05e10c6bedd3464f2cc748db844f029b39a0cb4709496c3986b8311d5351d9667986bea4a40ce50202a61be6933342041
-  data.tar.gz: 1bbb9f8afb20b960831cfe1e8c720c12ca72c7206a85fced08e54038ef81ffa5d437fd62e2f2df2d9cca99f486d0934114c82d8a8836bd065d1ee8b97238c2ef
+  metadata.gz: f4d6373fde6c57a192903b224a292ed9cffaad0b19e8ddc0c99bff2f74f6dc7409f053bd2c2c4506f71c56af214b6e7cc98b9c9d75e0e7663af69782f60fa2b2
+  data.tar.gz: 7d9fc0748f73eeba62edb386e55ea4615a13b3add5014cc0131451f6977942087ef8ca0b7a3935dd6412233e1296cc81575f4291d90be24efbaf83c58c55dc5d

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]
@@ -108,6 +109,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,7 +125,7 @@ module Spree
           def serialize_shipping_rates(shipments)
             shipping_rates_serializer.new(
               shipments,
-              include: [:shipping_rates],
+              include: [:shipping_rates, :stock_location],
               params: { show_rates: true }
             ).serializable_hash
           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

@@ -20,12 +20,14 @@ module Spree
 
         belongs_to :user
         belongs_to :billing_address,
-          id_method_name: :bill_address_id,
-          serializer: :address
+                   id_method_name: :bill_address_id,
+                   serializer: :address,
+                   record_type: :address
 
         belongs_to :shipping_address,
-          id_method_name: :ship_address_id,
-          serializer: :address
+                   id_method_name: :ship_address_id,
+                   serializer: :address,
+                   record_type: :address
       end
     end
   end

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

@@ -10,6 +10,8 @@ module Spree
         attribute :free, &:free?
 
         has_many :shipping_rates, if: proc { |_record, params| params&.dig(:show_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/app/serializers/spree/v2/storefront/taxon_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       class TaxonSerializer < BaseSerializer
         set_type   :taxon
 
-        attributes :name, :pretty_name, :permalink, :seo_title, :meta_title, :meta_description,
+        attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
                    :meta_keywords, :left, :right, :position, :depth, :updated_at
 
         attribute :is_root,  &:root?

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

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.5
+  version: 4.1.10
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-09-23 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.5
+        version: 4.1.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.5
+        version: 4.1.10
 - !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,7 +304,11 @@ files:
 homepage: http://spreecommerce.org
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/spree/spree/issues
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.1.10
+  documentation_uri: https://guides.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.1.10
 post_install_message: 
 rdoc_options: []
 require_paths: