foobara-http-command-connector 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f050dbda61782345868886aeb89b9f79160aafd2ec23ed5c9295c962460360dc
-  data.tar.gz: 8baa30f94268fecc85e9b9f86676f03a484d5efbc797a5aedd35f62d770f24b0
+  metadata.gz: 4a6e931ec6770cb9d080f7881905dfac20b5246a0ca5726e14ce37151edff543
+  data.tar.gz: b11048224ade66b0fda7dc73b33ce49f522402e283e8ac10bd776e5548c9b6bd
 SHA512:
-  metadata.gz: ea971dd972af3d7845e9a206e4dc956eb1b29f674b34d4389a7f67e360e4559b8dd5cf9cc9e6475ee98aadb63985aff93d9c4b4d75fe9f9cf07e8f2e1054b6cf
-  data.tar.gz: f8bbcb34388d4042df81fafdd9e286d2b2cca9a560e1dcd541f0fa83e38d7b402858f6c2f0ef48c858386468db1a7c64bcfd7e30df264bdbc10d87ce771dd383
+  metadata.gz: 3b4386dd8cbcdccd2b4fe4bc02dde29cae04704fa56e5458dd77d712515518c9e91af64664255679f81539c6b33346b3c8aa91e33cdac95ba98073a5d74359d1
+  data.tar.gz: 5fbb2a89db7b9605e0509eaac865feea185dd13ac6067c2ce8166cac87970bcf09ab3e2ba31f02c6cfb4328e86b2bbb304cc32ada10193411bd1f0948e001e15

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-## [0.0.13] - 2025-01-30
+## [0.0.15] - 2025-03-28
 
-- Make sure manifest is ran in detached context
+- Implement MoveAttributeToCookie response mutator
+- Decouple Help command from html serialization
+
+## [0.0.14] - 2025-02-02
+
+- Put manifest into detached context by default
 
 ## [0.0.12] - 2025-01-28
 

data/src/http/commands/describe.rb

@@ -3,15 +3,33 @@ module Foobara
     class Http < Foobara::CommandConnector
       module Commands
         class Describe < Foobara::CommandConnector::Commands::Describe
+          inputs do
+            manifestable :duck
+            request :duck
+            detached :boolean, default: true
+          end
+
           def stamp_request_metadata
             manifest[:metadata] = super.merge(url: request.url)
           end
 
+          def in_detached_context(&)
+            Thread.foobara_with_var("foobara_manifest_context", detached: true, &)
+          end
+
           def build_manifest
-            Thread.foobara_with_var("foobara_manifest_context", detached: true) do
+            if detached_context?
+              in_detached_context do
+                super
+              end
+            else
               super
             end
           end
+
+          def detached_context?
+            detached
+          end
         end
       end
     end

data/src/http/commands/help/presenter/request_failed.rb

@@ -0,0 +1,14 @@
+module Foobara
+  module CommandConnectors
+    class Http < CommandConnector
+      module Commands
+        class Help < Command
+          class Presenter
+            class RequestFailed < Presenter
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/src/http/commands/help/presenter.rb

@@ -41,6 +41,8 @@ module Foobara
                   Presenter::Processor
                 when Manifest::ProcessorClass
                   Presenter::ProcessorClass
+                when ErrorCollection
+                  Presenter::RequestFailed
                 else
                   # :nocov:
                   raise "No presenter found for #{manifest.path}"
@@ -171,7 +173,9 @@ module Foobara
             end
 
             def respond_to_missing?(method_name, include_private = false)
+              # :nocov:
               manifest.respond_to?(method_name, include_private)
+              # :nocov:
             end
           end
         end

data/src/http/commands/help/result_serializer.rb

@@ -0,0 +1,22 @@
+module Foobara
+  module CommandConnectors
+    class Http < CommandConnector
+      module Commands
+        class Help < Command
+          class ResultSerializer < Serializer
+            def serialize(object_to_help_with)
+              presenter = Presenter.for(object_to_help_with)
+
+              template_path = presenter.template_path
+              template_body = File.read(template_path)
+              template = ERB.new(template_body)
+              template.filename = template_path
+
+              template.result(presenter.instance_eval { binding })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/src/http/commands/help/templates/request_failed.html.erb

@@ -0,0 +1 @@
+Request Failed: <%= to_sentence %>

data/src/http/commands/help.rb

@@ -3,23 +3,20 @@ module Foobara
     class Http < CommandConnector
       module Commands
         class Help < Command
-          description "Will extract items from the request to help with. Assumes the help is desired in HTML format"
+          description "Will extract items from the request to help with"
           inputs request: Http::Request
