jsonrpc-middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e61b560d7db3538454d0d5206eaea1fc2a86a01b25294c4d56de4b6237dd120
+  data.tar.gz: 1d7255ba3a462bbc9d53efbec3ba9b242f773b2c4fa270de280b951ea3b05743
+SHA512:
+  metadata.gz: b3d9b2f802ac5ffd1f342c45d00e001113ebf857e09208deac8560dd75a06f6201bcc4e7a99f0184cb6c1a48497d70e922d59d7f6b476c93f530584b60fa0066
+  data.tar.gz: b07c00f97c85c9a41f82decf00dbf58f10c2655e1011f0e3e6d5e63ff2f90cee88e310f6c892a8d49c2ec94aea5cfa7dccdf9292b7940256f82b1591823df2e2

data/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle exec rspec:*)",
+      "Bash(bundle exec rubocop:*)"
+    ]
+  },
+  "enableAllProjectMcpServers": false
+}

data/.editorconfig

@@ -0,0 +1,11 @@
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true
+
+# 2 space indentation
+[*.rb]
+indent_style = space
+indent_size = 2

data/.overcommit.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+  TrailingWhitespace:
+    enabled: true
+
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,74 @@
+plugins:
+  - rubocop-factory_bot
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.4
+  DisplayCopNames: true
+  NewCops: enable
+
+# ----------------------- Gemspec -----------------------
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# ----------------------- Style -----------------------
+
+Style/MixinUsage:
+  Exclude:
+    - bin/console
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# ----------------------- Layout ----------------------
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - jsonrpc-middleware.gemspec
+
+# ---------------------- Metrics ----------------------
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# ----------------------- RSpec -----------------------
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# RuboCop does not like the gem's name.
+RSpec/SpecFilePathFormat:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.4

data/.yardstick.yml

@@ -0,0 +1,22 @@
+threshold: 100
+rules:
+  ApiTag::Presence:
+    enabled: true
+  ApiTag::Inclusion:
+    enabled: true
+  ApiTag::ProtectedMethod:
+    enabled: true
+  ApiTag::PrivateMethod:
+    enabled: true
+  ExampleTag:
+    enabled: true
+  ReturnTag:
+    enabled: true
+  Summary::Presence:
+    enabled: true
+  Summary::Length:
+    enabled: false
+  Summary::Delimiter:
+    enabled: true
+  Summary::SingleLine:
+    enabled: false

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-06-14
+
+### Added
+- Initial release of the JSON-RPC 2.0 middleware for Rack applications
+- Complete implementation of the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification)
+- Core components:
+  - `JSONRPC::Middleware` for handling JSON-RPC requests in Rack applications
+  - `JSONRPC::Parser` for parsing and validating JSON-RPC requests
+  - `JSONRPC::Validator` for validating procedure parameters
+  - `JSONRPC::Configuration` for registering and managing procedures
+- Support for all JSON-RPC request types:
+  - Single requests with responses
+  - Notifications (requests without responses)
+  - Batch requests (multiple requests/notifications in a single call)
+- Parameter validation via Dry::Validation:
+  - Support for both positional and named arguments
+  - Customizable validation rules and error messages
+- Comprehensive error handling:
+  - Parse errors
+  - Invalid request errors
+  - Method not found errors
+  - Invalid params errors
+  - Internal errors
+- Helper methods for request and response processing
+- Examples for basic and advanced usage scenarios
+
+[Unreleased]: https://github.com/wilsonsilva/jsonrpc-middleware/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/wilsonsilva/jsonrpc-middleware/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Guardfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+guard 'bundler' do
+  watch('jsonrpc-middleware.gemspec')
+end
+
+guard 'bundler_audit', run_on_start: true do
+  watch('Gemfile.lock')
+end
+
+group 'tests' do
+  guard 'rspec', all_on_start: true, failed_mode: :focus, cmd: 'COVERAGE=false bundle exec rspec --format progress' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end
+
+guard 'rubocop' do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Wilson Silva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+# JSONRPC::Middleware - Ruby JSON-RPC Implementation
+
+[![Gem Version](https://badge.fury.io/rb/jsonrpc-middleware.svg)](https://badge.fury.io/rb/jsonrpc-middleware)
+![Build](https://github.com/wilsonsilva/jsonrpc-middleware/actions/workflows/main.yml/badge.svg)
+[![Maintainability](https://qlty.sh/badges/73ebc4bb-d1db-4b5b-9a7c-a4acd59dfe69/maintainability.svg)](https://qlty.sh/gh/wilsonsilva/projects/jsonrpc-middleware)
+[![Code Coverage](https://qlty.sh/badges/73ebc4bb-d1db-4b5b-9a7c-a4acd59dfe69/test_coverage.svg)](https://qlty.sh/gh/wilsonsilva/projects/jsonrpc-middleware)
+
+A Ruby implementation of the JSON-RPC protocol, enabling standardized communication between systems via remote procedure
+calls encoded in JSON.
+
+## Table of contents
+
+- [Key features](#-key-features)
+- [Installation](#-installation)
+- [Quickstart](#-quickstart)
+- [Documentation](#-documentation)
+- [Development](#-development)
+  * [Type checking](#type-checking)
+- [Contributing](#-contributing)
+- [License](#-license)
+- [Code of Conduct](#-code-of-conduct)
+
+## 🔑 Key features
+
+- **Complete JSON-RPC 2.0 Implementation**: Fully implements the [JSON-RPC 2.0 specification](https://www.jsonrpc.org/specification)
+- **Rack Middleware integration**: Seamlessly integrates with Rack applications
+- **Advanced request validation**: Define request parameter specifications and validations using `Dry::Validation`
+- **Support for all request types**: Handles single requests, notifications, and batch requests
+- **Parameter validation**: Supports both positional and named arguments with customizable validation rules
+- **Error handling**: Comprehensive error handling with standard JSON-RPC error responses
+- **Helper methods**: Convenient helper methods to simplify request and response processing
+- **Type checking**: Ruby type checking support via RBS definitions
+
+## 📦 Installation
+
+Install the gem by executing:
+
+    $ gem install jsonrpc-middleware
+
+## ⚡️ Quickstart
+
+### Basic Setup with Rack
+
+```ruby
+# Gemfile
+source 'https://rubygems.org'
+gem 'jsonrpc-middleware'
+gem 'rack'
+```
+
+```ruby
+# config.ru
+require 'jsonrpc'
+require_relative 'app'
+
+# Use the middleware
+use JSONRPC::Middleware
+
+# Your application
+run App.new
+```
+
+### Define Your JSON-RPC Procedures
+
+Define your available procedures with validation rules:
+
+```ruby
+# procedures.rb
+require 'jsonrpc'
+
+JSONRPC.configure do
+  # Define a procedure that accepts both positional and named arguments
+  procedure(:add, allow_positional_arguments: true) do
+    params do
+      required(:addends).filled(:array)
+      required(:addends).value(:array).each(type?: Numeric)
+    end
+
+    rule(:addends) do
+      key.failure('must contain at least one addend') if value.empty?
+    end
+  end
+
+  # Define a procedure with named arguments only
+  procedure(:subtract) do
+    params do
+      required(:minuend).filled(:integer)
+      required(:subtrahend).filled(:integer)
+    end
+  end
+end
+```
+
+### Create Your Application
+
+```ruby
+# app.rb
+class App
+  include JSONRPC::Helpers
+
+  def call(env)
+    @env = env # Set the env instance variable to use JSONRPC helpers
+
+    if jsonrpc_request?
+      # Handle a standard JSON-RPC request
+      result = handle_single(jsonrpc_request)
+      jsonrpc_response(result)
+    elsif jsonrpc_notification?
+      # Handle a notification (no response needed)
+      handle_single(jsonrpc_notification)
+      jsonrpc_notification_response
+    else
+      # Handle batch requests
+      responses = handle_batch(jsonrpc_batch)
+      jsonrpc_batch_response(responses)
+    end
+  end
+
+  private
+
+  def handle_single(request_or_notification)
+    params = request_or_notification.params
+
+    case request_or_notification.method
+    when 'add'
+      # Handle both positional and named arguments
+      addends = params.is_a?(Array) ? params : params['addends']
+      addends.sum
+    when 'subtract'
+      params['minuend'] - params['subtrahend']
+    end
+  end
+
+  def handle_batch(batch)
+    batch.flat_map do |request_or_notification|
+      result = handle_single(request_or_notification)
+      # Only create responses for requests, not notifications
+      JSONRPC::Response.new(id: request_or_notification.id, result: result) if request_or_notification.is_a?(JSONRPC::Request)
+    end.compact
+  end
+end
+```
+
+### Example Requests
+
+Here are example JSON-RPC requests you can make to your application:
+
+```json
+// Standard request with named params
+{
+  "jsonrpc": "2.0",
+  "method": "subtract",
+  "params": {
+    "minuend": 42,
+    "subtrahend": 23
+  },
+  "id": 1
+}
+
+// Request with positional params (if allowed)
+{
+  "jsonrpc": "2.0",
+  "method": "add",
+  "params": [1, 2, 3, 4, 5],
+  "id": 2
+}
+
+// Notification (no response)
+{
+  "jsonrpc": "2.0",
+  "method": "add",
+  "params": {"addends": [1, 2, 3]}
+}
+
+// Batch request
+[
+  {"jsonrpc": "2.0", "method": "add", "params": {"addends": [1, 2]}, "id": 1},
+  {"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 10, "subtrahend": 5}, "id": 2}
+]
+```
+
+## 📚 Documentation
+
+- [YARD documentation](https://rubydoc.info/gems/jsonrpc-middleware)
+
+## 🔨 Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+The health and maintainability of the codebase is ensured through a set of
+Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
+
+```
+rake build                    # Build jsonrpc-middleware.gem into the pkg directory
+rake build:checksum           # Generate SHA512 checksum if jsonrpc-middleware.gem into the checksums directory
+rake bundle:audit:check       # Checks the Gemfile.lock for insecure dependencies
+rake bundle:audit:update      # Updates the bundler-audit vulnerability database
+rake clean                    # Remove any temporary products
+rake clobber                  # Remove any generated files
+rake coverage                 # Run spec with coverage
+rake install                  # Build and install jsonrpc-middleware.gem into system gems
+rake install:local            # Build and install jsonrpc-middleware.gem into system gems without network access
+rake qa                       # Test, lint and perform security and documentation audits
+rake release[remote]          # Create a tag, build and push jsonrpc-middleware.gem to rubygems.org
+rake rubocop                  # Run RuboCop
+rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
+rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
+rake spec                     # Run RSpec code examples
+rake verify_measurements      # Verify that yardstick coverage is at least 100%
+rake yard                     # Generate YARD Documentation
+rake yard:junk                # Check the junk in your YARD Documentation
+rake yardstick_measure        # Measure docs in lib/**/*.rb with yardstick
+```
+
+### Type checking
+
+This gem leverages [RBS](https://github.com/ruby/rbs), a language to describe the structure of Ruby programs. It is
+used to provide type checking and autocompletion in your editor. Run `bundle exec typeprof FILENAME` to generate
+an RBS definition for the given Ruby file. And validate all definitions using [Steep](https://github.com/soutaro/steep)
+with the command `bundle exec steep check`.
+
+## 🐞 Issues & Bugs
+
+If you find any issues or bugs, please report them [here](https://github.com/wilsonsilva/jsonrpc-middleware/issues), I will be happy
+to have a look at them and fix them as soon as possible.
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/jsonrpc-middleware.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [code of conduct](https://github.com/wilsonsilva/jsonrpc-middleware/blob/main/CODE_OF_CONDUCT.md).
+
+## 📜 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 👔 Code of Conduct
+
+Everyone interacting in the JSONRPC::Middleware Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected
+to follow the [code of conduct](https://github.com/wilsonsilva/jsonrpc-middleware/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'bundler/audit/task'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yaml'
+require 'yard/rake/yardoc_task'
+require 'yard-junk/rake'
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+
+yardstick_options = YAML.load_file('.yardstick.yml')
+
+Bundler::Audit::Task.new
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-yard'
+end
+YARD::Rake::YardocTask.new
+YardJunk::Rake.define_task
+Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
+Yardstick::Rake::Verify.new
+
+task default: %i[spec rubocop]
+
+# Remove the report on rake clobber
+CLEAN.include('measurements', 'doc', '.yardoc', 'tmp')
+
+# Delete these files and folders when running rake clobber.
+CLOBBER.include('coverage', '.rspec_status')
+
+desc 'Run spec with coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+  `open coverage/index.html`
+end
+
+desc 'Test, lint and perform security and documentation audits'
+task qa: %w[spec rubocop yard:junk verify_measurements bundle:audit]

data/Steepfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+end