dislogger 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f02d278c361c1316f47a29bedad900e03183f2f40e750656cf200d01d80f66
-  data.tar.gz: 2d78928ccb2740d8eca3a15fc81e5cc0168c2730511417b2ece3167a9f973f18
+  metadata.gz: 0b7ddd219546d4b47916d9e0cfd1303679ed1a3f4befa6675a7be486ada7de25
+  data.tar.gz: '001685aeefc4f82fd7a07f8a539ea9c737de5a1760eebdc0799660ea62c4087d'
 SHA512:
-  metadata.gz: 519c66523ab2f57d73f85cd06cbda35ceef6e7ae359164d45df6c2b1b30aadfe5e6828c5aa344c7862b6a89cea8807b46905b9c01bc1e135fc1da7d53a677519
-  data.tar.gz: 429ebbb1a4ee2faf591092e3cd532a519fc65d47f7a26a51a397298a31e2651dd766b4e0fdbd7cb06df689ba59a5d188f087d4b59a8c1502bd72508a40acf1ca
+  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

@@ -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/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.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.6
+  version: 0.1.8
 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: