super_auth 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1ea96c948511db2bcb65e7dc10b813ae6b5fddb1bbee785c7a3e59178c7b68f
-  data.tar.gz: 3d5eb559c56948c9edb31f801f28636ee594578759f83c452d3a62987432394e
+  metadata.gz: 6a5da5e9ec945c0624514fb6b72471c934911dfa9e59271aeee08ef7e78e60c7
+  data.tar.gz: 6f96f6f911d939a4f4059081b45b68894c7ef1795d232df6f4646c854f4554a1
 SHA512:
-  metadata.gz: 272eba9bf5807006f956605eb927c7aaec6594fee0683c8ee155c7f4d614419dbd1927495860cfa73acc9b5973887d273605bdbbff58a8d0726f7f63a9ebdcd5
-  data.tar.gz: 904ee67ef8c4b858bfec6ea2cfe39bdc692dba063edee0a76f769209301c3c9a8850df37bf8b65584bd5a15db9cbf1df3125429c2d4a43f8b18f49e25c8bf665
+  metadata.gz: f747d99cf64d276a95d7e3231885b37289b4e587e09be1febbe070ed416f206b7989bba7c32a64b9d5fddeed6afb2502ef871008e51b64395696d54e54887dd1
+  data.tar.gz: b580ce1942b4ce3334639e0ac20c579af0eb65d285beaa403a5c3540c3239d6582d2444fb88d7d67fdf05720e37b7291d104cb208bbc98d393b97e4280ab066e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    super_auth (0.1.2)
+    super_auth (0.1.3)
       sequel
 
 GEM

data/README.md

@@ -1,23 +1,167 @@
 # SuperAuth
 
-TODO: Delete this and the text below, and describe your gem
+Super auth is turn-key authorization gem that makes unauthorized access unrepresentable. **Stop writing tests for authorization with confidence**
 
-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/super_auth`. To experiment with that code, run `bin/console` for an interactive prompt.
+The intent is to use with ruby applications, as well as centralize authorization for multiple applications. If you look at the [OWASP top vulnerabilty](https://owasp.org/Top10/A01_2021-Broken_Access_Control/), broken
+access control is the NUMBER 1 most common security risk in modern applications today. super_auth provides a authentication strategy that allows you to completely de-risk your application, solving this issue once confidently.
 
-## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+    gem "super_auth"
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Docs
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+How `super_auth` stacks up against other authentication strategies:
+[Do you really understand Authentication](https://dev.to/jonathanfrias/do-you-really-understand-authorization-1o5d)
 
 ## Usage
 
+SuperAuth is a rules engine engine that works on 5 different authorization concepts:
+
+- Users
+- Groups
+- Roles
+- Permissions
+- Resources
+
+The basis for how this works is that the rules engine is trying to match a user with a resource to determine access.
+The engine determines if it can find an authorization route betewen a user and a resource. It does so by looking at users, groups, roles, permissions.
+
+                         +-------+       +------+
+                         | Group |<----->| Role |
+                         +-------+\    / +------+
+                             ^     \  /     ^
+                             |      \/      |
+                             |      /\      |
+                             |     /  \     |
+                             V    /    \    V
+    +---------------+    +------+/      \+------------+    +----------+      +-------------------+
+    | YourApp::User |<-->| User |<------>| Permission |<-->| Resource | <--> | YourApp::Resource |
+    +---------------+    +------+        +------------+    +----------+      +-------------------+
+                             ^                                  ^
+                             |                                  |
+                             +----------------------------------+
+
+
+The lines between the boxes are called [edges](https://en.wikipedia.org/wiki/Glossary_of_graph_theory#edge).
+Note that `Group` and `Role` trees.
+
+In general the super_auth has 5 different pathing strategies to search for access.
+
+    1. users <-> group[s] <-> role[s] <-> permission <-> resource
+    2. users <->              role[s] <-> permission <-> resource
+    3. users <-> group[s] <->             permission <-> resource
+    4. users <->                          permission <-> resource
+    5. users <->                                         resource
+
+Edges can be drawn between any 2 objects, allowing super_auth can seamlessly scale in complexity with you.
+When `Group` and `Role` are used, the rules will apply to all descedants. If there are any edges
+between the specified user and the resource, then access is granted.
+
+
+You can see usage examples `spec/example_spec.rb`.
+
+We're going to need some users:
+
+    Users:
+      - Peter
+      - Michael
+      - Bethany
+      - Eloise
+      - Anna
+      - Dillon
+      - Guest (Unknown User)
+
+Let's see an example company structure:
+
+    Groups:
+      - Company
+        - Engineering_dept
+          - Backend
+          - Frontend
+        - Sales Department
+        - Marketing Department
+      - Customers
+        - CustomerA
+        - CustomerB
+      - Vendors
+        - VendorA
+        - VendorB
+
+We're going to define a roles:
+
+    Roles:
+      - Employee
+        - Engineering
+          - Señor Software Developer
+          - Señor Designer
+          - Software Developer
+          - Production Support
+        - Sales and Marketing
+          - Marketing Manager
+          - Marketing Associate
+      - CustomerRole
+
+We're going to define some permissions:
+
+    Permissions:
+      - create
+      - read
+      - update
+      - delete
+      - invoice
+      - login
+      - reboot
+      - deploy
+      - sign_contract
+      - subscribe
+      - unsubscribe
+      - publish_design
+
+Finally, we need some resources:
+
+    Resources:
+      - app1
+      - app2
+      - staging
+      - db1
+      - db2
+      - core_design_template
+      - customer_profile
+      - marketing_website
+      - customer_post1
+      - customer_post2
+      - customer_post3
+
+So we have sufficient prerequisite data to do some interesting authorizations. Let's draw some edges:
+
+    Peter <-> Frontend # Peter is on the Frontend team. (via Company->Engineering_dept->Frontend)
+    Engineering_dept <-> Engineering # Group "Engineering_dept" has the Role "Engineering"
+    Engineering <-> create # Engineering role can do basic CRUD operations
+    Engineering <-> read   # Peter can CRUD too
+    Engineering <-> update
+    Engineering <-> delete
+    core_design_template <-> create # Now, those CRUD permissions apply to core_design_template resource
+    core_design_template <-> read
+    core_design_template <-> update
+    core_design_template <-> delete
+
+With this, the following paths are created from Peter to the core_design_template:
+
+    Peter <-> Frontend <-> Engineering_dept <-> Engineering <-> create <-> core_design_template
+    Peter <-> Frontend <-> Engineering_dept <-> Engineering <-> read   <-> core_design_template
+    Peter <-> Frontend <-> Engineering_dept <-> Engineering <-> update <-> core_design_template
+    Peter <-> Frontend <-> Engineering_dept <-> Engineering <-> delete <-> core_design_template
+
+    Which completes the circuit using the path
+    user <-> group <-> group <-> role <-> permission <-> resource
+
+
+When you create/delete an edge new authorizations are generated and stored in the `super_auth` database table.
+Since the path is stored with the record, it trivial to audit access permissions using basic SQL.
+
 TODO: Write usage instructions here
 
 ## Development
@@ -28,8 +172,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/super_auth.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JonathanFrias/super_auth.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [GPL](https://www.gnu.org/licenses/quick-guide-gplv3.html).

data/db/migrate/1_users.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:users) do
+    create_table?(:super_auth_users) do
       primary_key :id
 
       String :external_id # , null: false

data/db/migrate/2_groups.rb

@@ -1,9 +1,9 @@
 Sequel.migration do
   change do
-    create_table(:groups) do
+    create_table?(:super_auth_groups) do
       primary_key :id
       String :name, null: false
-      foreign_key :parent_id, :groups, deferrable: true, type: :integer
+      foreign_key :parent_id, :super_auth_groups, deferrable: true, type: :integer
       DateTime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
       DateTime :updated_at, null: false, default: Sequel::CURRENT_TIMESTAMP
     end

data/db/migrate/3_permissions.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:permissions) do
+    create_table?(:super_auth_permissions) do
       primary_key :id
       String :name, null: false
       DateTime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP

data/db/migrate/4_roles.rb

@@ -1,9 +1,9 @@
 Sequel.migration do
   change do
-    create_table(:roles) do
+    create_table?(:super_auth_roles) do
       primary_key :id
       String :name, null: false
-      foreign_key :parent_id, :roles, deferrable: true, type: :integer
+      foreign_key :parent_id, :super_auth_roles, deferrable: true, type: :integer
       DateTime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
       DateTime :updated_at, null: false, default: Sequel::CURRENT_TIMESTAMP
     end

data/db/migrate/5_resources.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:resources) do
+    create_table?(:super_auth_resources) do
       primary_key :id
 
       String :name

data/db/migrate/6_edge.rb

@@ -1,13 +1,13 @@
 Sequel.migration do
   change do
-    create_table(:edges) do
+    create_table?(:super_auth_edges) do
       primary_key :id
 
-      foreign_key :user_id,       :users,       null: true
-      foreign_key :group_id,      :groups,      null: true
-      foreign_key :permission_id, :permissions, null: true
-      foreign_key :role_id,       :roles,       null: true
-      foreign_key :resource_id,   :resources,   null: true
+      foreign_key :user_id,       :super_auth_users,       null: true
+      foreign_key :group_id,      :super_auth_groups,      null: true
+      foreign_key :permission_id, :super_auth_permissions, null: true
+      foreign_key :role_id,       :super_auth_roles,       null: true
+      foreign_key :resource_id,   :super_auth_resources,   null: true
 
       DateTime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
       DateTime :updated_at, null: false, default: Sequel::CURRENT_TIMESTAMP

data/lib/basic_loader.rb

@@ -7,6 +7,7 @@ require 'super_auth/edge'
 require 'super_auth/nestable'
 require 'super_auth/group'
 require 'super_auth/permission'
+require 'super_auth/railtie'
 require 'super_auth/resource'
 require 'super_auth/role'
 require 'super_auth/user'

data/lib/super_auth/edge.rb

@@ -1,4 +1,4 @@
-class SuperAuth::Edge < Sequel::Model(:edges)
+class SuperAuth::Edge < Sequel::Model(:super_auth_edges)
   many_to_one :user
   many_to_one :group
   many_to_one :permission
@@ -15,45 +15,45 @@ class SuperAuth::Edge < Sequel::Model(:edges)
     end
 
     def users_groups_roles_permissions_resources
-      users_groups_roles_ds = SuperAuth::User.join(:edges, user_id: :id).select_all(:users).join(SuperAuth::Group.from(SuperAuth::Group.trees).as(:groups), id: :group_id).select(
-        Sequel[:users][:id].as(:user_id),
-        Sequel[:users][:name].as(:user_name),
-        Sequel[:users][:external_id].as(:user_external_id),
-        Sequel[:users][:created_at].as(:user_created_at),
-        Sequel[:users][:updated_at].as(:user_updated_at),
+      users_groups_roles_ds = SuperAuth::User.join(:super_auth_edges, user_id: :id).select_all(:super_auth_users).join(SuperAuth::Group.from(SuperAuth::Group.trees).as(:groups), id: :group_id).select(
+        Sequel[:super_auth_users][:id].as(:user_id),
+        Sequel[:super_auth_users][:name].as(:user_name),
+        Sequel[:super_auth_users][:external_id].as(:user_external_id),
+        Sequel[:super_auth_users][:created_at].as(:user_created_at),
+        Sequel[:super_auth_users][:updated_at].as(:user_updated_at),
         Sequel[:groups][:id].as(:group_id),
         Sequel[:groups][:name].as(:group_name),
-        Sequel[:edges][:id].as(:edge_id),
-        Sequel[:edges][:permission_id].as(:edge_permission_id),
-        Sequel[:edges][:group_id].as(:edge_group_id),
-        Sequel[:edges][:user_id].as(:edge_user_id),
-        Sequel[:edges][:role_id].as(:edge_role_id),
+        Sequel[:super_auth_edges][:id].as(:edge_id),
+        Sequel[:super_auth_edges][:permission_id].as(:edge_permission_id),
+        Sequel[:super_auth_edges][:group_id].as(:edge_group_id),
+        Sequel[:super_auth_edges][:user_id].as(:edge_user_id),
+        Sequel[:super_auth_edges][:role_id].as(:edge_role_id),
         Sequel[:groups][:group_path],
         Sequel[:groups][:group_name_path],
         Sequel[:groups][:parent_id],
         Sequel[:groups][:created_at].as(:group_created_at),
         Sequel[:groups][:updated_at].as(:group_updated_at),
-      ).join(Sequel[:edges].as(:group_role_edges), Sequel[:group_role_edges][:group_id] => Sequel[:groups][:id]).select_append(
+      ).join(Sequel[:super_auth_edges].as(:group_role_edges), Sequel[:group_role_edges][:group_id] => Sequel[:groups][:id]).select_append(
         Sequel[:group_role_edges][:id].as(:group_role_edge_id),
         Sequel[:group_role_edges][:permission_id].as(:group_role_edge_permission_id),
         Sequel[:group_role_edges][:group_id].as(:group_role_edge_group_id),
         Sequel[:group_role_edges][:user_id].as(:group_role_edge_user_id),
         Sequel[:group_role_edges][:role_id].as(:group_role_edge_role_id),
-      ).join(:roles, id: Sequel[:group_role_edges][:role_id])
+      ).join(:super_auth_roles, id: Sequel[:group_role_edges][:role_id])
 
       SuperAuth::Edge.from(
         SuperAuth::Edge.from(
           SuperAuth::Group.cte(SuperAuth::Group.where(id: users_groups_roles_ds.select(Sequel[:groups][:id])).select(:id)).select { [id.as(:group_id), name.as(:group_name), parent_id.as(:group_parent_id), group_path, group_name_path, created_at.as(:group_created_at), updated_at.as(:group_updated_at)] },
           SuperAuth::Role.cte(users_groups_roles_ds.select(Sequel[:group_role_edges][:role_id])).select { [id.as(:role_id), name.as(:role_name), parent_id.as(:role_parent_id), role_path, role_name_path, created_at.as(:role_created_at), updated_at.as(:role_updated_at) ] }
         ).as(:users_groups_roles_permissions_resources)
-      ).join(Sequel[:edges].as(:user_edges), Sequel[:user_edges][:group_id] => Sequel[:users_groups_roles_permissions_resources][:group_id])
-       .join(Sequel[:users], id: Sequel[:user_edges][:user_id])
+      ).join(Sequel[:super_auth_edges].as(:user_edges), Sequel[:user_edges][:group_id] => Sequel[:users_groups_roles_permissions_resources][:group_id])
+       .join(Sequel[:super_auth_users], id: Sequel[:user_edges][:user_id])
        .select(
-          Sequel[:users][:id].as(:user_id),
-          Sequel[:users][:name].as(:user_name),
-          Sequel[:users][:external_id].as(:user_external_id),
-          Sequel[:users][:created_at].cast(:text).as(:user_created_at),
-          Sequel[:users][:updated_at].cast(:text).as(:user_updated_at),
+          Sequel[:super_auth_users][:id].as(:user_id),
+          Sequel[:super_auth_users][:name].as(:user_name),
+          Sequel[:super_auth_users][:external_id].as(:user_external_id),
+          Sequel[:super_auth_users][:created_at].cast(:text).as(:user_created_at),
+          Sequel[:super_auth_users][:updated_at].cast(:text).as(:user_updated_at),
 
           Sequel[:users_groups_roles_permissions_resources][:group_id],
           Sequel[:users_groups_roles_permissions_resources][:group_name],
@@ -71,32 +71,32 @@ class SuperAuth::Edge < Sequel::Model(:edges)
           Sequel[:users_groups_roles_permissions_resources][:role_created_at].cast(:text),
           Sequel[:users_groups_roles_permissions_resources][:role_updated_at].cast(:text),
 
-          Sequel[:permissions][:id].as(:permission_id),
-          Sequel[:permissions][:name].as(:permission_name),
-          Sequel[:permissions][:created_at].cast(:text).as(:permission_created_at),
-          Sequel[:permissions][:updated_at].cast(:text).as(:permission_updated_at),
+          Sequel[:super_auth_permissions][:id].as(:permission_id),
+          Sequel[:super_auth_permissions][:name].as(:permission_name),
+          Sequel[:super_auth_permissions][:created_at].cast(:text).as(:permission_created_at),
+          Sequel[:super_auth_permissions][:updated_at].cast(:text).as(:permission_updated_at),
 
-          Sequel[:resources][:id].as(:resource_id),
-          Sequel[:resources][:name].as(:resource_name),
-          Sequel[:resources][:external_id].as(:resource_external_id)
+          Sequel[:super_auth_resources][:id].as(:resource_id),
+          Sequel[:super_auth_resources][:name].as(:resource_name),
+          Sequel[:super_auth_resources][:external_id].as(:resource_external_id)
         )
-       .join(Sequel[:edges].as(:permission_edges), Sequel[:permission_edges][:role_id] => Sequel[:users_groups_roles_permissions_resources][:role_id])
-       .join(Sequel[:permissions], id: Sequel[:permission_edges][:permission_id])
-       .join(Sequel[:edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:permission_edges][:permission_id])
-       .join(Sequel[:resources], id: Sequel[:resource_edges][:resource_id])
+       .join(Sequel[:super_auth_edges].as(:permission_edges), Sequel[:permission_edges][:role_id] => Sequel[:users_groups_roles_permissions_resources][:role_id])
+       .join(Sequel[:super_auth_permissions], id: Sequel[:permission_edges][:permission_id])
+       .join(Sequel[:super_auth_edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:permission_edges][:permission_id])
+       .join(Sequel[:super_auth_resources], id: Sequel[:resource_edges][:resource_id])
        .distinct
     end
 
     def users_groups_permissions_resources
       SuperAuth::User.
-        join(Sequel[:edges].as(:user_edges), user_id: :id).
+        join(Sequel[:super_auth_edges].as(:user_edges), user_id: :id).
         join(SuperAuth::Group.from(SuperAuth::Group.trees).as(:groups), id: :group_id).
         select(
-          Sequel[:users][:id].as(:user_id),
-          Sequel[:users][:name].as(:user_name),
-          Sequel[:users][:external_id].as(:user_external_id),
-          Sequel[:users][:created_at].cast(:text).as(:user_created_at),
-          Sequel[:users][:updated_at].cast(:text).as(:user_updated_at),
+          Sequel[:super_auth_users][:id].as(:user_id),
+          Sequel[:super_auth_users][:name].as(:user_name),
+          Sequel[:super_auth_users][:external_id].as(:user_external_id),
+          Sequel[:super_auth_users][:created_at].cast(:text).as(:user_created_at),
+          Sequel[:super_auth_users][:updated_at].cast(:text).as(:user_updated_at),
 
           Sequel[:groups][:id].as(:group_id),
           Sequel[:groups][:name].as(:group_name),
@@ -114,40 +114,40 @@ class SuperAuth::Edge < Sequel::Model(:edges)
           Sequel::NULL.as(:role_created_at),      # Sequel[:roles][:created_at].as(:role_created_at),
           Sequel::NULL.as(:role_updated_at),      # Sequel[:roles][:updated_at].as(:role_updated_at),
 
-          Sequel[:permissions][:id].as(:permission_id),
-          Sequel[:permissions][:name].as(:permission_name),
-          Sequel[:permissions][:created_at].cast(:text).as(:permission_created_at),
-          Sequel[:permissions][:updated_at].cast(:text).as(:permission_updated_at),
+          Sequel[:super_auth_permissions][:id].as(:permission_id),
+          Sequel[:super_auth_permissions][:name].as(:permission_name),
+          Sequel[:super_auth_permissions][:created_at].cast(:text).as(:permission_created_at),
+          Sequel[:super_auth_permissions][:updated_at].cast(:text).as(:permission_updated_at),
 
-          Sequel[:resources][:id].as(:resource_id),
-          Sequel[:resources][:name].as(:resource_name),
-          Sequel[:resources][:external_id].as(:resource_external_id),
+          Sequel[:super_auth_resources][:id].as(:resource_id),
+          Sequel[:super_auth_resources][:name].as(:resource_name),
+          Sequel[:super_auth_resources][:external_id].as(:resource_external_id),
         ).
-        join(Sequel[:edges].as(:permission_edges), Sequel[:permission_edges][:group_id] => Sequel[:groups][:id]).
-        join(Sequel[:permissions], id: Sequel[:permission_edges][:permission_id]).
-        join(Sequel[:edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:permissions][:id]).
-        join(Sequel[:resources], id: Sequel[:resource_edges][:resource_id]).
+        join(Sequel[:super_auth_edges].as(:permission_edges), Sequel[:permission_edges][:group_id] => Sequel[:groups][:id]).
+        join(Sequel[:super_auth_permissions], id: Sequel[:permission_edges][:permission_id]).
+        join(Sequel[:super_auth_edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:super_auth_permissions][:id]).
+        join(Sequel[:super_auth_resources], id: Sequel[:resource_edges][:resource_id]).
         distinct
     end
 
     def users_roles_permissions_resources
       SuperAuth::User.
-        join(Sequel[:edges].as(:user_edges), user_id: :id).
+        join(Sequel[:super_auth_edges].as(:user_edges), user_id: :id).
         join(SuperAuth::Role.from(SuperAuth::Role.trees).as(:roles), id: :role_id).
         select(
-          Sequel[:users][:id].as(:user_id),
-          Sequel[:users][:name].as(:user_name),
-          Sequel[:users][:external_id].as(:user_external_id),
-          Sequel[:users][:created_at].cast(:text).as(:user_created_at),
-          Sequel[:users][:updated_at].cast(:text).as(:user_updated_at),
-
-          Sequel.lit(%Q[0 as "group_id"]),                                       # Sequel[:groups][:group_id],
-          Sequel::NULL.as(:group_name),                                          # Sequel[:groups][:group_name],
-          Sequel::NULL.as(:group_path),                                          # Sequel[:groups][:group_path],
-          Sequel::NULL.as(:group_name_path),                                     # Sequel[:groups][:group_name_path],
-          Sequel.lit(%Q[0 as "group_parent_id"]),                                # Sequel[:groups][:group_parent_id],
-          Sequel.lit(%Q['1970-01-01 00:00:00.000000-00' as "group_created_at"]), # Sequel[:groups][:group_created_at],
-          Sequel.lit(%Q['1970-01-01 00:00:00.000000-00' as "group_updated_at"]), # Sequel[:groups][:group_updated_at],
+          Sequel[:super_auth_users][:id].as(:user_id),
+          Sequel[:super_auth_users][:name].as(:user_name),
+          Sequel[:super_auth_users][:external_id].as(:user_external_id),
+          Sequel[:super_auth_users][:created_at].cast(:text).as(:user_created_at),
+          Sequel[:super_auth_users][:updated_at].cast(:text).as(:user_updated_at),
+
+          Sequel.lit(%Q[0 as "group_id"]),                                       # Sequel[:super_auth_groups][:group_id],
+          Sequel::NULL.as(:group_name),                                          # Sequel[:super_auth_groups][:group_name],
+          Sequel::NULL.as(:group_path),                                          # Sequel[:super_auth_groups][:group_path],
+          Sequel::NULL.as(:group_name_path),                                     # Sequel[:super_auth_groups][:group_name_path],
+          Sequel.lit(%Q[0 as "group_parent_id"]),                                # Sequel[:super_auth_groups][:group_parent_id],
+          Sequel.lit(%Q['1970-01-01 00:00:00.000000-00' as "group_created_at"]), # Sequel[:super_auth_groups][:group_created_at],
+          Sequel.lit(%Q['1970-01-01 00:00:00.000000-00' as "group_updated_at"]), # Sequel[:super_auth_groups][:group_updated_at],
 
           Sequel[:roles][:id].as(:role_id),
           Sequel[:roles][:name].as(:role_name),
@@ -157,31 +157,31 @@ class SuperAuth::Edge < Sequel::Model(:edges)
           Sequel[:roles][:created_at].cast(:text).as(:role_created_at),
           Sequel[:roles][:updated_at].cast(:text).as(:role_updated_at),
 
-          Sequel[:permissions][:id].as(:permission_id),
-          Sequel[:permissions][:name].as(:permission_name),
-          Sequel[:permissions][:created_at].cast(:text).as(:permission_created_at),
-          Sequel[:permissions][:updated_at].cast(:text).as(:permission_updated_at),
+          Sequel[:super_auth_permissions][:id].as(:permission_id),
+          Sequel[:super_auth_permissions][:name].as(:permission_name),
+          Sequel[:super_auth_permissions][:created_at].cast(:text).as(:permission_created_at),
+          Sequel[:super_auth_permissions][:updated_at].cast(:text).as(:permission_updated_at),
 
-          Sequel[:resources][:id].as(:resource_id),
-          Sequel[:resources][:name].as(:resource_name),
-          Sequel[:resources][:external_id].as(:resource_external_id),
+          Sequel[:super_auth_resources][:id].as(:resource_id),
+          Sequel[:super_auth_resources][:name].as(:resource_name),
+          Sequel[:super_auth_resources][:external_id].as(:resource_external_id),
       ).
-      join(Sequel[:edges].as(:permission_edges), Sequel[:permission_edges][:role_id] => Sequel[:roles][:id]).
-      join(Sequel[:permissions], id: Sequel[:permission_edges][:permission_id]).
-      join(Sequel[:edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:permissions][:id]).
-      join(Sequel[:resources], id: Sequel[:resource_edges][:resource_id]).
+      join(Sequel[:super_auth_edges].as(:permission_edges), Sequel[:permission_edges][:role_id] => Sequel[:roles][:id]).
+      join(Sequel[:super_auth_permissions], id: Sequel[:permission_edges][:permission_id]).
+      join(Sequel[:super_auth_edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:super_auth_permissions][:id]).
+      join(Sequel[:super_auth_resources], id: Sequel[:resource_edges][:resource_id]).
       distinct
     end
 
     def users_permissions_resources
       SuperAuth::User.
-        join(Sequel[:edges].as(:user_edges), user_id: :id).
+        join(Sequel[:super_auth_edges].as(:user_edges), user_id: :id).
         select(
-          Sequel[:users][:id].as(:user_id),
-          Sequel[:users][:name].as(:user_name),
-          Sequel[:users][:external_id].as(:user_external_id),
-          Sequel[:users][:created_at].cast(:text).as(:user_created_at),
-          Sequel[:users][:updated_at].cast(:text).as(:user_updated_at),
+          Sequel[:super_auth_users][:id].as(:user_id),
+          Sequel[:super_auth_users][:name].as(:user_name),
+          Sequel[:super_auth_users][:external_id].as(:user_external_id),
+          Sequel[:super_auth_users][:created_at].cast(:text).as(:user_created_at),
+          Sequel[:super_auth_users][:updated_at].cast(:text).as(:user_updated_at),
 
           Sequel.lit(%Q[0 as "group_id"]),      # Sequel[:groups][:group_id],
           Sequel::NULL.as(:group_name),       # Sequel[:groups][:group_name],
@@ -200,19 +200,19 @@ class SuperAuth::Edge < Sequel::Model(:edges)
           Sequel::NULL.as(:role_created_at),     # Sequel[:roles][:role_created_at],
           Sequel::NULL.as(:role_updated_at),     # Sequel[:roles][:role_updated_at],
 
-          Sequel[:permissions][:id].as(:permission_id),
-          Sequel[:permissions][:name].as(:permission_name),
-          Sequel[:permissions][:created_at].cast(:text).as(:permission_created_at),
-          Sequel[:permissions][:updated_at].cast(:text).as(:permission_updated_at),
+          Sequel[:super_auth_permissions][:id].as(:permission_id),
+          Sequel[:super_auth_permissions][:name].as(:permission_name),
+          Sequel[:super_auth_permissions][:created_at].cast(:text).as(:permission_created_at),
+          Sequel[:super_auth_permissions][:updated_at].cast(:text).as(:permission_updated_at),
 
-          Sequel[:resources][:id].as(:resource_id),
-          Sequel[:resources][:name].as(:resource_name),
-          Sequel[:resources][:external_id].as(:resource_external_id)
+          Sequel[:super_auth_resources][:id].as(:resource_id),
+          Sequel[:super_auth_resources][:name].as(:resource_name),
+          Sequel[:super_auth_resources][:external_id].as(:resource_external_id)
         ).
-      join(Sequel[:edges].as(:permission_edges), Sequel[:permission_edges][:user_id] => Sequel[:users][:id]).
-      join(Sequel[:permissions], id: Sequel[:permission_edges][:permission_id]).
-      join(Sequel[:edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:permissions][:id]).
-      join(Sequel[:resources], id: Sequel[:resource_edges][:resource_id]).
+      join(Sequel[:super_auth_edges].as(:permission_edges), Sequel[:permission_edges][:user_id] => Sequel[:super_auth_users][:id]).
+      join(Sequel[:super_auth_permissions], id: Sequel[:permission_edges][:permission_id]).
+      join(Sequel[:super_auth_edges].as(:resource_edges), Sequel[:resource_edges][:permission_id] => Sequel[:super_auth_permissions][:id]).
+      join(Sequel[:super_auth_resources], id: Sequel[:resource_edges][:resource_id]).
       distinct
     end
   end

data/lib/super_auth/group.rb

@@ -1,3 +1,3 @@
-class SuperAuth::Group < Sequel::Model(:groups)
+class SuperAuth::Group < Sequel::Model(:super_auth_groups)
   include SuperAuth::Nestable
 end

data/lib/super_auth/nestable.rb

@@ -110,7 +110,7 @@ module SuperAuth::Nestable
     end
 
     def pluralize(base = self)
-      "#{demodularize(base).downcase}s".to_sym
+      "super_auth_#{demodularize(base).downcase}s".to_sym
     end
 
     def singularize(base = self)
@@ -118,7 +118,7 @@ module SuperAuth::Nestable
     end
 
     def cte_name(base = self)
-      "#{pluralize(base)}_cte".to_sym
+      "super_auth_#{pluralize(base)}_cte".to_sym
     end
 
     def base_path(base = self)

data/lib/super_auth/permission.rb

@@ -1,23 +1,23 @@
-class SuperAuth::Permission < Sequel::Model(:permissions)
+class SuperAuth::Permission < Sequel::Model(:super_auth_permissions)
   one_to_many :edges
 
   dataset_module do
     def with_edges
-      join(:edges, permission_id: :id).select_all(:permissions)
+      join(:super_auth_edges, permission_id: :id).select_all(:super_auth_permissions)
     end
 
     def with_roles
-      with_edges.join(Role.from(Role.trees).as(:roles), id: :role_id).select(
-        Sequel[:permissions][:id].as(:id),
-        Sequel[:permissions][:id].as(:permission_id),
+    with_edges.join(Role.from(Role.trees).as(:roles), id: :role_id).select(
+        Sequel[:super_auth_permissions][:id].as(:id),
+        Sequel[:super_auth_permissions][:id].as(:permission_id),
         Sequel[:roles][:id].as(:role_id),
-        Sequel[:permissions][:name].as(:permission_name),
+        Sequel[:super_auth_permissions][:name].as(:permission_name),
         Sequel[:roles][:name].as(:role_name),
-        Sequel[:edges][:id].as(:edge_id),
-        Sequel[:edges][:permission_id].as(:edge_permission_id),
-        Sequel[:edges][:group_id].as(:edge_group_id),
-        Sequel[:edges][:user_id].as(:edge_user_id),
-        Sequel[:edges][:role_id].as(:edge_role_id),
+        Sequel[:super_auth_edges][:id].as(:edge_id),
+        Sequel[:super_auth_edges][:permission_id].as(:edge_permission_id),
+        Sequel[:super_auth_edges][:group_id].as(:edge_group_id),
+        Sequel[:super_auth_edges][:user_id].as(:edge_user_id),
+        Sequel[:super_auth_edges][:role_id].as(:edge_role_id),
         :role_path,
         :role_name_path,
         :parent_id

data/lib/super_auth/railtie.rb

@@ -0,0 +1,12 @@
+module SuperAuth
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/super_auth_tasks.rake"
+      end
+    end
+  else
+    class Railtie
+    end
+  end
+end

data/lib/super_auth/resource.rb

@@ -1,2 +1,2 @@
-class SuperAuth::Resource < Sequel::Model(:resources)
+class SuperAuth::Resource < Sequel::Model(:super_auth_resources)
 end

data/lib/super_auth/role.rb

@@ -1,3 +1,3 @@
-class SuperAuth::Role < Sequel::Model(:roles)
+class SuperAuth::Role < Sequel::Model(:super_auth_roles)
   include SuperAuth::Nestable
 end

data/lib/super_auth/user.rb

@@ -1,23 +1,23 @@
-class SuperAuth::User < Sequel::Model(:users)
+class SuperAuth::User < Sequel::Model(:super_auth_users)
   one_to_many :edges
 
   dataset_module do
     def with_edges
-      join(:edges, user_id: :id).select_all(:users)
+      join(:super_auth_edges, user_id: :id).select_all(:super_auth_users)
     end
 
     def with_groups
       with_edges.join(Group.from(Group.trees).as(:groups), id: :group_id).select(
-        Sequel[:users][:id].as(:id),
-        Sequel[:users][:id].as(:user_id),
+        Sequel[:super_auth_users][:id].as(:id),
+        Sequel[:super_auth_users][:id].as(:user_id),
         Sequel[:groups][:id].as(:group_id),
-        Sequel[:users][:name].as(:user_name),
+        Sequel[:super_auth_users][:name].as(:user_name),
         Sequel[:groups][:name].as(:group_name),
-        Sequel[:edges][:id].as(:edge_id),
-        Sequel[:edges][:permission_id].as(:edge_permission_id),
-        Sequel[:edges][:group_id].as(:edge_group_id),
-        Sequel[:edges][:user_id].as(:edge_user_id),
-        Sequel[:edges][:role_id].as(:edge_role_id),
+        Sequel[:super_auth_edges][:id].as(:edge_id),
+        Sequel[:super_auth_edges][:permission_id].as(:edge_permission_id),
+        Sequel[:super_auth_edges][:group_id].as(:edge_group_id),
+        Sequel[:super_auth_edges][:user_id].as(:edge_user_id),
+        Sequel[:super_auth_edges][:role_id].as(:edge_role_id),
         Sequel[:groups][:group_path],
         Sequel[:groups][:group_name_path],
         Sequel[:groups][:parent_id]

data/lib/super_auth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SuperAuth
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/super_auth.rb

@@ -13,25 +13,29 @@ end
 require 'sequel'
 
 ENV["SUPER_AUTH_LOG_LEVEL"] = 'debug'
-logger = if ENV["SUPER_AUTH_LOG_LEVEL"] == "debug"
-  require 'logger'
-  Logger.new(STDOUT)
-end
+require 'logger'
+logger = Logger.new(STDOUT)
 
-require 'sequel'
 Sequel::Model.plugin :timestamps, update_on_create: true
 if !ENV['SUPER_AUTH_DATABASE_URL'].nil? && !ENV['SUPER_AUTH_DATABASE_URL'].empty?
   Sequel::Model.db = Sequel.connect(ENV['SUPER_AUTH_DATABASE_URL'], logger: logger)
 else
-  puts "Warning: SUPER_AUTH_DATABASE_URL not set, using in memory database"
+  logger.warn "SUPER_AUTH_DATABASE_URL not set, using sqlite in memory database."
   Sequel::Model.db = Sequel.sqlite(logger: logger)
-  Sequel.extension :migration
-  Sequel::Migrator.run(Sequel::Model.db, "db/migrate")
 end
 Sequel::Model.default_association_options = {:class_namespace=>'SuperAuth'}
 
+# I don't love this, but I don't know how to do it better
+unless Sequel::Model.db.table_exists?(:super_auth_edges)
+  Sequel.extension :migration
+  path = Pathname.new(__FILE__).parent.parent.join("db", "migrate")
+  Sequel::Migrator.run(Sequel::Model.db, path)
+end
 require 'basic_loader' unless defined?(SuperAuth::AUTOLOADERS)
 
+
 module SuperAuth
   class Error < StandardError; end
 end
+
+require "super_auth/railtie" if defined?(Rails::Railtie)

data/lib/tasks/super_auth_tasks.rake

@@ -0,0 +1,13 @@
+namespace :super_auth do
+  desc "Run the super_auth database migrations"
+  task migrate: :environment do
+    # TODO: Make this work properly without auto applying migrations, which is silly
+    #
+    # raise "ENV variable SUPER_AUTH_DATABASE_URL is not set" if ENV['SUPER_AUTH_DATABASE_URL'].nil? || ENV['SUPER_AUTH_DATABASE_URL'].empty?
+    # Sequel::Model.db = Sequel.connect(ENV['SUPER_AUTH_DATABASE_URL'])
+    # Sequel.extension :migration
+    # binding.irb
+    # path = Pathname.new(__FILE__).parent.parent.join("db", "migrate")
+    # Sequel::Migrator.run(Sequel::Model.db, path)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jonathan Frias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-30 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -64,10 +64,12 @@ files:
 - lib/super_auth/group.rb
 - lib/super_auth/nestable.rb
 - lib/super_auth/permission.rb
+- lib/super_auth/railtie.rb
 - lib/super_auth/resource.rb
 - lib/super_auth/role.rb
 - lib/super_auth/user.rb
 - lib/super_auth/version.rb
+- lib/tasks/super_auth_tasks.rake
 homepage: https://github.com/JonathanFrias/super_auth
 licenses:
 - MIT
@@ -90,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Make Unauthenticated State Unrepresentable