Class: Foobara::CommandConnector

Inherits:
Object
  • Object
show all
Includes:
Concerns::Desugarizers, Concerns::Reflection
Defined in:
foobara-0.6.1/projects/command_connectors/src/authenticator.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector.rb,
foobara-0.6.1/projects/command_connectors/src/authenticator_selector.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/request.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/response.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/commands/ping.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/unknown_error.rb,
foobara-0.6.1/projects/entities_plumbing/src/extensions/authenticator_methods.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/not_found_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/commands/describe.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/not_allowed_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/concerns/reflection.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/no_type_found_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/concerns/desugarizers.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/invalid_context_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/unauthenticated_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/commands/list_commands.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/no_command_found_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/command_connector_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/no_allowed_rule_given_error.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/commands/query_git_commit_info.rb,
foobara-0.6.1/projects/command_connectors/src/command_connector/no_command_or_type_found_error.rb

Defined Under Namespace

Modules: AuthenticatorMethods, Commands, Concerns Classes: AlreadyConnectedError, Authenticator, AuthenticatorSelector, CommandConnectorError, InvalidContextError, NoAllowedRuleGivenError, NoAuthenticatorGivenError, NoCommandFoundError, NoCommandOrTypeFoundError, NoTypeFoundError, NotAllowedError, NotFoundError, Request, Response, UnauthenticatedError, UnexpectedSensitiveTypeInManifestError, UnknownError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::Reflection

#all_exposed_type_names, #foobara_manifest

Methods included from Concern

foobara_class_methods_module_for, foobara_concern?, included

Constructor Details

#initialize(name: nil, authenticator: nil, capture_unknown_error: nil, default_serializers: nil, default_pre_commit_transformers: nil, auth_map: nil, current_user: nil, requires_allowed_rule: false, allowed_rules: nil, allow: nil, &block) ⇒ CommandConnector

Returns a new instance of CommandConnector.



196
197
198
199
200
201
202
203
204
205
206
207
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
245
246
247
248
249
 
# File 'projects/command_connectors/src/command_connector.rb', line 196

def initialize(name: nil,
               authenticator: nil,
               capture_unknown_error: nil,
               default_serializers: nil,
               default_pre_commit_transformers: nil,
               auth_map: nil,
               current_user: nil,
               # TODO: let's default this to true
               requires_allowed_rule: false,
               allowed_rules: nil,
               allow: nil,
               &block)
  authenticator = self.class.to_authenticator(authenticator)

  if current_user
    auth_map ||= {}
    auth_map[:current_user] = current_user
  end

  if auth_map
    self.auth_map = auth_map.transform_values do |mapper|
      self.class.to_auth_user_mapper(mapper)
    end
  end

  self.authenticator = authenticator
  self.command_registry = CommandRegistry.new(authenticator:)
  allowed_rules&.each_pair { |symbol, rule| register_allowed_rule(symbol, rule) }
  self.allow allow if allow

  self.capture_unknown_error = capture_unknown_error
  self.name = name

  Util.array(default_serializers).each do |serializer|
    add_default_serializer(serializer)
  end

  if requires_allowed_rule
    self.requires_allowed_rule = requires_allowed_rule
    register_allowed_rule(CommandConnector.always_allowed_rule)
  end

  Util.array(default_pre_commit_transformers).each do |pre_commit_transformer|
    add_default_pre_commit_transformer(pre_commit_transformer)
  end

  self.class.allowed_rules_to_register.each do |ruleish_args|
    command_registry.allowed_rule(*ruleish_args)
  end

  if block
    instance_eval(&block)
  end
end

Instance Attribute Details

#auth_map ⇒ Object

Returns the value of attribute auth_map.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def auth_map
  @auth_map
end

#authenticator ⇒ Object

Returns the value of attribute authenticator.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def authenticator
  @authenticator
end

#capture_unknown_error ⇒ Object

Returns the value of attribute capture_unknown_error.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def capture_unknown_error
  @capture_unknown_error
end

#command_registry ⇒ Object

Returns the value of attribute command_registry.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def command_registry
  @command_registry
end

#name ⇒ Object

Returns the value of attribute name.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def name
  @name
end

#requires_allowed_rule ⇒ Object

Returns the value of attribute requires_allowed_rule.



193
194
195
 
