Class: HaveAPI::Action

Inherits:
Common
  • Object
show all
Includes:
Hookable
Defined in:
lib/haveapi/action.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Hookable

included

Methods inherited from Common

check_build, has_attr, inherit_attrs

Constructor Details

#initialize(request, version, params, body, context) ⇒ Action

Returns a new instance of Action.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/haveapi/action.rb', line 292

def initialize(request, version, params, body, context)
  super()
  @request = request
  @version = version
  @params = params
  @params.update(body) if body
  @context = context
  @context.action = self.class
  @context.action_instance = self
  @metadata = {}
  @reply_meta = { object: {}, global: {} }
  @flags = {}

  class_auth = self.class.authorization

  @authorization = if class_auth
                     class_auth.clone
                   else
                     Authorization.new {}
                   end

  self.class.add_pre_authorize_blocks(@authorization, @context)
end

Class Attribute Details

.action_name ⇒ Object 



192
193
194
 
# File 'lib/haveapi/action.rb', line 192

def action_name
  (@action_name ? @action_name.to_s : to_s).demodulize
end

.authorization ⇒ Object (readonly)

Returns the value of attribute authorization.



44
45
46
 
# File 'lib/haveapi/action.rb', line 44

def authorization
  @authorization
end

.examples ⇒ Object (readonly)

Returns the value of attribute examples.



44
45
46
 
# File 'lib/haveapi/action.rb', line 44

def examples
  @examples
end

.resource ⇒ Object

Returns the value of attribute resource.



43
44
45
 
# File 'lib/haveapi/action.rb', line 43

def resource
  @resource
end

Instance Attribute Details

#current_user ⇒ Object (readonly)

Returns the value of attribute current_user.



39
40
41
 
# File 'lib/haveapi/action.rb', line 39

def current_user
  @current_user
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



39
40
41
 
# File 'lib/haveapi/action.rb', line 39

def errors
  @errors
end

#flags ⇒ Object

Returns the value of attribute flags.



40
41
42
 
# File 'lib/haveapi/action.rb', line 40

def flags
  @flags
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



39
40
41
 
# File 'lib/haveapi/action.rb', line 39

def message
  @message
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



39
40
41
 
# File 'lib/haveapi/action.rb', line 39

def request
  @request
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



39
40
41
 
# File 'lib/haveapi/action.rb', line 39

def version
  @version
end

Class Method Details

.add_pre_authorize_blocks(authorization, context) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/haveapi/action.rb', line 279

def add_pre_authorize_blocks(authorization, context)
  ret = Action.call_hooks(
    :pre_authorize,
    args: [context],
    initial: { blocks: [] }
  )

  ret[:blocks].reverse_each do |block|
    authorization.prepend_block(block)
  end
end

.authorize ⇒ Object 



181
182
183
 
# File 'lib/haveapi/action.rb', line 181

def authorize(&)
  @authorization = Authorization.new(&)
end

.build_route(prefix) ⇒ Object 



198
199
200
201
202
203
204
205
206
 
# File 'lib/haveapi/action.rb', line 198

def build_route(prefix)
  route = @route || action_name.underscore

  if !route.is_a?(String) && route.respond_to?(:call)
    route = route.call(resource)
  end

  prefix + format(route, resource: resource.resource_name.underscore)
end

.delayed_inherited(subclass) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/haveapi/action.rb', line 57

def delayed_inherited(subclass)
  resource = subclass.resource || Kernel.const_get(subclass.to_s.deconstantize)

  inherit_attrs(subclass)
  inherit_attrs_from_resource(subclass, resource, [:auth])

  i = @input.clone
  i.action = subclass

  o = @output.clone
  o.action = subclass

  m = {}

  @meta.each do |k, v|
    m[k] = v && v.clone
    next unless v

    m[k].action = subclass
  end

  subclass.instance_variable_set(:@input, i)
  subclass.instance_variable_set(:@output, o)
  subclass.instance_variable_set(:@meta, m)

  begin
    subclass.instance_variable_set(:@resource, resource)
    subclass.instance_variable_set(:@model, resource.model)
    resource.action_defined(subclass)
  rescue NoMethodError
    nil
  end
end

.describe(context) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/haveapi/action.rb', line 208

def describe(context)
  authorization = (@authorization && @authorization.clone) || Authorization.new
  add_pre_authorize_blocks(authorization, context)

  if (context.endpoint || context.current_user) \
      && !authorization.authorized?(context.current_user, context.path_params_from_args)
    return false
  end

  route_method = context.action.http_method.to_s.upcase
  context.authorization = authorization

  if context.endpoint
    context.action_instance = context.action.from_context(context)

    ret = catch(:return) do
      context.action_prepare = context.action_instance.prepare
    end

    return false if ret == false
  end

  {
    auth: @auth,
    description: @desc,
    aliases: @aliases,
    blocking: @blocking ? true : false,
    input: @input ? @input.describe(context) : { parameters: {} },
    output: @output ? @output.describe(context) : { parameters: {} },
    meta: @meta ? @meta.merge(@meta) { |_, v| v && v.describe(context) } : nil,
    examples: @examples ? @examples.describe(context) : [],
    scope: context.action_scope,
    path: context.resolved_path,
    method: route_method,
    help: "#{context.path}?method=#{route_method}"
  }
end

.example(title = '') ⇒ Object 



185
186
187
188
189
190
 
# File 'lib/haveapi/action.rb', line 185

def example(title = '', &)
  @examples ||= ExampleList.new
  e = Example.new(title)
  e.instance_eval(&)
  @examples << e
end

.from_context(c) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/haveapi/action.rb', line 259

def from_context(c)
  ret = new(nil, c.version, c.params, nil, c)
  ret.instance_exec do
    @safe_params = @params.dup
    @authorization = c.authorization
    @current_user = c.current_user
  end

  ret
end

.inherit_attrs_from_resource(action, r, attrs) ⇒ Object

Inherit attributes from resource action is defined in.



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/haveapi/action.rb', line 247

def inherit_attrs_from_resource(action, r, attrs)
  begin
    return unless r.obj_type == :resource
  rescue NoMethodError
    return
  end

  attrs.each do |attr|
    action.method(attr).call(r.method(attr).call)
  end
end

.inherited(subclass) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/haveapi/action.rb', line 46

def inherited(subclass)
  # puts "Action.inherited called #{subclass} from #{to_s}"
  super
  subclass.instance_variable_set(:@obj_type, obj_type)

  return unless subclass.name

  # not an anonymouse class
  delayed_inherited(subclass)
end

.initialize ⇒ Object

rubocop:disable Lint/MissingSuper



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/haveapi/action.rb', line 91

def initialize # rubocop:disable Lint/MissingSuper
  return if @initialized

  check_build("#{self}.input") do
    input.exec
    model_adapter(input.layout).load_validators(model, input) if model
  end

  check_build("#{self}.output") do
    output.exec
  end

  model_adapter(input.layout).used_by(:input, self)
  model_adapter(output.layout).used_by(:output, self)

  if blocking
    meta(:global) do
      output do
        integer :action_state_id,
                label: 'Action state ID',
                desc: 'ID of ActionState object for state querying. When null, the action ' \
                      'is not blocking for the current invocation.'
      end
    end
  end

  if @meta
    @meta.each_value do |m|
      next unless m

      check_build("#{self}.meta.input") do
        m.input && m.input.exec
      end

      check_build("#{self}.meta.output") do
        m.output && m.output.exec
      end
    end
  end

  @initialized = true
end

.input(layout = nil, namespace: nil, &block) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/haveapi/action.rb', line 148

def input(layout = nil, namespace: nil, &block)
  if block
    @input ||= Params.new(:input, self)
    @input.layout = layout
    @input.namespace = namespace
    @input.add_block(block)
  else
    @input
  end
end

.meta(type = :object, &block) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/haveapi/action.rb', line 170

def meta(type = :object, &block)
  if block
    @meta ||= { object: nil, global: nil }
    @meta[type] ||= Metadata::ActionMetadata.new
    @meta[type].action = self
    @meta[type].instance_exec(&block)
  else
    @meta[type]
  end
end

.model_adapter(layout) ⇒ Object 



144
145
146
 
# File 'lib/haveapi/action.rb', line 144

def model_adapter(layout)
  ModelAdapter.for(layout, resource.model)
end

.output(layout = nil, namespace: nil, &block) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/haveapi/action.rb', line 159

def output(layout = nil, namespace: nil, &block)
  if block
    @output ||= Params.new(:output, self)
    @output.layout = layout
    @output.namespace = namespace
    @output.add_block(block)
  else
    @output
  end
end

.resolve_path_params(object) ⇒ Object 



270
271
272
273
274
275
276
277
 
# File 'lib/haveapi/action.rb', line 270

def resolve_path_params(object)
  if resolve
    resolve.call(object)

  else
    object.respond_to?(:id) ? object.id : nil
  end
end

.validate_build ⇒ Object 



134
135
136
137
138
139
140
141
142
 
# File 'lib/haveapi/action.rb', line 134

