query_guard 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab42a4becef74dd106779b1e16f65f3e0178762531ede328212958cb36dbb2f5
-  data.tar.gz: e49b0e60d3ede416580c4e92e2f46142f3bbcc0c13da5ac9fde9024a001cccca
+  metadata.gz: 6bfc3581737fdfb115f1f3d59eaa678f061af78c561e0a03782eb019a46d4b3f
+  data.tar.gz: dc3e1b303ca6044f7e18af3fc2dbbd309f2bd4e1c7aa4c0751cedc89a08dc2c1
 SHA512:
-  metadata.gz: 756393f33c6e2c44650b377db916c3c516f5d49191ba9557461b8dfa9bcc8a977048fcf919b71c2ef101b0cb2bfe9f92fefe639ab88d28d01a09f9d565855046
-  data.tar.gz: 77f0b2337a0330922438eeb20ed1b946b0b0e1264622e577a4ad005cf7e9288efda5fafb34351d0691fa489cf2dc4f123c6ec8b1c9b4f413d1c5acf8fc770122
+  metadata.gz: 9bee2280297b23e229235ba461ec6c2c978a927e7dbb8f3c26270def1a5615b229948b50c483f2f9ac4c08c8546d96af1e355f8ae41acb032b52acaff7ef98c9
+  data.tar.gz: ddd6d8b867f91afbe91e941864e0d2a656c3442aed5d7a579702e969358e52b9a38d9667956d3640e57593a9f45dd16406892ceac19f1938f96c6bfe787ce6bf

data/README.md

@@ -8,3 +8,56 @@ Add to your Gemfile:
 
 ```ruby
 gem "query_guard"
+```
+
+## ⚙️ Configuration File
+
+To enable and configure `QueryGuard` in your Rails application,  
+you need to create an initializer file with the configuration options below.
+
+---
+
+### 1️⃣ Create the configuration file
+
+Run this command inside your Rails app:
+
+```bash
+touch config/initializers/query_guard.rb
+```
+
+### 2️⃣ Add the following code inside that file:
+
+```ruby
+# config/initializers/query_guard.rb
+
+# Configure QueryGuard settings
+QueryGuard.configure do |config|
+  # Environments where QueryGuard should be active
+  # By default: [:development, :test]
+  config.enabled_environments = %i[development test]
+
+  # Maximum number of SQL queries allowed per request
+  # Use nil to disable this limit
+  config.max_queries_per_request = 100
+
+  # Maximum duration (milliseconds) for a single SQL query
+  # Logs as a slow query if exceeded
+  config.max_duration_ms_per_query = 100.0
+
+  # Whether to flag or block SELECT * statements
+  config.block_select_star = true
+
+  # Ignore certain SQL patterns (e.g., schema and transaction queries)
+  config.ignored_sql = [
+    /^PRAGMA /i,  # SQLite schema queries
+    /^BEGIN/i,
+    /^COMMIT/i
+  ]
+
+  # Raise exception on violation instead of just logging
+  config.raise_on_violation = false
+
+  # Prefix for log messages in Rails logs
+  config.log_prefix = "[QueryGuard]"
+end
+```

data/lib/query_guard/config.rb

@@ -3,7 +3,8 @@ module QueryGuard
   class Config
     attr_accessor :enabled_environments, :max_queries_per_request,
                   :max_duration_ms_per_query, :block_select_star,
-                  :ignored_sql, :raise_on_violation, :log_prefix
+                  :ignored_sql, :raise_on_violation, :log_prefix,
+                  :base_url, :api_key, :project, :env
 
     def initialize
       @enabled_environments     = %i[development test]

data/lib/query_guard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QueryGuard
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/query_guard.rb

@@ -8,6 +8,8 @@ require "query_guard/middleware"
 
 module QueryGuard
   class << self
+    attr_accessor :client, :config
+
     def config
       @config ||= Config.new
     end
@@ -17,6 +19,17 @@ module QueryGuard
       self
     end
 
+    def configure
+      config ||= Config.new
+      yield(config)
+      client = Client.new(
+        base_url: config.base_url,
+        api_key:  config.api_key,
+        project:  config.project,
+        env:      config.env
+      )
+    end
+
     def install!(app = nil)
       # Install SQL subscriber once
       Subscriber.install!(config)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_guard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chitradevi36
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-11-02 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake