pg_rls 0.0.1.beta → 0.0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff1edae4e2b864b6d1c50dbe73330ddd3092314fc0f0654ce631dd3f2381e73
-  data.tar.gz: f61c086a2319def269009a8acd4bb712457913cb23703d4f592486c1adc76161
+  metadata.gz: 54636ddf6a708016930a9f737f9a45b9cc13c157bc4adef11e6bb11d72d9490c
+  data.tar.gz: 9a8185e0f13e3f021850372c6a4faf44b0c7c4f331eebbeb65e280aefc88812c
 SHA512:
-  metadata.gz: 88eaa010df64b8ba78630841f3ac886c44dca7929e43016e2dcbe6b4000a06ad41d0606e94fe7457eb3c46fe0e3c341d2208bf6b5fd64553fcd9eedbaee59c7a
-  data.tar.gz: 70aef5056d562fb96a2189d580f3b3cc31b1efb4ef71433969f8896268cdf0286bc5450b9b855166e48580d12aed451d0771c672611c3a934f7f046be2ea8dc9
+  metadata.gz: 6fc47ebe73cf24b6a8171442d971e3f255e46036af47ba8db4d8127639b321ca2f464be096adc320a2c3405157effdea56c4c7969969dbdf0633179257718ebc
+  data.tar.gz: 1c317ccb4d8aea566f8f334309aa0ed785f1256ad450c4b97f484efdf79b75d3269e259404dd7a379225ac40803f93981c277211f40438d30810bf22142fad83

data/Gemfile

@@ -13,5 +13,3 @@ gem 'rake'
 gem 'rspec'
 
 gem 'rubocop'
-
-gem 'rspec-rails'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg_rls (0.0.1.alpha)
+    pg_rls (0.0.1)
       bundler (>= 2.2.10)
 
 GEM
@@ -83,7 +83,7 @@ GEM
       mini_mime (>= 0.1.1)
     marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.1)
+    mini_mime (1.1.2)
     minitest (5.14.4)
     nio4r (2.5.8)
     nokogiri (1.12.5-x86_64-linux)
@@ -137,14 +137,6 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (5.0.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      railties (>= 5.2)
-      rspec-core (~> 3.10)
-      rspec-expectations (~> 3.10)
-      rspec-mocks (~> 3.10)
-      rspec-support (~> 3.10)
     rspec-support (3.10.2)
     rubocop (1.22.1)
       parallel (~> 1.10)
@@ -182,7 +174,6 @@ DEPENDENCIES
   rails (~> 6.1.4, >= 6.1.4.1)
   rake
   rspec
-  rspec-rails
   rubocop
 
 RUBY VERSION

data/README.md

@@ -1,10 +1,48 @@
-# PgRls
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pg_rls`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![LinkedIn][linkedin-shield2]][linkedin-url2]
+[![Hireable][hireable]][hireable-url]
+[![Donate][donate]][paypal-donate-code]
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+ <h1 align="center">PgRls<h2 align="center">PostgreSQL Row Level Security<br />The Rails right way to do multitenancy</h2></h1>
+
+  <p align="center">
+    <br />
+    <a href="https://github.com/Dandush03/pg_rls/wiki"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/Dandush03/pg_rls/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/Dandush03/pg_rls/issues">Request Feature</a>
+    ·
+    <a href="https://github.com/Dandush03/pg_rls">API Repo</a>
+  </p>
+
+</p>
+
+### Table of Contents
+* [Required Installations](#required-Installations)
+  * [Installing](#installing)
+  * [Instructions](#instructions)
+  * [Testing](#Testing)
+* [Development](#testing)
+* [Contact](#contact)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#Code-of-Conduct)
+* [Show your support](#Show-your-support)
+
+### It's time we start doing multitenancy right! You can avoid creating a separate Postgres schema/databases for each customer or trying to ensure the WHERE clause of every single query includes the particular company. Just integrate PgRls seamlessly to your application.
+
+### This gem will integrate PostgreSQL RLS to help you develop a great multitenancy application.
+
+## Required Installation
+### Installing
 
 Add this line to your application's Gemfile:
 
@@ -16,23 +54,51 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install pg_rls
 
-## Usage
+### Instructions
+
+```bash
+rails generate pg_rls:install company #=> where company eq tenant model name
+```
+You can change company to anything you'd like, for example, `tenant`
+This will generate the model and inject all the required code
+
+For any new model that needs to be under rls, you can generate it by writing 
+
+```bash
+rails generate pg_rls user #=> where user eq model name
+```
+and it will generate all the necesary information for you.
 
-RUN `rails generate pg_rls:install company`
+You can swtich to another tenant by using 
+```ruby
+PgRls::Tenant.switch :app #=> where app eq tenant name
+```
+Don't forget to update how you want `PgRls` to find your tenant, you can set multiple options by modifying `api/config/initializers/pg_rls.rb` `search_methods`  
+### Testing
 
-You can change company to anything you'd like like for example `tenant`
-this will generate the model and inject all the required code
+Many application uses some sort of database cleaner before running thair spec so on each test that we run we'll have an empty state. Usually, those gems clear our user configuration for the database. To solve this issue, we must implement the following:
 
-for any new model that required to be under rls you can generate it by writing 
+```ruby
+# spec/rails_helper.rb
 
-`rails generate pg_rls user`
-and it will generate all the necesary information for you
+...
+# some database cleaning strategy
 
-enjoy the gem :) 
+config.before(:suite) do
+  # Create A Default Tenant and Grant Test User Credentials
+  PgRls::Database::Prepared.grant_user_credentials
+  # Create the tenant which in this example is company and we are using FactoryBot
+  FactoryBot.create(:company, subdomain: 'app')
+  # In this default case our initializer is set to search by subdomain so will use it
+  PgRls::Tenant.switch :app
+end
+
+...
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -50,3 +116,33 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the PgRls project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dandush03/pg_rls/blob/master/CODE_OF_CONDUCT.md).
+
+## Note
+Currently we only support subdomain as a searcher but will soon integrate slug/domain and cookies support 
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+
+If this project help you reduce time to develop, you can give me a cup of coffee :)
+
+[![paypal][paypal-url]][paypal-donate-code]
+
+<!-- MARKDOWN LINKS & IMAGES -->
+[contributors-shield]: https://img.shields.io/github/contributors/Dandush03/React-Calculator.svg?style=flat-square
+[contributors-url]: https://github.com/Dandush03/pg_rls/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/Dandush03/pg_rls.svg?style=flat-square
+[forks-url]: https://github.com/Dandush03/pg_rls/network/members
+[stars-shield]: https://img.shields.io/github/stars/Dandush03/pg_rls.svg?style=flat-square
+[stars-url]: https://github.com/Dandush03/pg_rls/stargazers
+[issues-shield]: https://img.shields.io/github/issues/Dandush03/pg_rls.svg?style=flat-square
+[issues-url]: https://github.com/Dandush03/pg_rls/issues
+[license-shield]: https://img.shields.io/github/license/Dandush03/pg_rls.svg?style=flat-square
+[license-url]: https://github.com/Dandush03/pg_rls/blob/master/LICENSE.txt
+[linkedin-shield2]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
+[linkedin-url2]: https://www.linkedin.com/in/daniel-laloush/
+[hireable]: https://cdn.rawgit.com/hiendv/hireable/master/styles/flat/yes.svg
+[paypal-url]: https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif
+[paypal-donate-code]: https://www.paypal.com/donate?hosted_button_id=QKZFZAMQNC8JL
+[hireable-url]: https://www.linkedin.com/in/daniel-laloush/
+[donate]: https://img.shields.io/badge/Donate-PayPal-blue.svg

data/lib/generators/pg_rls/active_record/active_record_generator.rb

@@ -11,36 +11,86 @@ module PgRls
 
       source_root File.expand_path('./templates', __dir__)
 
-      hook_for :test_framework
+      def check_class_collision; end
 
-      def create_migration_file
-        migration_template migration_template_path, "#{migration_path}/#{file_sub_name}_#{table_name}.rb",
+      def create_migration_file; end
+
+      def migration_exist?
+        @migration_exist ||= Dir.glob("#{migration_path}/*create_#{table_name}.rb").present?
+      end
+
+      def create_tenant_migration_file
+        return if migration_exist?
+
+        migration_template create_migration_template_path,
+                           "#{migration_path}/#{create_file_sub_name}_#{table_name}.rb",
+                           migration_version: migration_version
+      end
+
+      def convert_tenant_migration_file
+        return unless migration_exist?
+
+        migration_template convert_migration_template_path,
+                           "#{migration_path}/#{convert_file_sub_name}_#{table_name}.rb",
+                           migration_version: migration_version
+
+        return if installation_in_progress?
+
+        migration_template 'convert_migration_backport.rb.tt',
+                           "#{migration_path}/pg_rls_backport_#{table_name}.rb",
                            migration_version: migration_version
       end
 
       def create_model_file
+        return if migration_exist?
+
         generate_abstract_class if database && !parent
-        template model_template_path, File.join('app/models', class_path, "#{file_name}.rb")
+
+        template model_template_path, model_file
+      end
+
+      def inject_method_to_model
+        return unless installation_in_progress?
+
+        gsub_file(model_file, /Class #{class_name} < #{parent_class_name.classify}/mi) do |match|
+          "#{match}\n  def self.current\n    PgRls::Tenant.fetch\n  end\n"
+        end
+      end
+
+      def model_file
+        File.join('app/models', class_path, "#{file_name}.rb")
       end
 
-      def migration_template_path
+      def create_migration_template_path
         return 'init_migration.rb.tt' if installation_in_progress?
 
         'migration.rb.tt'
       end
 
+      def convert_migration_template_path
+        return 'init_convert_migration.rb.tt' if installation_in_progress?
+
+        'convert_migration.rb.tt'
+      end
+
       def model_template_path
         return 'init_model.rb.tt' if installation_in_progress?
 
         'model.rb.tt'
       end
 
-      def file_sub_name
-        return 'pg_rls_tenant_create' if installation_in_progress?
+      def create_file_sub_name
+        return 'pg_rls_create_tenant' if installation_in_progress?
 
         'pg_rls_create'
       end
 
+      def convert_file_sub_name
+        return 'pg_rls_convert_tenant' if installation_in_progress?
+
+        'pg_rls_convert'
+      end
+
       def installation_in_progress?
         shell.base.class.name.include?('Install')
       end

data/lib/generators/pg_rls/active_record/templates/convert_migration.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class PgRlsConvert<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+    convert_to_rls_table :<%= table_name %>
+  end
+
+  def down
+    revert_rls_table :<%= table_name %>
+  end
+end

data/lib/generators/pg_rls/active_record/templates/convert_migration_backport.rb.tt

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class PgRlsBackport<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+    PgRls.establish_default_connection
+
+    # Suggested Code:
+    # PgRls.all_tenants do |tenant|
+    #   tenant.<%= table_name %>.in_batches(of: 100) do |<%= table_name %>|
+    #     <%= table_name %>.each { |<%= table_name.singularize %>| <%= table_name.singularize %>.update_attribute('tenant_id', tenant.tenant_id) }
+    #   end
+    # end
+  end
+end

data/lib/generators/pg_rls/active_record/templates/init_convert_migration.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class PgRlsConvertTenant<%= PgRls.table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+    convert_to_rls_tenant_table :<%= table_name %>
+  end
+
+  def down
+    revert_rls_tenant_table :<%= table_name %>
+  end
+end

data/lib/generators/pg_rls/active_record/templates/init_migration.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PgRlsTenantCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+class PgRlsCreateTenant<%= PgRls.table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def up
     create_rls_tenant_table :<%= table_name %>, id: :uuid do |t|
       t.string :name
@@ -13,13 +13,13 @@ class PgRlsTenantCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= m
       t.timestamps
     end
 
-    add_index :companies, :name,            unique: true
-    add_index :companies, :identification,  unique: true
-    add_index :companies, :domain,          unique: true
-    add_index :companies, :subdomain,       unique: true
+    add_index :<%= table_name %>, :name,            unique: true
+    add_index :<%= table_name %>, :identification,  unique: true
+    add_index :<%= table_name %>, :domain,          unique: true
+    add_index :<%= table_name %>, :subdomain,       unique: true
   end
 
   def down
-    drop_rls_tenant_table :companies
+    drop_rls_tenant_table :<%= table_name %>
   end
 end

data/lib/generators/pg_rls/active_record/templates/init_model.rb.tt

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %> < <%= parent_class_name.classify %>
+class <%= PgRls.class_name.camelize %> < <%= parent_class_name.classify %>
   def self.current
-    find_by_tenant_id(connection.execute("SELECT current_setting('rls.tenant_id')").getvalue(0, 0))
-  rescue ActiveRecord::StatementInvalid
-    'no tenant is selected'
+    PgRls::Tenant.fetch
   end
 <% attributes.select(&:reference?).each do |attribute| -%>
   belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>

data/lib/generators/pg_rls/install_generator.rb

@@ -8,14 +8,25 @@ module PgRls
     MissingORMError = Class.new(Thor::Error)
     # Installer Generator
     class InstallGenerator < Rails::Generators::Base
+      def initialize(*args)
+        tenant_model_or_table = args.first
+        if tenant_model_or_table.present?
+          PgRls.table_name = tenant_model_or_table.first.pluralize
+          PgRls.class_name = tenant_model_or_table.first.singularize
+        end
+        super
+      end
       APPLICATION_RECORD_LINE = 'class ApplicationRecord < ActiveRecord::Base'
       APPLICATION_RECORD_PATH = 'app/models/application_record.rb'
       APPLICATION_CONTROLLER_LINE = 'class ApplicationController < ActionController::Base'
       APPLICATION_CONTROLLER_PATH = 'app/controllers/application_controller.rb'
+
       source_root File.expand_path('../templates', __dir__)
 
       desc 'Creates a PgRls initializer and copy locale files to your application.'
 
+      hook_for :orm, required: true
+
       def orm_error_message
         <<-ERROR.strip_heredoc
         An ORM must be set to install PgRls in your application.
@@ -30,10 +41,9 @@ module PgRls
       def copy_initializer
         raise MissingORMError, orm_error_message unless options[:orm]
 
-        template 'pg_rls.rb.tt', 'config/initializers/pg_rls.rb'
-
         inject_include_to_application_record
         inject_include_to_application_controller
+        template 'pg_rls.rb.tt', 'config/initializers/pg_rls.rb'
       end
 
       def inject_include_to_application_record
@@ -68,8 +78,6 @@ module PgRls
       def show_readme
         readme 'README' if behavior == :invoke
       end
-
-      hook_for :orm, required: true
     end
   end
 end

data/lib/generators/templates/pg_rls.rb.tt

@@ -2,6 +2,11 @@
 
 require 'pg_rls'
 
-PgRls.setup do |_config|
+PgRls.setup do |config|
   ActiveRecord::ConnectionAdapters::AbstractAdapter.include PgRls::Schema::Statements
+
+  # Do not remove this value after initialization
+  config.class_name = :<%= PgRls.class_name %>
+  config.table_name = :<%= PgRls.table_name %>
+  config.search_methods = <%= PgRls.search_methods %>
 end

data/lib/pg_rls/database/prepared.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PgRls
+  module Database
+    # Prepare database for test unit
+    module Prepared
+      class << self
+        def grant_user_credentials(name: PgRls::SECURE_USERNAME)
+          return unless Rails.env.test?
+
+          PgRls.execute <<-SQL
+            GRANT USAGE, SELECT
+              ON ALL SEQUENCES IN SCHEMA public
+                TO #{name};
+            GRANT SELECT, INSERT, UPDATE, DELETE
+              ON ALL TABLES IN SCHEMA public
+                TO #{name};
+          SQL
+        end
+      end
+    end
+  end
+end

data/lib/pg_rls/schema/down_statements.rb

@@ -5,7 +5,13 @@ module PgRls
     # Down Schema Statements
     module DownStatements
       def drop_rls_user
-        ActiveRecord::Migration.execute "DROP USER #{PgRls::SECURE_USERNAME};"
+        ActiveRecord::Migration.execute <<~SQL
+          DROP OWNED BY #{PgRls::SECURE_USERNAME};
+          REVOKE ALL PRIVILEGES ON ALL TABLES IN SCHEMA public FROM #{PgRls::SECURE_USERNAME};
+          REVOKE ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public FROM #{PgRls::SECURE_USERNAME};
+          REVOKE ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA public FROM #{PgRls::SECURE_USERNAME};
+          DROP USER #{PgRls::SECURE_USERNAME};
+        SQL
       end
 
       def drop_rls_blocking_function

data/lib/pg_rls/schema/statements.rb

@@ -27,11 +27,11 @@ module PgRls
       end
 
       def drop_rls_tenant_table(table_name)
-        drop_rls_user
         drop_rls_setter_function
         detach_blocking_function(table_name)
         drop_table(table_name)
         drop_rls_blocking_function
+        drop_rls_user
       end
 
       def drop_rls_table(table_name)
@@ -39,6 +39,34 @@ module PgRls
         drop_rls_policy(table_name)
         drop_table(table_name)
       end
+
+      def convert_to_rls_tenant_table(table_name, **_options)
+        create_rls_user(password: PgRls.database_configuration['password'])
+        create_rls_setter_function
+        create_rls_blocking_function
+        add_rls_column_to_tenant_table(table_name)
+        append_blocking_function(table_name)
+      end
+
+      def revert_rls_tenant_table(table_name)
+        drop_rls_setter_function
+        detach_blocking_function(table_name)
+        drop_rls_blocking_function
+        drop_rls_user
+        drop_rls_column(table_name)
+      end
+
+      def convert_to_rls_table(table_name)
+        add_rls_column(table_name)
+        create_rls_policy(table_name)
+        append_trigger_function(table_name)
+      end
+
+      def revert_rls_table(table_name)
+        detach_trigger_function(table_name)
+        drop_rls_policy(table_name)
+        drop_rls_column(table_name)
+      end
     end
   end
 end

data/lib/pg_rls/schema/up_statements.rb

@@ -12,6 +12,12 @@ module PgRls
           ALTER DEFAULT PRIVILEGES IN SCHEMA public
             GRANT SELECT, INSERT, UPDATE, DELETE
             ON TABLES TO #{name};
+          GRANT SELECT, INSERT, UPDATE, DELETE
+            ON ALL TABLES IN SCHEMA public
+            TO #{name};
+          GRANT USAGE, SELECT
+            ON ALL SEQUENCES IN SCHEMA public
+            TO #{name};
         SQL
       end
 
@@ -64,9 +70,9 @@ module PgRls
         ActiveRecord::Migration.execute <<-SQL
           ALTER TABLE #{table_name}
             ADD COLUMN IF NOT EXISTS tenant_id uuid,
-            ADD CONSTRAINT fk_companies
+            ADD CONSTRAINT fk_#{PgRls.table_name}
               FOREIGN KEY (tenant_id)
-              REFERENCES companies(tenant_id)
+              REFERENCES #{PgRls.table_name}(tenant_id)
               ON DELETE CASCADE;
         SQL
       end

data/lib/pg_rls/secure_connection.rb

@@ -12,6 +12,8 @@ module PgRls
     private
 
     def establish_secure_connection
+      return if PgRls.default_connection?
+
       return if secure_connection_established?
 
       PgRls.establish_new_connection

data/lib/pg_rls/tenant.rb

@@ -4,20 +4,37 @@ module PgRls
   # Tenant Controller
   module Tenant
     class << self
-      SET_COMPANY_ID_SQL = 'SET rls.tenant_id = %s'
       def switch(resource)
         connection_adapter = PgRls.connection_class
-        tenant = tenant_by_subdomain_uuid_or_tenant_id(resource)
-        connection_adapter.connection.execute(format(SET_COMPANY_ID_SQL,
+        find_tenant(resource)
+        connection_adapter.connection.execute(format('SET rls.tenant_id = %s',
                                                      connection_adapter.connection.quote(tenant.tenant_id)))
-        "RLS changed to '#{tenant}'"
+        "RLS changed to '#{tenant.name}'"
       rescue StandardError => e
         puts 'connection was not made'
-        puts e
+        puts @error || e
       end
 
-      def tenant_by_subdomain_uuid_or_tenant_id(resource)
-        Company.find_by_subdomain(resource) || Company.find_by_id(resource) || Company.find_by_tenant_id(resource)
+      attr_reader :tenant
+
+      def fetch
+        @fetch ||= tenant.find_by_tenant_id(
+          PgRls.connection_class.connection.execute(
+            "SELECT current_setting('rls.tenant_id')"
+          ).getvalue(0, 0)
+        )
+      rescue ActiveRecord::StatementInvalid
+        'no tenant is selected'
+      end
+
+      def find_tenant(resource)
+        @tenant = nil
+
+        PgRls.search_methods.each do |method|
+          @tenant ||= PgRls.main_model.send("find_by_#{method}", resource)
+        rescue NoMethodError => e
+          @error = e
+        end
       end
     end
   end

data/lib/pg_rls/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgRls
-  VERSION = '0.0.1.beta'
+  VERSION = '0.0.1.3'
 end

data/lib/pg_rls.rb

@@ -3,6 +3,7 @@
 require 'active_record'
 require 'forwardable'
 require_relative 'pg_rls/version'
+require_relative 'pg_rls/database/prepared'
 require_relative 'pg_rls/schema/statements'
 require_relative 'pg_rls/tenant'
 require_relative 'pg_rls/secure_connection'
@@ -11,14 +12,19 @@ require_relative 'pg_rls/multi_tenancy'
 # PostgreSQL Row Level Security
 module PgRls
   class Error < StandardError; end
-  SECURE_USERNAME = 'app_user'
+  SECURE_USERNAME = "#{Rails.env}_app_user".freeze
 
   class << self
     extend Forwardable
 
-    WRITER_METHODS = %i[].freeze
-    READER_METHODS = %i[connection_class database_configuration execute].freeze
-    DELEGATORS_METHODS = %i[connection_class database_configuration execute].freeze
+    WRITER_METHODS = %i[table_name class_name search_methods].freeze
+    READER_METHODS = %i[
+      connection_class database_configuration execute table_name class_name search_methods
+    ].freeze
+    DELEGATORS_METHODS = %i[
+      connection_class database_configuration execute table_name search_methods
+      class_name all_tenants main_model establish_default_connection
+    ].freeze
 
     attr_writer(*WRITER_METHODS)
     attr_reader(*READER_METHODS)
@@ -45,8 +51,29 @@ module PgRls
       )
     end
 
+    def establish_default_connection
+      @default_connection = true
+    end
+
+    def default_connection?
+      @default_connection
+    end
+
+    def main_model
+      class_name.to_s.camelize.constantize
+    end
+
+    def all_tenants
+      main_model.all.each do |tenant|
+        allowed_search_fields = search_methods.map(&:to_s).intersection(main_model.column_names)
+        Tenant.switch tenant.send(allowed_search_fields.first)
+
+        yield(tenant) if block_given?
+      end
+    end
+
     def current_connection_username
-      PgRls.connection_class.connection_db_config.configuration_hash[:username]
+      connection_class.connection_db_config.configuration_hash[:username]
     end
 
     def execute(query)
@@ -59,4 +86,12 @@ module PgRls
       end
     end
   end
+  mattr_accessor :table_name
+  @@table_name = 'companies'
+
+  mattr_accessor :class_name
+  @@class_name = 'Company'
+
+  mattr_accessor :search_methods
+  @@search_methods = %i[subdomain id tenant_id]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_rls
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta
+  version: 0.0.1.3
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +24,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.10
-description: Write a longer description or delete this line.
+description: |2
+      This gem will help you to integrate PostgreSQL RLS to help you develop a great multitenancy application
+      checkout the repository at https://github.com/Dandush03/pg_rls
 email:
 - daniel.laloush@influitive.com
 executables: []
@@ -45,6 +47,9 @@ files:
 - lib/generators/pg_rls.rb
 - lib/generators/pg_rls/active_record/active_record_generator.rb
 - lib/generators/pg_rls/active_record/templates/abstract_base_class.rb.tt
+- lib/generators/pg_rls/active_record/templates/convert_migration.rb.tt
+- lib/generators/pg_rls/active_record/templates/convert_migration_backport.rb.tt
+- lib/generators/pg_rls/active_record/templates/init_convert_migration.rb.tt
 - lib/generators/pg_rls/active_record/templates/init_migration.rb.tt
 - lib/generators/pg_rls/active_record/templates/init_model.rb.tt
 - lib/generators/pg_rls/active_record/templates/migration.rb.tt
@@ -55,6 +60,7 @@ files:
 - lib/generators/templates/README
 - lib/generators/templates/pg_rls.rb.tt
 - lib/pg_rls.rb
+- lib/pg_rls/database/prepared.rb
 - lib/pg_rls/multi_tenancy.rb
 - lib/pg_rls/schema/down_statements.rb
 - lib/pg_rls/schema/statements.rb
@@ -65,7 +71,8 @@ files:
 homepage: https://github.com/Dandush03/pg_rls
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -77,11 +84,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.