# File 'projects/command_connectors/src/command_connector.rb', line 193

def requires_allowed_rule
  @requires_allowed_rule
end

Class Method Details

.allowed_rules_to_register ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'projects/command_connectors/src/command_connector.rb', line 15

def allowed_rules_to_register
  return @allowed_rules_to_register if defined?(@allowed_rules_to_register)

  @allowed_rules_to_register = if superclass == Object
                                 []
                               else
                                 superclass.allowed_rules_to_register.dup
                               end
end

.always_allowed_rule ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'projects/command_connectors/src/command_connector.rb', line 183

def always_allowed_rule
  # maybe move AllowedRule to CommandConnector:: instead of
  # CommandRegistry:: which is more of an implementation detail?
  @always_allowed_rule ||= CommandRegistry::AllowedRule.new(
    symbol: :always,
    explanation: "This always passes. Used to override allowed_rule_missing."
  ) { true }
end

.authenticator_registry ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'projects/command_connectors/src/command_connector.rb', line 29

def authenticator_registry
  return @authenticator_registry if defined?(@authenticator_registry)

  @authenticator_registry = if superclass == Object
                              {}
                            else
                              superclass.authenticator_registry.dup
                            end
end

.build_auth_mapper(to_type) ⇒ Object

TODO: make private



179
180
181
 
# File 'projects/command_connectors/src/command_connector.rb', line 179

def build_auth_mapper(to_type, &)
  TypeDeclarations::TypedTransformer.subclass(to: to_type, &).instance
end

.find_builtin_command_class(command_class_name) ⇒ Object 



11
12
13
 
# File 'projects/command_connectors/src/command_connector.rb', line 11

def find_builtin_command_class(command_class_name)
  Util.find_constant_through_class_hierarchy(self, "Commands::#{command_class_name}")
end

.register_allowed_rule(*rule_args) ⇒ Object 



25
26
27
 
# File 'projects/command_connectors/src/command_connector.rb', line 25

def register_allowed_rule(*rule_args)
  allowed_rules_to_register << rule_args
end

.register_authenticator(*authenticatorish_args) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'projects/command_connectors/src/command_connector.rb', line 39

def register_authenticator(*authenticatorish_args)
  authenticator = to_authenticator(*authenticatorish_args)

  unless authenticator.symbol
    # simplecov:disable
    raise ArgumentError, "Expected authenticator to have a symbol"
    # simplecov:enable
  end

  authenticator_registry[authenticator.symbol] = authenticator
end

.to_auth_user_mapper(object) ⇒ Object

don't call this auth_user ?



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'projects/command_connectors/src/command_connector.rb', line 122

def to_auth_user_mapper(object)
  case object
  when TypeDeclarations::TypedTransformer
    object
  when ::Class
    if object < TypeDeclarations::TypedTransformer
      object.instance
    elsif object < Foobara::DomainMapper
      build_auth_mapper(object.to_type) { |authenticated_user| object.map!(authenticated_user) }
    elsif object < Foobara::Command
      inputs_type = object.inputs_type
      element_types = inputs_type.element_types
      size = element_types.size

      first_required_input = if size == 1
                               element_types.keys[0]
                             elsif size > 1
                               declaration = inputs_type&.declaration_data
                               required_attribute_names = declaration&.[](:required) || EMPTY_ARRAY

                               if required_attribute_names.size == 1
                                 required_attribute_names[0]
                               else
                                 # simplecov:disable
                                 raise ArgumentError,
                                       "Ambiguous inputs when trying to use #{object} as a mapper. " \
                                       "Should have either only 1 input or only 1 required input."
                                 # simplecov:enable
                               end
                             else
                               # simplecov:disable
                               raise ArgumentError, "To use a command as a mapper it must take an input to map"
                               # simplecov:enable
                             end

      build_auth_mapper(object.result_type) do |authenticated_user|
        object.run!(first_required_input => authenticated_user)
      end
    else
      # simplecov:disable
      raise ArgumentError, "not sure how to convert a #{object} to an auth mapper"
      # simplecov:enable
    end
  when ::Hash
    object => { to:, map: }
    build_auth_mapper(to, &map)
  when ::Array
    object => [to, map]
    build_auth_mapper(to, &map)
  else
    # simplecov:disable
    raise ArgumentError, "Not sure how to convert #{object} to an auth mapper"
    # simplecov:enable
  end
end

.to_authenticator(*args) ⇒ Object

TODO: relocate to Authenticator



52
53
54
55
56
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
90
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
 
# File 'projects/command_connectors/src/command_connector.rb', line 52

def to_authenticator(*args)
  symbol, object = case args.size
                   when 1
                     [nil, args[0]]
                   when 2
                     args
                   else
                     # simplecov:disable
                     raise ArgumentError, "Expected 1 or 2 arguments, got #{args.size}"
                     # simplecov:enable
                   end

  case object
  when Class
    if object < Authenticator
      object.instance
    else
      # simplecov:disable
      raise ArgumentError, "Expected a class that inherits from Authenticator"
      # simplecov:enable
    end
  when Authenticator, nil
    object
  when ::String
    if symbol
      # simplecov:disable
      raise ArgumentError, "Was not expecting a symbol and a string"
      # simplecov:enable
    end

    to_authenticator(object.to_sym)
  when ::Symbol
    authenticator = authenticator_registry[object]

    unless authenticator
      # simplecov:disable
      raise "No authenticator found for #{object}"
      # simplecov:enable
    end

    authenticator
  when ::Array
    case object.size
    when 0
      # TODO: test this
      # simplecov:disable
      nil
      # simplecov:enable
    when 1
      to_authenticator(object[0])
    else
      authenticators = object.map { |authenticatorish| to_authenticator(authenticatorish) }
      AuthenticatorSelector.new(authenticators:, symbol:)
    end
  else
    if object.respond_to?(:call)
      Authenticator.new(symbol:, &object)
    else
      # simplecov:disable
      raise "Not sure how to convert #{object} into an AllowedRule object"
      # simplecov:enable
    end
  end.tap do |resolved_authenticator|
    if resolved_authenticator
      resolved_authenticator.symbol ||= symbol
    end
  end
end

Instance Method Details

#add_default_errors_transformer(transformer) ⇒ Object 



337
338
339
 
# File 'projects/command_connectors/src/command_connector.rb', line 337

def add_default_errors_transformer(transformer)
  command_registry.add_default_errors_transformer(transformer)
end

#add_default_inputs_transformer(transformer) ⇒ Object 



329
330
331
 
# File 'projects/command_connectors/src/command_connector.rb', line 329

def add_default_inputs_transformer(transformer)
  command_registry.add_default_inputs_transformer(transformer)
end

#add_default_pre_commit_transformer(transformer) ⇒ Object 



341
342
343
 
# File 'projects/command_connectors/src/command_connector.rb', line 341

def add_default_pre_commit_transformer(transformer)
  command_registry.add_default_pre_commit_transformer(transformer)
end

#add_default_response_mutator(mutator) ⇒ Object 



349
350
351
352
353
 
# File 'projects/command_connectors/src/command_connector.rb', line 349

def add_default_response_mutator(mutator)
  # simplecov:disable
  command_registry.add_default_response_mutator(mutator)
  # simplecov:enable
end

#add_default_result_transformer(transformer) ⇒ Object 



333
334
335
 
# File 'projects/command_connectors/src/command_connector.rb', line 333

def add_default_result_transformer(transformer)
  command_registry.add_default_result_transformer(transformer)
end

#add_default_serializer(serializer) ⇒ Object 



345
346
347
 
# File 'projects/command_connectors/src/command_connector.rb', line 345

def add_default_serializer(serializer)
  command_registry.add_default_serializer(serializer)
end

#all_exposed_command_names ⇒ Object 



393
394
395
 
# File 'projects/command_connectors/src/command_connector.rb', line 393

def all_exposed_command_names
  all_exposed_commands.map(&:full_command_name)
end

#all_exposed_commands ⇒ Object 



387
388
389
390
391
 
# File 'projects/command_connectors/src/command_connector.rb', line 387

def all_exposed_commands
  process_delayed_connections

  command_registry.foobara_all_command(mode: Namespace::LookupMode::ABSOLUTE_SINGLE_NAMESPACE)
end

#all_transformed_command_classes ⇒ Object 



375
376
377
 
# File 'projects/command_connectors/src/command_connector.rb', line 375

def all_transformed_command_classes
  command_registry.all_transformed_command_classes
end

#allow(rules) ⇒ Object 



251
252
253
 
# File 'projects/command_connectors/src/command_connector.rb', line 251

def allow(rules)
  command_registry.allow rules
end

#allowed_rule ⇒ Object 



355
356
357
358
359
 
# File 'projects/command_connectors/src/command_connector.rb', line 355

def allowed_rule(*)
  # simplecov:disable
  command_registry.allowed_rule(*)
  # simplecov:enable
end

#allowed_rules ⇒ Object 



361
362
363
 
# File 'projects/command_connectors/src/command_connector.rb', line 361

def allowed_rules(*)
  command_registry.allowed_rules(*)
end

#command ⇒ Object

TODO: should this be the official way to connect a command instead of #connect ? Probably not. But what about #export instead?



261
 
# File 'projects/command_connectors/src/command_connector.rb', line 261

def command(...) = connect(...)

#command_connected?(original_command_class) ⇒ Boolean

Returns:

  • (Boolean) 


397
398
399
400
401
 
# File 'projects/command_connectors/src/command_connector.rb', line 397

def command_connected?(original_command_class)
  all_exposed_commands.any? do |command|
    command.command_class == original_command_class
  end
end

#connect(*args, **opts) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'projects/command_connectors/src/command_connector.rb', line 263

def connect(*args, **opts)
  args, opts = desugarize_connect_args(args, opts)

  registerable = args[0]

  if opts.key?(:authenticator)
    authenticator = opts[:authenticator]
    authenticator = self.class.to_authenticator(authenticator)
    opts = opts.merge(authenticator:)
  end

  case registerable
  when Class
    unless registerable < Command
      # simplecov:disable
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # simplecov:enable
    end

    command_registry.register(*args, **opts)
  when Module
    if registerable.foobara_organization?
      args = args[1..]
      registerable.foobara_domains.map do |domain|
        connect(domain, *args, **opts)
      end.flatten
    elsif registerable.foobara_domain?
      args = args[1..]
      connected = []

      registerable = registerable.foobara_all_command(mode: Namespace::LookupMode::DIRECT)

      registerable.each do |command_class|
        unless command_class.abstract?
          connected << connect(command_class, *args, **opts)
        end
      end

      connected.flatten
    else
      # simplecov:disable
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # simplecov:enable
    end
  when Symbol, String
    connect_delayed(*args, **opts)
  else
    # simplecov:disable
    raise "Don't know how to register #{registerable} (#{registerable.class})"
    # simplecov:enable
  end
end

#each_transformed_command_class ⇒ Object 



369
370
371
372
373
 
# File 'projects/command_connectors/src/command_connector.rb', line 369

def each_transformed_command_class(&)
  # simplecov:disable
  command_registry.each_transformed_command_class(&)
  # simplecov:enable
end

#find_builtin_command_class(command_class_name) ⇒ Object 



325
326
327
 
# File 'projects/command_connectors/src/command_connector.rb', line 325

def find_builtin_command_class(command_class_name)
  self.class.find_builtin_command_class(command_class_name)
end

#lookup_command(name) ⇒ Object 



379
380
381
 
# File 'projects/command_connectors/src/command_connector.rb', line 379

def lookup_command(name)
  command_registry.foobara_lookup_command(name)
end

#register_allowed_rule(*ruleish_args) ⇒ Object 



255
256
257
 
# File 'projects/command_connectors/src/command_connector.rb', line 255

def register_allowed_rule(*ruleish_args)
  command_registry.allowed_rule(*ruleish_args)
end

#run ⇒ Object

TODO: maybe introduce a Runner interface?



317
318
319
320
321
322
323
 
# File 'projects/command_connectors/src/command_connector.rb', line 317

def run(...)
  process_delayed_connections

  request = build_request(...)

  run_request(request)
end

#transformed_command_from_name ⇒ Object 



365
366
367
 
# File 'projects/command_connectors/src/command_connector.rb', line 365

def transformed_command_from_name(*)
  command_registry.transformed_command_from_name(*)
end

#type_from_name(name) ⇒ Object 



383
384
385
 
# File 'projects/command_connectors/src/command_connector.rb', line 383

def type_from_name(name)
  Foobara.foobara_lookup_type(name, mode: Namespace::LookupMode::RELAXED)
end