hooks-ruby 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6bca4c82b0d3c507e2f772257a0e6ed5a30a072bb51b61da45d1c2688d99ba
-  data.tar.gz: c0d8a9f0aea0b3c5f039b7cb3354d418b79fab87aa14a4738ffb7ee04b554a2d
+  metadata.gz: 60133a1ffe3b89d168e58f606335ce3f23da219251790a331973b5691310b7f9
+  data.tar.gz: 158d1d0522c8e8aa55dd014a06a67f6b4922e87a3224adefb173beea78feed27
 SHA512:
-  metadata.gz: 0afe8a3b475163b154d7016b939fcf4fcdd40312534ea732018cc8cfe407823b3266d7c31881d010725bfa670927dfe6e6fd84663ca68ccb54dc27179fb01293
-  data.tar.gz: '04844e2020cc32371f889986c1eadc5c4cbd83bcac06a566466784ff306525e02713eb7f75838a304aa283b230b08b61760dc80f1e4fef993b2d163aaf587fbd'
+  metadata.gz: e56464ca7e87dd022060b36bd0678795efbec4ea6c6fd9bf65c7318320a32624dd9e3c3ad21e2838f701be7593766ad34fe1a65bc851c41209e2e4c9fe149f51
+  data.tar.gz: b88b05bf7643f248181973c9954a23dde5b61b0d23bec67d364e20756e2f567a355863725ff81d0644dbdb480788ec261e611d25aba84f09725d6a54d59b629c

data/lib/hooks/app/api.rb

@@ -38,8 +38,8 @@ module Hooks
           content_type :txt, "text/plain"
           content_type :xml, "application/xml"
           content_type :any, "*/*"
-          format :txt
-          default_format :txt
+
+          default_format config[:default_format] || :json
         end
 
         api_class.class_eval do
@@ -117,22 +117,21 @@ module Hooks
                   log.info("successfully processed webhook event with handler: #{handler_class_name}")
                   log.debug("processing duration: #{Time.now - start_time}s")
                   status 200
-                  content_type "application/json"
-                  response.to_json
+                  response
                 rescue Hooks::Plugins::Handlers::Error => e
                   # Handler called error! method - immediately return error response and exit the request
                   log.debug("handler #{handler_class_name} called `error!` method")
 
-                  error_response = nil
-
                   status e.status
                   case e.body
                   when String
+                    # if error! was called with a string, we assume it's a simple text error
+                    # example: error!("simple text error", 400) -> should return a plain text response
                     content_type "text/plain"
                     error_response = e.body
                   else
-                    content_type "application/json"
-                    error_response = e.body.to_json
+                    # Let Grape handle JSON conversion with the default format
+                    error_response = e.body
                   end
 
                   return error_response
@@ -163,8 +162,7 @@ module Hooks
                   error_response[:handler] = handler_class_name unless config[:production]
 
                   status determine_error_code(e)
-                  content_type "application/json"
-                  error_response.to_json
+                  error_response
                 end
               end
             end

data/lib/hooks/app/endpoints/catchall.rb

@@ -17,6 +17,13 @@ module Hooks
     class CatchallEndpoint < Grape::API
       include Hooks::App::Helpers
 
+      # Set up content types and default format to JSON to match main API
+      content_type :json, "application/json"
+      content_type :txt, "text/plain"
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      default_format :json
+
       def self.mount_path(config)
         # :nocov:
         "#{config[:root_path]}/*path"
@@ -81,8 +88,7 @@ module Hooks
               log.info("successfully processed webhook event with handler: #{handler_class_name}")
               log.debug("processing duration: #{Time.now - start_time}s")
               status 200
-              content_type "application/json"
-              response.to_json
+              response
             rescue StandardError => e
               err_msg = "Error processing webhook event with handler: #{handler_class_name} - #{e.message} " \
                 "- request_id: #{request_id} - path: #{full_path} - method: #{http_method} - " \
@@ -102,8 +108,7 @@ module Hooks
               error_response[:handler] = handler_class_name unless config[:production]
 
               status determine_error_code(e)
-              content_type "application/json"
-              error_response.to_json
+              error_response
             end
           end
         end

data/lib/hooks/app/endpoints/health.rb

@@ -6,14 +6,20 @@ require_relative "../../version"
 module Hooks
   module App
     class HealthEndpoint < Grape::API
+      # Set up content types and default format to JSON
+      content_type :json, "application/json"
+      content_type :txt, "text/plain"
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      default_format :json
+
       get do
-        content_type "application/json"
         {
           status: "healthy",
           timestamp: Time.now.utc.iso8601,
           version: Hooks::VERSION,
           uptime_seconds: (Time.now - Hooks::App::API.server_start_time).to_i
-        }.to_json
+        }
       end
     end
   end

data/lib/hooks/app/endpoints/version.rb

@@ -6,12 +6,18 @@ require_relative "../../version"
 module Hooks
   module App
     class VersionEndpoint < Grape::API
+      # Set up content types and default format to JSON
+      content_type :json, "application/json"
+      content_type :txt, "text/plain"
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      default_format :json
+
       get do
-        content_type "application/json"
         {
           version: Hooks::VERSION,
           timestamp: Time.now.utc.iso8601
-        }.to_json
+        }
       end
     end
   end

data/lib/hooks/core/config_loader.rb

@@ -20,7 +20,8 @@ module Hooks
         production: true,
         endpoints_dir: "./config/endpoints",
         use_catchall_route: false,
-        normalize_headers: true
+        normalize_headers: true,
+        default_format: :json
       }.freeze
 
       SILENCE_CONFIG_LOADER_MESSAGES = ENV.fetch(
@@ -31,16 +32,24 @@ module Hooks
       #
       # @param config_path [String, Hash] Path to config file or config hash
       # @return [Hash] Merged configuration
+      # @raise [ArgumentError] if config file path is provided but file doesn't exist
+      # @raise [RuntimeError] if config file exists but fails to load
       def self.load(config_path: nil)
         config = DEFAULT_CONFIG.dup
         overrides = []
 
         # Load from file if path provided
-        if config_path.is_a?(String) && File.exist?(config_path)
+        if config_path.is_a?(String)
+          unless File.exist?(config_path)
+            raise ArgumentError, "Configuration file not found: #{config_path}"
+          end
+
           file_config = load_config_file(config_path)
           if file_config
             overrides << "file config"
             config.merge!(file_config)
+          else
+            raise RuntimeError, "Failed to load configuration from file: #{config_path}"
           end
         end
 
@@ -126,7 +135,6 @@ module Hooks
         env_config = {}
 
         env_mappings = {
-          "HOOKS_HANDLER_DIR" => :handler_dir,
           "HOOKS_HANDLER_PLUGIN_DIR" => :handler_plugin_dir,
           "HOOKS_AUTH_PLUGIN_DIR" => :auth_plugin_dir,
           "HOOKS_LIFECYCLE_PLUGIN_DIR" => :lifecycle_plugin_dir,
@@ -141,6 +149,7 @@ module Hooks
           "HOOKS_ENDPOINTS_DIR" => :endpoints_dir,
           "HOOKS_USE_CATCHALL_ROUTE" => :use_catchall_route,
           "HOOKS_NORMALIZE_HEADERS" => :normalize_headers,
+          "HOOKS_DEFAULT_FORMAT" => :default_format,
           "HOOKS_SOME_STRING_VAR" => :some_string_var # Added for test
         }
 
@@ -155,6 +164,9 @@ module Hooks
           when :use_catchall_route, :normalize_headers
             # Convert string to boolean
             env_config[config_key] = %w[true 1 yes on].include?(value.downcase)
+          when :default_format
+            # Convert string to symbol
+            env_config[config_key] = value.to_sym
           else
             env_config[config_key] = value
           end

data/lib/hooks/core/config_validator.rb

@@ -12,21 +12,21 @@ module Hooks
 
       # Global configuration schema
       GLOBAL_CONFIG_SCHEMA = Dry::Schema.Params do
-        optional(:handler_dir).filled(:string)  # For backward compatibility
-        optional(:handler_plugin_dir).filled(:string)
+        required(:handler_plugin_dir).filled(:string)
         optional(:auth_plugin_dir).maybe(:string)
         optional(:lifecycle_plugin_dir).maybe(:string)
         optional(:instruments_plugin_dir).maybe(:string)
-        optional(:log_level).filled(:string, included_in?: %w[debug info warn error])
+        required(:log_level).filled(:string, included_in?: %w[debug info warn error])
         optional(:request_limit).filled(:integer, gt?: 0)
         optional(:request_timeout).filled(:integer, gt?: 0)
-        optional(:root_path).filled(:string)
+        required(:root_path).filled(:string)
         optional(:health_path).filled(:string)
         optional(:version_path).filled(:string)
-        optional(:environment).filled(:string, included_in?: %w[development production])
+        required(:environment).filled(:string, included_in?: %w[development production])
         optional(:endpoints_dir).filled(:string)
         optional(:use_catchall_route).filled(:bool)
         optional(:normalize_headers).filled(:bool)
+        optional(:default_format).filled(:symbol, included_in?: %i[json txt xml any])
 
         optional(:ip_filtering).hash do
           optional(:ip_header).filled(:string)

data/lib/hooks/version.rb

@@ -4,5 +4,5 @@
 module Hooks
   # Current version of the Hooks webhook framework
   # @return [String] The version string following semantic versioning
-  VERSION = "0.3.2".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hooks-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - github