jsonrpc-middleware 0.1.0 → 0.2.0

data/examples/rails/config/environments/test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # While tests run files are not watched, reloading is not necessary.
+  config.enable_reloading = false
+
+  # Eager loading loads your entire application. When running a single test locally,
+  # this is usually not necessary, and can slow down your test suite. However, it's
+  # recommended that you enable it in continuous integration systems to ensure eager
+  # loading is working properly before deploying your code.
+  config.eager_load = ENV['CI'].present?
+
+  # Configure public file server for tests with cache-control for performance.
+  config.public_file_server.headers = { 'cache-control' => 'public, max-age=3600' }
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+  config.cache_store = :null_store
+
+  # Render exception templates for rescuable exceptions and raise for other exceptions.
+  config.action_dispatch.show_exceptions = :rescuable
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Raise error when a before_action's only/except options reference missing actions.
+  config.action_controller.raise_on_missing_callback_actions = true
+end

data/examples/rails/config/initializers/cors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin Ajax requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins "example.com"
+#
+#     resource "*",
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/examples/rails/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file.
+# Use this to limit dissemination of sensitive information.
+# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors.
+Rails.application.config.filter_parameters += %i[
+  passw email secret token _key crypt salt certificate otp ssn cvv cvc
+]

data/examples/rails/config/initializers/inflections.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/examples/rails/config/initializers/jsonrpc.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../../procedures'
+
+# JSONRPC.configure do |config|
+#   config.log_internal_errors = true           # Log internal error backtraces (default: true)
+#   config.log_request_validation_errors = true # Log JSON-RPC request validation errors (default: false)
+#   config.render_internal_errors = true        # Render internal error information in responses (default: true)
+#   config.rescue_internal_errors = true        # Handle and serialize internal errors (default: true)
+#
+#   # Allow 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
+#
+#   procedure(:subtract) do
+#     params do
+#       required(:minuend).filled(:integer)
+#       required(:subtrahend).filled(:integer)
+#     end
+#   end
+#
+#   procedure(:multiply) do
+#     params do
+#       required(:multiplicand).filled
+#       required(:multiplier).filled
+#     end
+#
+#     rule(:multiplicand) do
+#       key.failure('must be a number') unless value.is_a?(Numeric)
+#     end
+#
+#     rule(:multiplier) do
+#       key.failure('must be a number') unless value.is_a?(Numeric)
+#     end
+#   end
+#
+#   procedure(:divide) do
+#     params do
+#       required(:dividend).filled(:integer)
+#       required(:divisor).filled(:integer)
+#     end
+#
+#     rule(:divisor) do
+#       key.failure('cannot be zero') if value.zero?
+#     end
+#   end
+#
+#   # Used only to test internal server errors
+#   procedure(:explode) do
+#     params do
+#       # No params
+#     end
+#   end
+# end

data/examples/rails/config/locales/en.yml

@@ -0,0 +1,31 @@
+# Files in the config/locales directory are used for internationalization and
+# are automatically loaded by Rails. If you want to use locales other than
+# English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more about the API, please read the Rails Internationalization guide
+# at https://guides.rubyonrails.org/i18n.html.
+#
+# Be aware that YAML interprets the following case-insensitive strings as
+# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings
+# must be quoted to be interpreted as strings. For example:
+#
+#     en:
+#       "yes": yup
+#       enabled: "ON"
+
+en:
+  hello: "Hello world"

data/examples/rails/config/puma.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This configuration file will be evaluated by Puma. The top-level methods that
+# are invoked here are part of Puma's configuration DSL. For more information
+# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
+#
+# Puma starts a configurable number of processes (workers) and each process
+# serves each request in a thread from an internal thread pool.
+#
+# You can control the number of workers using ENV["WEB_CONCURRENCY"]. You
+# should only set this value when you want to run 2 or more workers. The
+# default is already 1.
+#
+# The ideal number of threads per worker depends both on how much time the
+# application spends waiting for IO operations and on how much you wish to
+# prioritize throughput over latency.
+#
+# As a rule of thumb, increasing the number of threads will increase how much
+# traffic a given process can handle (throughput), but due to CRuby's
+# Global VM Lock (GVL) it has diminishing returns and will degrade the
+# response time (latency) of the application.
+#
+# The default is set to 3 threads as it's deemed a decent compromise between
+# throughput and latency for the average Rails application.
+#
+# Any libraries that use a connection pool or another resource pool should
+# be configured to provide at least as many connections as the number of
+# threads. This includes Active Record's `pool` parameter in `database.yml`.
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 3)
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+port ENV.fetch('PORT', 3000)
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart
+
+# Specify the PID file. Defaults to tmp/pids/server.pid in development.
+# In other environments, only set the PID file if requested.
+pidfile ENV['PIDFILE'] if ENV['PIDFILE']

data/examples/rails/config/routes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the app is live.
+  get 'up' => 'rails/health#show', as: :rails_health_check
+
+  post '/', to: 'jsonrpc#handle'
+
+  # Defines the root path route ("/")
+  # root "posts#index"
+end

data/examples/rails/config.ru

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application
+Rails.application.load_server

data/examples/rails/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/examples/rails-single-file/config.ru

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  gem 'rails', '~> 8.0.2'
+  gem 'puma', '~> 6.6.0'
+  gem 'jsonrpc-middleware', path: '../../', require: 'jsonrpc'
+end
+
+require 'rails'
+require 'action_controller/railtie'
+
+JSONRPC.configure do |config|
+  config.rescue_internal_errors = true # set to +false+ if you want to raise JSONRPC::InternalError manually
+
+  procedure(:echo) do
+    params do
+      required(:message).filled(:string)
+    end
+  end
+end
+
+# Define the application
+class App < Rails::Application
+  config.root = __dir__
+  config.cache_classes = true
+  config.eager_load = true
+  config.active_support.deprecation = :stderr
+  config.consider_all_requests_local = true
+  config.active_support.to_time_preserves_timezone = :zone
+  config.logger = nil
+  config.hosts.clear
+
+  routes.append do
+    post '/', to: 'jsonrpc#handle'
+  end
+end
+
+# Define the JSONRPC controller
+class JsonrpcController < ActionController::Base
+  def handle
+    if jsonrpc_request?
+      result = handle_single(jsonrpc_request)
+      render jsonrpc: result
+    elsif jsonrpc_notification?
+      handle_single(jsonrpc_notification)
+      render jsonrpc: nil
+    else
+      responses = handle_batch(jsonrpc_batch)
+      render jsonrpc: responses
+    end
+  end
+
+  private
+
+  def handle_single(request_or_notification) = request_or_notification.params
+
+  def handle_batch(batch)
+    batch.flat_map do |request_or_notification|
+      result = handle_single(request_or_notification)
+      JSONRPC::Response.new(id: request_or_notification.id, result:) if request_or_notification.is_a?(JSONRPC::Request)
+    end.compact
+  end
+end
+
+App.initialize!
+
+run App

data/examples/sinatra-classic/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jsonrpc-middleware', path: '../..'
+gem 'puma'
+gem 'rackup'
+gem 'sinatra'
+gem 'sinatra-contrib'

data/examples/sinatra-classic/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ../..
+  specs:
+    jsonrpc-middleware (0.1.0)
+      dry-validation (~> 1.11)
+      zeitwerk (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-core (1.1.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.2.0)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-schema (1.14.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.5)
+      dry-types (~> 1.8)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-schema (~> 1.14)
+      zeitwerk (~> 2.6)
+    logger (1.7.0)
+    multi_json (1.15.0)
+    mustermann (3.0.3)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.7.4)
+    puma (6.6.0)
+      nio4r (~> 2.0)
+    rack (3.1.13)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rackup (2.2.1)
+      rack (>= 3)
+    ruby2_keywords (0.0.5)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    sinatra-contrib (4.1.1)
+      multi_json (>= 0.0.2)
+      mustermann (~> 3.0)
+      rack-protection (= 4.1.1)
+      sinatra (= 4.1.1)
+      tilt (~> 2.0)
+    tilt (2.6.0)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  jsonrpc-middleware!
+  puma
+  rackup
+  sinatra
+  sinatra-contrib
+
+BUNDLED WITH
+   2.6.8

data/examples/sinatra-classic/README.md

@@ -0,0 +1,32 @@
+# Sinatra Classic Calculator
+
+A JSON-RPC calculator server using classic Sinatra style.
+
+## Running
+
+```sh
+bundle install
+bundle exec rackup
+```
+
+## API
+
+The server implements a calculator with these procedures:
+
+- `add` - Add numbers (supports both positional and named arguments)
+- `subtract` - Subtract two numbers  
+- `multiply` - Multiply two numbers
+- `divide` - Divide two numbers
+- `explode` - Test procedure that throws an error
+
+## Example Requests
+
+```sh
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "add", "params": {"addends": [1, 2, 3]}, "id": 1}'
+
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 10, "subtrahend": 3}, "id": 2}'
+```

data/examples/sinatra-classic/app.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+require 'sinatra/json'
+require 'jsonrpc'
+
+set :host_authorization, permitted_hosts: []
+set :raise_errors, true
+set :show_exceptions, false
+
+use JSONRPC::Middleware
+helpers JSONRPC::Helpers
+
+post '/' do
+  @env = env # Set the @env instance variable to use the JSONRPC helpers below
+
+  if jsonrpc_request?
+    result = handle_single(jsonrpc_request)
+    jsonrpc_response(result)
+  elsif jsonrpc_notification?
+    handle_single(jsonrpc_notification)
+    jsonrpc_notification_response
+  else
+    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'
+    addends = params.is_a?(Array) ? params : params['addends'] # Handle positional and named arguments
+    addends.sum
+  when 'subtract'
+    params['minuend'] - params['subtrahend']
+  when 'multiply'
+    params['multiplicand'] * params['multiplier']
+  when 'divide'
+    params['dividend'] / params['divisor']
+  when 'explode'
+    raise 'An internal error has occurred.'
+  end
+end
+
+def handle_batch(batch)
+  batch.flat_map do |request_or_notification|
+    result = handle_single(request_or_notification)
+    JSONRPC::Response.new(id: request_or_notification.id, result:) if request_or_notification.is_a?(JSONRPC::Request)
+  end.compact
+end

data/examples/sinatra-classic/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require './app'
+require '../procedures'
+
+run Sinatra::Application

data/examples/sinatra-modular/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jsonrpc-middleware', path: '../..'
+gem 'puma'
+gem 'rackup'
+gem 'sinatra'
+gem 'sinatra-contrib'

data/examples/sinatra-modular/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ../..
+  specs:
+    jsonrpc-middleware (0.1.0)
+      dry-validation (~> 1.11)
+      zeitwerk (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    dry-configurable (1.3.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-core (1.1.0)
+      concurrent-ruby (~> 1.0)
+      logger
+      zeitwerk (~> 2.6)
+    dry-inflector (1.2.0)
+    dry-initializer (3.2.0)
+    dry-logic (1.6.0)
+      bigdecimal
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      zeitwerk (~> 2.6)
+    dry-schema (1.14.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-logic (~> 1.5)
+      dry-types (~> 1.8)
+      zeitwerk (~> 2.6)
+    dry-types (1.8.3)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.1)
+      dry-initializer (~> 3.2)
+      dry-schema (~> 1.14)
+      zeitwerk (~> 2.6)
+    logger (1.7.0)
+    multi_json (1.15.0)
+    mustermann (3.0.3)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.7.4)
+    puma (6.6.0)
+      nio4r (~> 2.0)
+    rack (3.1.13)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rackup (2.2.1)
+      rack (>= 3)
+    ruby2_keywords (0.0.5)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    sinatra-contrib (4.1.1)
+      multi_json (>= 0.0.2)
+      mustermann (~> 3.0)
+      rack-protection (= 4.1.1)
+      sinatra (= 4.1.1)
+      tilt (~> 2.0)
+    tilt (2.6.0)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  jsonrpc-middleware!
+  puma
+  rackup
+  sinatra
+  sinatra-contrib
+
+BUNDLED WITH
+   2.6.8

data/examples/sinatra-modular/README.md

@@ -0,0 +1,32 @@
+# Sinatra Modular Calculator
+
+A JSON-RPC calculator server using modular Sinatra (Sinatra::Base).
+
+## Running
+
+```sh
+bundle install
+bundle exec rackup
+```
+
+## API
+
+The server implements a calculator with these procedures:
+
+- `add` - Add numbers (supports both positional and named arguments)
+- `subtract` - Subtract two numbers  
+- `multiply` - Multiply two numbers
+- `divide` - Divide two numbers
+- `explode` - Test procedure that throws an error
+
+## Example Requests
+
+```sh
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "add", "params": {"addends": [1, 2, 3]}, "id": 1}'
+
+curl -X POST http://localhost:9292 \
+  -H "Content-Type: application/json" \
+  -d '{"jsonrpc": "2.0", "method": "multiply", "params": {"multiplicand": 6, "multiplier": 7}, "id": 3}'
+```