spree_api 4.1.10 → 4.2.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '081a59e1e4a0962307541447f46aee0b5aa37996d93063bb9f1a8a48fa7284f4'
-  data.tar.gz: ce108948d989bd3b6e77811c5ee644459be649923d018ab2b909d7982f90207b
+  metadata.gz: 870bda309064df374e65aee63ddd2d7abb72004dbb6d218f0b1b77b7f5b0219f
+  data.tar.gz: e8fd20974f60d065473f2fb1303dd86221de56173f6a1e957c7efc8d5dba2aed
 SHA512:
-  metadata.gz: f4d6373fde6c57a192903b224a292ed9cffaad0b19e8ddc0c99bff2f74f6dc7409f053bd2c2c4506f71c56af214b6e7cc98b9c9d75e0e7663af69782f60fa2b2
-  data.tar.gz: 7d9fc0748f73eeba62edb386e55ea4615a13b3add5014cc0131451f6977942087ef8ca0b7a3935dd6412233e1296cc81575f4291d90be24efbaf83c58c55dc5d
+  metadata.gz: 37e0a2ef4037067d2ffd5391d70b7c9fd6953d0529721e83ba7935755b1bca9515bc047e16525cae1df3d68e0815082f21e3e5579521f80259c717abe06d0b76
+  data.tar.gz: 87d24be4132f732043258a35db7b5398f3a63fe99908141e6bbba92786e5897a2c9c9ddf0c3ed5efa9b3da6b65a73f2ac5e4a895fc4bb69038ab5e597ece2932

data/app/controllers/concerns/spree/api/v2/storefront/order_concern.rb

@@ -34,6 +34,10 @@ module Spree
             )
           end
 
+          def supported_currencies
+            current_store.supported_currencies_list
+          end
+
           def serialize_order(order)
             resource_serializer.new(order.reload, include: resource_includes, fields: sparse_fields).serializable_hash
           end

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

@@ -2,9 +2,7 @@ require_dependency 'spree/api/controller_setup'
 
 module Spree
   module Api
-    class BaseController < ActionController::Base
-      protect_from_forgery unless: -> { request.format.json? || request.format.xml? }
-
+    class BaseController < ActionController::API
       include Spree::Api::ControllerSetup
       include Spree::Core::ControllerHelpers::Store
       include Spree::Core::ControllerHelpers::StrongParameters

data/app/controllers/spree/api/errors_controller.rb

@@ -1,6 +1,6 @@
 module Spree
   module Api
-    class ErrorsController < ActionController::Base
+    class ErrorsController < ActionController::API
       def render_404
         render 'spree/api/errors/not_found', status: 404
       end

data/app/controllers/spree/api/v1/taxons_controller.rb

@@ -74,7 +74,12 @@ module Spree
 
         def taxonomy
           if params[:taxonomy_id].present?
-            @taxonomy ||= Spree::Taxonomy.accessible_by(current_ability, :show).find(params[:taxonomy_id])
+            @taxonomy ||=
+              if defined?(SpreeGlobalize)
+                Spree::Taxonomy.includes(:translations, taxons: [:translations]).accessible_by(current_ability, :show).find(params[:taxonomy_id])
+              else
+                Spree::Taxonomy.accessible_by(current_ability, :show).find(params[:taxonomy_id])
+              end
           end
         end
 

data/app/controllers/spree/api/v1/users_controller.rb

@@ -5,22 +5,48 @@ module Spree
         rescue_from Spree::Core::DestroyWithOrdersError, with: :error_during_processing
 
         def index
-          @users = Spree.user_class.accessible_by(current_ability, :show)
+          users
 
           if params[:ids]
-            @users = @users.where(id: params[:ids])
-          elsif params[:q]
-            users_with_ship_address = @users.with_address(params[:q][:ship_address_firstname_start])
-            users_with_bill_address = @users.with_address(params[:q][:ship_address_firstname_start], :bill_address)
-
-            users_with_addresses_ids = (users_with_ship_address.ids + users_with_bill_address.ids).compact.uniq
-            @users = @users.with_email_or_addresses_ids(params[:q][:email_start], users_with_addresses_ids)
+            load_users_by_ids
+          elsif params.dig(:q, :ship_address_firstname_start)
+            load_users_by_address
+          elsif params.dig(:q, :email_start)
+            load_users_by_email
           end
 
+          prepare_index_response
+          respond_with(@users)
+        end
+
+        def users
+          @users ||= Spree.user_class.accessible_by(current_ability, :show)
+        end
+
+        def load_users_by_ids
+          @users = @users.where(id: params[:ids])
+        end
+
+        def load_users_by_address
+          address_params = params[:q][:ship_address_firstname_start] ||
+            params[:q][:ship_address_lastname_start] ||
+            params[:q][:bill_address_firstname_start] ||
+            params[:q][:bill_address_lastname_start]
+          @users = @users.with_email_or_address(params[:q][:email_start], address_params)
+        end
+
+        def load_users_by_email
+          @users = @users.with_email(params[:q][:email_start])
+        end
+
+        def paginate_users
           @users = @users.page(params[:page]).per(params[:per_page])
+        end
+
+        def prepare_index_response
+          paginate_users
           expires_in 15.minutes, public: true
           headers['Surrogate-Control'] = "max-age=#{15.minutes}"
-          respond_with(@users)
         end
 
         def show

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/orders_controller.rb

@@ -35,11 +35,11 @@ module Spree
             end
 
             def collection_serializer
-              Spree::Api::Dependencies.storefront_cart_serializer.constantize
+              Spree::Api::Dependencies.storefront_order_serializer.constantize
             end
 
             def resource_serializer
-              Spree::Api::Dependencies.storefront_cart_serializer.constantize
+              Spree::Api::Dependencies.storefront_order_serializer.constantize
             end
 
             def collection_finder

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, :stock_location],
-              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/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]
@@ -161,8 +161,9 @@ module Spree
 
       @@store_attributes = [
         :id, :name, :url, :meta_description, :meta_keywords, :seo_title,
-        :mail_from_address, :default_currency, :code, :default,
-        :facebook, :twitter, :instagram
+        :mail_from_address, :customer_support_email, :default_currency,
+        :code, :default, :facebook, :twitter, :instagram,
+        :supported_currencies
       ]
 
       @@tag_attributes = [:id, :name]

data/app/models/spree/api_dependencies.rb

@@ -14,7 +14,7 @@ module Spree
       :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_store_serializer, :storefront_address_serializer,
+      :storefront_store_serializer, :storefront_address_serializer, :storefront_order_serializer,
       :storefront_account_create_address_service, :storefront_account_update_address_service, :storefront_address_finder
     ].freeze
 
@@ -66,6 +66,7 @@ module Spree
       @storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'
       @storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'
       @storefront_store_serializer = 'Spree::V2::Storefront::StoreSerializer'
+      @storefront_order_serializer = 'Spree::V2::Storefront::CartSerializer'
 
       # sorters
       @storefront_order_sorter = Spree::Dependencies.order_sorter

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/product_serializer.rb

@@ -5,8 +5,8 @@ module Spree
         set_type :product
 
         attributes :name, :description, :price, :currency, :display_price,
-                   :available_on, :slug, :meta_description, :meta_keywords,
-                   :updated_at
+                   :compare_at_price, :display_compare_at_price, :available_on,
+                   :slug, :meta_description, :meta_keywords, :updated_at
 
         attribute :purchasable,   &:purchasable?
         attribute :in_stock,      &:in_stock?

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

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

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

@@ -7,6 +7,8 @@ module Spree
         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
+
+        has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
       end
     end
   end

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

@@ -4,8 +4,8 @@ module Spree
       class VariantSerializer < BaseSerializer
         set_type :variant
 
-        attributes :name, :sku, :price, :currency, :display_price, :weight, :height,
-                   :width, :depth, :is_master, :options_text, :slug, :description
+        attributes :sku, :price, :currency, :display_price, :weight, :height,
+                   :width, :depth, :is_master, :options_text
 
         attribute :purchasable,   &:purchasable?
         attribute :in_stock,      &:in_stock?

data/app/views/spree/api/v1/products/show.rabl

@@ -6,6 +6,10 @@ attributes *product_attributes
 node(:display_price) { |p| p.display_price.to_s }
 node(:has_variants, &:has_variants?)
 node(:taxon_ids, &:taxon_ids)
