pg_rls 0.0.1.1 → 0.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4adb2a4dc970c7945eea48bae37f3fe6153607ac61bfe69e5190a4f1b0d3996b
-  data.tar.gz: 6c223603207bb885e56b4e2340c0e737747418cfeca0fea9a0cda191385cc945
+  metadata.gz: d7e3e80029653fbeffba3ab6ab495273c5eabfe8a8f7ca2250b55d58621652d1
+  data.tar.gz: c789d0607cff7d73be8eba6205258b85dba70917a28093c800a70c7ca3846c39
 SHA512:
-  metadata.gz: 58a6a9f87ad417a3ce1783211afe6189fec242f7488cb238d9ec416c71b960eac7263b1c90cb6afa03460ab0b393d7af510e40b6d5d78484d4e56a89ba742982
-  data.tar.gz: bc5efaefc28e0b965ebeebc27151b96324399275f96a5ae473ea2336e220ff10f646490b35cbd3d7d5d92cefc55b88025502a8619bb32000ebb32bbbaefaf506
+  metadata.gz: c6c19274c02a6de2d07a48786b5bfbf80e7ba2107270b88930f212ab8c0798f1128be85e4f2d300cce8e6aff70b8978dd5e5ea6dc544f25b92faa1896cc8585d
+  data.tar.gz: 37be65bcfcc8af3cb23a4c5e6ed5cc761bba6225f1853de6f7692f5e895b74135dacf01984127a54a569966127c9ff79b8b66531aa05ca3bb724dac06ac3baa0

data/README.md

@@ -63,7 +63,7 @@ Or install it yourself with:
 ```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`
+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 
@@ -77,7 +77,7 @@ 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:
@@ -90,8 +90,10 @@ Many application uses some sort of database cleaner before running thair spec so
 
 config.before(:suite) do
   # Create A Default Tenant and Grant Test User Credentials
-  PgRls::Test::PreparedDatabase.grant_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
 

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/{test/prepared_database.rb → database/prepared.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module PgRls
-  module Test
+  module Database
     # Prepare database for test unit
-    module PreparedDatabase
+    module Prepared
       class << self
         def grant_user_credentials(name: PgRls::SECURE_USERNAME)
           return unless Rails.env.test?

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,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
 

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.1'
+  VERSION = '0.0.1.2'
 end

data/lib/pg_rls.rb

@@ -3,7 +3,7 @@
 require 'active_record'
 require 'forwardable'
 require_relative 'pg_rls/version'
-require_relative 'pg_rls/test/prepared_database'
+require_relative 'pg_rls/database/prepared'
 require_relative 'pg_rls/schema/statements'
 require_relative 'pg_rls/tenant'
 require_relative 'pg_rls/secure_connection'
@@ -17,12 +17,13 @@ module PgRls
   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)
@@ -50,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)
@@ -69,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.1
+  version: 0.0.1.2
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-30 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,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
@@ -57,18 +60,19 @@ 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
 - lib/pg_rls/schema/up_statements.rb
 - lib/pg_rls/secure_connection.rb
 - lib/pg_rls/tenant.rb
-- lib/pg_rls/test/prepared_database.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:
@@ -84,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.