spree_api 4.3.0 → 4.5.1

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

@@ -2,23 +2,18 @@ module Spree
   module V2
     module Storefront
       class StoreSerializer < BaseSerializer
+        include Spree::Api::V2::StoreMediaSerializerImagesConcern
+
         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, :supported_locales
+        attributes :name, :url, :meta_description, :meta_keywords, :seo_title, :default_currency,
+                   :default, :supported_currencies, :facebook, :twitter, :instagram, :default_locale,
+                   :customer_support_email, :description, :address, :contact_phone, :supported_locales
 
         has_many :menus
         has_many :cms_pages
 
         has_one :default_country, serializer: :country, record_type: :country, id_method_name: :default_country_id
-
-        attribute :favicon_path do |store|
-          if store.favicon_image.attached?
-            url_helpers = Rails.application.routes.url_helpers
-            url_helpers.rails_representation_path(store.favicon, only_path: true)
-          end
-        end
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Spree
         set_type   :taxon
 
         attributes :name, :pretty_name, :permalink, :seo_title, :description, :meta_title, :meta_description,
-                   :meta_keywords, :left, :right, :position, :depth, :updated_at
+                   :meta_keywords, :left, :right, :position, :depth, :updated_at, :public_metadata
 
         attribute :is_root do |taxon|
           taxon.root?

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

@@ -4,7 +4,7 @@ module Spree
       class TaxonomySerializer < BaseSerializer
         set_type   :taxonomy
 
-        attributes :name, :position
+        attributes :name, :position, :public_metadata
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Spree
       class UserSerializer < BaseSerializer
         set_type :user
 
-        attributes :email
+        attributes :email, :first_name, :last_name, :public_metadata
 
         attribute :store_credits do |user|
           user.total_available_store_credit

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

@@ -6,7 +6,7 @@ module Spree
 
         set_type :variant
 
-        attributes :sku, :weight, :height, :width, :depth, :is_master, :options_text
+        attributes :sku, :barcode, :weight, :height, :width, :depth, :is_master, :options_text, :public_metadata
 
         attribute :purchasable do |variant|
           variant.purchasable?

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

@@ -0,0 +1,29 @@
+module Spree
+  module V2
+    module Storefront
+      class WishedItemSerializer < BaseSerializer
+        set_type :wished_item
+
+        attributes :quantity
+
+        attribute :price do |wished_item, params|
+          wished_item.price(currency: params[:currency])
+        end
+
+        attribute :total do |wished_item, params|
+          wished_item.total(currency: params[:currency])
+        end
+
+        attribute :display_price do |wished_item, params|
+          wished_item.display_price(currency: params[:currency]).to_s
+        end
+
+        attribute :display_total do |wished_item, params|
+          wished_item.display_total(currency: params[:currency]).to_s
+        end
+
+        belongs_to :variant
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spree
+  module V2
+    module Storefront
+      class WishlistSerializer < BaseSerializer
+        set_type :wishlist
+
+        attributes :token, :name, :is_private, :is_default
+
+        attribute :variant_included do |wishlist, params|
+          wishlist.include?(params[:is_variant_included])
+        end
+
+        has_many :wished_items
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/handle_request.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class HandleRequest
+        def initialize(event_name:, subscriber:, webhook_payload_body:)
+          @event_name = event_name
+          @subscriber = subscriber
+          @webhook_payload_body = JSON.parse(webhook_payload_body)
+        end
+
+        def call
+          Rails.logger.debug(msg("sending to '#{url}'"))
+          Rails.logger.debug(msg("webhook_payload_body: #{body_with_event_metadata}"))
+
+          if request.unprocessable_uri?
+            return process(:warn, msg("can not make a request to '#{url}'"))
+          end
+          return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
+
+          process(:debug, msg("success for URL '#{url}'"))
+        end
+
+        private
+
+        attr_reader :webhook_payload_body, :event_name, :subscriber
+
+        delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?, to: :request
+        delegate :id, :url, to: :subscriber
+        delegate :created_at, :id, to: :event, prefix: true
+
+        def process(log_level, msg)
+          Rails.logger.public_send(log_level, msg)
+          make_request
+          update_event(msg)
+          nil
+        end
+
+        def request
+          @request ||=
+            Spree::Webhooks::Subscribers::MakeRequest.new(webhook_payload_body: body_with_event_metadata, url: url)
+        end
+        alias make_request request
+
+        def body_with_event_metadata
+          webhook_payload_body.
+            merge(event_created_at: event_created_at, event_id: event_id, event_type: event.name).
+            to_json
+        end
+
+        def event
+          @event ||= Spree::Webhooks::Event.create!(
+            name: event_name, subscriber_id: subscriber.id, url: url
+          )
+        end
+
+        def update_event(msg)
+          event.update(
+            execution_time: execution_time,
+            request_errors: msg,
+            response_code: response_code,
+            success: success?
+          )
+        end
+
+        def msg(msg)
+          "[SPREE WEBHOOKS] '#{event_name}' #{msg}"
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/make_request.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spree
+  module Webhooks
+    module Subscribers
+      class MakeRequest
+        def initialize(url:, webhook_payload_body:)
+          @execution_time_in_milliseconds = 0
+          @url = url
+          @webhook_payload_body = webhook_payload_body
+          @webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
+        end
+
+        def execution_time
+          request
+          @execution_time_in_milliseconds
+        end
+
+        def failed_request?
+          (200...300).exclude?(response_code)
+        end
+
+        def response_code
+          request.code.to_i
+        end
+
+        def success?
+          !unprocessable_uri? && !failed_request?
+        end
+
+        def unprocessable_uri?
+          uri_path == '' && uri_host.nil? && uri_port.nil?
+        end
+
+        private
+
+        attr_reader :execution_time_in_milliseconds, :url, :webhook_payload_body, :webhooks_timeout
+
+        HEADERS = { 'Content-Type' => 'application/json' }.freeze
+        private_constant :HEADERS
+
+        delegate :host, :path, :port, to: :uri, prefix: true
+
+        def http
+          http = Net::HTTP.new(uri_host, uri_port)
+          http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
+          http.use_ssl = true if use_ssl?
+          http
+        end
+
+        def request
+          req = Net::HTTP::Post.new(uri_path, HEADERS)
+          req.body = webhook_payload_body
+          @request ||= begin
+            start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            request_result = http.request(req)
+            @execution_time_in_milliseconds = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).in_milliseconds
+            request_result
+          end
+        rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
+          Class.new do
+            def self.code
+              '0'
+            end
+          end
+        end
+
+        def custom_read_timeout?
+          webhooks_timeout.present?
+        end
+
+        def use_ssl?
+          !(Rails.env.development? || Rails.env.test?)
+        end
+
+        def uri
+          URI(url)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks/subscribers/queue_requests.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Webhooks
+    module Subscribers
+      class QueueRequests
+        prepend Spree::ServiceModule::Base
+
+        def call(event_name:, webhook_payload_body:, **options)
+          filtered_subscribers(event_name, webhook_payload_body, options).each do |subscriber|
+            Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
+              webhook_payload_body, event_name, subscriber
+            )
+          end
+        end
+
+        private
+
+        def filtered_subscribers(event_name, _, _)
+          Spree::Webhooks::Subscriber.active.with_urls_for(event_name)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/webhooks.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Webhooks
+    def self.disable_webhooks
+      webhooks_disabled_previously = ENV['DISABLE_SPREE_WEBHOOKS']
+      begin
+        ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+        yield
+      ensure
+        ENV['DISABLE_SPREE_WEBHOOKS'] = webhooks_disabled_previously
+      end
+    end
+  end
+end

data/config/i18n-tasks.yml

@@ -0,0 +1,40 @@
+base_locale: en
+data:
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+# Find translate calls
+search:
+  paths:
+    - '../api/app'
+    - '../api/lib'
+
+#### For API v1 only, START ####
+  exclude:
+    - '../api/app/controllers/spree/api/v1/*'
+    - '../api/app/views/*'
+
+ignore_unused:
+  - 'spree.api.gateway_error'
+  - 'spree.api.invalid_api_key'
+  - 'spree.api.invalid_resource'
+  - 'spree.api.invalid_taxonomy_id'
+  - 'spree.api.must_specify_api_key'
+  - 'spree.api.negative_quantity'
+  - 'spree.api.order.could_not_transition'
+  - 'spree.api.order.insufficient_quantity'
+  - 'spree.api.order.invalid_shipping_method'
+  - 'spree.api.payment.credit_over_limit'
+  - 'spree.api.payment.update_forbidden'
+  - 'spree.api.shipment.cannot_ready'
+  - 'spree.api.shipment_transfer_errors_occurred'
+  - 'spree.api.shipment_transfer_success'
+  - 'spree.api.stock_location_required'
+  - 'spree.api.unauthorized'
+  - 'spree.api.wrong_shipment_target'
+#### For API v1 only, END ####
+
+# The PatternMapper for Spree.t
+<% I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper', patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>

data/config/initializers/doorkeeper.rb

@@ -2,11 +2,15 @@ Doorkeeper.configure do
   orm :active_record
   use_refresh_token
   api_only
-  base_controller 'ActionController::API'
+  base_controller 'Spree::Api::V2::BaseController'
+  base_metal_controller 'Spree::Api::V2::BaseController'
 
+  # FIXME: we should only skip this for Storefront API until v5
+  # we should not skip this for Platform API
   skip_client_authentication_for_password_grant { true } if defined?(skip_client_authentication_for_password_grant)
 
   resource_owner_authenticator { current_spree_user }
+  use_polymorphic_resource_owner
 
   resource_owner_from_credentials do
     user = Spree.user_class.find_for_database_authentication(email: params[:username])
@@ -21,7 +25,7 @@ Doorkeeper.configure do
   end
 
   admin_authenticator do |routes|
-    current_spree_user&.has_spree_role?('admin') || redirect_to(routes.root_url)
+    current_spree_user&.spree_admin? || redirect_to(routes.root_url)
   end
 
   grant_flows %w[password client_credentials]
@@ -33,16 +37,12 @@ Doorkeeper.configure do
   access_token_methods :from_bearer_authorization, :from_access_token_param
 
   optional_scopes :admin, :write, :read
-end
-
-Doorkeeper::AccessGrant.class_eval do
-  self.table_name = 'spree_oauth_access_grants'
-end
 
-Doorkeeper::AccessToken.class_eval do
-  self.table_name = 'spree_oauth_access_tokens'
-end
+  access_token_class 'Spree::OauthAccessToken'
+  access_grant_class 'Spree::OauthAccessGrant'
+  application_class 'Spree::OauthApplication'
 
-Doorkeeper::Application.class_eval do
-  self.table_name = 'spree_oauth_applications'
+  # using Bcrupt for token secrets is currently not supported by Doorkeeper
+  hash_token_secrets fallback: :plain
+  hash_application_secrets fallback: :plain, using: '::Doorkeeper::SecretStoring::BCrypt'
 end

data/config/locales/en.yml

@@ -1,36 +1,38 @@
+---
 en:
   spree:
     api:
-      must_specify_api_key: "You must specify an API key."
-      invalid_api_key: "Invalid API key (%{key}) specified."
-      unauthorized: "You are not authorized to perform that action."
-      invalid_resource: "Invalid resource. Please fix errors and try again."
-      resource_not_found: "The resource you were looking for could not be found."
-      gateway_error: "There was a problem with the payment gateway: %{text}"
-      access: "API Access"
-      key: "Key"
-      clear_key: "Clear key"
-      regenerate_key: "Regenerate Key"
-      no_key: "No key"
-      generate_key: "Generate API key"
-      key_generated: "Key generated"
-      key_cleared: "Key cleared"
+      gateway_error: 'There was a problem with the payment gateway: %{text}'
+      invalid_api_key: Invalid API key (%{key}) specified.
+      invalid_resource: Invalid resource. Please fix errors and try again.
+      invalid_taxonomy_id: Invalid taxonomy id.
+      must_specify_api_key: You must specify an API key.
+      negative_quantity: quantity is negative
       order:
-        could_not_transition: "The order could not be transitioned. Please fix the errors and try again."
-        invalid_shipping_method: "Invalid shipping method specified."
+        could_not_transition: The order could not be transitioned. Please fix the errors and try again.
         insufficient_quantity: An item in your cart has become unavailable.
+        invalid_shipping_method: Invalid shipping method specified.
       payment:
-        credit_over_limit: "This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number."
-        update_forbidden: "This payment cannot be updated because it is %{state}."
+        credit_over_limit: This payment can only be credited up to %{limit}. Please specify an amount less than or equal to this number.
+        update_forbidden: This payment cannot be updated because it is %{state}.
+      resource_not_found: The resource you were looking for could not be found.
       shipment:
-        cannot_ready: "Cannot ready shipment."
-      stock_location_required: "A stock_location_id parameter must be provided in order to retrieve stock movements."
-      invalid_taxonomy_id: "Invalid taxonomy id."
-      shipment_transfer_errors_occurred: "Following errors occurred while attempting this action:"
-      negative_quantity: "quantity is negative"
-      wrong_shipment_target: "target shipment is the same as original shipment"
-
+        cannot_ready: Cannot ready shipment.
+      shipment_transfer_errors_occurred: 'Following errors occurred while attempting this action:'
+      shipment_transfer_success: Variants successfully transferred
+      stock_location_required: A stock_location_id parameter must be provided in order to retrieve stock movements.
+      unauthorized: You are not authorized to perform that action.
       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"
+          no_coupon_code: No coupon code provided and the Order doesn't have any coupon code promotions applied
+          wrong_quantity: Quantity has to be greater than 0
+        digitals:
+          missing_file: 'Missing Digital Item: attachment'
+          unauthorized: Error, you are not authorized to access this asset
+        metadata:
+          invalid_params: Public and private metadata parameters should be objects
+        wishlist:
+          errors:
+            the_wishlist_could_not_be_destroyed: The wishlist could not be destroyed.
+          wrong_quantity: Quantity has to be greater than 0
+      wrong_shipment_target: target shipment is the same as original shipment