trust 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/MIT-LICENSE +23 -0
- data/README.md +244 -0
- data/Rakefile +37 -0
- data/lib/tasks/trust_tasks.rake +42 -0
- data/lib/trust/active_record.rb +65 -0
- data/lib/trust/authorization.rb +85 -0
- data/lib/trust/controller/properties.rb +134 -0
- data/lib/trust/controller/resource.rb +306 -0
- data/lib/trust/controller.rb +197 -0
- data/lib/trust/exceptions.rb +45 -0
- data/lib/trust/inheritable_attribute.rb +91 -0
- data/lib/trust/permissions.rb +268 -0
- data/lib/trust/test_helper.rb +56 -0
- data/lib/trust/version.rb +27 -0
- data/lib/trust.rb +39 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/accounts.js +2 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/javascripts/clients.js +2 -0
- data/test/dummy/app/assets/javascripts/users.js +2 -0
- data/test/dummy/app/assets/stylesheets/accounts.css +4 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/assets/stylesheets/clients.css +4 -0
- data/test/dummy/app/assets/stylesheets/scaffold.css +56 -0
- data/test/dummy/app/assets/stylesheets/users.css +4 -0
- data/test/dummy/app/controllers/accounts_controller.rb +100 -0
- data/test/dummy/app/controllers/application_controller.rb +31 -0
- data/test/dummy/app/controllers/clients_controller.rb +107 -0
- data/test/dummy/app/controllers/savings_accounts_controller.rb +27 -0
- data/test/dummy/app/controllers/settlements_controller.rb +26 -0
- data/test/dummy/app/controllers/users_controller.rb +107 -0
- data/test/dummy/app/helpers/accounts_helper.rb +26 -0
- data/test/dummy/app/helpers/application_helper.rb +26 -0
- data/test/dummy/app/helpers/clients_helper.rb +26 -0
- data/test/dummy/app/helpers/users_helper.rb +26 -0
- data/test/dummy/app/models/account/credit.rb +26 -0
- data/test/dummy/app/models/account.rb +35 -0
- data/test/dummy/app/models/client.rb +35 -0
- data/test/dummy/app/models/permissions.rb +68 -0
- data/test/dummy/app/models/savings_account.rb +26 -0
- data/test/dummy/app/models/user.rb +40 -0
- data/test/dummy/app/views/accounts/_form.html.erb +46 -0
- data/test/dummy/app/views/accounts/edit.html.erb +31 -0
- data/test/dummy/app/views/accounts/index.html.erb +48 -0
- data/test/dummy/app/views/accounts/new.html.erb +30 -0
- data/test/dummy/app/views/accounts/show.html.erb +35 -0
- data/test/dummy/app/views/clients/_form.html.erb +46 -0
- data/test/dummy/app/views/clients/edit.html.erb +31 -0
- data/test/dummy/app/views/clients/index.html.erb +48 -0
- data/test/dummy/app/views/clients/new.html.erb +30 -0
- data/test/dummy/app/views/clients/show.html.erb +35 -0
- data/test/dummy/app/views/layouts/application.html.erb +39 -0
- data/test/dummy/app/views/users/_form.html.erb +46 -0
- data/test/dummy/app/views/users/edit.html.erb +31 -0
- data/test/dummy/app/views/users/index.html.erb +48 -0
- data/test/dummy/app/views/users/new.html.erb +30 -0
- data/test/dummy/app/views/users/show.html.erb +35 -0
- data/test/dummy/config/application.rb +56 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +38 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/db/migrate/20120522115011_create_accounts.rb +36 -0
- data/test/dummy/db/migrate/20120522130322_create_users.rb +33 -0
- data/test/dummy/db/migrate/20120523144144_create_clients.rb +34 -0
- data/test/dummy/db/schema.rb +38 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/dummy/test/fixtures/accounts.yml +7 -0
- data/test/dummy/test/fixtures/clients.yml +7 -0
- data/test/dummy/test/fixtures/users.yml +7 -0
- data/test/dummy/test/functional/accounts_controller_test.rb +123 -0
- data/test/dummy/test/functional/clients_controller_test.rb +74 -0
- data/test/dummy/test/functional/users_controller_test.rb +74 -0
- data/test/dummy/test/unit/account_test.rb +31 -0
- data/test/dummy/test/unit/client_test.rb +31 -0
- data/test/dummy/test/unit/helpers/accounts_helper_test.rb +28 -0
- data/test/dummy/test/unit/helpers/clients_helper_test.rb +28 -0
- data/test/dummy/test/unit/helpers/users_helper_test.rb +28 -0
- data/test/dummy/test/unit/permissions_test.rb +171 -0
- data/test/dummy/test/unit/user_test.rb +31 -0
- data/test/test_helper.rb +45 -0
- data/test/trust_test.rb +31 -0
- data/test/unit/trust/active_record_test.rb +56 -0
- data/test/unit/trust/authorization_test.rb +108 -0
- data/test/unit/trust/controller/properties_test.rb +132 -0
- data/test/unit/trust/controller/resource_test.rb +251 -0
- data/test/unit/trust/controller_test.rb +160 -0
- data/test/unit/trust/inheritable_attribute_test.rb +65 -0
- data/test/unit/trust/permissions_test.rb +258 -0
- metadata +280 -0
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
# Copyright (c) 2012 Bingo Entreprenøren AS
|
|
2
|
+
# Copyright (c) 2012 Teknobingo Scandinavia AS
|
|
3
|
+
# Copyright (c) 2012 Knut I. Stenmark
|
|
4
|
+
# Copyright (c) 2012 Patrick Hanevold
|
|
5
|
+
#
|
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
|
7
|
+
# a copy of this software and associated documentation files (the
|
|
8
|
+
# "Software"), to deal in the Software without restriction, including
|
|
9
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
|
10
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
11
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
|
12
|
+
# the following conditions:
|
|
13
|
+
#
|
|
14
|
+
# The above copyright notice and this permission notice shall be
|
|
15
|
+
# included in all copies or substantial portions of the Software.
|
|
16
|
+
#
|
|
17
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
18
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
19
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
20
|
+
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
21
|
+
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
22
|
+
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
23
|
+
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
24
|
+
|
|
25
|
+
module Trust
|
|
26
|
+
class Permissions
|
|
27
|
+
# = Trust::Permissions
|
|
28
|
+
# Permissions should be specified in a separate file in you app/model directory. The file could look like this:
|
|
29
|
+
#
|
|
30
|
+
# module Permissions
|
|
31
|
+
# class Default < Trust::Permissions
|
|
32
|
+
# ...
|
|
33
|
+
# end
|
|
34
|
+
# ...
|
|
35
|
+
# end
|
|
36
|
+
#
|
|
37
|
+
# The above is the minimum required definitions that must exist in you file. <tt>Default</tt> will be used if no classes
|
|
38
|
+
# match the permissions requested, so the <tt>Default</tt> class definition is mandatory.
|
|
39
|
+
#
|
|
40
|
+
# If you want to separate the permissions into separate files that is ok. Then you shoud place these files in the
|
|
41
|
+
# /app/model/permissions directory.
|
|
42
|
+
#
|
|
43
|
+
# === Defining permisions
|
|
44
|
+
#
|
|
45
|
+
# The basic rules is to define classes in the Permissions module that matches your models.
|
|
46
|
+
# Here are some examples:
|
|
47
|
+
# * <tt>Project</tt> should have a matching class <tt>Permissions::Project</tt>
|
|
48
|
+
# * <tt>Account</tt> should have a matching class <tt>Permissions::Account</tt>
|
|
49
|
+
# * <tt>Account:Credit</tt> may have a matching class <tt>Permissions::Account::Credit</tt>, but if its inheriting from
|
|
50
|
+
# <tt>Account</tt> and no special handling is necessary, it is not necessary to create the permissions class.
|
|
51
|
+
#
|
|
52
|
+
# === Using inheritance
|
|
53
|
+
#
|
|
54
|
+
# Inheritance is also fully supported, but should generally follow your own inheritance model
|
|
55
|
+
#
|
|
56
|
+
# module Permissions
|
|
57
|
+
# class Account < Default
|
|
58
|
+
# role :admin, :accountant do
|
|
59
|
+
# ...
|
|
60
|
+
# end
|
|
61
|
+
# end
|
|
62
|
+
# class Account::Credit < Account
|
|
63
|
+
# ...
|
|
64
|
+
# end
|
|
65
|
+
# end
|
|
66
|
+
#
|
|
67
|
+
# === Action aliases
|
|
68
|
+
#
|
|
69
|
+
# You can define aliases for actions. You do this by setting the <tt>action_aliases</tt> attribute on Trust::Permissions class
|
|
70
|
+
# Example:
|
|
71
|
+
# Trust::Permissions.action_aliases = {
|
|
72
|
+
# read: [:index, :show],
|
|
73
|
+
# create: [:create, :new]
|
|
74
|
+
# }
|
|
75
|
+
#
|
|
76
|
+
# Keep in mind that all permissions are expanded upon declaration, so when using the <tt>can?</tt> method you must refer to
|
|
77
|
+
# the actual action and not the alias. The alias will never give a positive permission.
|
|
78
|
+
#
|
|
79
|
+
# === Accessors
|
|
80
|
+
#
|
|
81
|
+
# Accessors that can be used when testing permissions:
|
|
82
|
+
# * <tt>user</tt> - the user currently logged in
|
|
83
|
+
# * <tt>action</tt> - the action request from the controller such as :edit, or the action tested from helper or
|
|
84
|
+
# from the object itself when using <tt>ActiveRecord::can?</tt> is being used.
|
|
85
|
+
# * <tt>subject</tt> - the object that is being tested for permissions. This may be a an existing object, a new object
|
|
86
|
+
# (such as for +:create+ and +:new+ action), or nil if no object has been instantiated.
|
|
87
|
+
# * <tt>parent</tt> - the parent object if in a nested route, specified by +belongs_to+ in the controller.
|
|
88
|
+
# * <tt>klass</tt> - the class of involed in the request. It can be a base class or the real class, depending on
|
|
89
|
+
# your controller design.
|
|
90
|
+
#
|
|
91
|
+
# === Defining your own accessors or instance methods
|
|
92
|
+
#
|
|
93
|
+
# You can easily define your own accessors in the classes. These can be helpful when declaring permissions.
|
|
94
|
+
# Example:
|
|
95
|
+
#
|
|
96
|
+
# class Account < Trust::Permissions
|
|
97
|
+
# role :admin, :accountant do
|
|
98
|
+
# can :update, :unless => :closed?
|
|
99
|
+
# end
|
|
100
|
+
# def closed?
|
|
101
|
+
# subject.closed?
|
|
102
|
+
# end
|
|
103
|
+
# end
|
|
104
|
+
#
|
|
105
|
+
# In the above example closed is testing on the subject to see if it is closed. The permission is referring to
|
|
106
|
+
# this method when evaluated.
|
|
107
|
+
# Keep in mind that you must refer to the +subject+, as you do not access the inctance of the object directly.
|
|
108
|
+
#
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
include InheritableAttribute
|
|
112
|
+
attr_reader :user, :action, :klass, :subject, :parent
|
|
113
|
+
inheritable_attr :permissions
|
|
114
|
+
class_attribute :action_aliases, :instance_writer => false, :instance_reader => false
|
|
115
|
+
self.permissions = {}
|
|
116
|
+
self.action_aliases = {
|
|
117
|
+
read: [:index, :show],
|
|
118
|
+
create: [:create, :new],
|
|
119
|
+
update: [:update, :edit],
|
|
120
|
+
manage: [:index, :show, :create, :new, :update, :edit, :destroy]
|
|
121
|
+
}
|
|
122
|
+
@@can_expressions = 0
|
|
123
|
+
|
|
124
|
+
# initializes the permission object
|
|
125
|
+
# calling the +authorized?+ method on the instance later will test for the authorization.
|
|
126
|
+
# Parameters:
|
|
127
|
+
# <tt>user</tt> - user object, must respond to role_symbols
|
|
128
|
+
# <tt>action</tt> - action, such as :create, :show, etc. Should not be an alias
|
|
129
|
+
# <tt>klass</tt> - the class of the subject.
|
|
130
|
+
# <tt>subject</tt> - the subject tested for authorization
|
|
131
|
+
# <tt>parent</tt> - the parent object, normally declared through belongs_to
|
|
132
|
+
#
|
|
133
|
+
# See Trust::Authorization for more details
|
|
134
|
+
def initialize(user, action, klass, subject, parent)
|
|
135
|
+
@user, @action, @klass, @subject, @parent = user, action, klass, subject, parent
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# returns true if the user is authorized to perform the action
|
|
139
|
+
def authorized?
|
|
140
|
+
authorized = nil
|
|
141
|
+
user && user.role_symbols.each do |role|
|
|
142
|
+
(permissions[role] || {}).each do |act, opt|
|
|
143
|
+
if act == action
|
|
144
|
+
break if (authorized = opt.any? ? eval_expr(opt) : true)
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
break if authorized
|
|
148
|
+
end
|
|
149
|
+
authorized
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
protected
|
|
153
|
+
def eval_expr(options) #:nodoc:
|
|
154
|
+
options.collect do |oper, expr|
|
|
155
|
+
res = case expr
|
|
156
|
+
when Symbol then send(expr)
|
|
157
|
+
when Proc
|
|
158
|
+
if expr.lambda?
|
|
159
|
+
instance_exec &expr
|
|
160
|
+
else
|
|
161
|
+
instance_eval &expr
|
|
162
|
+
end
|
|
163
|
+
else
|
|
164
|
+
expr
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
case oper
|
|
168
|
+
when :if then res
|
|
169
|
+
when :unless then !res
|
|
170
|
+
else
|
|
171
|
+
raise UnsupportedCondition, expr.inspect
|
|
172
|
+
end
|
|
173
|
+
end.all?
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
class << self
|
|
177
|
+
# Assign permissions to one or more roles.
|
|
178
|
+
# You may call role or roles, they are the same function like <tt>role :admin</tt> or <tt>roles :admin, :accountant</tt>
|
|
179
|
+
#
|
|
180
|
+
# There are two ways to call role, with or without block. If you want to set multiple permissions with different conditons
|
|
181
|
+
# then you should use a block.
|
|
182
|
+
#
|
|
183
|
+
# module Permissions
|
|
184
|
+
# class Account < Trust::Permissions
|
|
185
|
+
# role :admin, can(:manage, :audit)
|
|
186
|
+
# end
|
|
187
|
+
# end
|
|
188
|
+
#
|
|
189
|
+
# The above assigns the manage and audit permissions to admin.
|
|
190
|
+
#
|
|
191
|
+
# module Permissions
|
|
192
|
+
# class Account < Trust::Permissions
|
|
193
|
+
# role :admin, :accountant do
|
|
194
|
+
# can :read
|
|
195
|
+
# can :update
|
|
196
|
+
# end
|
|
197
|
+
# end
|
|
198
|
+
# end
|
|
199
|
+
#
|
|
200
|
+
# The above permits admin and accountant to read accounts.
|
|
201
|
+
def role(*roles, &block)
|
|
202
|
+
if block_given?
|
|
203
|
+
if @@can_expressions > 0
|
|
204
|
+
@@can_expressions = 0
|
|
205
|
+
raise RoleAssigmnentMissing
|
|
206
|
+
end
|
|
207
|
+
@perms = []
|
|
208
|
+
@in_role_block = true
|
|
209
|
+
yield
|
|
210
|
+
@in_role_block = false
|
|
211
|
+
perms = @perms
|
|
212
|
+
else
|
|
213
|
+
if @@can_expressions > 1
|
|
214
|
+
@@can_expressions = 0
|
|
215
|
+
raise RoleAssigmnentMissing
|
|
216
|
+
end
|
|
217
|
+
options = roles.extract_options!
|
|
218
|
+
raise ArgumentError, "Must have a block or a can expression" unless perms = options[:can]
|
|
219
|
+
@@can_expressions = 0
|
|
220
|
+
end
|
|
221
|
+
roles.flatten.each do |role|
|
|
222
|
+
self.permissions[role] ||= []
|
|
223
|
+
self.permissions[role] += perms
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
alias :roles :role
|
|
227
|
+
|
|
228
|
+
# Defines permissions
|
|
229
|
+
# action - can be an alias or an actions of some kind
|
|
230
|
+
# options - :if/:unless :symbol or proc that will be called to evaluate an expression
|
|
231
|
+
#
|
|
232
|
+
# module Permissions
|
|
233
|
+
# class Account < Trust::Permissions
|
|
234
|
+
# role :admin, :accountant do
|
|
235
|
+
# can :read
|
|
236
|
+
# can :update, :unless => :closed?
|
|
237
|
+
# end
|
|
238
|
+
# end
|
|
239
|
+
# end
|
|
240
|
+
#
|
|
241
|
+
# The above permits admin and accountant to read accounts, but can update only if the account is not closed.
|
|
242
|
+
# In the example above a method is used to test data on the actual record when testing for permissions.
|
|
243
|
+
def can(*args)
|
|
244
|
+
options = args.extract_options!
|
|
245
|
+
p = expand_aliases(args).collect { |action| [action, options] }
|
|
246
|
+
if @in_role_block
|
|
247
|
+
@perms += p
|
|
248
|
+
else
|
|
249
|
+
@@can_expressions += 1
|
|
250
|
+
return {:can => p }
|
|
251
|
+
end
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
private
|
|
255
|
+
def expand_aliases(actions) #:nodoc:
|
|
256
|
+
expanded = []
|
|
257
|
+
Array.wrap(actions).each do |action|
|
|
258
|
+
if self.action_aliases[action]
|
|
259
|
+
expanded += Array.wrap(self.action_aliases[action])
|
|
260
|
+
else
|
|
261
|
+
expanded << action
|
|
262
|
+
end
|
|
263
|
+
end
|
|
264
|
+
expanded
|
|
265
|
+
end
|
|
266
|
+
end
|
|
267
|
+
end
|
|
268
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Copyright (c) 2012 Bingo Entreprenøren AS
|
|
2
|
+
# Copyright (c) 2012 Teknobingo Scandinavia AS
|
|
3
|
+
# Copyright (c) 2012 Knut I. Stenmark
|
|
4
|
+
# Copyright (c) 2012 Patrick Hanevold
|
|
5
|
+
#
|
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
|
7
|
+
# a copy of this software and associated documentation files (the
|
|
8
|
+
# "Software"), to deal in the Software without restriction, including
|
|
9
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
|
10
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
11
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
|
12
|
+
# the following conditions:
|
|
13
|
+
#
|
|
14
|
+
# The above copyright notice and this permission notice shall be
|
|
15
|
+
# included in all copies or substantial portions of the Software.
|
|
16
|
+
#
|
|
17
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
18
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
19
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
20
|
+
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
21
|
+
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
22
|
+
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
23
|
+
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
24
|
+
|
|
25
|
+
class Trust::ResourceHelper
|
|
26
|
+
attr_accessor :instance, :parent, :instances
|
|
27
|
+
attr_accessor :properties, :params, :action, :instance_params
|
|
28
|
+
attr_accessor :info, :parent_info, :relation
|
|
29
|
+
class << self
|
|
30
|
+
attr_accessor :properties
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
def klass
|
|
34
|
+
instance.class
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def instance_name
|
|
38
|
+
Trust::Controller::Resource::Info.var_name(klass)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def parent_name
|
|
42
|
+
Trust::Controller::Resource::Info.var_name(parent.class)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def instantiated
|
|
46
|
+
instances || instance
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
class ActionView::TestCase
|
|
51
|
+
# allows you to stub resource for helpers
|
|
52
|
+
def resource
|
|
53
|
+
@resource ||= Trust::ResourceHelper.new
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Copyright (c) 2012 Bingo Entreprenøren AS
|
|
2
|
+
# Copyright (c) 2012 Teknobingo Scandinavia AS
|
|
3
|
+
# Copyright (c) 2012 Knut I. Stenmark
|
|
4
|
+
# Copyright (c) 2012 Patrick Hanevold
|
|
5
|
+
#
|
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
|
7
|
+
# a copy of this software and associated documentation files (the
|
|
8
|
+
# "Software"), to deal in the Software without restriction, including
|
|
9
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
|
10
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
11
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
|
12
|
+
# the following conditions:
|
|
13
|
+
#
|
|
14
|
+
# The above copyright notice and this permission notice shall be
|
|
15
|
+
# included in all copies or substantial portions of the Software.
|
|
16
|
+
#
|
|
17
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
18
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
19
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
20
|
+
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
21
|
+
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
22
|
+
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
23
|
+
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
24
|
+
|
|
25
|
+
module Trust
|
|
26
|
+
VERSION = "0.5.0"
|
|
27
|
+
end
|
data/lib/trust.rb
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Copyright (c) 2012 Bingo Entreprenøren AS
|
|
2
|
+
# Copyright (c) 2012 Teknobingo Scandinavia AS
|
|
3
|
+
# Copyright (c) 2012 Knut I. Stenmark
|
|
4
|
+
# Copyright (c) 2012 Patrick Hanevold
|
|
5
|
+
#
|
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
|
7
|
+
# a copy of this software and associated documentation files (the
|
|
8
|
+
# "Software"), to deal in the Software without restriction, including
|
|
9
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
|
10
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
11
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
|
12
|
+
# the following conditions:
|
|
13
|
+
#
|
|
14
|
+
# The above copyright notice and this permission notice shall be
|
|
15
|
+
# included in all copies or substantial portions of the Software.
|
|
16
|
+
#
|
|
17
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
18
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
19
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
20
|
+
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
21
|
+
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
22
|
+
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
23
|
+
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
24
|
+
|
|
25
|
+
require 'trust/exceptions'
|
|
26
|
+
require 'trust/inheritable_attribute'
|
|
27
|
+
module Trust
|
|
28
|
+
autoload :Permissions, 'trust/permissions'
|
|
29
|
+
autoload :Controller, 'trust/controller'
|
|
30
|
+
autoload :Authorization, 'trust/authorization'
|
|
31
|
+
autoload :ActiveRecord, 'trust/active_record'
|
|
32
|
+
end
|
|
33
|
+
require 'trust/controller'
|
|
34
|
+
class ActionController::Base
|
|
35
|
+
include Trust::Controller
|
|
36
|
+
end
|
|
37
|
+
class ActiveRecord::Base
|
|
38
|
+
include Trust::ActiveRecord
|
|
39
|
+
end
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
== Welcome to Rails
|
|
2
|
+
|
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
|
5
|
+
|
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
|
12
|
+
and directing data to the view.
|
|
13
|
+
|
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
|
17
|
+
methods. You can read more about Active Record in
|
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
|
19
|
+
|
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
|
25
|
+
Rails. You can read more about Action Pack in
|
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
== Getting Started
|
|
30
|
+
|
|
31
|
+
1. At the command prompt, create a new Rails application:
|
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
|
33
|
+
|
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
|
36
|
+
|
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
|
39
|
+
|
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
|
41
|
+
the following resources handy:
|
|
42
|
+
|
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
== Debugging Rails
|
|
48
|
+
|
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
|
50
|
+
will help you debug it and get it back on the rails.
|
|
51
|
+
|
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
|
56
|
+
|
|
57
|
+
You can also log your own messages directly into the log file from your code
|
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
|
59
|
+
|
|
60
|
+
class WeblogController < ActionController::Base
|
|
61
|
+
def destroy
|
|
62
|
+
@weblog = Weblog.find(params[:id])
|
|
63
|
+
@weblog.destroy
|
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
The result will be a message in your log file along the lines of:
|
|
69
|
+
|
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
|
71
|
+
|
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
|
73
|
+
|
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
|
75
|
+
several books available online as well:
|
|
76
|
+
|
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
|
79
|
+
|
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
|
81
|
+
programming in general.
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
== Debugger
|
|
85
|
+
|
|
86
|
+
Debugger support is available through the debugger command when you start your
|
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
|
91
|
+
|
|
92
|
+
class WeblogController < ActionController::Base
|
|
93
|
+
def index
|
|
94
|
+
@posts = Post.all
|
|
95
|
+
debugger
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
|
101
|
+
|
|
102
|
+
>> @posts.inspect
|
|
103
|
+
=> "[#<Post:0x14a6be8
|
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
|
105
|
+
#<Post:0x14a6620
|
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
|
108
|
+
=> "hello from a debugger"
|
|
109
|
+
|
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
|
111
|
+
|
|
112
|
+
>> f = @posts.first
|
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
|
114
|
+
>> f.
|
|
115
|
+
Display all 152 possibilities? (y or n)
|
|
116
|
+
|
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
== Console
|
|
121
|
+
|
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
|
126
|
+
without arguments will launch it in the development environment.
|
|
127
|
+
|
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
|
129
|
+
directory.
|
|
130
|
+
|
|
131
|
+
Options:
|
|
132
|
+
|
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
|
134
|
+
made to the database.
|
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
|
137
|
+
|
|
138
|
+
To reload your controllers and models after launching the console run
|
|
139
|
+
<tt>reload!</tt>
|
|
140
|
+
|
|
141
|
+
More information about irb can be found at:
|
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
== dbconsole
|
|
146
|
+
|
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
|
152
|
+
PostgreSQL and SQLite 3.
|
|
153
|
+
|
|
154
|
+
== Description of Contents
|
|
155
|
+
|
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
|
157
|
+
|
|
158
|
+
|-- app
|
|
159
|
+
| |-- assets
|
|
160
|
+
| |-- images
|
|
161
|
+
| |-- javascripts
|
|
162
|
+
| `-- stylesheets
|
|
163
|
+
| |-- controllers
|
|
164
|
+
| |-- helpers
|
|
165
|
+
| |-- mailers
|
|
166
|
+
| |-- models
|
|
167
|
+
| `-- views
|
|
168
|
+
| `-- layouts
|
|
169
|
+
|-- config
|
|
170
|
+
| |-- environments
|
|
171
|
+
| |-- initializers
|
|
172
|
+
| `-- locales
|
|
173
|
+
|-- db
|
|
174
|
+
|-- doc
|
|
175
|
+
|-- lib
|
|
176
|
+
| `-- tasks
|
|
177
|
+
|-- log
|
|
178
|
+
|-- public
|
|
179
|
+
|-- script
|
|
180
|
+
|-- test
|
|
181
|
+
| |-- fixtures
|
|
182
|
+
| |-- functional
|
|
183
|
+
| |-- integration
|
|
184
|
+
| |-- performance
|
|
185
|
+
| `-- unit
|
|
186
|
+
|-- tmp
|
|
187
|
+
| |-- cache
|
|
188
|
+
| |-- pids
|
|
189
|
+
| |-- sessions
|
|
190
|
+
| `-- sockets
|
|
191
|
+
`-- vendor
|
|
192
|
+
|-- assets
|
|
193
|
+
`-- stylesheets
|
|
194
|
+
`-- plugins
|
|
195
|
+
|
|
196
|
+
app
|
|
197
|
+
Holds all the code that's specific to this particular application.
|
|
198
|
+
|
|
199
|
+
app/assets
|
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
|
201
|
+
|
|
202
|
+
app/controllers
|
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
|
204
|
+
automated URL mapping. All controllers should descend from
|
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
|
206
|
+
|
|
207
|
+
app/models
|
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
|
209
|
+
ActiveRecord::Base by default.
|
|
210
|
+
|
|
211
|
+
app/views
|
|
212
|
+
Holds the template files for the view that should be named like
|
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
|
214
|
+
eRuby syntax by default.
|
|
215
|
+
|
|
216
|
+
app/views/layouts
|
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
|
221
|
+
layout.
|
|
222
|
+
|
|
223
|
+
app/helpers
|
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
|
225
|
+
generated for you automatically when using generators for controllers.
|
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
|
227
|
+
|
|
228
|
+
config
|
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
|
230
|
+
and other dependencies.
|
|
231
|
+
|
|
232
|
+
db
|
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
|
234
|
+
sequence of Migrations for your schema.
|
|
235
|
+
|
|
236
|
+
doc
|
|
237
|
+
This directory is where your application documentation will be stored when
|
|
238
|
+
generated using <tt>rake doc:app</tt>
|
|
239
|
+
|
|
240
|
+
lib
|
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
|
243
|
+
the load path.
|
|
244
|
+
|
|
245
|
+
public
|
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
|
248
|
+
server.
|
|
249
|
+
|
|
250
|
+
script
|
|
251
|
+
Helper scripts for automation and generation.
|
|
252
|
+
|
|
253
|
+
test
|
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
|
255
|
+
command, template test files will be generated for you and placed in this
|
|
256
|
+
directory.
|
|
257
|
+
|
|
258
|
+
vendor
|
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
|
261
|
+
vendor/rails/. This directory is in the load path.
|
data/test/dummy/Rakefile
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
#!/usr/bin/env rake
|
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
|
4
|
+
|
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
|
6
|
+
|
|
7
|
+
Dummy::Application.load_tasks
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
|
2
|
+
// listed below.
|
|
3
|
+
//
|
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
|
6
|
+
//
|
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
|
8
|
+
// the compiled file.
|
|
9
|
+
//
|
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
|
12
|
+
//
|
|
13
|
+
//= require jquery
|
|
14
|
+
//= require jquery_ujs
|
|
15
|
+
//= require_tree .
|