rails_respond_to_pb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfaac3cf5080bc47d884e92e4fa12da3512490396c1e40fed79172667a645527
-  data.tar.gz: 7570d05d12f924e6498c7497d7e0bae2133fb6d95a652ea6c64a81797db4cbe7
+  metadata.gz: 27c0b4bdc93f8fa61505a205af19a464e1c76537fba1e5dc920aa1fbae17b0d3
+  data.tar.gz: f0f8c4030a7418df027cb23335f90bff71005329bd9ca4708db902a67ade1a51
 SHA512:
-  metadata.gz: 43ab9bf02f8652bec55b073532c6ec06d5fc45a8c7c5668832c5644874f4d977a2e4294fd47b2db516dabd10f303b4efdccaa7faff7d8e64be294a7b5338034a
-  data.tar.gz: a5e70fb72e256eca9558e2f7a19b1213da54f9daf5df680c7d7e51353241fbd688fd19c5e0e02b8723f22bee055f8633b3f03a2d01833c6136a94643f614f374
+  metadata.gz: 8077c5f026c6e8f945f0a522e260bb65a7fcc49a5e37d37dda3c0d08703d645ca32c2929579586ac52e9dbbb14f8eecda86dfb3d4005a9ab685978f93643dee2
+  data.tar.gz: 90f9cbd36f60285beefa99a540ae747dfd336939ef66fcba19d3eb32f25e8b4b74a4b15b2082d33395dfc2c6ee1555d7972d79fc9c7a0aa4acd98f55a38b8bd9

data/CHANGELOG.md

@@ -5,6 +5,6 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.1.2
+## 0.1.3
 
 - In the beginning...

data/README.md

@@ -33,7 +33,7 @@ This gem loads Rails middleware that routes to services with Controllers as Hand
     - assumes a `ThingsService` routes to a `ThingsController`
 - loads any `_twirp.rb` files may exist within any folder of 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').proto`
+  - currently you'd respond with a `render plain: ThingResponse.new(id: 1, name: 'Foo').to_proto`
     - looking into `render pb:`
 
 Generate a proto like this for each of your controllers (`rpc` methods should match your controller methods. `message` is to your discretion):
@@ -72,11 +72,34 @@ message ThingList {
 
 ### Server
 
-This gem will allow your app to respond to Twirp requests. No setup required, other than having the prerequisite Service files loaded in your application.
+This gem will allow your app to respond to Twirp requests. There is little setup required, other than having the prerequisite Service files loaded in your application.
+
+Given a Service file of `ThingsService`, this gem assumes the presence of a `ThingsController` with actions corresponding with `rpc` methods. To allow your controller to respond to the RPC request, simply update the action accordingly:
+
+```ruby
+def index
+  # ... business as usual
+
+  respond_to do |format|
+    format.pb do
+      render plain: ThingList.new(things: Thing.all.map { |r| ThingResponse.new(r.as_json) }).to_proto
+    end
+    format.json { render: Thing.all.as_json } # or whatever your controller responds to usually
+  end
+end
+```
+
+The **required** setup here is:
+
+```ruby
+respond_to do |format|
+    format.pb do
+      render plain: YourProtoResponse.to_proto
+```
 
 ### Client
 
-Assuming you have the prerequisite Client files loaded in your application, you can connect to a Twirp server
+Assuming you have the prerequisite Client files loaded in your application, you can connect to a Twirp server as usual:
 
 ```ruby
 client = ThingsClient.new('http://localhost:3000')
@@ -139,7 +162,7 @@ I typically add an alias to make working with dockerized apps easier. This assum
 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 exec console` for an interactive prompt that will allow you to experiment.
+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).
 

data/docker-compose.yml

@@ -9,6 +9,10 @@ services:
     volumes:
       - .:/usr/src/gem:delegated
       - bundle:/usr/local/bundle:delegated
+      - ~/.gitconfig:/etc/gitconfig:ro
+      - ~/.ssh:/root/.ssh:ro
+      - ~/.gemrc:/etc/.gemrc:ro
+      - ~/.local/share/gem/credentials:/root/.local/share/gem/credentials:ro
 
   rspec:
     <<: *bundle

data/lib/rails_respond_to_pb/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rails_respond_to_pb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Brett C. Dudo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2021-08-18 00:00:00.000000000 Z
@@ -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
@@ -102,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.2.25
+signing_key: 
 specification_version: 4
 summary: Middleware for a Rails App providing functionality for gRPC and Twirp
 test_files: []