action_webhook 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7077d23d4f22c68b2a33a9cc9ee6e6ad911d9c9ee23a2a861bb93837c69910e7
-  data.tar.gz: 124749c8b109502308684d10e5a05791f99f35f26a0d01bdc1b3d11fd3ff43d3
+  metadata.gz: 5fd47bb2e72c2bd12feab3682031b00603f271279b435eeb56b5a4e7dba6bccb
+  data.tar.gz: a4e22834b739227926772b9b8d18f4dbc74c1d7f7fc06bcbc1174707a306897d
 SHA512:
-  metadata.gz: c3be33f1a7a4528062882ea98e05caa9d61ef413bc72e4fba03788a7862e52b891f91897389e513f712fddaab7f7b5b68f4367b091f148df897a0548b25db556
-  data.tar.gz: 41d39d74c5ce2854375b1397552b687d64d9f3ad991eade8b92627b2f5efed8744de3fa092fe72926a244e50244a4363174b1ba91ad537bc0f485c94552d8a5c
+  metadata.gz: dd8df71521ef095e6f52aad36daacb1e518ec400a0cb1aa8919568dbe240731097679f18933bd9d30406d17a02685ffd79570189067e84405c80968c834de015
+  data.tar.gz: f42e11c74f275f4206c992a9e96a6e3b37eb40ed4f53191dbbef2192c596a2f039c172bd9d888f33ae0c18b9dc504a25d40055f86fba847ba5188c4e578af672

data/lib/action_webhook/base.rb

@@ -4,6 +4,10 @@ module ActionWebhook
   # 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' }]
+  #
   # Example:
   #
   #   class UserWebhook < ActionWebhook::Base
@@ -41,10 +45,26 @@ module ActionWebhook
   #
   #     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
   #
@@ -81,12 +101,21 @@ module ActionWebhook
       @attempts += 1
       response = process_webhook
 
-      if response.all? { |r| r[:success] }
-        invoke_callback(self.class.after_deliver_callback, response)
-      elsif @attempts < self.class.max_retries
-        retry_with_backoff
-      else
-        invoke_callback(self.class.after_retries_exhausted_callback, response)
+      # Separate successful and failed responses
+      successful_responses = response.select { |r| r[:success] }
+      failed_responses = response.reject { |r| r[:success] }
+
+      # Invoke success callback for successful deliveries
+      invoke_callback(self.class.after_deliver_callback, successful_responses) if successful_responses.any?
+
+      # 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
+        retry_with_backoff(failed_webhook_details)
+      elsif failed_responses.any?
+        # All retries exhausted for failed URLs
+        invoke_callback(self.class.after_retries_exhausted_callback, failed_responses)
       end
 
       response
@@ -225,8 +254,51 @@ 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?
       headers
@@ -318,13 +390,19 @@ module ActionWebhook
       end
     end
 
-    def retry_with_backoff
+    def retry_with_backoff(failed_webhook_details = nil)
+      # Use failed webhook details if provided, otherwise retry all
+      retry_details = failed_webhook_details || @webhook_details
+
       delay = calculate_backoff_delay
-      logger.info("Scheduling webhook retry #{@attempts + 1}/#{self.class.max_retries} in #{delay} seconds")
+      logger.info("Scheduling webhook retry #{@attempts + 1}/#{self.class.max_retries} for #{retry_details.size} URLs in #{delay} seconds")
 
       job_class = resolve_job_class
       serialized_webhook = serialize
 
+      # Update the webhook details to only include failed URLs
+      serialized_webhook["webhook_details"] = retry_details
+
       enqueue_retry_job(job_class, serialized_webhook, delay)
     end
 

data/lib/action_webhook/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: action_webhook
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Vinay Uttam Vemparala
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty