ruolo 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.editorconfig +9 -0
- data/.gitignore +3 -0
- data/.rubocop.yml +3 -0
- data/CHANGELOG.md +8 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +169 -0
- data/bin/console +102 -0
- data/lib/ruolo.rb +29 -0
- data/lib/ruolo/configuration.rb +12 -0
- data/lib/ruolo/models.rb +5 -0
- data/lib/ruolo/models/permission.rb +12 -0
- data/lib/ruolo/models/role.rb +15 -0
- data/lib/ruolo/models/user.rb +11 -0
- data/lib/ruolo/sync.rb +80 -0
- data/lib/ruolo/version.rb +5 -0
- data/ruolo.gemspec +30 -0
- metadata +132 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a4ddd82aec0b34aaba1ffc7f9346ed7a3ebc7245f33effbf8584c2abfbfdec5e
|
4
|
+
data.tar.gz: ebbe414e57fc32ffe9d1ea70d26f6038bae6cf5c6592a39e1b79de38f6486582
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6bd9d5461e167c508d9a656a049a6ae8fdd10cc53056aa5dd9bc0de644b1f7be28f57c8f89033cf4f4553e925127b4d51a6158fa4ed21b1b7f9096bf7a7c75d2
|
7
|
+
data.tar.gz: 50d82bbbe3d6f8a41bb65c49865fbd48059ac8d4b4a386606059d255cd31f0ea0130a0128419307f9d186659fda503dd270c24fd8d349ef3df93bd3277e7861e
|
data/.editorconfig
ADDED
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
data/CHANGELOG.md
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,169 @@
|
|
1
|
+
# Ruolo
|
2
|
+
|
3
|
+
A library for generating and keeping your static role-based access-control
|
4
|
+
policies in sync with your database using the
|
5
|
+
[sequel](https://github.com/jeremyevans/sequel) gem.
|
6
|
+
|
7
|
+
You're an application developer and know all of the permissions and roles that
|
8
|
+
you want to create - you want to create them in code and have them persist to
|
9
|
+
the database (and stay in sync should you add/change/remove something). This
|
10
|
+
is what `ruolo` can help with: define your RBAC policies using a DSL and run
|
11
|
+
the sync on application start up. You're responsible for both the authentication
|
12
|
+
and authorization of users after that, `ruolo` is completely unopinionated.
|
13
|
+
|
14
|
+
## Usage
|
15
|
+
|
16
|
+
### Migrations
|
17
|
+
|
18
|
+
You'll need to run the following database migration to setup your schema, fill
|
19
|
+
in the `users` table with your own details:
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
Sequel.migration do
|
23
|
+
change do
|
24
|
+
create_table :users do
|
25
|
+
primary_key :id, type: :Bignum
|
26
|
+
|
27
|
+
column :email, String, null: false, size: 190, unique: true
|
28
|
+
column :password, String, null: false, size: 60, fixed: true
|
29
|
+
|
30
|
+
column :first_name, String, null: false
|
31
|
+
column :last_name, String, null: false
|
32
|
+
|
33
|
+
column :created_at, DateTime, null: false
|
34
|
+
column :updated_at, DateTime, null: false
|
35
|
+
|
36
|
+
constraint(:valid_email, email: /@/)
|
37
|
+
end
|
38
|
+
|
39
|
+
create_table :roles do
|
40
|
+
primary_key :id, type: :Bignum
|
41
|
+
|
42
|
+
column :name, String, null: false, size: 150, unique: true
|
43
|
+
column :description, String
|
44
|
+
|
45
|
+
column :created_at, DateTime, null: false
|
46
|
+
column :updated_at, DateTime, null: false
|
47
|
+
|
48
|
+
constraint(:valid_name, name: /^[A-Z]([A-Z0-9]*[\-\._]?)*$/)
|
49
|
+
end
|
50
|
+
|
51
|
+
create_table :permissions do
|
52
|
+
primary_key :id, type: :Bignum
|
53
|
+
|
54
|
+
column :name, String, null: false, size: 150, unique: true
|
55
|
+
column :description, String
|
56
|
+
|
57
|
+
column :created_at, DateTime, null: false
|
58
|
+
column :updated_at, DateTime, null: false
|
59
|
+
|
60
|
+
constraint(:valid_name, name: /^[A-Z]([A-Z0-9]*[\-\._]?)*$/)
|
61
|
+
end
|
62
|
+
|
63
|
+
create_table :users_roles do
|
64
|
+
foreign_key :user_id, :users, null: false, type: :Bignum,
|
65
|
+
on_update: :cascade, on_delete: :cascade
|
66
|
+
foreign_key :role_id, :roles, null: false, type: :Bignum,
|
67
|
+
on_update: :cascade, on_delete: :cascade
|
68
|
+
primary_key %i[user_id role_id]
|
69
|
+
index %i[role_id user_id]
|
70
|
+
end
|
71
|
+
|
72
|
+
create_table :roles_permissions do
|
73
|
+
foreign_key :role_id, :roles, null: false, type: :Bignum,
|
74
|
+
on_update: :cascade, on_delete: :cascade
|
75
|
+
foreign_key :permission_id, :permissions, null: false, type: :Bignum,
|
76
|
+
on_update: :cascade, on_delete: :cascade
|
77
|
+
primary_key %i[role_id permission_id]
|
78
|
+
index %i[permission_id role_id]
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
### User Class
|
85
|
+
|
86
|
+
You'll need to set your `User` class to use the correct association class, and
|
87
|
+
configure `ruolo` to use the correct user class (you can also include the
|
88
|
+
ruolo user module for the `permission?` mixin helper):
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
Ruolo.configure do |c|
|
92
|
+
c.user_class = 'YourApp::User'
|
93
|
+
end
|
94
|
+
|
95
|
+
module YourApp
|
96
|
+
class User < Sequel::Model
|
97
|
+
include Ruolo::Models::User
|
98
|
+
many_to_many :roles, join_table: :users_roles, class: 'Ruolo::Models::Role'
|
99
|
+
end
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
### Policy
|
104
|
+
|
105
|
+
To create your static permissions and roles create a yaml file with the
|
106
|
+
following format, the permission list is derived from the permissions that are
|
107
|
+
defined for the roles:
|
108
|
+
|
109
|
+
```yaml
|
110
|
+
---
|
111
|
+
roles:
|
112
|
+
POST_ADMIN:
|
113
|
+
- CREATE_POST
|
114
|
+
- DELETE_POST
|
115
|
+
POST_CREATOR:
|
116
|
+
- CREATE_POST
|
117
|
+
```
|
118
|
+
|
119
|
+
### Sync
|
120
|
+
|
121
|
+
After adding the migrations, configuring ruolo and your custom user class, and
|
122
|
+
defining your RBAC policy, run the sync during your application startup:
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
require 'sequel'
|
126
|
+
require 'ruolo'
|
127
|
+
|
128
|
+
DB = Sequel.connect('...')
|
129
|
+
|
130
|
+
Ruolo.configure do |config|
|
131
|
+
config.connection = DB
|
132
|
+
end
|
133
|
+
|
134
|
+
Ruolo.sync!('./path/to/policy.yml')
|
135
|
+
```
|
136
|
+
|
137
|
+
## Gem Development
|
138
|
+
|
139
|
+
To hack on the gem you'll need PostgreSQL installed and running, then create a
|
140
|
+
user and database:
|
141
|
+
|
142
|
+
```shell
|
143
|
+
$ createuser ruolo
|
144
|
+
$ createdb ruolo
|
145
|
+
```
|
146
|
+
|
147
|
+
Then you can ensure everything was created correctly:
|
148
|
+
|
149
|
+
```shell
|
150
|
+
$ psql -U ruolo
|
151
|
+
```
|
152
|
+
|
153
|
+
## License
|
154
|
+
|
155
|
+
```
|
156
|
+
Copyright 2019 Mario Finelli
|
157
|
+
|
158
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
159
|
+
you may not use this file except in compliance with the License.
|
160
|
+
You may obtain a copy of the License at
|
161
|
+
|
162
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
163
|
+
|
164
|
+
Unless required by applicable law or agreed to in writing, software
|
165
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
166
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
167
|
+
See the License for the specific language governing permissions and
|
168
|
+
limitations under the License.
|
169
|
+
```
|
data/bin/console
ADDED
@@ -0,0 +1,102 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require 'logger'
|
5
|
+
log = Logger.new($stdout)
|
6
|
+
|
7
|
+
require 'sequel'
|
8
|
+
DB = Sequel.connect('postgres://ruolo@localhost/ruolo')
|
9
|
+
|
10
|
+
DB.loggers << log
|
11
|
+
|
12
|
+
begin
|
13
|
+
DB.create_table :users do
|
14
|
+
primary_key :id, type: :Bignum
|
15
|
+
|
16
|
+
column :email, String, null: false, size: 190, unique: true
|
17
|
+
column :password, String, null: false, size: 60, fixed: true
|
18
|
+
|
19
|
+
column :first_name, String, null: false
|
20
|
+
column :last_name, String, null: false
|
21
|
+
|
22
|
+
column :created_at, DateTime, null: false
|
23
|
+
column :updated_at, DateTime, null: false
|
24
|
+
|
25
|
+
constraint(:valid_email, email: /@/)
|
26
|
+
end
|
27
|
+
rescue Sequel::DatabaseError
|
28
|
+
puts 'users table already exists'
|
29
|
+
end
|
30
|
+
|
31
|
+
begin
|
32
|
+
DB.create_table :roles do
|
33
|
+
primary_key :id, type: :Bignum
|
34
|
+
|
35
|
+
column :name, String, null: false, size: 150, unique: true
|
36
|
+
column :description, String
|
37
|
+
|
38
|
+
column :created_at, DateTime, null: false
|
39
|
+
column :updated_at, DateTime, null: false
|
40
|
+
|
41
|
+
constraint(:valid_name, name: /^[A-Z]([A-Z0-9]*[\-\._]?)*$/)
|
42
|
+
end
|
43
|
+
rescue Sequel::DatabaseError
|
44
|
+
puts 'roles table already exists'
|
45
|
+
end
|
46
|
+
|
47
|
+
begin
|
48
|
+
DB.create_table :permissions do
|
49
|
+
primary_key :id, type: :Bignum
|
50
|
+
|
51
|
+
column :name, String, null: false, size: 150, unique: true
|
52
|
+
column :description, String
|
53
|
+
|
54
|
+
column :created_at, DateTime, null: false
|
55
|
+
column :updated_at, DateTime, null: false
|
56
|
+
|
57
|
+
constraint(:valid_name, name: /^[A-Z]([A-Z0-9]*[\-\._]?)*$/)
|
58
|
+
end
|
59
|
+
rescue Sequel::DatabaseError
|
60
|
+
puts 'permissions table already exists'
|
61
|
+
end
|
62
|
+
|
63
|
+
begin
|
64
|
+
DB.create_table :users_roles do
|
65
|
+
foreign_key :user_id, :users, null: false, type: :Bignum,
|
66
|
+
on_update: :cascade, on_delete: :cascade
|
67
|
+
foreign_key :role_id, :roles, null: false, type: :Bignum,
|
68
|
+
on_update: :cascade, on_delete: :cascade
|
69
|
+
primary_key %i[user_id role_id]
|
70
|
+
index %i[role_id user_id]
|
71
|
+
end
|
72
|
+
rescue Sequel::DatabaseError
|
73
|
+
puts 'users/roles table already exists'
|
74
|
+
end
|
75
|
+
|
76
|
+
begin
|
77
|
+
DB.create_table :roles_permissions do
|
78
|
+
foreign_key :role_id, :roles, null: false, type: :Bignum,
|
79
|
+
on_update: :cascade, on_delete: :cascade
|
80
|
+
foreign_key :permission_id, :permissions, null: false, type: :Bignum,
|
81
|
+
on_update: :cascade, on_delete: :cascade
|
82
|
+
primary_key %i[role_id permission_id]
|
83
|
+
index %i[permission_id role_id]
|
84
|
+
end
|
85
|
+
rescue Sequel::DatabaseError
|
86
|
+
puts 'roles/permissions table already exists'
|
87
|
+
end
|
88
|
+
|
89
|
+
require 'ruolo'
|
90
|
+
|
91
|
+
Ruolo.configure do |config|
|
92
|
+
config.connection = DB
|
93
|
+
end
|
94
|
+
|
95
|
+
class User < Sequel::Model
|
96
|
+
include Ruolo::Models::User
|
97
|
+
plugin :timestamps, update_on_create: true
|
98
|
+
many_to_many :roles, join_table: :users_roles, class: 'Ruolo::Models::Role'
|
99
|
+
end
|
100
|
+
|
101
|
+
require 'pry'
|
102
|
+
Pry.start
|
data/lib/ruolo.rb
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'ruolo/configuration'
|
4
|
+
require 'ruolo/version'
|
5
|
+
|
6
|
+
module Ruolo
|
7
|
+
class << self
|
8
|
+
attr_writer :configuration
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.configuration
|
12
|
+
@configuration ||= Ruolo::Configuration.new
|
13
|
+
end
|
14
|
+
|
15
|
+
def self.reset
|
16
|
+
@configuration = Ruolo::Configuration.new
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.configure
|
20
|
+
yield(configuration)
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.sync!(policy_file)
|
24
|
+
Ruolo::Sync.new(policy_file).sync!
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
require 'ruolo/models'
|
29
|
+
require 'ruolo/sync'
|
data/lib/ruolo/models.rb
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'sequel'
|
4
|
+
|
5
|
+
require 'ruolo/configuration'
|
6
|
+
|
7
|
+
module Ruolo
|
8
|
+
module Models
|
9
|
+
class Role < Sequel::Model
|
10
|
+
plugin :timestamps, update_on_create: true
|
11
|
+
many_to_many :permissions, join_table: :roles_permissions
|
12
|
+
many_to_many :users, join_table: :users_roles, class: Ruolo.configuration.user_class
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
data/lib/ruolo/sync.rb
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'yaml'
|
4
|
+
|
5
|
+
require 'ruolo/configuration'
|
6
|
+
require 'ruolo/models'
|
7
|
+
|
8
|
+
module Ruolo
|
9
|
+
class Sync
|
10
|
+
def initialize(policy_file)
|
11
|
+
@policy_document = YAML.safe_load(File.read(policy_file), symbolize_names: true)
|
12
|
+
end
|
13
|
+
|
14
|
+
def sync!
|
15
|
+
Ruolo.configuration.connection.transaction do
|
16
|
+
permissions_diff
|
17
|
+
roles_diff
|
18
|
+
roles_permissions_diff
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
private
|
23
|
+
|
24
|
+
def permissions_from_policy
|
25
|
+
@policy_document[:roles].map { |_role, permissions| permissions }.flatten.uniq
|
26
|
+
end
|
27
|
+
|
28
|
+
def roles_from_policy
|
29
|
+
@policy_document[:roles].map { |role, _permissions| role.to_s }
|
30
|
+
end
|
31
|
+
|
32
|
+
def permissions_diff
|
33
|
+
permissions = Ruolo::Models::Permission.all
|
34
|
+
policy = permissions_from_policy
|
35
|
+
|
36
|
+
remove = permissions.reject { |perm| policy.include?(perm.name) }
|
37
|
+
add = policy.reject { |pol| permissions.map(&:name).include?(pol) }
|
38
|
+
|
39
|
+
remove.each(&:destroy)
|
40
|
+
|
41
|
+
add.each do |permission|
|
42
|
+
Ruolo::Models::Permission.create(name: permission)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
def roles_diff
|
47
|
+
roles = Ruolo::Models::Role.all
|
48
|
+
policy = roles_from_policy
|
49
|
+
|
50
|
+
remove = roles.reject { |role| policy.include?(role.name) }
|
51
|
+
add = policy.reject { |pol| roles.map(&:name).include?(pol) }
|
52
|
+
|
53
|
+
remove.each(&:destroy)
|
54
|
+
|
55
|
+
add.each do |role|
|
56
|
+
Ruolo::Models::Role.create(name: role)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
def roles_permissions_diff
|
61
|
+
roles = Ruolo::Models::Role.eager_graph(:permissions).all
|
62
|
+
|
63
|
+
# at this point we should _only_ have the actual roles in the database
|
64
|
+
roles.each do |role|
|
65
|
+
policy = @policy_document[:roles][role.name.to_sym]
|
66
|
+
|
67
|
+
remove = role.permissions.reject { |perm| policy.include?(perm.name) }
|
68
|
+
add = policy.reject { |pol| role.permissions.map(&:name).include?(pol) }
|
69
|
+
|
70
|
+
remove.each do |permission|
|
71
|
+
role.remove_permission permission
|
72
|
+
end
|
73
|
+
|
74
|
+
add.each do |permission|
|
75
|
+
role.add_permission Ruolo::Models::Permission.where(name: permission).first
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
data/ruolo.gemspec
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require 'ruolo/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = 'ruolo'
|
9
|
+
spec.version = Ruolo::VERSION
|
10
|
+
spec.authors = ['Mario Finelli']
|
11
|
+
spec.email = ['mario@finel.li']
|
12
|
+
|
13
|
+
spec.summary = 'A library to keep your static role-based access control policies in sync with your database.'
|
14
|
+
spec.description = 'A library to keep your static role-based access control policies in sync with your database.'
|
15
|
+
spec.homepage = 'https://github.com/mfinelli/ruolo'
|
16
|
+
spec.license = 'Apache-2.0'
|
17
|
+
|
18
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
19
|
+
f.match(%r{^(test|spec|features)/})
|
20
|
+
end
|
21
|
+
|
22
|
+
spec.require_paths = ['lib']
|
23
|
+
|
24
|
+
spec.add_dependency 'sequel', '~> 5.0'
|
25
|
+
|
26
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
27
|
+
spec.add_development_dependency 'pg'
|
28
|
+
spec.add_development_dependency 'pry'
|
29
|
+
spec.add_development_dependency 'rubocop'
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,132 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: ruolo
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Mario Finelli
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-08-26 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: sequel
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '5.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '5.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: pg
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: pry
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rubocop
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: A library to keep your static role-based access control policies in sync
|
84
|
+
with your database.
|
85
|
+
email:
|
86
|
+
- mario@finel.li
|
87
|
+
executables: []
|
88
|
+
extensions: []
|
89
|
+
extra_rdoc_files: []
|
90
|
+
files:
|
91
|
+
- ".editorconfig"
|
92
|
+
- ".gitignore"
|
93
|
+
- ".rubocop.yml"
|
94
|
+
- CHANGELOG.md
|
95
|
+
- Gemfile
|
96
|
+
- LICENSE
|
97
|
+
- README.md
|
98
|
+
- bin/console
|
99
|
+
- lib/ruolo.rb
|
100
|
+
- lib/ruolo/configuration.rb
|
101
|
+
- lib/ruolo/models.rb
|
102
|
+
- lib/ruolo/models/permission.rb
|
103
|
+
- lib/ruolo/models/role.rb
|
104
|
+
- lib/ruolo/models/user.rb
|
105
|
+
- lib/ruolo/sync.rb
|
106
|
+
- lib/ruolo/version.rb
|
107
|
+
- ruolo.gemspec
|
108
|
+
homepage: https://github.com/mfinelli/ruolo
|
109
|
+
licenses:
|
110
|
+
- Apache-2.0
|
111
|
+
metadata: {}
|
112
|
+
post_install_message:
|
113
|
+
rdoc_options: []
|
114
|
+
require_paths:
|
115
|
+
- lib
|
116
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
117
|
+
requirements:
|
118
|
+
- - ">="
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '0'
|
121
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
122
|
+
requirements:
|
123
|
+
- - ">="
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '0'
|
126
|
+
requirements: []
|
127
|
+
rubygems_version: 3.0.3
|
128
|
+
signing_key:
|
129
|
+
specification_version: 4
|
130
|
+
summary: A library to keep your static role-based access control policies in sync
|
131
|
+
with your database.
|
132
|
+
test_files: []
|