rails_api_guard 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93890693de684b76c7ac78ed99e9d1ca804272c7cbf14b1c8087d5070ab2fcea
-  data.tar.gz: f4056a7057f5d56e26143ebf7d810d2d742090a2e920c4cf29a9b289bea96924
+  metadata.gz: 113eca3b940fb42eb59e46207a1389447a14b1c8e664397bcf2e48060bc87c49
+  data.tar.gz: 7ed64fb43fcf0f8225dc0e0a237c35f6b5720e1b0686126d27381766ada440f2
 SHA512:
-  metadata.gz: a4b8acff3abc11669ad3d6ca6a1d35886e06f420f51f27822d6292e942b920b10faccfe4a365c15e337b410330283868876249b5909e5da9bcb8efd815efa95b
-  data.tar.gz: e6cab1599d4edcf9b013a89139e7bd398764ca5491d3d0d076742472de1414cbe0ee77514b4439077d4209d9ce6c078ad3c935005ffe3753b0156b6362adea41
+  metadata.gz: c5736712e78258a58be184b20bf67628c943c3005649f0a0bc3917c8f416e29b4c4b57cddf5266895bd5073aff91375d2fbbfad25159b58b5fe8cce3f854c97d
+  data.tar.gz: 40e092d2d0ca2471179055399df4fea4e38fddb751ffccb6bd51c0063e77e19b2f065deec319e2e2d45c54f5695465726a6d56de09e4952df0d37c489c100224

data/README.md

@@ -34,6 +34,20 @@ config.middleware.use RailsApiGuard::Middleware::RateLimiter
 ## Configuration
 Edit `config/initializers/rails_api_guard.rb` to set request limits, expiry time, Slack alerts, and excluded endpoint patterns.
 
+## Slack Notifications
+
+RailsApiGuard can optionally send Slack alerts whenever a request exceeds the defined rate limit threshold.
+
+### Configuration
+
+To enable Slack alerts, set your Slack webhook URL in the initializer:
+
+```ruby
+# config/initializers/rails_api_guard.rb
+RailsApiGuard.configure do |config|
+  config.slack_webhook_url = ENV["SLACK_WEBHOOK_URL"]
+end
+
 ## Contributing
 Contribution directions are yet to add.
 

data/lib/rails_api_guard/services/slack_notifier.rb

@@ -5,11 +5,22 @@ module RailsApiGuard
         class SlackNotifier
             def self.notify(message)
                 webhook_url = RailsApiGuard.config.slack_webhook_url
-                return unless webhook_url.present?
-        
-                payload = { text: message }
-        
-                HTTParty.post(webhook_url, body: payload.to_json, headers: { 'Content-Type' => 'application/json' })
+
+                if webhook_url.nil?
+                    Rails.logger.warn 'no Slack webhook URl configured'
+                    Rails.logger.warn "Message : #{message}"
+                    return
+                end
+
+                response = HTTParty.post(
+                    webhook_url,
+                    body: { text: message }.to_json,
+                    headers: { 'Content-Type' => 'application/json' }
+                )
+
+                unless rails.success?
+                    Rails.logger.error "Failed to send Slack alert: #{response.code} - #{response.body}"
+                end
             end
         end
     end

data/lib/rails_api_guard/version.rb

@@ -1,3 +1,3 @@
 module RailsApiGuard
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_guard
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - sugat dhole
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-30 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails