rails_api_guard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae35863b762ee8926c2893c07c25d9a714041d0663db67af7a99a7b4a3a00cd5
+  data.tar.gz: 05fc95bdf98f4d3e0fce584cb8207e984278ffb38c884eea60e6ccd8916a699e
+SHA512:
+  metadata.gz: 7251b195ef84cce364ab0cd6b6b492a9bbd46369c62a024c91315c80932f53a994512fc5e79e52e97dc1c5b51bade97a1b673b635b109aa2ac5d8f9ca1d018d9
+  data.tar.gz: e54bf900c2047aa6a0817e000f30ba2ff45d9ff830c7c03fd80a77e9ff1f30462f899bb8b29d514a60e078db325670321486b9d8a427896cb8ec8da1dc969c6c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright sugat dhole
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# RailsApiGuard
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_api_guard"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_api_guard
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/rails_api_guard_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/rails_api_guard .css

data/app/assets/stylesheets/rails_api_guard/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_api_guard/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsApiGuard
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_api_guard/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsApiGuard
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_api_guard/application_job.rb

@@ -0,0 +1,4 @@
+module RailsApiGuard
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_api_guard/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsApiGuard
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/rails_api_guard/application_record.rb

@@ -0,0 +1,5 @@
+module RailsApiGuard
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/rails_api_guard/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails api guard</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "rails_api_guard/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RailsApiGuard::Engine.routes.draw do
+end

data/lib/rails_api_guard/config.rb

@@ -0,0 +1,12 @@
+module RailsApiGuard
+    class Config
+        attr_accessor :excluded_patterns, :limit, :expiry_time, :slack_webhook_url
+
+        def initialize
+            @excluded_patterns = []
+            @limit = 5 
+            @expiry_time = 60 # in seconds
+            @slack_webhook_url = nil
+        end
+    end
+end

data/lib/rails_api_guard/config_manager.rb

@@ -0,0 +1,39 @@
+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

data/lib/rails_api_guard/engine.rb

@@ -0,0 +1,7 @@
+module RailsApiGuard
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsApiGuard
+
+    config.eager_load_paths << root.join("lib")
+  end
+end

data/lib/rails_api_guard/middleware/rate_limiter.rb

@@ -0,0 +1,43 @@
+module RailsApiGuard
+    module Middleware
+        class RateLimiter
+            def initialize(app)
+                @app = app
+                @limit = RailsApiGuard.config.limit
+                @expiry_time = RailsApiGuard.config.expiry_time
+                @rate_limit_store = Services::RateLimitStore.new(@limit, @expiry_time)
+            end
+
+            def call(env)
+                request = Rack::Request.new(env)
+                
+                if Services::ExclusionChecker.excluded_endpoint?(request.path)
+                    Rails.logger.info "Skipping rate limiting for #{request.path}"
+                    return @app.call(env)
+                end
+               
+                ip = request.ip
+                
+                
+                if @rate_limit_store.increment_and_check(ip, request.path)
+                    Rails.logger.info "Rate limiting exceeded!!!"
+                    Services::SlackNotifier.notify("🚨 Rate limit exceeded for #{ip}!")
+                    return too_many_requests
+                end
+
+
+                @app.call(env)
+            end
+            
+            private
+
+            def too_many_requests
+                [
+                    429,
+                    { "Content-Type" => "application/json" },
+                    [{ error: "Rate limit exceeded" }.to_json]
+                  ]
+            end
+        end
+    end
+end

data/lib/rails_api_guard/services/exclusion_checker.rb

@@ -0,0 +1,17 @@
+module RailsApiGuard
+    module Services
+        class ExclusionChecker
+            def self.excluded_endpoint?(path)
+                return true if path.start_with?('/.well-known')
+
+                RailsApiGuard.config.excluded_patterns.any? do |pattern|
+                    if pattern.start_with?("^")
+                        Regexp.new(pattern).match?(path)
+                    else
+                        File.fnmatch?(pattern, path)
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/rails_api_guard/services/rate_limit_store.rb

@@ -0,0 +1,24 @@
+module RailsApiGuard
+    module Services
+        class RateLimitStore
+            def initialize(limit, expiry_time)
+                @limit = limit
+                @expiry_time = expiry_time
+                @redis = RedisClient.instance
+            end
+
+            def increment_and_check(ip, path)
+                key = "rate_limiter::#{ip}::#{path}"
+                current_count = @redis.get(key).to_i
+
+                if current_count == 0
+                    @redis.setex(key, @expiry_time, 0)
+                end
+
+                @redis.incr(key)
+
+                current_count + 1 > @limit
+            end
+        end
+    end
+end

data/lib/rails_api_guard/services/redis_client.rb

@@ -0,0 +1,9 @@
+module RailsApiGuard
+    module Services
+        class RedisClient
+            def self.instance
+                @instance ||= Redis.new
+            end
+        end
+    end
+end

data/lib/rails_api_guard/services/slack_notifier.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+
+module RailsApiGuard
+    module Services
+        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' })
+            end
+        end
+    end
+end

data/lib/rails_api_guard/version.rb

@@ -0,0 +1,3 @@
+module RailsApiGuard
+  VERSION = "0.1.0"
+end

data/lib/rails_api_guard.rb

@@ -0,0 +1,16 @@
+require "rails_api_guard/version"
+require "rails_api_guard/engine"
+require "rails_api_guard/middleware/rate_limiter"
+require "rails_api_guard/config"
+require "redis"
+
+module RailsApiGuard
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+end

data/lib/tasks/rails_api_guard_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_api_guard do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_guard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sugat dhole
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plug-and-play API rate limiter with per-user/per-plan configs, Redis
+  backend, Slack alerts and admin dashboard.
+email:
+- sugatdhole@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/rails_api_guard_manifest.js
+- app/assets/stylesheets/rails_api_guard/application.css
+- app/controllers/rails_api_guard/application_controller.rb
+- app/helpers/rails_api_guard/application_helper.rb
+- app/jobs/rails_api_guard/application_job.rb
+- app/mailers/rails_api_guard/application_mailer.rb
+- app/models/rails_api_guard/application_record.rb
+- app/views/layouts/rails_api_guard/application.html.erb
+- 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/middleware/rate_limiter.rb
+- lib/rails_api_guard/services/exclusion_checker.rb
+- lib/rails_api_guard/services/rate_limit_store.rb
+- lib/rails_api_guard/services/redis_client.rb
+- lib/rails_api_guard/services/slack_notifier.rb
+- lib/rails_api_guard/version.rb
+- lib/tasks/rails_api_guard_tasks.rake
+homepage: https://github.com/sudo0809/rails_api_guard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sudo0809/rails_api_guard
+  source_code_uri: https://github.com/sudo0809/rails_api_guard
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: API rate limiter middleware engine for Rails APIs.
+test_files: []