foobara-jsonrpc-connector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c96f75168448845d7132ee09ca5d87ee541c9f868ea724602faec5eef4c42b3
+  data.tar.gz: 56dea022fe3625f1a840b8e377a35796636471c28dd38f39a86696c8f47dcdae
+SHA512:
+  metadata.gz: e16eb5ad6b134898ac3d229b324f5a4cd93b57480c0c771ee55f9393e95080b0b4378a2f5e142fba7436c963a2d04990ba42832f3c0003f0c9b6431fe44234c2
+  data.tar.gz: 8ffa2ad370ee7fc3866f1937bda5d64515eb011d8edcd65dcebc2a59ecdb0ca2569f7f3c9c3ced191c1df2c2017789c75b0b3af449807b531bea8aa509e0b775

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.1] - 2025-04-08
+
+- Initial release
+
+## [0.0.0] - 2025-04-07
+
+- Project birth

data/LICENSE-MPL-2.0.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/LICENSE.txt

@@ -0,0 +1,9 @@
+This project is licensed under the MPL-2.0 license.
+
+
+  MPL-2.0 License: LICENSE-MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/
+
+
+This is equivalent to the following SPDX License Expression: MPL-2.0
+
+Copyright (c) 2025 Miles Georgi

data/README.md

@@ -0,0 +1,118 @@
+# Foobara::JsonrpcConnector
+
+Provides a way to invoke Foobara commands over Jsonrpc version 2.0.
+
+This does not provide a transport mechanism as jsonrpc itself is transport-agnostic.
+
+Implements the full spec including batched requests, errors, and "notifications" as defined by the spec located here:
+https://www.jsonrpc.org/specification
+
+## Installation
+
+Typical stuff: add `gem "foobara-jsonrpc-connector` to your Gemfile or .gemspec file. Or even just
+`gem install foobara-jsonrpc-connector` if just playing with it directly in scripts.
+
+## Usage
+
+Here's an example of exposing a ComputeExponent command via jsonrpc:
+
+```ruby
+#!/usr/bin/env ruby
+
+require "foobara/jsonrpc_connector"
+
+class ComputeExponent < Foobara::Command
+  inputs do
+    base :integer, :required
+    exponent :integer, :required
+  end
+
+  result :integer
+
+  def execute
+    calculate_exponent
+
+    calculation
+  end
+
+  attr_accessor :calculation
+
+  def calculate_exponent
+    self.calculation = base ** exponent
+  end
+end
+
+connector = Foobara::JsonrpcConnector.new
+connector.connect(ComputeExponent)
+
+puts connector.run('{"jsonrpc": "2.0",
+                     "method": "ComputeExponent",
+                     "params": {"base": 2, "exponent": 3},
+                     "id": 100}')
+```
+
+This script outputs:
+
+```
+$ ./compute_exponent.rb 
+{"jsonrpc":"2.0","id":100,"result":8}
+```
+
+Here's an example of a batch of commands:
+
+```ruby
+puts connector.run('[
+  {"jsonrpc": "2.0", "method": "SomeOrg::Math::ComputeExponent", "params": {"base": 2, "exponent": 3}, "id": 10},
+  {"jsonrpc": "2.0", "method": "SomeOrg::Math::ComputeExponent", "params": {"base": 2, "exponent": 3}},
+  {"jsonrpc": "2.0", "method": "SomeOrg::Math::ComputeExponent", "params": {"base": 2, "exponent": 3}, "id": 20}
+]')
+```
+
+Which outputs:
+
+```
+./compute_exponent_batch.rb 
+[{"jsonrpc":"2.0","id":10,"result":8},{"jsonrpc":"2.0","id":20,"result":8}]
+```
+
+Note that we don't get a result for the request in the batch without an ID. This is a "notification" according to the
+spec and is to have no response.
+
+Jsonrpc errors are also implemented. Here's an example:
+
+```ruby
+puts connector.run('{"jsonrpc": "2.0",
+                     "method": "ComputeExponent",
+                     "params": {"exponent": 3},
+                     "id": 100}')
+```
+
+Which outputs:
+
+```
+$ ./compute_exponent_error.rb 
+{"jsonrpc":"2.0","id":100,"error":
+  {"code":-32602,
+   "message":"Missing required attribute base",
+   "data":{"data.base.missing_required_attribute":{
+     "key":"data.base.missing_required_attribute",
+     "path":["base"],
+     "runtime_path":[],
+     "category":"data",
+     "symbol":"missing_required_attribute",
+     "message":"Missing required attribute base",
+     "context":{"attribute_name":"base"},
+     "is_fatal":true}
+   }
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/foobara/jsonrpc-connector
+
+## License
+
+This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.

data/lib/foobara/jsonrpc_connector.rb

@@ -0,0 +1,4 @@
+require "foobara/all"
+require "foobara/command_connectors"
+
+Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/jsonrpc_connector.rb

@@ -0,0 +1,131 @@
+module Foobara
+  class JsonrpcConnector < CommandConnector
+    def initialize(*, capture_unknown_error: true, **, &)
+      super
+    end
+
+    # TODO: maybe introduce a Runner interface?
+    def run(*args, **opts, &)
+      super.body
+    end
+
+    def run_request(request)
+      if request.batch? && !request.error
+        request.batch.each do |batch_request|
+          super(batch_request)
+        end
+
+        build_response(request)
+      else
+        super
+      end
+    end
+
+    # We add a serializer to the top-level request but not to the children of a batch requests
+    def build_request(*, serializers: json_serializer, **, &)
+      super(*, **, serializers:, &)
+    end
+
+    def json_serializer
+      @json_serializer ||= Foobara::CommandConnectors::Serializers::JsonSerializer.new
+    end
+
+    # TODO: Should this be implemented on response object instead??
+    def set_response_body(response)
+      request = response.request
+
+      return if request.notification?
+
+      response.body = if request.valid_batch?
+                        request.batch.map do |batched_request|
+                          batched_request.response.body
+                        end.compact
+                      else
+                        body = { jsonrpc: "2.0", id: request.request_id }
+
+                        if request.error
+                          body.merge(error: { message: request.error.message, code: response.status })
+                        else
+                          outcome = request.outcome
+
+                          if outcome.success?
+                            body.merge(result: outcome.result)
+                          else
+                            body.merge(error: {
+                                         message: outcome.errors_sentence,
+                                         data: outcome.errors_hash,
+                                         code: response.status
+                                       })
+                          end
+                        end
+                      end
+
+      if request.serializer
+        response.body = request.serializer.process_value!(response.body)
+      end
+    end
+
+    def request_to_response(request)
+      response = self.class::Response.new(request:)
+      # TODO: push this up??
+      request.response = response
+      response
+    end
+
+    def set_response_status(response)
+      return if response.request.valid_batch?
+
+      request = response.request
+
+      response.status = if request.error
+                          case request.error
+                          when Request::InvalidJsonrpcVersionError, Request::InvalidJsonrpcMethodError,
+                            Request::InvalidJsonrpcParamsError, Request::EmptyBatchError,
+                            Request::InvalidJsonrpcRequestStructureError
+                            -32_600
+                          when Request::InvalidJsonError
+                            -32_700
+                          when CommandConnector::NotFoundError
+                            -32_601
+                          when Request::FoobaraCommandsDoNotAcceptArraysError
+                            -32_602
+                          else
+                            -32_603
+                          end
+                        elsif request.success?
+                          0
+                        else
+                          errors = request.error_collection.error_array
+                          error = errors.first
+
+                          # Going to steal some http codes to be less confusing
+                          case error
+                          when Foobara::Entity::NotFoundError
+                            # TODO: we should not be coupled to Entities here...
+                            # :nocov:
+                            404
+                            # :nocov:
+                          when CommandConnector::UnauthenticatedError
+                            # :nocov:
+                            401
+                            # :nocov:
+                          when CommandConnector::NotAllowedError
+                            # :nocov:
+                            403
+                            # :nocov:
+                          when CommandConnector::UnknownError
+                            -32_603
+                          when Foobara::DataError
+                            -32_602
+                          end || -32_600
+                        end
+    end
+
+    def request_to_command(request)
+      super
+    rescue CommandConnector::NoCommandFoundError => e
+      request.error = e
+      nil
+    end
+  end
+end

data/src/request.rb

@@ -0,0 +1,145 @@
+module Foobara
+  class JsonrpcConnector < CommandConnector
+    class Request < CommandConnector::Request
+      class InvalidJsonrpcVersionError < StandardError; end
+      class InvalidJsonrpcMethodError < StandardError; end
+      class InvalidJsonrpcParamsError < StandardError; end
+      class InvalidJsonrpcRequestStructureError < StandardError; end
+      class EmptyBatchError < StandardError; end
+      class InvalidJsonError < StandardError; end
+      class FoobaraCommandsDoNotAcceptArraysError < StandardError; end
+
+      attr_accessor :raw_request_json, :parsed_request_body, :request_id, :batch, :is_batch_child, :response
+
+      def initialize(request_json, *, serializers: nil, is_batch_child: false, **, &)
+        self.is_batch_child = is_batch_child
+        self.raw_request_json = request_json
+
+        set_parsed_json
+
+        unless error
+          if batch?
+            unless error
+              self.batch = parsed_request_body.map do |request|
+                self.class.new(request, *, is_batch_child: true, **, &)
+              end
+            end
+
+            validate_batch_not_empty
+          else
+            validate_request_structure
+
+            unless error
+              self.request_id = parsed_request_body["id"]
+
+              verify_jsonrpc_version
+
+              unless error
+                full_command_name = parsed_request_body["method"]
+                inputs = if parsed_request_body.key?("params")
+                           parsed_request_body["params"]
+                         else
+                           {}
+                         end
+              end
+            end
+          end
+        end
+
+        if batch? || error
+          full_command_name = inputs = nil
+        end
+
+        super(*, full_command_name:, inputs:, action: "run", serializers:, **, &)
+
+        validate_inputs_and_name
+      end
+
+      def set_parsed_json
+        self.parsed_request_body = if batch_child?
+                                     raw_request_json
+                                   else
+                                     begin
+                                       JSON.parse(raw_request_json)
+                                     rescue => e
+                                       self.error = InvalidJsonError.new("Could not parse request: #{e.message}")
+                                       error.set_backtrace(caller)
+                                       nil
+                                     end
+                                   end
+      end
+
+      def verify_jsonrpc_version
+        if parsed_request_body["jsonrpc"] != "2.0"
+          self.error = InvalidJsonrpcVersionError.new("Unsupported jsonrpc version: #{parsed_request_body["jsonrpc"]}")
+          error.set_backtrace(caller)
+        end
+      end
+
+      def batch_child?
+        is_batch_child
+      end
+
+      def notification?
+        return false if response&.status == -32_600
+
+        if parsed_request_body
+          if valid_batch?
+            batch.all?(&:notification?)
+          else
+            parsed_request_body.is_a?(::Hash) && !parsed_request_body.key?("id")
+          end
+        end
+      end
+
+      def batch?
+        parsed_request_body.is_a?(::Array)
+      end
+
+      def valid_batch?
+        batch? && batch && !batch.empty?
+      end
+
+      def validate_inputs_and_name
+        return if error
+        return if batch?
+
+        unless full_command_name.is_a?(String)
+          self.error = InvalidJsonrpcMethodError.new(
+            "Invalid jsonrpc method. Expected a string got #{full_command_name}"
+          )
+          error.set_backtrace(caller)
+          return
+        end
+
+        unless inputs.is_a?(::Hash)
+          self.error = if inputs.is_a?(::Array)
+                         FoobaraCommandsDoNotAcceptArraysError.new(
+                           "Foobara commands do not accept arrays as inputs"
+                         )
+                       else
+                         InvalidJsonrpcParamsError.new("Invalid jsonrpc params. Expected a hash got #{inputs}")
+                       end
+
+          error.set_backtrace(caller)
+        end
+      end
+
+      def validate_batch_not_empty
+        if batch? && batch.empty?
+          self.error = EmptyBatchError.new("An empty array/batch is not allowed")
+          error.set_backtrace(caller)
+        end
+      end
+
+      def validate_request_structure
+        unless parsed_request_body.is_a?(::Hash)
+          self.error = InvalidJsonrpcRequestStructureError.new(
+            "Invalid jsonrpc request structure. Expected a hash but got #{parsed_request_body}"
+          )
+          error.set_backtrace(caller)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: foobara-jsonrpc-connector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miles Georgi
+bindir: bin
+cert_chain: []
+date: 2025-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foobara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.94
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.94
+email:
+- azimux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE-MPL-2.0.txt
+- LICENSE.txt
+- README.md
+- lib/foobara/jsonrpc_connector.rb
+- src/jsonrpc_connector.rb
+- src/request.rb
+homepage: https://github.com/foobara/jsonrpc-connector
+licenses:
+- MPL-2.0
+metadata:
+  homepage_uri: https://github.com/foobara/jsonrpc-connector
+  source_code_uri: https://github.com/foobara/jsonrpc-connector
+  changelog_uri: https://github.com/foobara/jsonrpc-connector/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: No description. Add one.
+test_files: []