multi-tenant-support 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1519c4812629d4b3e66708ab8aaffca8925fe23cc75924e55d57a010dbd71022
-  data.tar.gz: 8de09d069ac3d0cb813b513fd77948e481682d4cef114f6054ab9c6089ea0df1
+  metadata.gz: d7761ff1721fab8904557ae7af54aca1875d19fb6076bbe5038493c945009eec
+  data.tar.gz: 43df41f9e15014829828918d4703e77fe6f321bad2f10495e103860abe57cbbf
 SHA512:
-  metadata.gz: 1dd7e70f8992e1bb9675e0e5dc4136a6395012b241eab4b022db02e3066d092449af6b69bd6532190d9c40de419d6784f3620c9b193bdbf3372f25ec32d11cc1
-  data.tar.gz: 1f5ab147795036d550935a3a12ba301a8c54905a3b61b154580401dbd1b9d832edc799ceeaa20d38eecea2086ccc6ccd36d65c6997e88ba6fe2fc8ef41d7a9ca
+  metadata.gz: 7103aec88b69d628baed7e783495cc5e06b8fe49f5751d40aa5e676f2586aa7a0fcfe4d4f6015bfa4409017e533a3fff3a71b945d5426feb2ba5d7ba177f1ede
+  data.tar.gz: f2e5c63298eee511690622da0d0c47bf0fcdeb80aff543704da2a2a7a047165d5d6eebfda3d44862003329fcc739a3d8278d3ffb7616667087d540c7f9e49006

data/README.md

@@ -11,7 +11,7 @@ Keep your data secure with multi-tenant-support. Prevent most ActiveRecord CRUD
 - Prevent most ActiveRecord CRUD methods from acting across tenants.
 - Support Row-level Multitenancy
 - Build on ActiveSupport::CurrentAttributes offered by rails
-- Auto set current tenant through subdomain and domain in controller
+- Auto set current tenant through subdomain and domain in controller (overrideable)
 - Support ActiveJob and Sidekiq
 
 
@@ -219,7 +219,7 @@ Below are the behaviour of all ActiveRecord CRUD methods under abvove scenarios:
 
 ## Usage
 
-#### Get current 
+### Get current 
 
 Get current tenant through:
 
@@ -227,7 +227,7 @@ Get current tenant through:
 MultiTenantSupport.current_tenant
 ```
 
-#### Switch tenant
+### Switch tenant
 
 You can switch to another tenant temporary through:
 
@@ -237,7 +237,7 @@ MultiTenantSupport.under_tenant amazon do
 end
 ```
 
-#### Disallow read across tenant by default
+### Disallow read across tenant by default
 
 This gem disallow read across tenant by default. You can check current state through:
 
@@ -245,7 +245,7 @@ This gem disallow read across tenant by default. You can check current state thr
 MultiTenantSupport.disallow_read_across_tenant?
 ```
 
-#### Allow read across tenant for super admin
+### Allow read across tenant for super admin
 
 You can turn on the permission to read records across tenant through: 
 
@@ -260,7 +260,7 @@ end
 
 You can put it in a before action in SuperAdmin's controllers
 
-#### Disallow modify records tenant
+### Disallow modify records tenant
 
 This gem disallow modify record across tenant no matter you are super admin or not.
 
@@ -274,23 +274,41 @@ If `MultiTenantSupport.current_tenant` exist, you can only modify those records
 
 If `MultiTenantSupport.current_tenant` is missing, you cannot modify or create any tenanted records.
 
-#### Set current tenant acccount in controller by default
+### Set current tenant acccount in controller by default
 
 This gem has set a before action `set_current_tenant_account` on ActionController. It search tenant by subdomain or domain. Do remember to `skip_before_action :set_current_tenant_account` in super admin controllers.
 
 Feel free to override it, if the finder behaviour is not what you want.
 
-#### upsert_all
+### Override current tenant finder method if domain/subdomain is not the way you want
+
+You can override `find_current_tenant_account` in any controller with your own tenant finding strategy. Just make sure this method return the tenat account record or nil.
+
+For example, say you only want to find tenant with domain not subdomain. It's very simple:
+
+```ruby
+class ApplicationController < ActionController::Base
+  private
+
+  def find_current_tenant_account
+    Account.find_by(domain: request.domain)
+  end
+end
+```
+
+Then your tenant finding strategy has changed from domain/subdomain to domain only.
+
+### upsert_all
 
 Currently, we don't have a good way to protect this method. So please use `upser_all` carefully.
 
-#### Unscoped
+### Unscoped
 
 This gem has override `unscoped` to prevent the default tenant scope be scoped out. But if you really want to scope out the default tenant scope, you can use `unscope_tenant`.
 
 ## Code Example
 
-#### Database Schema
+### Database Schema
 
 ```ruby
 create_table "accounts", force: :cascade do |t|

data/lib/multi_tenant_support/concern/controller_concern.rb

@@ -15,12 +15,17 @@ module MultiTenantSupport
       end
 
       def set_current_tenant_account
-        tenant_account = MultiTenantSupport::FindTenantAccount.call(
+        tenant_account = find_current_tenant_account
+        MultiTenantSupport::Current.tenant_account = tenant_account
+        instance_variable_set("@#{MultiTenantSupport.current_tenant_account_method}", tenant_account)
+      end
+
+      # A user can override this method, if he need a customize way
+      def find_current_tenant_account
+        MultiTenantSupport::FindTenantAccount.call(
           subdomains: request.subdomains,
           domain: request.domain
         )
-        MultiTenantSupport::Current.tenant_account = tenant_account
-        instance_variable_set("@#{MultiTenantSupport.current_tenant_account_method}", tenant_account)
       end
     end
   end

data/lib/multi_tenant_support/version.rb

@@ -1,3 +1,3 @@
 module MultiTenantSupport
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi-tenant-support
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Hopper Gee