foobara 0.0.113 → 0.0.115

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6311b48e0b7d0f27986d0536f437d60db1409f9a71c36cfc5858f3637b37629d
-  data.tar.gz: e4e057f18a757133d17cd938275aa6c93a97e6ab03ea207a1eca603ed25f1866
+  metadata.gz: 94baacc7205e4b750c59df65dede92b2c95f15053144ba8d8324c81eb80da770
+  data.tar.gz: 696db0d2d875c8f2c40ed9d916019518c3f2ffcc0829015a0333109c83a1e8ef
 SHA512:
-  metadata.gz: b48c048cbe4e4c4905222c6564b44842809a160ed07b523ef2a4c9833fc29bcf1b1024729d1431833aa363d0839c41b808b4a09302e070dcca13358a98212327
-  data.tar.gz: 761e37c588eef4370fe0884250a6e824083c2c420864cbeb2ebf268340ca1beee2410d1e68ea4cef10d69953f633ae0785d9eaa72f6e9c9727705ecfc2a4ce32
+  metadata.gz: 5b5cd5e50eee5c8f652d24107027eaf9115128742b57f8964010667d0e12da2a5bc1087d87870c507c9bd0cc6016eaa0248e9707d567c96c4193794863bebb6a
+  data.tar.gz: 356150abc278d32b253ddc08ed1f4932ac4432a25f9ed4797518191b9a86fc01c06986df8e314aa5a6fc64b44441adc89946a6b6f49daac42d424a73d41e2589

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [0.0.115] - 2025-05-01
+
+- Make sure Authenticator#authenticate hits #applicable?
+
+# [0.0.114] - 2025-05-01
+
+- Support choosing among multiple processors
+- Make Authenticator a Processor
+- Give a way for Processor::Selection to give nil when nothing matches
+
 # [0.0.113] - 2025-04-25
 
 - If an inputs transformer fails give relevant error/outcome not an unknown error

data/projects/command/src/transformed_command.rb

@@ -217,9 +217,6 @@ module Foobara
       end
 
       def types_depended_on
-        # Seems to be not necessary?
-        # types = command_class.types_depended_on
-
         types = Set.new
 
         # TODO: memoize this
@@ -299,18 +296,14 @@ module Foobara
         response_mutators = mutators_to_manifest_symbols(self.response_mutators, to_include:)
         request_mutators = mutators_to_manifest_symbols(self.request_mutators, to_include:)
 
-        authenticator_manifest = if authenticator
-                                   if authenticator.respond_to?(:foobara_manifest)
-                                     # TODO: test this path
-                                     # :nocov:
-                                     authenticator.foobara_manifest
-                                     # :nocov:
-                                   else
-                                     true
-                                   end
-                                 end
-
-        inputs_types_depended_on =  TypeDeclarations.with_manifest_context(remove_sensitive: false) do
+        authenticator_details = if authenticator
+                                  {
+                                    symbol: authenticator.symbol,
+                                    explanation: authenticator.explanation
+                                  }
+                                end
+
+        inputs_types_depended_on = TypeDeclarations.with_manifest_context(remove_sensitive: false) do
           self.inputs_types_depended_on.map(&:foobara_manifest_reference).sort
         end
 
@@ -338,7 +331,7 @@ module Foobara
             response_mutators:,
             request_mutators:,
             requires_authentication:,
-            authenticator: authenticator_manifest
+            authenticator: authenticator_details
           )
         )
       end
@@ -486,7 +479,8 @@ module Foobara
       end
     end
 
-    attr_accessor :command, :untransformed_inputs, :transformed_inputs, :outcome, :authenticated_user
+    attr_accessor :command, :untransformed_inputs, :transformed_inputs, :outcome, :authenticated_user,
+                  :authenticated_credential
 
     def initialize(untransformed_inputs = {})
       self.untransformed_inputs = untransformed_inputs || {}

data/projects/command_connectors/src/authenticator.rb

@@ -1,14 +1,32 @@
 module Foobara
   class CommandConnector
-    class Authenticator
-      attr_reader :block, :explanation, :symbol
+    # TODO: should switch to a processor and give errors if the authenticator header is malformed
+    class Authenticator < Value::Transformer
+      attr_reader :block
 
       def initialize(symbol: nil, explanation: nil, &block)
         symbol ||= Util.non_full_name_underscore(self.class).to_sym
+        explanation ||= symbol
+
+        super(symbol:, explanation:)
 
-        @symbol = symbol
         @block = block
-        @explanation = explanation || symbol
+      end
+
+      def symbol
+        declaration_data[:symbol]
+      end
+
+      def explanation
+        declaration_data[:explanation]
+      end
+
+      def transform(request)
+        request.instance_exec(&to_proc)
+      end
+
+      def authenticate(request)
+        process_value!(request)
       end
 
       def to_proc

data/projects/command_connectors/src/authenticator_selector.rb

@@ -0,0 +1,29 @@
+require_relative "authenticator"
+
+module Foobara
+  class CommandConnector
+    # TODO: should switch to a processor and give errors if the authenticator header is malformed
+    class AuthenticatorSelector < Authenticator
+      attr_accessor :authenticators
+
+      def initialize(authenticators:, symbol: nil, explanation: nil, &block)
+        self.authenticators = authenticators
+
+        symbol ||= authenticators.map(&:symbol).map(&:to_s).join("_or_").to_sym
+        explanation ||= authenticators.map(&:explanation).join(", or ")
+
+        super(symbol:, explanation:)
+
+        @block = block
+      end
+
+      def selector
+        @selector ||= Value::Processor::Selection.new(processors: authenticators, error_if_none_applicable: false)
+      end
+
+      def authenticate(request)
+        selector.process_value!(request)
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector.rb

@@ -85,6 +85,19 @@ module Foobara
           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)
@@ -403,12 +416,14 @@ module Foobara
 
     def authenticate(request)
       request_command = request.command
-      auth_block = request_command.authenticator || authenticator
+      authenticator = request_command.authenticator || self.authenticator
 
       request_command.after_load_records do |command:, **|
-        authenticated_user = request.instance_exec(&auth_block)
+        authenticated_user, authenticated_credential = authenticator.authenticate(request)
 
+        # TODO: why are these on the command instead of the request??
         request_command.authenticated_user = authenticated_user
+        request_command.authenticated_credential = authenticated_credential
 
         unless authenticated_user
           request_command.outcome = Outcome.error(CommandConnector::UnauthenticatedError.new)

data/projects/value/src/processor/selection.rb

@@ -16,10 +16,12 @@ module Foobara
           end
         end
 
-        attr_accessor :enforce_unique
+        attr_accessor :enforce_unique, :error_if_none_applicable
 
-        def initialize(*, enforce_unique: true, **)
+        def initialize(*, enforce_unique: true, error_if_none_applicable: true, **)
           self.enforce_unique = enforce_unique
+          self.error_if_none_applicable = error_if_none_applicable
+
           super(*, **)
         end
 
@@ -29,12 +31,19 @@ module Foobara
 
           if outcome.success?
             processor = outcome.result
-            outcome = processor.process_value(value)
+
+            unless processor.nil?
+              outcome = processor.process_value(value)
+            end
           end
 
           outcome
         end
 
+        def process_value!(value)
+          process_value(value).result!
+        end
+
         def processor_for(value)
           processor = if enforce_unique
                         applicable_processors = processors.select { |p| p.applicable?(value) }
@@ -59,8 +68,10 @@ module Foobara
 
           if processor
             Outcome.success(processor)
-          else
+          elsif error_if_none_applicable
             Outcome.error(build_error(value, error_class: NoApplicableProcessorError))
+          else
+            Outcome.success(nil)
           end
         end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.113
+  version: 0.0.115
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -182,6 +182,7 @@ files:
 - projects/command/src/transformed_command.rb
 - projects/command_connectors/lib/foobara/command_connectors.rb
 - projects/command_connectors/src/authenticator.rb
+- projects/command_connectors/src/authenticator_selector.rb
 - projects/command_connectors/src/command_connector.rb
 - projects/command_connectors/src/command_connector/command_connector_error.rb
 - projects/command_connectors/src/command_connector/commands/describe.rb
@@ -508,7 +509,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A command-centric and discoverable software framework with a focus on domain
   concepts and abstracting away integration code