rails_respond_to_pb 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c0b4bdc93f8fa61505a205af19a464e1c76537fba1e5dc920aa1fbae17b0d3
-  data.tar.gz: f0f8c4030a7418df027cb23335f90bff71005329bd9ca4708db902a67ade1a51
+  metadata.gz: 72802f972933ce66eb55b4da8451ba00b2d12f0f52215a98c75af0d8016bdcfe
+  data.tar.gz: dc9c577f01084400fb2ab4db0150d5c06c384a840dbfe09ea8035686d3514f8c
 SHA512:
-  metadata.gz: 8077c5f026c6e8f945f0a522e260bb65a7fcc49a5e37d37dda3c0d08703d645ca32c2929579586ac52e9dbbb14f8eecda86dfb3d4005a9ab685978f93643dee2
-  data.tar.gz: 90f9cbd36f60285beefa99a540ae747dfd336939ef66fcba19d3eb32f25e8b4b74a4b15b2082d33395dfc2c6ee1555d7972d79fc9c7a0aa4acd98f55a38b8bd9
+  metadata.gz: 413ee918b3c2412990c7c15e37d25aa072c7857dd56ecdabe167f7ab0e2e2a864990e3af5ccad6d81a60a054d657fdb18f77042e9153991f9d083f16b121b20b
+  data.tar.gz: 75fef258b0b4386cf5e8220dabe2407b8ce51cfdae8275ead38754f0efc3b4341951ef80a1fd21ccd35be7c64f99e315998c19d2b9adc4b4b21c38cb986c25c8

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/.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+name: Rubocop
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Rubocop
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake rubocop

data/.github/workflows/{main.yml → spec.yml}

@@ -1,6 +1,8 @@
-name: Ruby
+name: Specs
 
-on: [push,pull_request]
+on:
+  - push
+  - pull_request
 
 jobs:
   build:
@@ -11,8 +13,8 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 3.0.0
-    - name: Run the default task
+    - name: Spec
       run: |
         gem install bundler -v 2.2.3
         bundle install
-        bundle exec rake
+        bundle exec rake spec

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.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,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 {
@@ -93,8 +96,17 @@ The **required** setup here is:
 
 ```ruby
 respond_to do |format|
-    format.pb do
-      render plain: YourProtoResponse.to_proto
+  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
@@ -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/Rakefile

@@ -9,4 +9,4 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: :spec

data/docker-compose.yml

@@ -1,6 +1,5 @@
 services:
   bundle: &bundle
-    env_file: .env
     stdin_open: true
     tty: true
     build: .

data/lib/rails_respond_to_pb/railtie.rb

@@ -15,7 +15,7 @@ module RailsRespondToPb
     end
 
     initializer 'respond_to_pb.require_pb' do
-      Dir["#{Rails.root}/lib/**/*_twirp.rb"].each { |file| require file }
+      Dir["#{Rails.root}/lib/**/*_twirp.rb"].sort.each { |file| require file }
     end
   end
 end

data/lib/rails_respond_to_pb/respond_to_pb.rb

@@ -9,6 +9,7 @@ class RespondToPb
 
   def call(env)
     _, @resource, @action = env['PATH_INFO'].split('/')
+    @resource = @resource.split('.').map(&:camelize).join('::')
 
     if env['CONTENT_TYPE'] == Twirp::Encoding::PROTO
       env['HTTP_ACCEPT'] = Twirp::Encoding::PROTO
@@ -33,10 +34,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.3'
+  VERSION = '0.2.1'
 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.2.1
 platform: ruby
 authors:
 - Brett C. Dudo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc-tools
@@ -59,7 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -95,14 +97,14 @@ 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
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Middleware for a Rails App providing functionality for gRPC and Twirp