action_webhook 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2063e93683fe64ce519f241843f17e33da9f29d671b965af97c0f97540a98ecc
-  data.tar.gz: 1f591bf9cfb727d9ab6e750338b708e4e24df2e782ea3f1a5096277f4311474d
+  metadata.gz: f4e6800e63275b752cf3ac373b19b461e87800f794b7c0c547329537a993dc84
+  data.tar.gz: b1f879d8133a5b36fed56f01f689149cfb677d2f45af54b1b3c6bc2f8ad1216d
 SHA512:
-  metadata.gz: 14ed8242d705d62f573fd884e83bc70479ed4397c4bb3fffd75fd178bdc929fe5d981c395abb99ab7d647c7f1aec3aeaf1685784b3d521e3e62ed2e073ee8c1c
-  data.tar.gz: 45c7362968926262d79f6dedb16f2391d30a2b64980e3a5d0116558360ee63fe416b54f33a17012b82e5b50d8a465a58d5f91e1b6fa1f05e185959a2ce547230
+  metadata.gz: 6a7841d4ca8b3af923e88442b2ec1337598644008a244edfe089afdff178cfcfe9f7dc6b8301a51c03d145cd6501940a4ddf24eefc902f3c729f6c26c72240af
+  data.tar.gz: e415ec27166e44d35f05a1d28ace5aee7b7584545bce5521fd66f74370162ac69e8545281ca66bedb6add13f82e9a9048bd15c3b670587b651bdd3b4223cb99f

data/lib/action_webhook/base.rb

@@ -1,9 +1,20 @@
+# frozen_string_literal: true
+
 module ActionWebhook
   # Base class for defining and delivering webhooks
   #
   # Subclass this and define webhook methods (e.g. `created`, `updated`) that
   # define instance variables and call deliver to send webhooks.
   #
+  # Headers can be provided in two formats:
+  # 1. Hash format: { 'Authorization' => 'Bearer token', 'Content-Type' => 'application/json' }
+  # 2. Array format: [{ 'key' => 'Authorization', 'value' => 'Bearer token' }, { 'key' => 'Content-Type', 'value' => 'application/json' }]
+  #
+  # Debug mode can be enabled to log header processing and request details:
+  #   class MyWebhook < ActionWebhook::Base
+  #     self.debug_headers = true
+  #   end
+  #
   # Example:
   #
   #   class UserWebhook < ActionWebhook::Base
@@ -38,13 +49,30 @@ module ActionWebhook
   #
   #   class UserWebhook < ActionWebhook::Base
   #     self.deliver_later_queue_name = 'webhooks'
+  #     self.debug_headers = true  # Enable header debugging
   #
   #     def created(user)
   #       @user = user
-  #       endpoints = WebhookSubscription.where(event: 'user.created').map do |sub|
-  #         { url: sub.url, headers: { 'Authorization' => "Bearer #{sub.token}" } }
+  #       # Headers can be provided as a hash
+  #       endpoints_with_hash_headers = WebhookSubscription.where(event: 'user.created').map do |sub|
+  #         {
+  #           url: sub.url,
+  #           headers: { 'Authorization' => "Bearer #{sub.token}", 'X-Custom-Header' => 'value' }
+  #         }
   #       end
-  #       deliver(endpoints)
+  #
+  #       # Or headers can be provided as an array of key/value objects (useful for database storage)
+  #       endpoints_with_array_headers = WebhookSubscription.where(event: 'user.created').map do |sub|
+  #         {
+  #           url: sub.url,
+  #           headers: [
+  #             { 'key' => 'Authorization', 'value' => "Bearer #{sub.token}" },
+  #             { 'key' => 'X-Custom-Header', 'value' => 'value' }
+  #           ]
+  #         }
+  #       end
+  #
+  #       deliver(endpoints_with_hash_headers)
   #     end
   #   end
   #
@@ -59,6 +87,9 @@ module ActionWebhook
     class_attribute :delivery_method, instance_writer: false, default: :deliver_now
     class_attribute :perform_deliveries, instance_writer: false, default: true
 
