pg_rls 0.0.1.beta → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff1edae4e2b864b6d1c50dbe73330ddd3092314fc0f0654ce631dd3f2381e73
-  data.tar.gz: f61c086a2319def269009a8acd4bb712457913cb23703d4f592486c1adc76161
+  metadata.gz: c4f0bd5f9878604a5f34c33b24221a9e7bb1efe25b526c825044dd7927f870f6
+  data.tar.gz: 1e51d31dccc7b7787921775f856d96cb630bf006fe5108df8fb65aba6560cf98
 SHA512:
-  metadata.gz: 88eaa010df64b8ba78630841f3ac886c44dca7929e43016e2dcbe6b4000a06ad41d0606e94fe7457eb3c46fe0e3c341d2208bf6b5fd64553fcd9eedbaee59c7a
-  data.tar.gz: 70aef5056d562fb96a2189d580f3b3cc31b1efb4ef71433969f8896268cdf0286bc5450b9b855166e48580d12aed451d0771c672611c3a934f7f046be2ea8dc9
+  metadata.gz: 86bafd3671e72de8a0f7fb84891c76530a28065dfb799b06de600bb0199a41cd8c22fed269e44076f79a05e2d874e63eeeb7f5728518d15ceddf89e6ff7bf824
+  data.tar.gz: f99445e75de533cb9ef7acfc5215c14ca78d629bd65cef1cb497f3adc1ae43f8689d46bcf7dcab8a5ac7684b79290630841ef33142434366800af9cf94e448d2

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,50 @@
-# 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]
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+ <h1 align="center">PgRls</h1>
+ <h2 align="center"> PostgreSQL Row Level Security </h2>
+ <h1 align="center"></h1>
+
+  <p align="center">
+    <br />
+    <a href="https://github.com/Dandush03/pg_rls"><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>
+
+### Table of Contents
+* [Required Installations](#required-Installations)
+  * [Installing](#installing)
+  * [Instructions](#instructions)
+* [Development](#testing)
+* [Contact](#contact)
+* [Contributing](#contributing)
+* [License](#license)
+* [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
+
+## Required Installations
+### Installing
 
 Add this line to your application's Gemfile:
 
@@ -20,18 +60,26 @@ Or install it yourself as:
 
     $ gem install pg_rls
 
-## Usage
-
-RUN `rails generate pg_rls:install company`
+### Instructions
 
+```bash
+rails generate pg_rls:install company #=> where app 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
 
 for any new model that required to be under rls you can generate it by writing 
 
-`rails generate pg_rls user`
+```bash
+rails generate pg_rls user #=> where app eq model name
+```
 and it will generate all the necesary information for you
 
+you can swtich tenant by using 
+```ruby
+PgRls::Tenant::switch :app #=> where app eq tenant name
+```
+
 enjoy the gem :) 
 ## Development
 
@@ -50,3 +98,26 @@ 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 soon will integrate slug/domain and cookies support 
+
+## Show your support
+
+Give a ⭐️ if you like this project!
+
+<!-- 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
+[hireable-url]: https://www.linkedin.com/in/daniel-laloush/

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

@@ -11,8 +11,6 @@ module PgRls
 
       source_root File.expand_path('./templates', __dir__)
 
-      hook_for :test_framework
-
       def create_migration_file
         migration_template migration_template_path, "#{migration_path}/#{file_sub_name}_#{table_name}.rb",
                            migration_version: migration_version

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 PgRlsTenantCreate<%= 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,10 @@
 
 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 %>
 end

data/lib/pg_rls/schema/up_statements.rb

@@ -64,9 +64,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/tenant.rb

@@ -4,20 +4,33 @@ 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,
+        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
       end
 
+      def tenant
+        PgRls.class_name.to_s.camelize.constantize
+      end
+
+      def 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 tenant_by_subdomain_uuid_or_tenant_id(resource)
-        Company.find_by_subdomain(resource) || Company.find_by_id(resource) || Company.find_by_tenant_id(resource)
+        tenant.find_by_subdomain(resource) || tenant.find_by_id(resource) || tenant.find_by_tenant_id(resource)
       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'
 end

data/lib/pg_rls.rb

@@ -16,9 +16,13 @@ module PgRls
   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].freeze
+    READER_METHODS = %i[
+      connection_class database_configuration execute table_name class_name
+    ].freeze
+    DELEGATORS_METHODS = %i[
+      connection_class database_configuration execute table_name class_name
+    ].freeze
 
     attr_writer(*WRITER_METHODS)
     attr_reader(*READER_METHODS)
@@ -59,4 +63,9 @@ module PgRls
       end
     end
   end
+  mattr_accessor :table_name
+  @@table_name = 'companies'
+
+  mattr_accessor :class_name
+  @@class_name = 'Company'
 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
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,9 +77,9 @@ 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
 signing_key: