spree_api 4.3.0.rc3 → 4.4.0.rc2

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,17 @@
+module Spree
+  module Webhooks
+    module Subscribers
+      class QueueRequests
+        prepend Spree::ServiceModule::Base
+
+        def call(event_name:, webhook_payload_body:)
+          Spree::Webhooks::Subscriber.active.with_urls_for(event_name).each do |subscriber|
+            Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(
+              webhook_payload_body, event_name, subscriber
+            )
+          end
+        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/initializers/rabl.rb

@@ -3,7 +3,7 @@ Rabl.configure do |config|
   config.include_child_root = false
 
   # Motivation here it make it call as_json when rendering timestamps
-  # and therefore display miliseconds. Otherwise it would fall to
-  # JSON.dump which doesn't display the miliseconds
+  # and therefore display milliseconds. Otherwise it would fall to
+  # JSON.dump which doesn't display the milliseconds
   config.json_engine = ActiveSupport::JSON
 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

data/config/routes.rb

@@ -137,16 +137,20 @@ Spree::Core::Engine.add_routes do
           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
+          patch :associate
+          patch :change_currency
         end
 
         resource :checkout, controller: :checkout, only: %i[update] do
           patch :next
           patch :advance
           patch :complete
+          post :create_payment
           post :add_store_credit
           post :remove_store_credit
           get :payment_methods
           get :shipping_rates
+          patch :select_shipping_method
         end
 
         resource :account, controller: :account, only: %i[show create update]
@@ -166,32 +170,47 @@ Spree::Core::Engine.add_routes do
 
         resources :menus, only: %i[index show]
         resources :cms_pages, only: %i[index show]
+
+        resources :wishlists do
+          get :default, on: :collection
+
+          member do
+            post :add_item
+            patch 'set_item_quantity/:item_id', to: 'wishlists#set_item_quantity', as: :set_item_quantity
+            delete 'remove_item/:item_id', to: 'wishlists#remove_item', as: :remove_item
+          end
+        end
+
+        get '/digitals/:token', to: 'digitals#download', as: 'digital'
       end
 
       namespace :platform do
         # Promotions API
         resources :promotions
+        resources :promotion_actions
+        resources :promotion_categories
+        resources :promotion_rules
 
         # Returns API
         resources :customer_returns
         resources :reimbursements
         resources :return_authorizations do
           member do
-            put :add
-            put :cancel
-            put :receive
+            patch :add
+            patch :cancel
+            patch :receive
           end
         end
 
         # Product Catalog API
         resources :products
         resources :taxonomies
-        resources :taxons
-        resources :classifications do
+        resources :taxons do
           member do
-            put :reposition
+            patch :reposition
           end
         end
+        resources :classifications
         resources :images
         resources :variants
         resources :properties
@@ -202,26 +221,38 @@ Spree::Core::Engine.add_routes do
         # Order API
         resources :orders do
           member do
-            put :next
-            put :advance
-            put :approve
-            put :cancel
-            put :empty
-            put :apply_coupon_code
-            put :remove_coupon_code
+            patch :next
+            patch :advance
+            patch :approve
+            patch :cancel
+            patch :empty
+            patch :apply_coupon_code
+            patch :complete
+            patch :use_store_credit
+            patch :cancel
+            patch :approve
           end
         end
         resources :line_items
+        resources :adjustments
+
+        # Payments API
         resources :payments do
-          member do
-            put :authorize
-            put :capture
-            put :purchase
-            put :void
-            put :credit
-          end
+          # TODO: support custom actions
+          # member do
+          #   patch :authorize
+          #   patch :capture
+          #   patch :purchase
+          #   patch :void
+          #   patch :credit
+          # end
         end
 
+        # Store Credit API
+        resources :store_credits
+        resources :store_credit_categories
+        resources :store_credit_types
+
         # Geo API
         resources :zones
         resources :countries, only: [:index, :show]
@@ -229,18 +260,21 @@ Spree::Core::Engine.add_routes do
 
         # Shipment API
         resources :shipments do
-          collection do
-            post 'transfer_to_location'
-            post 'transfer_to_shipment'
-          end
           member do
