Class: Foobara::CommandConnector

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

Defined Under Namespace

Modules: Commands, Concerns Classes: AlreadyConnectedError, Authenticator, AuthenticatorSelector, CommandConnectorError, InvalidContextError, NoAllowedRuleGivenError, 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.



195
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
 
# File 'projects/command_connectors/src/command_connector.rb', line 195

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.



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

def auth_map
  @auth_map
end

#authenticator ⇒ Object

Returns the value of attribute authenticator.



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

def authenticator
  @authenticator
end

#capture_unknown_error ⇒ Object

Returns the value of attribute capture_unknown_error.



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

def capture_unknown_error
  @capture_unknown_error
end

#command_registry ⇒ Object

Returns the value of attribute command_registry.



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

def command_registry
  @command_registry
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#requires_allowed_rule ⇒ Object

Returns the value of attribute requires_allowed_rule.



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

def requires_allowed_rule
  @requires_allowed_rule
end

Class Method Details

.allowed_rules_to_register ⇒ Object 



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

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 



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

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 



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

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



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

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

.find_builtin_command_class(command_class_name) ⇒ Object 



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

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 



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

def register_allowed_rule(*rule_args)
  allowed_rules_to_register << rule_args
end

.register_authenticator(*authenticatorish_args) ⇒ Object 



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

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

  unless authenticator.symbol
    # :nocov:
    raise ArgumentError, "Expected authenticator to have a symbol"
    # :nocov:
  end

  authenticator_registry[authenticator.symbol] = authenticator
end

.to_auth_user_mapper(object) ⇒ Object

don’t call this auth_user ?



121
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
 
# File 'projects/command_connectors/src/command_connector.rb', line 121

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.first
                             elsif size > 1
                               declaration = inputs_type&.declaration_data
                               required_attribute_names = declaration&.[](:required) || EMPTY_ARRAY

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

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

.to_authenticator(*args) ⇒ Object

TODO: relocate to Authenticator



51
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
 
# File 'projects/command_connectors/src/command_connector.rb', line 51

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

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

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

    unless authenticator
      # :nocov:
      raise "No authenticator found for #{object}"
      # :nocov:
    end

    authenticator
  when ::Array
    case object.size
    when 0
      # TODO: test this
      # :nocov:
      nil
      # :nocov:
    when 1
      to_authenticator(object.first)
    else
      authenticators = object.map { |authenticatorish| to_authenticator(authenticatorish) }
      AuthenticatorSelector.new(authenticators:, symbol:)
    end
  else
    if object.respond_to?(:call)
      Authenticator.new(symbol:, &object)
    else
      # :nocov:
      raise "Not sure how to convert #{object} into an AllowedRule object"
      # :nocov:
    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 



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

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

#add_default_inputs_transformer(transformer) ⇒ Object 



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

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

#add_default_pre_commit_transformer(transformer) ⇒ Object 



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

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

#add_default_response_mutator(mutator) ⇒ Object 



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

def add_default_response_mutator(mutator)
  # :nocov:
  command_registry.add_default_response_mutator(mutator)
  # :nocov:
end

#add_default_result_transformer(transformer) ⇒ Object 



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

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

#add_default_serializer(serializer) ⇒ Object 



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

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

#all_exposed_command_names ⇒ Object 



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

def all_exposed_command_names
  all_exposed_commands.map(&:full_command_name)
end

#all_exposed_commands ⇒ Object 



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

def all_exposed_commands
  process_delayed_connections

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

#all_transformed_command_classes ⇒ Object 



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

def all_transformed_command_classes
  command_registry.all_transformed_command_classes
end

#allow(rules) ⇒ Object 



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

def allow(rules)
  command_registry.allow rules
end

#allowed_rule ⇒ Object 



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

def allowed_rule(*)
  # :nocov:
  command_registry.allowed_rule(*)
  # :nocov:
end

#allowed_rules ⇒ Object 



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

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?



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

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

#command_connected?(original_command_class) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

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



262
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
 
# File 'projects/command_connectors/src/command_connector.rb', line 262

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

  registerable = args.first

  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
      # :nocov:
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # :nocov:
    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
      # :nocov:
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # :nocov:
    end
  when Symbol, String
    connect_delayed(*args, **opts)
  else
    # :nocov:
    raise "Don't know how to register #{registerable} (#{registerable.class})"
    # :nocov:
  end
end

#each_transformed_command_class ⇒ Object 



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

def each_transformed_command_class(&)
  # :nocov:
  command_registry.each_transformed_command_class(&)
  # :nocov:
end

#find_builtin_command_class(command_class_name) ⇒ Object 



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

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

#lookup_command(name) ⇒ Object 



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

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

#register_allowed_rule(*ruleish_args) ⇒ Object 



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

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

#run ⇒ Object

TODO: maybe introduce a Runner interface?



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

def run(...)
  process_delayed_connections

  request = build_request(...)

  run_request(request)
end

#transformed_command_from_name ⇒ Object 



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

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

#type_from_name(name) ⇒ Object 



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

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