spree_api 4.1.5 → 4.2.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c9821451801f101e2515e3595c057cdf95ea6afca35c7c7ac28fa23587d36b9
-  data.tar.gz: 367c6e377dc344d7d139171254a407c00659a7a5c82d992eb76edfc871954eca
+  metadata.gz: 3d7a31de48e37ea579244e2c62fb47e2891f5663b095aa8f49de99ecc24abc1e
+  data.tar.gz: 6d5470cb5181210801f5210f46b1e0fc7a3d704b8cd930f372a0544b5861713b
 SHA512:
-  metadata.gz: 564695676cf6b20217140d99f075f1c05e10c6bedd3464f2cc748db844f029b39a0cb4709496c3986b8311d5351d9667986bea4a40ce50202a61be6933342041
-  data.tar.gz: 1bbb9f8afb20b960831cfe1e8c720c12ca72c7206a85fced08e54038ef81ffa5d437fd62e2f2df2d9cca99f486d0934114c82d8a8836bd065d1ee8b97238c2ef
+  metadata.gz: 0b79cb583334e0813cde900718b6062a3601761aba2093159846a383c684219735ebf6861056a24376701d072e766eb74b2a280ef9dacf0f4993f67237dc6c01
+  data.tar.gz: 2429b6091f2e256743136cef85b42a65cfd53f9daadc6b1a5f3945c0fba1b9a1f882491edc85f0cf8a22cd7a7ee8dbed30c174f53e3d139b7d62eda8fe91c4a4

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

@@ -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/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

data/app/helpers/spree/api/api_helpers.rb

@@ -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/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/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/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/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,88 @@ 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/credit_cards':
     get:
       description: >-
@@ -774,7 +855,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
@@ -2003,10 +2084,6 @@ components:
     VariantAttributes:
       type: object
       properties:
-        name:
-          type: string
-          example: 'Example product'
-          description: 'Product name'
         sku:
           type: string
           example: 'SKU-1001'
@@ -2038,14 +2115,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

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/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.homepage      = 'http://spreecommerce.org'
+  s.description   = %q{Spree's API}
+  s.homepage      = 'https://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.2.0.beta
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-09-07 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.2.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.5
+        version: 4.2.0.beta
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -297,10 +297,14 @@ files:
 - script/rails
 - spec/fixtures/thinking-cat.jpg
 - spree_api.gemspec
-homepage: http://spreecommerce.org
+homepage: https://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.2.0.beta
+  documentation_uri: https://guides.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.2.0.beta
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -312,9 +316,9 @@ 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: