rails_api_guard 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b4d8d394e924a76d3aa00b2fdb2fdf782747545d8ffc2542506bc854ea6a65
-  data.tar.gz: 9dfa228e433502c43df3e0ed50348af2581c73cfa7376d88e1a491310ca8eac5
+  metadata.gz: 113eca3b940fb42eb59e46207a1389447a14b1c8e664397bcf2e48060bc87c49
+  data.tar.gz: 7ed64fb43fcf0f8225dc0e0a237c35f6b5720e1b0686126d27381766ada440f2
 SHA512:
-  metadata.gz: dc940368929aa36574ff9fac9326eaf2c2d6a104c42081491bf0552857becbfb5ae9dbe51f2fc63f518f5ad771e59f63ac3ed1c0b8f37fdf20c91de17ca06906
-  data.tar.gz: 94144edae5b36b29d9319d152a1d80b95d524f9e66e9b22d8880805baf74f692e6645cf051e352442a4b698698d7056011d9a0263cafaeed502d75e5c3977791
+  metadata.gz: c5736712e78258a58be184b20bf67628c943c3005649f0a0bc3917c8f416e29b4c4b57cddf5266895bd5073aff91375d2fbbfad25159b58b5fe8cce3f854c97d
+  data.tar.gz: 40e092d2d0ca2471179055399df4fea4e38fddb751ffccb6bd51c0063e77e19b2f065deec319e2e2d45c54f5695465726a6d56de09e4952df0d37c489c100224

data/README.md

@@ -25,9 +25,29 @@ $ gem install rails_api_guard
 rails generate rails_api_guard:install
 ```
 
+## Middleware
+Add this to application.rb if not used generator
+```ruby
+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/generators/install/install_generator.rb

@@ -10,6 +10,20 @@ module RailsApiGuard
       def copy_initializer
         template "rails_api_guard_initializer.rb", "config/initializers/rails_api_guard.rb"
       end
+
+      def add_middleware
+        application_file = 'config/application.rb'
+        middleware_pattern = /config\.middleware\.use RailsApiGuard::Middleware::RateLimiter/
+        middleware_line = "\t\t# Added by RailsApiGuard gem to apply API rate limiting middleware\n"
+        middleware_line += "\t\tconfig.middleware.use RailsApiGuard::Middleware::RateLimiter\n"
+
+        if File.readlines(application_file).grep(/config\.middleware\.use RailsApiGuard::Middleware::RateLimiter/).any?
+          say_status :skipped, "Middleware already added to #{application_file}", :yellow
+        else
+          insert_into_file application_file, "\n\n#{middleware_line}", after: "class Application < Rails::Application"
+          say_status :added, "Middleware added to #{application_file}", :green
+        end
+      end
     end
   end
 end

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.0"
+  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.0
+  version: 0.2.2
 platform: ruby
 authors:
 - sugat dhole
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-29 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails