https://github.com/handofgod94/json_rpc
https://github.com/handofgod94/json_rpc
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/handofgod94/json_rpc
- Owner: HandOfGod94
- Created: 2025-04-12T18:33:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T18:50:32.000Z (7 months ago)
- Last Synced: 2025-04-12T19:35:11.369Z (7 months ago)
- Language: Ruby
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON-RPC
A lightweight, transport-agnostic JSON-RPC 1.0 implementation in Ruby that provides a simple way to handle JSON-RPC requests and responses.
> **Note:** This project is currently a work in progress. It implements JSON-RPC 1.0 specification and is being actively developed.
## Features
- Simple and clean API for handling JSON-RPC requests
- Built-in request validation
- Customizable routing system with yield-based DSL
- Error handling for common JSON-RPC scenarios
- Transport-agnostic design (works with HTTP, WebSocket, or any other transport layer)
- JSON-RPC 1.0 specification compliant
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'json_rpc'
```
And then execute:
```bash
$ bundle install
```
Or install it yourself as:
```bash
$ gem install json_rpc
```
## Usage
```ruby
require 'json_rpc'
# Define your routes using the yield-based router
router = JsonRpc::Router.define do |r|
r.rpc :add do |a, b|
a + b
end
r.rpc :ping do
'pong'
end
end
# Handle a request using invoke
request = '{"jsonrpc": "1.0", "method": "add", "params": [1, 2], "id": 1}'
response = router.invoke(request)
puts response.to_json
# => {"jsonrpc":"1.0","result":3,"id":1}
# Handle a ping request
request = '{"jsonrpc": "1.0", "method": "ping", "params": [], "id": 2}'
response = router.invoke(request)
puts response.to_json
# => {"jsonrpc":"1.0","result":"pong","id":2}
```
## Development
After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.