gocardless_pro 4.3.0 → 4.5.0

data/lib/gocardless_pro/webhook.rb

@@ -1,6 +1,18 @@
 require 'openssl'
 
 module GoCardlessPro
+  # Represents the result of parsing a webhook, containing both the events
+  # and the webhook metadata.
+  class WebhookParseResult
+    attr_reader :events
+    attr_reader :webhook_id
+
+    def initialize(events, webhook_id)
+      @events = events
+      @webhook_id = webhook_id
+    end
+  end
+
   class Webhook
     class InvalidSignatureError < StandardError; end
 
@@ -38,6 +50,39 @@ module GoCardlessPro
         events.map { |event| Resources::Event.new(event) }
       end
 
+      # Validates that a webhook was genuinely sent by GoCardless using
+      # `.signature_valid?`, and then parses it into a WebhookParseResult containing
+      # both the events and the webhook ID from the meta field
+      #
+      # @option options [String] :request_body the request body
+      # @option options [String] :signature_header the signature included in the request,
+      #   found in the `Webhook-Signature` header
+      # @option options [String] :webhook_endpoint_secret the webhook endpoint secret for
+      #   your webhook endpoint, as configured in your GoCardless Dashboard
+      # @return [WebhookParseResult] containing the events and webhook ID
+      # @raise [InvalidSignatureError] if the signature header specified does not match
+      #   the signature computed using the request body and webhook endpoint secret
+      # @raise [ArgumentError] if a required keyword argument is not provided or is not
+      #   of the required type
+      def parse_with_meta(options = {})
+        validate_options!(options)
+
+        unless signature_valid?(request_body: options[:request_body],
+                                signature_header: options[:signature_header],
+                                webhook_endpoint_secret: options[:webhook_endpoint_secret])
+          raise InvalidSignatureError, "This webhook doesn't appear to be a genuine " \
+                                        'webhook from GoCardless, because the signature ' \
+                                        "header doesn't match the signature computed" \
+                                        ' with your webhook endpoint secret.'
+        end
+
+        parsed = JSON.parse(options[:request_body])
+        events = parsed['events'].map { |event| Resources::Event.new(event) }
+        webhook_id = parsed.dig('meta', 'webhook_id')
+
+        WebhookParseResult.new(events, webhook_id)
+      end
+
       # Validates that a webhook was genuinely sent by GoCardless by computing its
       # signature using the body and your webhook endpoint secret, and comparing that with
       # the signature included in the `Webhook-Signature` header

data/lib/gocardless_pro.rb

@@ -123,6 +123,12 @@ require_relative 'gocardless_pro/services/negative_balance_limits_service'
 require_relative 'gocardless_pro/resources/outbound_payment'
 require_relative 'gocardless_pro/services/outbound_payments_service'
 
+require_relative 'gocardless_pro/resources/outbound_payment_import'
+require_relative 'gocardless_pro/services/outbound_payment_imports_service'
+
+require_relative 'gocardless_pro/resources/outbound_payment_import_entry'
+require_relative 'gocardless_pro/services/outbound_payment_import_entries_service'
+
 require_relative 'gocardless_pro/resources/payer_authorisation'
 require_relative 'gocardless_pro/services/payer_authorisations_service'
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - GoCardless
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,57 +49,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.13.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.24.0
+        version: 3.26.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.24.0
+        version: 3.26.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.0
+        version: 1.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.0
+        version: 1.89.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
+        version: 0.9.45
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
-description:
+        version: 0.9.45
 email:
 - engineering@gocardless.com
 executables: []
@@ -154,6 +152,8 @@ files:
 - lib/gocardless_pro/resources/mandate_pdf.rb
 - lib/gocardless_pro/resources/negative_balance_limit.rb
 - lib/gocardless_pro/resources/outbound_payment.rb
+- lib/gocardless_pro/resources/outbound_payment_import.rb
+- lib/gocardless_pro/resources/outbound_payment_import_entry.rb
 - lib/gocardless_pro/resources/payer_authorisation.rb
 - lib/gocardless_pro/resources/payer_theme.rb
 - lib/gocardless_pro/resources/payment.rb
@@ -199,6 +199,8 @@ files:
 - lib/gocardless_pro/services/mandate_pdfs_service.rb
 - lib/gocardless_pro/services/mandates_service.rb
 - lib/gocardless_pro/services/negative_balance_limits_service.rb
+- lib/gocardless_pro/services/outbound_payment_import_entries_service.rb
+- lib/gocardless_pro/services/outbound_payment_imports_service.rb
 - lib/gocardless_pro/services/outbound_payments_service.rb
 - lib/gocardless_pro/services/payer_authorisations_service.rb
 - lib/gocardless_pro/services/payer_themes_service.rb
@@ -222,7 +224,6 @@ homepage: https://github.com/gocardless/gocardless-pro-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,8 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A gem for calling the GoCardless API
 test_files: []