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.

Rename `Webhooks::Endpoint` to `Webhooks::Subscriber`

Damian Legawiec371fc4f62837
diff --git a/api/app/jobs/spree/webhooks/endpoints/make_request_job.rb b/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
similarity index 60%
rename from api/app/jobs/spree/webhooks/endpoints/make_request_job.rb
rename to api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
index d9e5936a35..896302f6d0 100644
--- a/api/app/jobs/spree/webhooks/endpoints/make_request_job.rb
+++ b/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
@@ -1,11 +1,11 @@
module Spree
module Webhooks
- module Endpoints
+ module Subscribers
class MakeRequestJob < Spree::BaseJob
queue_as :spree_webhooks
def perform(body, event, url)
- Spree::Webhooks::Endpoints::HandleRequest.new(body: body, event: event, url: url).call
+ Spree::Webhooks::Subscribers::HandleRequest.new(body: body, event: event, url: url).call
end
end
end
diff --git a/api/app/models/concerns/spree/webhooks/has_webhooks.rb b/api/app/models/concerns/spree/webhooks/has_webhooks.rb
index f78765011a..4f29489202 100644
--- a/api/app/models/concerns/spree/webhooks/has_webhooks.rb
+++ b/api/app/models/concerns/spree/webhooks/has_webhooks.rb
@@ -11,7 +11,7 @@ module Spree
def queue_webhooks_requests!(event)
return if disable_spree_webhooks? || webhooks_descendant? || body.blank?
- Spree::Webhooks::Endpoints::QueueRequests.call(event: event, body: body)
+ Spree::Webhooks::Subscribers::QueueRequests.call(event: event, body: body)
end
end
diff --git a/api/app/models/spree/webhooks/endpoint.rb b/api/app/models/spree/webhooks/subscriber.rb
similarity index 52%
rename from api/app/models/spree/webhooks/endpoint.rb
rename to api/app/models/spree/webhooks/subscriber.rb
index 36070e1fc4..2f5f728f23 100644
--- a/api/app/models/spree/webhooks/endpoint.rb
+++ b/api/app/models/spree/webhooks/subscriber.rb
@@ -1,7 +1,9 @@
module Spree
module Webhooks
- class Endpoint < Spree::Webhooks::Base
+ class Subscriber < Spree::Webhooks::Base
validates :url, 'spree/url': true, presence: true
+
+ scope :active, -> { where(active: true) }
end
end
end
diff --git a/api/app/services/spree/webhooks/endpoints/handle_request.rb b/api/app/services/spree/webhooks/subscribers/handle_request.rb
similarity index 89%
rename from api/app/services/spree/webhooks/endpoints/handle_request.rb
rename to api/app/services/spree/webhooks/subscribers/handle_request.rb
index 086e0be73e..7caead3304 100644
--- a/api/app/services/spree/webhooks/endpoints/handle_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/handle_request.rb
@@ -2,7 +2,7 @@
module Spree
module Webhooks
- module Endpoints
+ module Subscribers
class HandleRequest
def initialize(body:, event:, url:)
@body = body
@@ -34,7 +34,7 @@ module Spree
attr_reader :body, :event, :url
def request
- @request ||= Spree::Webhooks::Endpoints::MakeRequest.new(body: body, url: url)
+ @request ||= Spree::Webhooks::Subscribers::MakeRequest.new(body: body, url: url)
end
def webhooks_log(msg)
diff --git a/api/app/services/spree/webhooks/endpoints/make_request.rb b/api/app/services/spree/webhooks/subscribers/make_request.rb
similarity index 98%
rename from api/app/services/spree/webhooks/endpoints/make_request.rb
rename to api/app/services/spree/webhooks/subscribers/make_request.rb
index eb411cc5e8..dc0477d4e7 100644
--- a/api/app/services/spree/webhooks/endpoints/make_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/make_request.rb
@@ -2,7 +2,7 @@
module Spree
module Webhooks
- module Endpoints
+ module Subscribers
class MakeRequest
def initialize(body:, url:)
@body = body
diff --git a/api/app/services/spree/webhooks/endpoints/queue_requests.rb b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
similarity index 61%
rename from api/app/services/spree/webhooks/endpoints/queue_requests.rb
rename to api/app/services/spree/webhooks/subscribers/queue_requests.rb
index 89bb40c11d..c957af06a4 100644
--- a/api/app/services/spree/webhooks/endpoints/queue_requests.rb
+++ b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
@@ -1,24 +1,22 @@
module Spree
module Webhooks
- module Endpoints
+ module Subscribers
class QueueRequests
prepend Spree::ServiceModule::Base
def call(body:, event:)
- urls_subscribed_to(event).each do |url|
- Spree::Webhooks::Endpoints::MakeRequestJob.perform_later(body, event, url)
+ subscriberd_urls_for(event).each do |url|
+ Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(body, event, url)
end
end
private
- def urls_subscribed_to(event)
- Spree::Webhooks::Endpoint.
- where(enabled: true).
- where(subscriptions_where_statement(event)).
- pluck(:url)
+ def subscriberd_urls_for(event)
+ Spree::Webhooks::Subscriber.active.where(subscriptions_where_statement(event)).pluck(:url)
end
+ # FIXME: this should be written as scope
def subscriptions_where_statement(event)
case ActiveRecord::Base.connection.adapter_name
when 'Mysql2'
diff --git a/api/db/migrate/20210902162826_create_spree_webhooks_tables.rb b/api/db/migrate/20210902162826_create_spree_webhooks_tables.rb
index bc65024a2f..a2048967f9 100644
--- a/api/db/migrate/20210902162826_create_spree_webhooks_tables.rb
+++ b/api/db/migrate/20210902162826_create_spree_webhooks_tables.rb
@@ -1,8 +1,8 @@
class CreateSpreeWebhooksTables < ActiveRecord::Migration[5.2]
def change
- create_table :spree_webhooks_endpoints do |t|
+ create_table :spree_webhooks_subscribers do |t|
t.string :url, null: false
- t.boolean :enabled, default: false, index: true
+ t.boolean :active, default: false, index: true
if t.respond_to? :jsonb
t.jsonb :subscriptions
diff --git a/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb b/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
index 986cabf533..e66f2dc0ca 100644
--- a/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
+++ b/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
@@ -1,12 +1,12 @@
require 'spec_helper'
-describe Spree::Webhooks::Endpoints::MakeRequestJob do
+describe Spree::Webhooks::Subscribers::MakeRequestJob do
let(:body) { {} }
let(:event) { 'order.cancel' }
let(:queue) { 'spree_webhooks' }
let(:url) { 'http://url.com/' }
- it 'enqueues a HTTP request using Spree::Webhooks::Endpoints::HandleRequest', :job do
+ it 'enqueues a HTTP request using Spree::Webhooks::Subscribers::HandleRequest', :job do
expect { described_class.perform_later(body, event, url) }.to have_enqueued_job.on_queue(queue)
end
end
diff --git a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
index a01d8a0f5e..dcd50f7929 100644
--- a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
+++ b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
@@ -30,7 +30,7 @@ describe Spree::Webhooks::HasWebhooks do
end
before do
- allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)
+ allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
allow(queue_requests).to receive(:call).with(any_args)
end
@@ -45,7 +45,7 @@ describe Spree::Webhooks::HasWebhooks do
)
end
let(:store) { create(:store) }
- let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }
+ let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
context 'with DISABLE_SPREE_WEBHOOKS equals "true" (set in spec_helper)' do
before { product.save }
diff --git a/api/spec/models/spree/api/webhooks/order_spec.rb b/api/spec/models/spree/api/webhooks/order_spec.rb
index 682d274603..987f21410e 100644
--- a/api/spec/models/spree/api/webhooks/order_spec.rb
+++ b/api/spec/models/spree/api/webhooks/order_spec.rb
@@ -2,7 +2,7 @@ require 'spec_helper'
describe Spree::Order do
describe 'sending webhooks after transitioning from states' do
- let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }
+ let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
let(:store) { create(:store, default: true) }
let(:body) do
Spree::Api::V2::Platform::OrderSerializer.new(order).serializable_hash.to_json
@@ -10,7 +10,7 @@ describe Spree::Order do
before do
ENV['DISABLE_SPREE_WEBHOOKS'] = nil
- allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)
+ allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
allow(queue_requests).to receive(:call).with(any_args)
end
diff --git a/api/spec/models/spree/api/webhooks/payment_spec.rb b/api/spec/models/spree/api/webhooks/payment_spec.rb
index 1ae8351fba..06ed01d027 100644
--- a/api/spec/models/spree/api/webhooks/payment_spec.rb
+++ b/api/spec/models/spree/api/webhooks/payment_spec.rb
@@ -5,7 +5,7 @@ describe Spree::Payment do
describe '#void' do
let(:body) { Spree::Api::V2::Platform::PaymentSerializer.new(payment).serializable_hash.to_json }
- let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }
+ let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
shared_examples 'queues a webhook request' do
before do
@@ -14,7 +14,7 @@ describe Spree::Payment do
# because after_void queues the HTTP request before finishing the transition, hence
# the total state changes that are sent in the body is one less.
allow(payment).to receive_message_chain(:state_changes, :create!)
- allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)
+ allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
allow(queue_requests).to receive(:call).with(any_args)
end
diff --git a/api/spec/models/spree/api/webhooks/shipment_spec.rb b/api/spec/models/spree/api/webhooks/shipment_spec.rb
index 0e9a7e4c29..2831391178 100644
--- a/api/spec/models/spree/api/webhooks/shipment_spec.rb
+++ b/api/spec/models/spree/api/webhooks/shipment_spec.rb
@@ -11,13 +11,13 @@ describe Spree::Shipment do
# because after_ship queues the HTTP request before finishing the transition, hence
# the total state changes that are sent in the body is one less.
allow(shipment).to receive_message_chain(:state_changes, :create!)
- allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)
+ allow(Spree::Webhooks::Subscribers::QueueRequests).to receive(:new).and_return(queue_requests)
allow(queue_requests).to receive(:call).with(any_args)
end
after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }
- let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }
+ let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }
it 'executes QueueRequests.call with a shipment.ship event and {} body after invoking ship' do
shipment.cancel # previous state that allows the object be shipped
diff --git a/api/spec/models/spree/webhooks/endpoint_spec.rb b/api/spec/models/spree/webhooks/subscriber_spec.rb
similarity index 63%
rename from api/spec/models/spree/webhooks/endpoint_spec.rb
rename to api/spec/models/spree/webhooks/subscriber_spec.rb
index b22427db81..1bf2dfed77 100644
--- a/api/spec/models/spree/webhooks/endpoint_spec.rb
+++ b/api/spec/models/spree/webhooks/subscriber_spec.rb
@@ -1,15 +1,15 @@
require 'spec_helper'
-describe Spree::Store do
+describe Spree::Webhooks::Subscriber do
describe 'validations' do
context 'url format' do
it 'is invalid with an invalid url' do
- endpoint = Spree::Webhooks::Endpoint.new(url: 'google.com')
+ endpoint = described_class.new(url: 'google.com')
expect(endpoint.valid?).to be(false)
end
it 'is valid with a valid url' do
- endpoint = Spree::Webhooks::Endpoint.new(url: 'http://google.com')
+ endpoint = described_class.new(url: 'http://google.com')
expect(endpoint.valid?).to be(true)
end
end
diff --git a/api/spec/services/spree/webhooks/endpoints/handle_request_spec.rb b/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
similarity index 92%
rename from api/spec/services/spree/webhooks/endpoints/handle_request_spec.rb
rename to api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
index 1486e9012c..18d30ab422 100644
--- a/api/spec/services/spree/webhooks/endpoints/handle_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
@@ -1,20 +1,20 @@
require 'spec_helper'
-describe Spree::Webhooks::Endpoints::HandleRequest do
+describe Spree::Webhooks::Subscribers::HandleRequest do
describe '#call' do
subject { described_class.new(body: body, event: event, url: url) }
let(:body) { { foo: :bar }.to_json }
let(:event) { 'order.cancel' }
let(:headers) { { 'Content-Type' => 'application/json' } }
- let(:request_double) { instance_double(Spree::Webhooks::Endpoints::MakeRequest) }
+ let(:request_double) { instance_double(Spree::Webhooks::Subscribers::MakeRequest) }
let(:url) { 'http://google.com/' }
context 'with an unexpected body' do
let(:body) { '' }
it 'does not instantiate a new request' do
- expect(Spree::Webhooks::Endpoints::MakeRequest).not_to receive(:new)
+ expect(Spree::Webhooks::Subscribers::MakeRequest).not_to receive(:new)
subject.call
end
diff --git a/api/spec/services/spree/webhooks/endpoints/make_request_spec.rb b/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
similarity index 98%
rename from api/spec/services/spree/webhooks/endpoints/make_request_spec.rb
rename to api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
index f02a4505bd..2682fad1ed 100644
--- a/api/spec/services/spree/webhooks/endpoints/make_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
@@ -1,6 +1,6 @@
require 'spec_helper'
-describe Spree::Webhooks::Endpoints::MakeRequest do
+describe Spree::Webhooks::Subscribers::MakeRequest do
let(:body) { { data: [{}] }.to_json }
let(:url) { 'google.com' }
diff --git a/api/spec/services/spree/webhooks/endpoints/queue_requests_spec.rb b/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
similarity index 84%
rename from api/spec/services/spree/webhooks/endpoints/queue_requests_spec.rb
rename to api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
index 78630f449b..769591395d 100644
--- a/api/spec/services/spree/webhooks/endpoints/queue_requests_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
@@ -1,13 +1,13 @@
require 'spec_helper'
-describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks do
+describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
describe '#call' do
subject { described_class.call(event: event, body: body) }
let(:event) { 'order.finalize' }
let(:body) { {} }
let(:queue) { 'spree_webhooks' }
- let(:make_request_job) { Spree::Webhooks::Endpoints::MakeRequestJob }
+ let(:make_request_job) { Spree::Webhooks::Subscribers::MakeRequestJob }
context 'without subscriptions for the given event' do
it 'does not queue a job to make a request' do
@@ -20,10 +20,10 @@ describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks do
before { stub_request(:post, endpoint.url) }
let(:endpoint) do
- Spree::Webhooks::Endpoint.create(
+ Spree::Webhooks::Subscriber.create(
url: 'https://url1.com/',
subscriptions: ['*'],
- enabled: true
+ active: true
)
end
@@ -38,10 +38,10 @@ describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks do
before { stub_request(:post, endpoint.url) }
let(:endpoint) do
- Spree::Webhooks::Endpoint.create(
+ Spree::Webhooks::Subscriber.create(
url: 'https://url2.com/',
subscriptions: [event],
- enabled: true
+ active: true
)
end
@@ -54,7 +54,7 @@ describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks do
context 'when endpoint subscriptions are not enabled' do
let(:endpoint) do
- Spree::Webhooks::Endpoint.create(
+ Spree::Webhooks::Subscriber.create(
url: 'https://url3.com/',
subscriptions: [event],
enabled: false
@@ -68,10 +68,10 @@ describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks do
context 'when endpoint subscriptions do not include the event or "*"' do
let(:endpoint) do
- Spree::Webhooks::Endpoint.create(
+ Spree::Webhooks::Subscriber.create(
url: 'https://url4.com/',
subscriptions: ['order.resume'],
- enabled: true
+ active: true
)
end