def validate_build
  check_build("#{self}.input") do
    input.validate_build
  end

  check_build("#{self}.output") do
    output.validate_build
  end
end

Instance Method Details

#authorized?(user) ⇒ Boolean

Returns:



322
323
324
325
 
# File 'lib/haveapi/action.rb', line 322

def authorized?(user)
  @current_user = user
  @authorization.authorized?(user, extract_path_params)
end

#exec ⇒ Object

This method must be reimplemented in every action. It must not be invoked directly, only via safe_exec, which restricts output.



356
357
358
 
# File 'lib/haveapi/action.rb', line 356

def exec
  ['not implemented']
end

#input ⇒ Object 



331
332
333
 
# File 'lib/haveapi/action.rb', line 331

def input
  @safe_params[self.class.input.namespace] if self.class.input
end

#meta ⇒ Object 



335
336
337
 
# File 'lib/haveapi/action.rb', line 335

def meta
  @metadata
end

#params ⇒ Object 



327
328
329
 
# File 'lib/haveapi/action.rb', line 327

def params
  @safe_params
end

#pre_exec ⇒ Object 



352
 
# File 'lib/haveapi/action.rb', line 352

def pre_exec; end

#prepare ⇒ Object

Prepare object, set instance variables from URL parameters. This method should return queried object. If the method is not implemented or returns nil, action description will not contain link to an associated resource. – FIXME: is this correct behaviour? ++



350
 
# File 'lib/haveapi/action.rb', line 350

def prepare; end

#safe_exec ⇒ Object

Calls exec while catching all exceptions and restricting output only to what user can see. Return array [status, data|error, errors]



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/haveapi/action.rb', line 363

def safe_exec
  exec_ret = catch(:return) do
    validate!
    prepare
    pre_exec
    exec
  rescue Exception => e # rubocop:disable Lint/RescueException
    tmp = call_class_hooks_as_for(Action, :exec_exception, args: [@context, e])

    if tmp.empty?
      p e.message
      puts e.backtrace
      error!('Server error occurred')
    end

    unless tmp[:status]
      error!(tmp[:message], {}, http_status: tmp[:http_status] || 500)
    end
  end

  begin
    output_ret = safe_output(exec_ret)
  rescue Exception => e # rubocop:disable Lint/RescueException
    tmp = call_class_hooks_as_for(Action, :exec_exception, args: [@context, e])

    p e.message
    puts e.backtrace

    return [
      tmp[:status] || false,
      tmp[:message] || 'Server error occurred',
      {},
      tmp[:http_status] || 500
    ]
  end

  output_ret
end

#safe_output(ret) ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/haveapi/action.rb', line 406

def safe_output(ret)
  if ret
    output = self.class.output

    if output
      safe_ret = nil
      adapter = self.class.model_adapter(output.layout)
      out_params = self.class.output.params

      case output.layout
      when :object
        out = adapter.output(@context, ret)
        safe_ret = @authorization.filter_output(
          out_params,
          out,
          true
        )
        @reply_meta[:global].update(out.meta)

      when :object_list
        safe_ret = []

        ret.each do |obj|
          out = adapter.output(@context, obj)

          safe_ret << @authorization.filter_output(
            out_params,
            out,
            true
          )
          safe_ret.last.update({ Metadata.namespace => out.meta }) unless meta[:no]
        end

      when :hash
        safe_ret = @authorization.filter_output(
          out_params,
          adapter.output(@context, ret),
          true
        )

      when :hash_list
        safe_ret = ret
        safe_ret.map! do |hash|
          @authorization.filter_output(
            out_params,
            adapter.output(@context, hash),
            true
          )
        end

      else
        safe_ret = ret
      end

      if self.class.blocking
        @reply_meta[:global][:action_state_id] = state_id
      end

      ns = { output.namespace => safe_ret }
      ns[Metadata.namespace] = @reply_meta[:global] unless meta[:no]

      [true, ns]

    else
      [true, {}]
    end

  else
    [false, @message, @errors, @http_status]
  end
end

#set_meta(hash) ⇒ Object 



339
340
341
 
# File 'lib/haveapi/action.rb', line 339

def set_meta(hash)
  @reply_meta[:global].update(hash)
end

#v?(v) ⇒ Boolean

Returns:



402
403
404
 
# File 'lib/haveapi/action.rb', line 402

def v?(v)
  @version == v
end

#validate! ⇒ Object 



316
317
318
319
320
 
# File 'lib/haveapi/action.rb', line 316

def validate!
  @params = validate
rescue ValidationError => e
  error!(e.message, e.to_hash)
end