rails_respond_to_pb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c0b4bdc93f8fa61505a205af19a464e1c76537fba1e5dc920aa1fbae17b0d3
-  data.tar.gz: f0f8c4030a7418df027cb23335f90bff71005329bd9ca4708db902a67ade1a51
+  metadata.gz: 1c322c035c9d8609dc8627e797c78c18a180646114ca046e712de5c602833471
+  data.tar.gz: 4620238b1f729bf8afff9f914e89c66d2f28fd19527012bbbd292302cd5da68d
 SHA512:
-  metadata.gz: 8077c5f026c6e8f945f0a522e260bb65a7fcc49a5e37d37dda3c0d08703d645ca32c2929579586ac52e9dbbb14f8eecda86dfb3d4005a9ab685978f93643dee2
-  data.tar.gz: 90f9cbd36f60285beefa99a540ae747dfd336939ef66fcba19d3eb32f25e8b4b74a4b15b2082d33395dfc2c6ee1555d7972d79fc9c7a0aa4acd98f55a38b8bd9
+  metadata.gz: 2e46f10d9b60f0670413af3683d9ef4ad72d6f84ac1e7773d2bb690ac8e62273e8f48d4de3bd0dc8db2296c7a2eb661d2380945f1a3dec45fa4408392da4a7a8
+  data.tar.gz: 7888edb96143bba2691b486e81368bf3917d20ddd1c6fe66a47b2d7f388fe6b0c3808d01cbeafdcfe2ee7e97bc0e0ab72ab59e20759b049f0ac10cc6ad2d306a

data/README.md

@@ -1,5 +1,7 @@
 # rails_respond_to_pb
 
+[![Gem Version](https://badge.fury.io/rb/rails_respond_to_pb.svg)](https://badge.fury.io/rb/rails_respond_to_pb)
+
 This gem allows you to route RPC calls via protobuf to an existing rails controller. Currently supporting:
 
 - [Twirp](https://github.com/twitchtv/twirp-ruby)
@@ -31,7 +33,8 @@ This gem loads Rails middleware that routes to services with Controllers as Hand
 - assumes a single `ThingsService` per controller
   - Typical Rails namey-ness conventions are followed here
     - assumes a `ThingsService` routes to a `ThingsController`
-- loads any `_twirp.rb` files may exist within any folder of your app's `lib` directory
+    - looking into building generating proto files from controllers
+- loads any `_twirp.rb` files that exist within your app's `lib` directory
 - allows a controller to `respond_to` the `pb` format
   - currently you'd respond with a `render plain: ThingResponse.new(id: 1, name: 'Foo').to_proto`
     - looking into `render pb:`
@@ -44,11 +47,11 @@ syntax = "proto3";
 service Things {
   // these rpc methods are important - use what's in the corresponding ThingsController.
   // whatever is sent as an argument will be made available to the controller as `params`
-  rpc create (ThingParams) returns (ThingResponse);
-  rpc show (ThingParams) returns (ThingResponse);
-  rpc index (ThingFilter) returns (ThingList);
-  rpc update (ThingParams) returns (ThingResponse);
-  rpc destroy (ThingParams) returns (ThingResponse);
+  rpc Create (ThingParams) returns (ThingResponse);
+  rpc Show (ThingParams) returns (ThingResponse);
+  rpc Index (ThingFilter) returns (ThingList);
+  rpc Update (ThingParams) returns (ThingResponse);
+  rpc Destroy (ThingParams) returns (ThingResponse);
 }
 
 message ThingParams {
@@ -97,6 +100,15 @@ respond_to do |format|
       render plain: YourProtoResponse.to_proto
 ```
 
+Of note, if you're trying to wire up **entirely new** methods, you do **NOT** need this gem at all, and you can simply add this to your routes file:
+
+```ruby
+handler = ThingsHandler.new()
+service = ThingsService.new(handler)
+
+mount service, at: service.full_name
+```
+
 ### Client
 
 Assuming you have the prerequisite Client files loaded in your application, you can connect to a Twirp server as usual:
@@ -107,6 +119,18 @@ query = ThingFilter.new name: 'foo'
 client.index(query)
 ```
 
+## Development
+
+I typically add an alias to make working with dockerized apps easier. This assumes [docker](https://docs.docker.com/get-docker/) is running.
+
+```sh
+alias dr="docker compose run --rm "
+```
+
+After checking out the repo, run `dr bundle install` to spin up a container, and install dependencies. Then, run `dr rspec spec` to run the tests. You can also run `dr bundle 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 `dr 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).
+
 ### Building protos
 
 For inspiration on how to build proto files locally (and working with docker-compose), here are some services to use within your application:
@@ -154,18 +178,6 @@ FROM ruby:3
 COPY --from=go /go/bin /usr/local/bin
 ```
 
-## Development
-
-I typically add an alias to make working with dockerized apps easier. This assumes [docker](https://docs.docker.com/get-docker/) is running.
-
-```sh
-alias dr="docker compose run --rm "
-```
-
-After checking out the repo, run `dr bundle install` to spin up a container, and install dependencies. Then, run `dr rspec spec` to run the tests. You can also run `dr bundle 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 `dr 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](https://github.com/[USERNAME]/rails_respond_to_pb). 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/[USERNAME]/rails_respond_to_pb/blob/main/CODE_OF_CONDUCT.md).

data/lib/rails_respond_to_pb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsRespondToPb
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/rails_respond_to_pb.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Middleware for a Rails App providing functionality for gRPC and Twirp'
   spec.homepage      = 'https://github.com/dudo/rails_respond_to_pb'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
 
   # spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_respond_to_pb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brett C. Dudo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc-tools
@@ -87,7 +87,7 @@ metadata:
   homepage_uri: https://github.com/dudo/rails_respond_to_pb
   source_code_uri: https://github.com/dudo/rails_respond_to_pb
   changelog_uri: https://github.com/dudo/rails_respond_to_pb/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,15 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Middleware for a Rails App providing functionality for gRPC and Twirp
 test_files: []