rls_multi_tenant 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b602ae00548e9668dd3ba466c9e3feeed720c6a36aba8a6b4b592324b68670'
-  data.tar.gz: 3e45ea738d6b55461cd35c6c280a8a34f624cf5c47fc3de466b03d39a38a320b
+  metadata.gz: 50eff8f3ced091cac7b277aff79cfd435a0ce0701ee2ca3ca7163d57e6792406
+  data.tar.gz: 7739392cf8b866e5d6e86ccebeeccb3a3e913b7efbccf89a4441d79dfbc93f84
 SHA512:
-  metadata.gz: 4b4415ff08af022593ad64afe9f2c1d929af6be70ce1663ba9531a5d366624e9157cd87a794ccf580721416ad77e3f3e4e1d11c0e43a2e492527a837cd0762db
-  data.tar.gz: e382dca5401c09de4a9287f75db4e3e8a91326450ba98295f2f2fb320b574032b70260a3dbc7908450c1d22fa6a095db63f213a02cb08dab72b633b5890cbf34
+  metadata.gz: a8c6c0d9323251de3b6bc8321cb8bae781ae8248ea37dd9cf643aa7e4e0441234c42084d7391dcd73d4735e20080c27025969359e5dfe1c9f0bea0d30e5aa34d
+  data.tar.gz: 7788deda9e7deb6c49e7fd9359cfb06e648044c48d78ac9e1823b3cf91eb0deff90db6d95e94f2433adc726b0d6fd924b822958cab0c7882da0667d7af606def

data/README.md

@@ -99,6 +99,7 @@ bundle install
       config.enable_security_validation = true      # Enable security checks (prevents running with superuser privileges)
       config.enable_subdomain_middleware = true     # Enable subdomain-based tenant switching (default: true)
       config.subdomain_field = :subdomain           # Field to use for subdomain matching (default: :subdomain)
+      config.excluded_subdomains = ['www']          # Subdomains to exclude from tenant lookup (default: ['www'])
     end
     ```
 3. **Setup the tenant model and migrations:**
@@ -172,6 +173,27 @@ tenant2 = Tenant.create!(name: "Company B", subdomain: "company-b")
 # Users visiting yourdomain.com (no subdomain) will have no tenant context
 ```
 
+**Excluded Subdomains:**
+
+You can configure subdomains that should be excluded from tenant lookup and treated as public access (no tenant context). By default, `www` is excluded.
+
+```ruby
+RlsMultiTenant.configure do |config|
+  # Exclude multiple subdomains from tenant lookup
+  config.excluded_subdomains = ['www', 'admin', 'api']
+end
+```
+
+When a request comes from an excluded subdomain (e.g., `www.yourdomain.com`), the middleware will:
+- Skip tenant lookup
+- Treat the request as public access (no tenant context)
+- Not raise an error for missing tenant
+
+This is useful for:
+- Main website access (`www`)
+- Admin panels that shouldn't be tenant-scoped
+- API endpoints that need public access
+
 ### Public Access (Non-Tenanted Models)
 
 Models that don't include `RlsMultiTenant::Concerns::TenantContext` are automatically treated as public models and can be accessed without tenant context. This provides a secure, explicit way to separate tenant-specific and public models.

data/lib/rls_multi_tenant/generators/install/templates/rls_multi_tenant.rb

@@ -16,4 +16,9 @@ RlsMultiTenant.configure do |config|
   # Configure the field to use for subdomain matching (default: :subdomain)
   # This should be a field on your tenant model that contains the subdomain
   config.subdomain_field = :subdomain
+
+  # Configure excluded subdomains (default: ['www'])
+  # Subdomains in this list will be treated as if they were nil (public access)
+  # Example: ['www', 'admin', 'api'] - these subdomains won't trigger tenant lookup
+  config.excluded_subdomains = ['www']
 end

data/lib/rls_multi_tenant/middleware/subdomain_tenant_selector.rb

@@ -30,7 +30,7 @@ module RlsMultiTenant
       def handle_no_tenant_request(env, request)
         subdomain = extract_subdomain(request.host)
 
-        if subdomain.present? && subdomain != 'www'
+        if subdomain.present? && !excluded_subdomain?(subdomain)
           handle_missing_tenant_error(request, subdomain)
         else
           handle_public_access(request)
@@ -64,7 +64,7 @@ module RlsMultiTenant
 
       def resolve_tenant_from_subdomain(request)
         subdomain = extract_subdomain(request.host)
-        return nil if subdomain.blank? || subdomain == 'www'
+        return nil if subdomain.blank? || excluded_subdomain?(subdomain)
 
         # Look up tenant by subdomain only
         tenant_class = RlsMultiTenant.tenant_class
@@ -101,6 +101,13 @@ module RlsMultiTenant
       def ip_host?(host)
         !/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/.match(host).nil?
       end
+
+      def excluded_subdomain?(subdomain)
+        return false if subdomain.blank?
+        
+        excluded = RlsMultiTenant.excluded_subdomains
+        excluded.is_a?(Array) && excluded.include?(subdomain.to_s.downcase)
+      end
     end
   end
 end

data/lib/rls_multi_tenant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RlsMultiTenant
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/lib/rls_multi_tenant.rb

@@ -17,7 +17,7 @@ module RlsMultiTenant
   # Configuration options
   class << self
     attr_writer :tenant_class_name, :tenant_id_column, :enable_security_validation, :enable_subdomain_middleware,
-                :subdomain_field
+                :subdomain_field, :excluded_subdomains
 
     def configure
       yield self
@@ -46,6 +46,10 @@ module RlsMultiTenant
     def subdomain_field
       @subdomain_field ||= :subdomain
     end
+
+    def excluded_subdomains
+      @excluded_subdomains ||= ['www']
+    end
   end
 
   # Default configuration
@@ -54,4 +58,5 @@ module RlsMultiTenant
   self.enable_security_validation = true
   self.enable_subdomain_middleware = true
   self.subdomain_field = :subdomain
+  self.excluded_subdomains = ['www']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rls_multi_tenant
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Coding Ways
@@ -177,7 +177,6 @@ files:
 - lib/rls_multi_tenant/middleware/subdomain_tenant_selector.rb
 - lib/rls_multi_tenant/railtie.rb
 - lib/rls_multi_tenant/rls_helper.rb
-- lib/rls_multi_tenant/rls_multi_tenant.rb
 - lib/rls_multi_tenant/security_validator.rb
 - lib/rls_multi_tenant/version.rb
 - rls_multi_tenant.gemspec

data/lib/rls_multi_tenant/rls_multi_tenant.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'rls_multi_tenant/version'
-require 'rls_multi_tenant/concerns/multi_tenant'
-require 'rls_multi_tenant/concerns/tenant_context'
-require 'rls_multi_tenant/security_validator'
-require 'rls_multi_tenant/rls_helper'
-require 'rls_multi_tenant/railtie' if defined?(Rails)
-
-module RlsMultiTenant
-  class Error < StandardError; end
-  class ConfigurationError < Error; end
-  class SecurityError < Error; end
-
-  # Configuration options
-  class << self
-    attr_writer :tenant_class_name, :tenant_id_column, :enable_security_validation, :enable_subdomain_middleware,
-                :subdomain_field
-
-    def configure
-      yield self
-    end
-
-    def tenant_class_name
-      @tenant_class_name ||= 'Tenant'
-    end
-
-    def tenant_class
-      @tenant_class ||= tenant_class_name.constantize
-    end
-
-    def tenant_id_column
-      @tenant_id_column ||= :tenant_id
-    end
-
-    def enable_security_validation
-      @enable_security_validation.nil? || @enable_security_validation
-    end
-
-    def enable_subdomain_middleware
-      @enable_subdomain_middleware.nil? ? false : @enable_subdomain_middleware
-    end
-
-    def subdomain_field
-      @subdomain_field ||= :subdomain
-    end
-  end
-
-  # Default configuration
-  self.tenant_class_name = 'Tenant'
-  self.tenant_id_column = :tenant_id
-  self.enable_security_validation = true
-  self.enable_subdomain_middleware = true
-  self.subdomain_field = :subdomain
-end