twirp-on-rails 1.0.0 → 1.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb31fa12f51069d7d6e447901646dd1ebfdc657d59bc670fffc57f8f858b34e
-  data.tar.gz: 414f84e6b7b655fabad364721fc6ea31ee94300674303ff633b5bf49434610cd
+  metadata.gz: 2925a659b9c79db0bfced51d9f8e8c3c86a9c9b4977f64611f7f57d7b2597c00
+  data.tar.gz: 56abcb2fa1e40241eef7f3199529bf4a83971f82358f679526a38b482c12cb79
 SHA512:
-  metadata.gz: 986ee79625c2cea727ebbb09b0efb0f110a5e64f3ce5d186dfd2786ceb35d48f88935a43335f4c6740144fa6023cc12107288554d2a3389f37bf3f6ad2b01f21
-  data.tar.gz: 68c86eb0918f123e6b96457944347893f96bdfbabe91c4c3f1bd8b0ae75c6eac3b590856f6156c3488ade4a58ebcc906dc566b8c255326da3eb89344796e4a5f
+  metadata.gz: 28a1b6ec586b9e129a64390a5e727aee495a2c624d74ca9b94ac0a1548b5fd36d4951a6e1bc256ca560ea3909a45c4e637dce401a8a77953d2faa6628644674e
+  data.tar.gz: 661c948ab6ca8b80d83fd882581d4e1246e541aebb2416e62fcafa1f202454453d8ccd7dadcb9ef0b6b8171eefef68aa19794d647595d2fe1a49e7c35fd8a0d4

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://img.shields.io/gem/v/twirp-on-rails.svg)](https://rubygems.org/gems/twirp-on-rails)
 [![CI](https://github.com/collectiveidea/twirp-rails/actions/workflows/ci.yml/badge.svg)](https://github.com/collectiveidea/twirp-rails/actions/workflows/ci.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
@@ -5,21 +6,19 @@
 
 ## Motivation
 
-Make serving [Twirp](https://twitchtv.github.io/twirp/) RPC Services as easy and familiar as Rails controllers. Add a few helpful abstractions, but don't hide [Twirp](https://twitchtv.github.io/twirp/), [Protobufs](https://protobuf.dev), or make it seem too magical.
+Serving [Twirp](https://twitchtv.github.io/twirp/) RPC Services should be as easy and familiar as Rails controllers. We add a few helpful abstractions, but don't hide [Twirp](https://twitchtv.github.io/twirp/), [Protobufs](https://protobuf.dev), or make it seem too magical.
 
-Out of the box, the [`twirp` gem](http://github.com/github/twirp-ruby) makes it easy to add [Services](https://github.com/github/twirp-ruby/wiki/Service-Handlers), but it feels clunky coming from Rails REST-ful APIs. We make it simple to build full-featured APIs. Hook in authorization, use `before_action` and more.
+Out of the box, the [`twirp` gem](http://github.com/github/twirp-ruby) lets you add [Services](https://github.com/github/twirp-ruby/wiki/Service-Handlers), but it feels clunky coming from Rails REST-ful APIs. We make it simple to build full-featured APIs. Hook in authorization, use `before_action` and more.
 
 Extracted from a real, production application with many thousands of users.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem using `gem install twirp-on-rails` or simply add it to your `Gemfile`:
 
-    $ bundle add twirp-on-rails
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install twirp-on-rails
+```
+gem "twirp-on-rails"
+```
 
 ## Usage
 
@@ -29,6 +28,20 @@ Add to your `routes.rb`:
 mount Twirp::Rails::Engine, at: "/twirp"
 ```
 
+### Generate your `_pb.rb` and `_twirp.rb` files
+
+Generate files [how Twirp-Ruby recommends](https://github.com/arthurnn/twirp-ruby/wiki/Code-Generation). 
+
+Example: 
+
+```bash
+protoc --ruby_out=./lib --twirp_ruby_out=./lib  haberdasher.proto
+```
+
+We (currently) don't run `protoc` for you and have no opinions where you put the generated files. 
+
+Ok, one small opinion: we default to looking in `lib/`, but you can change that.
+
 ### Configuration
 
 Twirp::Rails will automatically load any `*_twirp.rb` files in your app's `lib/` directory (and subdirectories). To modify the location, add this to an initializer: 

data/lib/twirp/rails/rack/conditional_post.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rack/conditional_get"
+require "rack/version"
 
 module Twirp
   module Rails
@@ -29,18 +30,21 @@ module Twirp
         def call(env)
           case env[::Rack::REQUEST_METHOD]
           when "POST"
-            status, headers, body = @app.call(env)
-            headers = ::Rack::Utils::HeaderHash[headers]
+            status, headers, body = response = @app.call(env)
+            # Rack 3 settles on only allowing lowercase headers
+            if Rack.release < "3.0"
+              headers = ::Rack::Utils::HeaderHash[headers]
+            end
+
             if status == 200 && fresh?(env, headers)
-              status = 304
+              response[0] = 304
               headers.delete(::Rack::CONTENT_TYPE)
               headers.delete(::Rack::CONTENT_LENGTH)
-              original_body = body
-              body = ::Rack::BodyProxy.new([]) do
-                original_body.close if original_body.respond_to?(:close)
+              response[2] = Rack::BodyProxy.new([]) do
+                body.close if body.respond_to?(:close)
               end
             end
-            [status, headers, body]
+            response
           else
             @app.call(env)
           end

data/lib/twirp/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Twirp
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.0.1.pre"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: twirp-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1.pre
 platform: ruby
 authors:
 - Daniel Morrison
 - Darron Schall
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,7 +73,7 @@ metadata:
   homepage_uri: https://github.com/collectiveidea/twirp-rails
   source_code_uri: https://github.com/collectiveidea/twirp-rails
   changelog_uri: https://github.com/collectiveidea/twirp-rails/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.9
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Use Twirp RPC with Rails
 test_files: []