rails_respond_to_pb 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfaac3cf5080bc47d884e92e4fa12da3512490396c1e40fed79172667a645527
-  data.tar.gz: 7570d05d12f924e6498c7497d7e0bae2133fb6d95a652ea6c64a81797db4cbe7
+  metadata.gz: 0aa245e7ea71430e7649f6287293c9c2e1daafec5ff1689c5c78ba78f9bb9baf
+  data.tar.gz: 24f3a9834c934dc896b772780275a82a9f49094951cc8da185547fc98be05f16
 SHA512:
-  metadata.gz: 43ab9bf02f8652bec55b073532c6ec06d5fc45a8c7c5668832c5644874f4d977a2e4294fd47b2db516dabd10f303b4efdccaa7faff7d8e64be294a7b5338034a
-  data.tar.gz: a5e70fb72e256eca9558e2f7a19b1213da54f9daf5df680c7d7e51353241fbd688fd19c5e0e02b8723f22bee055f8633b3f03a2d01833c6136a94643f614f374
+  metadata.gz: 625454f9b1c30231ce95c46460f6723b283d05a1f1664dfff20906ed49888b927db1fca70f992d31d7974a17883b99e43fc32ecfee057b857425731f79af7a85
+  data.tar.gz: 4c8f924f845479b6eaf938f50de51fe2ecc375af260ad36886fc92c6b82a1c10a5b84a037d1b8bcdfd5197c40d38744a353cb065b9cb24a724e9202c4080e036

data/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set ENV
+        run: |
+          echo INPUT_PACKAGE_NAME=${GITHUB_REPOSITORY##*/} >> $GITHUB_ENV
+          echo INPUT_VERSION_FILE=lib/${GITHUB_REPOSITORY##*/}/version.rb >> $GITHUB_ENV
+      - uses: GoogleCloudPlatform/release-please-action@v2
+        id: release
+        with:
+          release-type: ruby
+          package-name: ${{ env.INPUT_PACKAGE_NAME }}
+          bump-minor-pre-major: true
+          version-file: ${{ env.INPUT_VERSION_FILE }}
+      - uses: actions/checkout@v2
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+        if: ${{ steps.release.outputs.release_created }}
+      - run: bundle install
+        if: ${{ steps.release.outputs.release_created }}
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          RUBYGEMS_API_KEY: "${{secrets.RUBYGEMS_API_KEY}}"
+        if: ${{ steps.release.outputs.release_created }}

data/CHANGELOG.md

@@ -5,6 +5,13 @@ 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.2.0](https://www.github.com/dudo/rails_respond_to_pb/compare/v0.1.5...v0.2.0) (2021-12-22)
+
+
+### Features
+
+* automate releases ([f880b17](https://www.github.com/dudo/rails_respond_to_pb/commit/f880b17fca29f70d9ca275f9c16316c31cd752f2))
+
+## 0.1.3
 
 - In the beginning...

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,9 +33,10 @@ 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').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):
@@ -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 {
@@ -72,11 +75,43 @@ 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
+```
+
+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
+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')
@@ -84,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:
@@ -131,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 exec 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/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/respond_to_pb.rb

@@ -33,10 +33,10 @@ class RespondToPb
   end
 
   def service_class
-    ::ActiveSupport::Dependencies.constantize("#{@resource}Service")
+    "#{@resource}Service".constantize
   end
 
   def controller_class
-    ::ActiveSupport::Dependencies.constantize("#{@resource}Controller")
+    "#{@resource}Controller".constantize
   end
 end

data/lib/rails_respond_to_pb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsRespondToPb
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 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.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Brett C. Dudo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc-tools
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -87,7 +88,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,7 +96,7 @@ 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:
   - - ">="
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Middleware for a Rails App providing functionality for gRPC and Twirp
 test_files: []