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.

Adds Spree::Webhooks::Event#signature_for

Stefan Vermaas7b4126f7494d
diff --git a/api/app/models/spree/webhooks/event.rb b/api/app/models/spree/webhooks/event.rb
index ee77b2dca5..66350dd9db 100644
--- a/api/app/models/spree/webhooks/event.rb
+++ b/api/app/models/spree/webhooks/event.rb
@@ -7,6 +7,14 @@ module Spree
self.whitelisted_ransackable_associations = %w[subscriber]
self.whitelisted_ransackable_attributes = %w[name request_errors response_code success url]
+
+ # Computes the base64-encoded HMAC SHA256 signature of the event for the given payload.
+ #
+ # @param payload [Hash, String] The payload for to the webhook subscriber.
+ # @return [String]
+ def signature_for(payload)
+ EventSignature.new(self, payload).computed_signature
+ end
end
end
end
diff --git a/api/spec/models/spree/webhooks/event_spec.rb b/api/spec/models/spree/webhooks/event_spec.rb
index 3a9f1550aa..56392c1e11 100644
--- a/api/spec/models/spree/webhooks/event_spec.rb
+++ b/api/spec/models/spree/webhooks/event_spec.rb
@@ -28,4 +28,16 @@ describe Spree::Webhooks::Event do
end
end
end
+
+ describe '#signature_for' do
+ subject(:signature) { event.signature_for(payload) }
+
+ let(:event) { create(:event) }
+ let(:payload) { { id: 123 }.to_json }
+
+ it 'computes a signature for the JSON payload' do
+ expect(signature).to \
+ eq(Spree::Webhooks::EventSignature.new(event, payload).computed_signature)
+ end
+ end
end