pg_rls 0.0.1.alpha → 0.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ed56d6024c7658ebdf54879615273e29b9337f178b27a56352d2b3ba831b53d
-  data.tar.gz: 10ed3f8ae3350ef016a0138fcee0dfaa875c93f399ec3bca3a258f3f6f8d1639
+  metadata.gz: d7e3e80029653fbeffba3ab6ab495273c5eabfe8a8f7ca2250b55d58621652d1
+  data.tar.gz: c789d0607cff7d73be8eba6205258b85dba70917a28093c800a70c7ca3846c39
 SHA512:
-  metadata.gz: 7bc62b85e6065bcfd687de04809efffd295a47b66f9ef72afa8f236a7b2750888ebc55df8e8b371c674a879d18204338328c5684835ca6fb09bb2d6456985302
-  data.tar.gz: 28ab96d49303876ed85573439140695db0adf475f4b2f2253d99c5c99f6b2069eda679c10b87c9275bd7e40b8cd2c4981cf5e6614b61cb8417f9e9ec431b7c23
+  metadata.gz: c6c19274c02a6de2d07a48786b5bfbf80e7ba2107270b88930f212ab8c0798f1128be85e4f2d300cce8e6aff70b8978dd5e5ea6dc544f25b92faa1896cc8585d
+  data.tar.gz: 37be65bcfcc8af3cb23a4c5e6ed5cc761bba6225f1853de6f7692f5e895b74135dacf01984127a54a569966127c9ff79b8b66531aa05ca3bb724dac06ac3baa0

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable
+  Exclude:
+    - lib/generators/pg_rls/active_record/templates/migration.rb
 Layout/LineLength:
   Max: 120

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    pg_rls (0.0.1.alpha)
+    pg_rls (0.0.1)
+      bundler (>= 2.2.10)
 
 GEM
   remote: https://rubygems.org/
@@ -82,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)

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,14 +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.
+
+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
+
+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:
 
-TODO: Write usage instructions here
+```ruby
+# spec/rails_helper.rb
+
+...
+# some database cleaning strategy
 
+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.
@@ -32,7 +107,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pg_rls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pg_rls/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/dandush03/pg_rls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dandush03/pg_rls/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +115,34 @@ 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/[USERNAME]/pg_rls/blob/master/CODE_OF_CONDUCT.md).
+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/Rakefile

@@ -10,3 +10,12 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+desc 'Generate documentation for PgRls.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PgRls'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record/model/model_generator'
+require File.join(File.dirname(__FILE__), '../base')
+
+module PgRls
+  module Generators
+    # Active Record Generator
+    class ActiveRecordGenerator < ::ActiveRecord::Generators::ModelGenerator
+      include ::PgRls::Base
+
+      source_root File.expand_path('./templates', __dir__)
+
+      def check_class_collision; end
+
+      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, 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 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 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
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      def migration_path
+        db_migrate_path
+      end
+
+      protected
+
+      def migration_action() = 'add'
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= abstract_class_name %> < ApplicationRecord
+  self.abstract_class = true
+
+  connects_to database: { <%= ActiveRecord.writing_role %>: :<%= database -%> }
+end
+<% 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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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
+      t.string :logo
+
+      t.string :identification
+      t.string :subdomain
+      t.string :domain
+
+      t.timestamps
+    end
+
+    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 :<%= table_name %>
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= PgRls.class_name.camelize %> < <%= parent_class_name.classify %>
+  def self.current
+    PgRls::Tenant.fetch
+  end
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+<% end -%>
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+  has_rich_text :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachment?).each do |attribute| -%>
+  has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+  has_many_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+end
+<% end -%>

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class PgRlsCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def up
+    create_rls_table :<%= table_name %><%= primary_key_type %> do |t|
+      <% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+      <% end -%>
+
+      t.timestamps null: false
+    end
+  end
+
+  def down
+    drop_rls_table :<%= table_name %>
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+<% end -%>
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+  has_rich_text :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachment?).each do |attribute| -%>
+  has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+  has_many_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+end
+<% end -%>

data/lib/generators/pg_rls/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Main Definition for Generator
+  module Base
+    protected
+
+    def nested_parent_name
+      @class_path.join('/')
+    end
+
+    def nested_parent_id
+      "#{nested_parent_name}_id"
+    end
+
+    def nested_parent_class_name
+      nested_parent_name.classify
+    end
+
+    def plural_nested_parent_name
+      nested_parent_name.pluralize
+    end
+
+    def class_path
+      []
+    end
+
+    def regular_class_path
+      []
+    end
+
+    def controller_class_path
+      []
+    end
+  end
+end

data/lib/generators/pg_rls/install_generator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+require 'securerandom'
+
+module PgRls
+  module Generators
+    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.
+        Be sure to have an ORM like Active Record or loaded in your
+        app or configure your own at `config/application.rb`.
+          config.generators do |g|
+            g.orm :your_orm_gem
+          end
+        ERROR
+      end
+
+      def copy_initializer
+        raise MissingORMError, orm_error_message unless options[:orm]
+
+        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
+        return if aplication_record_already_included?
+
+        gsub_file(APPLICATION_RECORD_PATH, /(#{Regexp.escape(APPLICATION_RECORD_LINE)})/mi) do |match|
+          "#{match}\n  include PgRls::SecureConnection\n"
+        end
+      end
+
+      def inject_include_to_application_controller
+        return if aplication_controller_already_included?
+
+        gsub_file(APPLICATION_CONTROLLER_PATH, /(#{Regexp.escape(APPLICATION_CONTROLLER_LINE)})/mi) do |match|
+          "#{match}\n  include PgRls::MultiTenancy\n"
+        end
+      end
+
+      def aplication_controller_already_included?
+        File.readlines(APPLICATION_CONTROLLER_PATH).grep(/include PgRls::MultiTenancy/).any?
+      end
+
+      def aplication_record_already_included?
+        File.readlines(APPLICATION_RECORD_PATH).grep(/include PgRls::SecureConnection/).any?
+      end
+
+      def initialize_error_text
+        <<-ERROR.strip_heredoc
+        ERROR
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/pg_rls/pg_rls_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative File.join(File.dirname(__FILE__), 'active_record/active_record_generator')
+
+module PgRls
+  module Generators
+    class PgRlsGenerator < ::Rails::Generators::NamedBase
+      # override ModelGenerator
+      hook_for :orm, required: true
+    end
+  end
+end

data/lib/generators/pg_rls.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+require 'rails/generators/active_model'
+require 'rails/generators/active_record/migration'
+require 'active_record'
+
+module PgRls
+  module Generators # :nodoc:
+    class PgRlsGenerator < Rails::Generators::NamedBase # :nodoc:
+      include PgRls::Generators::Migration
+
+      # Set the current directory as base for the inherited generators.
+      def self.base_root
+        __dir__
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,19 @@
+README
+===============================================================================
+WARNING!!
+
+Once you remove a tenant all of his data would be removed as well
+
+PgRls::SecureConnection was included to your ApplicationRecord do not remove it
+
+===============================================================================
+
+to generate secure model run
+
+rails g pg_rls model_name
+
+or
+
+rails generate pg_rls model_name
+
+===============================================================================

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'pg_rls'
+
+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/multi_tenancy.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Ensure Connection is with App_use
+  module MultiTenancy
+    def self.included(base)
+      base.class_eval do
+        before_action :switch_tenant
+      end
+    end
+
+    private
+
+    def switch_tenant
+      Tenant.switch request.subdomain
+    rescue NoMethodError
+      redirect_to '/'
+    end
+  end
+end

data/lib/pg_rls/schema/down_statements.rb

@@ -4,8 +4,14 @@ module PgRls
   module Schema
     # Down Schema Statements
     module DownStatements
-      def drop_rls_user(name = :app_user)
-        ActiveRecord::Migration.execute "DROP USER #{name};"
+      def drop_rls_user
+        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
@@ -37,9 +43,9 @@ module PgRls
         SQL
       end
 
-      def drop_rls_policy(table_name, user = :app_user)
+      def drop_rls_policy(table_name)
         ActiveRecord::Migration.execute <<-SQL
-          DROP POLICY #{table_name}_#{user} ON #{table_name};
+          DROP POLICY #{table_name}_#{PgRls::SECURE_USERNAME} ON #{table_name};
           ALTER TABLE #{table_name} DISABLE ROW LEVEL SECURITY;
         SQL
       end

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

@@ -4,7 +4,7 @@ module PgRls
   module Schema
     # Up Schema Statements
     module UpStatements
-      def create_rls_user(name: :app_user, password: 'password')
+      def create_rls_user(name: PgRls::SECURE_USERNAME, password: 'password')
         PgRls.execute <<-SQL
           DROP ROLE IF EXISTS #{name};
           CREATE USER #{name} WITH PASSWORD '#{password}';
@@ -12,6 +12,9 @@ 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};
         SQL
       end
 
@@ -64,14 +67,14 @@ 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
 
-      def create_rls_policy(table_name, user = :app_user)
+      def create_rls_policy(table_name, user = PgRls::SECURE_USERNAME)
         ActiveRecord::Migration.execute <<-SQL
           ALTER TABLE #{table_name} ENABLE ROW LEVEL SECURITY;
           CREATE POLICY #{table_name}_#{user}

data/lib/pg_rls/secure_connection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Ensure Connection is with App_use
+  module SecureConnection
+    def self.included(base)
+      base.class_eval do
+        after_initialize :establish_secure_connection
+      end
+    end
+
+    private
+
+    def establish_secure_connection
+      return if PgRls.default_connection?
+
+      return if secure_connection_established?
+
+      PgRls.establish_new_connection
+    end
+
+    def secure_connection_established?
+      PgRls.current_connection_username == PgRls::SECURE_USERNAME
+    end
+  end
+end

data/lib/pg_rls/tenant.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PgRls
+  # Tenant Controller
+  module Tenant
+    class << self
+      def switch(resource)
+        connection_adapter = PgRls.connection_class
+        find_tenant(resource)
+        connection_adapter.connection.execute(format('SET rls.tenant_id = %s',
+                                                     connection_adapter.connection.quote(tenant.tenant_id)))
+        "RLS changed to '#{tenant.name}'"
+      rescue StandardError => e
+        puts 'connection was not made'
+        puts @error || e
+      end
+
+      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
+end

data/lib/pg_rls/version.rb

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

data/lib/pg_rls.rb

@@ -3,19 +3,28 @@
 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/tenant'
+require_relative 'pg_rls/tenant'
+require_relative 'pg_rls/secure_connection'
+require_relative 'pg_rls/multi_tenancy'
 
 # PostgreSQL Row Level Security
 module PgRls
   class Error < StandardError; end
+  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)
@@ -38,18 +47,51 @@ module PgRls
 
     def establish_new_connection
       connection_class.establish_connection(
-        connection_class.connection_config.dup.tap { |n| n[:username] = 'app_user' }
+        **database_configuration
       )
     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
+      connection_class.connection_db_config.configuration_hash[:username]
+    end
+
     def execute(query)
       @execute = ActiveRecord::Migration.execute(query)
     end
 
     def database_configuration
       @database_configuration ||= database_connection_file[Rails.env].tap do |config|
-        config['username'] = 'app_user'
+        config['username'] = PgRls::SECURE_USERNAME
       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,16 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: pg_rls
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1.2
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
-dependencies: []
-description: Write a longer description or delete this line.
+date: 2022-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+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: []
@@ -28,16 +44,35 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- 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
+- lib/generators/pg_rls/active_record/templates/model.rb.tt
+- lib/generators/pg_rls/base.rb
+- lib/generators/pg_rls/install_generator.rb
+- lib/generators/pg_rls/pg_rls_generator.rb
+- 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
 - lib/pg_rls/schema/up_statements.rb
-- lib/pg_rls/tenant/tenant.rb
+- lib/pg_rls/secure_connection.rb
+- lib/pg_rls/tenant.rb
 - lib/pg_rls/version.rb
 homepage: https://github.com/Dandush03/pg_rls
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -49,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.

data/lib/pg_rls/tenant/tenant.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module PgRls
-  # Tenant Controller
-  module Tenant
-    class << self
-      SET_COMPANY_ID_SQL = 'SET rls.tenant_id = %s'
-      def switch(resource)
-        connection_adapter = PgRls.establish_new_connection
-        tenant = tenant_by_subdomain_uuid_or_tenant_id(resource)
-        connection_adapter.connection.execute(format('SET rls.tenant_id = %s', connection_adapter.connection.quote(tenant.tenant_id)))
-        puts "connected to #{resource}"
-      rescue StandardError => e
-        puts 'connection was not made'
-        puts 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)
-      end
-    end
-  end
-end