dislogger 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68999016d4bdfa0436b75a70149e7a6f4b9643a4f2277fcf6a720a324dcfebbf
-  data.tar.gz: 66ea5ef0d7e5bbfa17016aefe4da05e701219b5ea8bdc0731e145e693ab0c310
+  metadata.gz: 0b7ddd219546d4b47916d9e0cfd1303679ed1a3f4befa6675a7be486ada7de25
+  data.tar.gz: '001685aeefc4f82fd7a07f8a539ea9c737de5a1760eebdc0799660ea62c4087d'
 SHA512:
-  metadata.gz: d5b3dbb2aaa1aa967abbd49aa1a4e66a85cf7d76406d54bb47f9d29f3efca8a493915153045e4203ad93f90556693bbc2073fd708c656289b6158848c82d4fc2
-  data.tar.gz: 67affcd9886734dee1ef2913d6efe5d4b800f506c84ba3087dde657155504c8a04e3bac209379bcf152e2fa8bf416ae3d47a572e5f83f471db385ee40e7ce07a
+  metadata.gz: 40495b36577cce4bb00ea8ab38b74019b4792e2ca6452c1edd735f4042557403ab382bb70b08f94e4fb952b7e5240c1828057a5068f76aad4c1da5ba6be1fc41
+  data.tar.gz: 2d90483f3e1db1969355be2565384cde9f38f7048e5dd4f7573203a47bb814f3ba45bf11554bf9e0dd71c4751e0d7fcece7d547664afa8f2959bc98fbdba0eb9

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

@@ -11,10 +11,10 @@ module Dislogger
 
     def initialize
       @discord_webhook_url = nil
-      @environment = 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
         404 => 3447003,  # Blue for not found
@@ -24,6 +24,14 @@ module Dislogger
       }
     end
 
+    def validate!
+      raise Errors::ConfigurationError, 'Discord webhook URL is required' unless discord_webhook_url.present?
+      raise Errors::ConfigurationError, 'Bot username is required' unless bot_username.present?
+      raise Errors::ConfigurationError, 'Enabled environments must be an array' unless enabled_environments.is_a?(Array)
+      raise Errors::ConfigurationError, 'Environment must be present' unless environment.present?
+      true
+    end
+
     def enabled?
       return false if environment.nil? || enabled_environments.empty?
       enabled_environments.include?(environment)

data/lib/dislogger/formatters/discord_formatter.rb

@@ -8,11 +8,11 @@ module Dislogger
           username: @config.bot_username,
           embeds: [
             {
-              title: "#{@config.environment.capitalize} - Error Notification (#{@status})",
-              description: @message,
-              color: @config.error_color_map[@status] || @config.error_color_map[:default],
+              title: format_title,
+              description: format_description,
+              color: get_error_color,
               fields: build_fields,
-              timestamp: Time.current.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+              timestamp: Time.current.utc.iso8601
             }
           ]
         }
@@ -20,22 +20,46 @@ module Dislogger
 
       private
 
+      def format_title
+        "#{@config.environment.capitalize} - Error Notification (#{@status})"
+      end
+
+      def format_description
+        return @message if @message.is_a?(String)
+        return @message.message if @message.respond_to?(:message)
+        @message.to_s
+      end
+
+      def get_error_color
+        @config.error_color_map[@status] || @config.error_color_map[:default]
+      end
+
       def build_fields
         fields = [
           { name: 'Status Code', value: @status.to_s, inline: true },
           { name: 'Environment', value: @config.environment, inline: true }
         ]
 
-        if @backtrace
+        if @backtrace && !@backtrace.empty?
           fields << {
             name: 'Backtrace',
-            value: @backtrace.first(@config.backtrace_lines_limit).join("\n"),
+            value: format_backtrace(@backtrace),
             inline: false
           }
         end
 
         fields
       end
+
+      def format_backtrace(backtrace)
+        return 'No backtrace available' if backtrace.nil? || backtrace.empty?
+        
+        trace = backtrace.first(@config.backtrace_lines_limit)
+        if trace.length >= @config.backtrace_lines_limit
+          trace << "... (truncated)"
+        end
+        trace.join("\n")
+      end
     end
   end
 end 

data/lib/dislogger/notifiers/discord_notifier.rb

@@ -8,6 +8,13 @@ module Dislogger
 
         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
+        false
       end
 
       protected
@@ -22,17 +29,27 @@ module Dislogger
       end
 
       def send_notification(payload)
-        HTTParty.post(
+        response = HTTParty.post(
           @config.discord_webhook_url,
           body: payload.to_json,
           headers: { 'Content-Type' => 'application/json' }
         )
-      rescue StandardError => e
-        if defined?(Rails) && Rails.logger
-          Rails.logger.error("Discord notification failed: #{e.message}")
-        else
-          warn("Discord notification failed: #{e.message}")
+        
+        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
+          return false
         end
+        
+        true
+      end
+
+      def enabled?
+        @config.enabled?
       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.4"
+  VERSION = "0.1.8"
 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.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-17 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: