https://github.com/y-yagi/grpc_reflection
https://github.com/y-yagi/grpc_reflection
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/y-yagi/grpc_reflection
- Owner: y-yagi
- License: mit
- Created: 2024-04-22T22:47:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-18T03:50:16.000Z (11 months ago)
- Last Synced: 2024-12-17T06:57:20.157Z (7 months ago)
- Language: Ruby
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# GrpcReflection
[](https://github.com/y-yagi/grpc_reflection/actions/workflows/main.yml)
[](http://badge.fury.io/rb/grpc_reflection)
This gem aims to provide GRPC Server Reflection Protocol for Ruby. The main purpose is to allow using [grpcurl](https://github.com/fullstorydev/grpcurl).
**Caution**
* This gem only supports files that generated by the latest `protoc`.
* This gem doesn't support all GRPC Server Reflection Protocol features. Currently, only supports requests by `file_containing_symbol` and `list_services`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'grpc_reflection'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install grpc_reflection
## Usage
This gem provies the server for GRPC Server Reflection Protocol. Please add it to your GRPC server.
```ruby
s = GRPC::RpcServer.new
s.add_http2_port('0.0.0.0:50051', :this_port_is_insecure)
s.handle(GrpcReflection::Server)
s.run_till_terminated_or_interrupted([1, 'int', 'SIGTERM'])
```
## 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/grpc_reflection.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).