pg_rls 0.0.1.4 → 0.0.1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00bc08507823f0659023716267357992118618dd2d69536cf1936f7ffa903961
-  data.tar.gz: 499004adf0eb1db60bba0e1899a08cc943c64f0e90495016b0acf1a322520731
+  metadata.gz: fa0740a77d93fc9f87723797b3bca421e957a5661e4f82211762e21e9a29e53e
+  data.tar.gz: 47c18a7af64db89155056eaa370131134581f56769730865bf4c9e7781208ca2
 SHA512:
-  metadata.gz: e9ed07f6dfb3477c100eebc4afc2fd72fd639637fc200dd4ce6130e2cbdcb9fb3c6b9c4e5b3955397eb3bd08811542e0c96b954497110d148f048ef8f2583bed
-  data.tar.gz: 04d74bc577004804a4a5cb039f48dfb32b1bdc8b018aee47729202e6c58bfb7711698b789dfdb575ae715e50c4f78f5a36516841176169481b64bbeafd071dc1
+  metadata.gz: c0cfdbfb358da830cabf1fae1406e52d208960331f9a871aef2829a9c18d7d5f31d0e6aa5c0d96942148bb6c64060faa875ec11dfe8dd0d9e2da4d14e41637b0
+  data.tar.gz: f420cf2bfc326cc3b8404f5059a9e1e6b398c377319939d196539be4e2aa4c43d88d27dfd579ca0ceea71cded49a78956687798a88b788a39c5076f2de88f970

data/README.md

@@ -1,3 +1,10 @@
+<!--
+  Title: PgRls Rails
+  Description: rails multitenancy with pg rls
+  Author: dandush03
+  -->
+<meta name="google-site-verification" content="Mc1vBv8PRYPw_cdd3EiKhF2vlOeIEIk3VYhAg75ertI" />
+
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
@@ -77,7 +84,28 @@ 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`  
+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`
+
+You can add the following configuration to your Database Config File to improve performance and remove `PgRls::SecureConnection` from `aplication_record.rb`
+
+```yml
+# app/config/database.yml
+<% def db_username
+    return PgRls::SECURE_USERNAME unless ENV['AS_DB_ADMIN']
+
+    Rails.application.credentials.dig(:database, :server_1, :username)
+   end %>
+
+...
+
+development:
+  <<: *default
+  database: example_development
+  username: <%= db_username %> # Apply this to production and all env including tests
+
+...
+
+```
 ### 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:

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

@@ -2,8 +2,6 @@
 
 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 %>|

data/lib/pg_rls/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative '../pg_rls'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/database/tasks/**/*.rake").each { |f| import f }

data/lib/pg_rls/database/prepared.rb

@@ -5,16 +5,31 @@ module PgRls
     # Prepare database for test unit
     module Prepared
       class << self
-        def grant_user_credentials(name: PgRls::SECURE_USERNAME)
-          return unless Rails.env.test?
+        def grant_user_credentials(name: PgRls::SECURE_USERNAME, password: 'password')
+          return unless Rails.env.test? || PgRls.default_connection?
 
-          PgRls.execute <<-SQL
-            GRANT USAGE, SELECT
-              ON ALL SEQUENCES IN SCHEMA public
-                TO #{name};
+          PgRls.admin_execute <<-SQL
+            DO
+            $do$
+            BEGIN
+              IF NOT EXISTS (
+                SELECT FROM pg_catalog.pg_roles AS r
+                WHERE r.rolname = '#{name}') THEN
+
+                  CREATE USER #{name} WITH PASSWORD '#{password}';
+              END IF;
+            END
+            $do$;
+            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};
+              TO #{name};
+            GRANT USAGE, SELECT
+              ON ALL SEQUENCES IN SCHEMA public
+              TO #{name};
           SQL
         end
       end

data/lib/pg_rls/database/tasks/admin_database.rake

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# OVERIDE RAILS TASK
+Rake::TaskManager.class_eval do
+  def alias_task(fq_name)
+    new_name = "#{fq_name}:original"
+    @tasks[new_name] = @tasks.delete(fq_name)
+  end
+end
+
+def alias_task(fq_name)
+  Rake.application.alias_task(fq_name)
+end
+
+def override_task(*args, &block)
+  name, _params, _deps = Rake.application.resolve_args(args.dup)
+  fq_name = Rake.application.instance_variable_get(:@scope).to_a.reverse.push(name).join(':')
+  alias_task(fq_name)
+  Rake::Task.define_task(*args, &block)
+end
+
+namespace :db do
+  override_task create: :load_config do
+    system('AS_DB_ADMIN=true rake db:create:original')
+  end
+
+  override_task drop: :load_config do
+    system('AS_DB_ADMIN=true rake db:drop:original')
+  end
+
+  override_task migrate: :load_config do
+    system('AS_DB_ADMIN=true rake db:migrate:original')
+  end
+
+  override_task rollback: :load_config do
+    system('AS_DB_ADMIN=true rake db:rollback:original')
+  end
+
+  override_task prepare: :load_config do
+    system('AS_DB_ADMIN=true rake db:prepare:original')
+  end
+
+  override_task setup: :load_config do
+    system('AS_DB_ADMIN=true rake db:setup:original')
+  end
+
+  override_task prepare: :load_config do
+    system('AS_DB_ADMIN=true rake db:reset:original')
+  end
+
+  override_task purge: :load_config do
+    system('AS_DB_ADMIN=true rake db:purge:original')
+  end
+
+  override_task abort_if_pending_migrations: :load_config do
+    system('AS_DB_ADMIN=true rake db:abort_if_pending_migrations:original')
+  end
+
+  override_task seed: :load_config do
+    system('AS_DB_ADMIN=true rake db:seed:original')
+  end
+
+  namespace :test do
+    override_task create: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:create:original')
+    end
+
+    override_task drop: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:drop:original')
+    end
+
+    override_task prepare: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:prepare:original')
+    end
+
+    override_task setup: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:setup:original')
+    end
+
+    override_task purge: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:purge:original')
+    end
+
+    override_task load_schema: :load_config do
+      system('AS_DB_ADMIN=true rake db:test:load_schema:original')
+    end
+  end
+
+  namespace :enviroment do
+    override_task set: :load_config do
+      system('AS_DB_ADMIN=true rake db:enviroment:set:original')
+    end
+  end
+
+  namespace :schema do
+    override_task load: :load_config do
+      system('AS_DB_ADMIN=true rake db:schema:load:original')
+      PgRls.admin_execute do
+        PgRls.execute <<-SQL
+          DROP ROLE IF EXISTS #{PgRls::SECURE_USERNAME};
+          CREATE USER #{PgRls::SECURE_USERNAME} WITH PASSWORD '#{PgRls.database_configuration['password']}';
+          GRANT ALL PRIVILEGES ON TABLE schema_migrations TO #{PgRls::SECURE_USERNAME};
+          GRANT USAGE ON SCHEMA public TO #{PgRls::SECURE_USERNAME};
+          ALTER DEFAULT PRIVILEGES IN SCHEMA public
+            GRANT SELECT, INSERT, UPDATE, DELETE
+            ON TABLES TO #{PgRls::SECURE_USERNAME};
+          GRANT SELECT, INSERT, UPDATE, DELETE
+            ON ALL TABLES IN SCHEMA public
+            TO #{PgRls::SECURE_USERNAME};
+          GRANT USAGE, SELECT
+            ON ALL SEQUENCES IN SCHEMA public
+            TO #{PgRls::SECURE_USERNAME};
+        SQL
+      end
+    end
+  end
+end

data/lib/pg_rls/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../pg_rls'
+require 'rails'
+
+module PgRls
+  # Extend Rails Railties
+  class Railtie < Rails::Railtie
+    railtie_name :my_gem
+
+    rake_tasks do
+      path = File.dirname(__FILE__)
+      Dir.glob("#{path}/database/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/pg_rls/tenant.rb

@@ -9,7 +9,7 @@ module PgRls
         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}'"
+        "RLS changed to '#{tenant.send(@method)}'"
       rescue StandardError => e
         puts 'connection was not made'
         puts @error || e
@@ -31,6 +31,7 @@ module PgRls
         @tenant = nil
 
         PgRls.search_methods.each do |method|
+          @method = method
           @tenant ||= PgRls.main_model.send("find_by_#{method}", resource)
         rescue NoMethodError => e
           @error = e

data/lib/pg_rls/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgRls
-  VERSION = '0.0.1.4'
+  VERSION = '0.0.1.4.1'
 end

data/lib/pg_rls.rb

@@ -8,6 +8,7 @@ require_relative 'pg_rls/schema/statements'
 require_relative 'pg_rls/tenant'
 require_relative 'pg_rls/secure_connection'
 require_relative 'pg_rls/multi_tenancy'
+require_relative 'pg_rls/railtie' if defined?(Rails)
 
 # PostgreSQL Row Level Security
 module PgRls
@@ -17,9 +18,9 @@ module PgRls
   class << self
     extend Forwardable
 
-    WRITER_METHODS = %i[table_name class_name search_methods].freeze
+    WRITER_METHODS = %i[table_name class_name search_methods establish_default_connection].freeze
     READER_METHODS = %i[
-      connection_class database_configuration execute table_name class_name search_methods
+      connection_class database_configuration execute table_name class_name search_methods establish_default_connection
     ].freeze
     DELEGATORS_METHODS = %i[
       connection_class database_configuration execute table_name search_methods
@@ -51,8 +52,20 @@ module PgRls
       )
     end
 
-    def establish_default_connection
-      @default_connection = true
+    def admin_execute(query = nil)
+      self.establish_default_connection = true
+      establish_new_connection
+      return yield if block_given?
+
+      execute(query)
+    ensure
+      self.establish_default_connection = false
+      establish_new_connection
+    end
+
+    def establish_default_connection=(value)
+      ENV['AS_DB_ADMIN'] = value.to_s
+      @default_connection = value
     end
 
     def default_connection?
@@ -77,12 +90,12 @@ module PgRls
     end
 
     def execute(query)
-      @execute = ActiveRecord::Migration.execute(query)
+      ActiveRecord::Migration.execute(query)
     end
 
     def database_configuration
-      @database_configuration ||= database_connection_file[Rails.env].tap do |config|
-        config['username'] = PgRls::SECURE_USERNAME
+      database_connection_file[Rails.env].tap do |config|
+        config['username'] = PgRls::SECURE_USERNAME unless default_connection?
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_rls
 version: !ruby/object:Gem::Version
-  version: 0.0.1.4
+  version: 0.0.1.4.1
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,8 +60,11 @@ files:
 - lib/generators/templates/README
 - lib/generators/templates/pg_rls.rb.tt
 - lib/pg_rls.rb
+- lib/pg_rls/Rakefile
 - lib/pg_rls/database/prepared.rb
+- lib/pg_rls/database/tasks/admin_database.rake
 - lib/pg_rls/multi_tenancy.rb
+- lib/pg_rls/railtie.rb
 - lib/pg_rls/schema/down_statements.rb
 - lib/pg_rls/schema/statements.rb
 - lib/pg_rls/schema/up_statements.rb
@@ -88,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.