clamo 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a648eb843f70c35499806bb4f53736046560d333af184759917ff10f321dbe
-  data.tar.gz: ce450a2e07864e7908ec0321f1f1f116168dbe6fd7ae7cc054bffc84442f33d5
+  metadata.gz: 93acbb6067140d2268cec5379f519ab6e693949f36f76e3933f8a93c246dbd96
+  data.tar.gz: 6811ac69e7b7b405991d2b1ce73e7138f4fb0709101e482da7f3744826dec592
 SHA512:
-  metadata.gz: 242c0a8d44b69ada88887001943213ab8a6cd074eecfec4482e08de60b39d505df2fd58b4e34a7f00b2266250e3d54f07bc187b036dc08d47889ec1fe55d6140
-  data.tar.gz: 4c72e3384fd958d1e9fe2a5a5b0ae607c4a667fbb9bc69eb04b1c8a10889ced46fd7caa47e8cc8f413dc5aec1746104c509c83165ec70863b4e02cc717090845
+  metadata.gz: 1c83b16bd8e702714fca22d0277206538f22c560f795ed01f8ae76268304209b2ae0669e988e3897725a62856fe286832ffe3f3993cdd99040659a4178373efb
+  data.tar.gz: bed60d4e01db858ea8875c420258c5754efdaa21a34cdb35b337c13168c811f6c2f7945f0510680fb872644ddf9d872a9a30f7ecbd164010d4eddf3d8dac7edc

data/README.md

@@ -14,15 +14,153 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install clamo
 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machi# Clamo
+
+A Ruby implementation of [JSON-RPC 2.0](https://www.jsonrpc.org/specification) designed for simplicity and compliance with the specification.
+
+
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+```ruby
+require 'clamo'
+
+# Define a service object with methods you want to expose
+module MyService
+  def self.add(a, b)
+    a + b
+  end
+  
+  def self.subtract(a:, b:)
+    a - b
+  end
+  
+  # Private methods won't be accessible via JSON-RPC
+  private_class_method def self.internal_method
+    # This won't be exposed
+  end
+end
+
+# Handle a JSON-RPC request
+request_body = '{"jsonrpc": "2.0", "method": "add", "params": [1, 2], "id": 1}'
+response = Clamo::Server.unparsed_dispatch_to_object(
+  request: request_body,
+  object: MyService
+)
+
+puts response
+# => {"jsonrpc":"2.0","result":3,"id":1}
+```
+
+### Handling Different Parameter Types
+
+Clamo supports both positional (array) and named (object/hash) parameters:
+
+```ruby
+# Positional parameters
+request = '{"jsonrpc": "2.0", "method": "add", "params": [1, 2], "id": 1}'
+
+# Named parameters
+request = '{"jsonrpc": "2.0", "method": "subtract", "params": {"a": 5, "b": 3}, "id": 2}'
+```
+
+### Batch Requests
+
+Clamo handles batch requests automatically:
+
+```ruby
+batch_request = <<~JSON
+[
+  {"jsonrpc": "2.0", "method": "add", "params": [1, 2], "id": 1},
+  {"jsonrpc": "2.0", "method": "subtract", "params": {"a": 5, "b": 3}, "id": 2}
+]
+JSON
+
+batch_response = Clamo::Server.unparsed_dispatch_to_object(
+  request: batch_request,
+  object: MyService
+)
+
+puts batch_response
+# => [{"jsonrpc":"2.0","result":3,"id":1},{"jsonrpc":"2.0","result":2,"id":2}]
+```
+
+### Notifications
+
+Notifications are requests without an ID field. They don't produce a response:
+
+```ruby
+notification = '{"jsonrpc": "2.0", "method": "add", "params": [1, 2]}'
+response = Clamo::Server.unparsed_dispatch_to_object(
+  request: notification,
+  object: MyService
+)
+
+puts response
+# => nil
+```
+
+### Building JSON-RPC Requests
+
+Clamo provides utilities for building JSON-RPC requests:
+
+```ruby
+request = Clamo::JSONRPC.build_request(
+  method: "add",
+  params: [1, 2],
+  id: 1
+)
+
+puts request
+# => {:jsonrpc=>"2.0", :method=>"add", :params=>[1, 2], :id=>1}
+```
+
+## Error Handling
+
+Clamo follows the JSON-RPC 2.0 specification for error handling:
+
+| Error Code | Message          | Description                                          |
+|------------|------------------|------------------------------------------------------|
+| -32700     | Parse error      | Invalid JSON was received                            |
+| -32600     | Invalid request  | The JSON sent is not a valid Request object          |
+| -32601     | Method not found | The method does not exist / is not available         |
+| -32602     | Invalid params   | Invalid method parameter(s)                          |
+| -32603     | Internal error   | Internal JSON-RPC error                              |
+| -32000     | Server error     | Reserved for implementation-defined server errors    |
+
+## Advanced Features
+
+### Parallel Processing
+
+Batch requests are processed in parallel using the [parallel](https://github.com/grosser/parallel) gem. You can pass options to `Parallel.map` via the `parsed_dispatch_to_object` method:
+
+```ruby
+Clamo::Server.parsed_dispatch_to_object(
+  request: batch_request,
+  object: MyService,
+  in_processes: 4  # Parallel processing option
+)
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/clamo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).ne, run `bundle exec rake install`. 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).
 
 ## Contributing
 

data/lib/clamo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clamo
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clamo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andriy Tyurnikov