pg_rls 0.0.1 → 0.0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f0bd5f9878604a5f34c33b24221a9e7bb1efe25b526c825044dd7927f870f6
-  data.tar.gz: 1e51d31dccc7b7787921775f856d96cb630bf006fe5108df8fb65aba6560cf98
+  metadata.gz: 4adb2a4dc970c7945eea48bae37f3fe6153607ac61bfe69e5190a4f1b0d3996b
+  data.tar.gz: 6c223603207bb885e56b4e2340c0e737747418cfeca0fea9a0cda191385cc945
 SHA512:
-  metadata.gz: 86bafd3671e72de8a0f7fb84891c76530a28065dfb799b06de600bb0199a41cd8c22fed269e44076f79a05e2d874e63eeeb7f5728518d15ceddf89e6ff7bf824
-  data.tar.gz: f99445e75de533cb9ef7acfc5215c14ca78d629bd65cef1cb497f3adc1ae43f8689d46bcf7dcab8a5ac7684b79290630841ef33142434366800af9cf94e448d2
+  metadata.gz: 58a6a9f87ad417a3ce1783211afe6189fec242f7488cb238d9ec416c71b960eac7263b1c90cb6afa03460ab0b393d7af510e40b6d5d78484d4e56a89ba742982
+  data.tar.gz: bc5efaefc28e0b965ebeebc27151b96324399275f96a5ae473ea2336e220ff10f646490b35cbd3d7d5d92cefc55b88025502a8619bb32000ebb32bbbaefaf506

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,49 @@ 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
 ```
 
-enjoy the gem :) 
+### 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
+
+...
+# some database cleaning strategy
+
+config.before(:suite) do
+  # Create A Default Tenant and Grant Test User Credentials
+  PgRls::Test::PreparedDatabase.grant_user_credentials
+  FactoryBot.create(:company, subdomain: 'app')
+  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 +116,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 +140,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/pg_rls/test/prepared_database.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PgRls
+  module Test
+    # Prepare database for test unit
+    module PreparedDatabase
+      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/version.rb

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

data/lib/pg_rls.rb

@@ -3,6 +3,7 @@
 require 'active_record'
 require 'forwardable'
 require_relative 'pg_rls/version'
+require_relative 'pg_rls/test/prepared_database'
 require_relative 'pg_rls/schema/statements'
 require_relative 'pg_rls/tenant'
 require_relative 'pg_rls/secure_connection'
@@ -11,7 +12,7 @@ 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

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.1
 platform: ruby
 authors:
 - Daniel Laloush
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-10-30 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: []
@@ -61,6 +63,7 @@ files:
 - 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: