foobara 0.0.104 → 0.0.106

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be41d74ce30f423271c0b160d955d9ea7422e5d4337ab1d3c17deb0dae395d53
-  data.tar.gz: 51f8a06a9468870be7e2db0dd2116a8bca141852f27d462b4ce01b74df490710
+  metadata.gz: 980071302c992808e812a703ff9a203fca501336c00225dd8eeb045982975704
+  data.tar.gz: '04901d96e1717a09d736feccd2c21d31873ae32235362b0613476f508423373f'
 SHA512:
-  metadata.gz: 49e75de0f35a1a1eb257efd6e1304ed39d340ee8531e1b768ca8fc58ab4a0bc8e4422e3c50c379565c899708ac7a0768aa87aca326240933771147c285212894
-  data.tar.gz: 6d3234ee0c549fd91d21fe11e16968a5fe56da263eafa90474b20baa2b091ec33b57b439891eeeccf7149e4a9d1995ebab8a3ecc864e1eb796a1a8bef60f1d63
+  metadata.gz: cee4fbf405088f382583642aed0c40c55010249e346f6881608463ec37d8bd8fe378fe030adedc3c2c1534a89980ee475affa872e260e7e95dbad611411d84f8
+  data.tar.gz: 741ed3a774a1d92dacef4a640706b41764f10144d39b130eeaf032648a60d95b3d450830facd8334b346a1a2e07179b750899063e69ac3bb1e6862884a0bff64

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# [0.0.106] - 2025-04-20
+
+- Fix authenticator explanation that was coupled to pry
+
+# [0.0.105] - 2025-04-20
+
+- Support registering allowed_rule and authenticator on connectors and using them by symbol
+- Automatically set requires_authentication if there's an authenticator+allowed_rule for convenience.
+
 # [0.0.104] - 2025-04-17
 
 - Fix manifest bug when command has no possible errors

data/projects/command/src/transformed_command.rb

@@ -566,17 +566,18 @@ module Foobara
             end
 
             if explanation.nil?
-              source = begin
-                allowed_rule.block.source
-              rescue MethodSource::SourceNotFoundError
-                # This path is hit if the way the source code is extracted
-                # doesn't result in valid Ruby, for example, as part of a hash such as:
-                # allowed_rule: -> () { whatever?(something) },
-                # :nocov:
-                allowed_rule.block.source_location.join(":")
-                # :nocov:
-              end
+              source = if allowed_rule.block.respond_to?("source") && defined?(MethodSource)
+                         begin
+                           # This only works when pry is loaded
+                           allowed_rule.block.source
+                         rescue MethodSource::SourceNotFoundError
+                           # This path is hit if the way the source code is extracted
+                           # doesn't result in valid Ruby, for example, as part of a hash such as:
+                           # allowed_rule: -> () { whatever?(something) },
+                         end
+                       end
 
+              source ||= allowed_rule.block.source_location.join(":")
               explanation = source || "No explanation."
             end
 

data/projects/command_connectors/src/authenticator.rb

@@ -0,0 +1,19 @@
+module Foobara
+  class CommandConnector
+    class Authenticator
+      attr_accessor :block, :explanation, :symbol
+
+      def initialize(symbol: nil, explanation: nil, &block)
+        symbol ||= Util.non_full_name_underscore(self.class).to_sym
+
+        self.symbol = symbol
+        self.block = block
+        self.explanation = explanation || symbol
+      end
+
+      def to_proc
+        block
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector.rb

@@ -84,18 +84,116 @@ module Foobara
       def find_builtin_command_class(command_class_name)
         Util.find_constant_through_class_hierarchy(self, "Commands::#{command_class_name}")
       end
+
+      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
+
+      def register_allowed_rule(*rule_args)
+        allowed_rules_to_register << rule_args
+      end
+
+      def authenticator_registry
+        return @authenticator_registry if defined?(@authenticator_registry)
+
+        @authenticator_registry = if superclass == Object
+                                    {}
+                                  else
+                                    superclass.authenticator_registry.dup
+                                  end
+      end
+
+      def register_authenticator(*authenticatorish_args)
+        authenticator = to_authenticator(*authenticatorish_args)
+
+        unless authenticator.symbol
+          # :nocov:
+          raise ArgumentError, "Expected an authenticator to have a symbol"
+          # :nocov:
+        end
+
+        authenticator_registry[authenticator.symbol] = authenticator
+      end
+
+      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.new
+          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
+        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
     end
 
     attr_accessor :command_registry, :authenticator, :capture_unknown_error
 
     def initialize(authenticator: nil, capture_unknown_error: nil, default_serializers: nil)
-      self.command_registry = CommandRegistry.new(authenticator:)
+      authenticator = self.class.to_authenticator(authenticator)
+
       self.authenticator = authenticator
+      self.command_registry = CommandRegistry.new(authenticator:)
       self.capture_unknown_error = capture_unknown_error
 
       Util.array(default_serializers).each do |serializer|
         add_default_serializer(serializer)
       end
+
+      self.class.allowed_rules_to_register.each do |ruleish_args|
+        command_registry.allowed_rule(*ruleish_args)
+      end
     end
 
     def find_builtin_command_class(command_class_name)
@@ -293,7 +391,11 @@ module Foobara
       delayed_connections.clear
     end
 
-    def connect(registerable, *, **)
+    def connect(registerable, *, authenticator: nil, **)
+      if authenticator
+        authenticator = self.class.to_authenticator(authenticator)
+      end
+
       case registerable
       when Class
         unless registerable < Command
@@ -302,15 +404,15 @@ module Foobara
           # :nocov:
         end
 
-        command_registry.register(registerable, *, **)
+        command_registry.register(registerable, *, authenticator:, **)
       when Module
         if registerable.foobara_organization?
           registerable.foobara_domains.map do |domain|
-            connect(domain, *, **)
+            connect(domain, *, authenticator:, **)
           end.flatten
         elsif registerable.foobara_domain?
           registerable.foobara_all_command(mode: Namespace::LookupMode::DIRECT).map do |command_class|
-            Util.array(connect(command_class, *, **))
+            Util.array(connect(command_class, *, authenticator:, **))
           end.flatten
         else
           # :nocov:
@@ -318,7 +420,7 @@ module Foobara
           # :nocov:
         end
       when Symbol, String
-        connect_delayed(registerable, *, **)
+        connect_delayed(registerable, *, authenticator:, **)
       else
         # :nocov:
         raise "Don't know how to register #{registerable} (#{registerable.class})"
@@ -372,9 +474,10 @@ module Foobara
 
     def authenticate(request)
       request_command = request.command
+      auth_block = request_command.authenticator || authenticator
 
       request_command.after_load_records do |command:, **|
-        authenticated_user = request.instance_exec(&authenticator)
+        authenticated_user = request.instance_exec(&auth_block)
 
         request_command.authenticated_user = authenticated_user
 

data/projects/command_connectors/src/command_registry/exposed_command.rb

@@ -38,6 +38,10 @@ module Foobara
         aggregate_entities: nil,
         atomic_entities: nil
       )
+        if allowed_rule && authenticator && requires_authentication.nil?
+          requires_authentication = true
+        end
+
         if requires_authentication || allowed_rule
           errors_transformers = [
             *errors_transformers,

data/projects/command_connectors/src/command_registry.rb

@@ -6,6 +6,9 @@ module Foobara
 
     attr_accessor :authenticator, :default_allowed_rule
 
+    # Should we support different authenticators for different commands?
+    # Might be a smell of two domains co-habitating in one? Or maybe one is just
+    # passing another through and we should support that?
     def initialize(authenticator: nil)
       self.scoped_path = []
       self.authenticator = authenticator
@@ -50,7 +53,7 @@ module Foobara
       pre_commit_transformers: nil,
       serializers: nil,
       allowed_rule: default_allowed_rule,
-      authenticator: self.authenticator,
+      authenticator: nil,
       **opts
     )
       opts.merge(
@@ -60,7 +63,7 @@ module Foobara
         pre_commit_transformers: [*pre_commit_transformers, *default_pre_commit_transformers],
         serializers: [*serializers, *default_serializers],
         allowed_rule: allowed_rule && to_allowed_rule(allowed_rule),
-        authenticator:
+        authenticator: authenticator || self.authenticator
       )
     end
 
@@ -140,8 +143,8 @@ module Foobara
       @allowed_rule_registry ||= {}
     end
 
-    def allowed_rule(ruleish)
-      allowed_rule = to_allowed_rule(ruleish)
+    def allowed_rule(*)
+      allowed_rule = to_allowed_rule(*)
 
       unless allowed_rule.symbol
         # :nocov:
@@ -201,11 +204,28 @@ module Foobara
       default_serializers << serializer
     end
 
-    def to_allowed_rule(object)
+    def to_allowed_rule(*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 AllowedRule, nil
         object
       when ::String
+        if symbol
+          # :nocov:
+          raise ArgumentError, "Was not expecting a symbol and a string"
+          # :nocov:
+        end
+
         to_allowed_rule(object.to_sym)
       when ::Symbol
         allowed_rule = allowed_rule_registry[object]
@@ -251,12 +271,14 @@ module Foobara
         allowed_rule
       else
         if object.respond_to?(:call)
-          AllowedRule.new(&object)
+          AllowedRule.new(symbol:, &object)
         else
           # :nocov:
           raise "Not sure how to convert #{object} into an AllowedRule object"
           # :nocov:
         end
+      end.tap do |rule|
+        rule.symbol ||= symbol
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.104
+  version: 0.0.106
 platform: ruby
 authors:
 - Miles Georgi
@@ -181,6 +181,7 @@ files:
 - projects/command/src/state_machine.rb
 - projects/command/src/transformed_command.rb
 - projects/command_connectors/lib/foobara/command_connectors.rb
+- projects/command_connectors/src/authenticator.rb
 - projects/command_connectors/src/command_connector.rb
 - projects/command_connectors/src/command_connector/commands/describe.rb
 - projects/command_connectors/src/command_connector/commands/list_commands.rb