+node(:display_current_currency_price) do |product|
+  price = product.price_in(current_currency)
+  Spree::Money.new(price.amount, currency: current_currency).to_s
+end
 
 child master: :master do
   extends 'spree/api/v1/variants/small'

data/docs/v2/storefront/index.yaml

@@ -49,7 +49,167 @@ paths:
           $ref: '#/components/responses/403Forbidden'
       security:
         - bearerAuth: []
+    post:
+      description: >-
+        Creates a new account
 
+        This endpoint requires [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem installed
+      tags:
+        - Account
+      operationId: 'Account Creation'
+      requestBody:
+        required: true
+        content:
+          application/vnd.api+json:
+            schema:
+              type: object
+              properties:
+                user:
+                  type: object
+                  properties:
+                    email:
+                      type: string
+                      example: 'john@snow.org'
+                    password:
+                      type: string
+                      example: 'spree123'
+                    password_confirmation:
+                      type: string
+                      example: 'spree123'
+      responses:
+        '200':
+          description: ok
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/Account'
+        '422':
+          description: Validation errors
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    patch:
+      description: >-
+        Updates user account
+
+        This endpoint requires [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem installed
+      tags:
+        - Account
+      operationId: 'Account Updates'
+      requestBody:
+        required: true
+        content:
+          application/vnd.api+json:
+            schema:
+              type: object
+              properties:
+                user:
+                  type: object
+                  properties:
+                    email:
+                      type: string
+                      example: 'john@snow.org'
+                    password:
+                      type: string
+                      example: 'spree123'
+                    password_confirmation:
+                      type: string
+                      example: 'spree123'
+      responses:
+        '200':
+          description: ok
+          content:
+            application/vnd.api+json:
+              schema:
+                $ref: '#/components/schemas/Account'
+        '422':
+          description: Validation errors
+          content:
+            application/vnd.api+json:
+              schema:
+                $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: >-
@@ -1299,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
@@ -1511,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'
@@ -2011,10 +2189,6 @@ components:
     VariantAttributes:
       type: object
       properties:
-        name:
-          type: string
-          example: 'Example product'
-          description: 'Product name'
         sku:
           type: string
           example: 'SKU-1001'
@@ -2046,14 +2220,6 @@ components:
         options_text:
           type: string
           example: 'Size: small, Color: red'
-        slug:
-          type: string
-          example: 'example-product'
-          description: 'Product slug'
-        description:
-          type: string
-          example: 'Example description'
-          description: 'Product description'
         purchasable:
           type: boolean
           example: true
@@ -2226,6 +2392,11 @@ components:
           $ref: '#/components/schemas/ShipmentAttributes'
         relationships:
           properties:
+            stock_location:
+              type: object
+              properties:
+                data:
+                  $ref: '#/components/schemas/Relation'
             shipping_rates:
               properties:
                 data:
@@ -2281,6 +2452,7 @@ components:
           items:
             oneOf:
               - $ref: '#/components/schemas/ShippingRate'
+              - $ref: '#/components/schemas/StockLocation'
     EstimateShippingRatesList:
       required:
         - data
@@ -2335,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/controller_setup.rb

@@ -6,7 +6,6 @@ module Spree
       def self.included(klass)
         klass.class_eval do
           include CanCan::ControllerAdditions
-          include Spree::Core::ControllerHelpers::Auth
 
           prepend_view_path Rails.root + 'app/views'
           append_view_path File.expand_path('../../../app/views', File.dirname(__FILE__))

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

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email         = ["ryan@spreecommerce.com"]
   s.summary       = %q{Spree's API}
   s.description   = %q{Spree's API}
-  s.homepage      = 'http://spreecommerce.org'
+  s.homepage      = 'https://spreecommerce.org'
   s.license       = 'BSD-3-Clause'
 
   s.metadata = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.1.10
+  version: 4.2.0.rc2
 platform: ruby
 authors:
 - Ryan Bigg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-23 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.10
+        version: 4.2.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.10
+        version: 4.2.0.rc2
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -301,15 +301,15 @@ files:
 - script/rails
 - spec/fixtures/thinking-cat.jpg
 - spree_api.gemspec
-homepage: http://spreecommerce.org
+homepage: https://spreecommerce.org
 licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.1.10
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.2.0.rc2
   documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.1.10
-post_install_message: 
+  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.rc2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -320,12 +320,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Spree's API
 test_files: []