-          result :string
+          result :duck
           possible_error CommandConnector::NotFoundError
 
           def execute
             load_manifest
             determine_object_to_help_with
-            build_presenter
-            load_template
-            generate_html_from_template
-            set_header_to_html
+            set_manifest_to_help_with
 
-            html
+            manifest_to_help_with
           end
 
-          attr_accessor :raw_manifest, :root_manifest, :object_to_help_with, :template, :html, :presenter
+          attr_accessor :raw_manifest, :root_manifest, :object_to_help_with, :manifest_to_help_with
 
           def load_manifest
             self.raw_manifest = command_connector.foobara_manifest
@@ -35,6 +32,7 @@ module Foobara
               if result
                 self.object_to_help_with = result
               else
+                # TODO: we should look up from the command connector's namespace instead, right?
                 result = GlobalOrganization.foobara_lookup(arg, mode:)
 
                 if result && root_manifest.contains?(result.foobara_manifest_reference,
@@ -54,38 +52,12 @@ module Foobara
             end
           end
 
-          def build_presenter
-            self.presenter = Help::Presenter.for(manifest_to_help_with)
-          end
-
-          def template_path
-            presenter.template_path
-          end
-
-          def load_template
-            template_body = File.read(template_path)
-
-            erb = ERB.new(template_body)
-            erb.filename = template_path
-
-            self.template = erb
-          end
-
-          def generate_html_from_template
-            self.html = template.result(presenter.instance_eval { binding })
-          end
-
-          def set_header_to_html
-            request.response_headers ||= {}
-            request.response_headers = request.response_headers.merge("content-type" => "text/html")
-          end
-
-          def manifest_to_help_with
-            @manifest_to_help_with ||= if object_to_help_with.is_a?(Manifest::BaseManifest)
-                                         object_to_help_with
-                                       else
-                                         root_manifest.lookup(object_to_help_with.foobara_manifest_reference)
-                                       end
+          def set_manifest_to_help_with
+            self.manifest_to_help_with = if object_to_help_with.is_a?(Manifest::BaseManifest)
+                                           object_to_help_with
+                                         else
+                                           root_manifest.lookup(object_to_help_with.foobara_manifest_reference)
+                                         end
           end
 
           def command_connector

data/src/http/cookie.rb

@@ -0,0 +1,31 @@
+module Foobara
+  module CommandConnectors
+    class Http < CommandConnector
+      class Cookie
+        attr_accessor :name, :value, :opts
+
+        ALLOWED_OPTIONS = %i[path httponly secure same_site domain expires max_age].freeze
+
+        def initialize(name, value, **opts)
+          invalid_options = opts.keys - ALLOWED_OPTIONS
+
+          unless invalid_options.empty?
+            # :nocov:
+            raise ArgumentError, "Invalid options #{invalid_options.inspect} expected only #{ALLOWED_OPTIONS.inspect}"
+            # :nocov:
+          end
+
+          self.name = name
+          self.value = value
+          self.opts = opts.transform_keys(&:to_sym)
+        end
+
+        ALLOWED_OPTIONS.each do |option|
+          define_method option do
+            opts[option]
+          end
+        end
+      end
+    end
+  end
+end

data/src/http/response.rb

@@ -3,11 +3,22 @@ module Foobara
     class Http < CommandConnector
       class Response < CommandConnector::Response
         attr_accessor :headers
+        attr_writer :cookies
 
-        def initialize(headers:, **)
+        def initialize(headers: nil, cookies: nil, **)
           self.headers = headers
+          self.cookies = cookies
+
           super(**)
         end
+
+        def cookies
+          @cookies ||= []
+        end
+
+        def add_cookie(cookie_name, cookie_value, cookie_opts)
+          cookies << Cookie.new(cookie_name, cookie_value, **cookie_opts)
+        end
       end
     end
   end

data/src/http/response_mutators/move_attribute_to_cookie.rb

@@ -0,0 +1,47 @@
+module Foobara
+  module CommandConnectors
+    class Http < CommandConnector
+      class MoveAttributeToCookie < ResponseMutator
+        class << self
+          attr_accessor :attribute_name, :cookie_name, :cookie_opts
+
+          def for(attribute_name, cookie_name = attribute_name, **cookie_opts)
+            subclass = Class.new(self)
+
+            subclass.attribute_name = attribute_name
+            subclass.cookie_name = cookie_name
+            subclass.cookie_opts = cookie_opts
+
+            subclass
+          end
+        end
+
+        attr_writer :attribute_name, :cookie_name, :cookie_opts
+
+        def result_type_from(result_type)
+          AttributesTransformers.reject(result_type.declaration_data)
+          new_declaration = TypeDeclarations::Attributes.reject(result_type.declaration_data, attribute_name)
+
+          Domain.current.foobara_type_from_declaration(new_declaration)
+        end
+
+        def mutate(response)
+          cookie_value = response.body.delete(attribute_name)
+          response.add_cookie(cookie_name, cookie_value, cookie_opts)
+        end
+
+        def attribute_name
+          @attribute_name ||= self.class.attribute_name
+        end
+
+        def cookie_name
+          @cookie_name ||= self.class.cookie_name
+        end
+
+        def cookie_opts
+          @cookie_opts ||= self.class.cookie_opts
+        end
+      end
+    end
+  end
+end

data/src/http.rb

@@ -58,57 +58,59 @@ module Foobara
         super(*, prefix:, **)
       end
 
-      def request_to_command(context)
-        if context.method == "OPTIONS"
+      def request_to_command(request)
+        if request.method == "OPTIONS"
           # TODO: this feels a bit hacky and like overkill...
           return Foobara::CommandConnectors::Http::Commands::GetOptions.new
         end
 
         command = super
 
-        if context.action == "help"
-          # Let's unwrap the transformed command to avoid serialization
-          # TODO: maybe instead register Help without serializers?
-          command = command.command
+        # TODO: We should kill these case statements and require connecting these commands
+        if request.action == "help"
+          command.class.serializers = [Commands::Help::ResultSerializer]
         end
 
         command
       end
 
-      def request_to_response(request)
-        command = request.command
+      def set_response_status(response)
+        command = response.command
         outcome = command.outcome
 
-        # TODO: feels awkward to call this here... Maybe use result/errors transformers instead??
-        # Or call the serializer here??
-        body = command.respond_to?(:serialize_result) ? command.serialize_result : outcome.result
-
-        status = if outcome.success?
-                   200
-                 else
-                   errors = outcome.errors
-
-                   if errors.size == 1
-                     error = errors.first
-
-                     case error
-                     when CommandConnector::UnknownError
-                       500
-                     when CommandConnector::NotFoundError, Foobara::Entity::NotFoundError
-                       # TODO: we should not be coupled to Entities here...
-                       body ||= "Not found"
-                       404
-                     when CommandConnector::UnauthenticatedError
-                       401
-                     when CommandConnector::NotAllowedError
-                       403
-                     end
-                   end || 422
-                 end
-
-        headers = headers_for(request)
-
-        Response.new(status:, headers:, body:, request:)
+        response.status = if outcome.success?
+                            200
+                          else
+                            errors = outcome.errors
+
+                            if errors.size == 1
+                              error = errors.first
+
+                              case error
+                              when CommandConnector::UnknownError
+                                500
+                              when CommandConnector::NotFoundError, Foobara::Entity::NotFoundError
+                                # TODO: we should not be coupled to Entities here...
+                                404
+                              when CommandConnector::UnauthenticatedError
+                                401
+                              when CommandConnector::NotAllowedError
+                                403
+                              end
+                            end || 422
+                          end
+      end
+
+      def mutate_response(response)
+        super
+
+        headers = headers_for(response.request)
+
+        if headers&.any?
+          response.headers = (response.headers || {}).merge(headers)
+        else
+          response.headers ||= {}
+        end
       end
 
       def headers_for(request)

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: foobara-http-command-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-01-31 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.88
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.88
 email:
 - azimux@gmail.com
 executables: []
@@ -48,8 +48,10 @@ files:
 - src/http/commands/help/presenter/organization.rb
 - src/http/commands/help/presenter/processor.rb
 - src/http/commands/help/presenter/processor_class.rb
+- src/http/commands/help/presenter/request_failed.rb
 - src/http/commands/help/presenter/root.rb
 - src/http/commands/help/presenter/type.rb
+- src/http/commands/help/result_serializer.rb
 - src/http/commands/help/templates/command.html.erb
 - src/http/commands/help/templates/domain.html.erb
 - src/http/commands/help/templates/entity.html.erb
@@ -58,10 +60,13 @@ files:
 - src/http/commands/help/templates/organization.html.erb
 - src/http/commands/help/templates/processor.html.erb
 - src/http/commands/help/templates/processor_class.html.erb
+- src/http/commands/help/templates/request_failed.html.erb
 - src/http/commands/help/templates/root.html.erb
 - src/http/commands/help/templates/type.html.erb
+- src/http/cookie.rb
 - src/http/request.rb
 - src/http/response.rb
+- src/http/response_mutators/move_attribute_to_cookie.rb
 homepage: https://github.com/foobara/http-command-connector
 licenses:
 - Apache-2.0
@@ -85,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: No description. Add one.
 test_files: []