+    # Debug configuration
+    class_attribute :debug_headers, instance_writer: false, default: false
+
     # Retry configuration
     class_attribute :max_retries, instance_writer: false, default: 3
     class_attribute :retry_delay, instance_writer: false, default: 30.seconds
@@ -91,7 +122,11 @@ module ActionWebhook
       # Handle failed responses
       if failed_responses.any? && @attempts < self.class.max_retries
         # Extract failed webhook details for retry
-        failed_webhook_details = failed_responses.map { |r| @webhook_details.find { |detail| detail[:url] == r[:url] } }.compact
+        failed_webhook_details = failed_responses.map do |r|
+          @webhook_details.find do |detail|
+            detail[:url] == r[:url]
+          end
+        end.compact
         retry_with_backoff(failed_webhook_details)
       elsif failed_responses.any?
         # All retries exhausted for failed URLs
@@ -234,14 +269,73 @@ module ActionWebhook
       assigns
     end
 
+    # Builds HTTP headers for webhook requests
+    #
+    # Supports two input formats:
+    # 1. Hash format: { 'Authorization' => 'Bearer token', 'Content-Type' => 'application/json' }
+    # 2. Array format: [{ 'key' => 'Authorization', 'value' => 'Bearer token' }, { 'key' => 'Content-Type', 'value' => 'application/json' }]
+    #
+    # The array format is useful when storing headers in databases where you need
+    # structured data with separate key and value fields.
+    #
+    # @param detail_headers [Hash, Array, nil] Headers in hash or array format
+    # @return [Hash] Formatted headers hash ready for HTTP request
     def build_headers(detail_headers)
-      headers = default_headers.merge(detail_headers)
+      # Handle both hash format and array format with key/value objects
+      processed_headers = case detail_headers
+                          when Array
+                            # Transform array of header hashes [{'key': 'value'}] into a single hash
+                            detail_headers.each_with_object({}) do |header_item, acc|
+                              next unless header_item.is_a?(Hash)
+
+                              # Handle string keys
+                              if header_item.key?("key") && header_item.key?("value")
+                                key = header_item["key"]
+                                value = header_item["value"]
+                                acc[key.to_s] = value.to_s if key && value
+                              # Handle symbol keys
+                              elsif header_item.key?(:key) && header_item.key?(:value)
+                                key = header_item[:key]
+                                value = header_item[:value]
+                                acc[key.to_s] = value.to_s if key && value
+                              else
+                                # Log warning for malformed header items
+                                logger&.warn("Skipping malformed header item: #{header_item.inspect}")
+                              end
+                            end
+                          when Hash
+                            # Ensure all keys and values are strings for consistency
+                            detail_headers.transform_keys(&:to_s).transform_values(&:to_s)
+                          when NilClass
+                            {}
+                          else
+                            logger&.warn("Unknown header format: #{detail_headers.class}. Expected Hash or Array.")
+                            {}
+                          end
+
+      headers = default_headers.merge(processed_headers)
       headers["Content-Type"] = "application/json" unless headers.key?("Content-Type")
       headers["X-Webhook-Attempt"] = @attempts.to_s if @attempts.positive?
+
+      # Debug headers if enabled
+      if self.class.debug_headers
+        logger&.info("ActionWebhook Headers Debug:")
+        logger&.info("  Default headers: #{default_headers}")
+        logger&.info("  Processed headers: #{processed_headers}")
+        logger&.info("  Final headers: #{headers}")
+      end
+
       headers
     end
 
     def send_webhook_request(url, payload, headers)
+      if self.class.debug_headers
+        logger&.info("ActionWebhook Request Debug:")
+        logger&.info("  URL: #{url}")
+        logger&.info("  Headers: #{headers}")
+        logger&.info("  Payload size: #{payload.to_json.bytesize} bytes")
+      end
+
       HTTParty.post(url, body: payload.to_json, headers: headers, timeout: 10)
     end
 

data/lib/action_webhook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionWebhook
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_webhook
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Vinay Uttam Vemparala
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-07-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +43,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement