dislogger 0.1.6 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f02d278c361c1316f47a29bedad900e03183f2f40e750656cf200d01d80f66
-  data.tar.gz: 2d78928ccb2740d8eca3a15fc81e5cc0168c2730511417b2ece3167a9f973f18
+  metadata.gz: 9a274a53633279d495fd56b23a36c52730b7ca8e8c848f918e88be497b3d1dcf
+  data.tar.gz: 7fb1ce90ab63bbff72470682564c11772d5985e32195c46681daa8daf95c83ac
 SHA512:
-  metadata.gz: 519c66523ab2f57d73f85cd06cbda35ceef6e7ae359164d45df6c2b1b30aadfe5e6828c5aa344c7862b6a89cea8807b46905b9c01bc1e135fc1da7d53a677519
-  data.tar.gz: 429ebbb1a4ee2faf591092e3cd532a519fc65d47f7a26a51a397298a31e2651dd766b4e0fdbd7cb06df689ba59a5d188f087d4b59a8c1502bd72508a40acf1ca
+  metadata.gz: 64dc81ec91e4c71e6e168aadd71ab5a7d6abd4a632a7f192a7373cf47a816a4365f232bcf337b834c29c12a1abba3c71fd660305e2e8a66bde392b4d24342f9a
+  data.tar.gz: 2f55c155f9158f0252599b34353546d65bb14b9ea447efb35ce9cc59ea9b0a58a05777775cdfc32a352065eb42d9026c169f3cf4445d01a4ca767f3be3b690da

data/README.md

@@ -7,12 +7,13 @@ A Ruby on Rails gem for elegant error handling and Discord notifications. Automa
 
 ## Features
 
-- 🚨 Automatic error handling for Rails applications
+- 🚨 Automatic error handling for Rails applications (both API and regular apps)
 - 🎯 Discord notifications for errors with customizable formatting
 - 📝 Detailed error information including backtrace
 - 🎨 Customizable error colors for different status codes
 - 🔧 Environment-based configuration
 - 🛡️ Built-in support for common Rails exceptions
+- ⚡ Works with both `ActionController::API` and `ActionController::Base`
 
 ## Installation
 
@@ -36,6 +37,16 @@ $ gem install dislogger
 
 ## Configuration
 
+### Quick Start
+
+After installing the gem, run the generator to create the configuration file:
+
+```bash
+$ rails generate dislogger:install
+```
+
+This will create an initializer at `config/initializers/dislogger.rb` with all available configuration options and their documentation.
+
 ### Setting up Discord Webhook
 
 Before configuring the gem, you need to set up a webhook in your Discord server:
@@ -68,27 +79,27 @@ DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/your-webhook-url
 
 Make sure to add `.env` to your `.gitignore` file to keep your webhook URL secure.
 
-### Additional Configuration Options
+### Configuration Options
 
-Create an initializer file at `config/initializers/dislogger.rb` with all available options:
+The generator will create an initializer with all available options:
 
 ```ruby
 Dislogger.configure do |config|
   # Required: Your Discord webhook URL (preferably from environment variables)
   config.discord_webhook_url = ENV['DISCORD_WEBHOOK_URL']
 
+  # Required: Current environment (defaults to Rails.env if available)
+  config.environment = Rails.env
+
   # Optional: Custom bot username (default: 'Error Logger')
   config.bot_username = 'My App Error Logger'
 
   # Optional: Number of backtrace lines to include (default: 5)
   config.backtrace_lines_limit = 10
 
-  # Optional: Environments where notifications are enabled (default: ['production', 'staging'])
+  # Optional: Environments where notifications are enabled (default: ['production', 'staging', 'development'])
   config.enabled_environments = ['production', 'staging', 'development']
 
-  # Optional: Current environment (default: Rails.env if available)
-  config.environment = 'production'
-
   # Optional: Custom error colors (default values shown below)
   config.error_color_map = {
     500 => 15158332, # Red
@@ -107,6 +118,12 @@ end
 The gem automatically includes error handling in your Rails controllers. No additional setup is required!
 
 ```ruby
+# For API applications
+class ApplicationController < ActionController::API
+  # Error handling is automatically included
+end
+
+# For regular Rails applications
 class ApplicationController < ActionController::Base
   # Error handling is automatically included
 end

data/lib/dislogger/configuration.rb

@@ -13,7 +13,7 @@ module Dislogger
       @discord_webhook_url = nil
       @bot_username = 'Error Logger'
       @backtrace_lines_limit = 5
-      @enabled_environments = %w[production staging]
+      @enabled_environments = %w[production staging development]
       @environment = nil
       @error_color_map = {
         500 => 15158332, # Red for server errors

data/lib/dislogger/error_handler.rb

@@ -7,16 +7,30 @@ module Dislogger
     extend ActiveSupport::Concern
 
     included do
-      rescue_from StandardError, with: :handle_internal_server_error
-      rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
-      rescue_from ActiveRecord::RecordInvalid, with: :handle_unprocessable_entity
-      rescue_from ActionController::ParameterMissing, with: :handle_unprocessable_entity
-      rescue_from Pundit::NotAuthorizedError, with: :handle_forbidden if defined?(Pundit)
-      rescue_from CanCan::AccessDenied, with: :handle_forbidden if defined?(CanCan)
+      if ancestors.include?(ActionController::API) || ancestors.include?(ActionController::Base)
+        rescue_from Exception, with: :handle_exception
+        rescue_from StandardError, with: :handle_internal_server_error
+        rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
+        rescue_from ActiveRecord::RecordInvalid, with: :handle_unprocessable_entity
+        rescue_from ActionController::ParameterMissing, with: :handle_unprocessable_entity
+        rescue_from Pundit::NotAuthorizedError, with: :handle_forbidden if defined?(Pundit)
+        rescue_from CanCan::AccessDenied, with: :handle_forbidden if defined?(CanCan)
+      end
     end
 
     private
 
+    def handle_exception(exception)
+      Rails.logger.error("Dislogger caught exception: #{exception.class.name} - #{exception.message}")
+      Rails.logger.error(exception.backtrace.join("\n")) if exception.backtrace
+
+      notify_and_render_error(
+        message: "#{exception.class.name}: #{exception.message}",
+        status: :internal_server_error,
+        backtrace: exception.backtrace
+      )
+    end
+
     def handle_not_found(exception)
       notify_and_render_error(
         message: exception.message.presence || 'Resource not found',
@@ -42,7 +56,7 @@ module Dislogger
 
     def handle_internal_server_error(exception)
       notify_and_render_error(
-        message: 'Internal Server Error',
+        message: exception.message || 'Internal Server Error',
         status: :internal_server_error,
         backtrace: exception.backtrace
       )
@@ -51,12 +65,15 @@ module Dislogger
     def notify_and_render_error(message:, status:, details: nil, backtrace: nil)
       status_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
 
-      Notifiers::DiscordNotifier.new.notify(
+      notifier = Notifiers::DiscordNotifier.new
+      notification_result = notifier.notify(
         message: message,
         status: status_code,
         backtrace: backtrace
       )
 
+      Rails.logger.info("Dislogger notification result: #{notification_result}") if defined?(Rails)
+
       render_error(message, status, details)
     end
 

data/lib/dislogger/notifiers/discord_notifier.rb

@@ -4,22 +4,21 @@ module Dislogger
   module Notifiers
     class DiscordNotifier < BaseNotifier
       def notify(message:, status:, backtrace: nil)
-        return unless enabled? && @config.discord_webhook_url.present?
+        return false unless enabled? && @config.discord_webhook_url.present?
 
+        log_info("Attempting to send Discord notification")
         formatted_message = format_message(message, status, backtrace)
         send_notification(formatted_message)
       rescue StandardError => e
-        if defined?(Rails) && Rails.logger
-          Rails.logger.error("Discord notification failed: #{e.message}")
-        else
-          warn("Discord notification failed: #{e.message}")
-        end
+        log_error("Discord notification failed: #{e.message}")
+        log_error(e.backtrace.join("\n")) if e.backtrace
         false
       end
 
       protected
 
       def format_message(message, status, backtrace)
+        log_info("Formatting Discord message")
         Formatters::DiscordFormatter.new(
           message: message,
           status: status,
@@ -29,6 +28,7 @@ module Dislogger
       end
 
       def send_notification(payload)
+        log_info("Sending notification to Discord")
         response = HTTParty.post(
           @config.discord_webhook_url,
           body: payload.to_json,
@@ -37,19 +37,40 @@ module Dislogger
         
         unless response.success?
           error_message = "Discord API Error: #{response.code} - #{response.body}"
-          if defined?(Rails) && Rails.logger
-            Rails.logger.error(error_message)
-          else
-            warn(error_message)
-          end
+          log_error(error_message)
           return false
         end
         
+        log_info("Discord notification sent successfully")
         true
+      rescue StandardError => e
+        log_error("Failed to send Discord notification: #{e.message}")
+        log_error(e.backtrace.join("\n")) if e.backtrace
+        false
       end
 
       def enabled?
-        @config.enabled?
+        result = @config.enabled?
+        log_info("Dislogger enabled? #{result} (environment: #{@config.environment}, enabled_environments: #{@config.enabled_environments})")
+        result
+      end
+
+      private
+
+      def log_info(message)
+        if defined?(Rails) && Rails.logger
+          Rails.logger.info("[Dislogger] #{message}")
+        else
+          puts "[Dislogger] #{message}"
+        end
+      end
+
+      def log_error(message)
+        if defined?(Rails) && Rails.logger
+          Rails.logger.error("[Dislogger] #{message}")
+        else
+          warn "[Dislogger] #{message}"
+        end
       end
     end
   end

data/lib/dislogger/railtie.rb

@@ -2,9 +2,23 @@
 
 module Dislogger
   class Railtie < Rails::Railtie
-    initializer 'dislogger.configure_rails_initialization' do
+    initializer 'dislogger.configure_rails_initialization' do |app|
+      # Configurar el ambiente por defecto si no está configurado
+      ActiveSupport.on_load(:before_configuration) do
+        Dislogger.configure do |config|
+          config.environment ||= Rails.env
+        end
+      end
+
+      # Incluir el ErrorHandler en los controladores
       ActiveSupport.on_load(:action_controller) do
-        ActionController::Base.include Dislogger::ErrorHandler
+        if defined?(ActionController::API)
+          ActionController::API.include(Dislogger::ErrorHandler)
+        end
+        
+        if defined?(ActionController::Base)
+          ActionController::Base.include(Dislogger::ErrorHandler)
+        end
       end
     end
   end

data/lib/dislogger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dislogger
-  VERSION = "0.1.6"
+  VERSION = "0.1.9"
 end

data/lib/generators/dislogger/install/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dislogger
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_initializer_file
+        template 'dislogger.rb', 'config/initializers/dislogger.rb'
+      end
+    end
+  end
+end 

data/lib/generators/dislogger/install/templates/dislogger.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Dislogger.configure do |config|
+  # Configura la URL del webhook de Discord (requerido)
+  config.discord_webhook_url = ENV['DISCORD_WEBHOOK_URL']
+
+  # Configura el ambiente actual (requerido)
+  config.environment = Rails.env
+
+  # Configura el nombre del bot (opcional, por defecto: 'Error Logger')
+  # config.bot_username = 'Mi App Error Logger'
+
+  # Configura el número de líneas del backtrace (opcional, por defecto: 5)
+  # config.backtrace_lines_limit = 10
+
+  # Configura los ambientes donde las notificaciones están habilitadas
+  # (opcional, por defecto: ['production', 'staging', 'development'])
+  # config.enabled_environments = ['production', 'staging', 'development']
+
+  # Configura los colores de los errores (opcional)
+  # config.error_color_map = {
+  #   500 => 15158332, # Rojo para errores del servidor
+  #   404 => 3447003,  # Azul para no encontrado
+  #   422 => 16776960, # Amarillo para errores de validación
+  #   403 => 15105570, # Naranja para prohibido
+  #   default: 10181046 # Gris para otros
+  # }
+end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dislogger
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.9
 platform: ruby
 authors:
 - Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -192,6 +192,8 @@ files:
 - lib/dislogger/notifiers/discord_notifier.rb
 - lib/dislogger/railtie.rb
 - lib/dislogger/version.rb
+- lib/generators/dislogger/install/install_generator.rb
+- lib/generators/dislogger/install/templates/dislogger.rb
 - sig/dislogger.rbs
 homepage: https://github.com/nduartex/dislogger
 licenses: