Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add create/index/show webhooks subscribers.

Sebastian Palmaa8173d193996
diff --git a/api/app/controllers/spree/api/v2/platform/resource_controller.rb b/api/app/controllers/spree/api/v2/platform/resource_controller.rb
index fc815818a5..1880bf8b46 100644
--- a/api/app/controllers/spree/api/v2/platform/resource_controller.rb
+++ b/api/app/controllers/spree/api/v2/platform/resource_controller.rb
@@ -44,7 +44,12 @@ module Spree
protected
def resource_serializer
- "Spree::Api::V2::Platform::#{model_class.to_s.demodulize}Serializer".constantize
+ # [TODO]: quickfix
+ if (x = model_class.to_s.scan(/(?<=:|^)\b.*?\b(?=:|$)/) - %w[Spree]).size > 1
+ "Spree::Api::V2::Platform::#{x.join('::')}Serializer".constantize
+ else
+ "Spree::Api::V2::Platform::#{model_class.to_s.demodulize}Serializer".constantize
+ end
end
def collection_serializer
diff --git a/api/app/controllers/spree/api/v2/platform/webhooks/subscribers_controller.rb b/api/app/controllers/spree/api/v2/platform/webhooks/subscribers_controller.rb
new file mode 100644
index 0000000000..63dd521b0c
--- /dev/null
+++ b/api/app/controllers/spree/api/v2/platform/webhooks/subscribers_controller.rb
@@ -0,0 +1,23 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ module Webhooks
+ class SubscribersController < ResourceController
+ private
+
+ def model_class
+ Spree::Webhooks::Endpoint
+ end
+
+ def permitted_resource_params
+ params.
+ require(:subscriber).
+ permit(spree_permitted_attributes.push(*%i[enabled subscriptions url]))
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/app/serializers/spree/api/v2/platform/webhooks/endpoint_serializer.rb b/api/app/serializers/spree/api/v2/platform/webhooks/endpoint_serializer.rb
new file mode 100644
index 0000000000..f5455d2854
--- /dev/null
+++ b/api/app/serializers/spree/api/v2/platform/webhooks/endpoint_serializer.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ module Webhooks
+ class EndpointSerializer < BaseSerializer
+ set_type :webhooks_endpoint
+
+ attributes :enabled, :url, :subscriptions
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/config/routes.rb b/api/config/routes.rb
index 0e73f5a108..2656f424f3 100644
--- a/api/config/routes.rb
+++ b/api/config/routes.rb
@@ -313,6 +313,10 @@ Spree::Core::Engine.add_routes do
# Configurations API
resources :shipping_categories
+
+ namespace :webhooks do
+ resources :subscribers, only: %i[create index show]
+ end
end
end
end
diff --git a/api/spec/integration/api/v2/platform/webhooks/subscribers_spec.rb b/api/spec/integration/api/v2/platform/webhooks/subscribers_spec.rb
new file mode 100644
index 0000000000..adada8bcc9
--- /dev/null
+++ b/api/spec/integration/api/v2/platform/webhooks/subscribers_spec.rb
@@ -0,0 +1,35 @@
+require 'swagger_helper'
+require 'spec_helper'
+
+# [TODO]: move
+FactoryBot.define do
+ factory :webhook_subscriber, aliases: [:subscriber], class: Spree::Webhooks::Endpoint do
+ trait :enabled do
+ enabled { true }
+ sequence(:url) { |n| "https://www.url#{n}.com/" }
+ end
+ end
+end
+
+
+describe 'WebhooksSubscribers API', swagger: true do
+ include_context 'Platform API v2'
+
+ resource_name = 'WebhookSubscriber'
+ options = {}
+
+ let(:id) { subscriber.tap(&:save).id }
+ let(:invalid_param_value) { { url: '' } }
+ let(:records_list) { create_list(:subscriber, 2, :enabled, subscriptions: ['*']) }
+ let(:subscriber) { build(:subscriber, :enabled, subscriptions: ['*']) }
+ let(:valid_create_param_value) { subscriber.attributes }
+
+ path '/api/v2/platform/webhooks/subscribers' do
+ include_examples 'GET records list', resource_name, options
+ include_examples 'POST create record', resource_name, options
+ end
+
+ path '/api/v2/platform/webhooks/subscribers/{id}' do
+ include_examples 'GET record', resource_name, options
+ end
+end
diff --git a/api/spec/requests/spree/api/v2/platform/webhooks/subscribers_spec.rb b/api/spec/requests/spree/api/v2/platform/webhooks/subscribers_spec.rb
new file mode 100644
index 0000000000..0a90cef5f4
--- /dev/null
+++ b/api/spec/requests/spree/api/v2/platform/webhooks/subscribers_spec.rb
@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Platform API v2 Webhooks Subscribers spec', type: :request do
+ subject { post '/api/v2/platform/webhooks/subscribers', headers: bearer_token, params: params }
+
+ include_context 'API v2 tokens'
+ include_context 'Platform API v2'
+
+ let(:bearer_token) { { 'Authorization' => valid_authorization } }
+ let(:params) { { subscriber: { enabled: true, url: 'https://www.url.com/', subscriptions: ['*'] } } }
+
+ context 'valid request' do
+ it 'returns status created' do
+ subject
+ expect(response).to have_http_status :created
+ end
+
+ it 'creates a subscriber ' do
+ expect { subject }.to change { Spree::Webhooks::Endpoint.count }.from(0).to(1)
+ end
+ end
+end
diff --git a/api/spec/swagger_helper.rb b/api/spec/swagger_helper.rb
index ff487b7ce2..a8be2008b9 100644
--- a/api/spec/swagger_helper.rb
+++ b/api/spec/swagger_helper.rb
@@ -147,6 +147,15 @@ RSpec.configure do |config|
required: %w[name presentation],
'x-internal': true
},
+ webhooks_subscriber_params: {
+ type: :object,
+ properties: {
+ enabled: { type: :boolean, example: true, default: false },
+ subscriptions: { type: :array, example: ['*'], default: [] },
+ url: { type: :string, example: 'https://www.url.com/' }
+ },
+ 'x-internal': true
+ },
order_params: {
type: :object,
properties: {