-            put :ready
-            put :ship
-            put :add
-            put :remove
+            %w[ready ship cancel resume pend].each do |state|
+              patch state.to_sym
+            end
+            patch :add_item
+            patch :remove_item
+            patch :transfer_to_location
+            patch :transfer_to_shipment
           end
         end
 
+        # Tax API
+        resources :tax_rates
+        resources :tax_categories
+
         # Inventory API
         resources :inventory_units
         resources :stock_items
@@ -252,6 +286,8 @@ Spree::Core::Engine.add_routes do
         resources :credit_cards
         resources :addresses
 
+        resources :roles
+
         # Menu API
         resources :menus
         resources :menu_items do
@@ -260,46 +296,36 @@ Spree::Core::Engine.add_routes do
           end
         end
 
-        # CMS Pages API
-        resources :cms_pages do
-          member do
-            patch :toggle_visibility
-          end
-        end
+        # CMS
+        resources :cms_pages
+        resources :cms_sections
+
+        # Wishlists API
+        resources :wishlists
+        resources :wished_items
 
-        resource :cms_sections do
+        # Digitals API
+        resources :digitals
+        resources :digital_links do
           member do
-            patch :reposition
+            patch :reset
           end
         end
 
         # Store API
         resources :stores
-      end
-    end
 
-    get '/404', to: 'errors#render_404'
+        # Configurations API
+        resources :payment_methods
+        resources :shipping_categories
+        resources :shipping_methods
 
-    match 'v:api/*path', to: redirect { |params, request|
-      format = ".#{params[:format]}" unless params[:format].blank?
-      query  = "?#{request.query_string}" unless request.query_string.blank?
-
-      if request.path == "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-        "#{spree_path}api/404"
-      else
-        "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-      end
-    }, via: [:get, :post, :put, :patch, :delete]
-
-    match '*path', to: redirect { |params, request|
-      format = ".#{params[:format]}" unless params[:format].blank?
-      query  = "?#{request.query_string}" unless request.query_string.blank?
-
-      if request.path == "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
-        "#{spree_path}api/404"
-      else
-        "#{spree_path}api/v1/#{params[:path]}#{format}#{query}"
+        # Webhooks API
+        namespace :webhooks do
+          resources :events, only: :index
+          resources :subscribers
+        end
       end
-    }, via: [:get, :post, :put, :patch, :delete]
+    end
   end
 end

data/db/migrate/20210902162826_create_spree_webhooks_tables.rb

@@ -0,0 +1,16 @@
+class CreateSpreeWebhooksTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_subscribers do |t|
+      t.string :url, null: false
+      t.boolean :active, default: false, index: true
+
+      if t.respond_to? :jsonb
+        t.jsonb :subscriptions
+      else
+        t.json :subscriptions
+      end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210919183228_enable_polymorphic_resource_owner.rb

@@ -0,0 +1,21 @@
+class EnablePolymorphicResourceOwner < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_oauth_access_tokens, :resource_owner_type, :string
+    add_column :spree_oauth_access_grants, :resource_owner_type, :string
+    change_column_null :spree_oauth_access_grants, :resource_owner_type, false
+
+    add_index :spree_oauth_access_tokens,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_tokens'
+
+    add_index :spree_oauth_access_grants,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_grants'
+
+    Spree::OauthAccessToken.reset_column_information
+    Spree::OauthAccessToken.update_all(resource_owner_type: Spree.user_class)
+
+    Spree::OauthAccessGrant.reset_column_information
+    Spree::OauthAccessGrant.update_all(resource_owner_type: Spree.user_class)
+  end
+end

data/db/migrate/20211025162826_create_spree_webhooks_events.rb

@@ -0,0 +1,14 @@
+class CreateSpreeWebhooksEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_events do |t|
+      t.integer "execution_time"
+      t.string "name", null: false
+      t.string "request_errors"
+      t.string "response_code", index: true
+      t.belongs_to "subscriber", null: false, index: true
+      t.boolean "success", index: true
+      t.string "url", null: false
+      t.timestamps
+    end
+  end
+end