rails_api_guard 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff2c4a75442207f09d733b09cb7cbf2cfc81a8837be142485b5e9ca34ad0314e
-  data.tar.gz: 3fc2814cfd88a03b7230e780fa39fea656a7ea93fc757fca1900c32d5f7d9fe5
+  metadata.gz: 93890693de684b76c7ac78ed99e9d1ca804272c7cbf14b1c8087d5070ab2fcea
+  data.tar.gz: f4056a7057f5d56e26143ebf7d810d2d742090a2e920c4cf29a9b289bea96924
 SHA512:
-  metadata.gz: 9d3fdc1f9a02bc18d4f7c71050121b572d47c1d9bbed33067c559a821773323b5882ec5a8fac97ed20c6599dc8a1573896fc26a7884a5d1b06d0de73c3ada67a
-  data.tar.gz: eeb6d2a72fead98a52ad278ec089fafdb69897d9fb03f0f4097f56c729297dced6dc76a00a01cf6abd8b73b658852f46c2f632a89fd7d67b1a636c9e6a71e726
+  metadata.gz: a4b8acff3abc11669ad3d6ca6a1d35886e06f420f51f27822d6292e942b920b10faccfe4a365c15e337b410330283868876249b5909e5da9bcb8efd815efa95b
+  data.tar.gz: e6cab1599d4edcf9b013a89139e7bd398764ca5491d3d0d076742472de1414cbe0ee77514b4439077d4209d9ce6c078ad3c935005ffe3753b0156b6362adea41

data/README.md

@@ -1,19 +1,18 @@
 # RailsApiGuard
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+A pluggable, configurable rate limiting middleware for Rails APIs with Redis backend, Slack alerts, and endpoint exclusions.
+
+## 🚀 Installation
 
-## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "rails_api_guard"
+gem 'rails_api_guard'
 ```
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
@@ -21,8 +20,22 @@ Or install it yourself as:
 $ gem install rails_api_guard
 ```
 
+## Generate the Initializer
+```bash
+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.
+
 ## Contributing
-Contribution directions go here.
+Contribution directions are yet to add.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -0,0 +1,29 @@
+require "rails/generators"
+
+module RailsApiGuard
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a RailsApiGuard initializer file."
+
+      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/generators/install/templates/rails_api_guard_initializer.rb

@@ -0,0 +1,41 @@
+# config/initializers/rails_api_guard.rb
+
+# RailsApiGuard configuration initializer
+#
+# This file allows you to customize rate limiting behavior for your Rails API.
+# You can adjust request limits, expiry time, Slack notifications, and exclusion rules
+# for specific endpoints from rate limiting.
+#
+# You can safely add, remove, or modify these settings as per your application needs.
+
+RailsApiGuard.configure do |config|
+  # 🚦 Maximum number of allowed requests within the expiry_time window per IP (or per key)
+  config.limit = 5
+
+  # 🕒 Expiry time (in seconds) for the rate limiting window.
+  # After this time window passes, the request count for an IP or key resets.
+  config.expiry_time = 60
+
+  # 🔔 Slack webhook URL for sending alerts when a client exceeds the rate limit.
+  # Best practice: set this securely via environment variables.
+  config.slack_webhook_url = ENV['SLACK_WEBHOOK_URL']
+
+  # 🚫 List of endpoint patterns to be excluded from rate limiting.
+  #
+  # Supports:
+  # - Exact string paths (e.g. '/healthcheck')
+  # - Wildcard patterns (e.g. '/public/*')
+  # - Regular expressions (must start with '^', e.g. '^/user/\d+/document/\w+$')
+  #
+  # 👉 This list is **fully extendable** — feel free to add any additional paths
+  # or dynamic route patterns you want to bypass the rate limiter.
+  #
+  # Example:
+  # config.excluded_patterns << '/open-api/*'
+  #
+  config.excluded_patterns = [
+    '/healthcheck',
+    '/public/*',
+    '^/user/\\d+/document/\\w+$'
+  ]
+end

data/lib/rails_api_guard/version.rb

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

data/lib/rails_api_guard.rb

@@ -3,14 +3,17 @@ require "rails_api_guard/engine"
 require "rails_api_guard/middleware/rate_limiter"
 require "rails_api_guard/config"
 require "redis"
+require "rails_api_guard/generators/install/install_generator"
+
 
 module RailsApiGuard
   class << self
     attr_accessor :config
   end
 
+  self.config ||= Config.new
+
   def self.configure
-    self.config ||= Config.new
-    yield(config)
+    yield(config) if block_given?
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_guard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - sugat dhole
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-29 00:00:00.000000000 Z
+date: 2025-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,8 +80,9 @@ files:
 - config/routes.rb
 - lib/rails_api_guard.rb
 - lib/rails_api_guard/config.rb
-- lib/rails_api_guard/config_manager.rb
 - lib/rails_api_guard/engine.rb
+- lib/rails_api_guard/generators/install/install_generator.rb
+- lib/rails_api_guard/generators/install/templates/rails_api_guard_initializer.rb
 - lib/rails_api_guard/middleware/rate_limiter.rb
 - lib/rails_api_guard/services/exclusion_checker.rb
 - lib/rails_api_guard/services/rate_limit_store.rb
@@ -95,6 +96,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/sudo0809/rails_api_guard
   source_code_uri: https://github.com/sudo0809/rails_api_guard
+  changelog_uri: https://github.com/sudo0809/rails_api_guard/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -103,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rails_api_guard/config_manager.rb

@@ -1,39 +0,0 @@
-require "yaml"
-
-module RailsApiGuard
-  class ConfigManager
-    def self.excluded_patterns
-      config["excluded_patterns"] || []
-    end
-
-    def self.limit
-      config["limit"] || 5
-    end
-
-    def self.expiry_time
-      config["expiry_time"] || 60
-    end
-
-    def self.slack_webhook_url
-      config["slack_webhook_url"]
-    end
-
-    def self.config
-      @config ||= load_config
-    end
-
-    def self.load_config
-      config_file = Rails.root.join("config/rails_api_guard.yml")
-      unless File.exist?(config_file)
-        Rails.logger.warn "⚠️ Rails API Guard config file missing at #{config_file}"
-        return {}
-      end
-
-      YAML.load_file(config_file) || {}
-    end
-
-    def self.reload!
-      @config = load_config
-    end
-  end
-end