pg_rls 0.0.1 → 0.0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f0bd5f9878604a5f34c33b24221a9e7bb1efe25b526c825044dd7927f870f6
-  data.tar.gz: 1e51d31dccc7b7787921775f856d96cb630bf006fe5108df8fb65aba6560cf98
+  metadata.gz: 00bc08507823f0659023716267357992118618dd2d69536cf1936f7ffa903961
+  data.tar.gz: 499004adf0eb1db60bba0e1899a08cc943c64f0e90495016b0acf1a322520731
 SHA512:
-  metadata.gz: 86bafd3671e72de8a0f7fb84891c76530a28065dfb799b06de600bb0199a41cd8c22fed269e44076f79a05e2d874e63eeeb7f5728518d15ceddf89e6ff7bf824
-  data.tar.gz: f99445e75de533cb9ef7acfc5215c14ca78d629bd65cef1cb497f3adc1ae43f8689d46bcf7dcab8a5ac7684b79290630841ef33142434366800af9cf94e448d2
+  metadata.gz: e9ed07f6dfb3477c100eebc4afc2fd72fd639637fc200dd4ce6130e2cbdcb9fb3c6b9c4e5b3955397eb3bd08811542e0c96b954497110d148f048ef8f2583bed
+  data.tar.gz: 04d74bc577004804a4a5cb039f48dfb32b1bdc8b018aee47729202e6c58bfb7711698b789dfdb575ae715e50c4f78f5a36516841176169481b64bbeafd071dc1

data/README.md

@@ -4,28 +4,23 @@
 [![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</h1>
- <h2 align="center"> PostgreSQL Row Level Security </h2>
- <h1 align="center"></h1>
+ <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"><strong>Explore the docs »</strong></a>
+    <a href="https://github.com/Dandush03/pg_rls/wiki"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://dl-final-webapp.herokuapp.com/">View Live Demo</a>
-    ·
     <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>
-    ·
-    <a href="https://github.com/Dandush03/pg_rls">WebApp Repo</a>
   </p>
 
 </p>
@@ -34,6 +29,7 @@
 * [Required Installations](#required-Installations)
   * [Installing](#installing)
   * [Instructions](#instructions)
+  * [Testing](#Testing)
 * [Development](#testing)
 * [Contact](#contact)
 * [Contributing](#contributing)
@@ -41,9 +37,11 @@
 * [Code of Conduct](#Code-of-Conduct)
 * [Show your support](#Show-your-support)
 
-This gem will help you to integrate PostgreSQL RLS to help you develop an easy multitenancy application
+### 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 Installations
+## Required Installation
 ### Installing
 
 Add this line to your application's Gemfile:
@@ -56,31 +54,51 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself with:
 
     $ gem install pg_rls
 
 ### Instructions
 
 ```bash
-rails generate pg_rls:install company #=> where app eq tenant model name
+rails generate pg_rls:install company #=> where company eq tenant model name
 ```
-You can change company to anything you'd like like for example `tenant`
-this will generate the model and inject all the required code
+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 required to be under rls you can generate it by writing 
+For any new model that needs to be under rls, you can generate it by writing 
 
 ```bash
-rails generate pg_rls user #=> where app eq model name
+rails generate pg_rls user #=> where user eq model name
 ```
-and it will generate all the necesary information for you
+and it will generate all the necesary information for you.
 
-you can swtich tenant by using 
+You can swtich to another tenant by using 
 ```ruby
-PgRls::Tenant::switch :app #=> where app eq tenant name
+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:
+
+```ruby
+# spec/rails_helper.rb
 
-enjoy the gem :) 
+...
+# 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.
@@ -100,12 +118,16 @@ The gem is available as open source under the terms of the [MIT License](https:/
 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 soon will integrate slug/domain and cookies support 
+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
@@ -120,4 +142,7 @@ Give a ⭐️ if you like this project!
 [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,34 +11,86 @@ module PgRls
 
       source_root File.expand_path('./templates', __dir__)
 
-      def create_migration_file
-        migration_template migration_template_path, "#{migration_path}/#{file_sub_name}_#{table_name}.rb",
+      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, 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<%= PgRls.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

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

@@ -8,4 +8,5 @@ PgRls.setup do |config|
   # 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

@@ -9,9 +9,16 @@ module PgRls
           DROP ROLE IF EXISTS #{name};
           CREATE USER #{name} WITH PASSWORD '#{password}';
           GRANT ALL PRIVILEGES ON TABLE schema_migrations TO #{name};
+          GRANT USAGE ON SCHEMA public TO #{name};
           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
 

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

@@ -6,21 +6,19 @@ module PgRls
     class << self
       def switch(resource)
         connection_adapter = PgRls.connection_class
-        tenant = tenant_by_subdomain_uuid_or_tenant_id(resource)
+        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 e
+        puts @error || e
       end
 
-      def tenant
-        PgRls.class_name.to_s.camelize.constantize
-      end
+      attr_reader :tenant
 
       def fetch
-        tenant.find_by_tenant_id(
+        @fetch ||= tenant.find_by_tenant_id(
           PgRls.connection_class.connection.execute(
             "SELECT current_setting('rls.tenant_id')"
           ).getvalue(0, 0)
@@ -29,8 +27,14 @@ module PgRls
         'no tenant is selected'
       end
 
-      def tenant_by_subdomain_uuid_or_tenant_id(resource)
-        tenant.find_by_subdomain(resource) || tenant.find_by_id(resource) || tenant.find_by_tenant_id(resource)
+      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'
+  VERSION = '0.0.1.4'
 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,17 +12,18 @@ 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[table_name class_name].freeze
+    WRITER_METHODS = %i[table_name class_name search_methods].freeze
     READER_METHODS = %i[
-      connection_class database_configuration execute table_name class_name
+      connection_class database_configuration execute table_name class_name search_methods
     ].freeze
     DELEGATORS_METHODS = %i[
-      connection_class database_configuration execute table_name class_name
+      connection_class database_configuration execute table_name search_methods
+      class_name all_tenants main_model establish_default_connection
     ].freeze
 
     attr_writer(*WRITER_METHODS)
@@ -49,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)
@@ -68,4 +91,7 @@ module PgRls
 
   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
+  version: 0.0.1.4
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 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:
@@ -81,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       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.